chiark / gitweb /
test-load targets: Use strip to sanitise whitespace in OTHER_DIRS so that the subst...
[chiark-tcl.git] / base / tcmdifgen
index da9832d..f944799 100755 (executable)
@@ -1,5 +1,22 @@
 #!/usr/bin/perl
 
+# code generator to help with writing Tcl extensions
+# Copyright 2006-2012 Ian Jackson
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this library; if not, see <http://www.gnu.org/licenses/>.
+
+
 # Input format is line-based, ws-significant, offside rule (some kind
 #  of, anyway).
 #
 #     functions.
 #
 #     `Type' causes declarations in the .h file of these functions:
-#        int pat_TYPENAME(Tcl_Interp*, Tcl_Obj *obj, C-TYPE *val, ARGS);
-#        Tcl_Obj *ret_TYPENAME(Tcl_Interp*, C-TYPE val, ARGS);
+#        int cht_pat_TYPENAME(Tcl_Interp*, Tcl_Obj *obj, C-TYPE *val, ARGS);
+#        Tcl_Obj *cht_ret_TYPENAME(Tcl_Interp*, C-TYPE val, ARGS);
 #
-#     pat_... must attempt to parse obj into the appropriate type.
+#     cht_pat_... must attempt to parse obj into the appropriate type.
 #     val will already have been initialised with `Init' statements if
-#     relevant.  Whether pat_... fails or succeeds it may allocate
+#     relevant.  Whether cht_pat_... fails or succeeds it may allocate
 #     memory into the object and must leave the object valid (for
 #     `Fini').
 #
-#     ret_... must convert the value back to a new Tcl_Obj.  It may
+#     cht_ret_... must convert the value back to a new Tcl_Obj.  It may
 #     not fail.
 #
 #  Init TYPENAME    C-STATEMENTS
 #     Arranges for generated .h files to #include the specified
 #     file.  C-INCLUDE-SPECIFIER should include the <..> or "..".
 #
-#  Table TABLENAME C-ENTRY-TYPE
+#  Table [*]TABLENAME C-ENTRY-TYPE
 #     Starts a table of commands or subcommands.  The generated .h
 #     will contain a definition of C-ENTRY-TYPE containing
 #         const char *name;
 #         Tcl_ObjCmdProc *func;
 #     and the generated .c will contain
 #         const C-ENTRY-TYPE C-ARRAY-NAME[];
-#     where C-ARRAY-NAME is C-ENTRY-TYPE lowercased, with
-#     `s' appended.  The entries are indented one level (one
+#     where C-ARRAY-NAME is TABLENAME, with `_entries' appended
+#     and `cht_' prepended.  The entries are indented one level (one
 #     or more spaces) and look like this:
-#        ENTRYNAME
+#        ENTRYNAME [ C-EXTRA-ENTRY-VALUES ]
 #            FORMALARGNAME   TYPE
 #            ...
 #          [ =>  RESULT-TYPE ]
 #     This will cause the declaration of
-#        int do_TABLENAME_ENTRYNAME(ClientData cd, Tcl_Interp *ip,
+#        int cht_do_TABLENAME_ENTRYNAME(ClientData cd, Tcl_Interp *ip,
 #                                   FORMAL-ARGUMENTS, RESULT-C-TYPE*);
 #     which is the procedure which the application must supply to
 #     implement the function.  If the `=> RESULT-TYPE' is omitted, so
 #     is the result argument to the function.  Each argument to the
 #     function is of the C type corresponding to the specified type.
-#     The do_... function should not eat any memory associated with
+#     TYPE may be `...', in which case the C function will be passed
+#     two args (int objc, Tcl_Obj *const *objv) for the remaining
+#     arguments.
+#
+#     The cht_do_... function should not eat any memory associated with
 #     the arguments.  The result buffer (if any) will be initialised
 #     using the `Init' and should on success contain the relevant
 #     result.  On failure it should leave the result unmodified (or at
 #     least, not in need of freeing).
 #
+#     As an alternative, the arguments can be replaced with just
+#            dispatch(TYPE-ARGS-FOR-ENUM)
+#     which is a shorthand for
+#            subcmd   enum(TYPE-ARGS-FOR-ENUM)
+#            args     ...
+#     and also generates and uses a standard dispatch function.
+#
 #     There will be an entry in C-ARRAY-NAME for every table entry.
 #     The name will be ENTRYNAME, and the func will be a function
 #     suitable for use as a Tcl command procedure, which parses the
 #     arguments, processes the command, and sets any result, as
 #     applicable.
 #
