chiark / gitweb /
Debian package wip
[chiark-tcl.git] / base / tcmdifgen
index 4b675968217e6d0f09dc6dfa2339749551db37d9..f4c77fc95695c05cd44d4aed217ea639c676af3a 100755 (executable)
@@ -1,5 +1,24 @@
 #!/usr/bin/perl
 
+# code generator to help with writing Tcl extensions
+# Copyright 2006 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, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+# 02110-1301, USA.
+
+
 # Input format is line-based, ws-significant, offside rule (some kind
 #  of, anyway).
 #
@@ -66,7 +85,7 @@
 #     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 ]
 #     messages.  It suppresses `TABLENAME ' from the front of the
 #     autogenerated argument parsing error strings.
 #
-#  ExtraEntry C-ENTRY-TYPE
+#  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.