X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=chiark-tcl.git;a=blobdiff_plain;f=base%2Ftcmdifgen;h=22da4aea8e6ead31e12bb3f36c95bcea712be8eb;hp=5cd076e1a97deb8c9475db7c23c233e798ce2ae6;hb=d55fe169a327a1a3352ed88587c8f52907e2301d;hpb=b6017ccf067a7fefa893c8bf19288a1909f17263 diff --git a/base/tcmdifgen b/base/tcmdifgen index 5cd076e..22da4ae 100755 --- a/base/tcmdifgen +++ b/base/tcmdifgen @@ -1,5 +1,121 @@ #!/usr/bin/perl +# Input format is line-based, ws-significant, offside rule (some kind +# of, anyway). +# +# Type TYPE: C-TYPE-DECLARATOR +# Defines TYPE as a type (for arguments and return values) +# which corresponds to the C type specified. C-TYPE-DECLARATOR +# must contain one `@' where the identifier would go. +# The type may contain allocated memory, etc., in which case +# `Init' and `Fini' must be used. +# +# TYPE may be either TYPENAME or TYPENAME(ARGS) - in this case, +# ARGS should be C argument declarations as for in a function +# prototype, of extra arguments for the application-supplied +# parser/returner functions. Each time a TYPE is used elsewhere, +# the ARGS should be the actual arguments to pass, and will be +# textually copied into the calls to the parser/returner +# 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); +# +# 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 +# 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 +# not fail. +# +# Init TYPENAME C-STATEMENTS +# Provides some statements which are used to initialise a variable +# of type TYPENAME. C-STATEMENTS should contain one or more `@', +# which will be replaced by the actual variable name. The +# variable will have been declared with the C declarator specified +# with `Type'. C-STATEMENTS may not fail or longjmp, and they may +# not allocate memory or other resources. If no `Init' is +# supplied then there is no invariant (so no `Fini' may be +# supplied either, and the type is `flat' - no memory, external +# refs, etc.) +# +# Fini TYPENAME C-STATEMENTS +# Provides some statements (like `Init') which are used to free a +# variable of type TYPENAME. The variable will already have been +# initialised with the `Init' statements, and may have been +# modified since by application per-type or per-command code. Its +# invariant will be satisfied before C-STATEMENTS. Afterwards the +# invariant may or may not be satisfied, but it may not have any +# memory or other resources allocated. C-STATEMENTS may not fail +# or longjmp. +# +# H-Include C-INCLUDE-SPECIFIER +# Arranges for generated .h files to #include the specified +# file. C-INCLUDE-SPECIFIER should include the <..> or "..". +# +# 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 +# or more spaces) and look like this: +# ENTRYNAME +# FORMALARGNAME TYPE +# ... +# [ => RESULT-TYPE ] +# This will cause the declaration of +# int 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 +# 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). +# +# 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 +# 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 +# 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*); +# sets the Tcl result from the supplied string +# int 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 +# (as a Tcl_Obj). On error sets the result, using +# what (a noun phrase describing the type of thing). +# Assumes (unportably!) that the name and func members +# 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). + use IO; use Data::Dumper; @@ -293,7 +409,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 \n"); + "#include \n"); o(h, 400, "void setstringresult(Tcl_Interp*, const char*);\n". @@ -389,5 +505,3 @@ sub badsyntax ($$$) { __DATA__ Type int: int Type obj: Tcl_Obj *@ - -Type charfrom(const char *opts, const char *what): int