-#  ExtraEntry C-ENTRY-TYPE
+#     `*' should be used if the table name is not useful for error
+#     messages.  It suppresses `TABLENAME ' from the front of the
+#     autogenerated argument parsing error strings.
+#
+#  EntryExtra C-ENTRY-TYPE
 #     Introduces a section of additional C code which will be inserted
 #     into the definition of C-ENTRY-TYPE by `Table'.  The C
 #     code, which follows on several indented lines, should be
 #     structure member definitions.
 #
-#     When ExtraEntry is used, in the corresponding Table, each
+#     When EntryExtra is used, in the corresponding Table, each
 #     ENTRYNAME should be followed on the same line by whitespace and
 #     EXTRA-VALUES; the EXTRA-VALUES are used as initialisers for the
 #     additional structure elements.
 #
-#  Also declared are these functions:
-#    void setstringresult(Tcl_Interp*, const char*);
+#  NoEntryDefine C-ENTRY-TYPE
+#     Prevents the definition of C-ENTRY-TYPE by Table.
+#     The C type must be defined elsewhere.
+#
+#  Also expected are these functions:
+#    void cht_setstringresult(Tcl_Interp*, const char*);
 #        sets the Tcl result from the supplied string
-#    int pat_enum(Tcl_Interp*, Tcl_Obj*, const void **c_e_t_array,
+#    int cht_pat_enum(Tcl_Interp*, Tcl_Obj*, const void **c_e_t_array,
 #                 const void *c_e_t_return, size_t c_e_t_sz, const char *what);
 #        scans a table of C-ENTRY-TYPEs looking for the
 #        string matching the string supplied by the script
 #        are in the same places no matter what the rest of
 #        the struct contains.
 #  and the two predefined types `int' (C `int') and `obj' (Tcl_Obj*,
-#  unmodified.)  The corresponding definitions are in tcmdiflib.c
-#  which #includes "tcmdiflib.h" (not supplied).
+#  unmodified.)  The corresponding definitions are in tcmdiflib.c.
 
 use IO;
 use Data::Dumper;
