chiark / gitweb /
5ee975aa072b4975a8b36c5a97ebda7ebad746e2
[chiark-tcl.git] / base / chiark-tcl.h
1 /*
2  * base code for various Tcl extensions
3  * Copyright 2006 Ian Jackson
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18  * 02110-1301, USA.
19  */
20
21 #ifndef CHIARK_TCL_H
22 #define CHIARK_TCL_H
23
24 #include <assert.h>
25 #include <stdlib.h>
26 #include <errno.h>
27 #include <unistd.h>
28 #include <fcntl.h>
29 #include <sys/socket.h>
30 #include <sys/uio.h>
31 #include <sys/un.h>
32 #include <arpa/inet.h>
33
34 #ifndef _TCL /* if someone already included some tcl.h, use that */
35 #include <tcl.h>
36 #endif /*_TCL*/
37
38 #include <adns.h>
39
40 typedef unsigned char Byte;
41
42 /* for assisting tcmdifgen and tcmdiflib.c */
43
44 typedef struct TopLevel_Command TopLevel_Command;
45
46 struct TopLevel_Command {
47   const char *name;
48   Tcl_ObjCmdProc *func;
49 };
50
51 void cht_setstringresult(Tcl_Interp*, const char*);
52 int cht_pat_enum(Tcl_Interp*, Tcl_Obj*, const void**,
53                  const void*, size_t, const char *what);
54
55 /* from scriptinv.c */
56
57 typedef struct { /* opaque; comments are for scriptinv.c impl'n only */
58   /* states:                Cancelled       Set                          */
59   Tcl_Interp *ipq;     /*    0               valid, non-0, useable       */
60   Tcl_Obj *script;     /*    0               valid, non-0                */
61   Tcl_Obj *xargs;      /*    0               valid, may be 0             */
62   int llen;            /*    undefined       llength of script + xargs   */
63 } ScriptToInvoke;
64
65 void cht_scriptinv_init(ScriptToInvoke *si); /* undefined -> Cancelled */
66 int cht_scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip,
67                       Tcl_Obj *newscript, Tcl_Obj *xargs);
68   /* Cancelled/Set -> Set (newscript!=0, ok) / Cancelled (otherwise) */
69 void cht_scriptinv_cancel(ScriptToInvoke *si);
70   /* Cancelled/Set -> Cancelled.  No separate free function - just cancel. */
71 #define cht_scriptinv_interp(si) ((si)->ipq)
72   /* int cht_scriptinv_interp(ScriptToInvoke *si);  returns 0 if Cancelled */
73
74 int cht_scriptinv_invoke_fg(ScriptToInvoke *si, int argc,
75                             Tcl_Obj *const *argv);
76   /* is a no-op if Cancelled rather than Set */
77   /* if script fails, returns that error */
78
79 void cht_scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj *const *argv);
80   /* if script fails, reports it with Tcl_BackgroundError */
81
82 /* from idtable.c */
83
84 typedef struct {
85   const char *valprefix, *assockey;
86   void (*destroyitem)(Tcl_Interp *ip, void *val);
87 } IdDataSpec;
88
89 /* The stored struct must start with a single int, conventionally
90  * named `ix'.  When the struct is returned for the first time ix must
91  * be -1; on subsequent occasions it must be >=0.  ix will be -1 iff
92  * the struct is registered by the iddatatable machinery. */
93
94 extern Tcl_ObjType cht_tabledataid_nearlytype;
95 int cht_tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, const IdDataSpec *idds);
96 void cht_tabledataid_disposing(Tcl_Interp *ip, void *val, const IdDataSpec *idds);
97   /* call this when you destroy the struct, to remove its name;
98    * _disposing is idempotent */
99
100 /* from hook.c */
101
102 int cht_staticerr(Tcl_Interp *ip, const char *m, const char *ec);
103 int cht_posixerr(Tcl_Interp *ip, int errnoval, const char *m);
104 int cht_newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
105 void cht_objfreeir(Tcl_Obj *o);
106 int cht_get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
107
108 void cht_obj_updatestr_vstringls(Tcl_Obj *o, ...);
109   /* const char*, int, const char*, int, ..., (const char*)0 */
110 void cht_obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
111 void cht_obj_updatestr_string(Tcl_Obj *o, const char *str);
112
113 void cht_prepare__basic(Tcl_Interp *ip);
114 void cht_setup__commands(Tcl_Interp *ip, const TopLevel_Command *cmds);
115   /* ... for use by CHT_INIT and CHTI_... macros only */
116
117 /* from parse.c */
118
119 typedef struct {
120   Tcl_Obj *obj, *var;
121   int copied;
122 } Something_Var;
123
124 void cht_init_somethingv(Something_Var *sth);
125 void cht_fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
126 int cht_pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
127                    Something_Var *sth, Tcl_ObjType *type);
128
129 /* from enum.c */
130
131 extern Tcl_ObjType cht_enum_nearlytype;
132 extern Tcl_ObjType cht_enum1_nearlytype;
133
134 const void *cht_enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
135                                     const void *firstentry, size_t entrysize,
136                                     const char *what);
137 #define enum_lookup_cached(ip,o,table,what)                     \
138     (cht_enum_lookup_cached_func((ip),(o),                              \
139                              &(table)[0],sizeof((table)[0]),    \
140                              (what)))
141   /* table should be a pointer to an array of structs of size
142    * entrysize, the first member of which should be a const char*.
143    * The table should finish with a null const char *.
144    * On error, 0 is returned and the ip->result will have been
145    * set to the error message.
146    */
147
148 int cht_enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
149                              const char *opts, const char *what);
150   /* -1 => error */
151
152 /* useful macros */
153
154 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
155 #define TFREE(f) (Tcl_Free((void*)(f)))
156 #define TREALLOC(p,l) ((void*)Tcl_Realloc((void*)(p),(l)))
157
158 /* macros for Chiark_tcl_FOOBAR_Init et al */
159
160   /*
161    * use these macros like this:
162    *    CHT_INIT(<extbase>,
163    *             <preparations>,
164    *             <results>)
165    * where
166    *
167    *   <extbase> is the short name eg `hbytes'
168    *     and should correspond to EXTBASE from the Makefile.
169    *
170    *   <results> are the initialisations which cause new commands
171    *     etc. to appear in the Tcl namespace.  Eg, CHTI_COMMANDS,
172    *     These initialisations are called only when a Tcl `load'
173    *     command loads this extension.
174    *
175    *   <preparations> are the initialisations that we need but which
176    *     do not interfere with the Tcl namespaces.  For example,
177    *     OBJECT types we used (CHTI_TYPE), and other chiark_tcl
178    *     extensions (CHTI_OTHER).  These initialisations are called
179    *     both as a result of Tcl `load' (before the <results>
180    *     initialisations) and also when another extension declares a
181    *     dependency on this one with CHTI_OTHER.
182    *
183    *   Both <results> and <preparations> are whitespace-separated
184    *   lists of calls to CHTI_... macros.  If the list is to be empty,
185    *   write `{ }' instead to prevent an empty macro argument.  The
186    *   preparations and results currently supported are:
187    *
188    *      CHTI_COMMANDS(cht_<somethingtoplevel>_entries)
189    *          where the .tct file contains
190    *            Table *<somethingtoplevel> TopLevel_Command
191    *
192    *      CHTI_OTHER(<extbase-of-underlying-extension>)
193    *          which does the <preparations> of that extension
194    *          (if they have not already been done).
195    *
196    *      CHTI_TYPE(cht_<something>_type)
197    *          where   extern Tcl_ObjType cht_<something>_type;
198    *          Note that CHTI_TYPE should only be called by the
199    *          extension which actually implements the type.  Other
200    *          extensions which need it should use CHTI_OTHER to bring
201    *          in the implementing extension.
202    */
203
204 #define CHT_INIT(e, preparations, results)                                   \
205   extern void cht_prepare_##e(Tcl_Interp *ip);                               \
206   void cht_prepare_##e(Tcl_Interp *ip) {                                     \
207     static int prepared;                                                     \
208     if (prepared) return;                                                    \
209     cht_prepare__basic(ip);                                                  \
210     { preparations }                                                         \
211     prepared= 1;                                                             \
212   }                                                                          \
213   extern int Chiark_tcl_##e##_Init(Tcl_Interp *ip); /*called by load(3tcl)*/ \
214   int Chiark_tcl_##e##_Init(Tcl_Interp *ip) {                                \
215     static int initd;                                                        \
216     if (initd) return TCL_OK;                                                \
217     cht_prepare_##e(ip);                                                     \
218     { results }                                                              \
219     initd= 1;                                                                \
220     return TCL_OK;                                                           \
221   }
222
223 #define CHTI_OTHER(e)                                                    \
224   { extern void cht_prepare_##e(Tcl_Interp *ip); cht_prepare_##e(ip); }
225
226 #define CHTI_TYPE(ot)      { Tcl_RegisterObjType(&(ot)); }
227
228 #define CHTI_COMMANDS(cl)  { cht_setup__commands(ip,cl); }
229
230 #endif /*CHIARK_TCL_H*/