@@ -123,8 +158,9 @@ parse('builtins','DATA');
 
 while (@ARGV) {
     $_= shift @ARGV;
-    if (m/^\-p(\w+)/) {
+    if (m/^\-p([-_0-9a-z]+)$/) {
        $prefix= $1;
+       $prefix =~ y/-/_/;
     } elsif (m/^\-w(c|h)$/) {
        $write= $1;
     } elsif (m/^\-o(.+)$/) {
@@ -146,6 +182,17 @@ sub zilch () {
     undef $c_of;
 }
 
+sub enumargs ($) {
+    my ($a) = @_;
+    $a =~ m:/(.*),: or die "invalid enum type \`$a'\n";
+    my ($a_tab, $ee_type, $estr) = ($`,$1,$');
+    if ($ee_type !~ m/^[^_]/) {
+       $ee_type= $a_tab.$ee_type;
+       $a_tab= lc($a_tab).'_entries';
+    }
+    return ($a_tab, $ee_type, $estr);
+}
+
 sub parse ($$) {
     my ($wh,$f) = @_;
     while (defined($_= $f->getline)) {
@@ -163,11 +210,12 @@ sub parse ($$) {
            unshift @i, $this_indent;
        }
 
-       if (@i==0 && m/^Table\s+(\w+)\s+(\w+)$/) {
+       if (@i==0 && m/^Table\s+(\*?)(\w+)\s+(\w+)$/) {
            zilch();
-           $c_table= $1;
-           $table_x{$c_table}{C}= $2;
-           $entrytype_x{$2}= '';
+           $c_table= $2;
+           $table_x{$c_table}{T}= $1;
+           $table_x{$c_table}{C}= $3;
+           $entrytype_x{$3}= '' unless exists $entrytype_x{$3};
        } elsif (@i==0 && m/^Untabled$/) {
            zilch();
            $c_table= '';
@@ -176,6 +224,9 @@ sub parse ($$) {
        } elsif (@i==0 && m/^EntryExtra\s+(\w+)$/) {
            zilch();
            $c_entryextra= $1;
+       } elsif (@i==0 && m/^NoEntryDefine\s+(\w+)$/) {
+           zilch();
+           $entrytype_x{$1}= " ";
        } elsif (@i>=1 && defined $c_entryextra) {
            $entrytype_x{$c_entryextra} .= "  $_\n";
        } elsif (@i==1 && m/^[a-z].*$/ && defined $c_table) {
@@ -190,6 +241,13 @@ sub parse ($$) {
            $tables{$c_table}{$c_entry}{A} = [ ];
        } elsif (@i==2 && m/^\.\.\.\s+(\w+)$/ && defined $c_entry) {
            $tables{$c_table}{$c_entry}{V}= $1;
+       } elsif (@i==2 && m:^dispatch\(((.*)/(.*)\,.*)\)$: && defined $c_entry) {
+           my $enumargs= $1;
+           my $subcmdtype= $2.$3;
+           $tables{$c_table}{$c_entry}{D}= $subcmdtype;
+           $tables{$c_table}{$c_entry}{V}= 'obj';
+           push @{ $tables{$c_table}{$c_entry}{A} },
+               { N => 'subcmd', T => 'enum', A => $enumargs, O => '' };
        } elsif (@i==2 && m/^(\??)([a-z]\w*)\s*(\S.*)/
                 && defined $c_entry) {
            ($opt, $var, $type) = ($1,$2,$3);
@@ -225,19 +283,20 @@ foreach $t (sort keys %types) {
     $type= $types{$t};
     $c= $type->{C};
     $xta= $type->{X};
-    $decl= "int pat_$t(Tcl_Interp *ip, Tcl_Obj *obj, ";
+    $decl= "int cht_pat_$t(Tcl_Interp *ip, Tcl_Obj *obj, ";
     $decl .= subst_in_decl('*val', $c, "type $t");
     $decl .= ", $xta",  if length $xta;
     $decl .= ");\n";
     o('h',160, $decl);
 
-    $decl= "Tcl_Obj *ret_$t(Tcl_Interp *ip, ".subst_in_decl('val',$c);
+    $decl= "Tcl_Obj *cht_ret_$t(Tcl_Interp *ip, ".subst_in_decl('val',$c);
     $decl .= ", $xta" if length $xta;
     $decl .= ");\n";
     o('h',170, $decl);
 }
 
 foreach $c_entrytype (sort keys %entrytype_x) {
+    next if $entrytype_x{$c_entrytype} =~ m/^\s$/;
     o('h', 20, "typedef struct $c_entrytype $c_entrytype;\n");
     o('h', 100,
       "struct $c_entrytype {\n".
@@ -257,7 +316,11 @@ foreach $c_table (sort keys %tables) {
        $r_entry= $r_table->{$c_entry};
        $pa_decl= "int pa_${c_table}_${c_entry_c}(ClientData cd,".
            " Tcl_Interp *ip, int objc, Tcl_Obj *const *objv)";
-       $do_decl= "int do_${c_table}_${c_entry_c}(";
+       $pa_func= "cht_do_${c_table}_${c_entry_c}";
+       if (exists $r_entry->{D}) {
+           $pa_func= "cht_dispatch_$r_entry->{D}";
+       }
+       $do_decl= "int $pa_func(";
        @do_al= ('ClientData cd', 'Tcl_Interp *ip');
        @do_aa= qw(cd ip);
        $pa_init= '';
@@ -272,7 +335,8 @@ foreach $c_table (sort keys %tables) {
        $any_eerr= 0;
        $any_eargc= 0;
        $pa_hint= '';
-       $pa_hint .= "$c_table " if length $c_table;
+       $pa_hint .= "$c_table " if length $c_table &&
+           !length $table_x{$c_table}{T};
        $pa_hint.= $c_entry;
        foreach $arg (@{ $r_entry->{A} }) {
            $n= $arg->{N};
@@ -302,15 +366,14 @@ foreach $c_table (sort keys %tables) {
                $pa_vars .= "  const void *v_$n= 0;\n";
                $paarg= "&v_$n";
                $pafin= "\n  a_$n= v_$n; ";
-               $a =~ m/\,/ or die "invalid enum type \`$a'\n";
-               $a_tab = lc($`).'s';
-               $a = "$a_tab, sizeof($`), $'";
-               o('h', 210, "extern const $` $a_tab".'[]'.";\n");
+               ($a_tab, $ee_type, $estr) = enumargs($a);
+               $a = "cht_$a_tab, sizeof($ee_type), $estr";
+               o('h', 210, "extern const $ee_type cht_$a_tab".'[]'.";\n");
            }
            if (exists $type_fini{$t}) {
                $pa_fini .= '  '.subst_in("a_$n", $type_fini{$t})."\n";
            }
-           $pa_body .= "  rc= pat_$t(ip, *objv++, $paarg";
+           $pa_body .= "  rc= cht_pat_$t(ip, *objv++, $paarg";
            $pa_body .= ", ".$a if length $a;
            $pa_body .= ");$pafin if (rc) goto rc_err;\n";
            push @do_aa, "a_$n";
@@ -333,16 +396,16 @@ foreach $c_table (sort keys %tables) {
        if (exists $r_entry->{R}) {
            $t= $r_entry->{R};
            $xta= $r_entry->{X};
-           push @do_al, make_decl("*result", $t, "do_al result");
+           push @do_al, make_decl("*result", $t, "cht_do_al result");
            $pa_vars .= make_decl_init("result", $t, $xta, \$pa_init,
                                       "pa_vars result");
            push @do_aa, "&result";
-           $pa_rslt .= "  Tcl_SetObjResult(ip, ret_$t(ip, result";
+           $pa_rslt .= "  Tcl_SetObjResult(ip, cht_ret_$t(ip, result";
            $pa_rslt .= ", $xta" if length $xta;
            $pa_rslt .= "));\n";
        }
        $pa_body .= "\n";
-       $pa_body .= "  rc= do_${c_table}_${c_entry_c}(";
+       $pa_body .= "  rc= $pa_func(";
        $pa_body .= join ', ', @do_aa;
        $pa_body .= ");\n";
        $pa_body .= "  if (rc) goto rc_err;\n";
@@ -361,7 +424,7 @@ foreach $c_table (sort keys %tables) {
            $pa_vars .= "  const char *e;\n";
            $pa_fini .= "\n";
            $pa_fini .= "e_err:\n";
-           $pa_fini .= "  setstringresult(ip,e);\n";
+           $pa_fini .= "  cht_setstringresult(ip,e);\n";
            $pa_fini .= "  rc= TCL_ERROR; goto rc_err;\n";
        }
        $pa_vars .= "\n";
@@ -385,8 +448,19 @@ foreach $c_table (sort keys %tables) {
          $pa_fini);
        $do_decl .= join ', ', @do_al;
        $do_decl .= ")";
-       o('h',100, $do_decl.";\n") or die $!;
-       
+
+       if (exists $r_entry->{D}) {
+           my $subcmdtype= $r_entry->{D};
+           if (!exists $dispatch_done{$subcmdtype}) {
+               my $di_body='';
+               $di_body .= "static $do_decl {\n";
+               $di_body .= "  return subcmd->func(0,ip,objc,objv);\n";
+               $di_body .= "}\n";
+               o('c',50, $di_body) or die $!;
+           }
+       } else {
+           o('h',100, $do_decl.";\n") or die $!;
+       }
 
        $op_tab .= sprintf("  { %-20s %-40s%s },\n",
                           "\"$c_entry\",",
@@ -394,7 +468,7 @@ foreach $c_table (sort keys %tables) {
                           $r_entry->{I});
     }
     if (length $c_table) {
-       $decl= "const $x_table->{C} ".lc($x_table->{C}).'s[]';
+       $decl= "const $x_table->{C} cht_${c_table}_entries[]";
        o('h', 500, "extern $decl;\n");
        o('c', 100,
          "$decl = {\n".
@@ -408,13 +482,7 @@ o(c, 0, "#include \"$prefix.h\"\n");
 
 o(h, 0,
   "#ifndef INCLUDED_\U${prefix}_H\n".
-  "#define INCLUDED_\U${prefix}_H\n\n".
-  "#include <tcl.h>\n");
-
-o(h, 400,
-  "void setstringresult(Tcl_Interp*, const char*);\n".
-  "int pat_enum(Tcl_Interp*, Tcl_Obj*, const void**,".
-  "             const void*, size_t, const char *what);\n");
+  "#define INCLUDED_\U${prefix}_H\n\n");
 
 o(h, 999,
   "#endif /*INCLUDED_\U${prefix}_H*/\n");
@@ -475,8 +543,8 @@ sub make_decl ($$$$) {
     my ($n, $t, $ta, $why) = @_;
     my ($type);
     if ($t eq 'enum') {
-       $ta =~ m/\,/ or die "invalid enum type \`$t' ($why)\n";
-       $c= "const $` *@";
+       ($a_tab, $ee_type, $estr) = enumargs($ta);
+       $c= "const $ee_type* @";
     } else { 
        defined $types{$t} or die "unknown type $t ($why)\n";
        $c= $types{$t}{C};