X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=chiark-tcl.git;a=blobdiff_plain;f=base%2Fchiark-tcl.h;h=2f4ae7d5f3c5ea37f62e714d5e82494010523719;hp=f542fe035364148ad2b51a9ccc9dd4d5cdf7995e;hb=eef51b4e49bda639a2f4e871b4d8ac00a0988103;hpb=05bed2aad2154e0e8c084789387bf900c5ee513b diff --git a/base/chiark-tcl.h b/base/chiark-tcl.h index f542fe0..2f4ae7d 100644 --- a/base/chiark-tcl.h +++ b/base/chiark-tcl.h @@ -1,162 +1,140 @@ /* - */ -/* - * hbytes raw2h BINARY => hex - * hbytes h2raw HEX => binary - * - * hbytes length VALUE => count - * hbytes prepend VAR [VALUE ...] = set VAR [concat VALUE ... $VAR] - * hbytes append VAR [VALUE ...] = set VAR [concat $VAR VALUE ...] - * hbytes concat VAR [VALUE ...] = set VAR [concat VALUE ...] - * hbytes unprepend VAR PREFIXLENGTH => prefix (removed from VAR) - * hbytes unappend VAR SUFFIXLENGTH => suffix (removed from VAR) - * hbytes chopto VAR NEWVARLENGTH => suffix (removed from VAR) - * (too short? error) - * - * hbytes range VALUE START SIZE => substring (or error) + * base code for various Tcl extensions + * Copyright 2006-2012 Ian Jackson * - * hbytes compare A B - * => -2 A is lexically earlier than B and not a prefix of B (A worked? (always 1 for p) - * hbytes pkcs5 pn|un VAR BLOCKSIZE => worked? (always 1 for p) - * hbytes blockcipher d|e VAR ALG KEY MODE [IV] => IV + * 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. * - * hbytes hash ALG MESSAGE => hash - * hbytes hmac ALG MESSAGE KEY [MACLENGTH] => mac - * - * Refs: HMAC: RFC2104 + * You should have received a copy of the GNU General Public License + * along with this library; if not, see . */ -#ifndef HBYTES_H -#define HBYTES_H +#ifndef CHIARK_TCL_H +#define CHIARK_TCL_H #include #include #include #include #include +#include #include #include #include #include +#ifndef _TCL /* if someone already included some tcl.h, use that */ #include +#endif /*_TCL*/ -typedef unsigned char Byte; - -/* from hbytes.c */ +#include -int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */ - -/* Internal representation details: */ -#define HBYTES_ISEMPTY(hb) (!(hb)->begin_complex && !(hb)->end_0) -#define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0) -#define HBYTES_ISSIMPLE(hb) ((hb)->begin_complex && (hb)->end_0) -#define HBYTES_ISCOMPLEX(hb) ((hb)->begin_complex && !(hb)->end_0) - -typedef struct { - void *begin_complex, *end_0; -} HBytes_Value; /* overlays internalRep */ - -typedef struct { - Byte *dstart; /* always allocated dynamically */ - int prespace, len, avail; - /* - * | SPARE | USED | SPARE | - * |<-prespace->|<-len->| | - * | |<----avail---->| - * ^start - */ -} HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */ - -/* Public interfaces: */ - -extern Tcl_ObjType hbytes_type; - -int hbytes_len(const HBytes_Value *v); -Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */ -int hbytes_issentinel(const HBytes_Value *v); - -Byte *hbytes_prepend(HBytes_Value *upd, int el); -Byte *hbytes_append(HBytes_Value *upd, int el); - /* return value is where to put the data */ - -const Byte *hbytes_unprepend(HBytes_Value *upd, int rl); -const Byte *hbytes_unappend(HBytes_Value *upd, int rl); - /* return value points to the removed data, which remains valid - * until next op on the HBytes_Value. If original value is - * shorter than rl or negative, returns 0 and does nothing. */ +typedef unsigned char Byte; -void hbytes_empty(HBytes_Value *returns); -void hbytes_sentinel(HBytes_Value *returns); -void hbytes_array(HBytes_Value *returns, const Byte *array, int l); -Byte *hbytes_arrayspace(HBytes_Value *returns, int l); -void hbytes_free(const HBytes_Value *frees); - /* _empty, _sentinel and _array do not free or read the old value; - * _free it first if needed. _free leaves it garbage, so you - * have to call _empty to reuse it. _arrayspace doesn't fill - * the array; you get a pointer and must fill it with data - * yourself. */ +/* for assisting tcmdifgen and tcmdiflib.c */ -/* The value made by hbytes_sentinel should not be passed to - * anything except HBYTES_IS..., and hbytes_free. */ +typedef struct TopLevel_Command TopLevel_Command; -/* from sockaddr.c */ +struct TopLevel_Command { + const char *name; + Tcl_ObjCmdProc *func; +}; + +void cht_setstringresult(Tcl_Interp*, const char*); +int cht_pat_enum(Tcl_Interp*, Tcl_Obj*, const void**, + const void*, size_t, const char *what); + +/* from scriptinv.c */ + +typedef struct { /* opaque; comments are for scriptinv.c impl'n only */ + /* states: Cancelled Set */ + Tcl_Interp *ipq; /* 0 valid, non-0, useable */ + Tcl_Obj *script; /* 0 valid, non-0 */ + Tcl_Obj *xargs; /* 0 valid, may be 0 */ + int llen; /* undefined llength of script + xargs */ +} ScriptToInvoke; + +void cht_scriptinv_init(ScriptToInvoke *si); /* undefined -> Cancelled */ +int cht_scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, + Tcl_Obj *newscript, Tcl_Obj *xargs); + /* Cancelled/Set -> Set (newscript!=0, ok) / Cancelled (otherwise) */ +void cht_scriptinv_cancel(ScriptToInvoke *si); + /* Cancelled/Set -> Cancelled. No separate free function - just cancel. */ +#define cht_scriptinv_interp(si) ((si)->ipq) + /* int cht_scriptinv_interp(ScriptToInvoke *si); returns 0 if Cancelled */ + +int cht_scriptinv_invoke_fg(ScriptToInvoke *si, int argc, + Tcl_Obj *const *argv); + /* is a no-op if Cancelled rather than Set */ + /* if script fails, returns that error */ + +void cht_scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj *const *argv); + /* if script fails, reports it with Tcl_BackgroundError */ + +/* from idtable.c */ typedef struct { - Byte *begin, *end; -} SockAddr_Value; - -extern Tcl_ObjType sockaddr_type; - -void sockaddr_clear(SockAddr_Value*); -void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len); -int sockaddr_len(const SockAddr_Value*); -const struct sockaddr *sockaddr_addr(const SockAddr_Value*); -void sockaddr_free(const SockAddr_Value*); + const char *valprefix, *assockey; + void (*destroyitem)(Tcl_Interp *ip, void *val); +} IdDataSpec; -/* from dgram.c */ +/* The stored struct must start with a single int, conventionally + * named `ix'. When the struct is returned for the first time ix must + * be -1; on subsequent occasions it must be >=0. ix will be -1 iff + * the struct is registered by the iddatatable machinery. */ -extern Tcl_ObjType sockid_type; -typedef struct DgramSocket *DgramSockID; +extern Tcl_ObjType cht_tabledataid_nearlytype; +int cht_tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, const IdDataSpec *idds); +void cht_tabledataid_disposing(Tcl_Interp *ip, void *val, const IdDataSpec *idds); + /* call this when you destroy the struct, to remove its name; + * _disposing is idempotent */ /* from hook.c */ -int staticerr(Tcl_Interp *ip, const char *m); -int posixerr(Tcl_Interp *ip, int errnoval, const char *m); -void objfreeir(Tcl_Obj *o); -int get_urandom(Tcl_Interp *ip, Byte *buffer, int l); +int cht_staticerr(Tcl_Interp *ip, const char *m, const char *ec); +int cht_posixerr(Tcl_Interp *ip, int errnoval, const char *m); +int cht_newfdposixerr(Tcl_Interp *ip, int fd, const char *m); +void cht_objfreeir(Tcl_Obj *o); +int cht_get_urandom(Tcl_Interp *ip, Byte *buffer, int l); -void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l); -void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte, - int l, const char *prefix); +void cht_obj_updatestr_vstringls(Tcl_Obj *o, ...); + /* const char*, size_t, const char*, size_t, ..., (const char*)0 */ +void cht_obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l); +void cht_obj_updatestr_string(Tcl_Obj *o, const char *str); + +void cht_prepare__basic(Tcl_Interp *ip); +void cht_setup__commands(Tcl_Interp *ip, const TopLevel_Command *cmds); + /* ... for use by CHT_INIT and CHTI_... macros only */ /* from parse.c */ typedef struct { - HBytes_Value *hb; Tcl_Obj *obj, *var; -} HBytes_Var; - -void fini_hbv(Tcl_Interp *ip, int rc, HBytes_Var *agg); + int copied; +} Something_Var; -/* from chop.c */ +void cht_init_somethingv(Something_Var *sth); +void cht_fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth); +int cht_pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var, + Something_Var *sth, Tcl_ObjType *type); /* from enum.c */ -extern Tcl_ObjType enum_nearlytype; -extern Tcl_ObjType enum1_nearlytype; +extern Tcl_ObjType cht_enum_nearlytype; +extern Tcl_ObjType cht_enum1_nearlytype; -const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, +const void *cht_enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, const void *firstentry, size_t entrysize, const char *what); #define enum_lookup_cached(ip,o,table,what) \ - (enum_lookup_cached_func((ip),(o), \ + (cht_enum_lookup_cached_func((ip),(o), \ &(table)[0],sizeof((table)[0]), \ (what))) /* table should be a pointer to an array of structs of size @@ -166,78 +144,86 @@ const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, * set to the error message. */ -int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, +int cht_enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, const char *opts, const char *what); /* -1 => error */ -/* from crypto.c */ - -void memxor(Byte *dest, const Byte *src, int l); - -typedef struct { - const char *name; - int pad, use_algname; -} PadMethod; - -extern Tcl_ObjType blockcipherkey_type; - -/* from algtables.c */ - -typedef struct { - const char *name; - int hashsize, blocksize, statesize; - void (*init)(void *state); - void (*update)(void *state, const Byte *data, int len); - void (*final)(void *state, Byte *digest); - void (*oneshot)(Byte *digest, const Byte *data, int len); -} HashAlgInfo; - -extern const HashAlgInfo hashalginfos[]; - -typedef struct { - void (*make_schedule)(void *schedule, const Byte *key, int keylen); - void (*crypt)(const void *schedule, const void *in, void *out); - /* in and out may be the same, but if they aren't they may not overlap */ - /* in and out for crypt will have been through block_byteswap */ -} BlockCipherDirectionInfo; - -typedef struct { - const char *name; - int blocksize, schedule_size, key_min, key_max; - void (*byteswap)(Byte *block); - BlockCipherDirectionInfo encrypt, decrypt; -} BlockCipherAlgInfo; - -extern const BlockCipherAlgInfo blockcipheralginfos[]; - -/* from bcmode.c */ - -typedef struct { - const char *name; - int iv_blocks, buf_blocks; - const char *(*encrypt)(Byte *data, int blocks, - const Byte *iv, Byte *buf, - const BlockCipherAlgInfo *alg, int encr, - int blocksize, const void *sch); - const char *(*decrypt)(Byte *data, int blocks, - const Byte *iv, Byte *buf, - const BlockCipherAlgInfo *alg, int encr, - int blocksize, const void *sch); - /* in each case, *iv is provided, but may be modified */ -} BlockCipherModeInfo; - -extern const BlockCipherModeInfo blockciphermodeinfos[]; - -/* from misc.c */ - -int setnonblock(int fd, int isnonblock); - /* useful macros */ -#define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue) -#define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue) - #define TALLOC(s) ((void*)Tcl_Alloc((s))) #define TFREE(f) (Tcl_Free((void*)(f))) +#define TREALLOC(p,l) ((void*)Tcl_Realloc((void*)(p),(l))) + +/* macros for Chiark_tcl_FOOBAR_Init et al */ + + /* + * use these macros like this: + * CHT_INIT(, + * , + * ) + * where + * + * is the short name eg `hbytes' + * and should correspond to EXTBASE from the Makefile. + * + * are the initialisations which cause new commands + * etc. to appear in the Tcl namespace. Eg, CHTI_COMMANDS, + * These initialisations are called only when a Tcl `load' + * command loads this extension. + * + * are the initialisations that we need but which + * do not interfere with the Tcl namespaces. For example, + * OBJECT types we used (CHTI_TYPE), and other chiark_tcl + * extensions (CHTI_OTHER). These initialisations are called + * both as a result of Tcl `load' (before the + * initialisations) and also when another extension declares a + * dependency on this one with CHTI_OTHER. + * + * Both and are whitespace-separated + * lists of calls to CHTI_... macros. If the list is to be empty, + * write `{ }' instead to prevent an empty macro argument. The + * preparations and results currently supported are: + * + * CHTI_COMMANDS(cht__entries) + * where the .tct file contains + * Table * TopLevel_Command + * + * CHTI_OTHER() + * which does the of that extension + * (if they have not already been done). + * + * CHTI_TYPE(cht__type) + * where extern Tcl_ObjType cht__type; + * Note that CHTI_TYPE should only be called by the + * extension which actually implements the type. Other + * extensions which need it should use CHTI_OTHER to bring + * in the implementing extension. + */ -#endif /*HBYTES_H*/ +#define CHT_INIT(e, preparations, results) \ + extern void cht_prepare_##e(Tcl_Interp *ip); \ + void cht_prepare_##e(Tcl_Interp *ip) { \ + static int prepared; \ + if (prepared) return; \ + cht_prepare__basic(ip); \ + { preparations } \ + prepared= 1; \ + } \ + extern int Chiark_tcl_##e##_Init(Tcl_Interp *ip); /*called by load(3tcl)*/ \ + int Chiark_tcl_##e##_Init(Tcl_Interp *ip) { \ + static int initd; \ + if (initd) return TCL_OK; \ + cht_prepare_##e(ip); \ + { results } \ + initd= 1; \ + return TCL_OK; \ + } + +#define CHTI_OTHER(e) \ + { extern void cht_prepare_##e(Tcl_Interp *ip); cht_prepare_##e(ip); } + +#define CHTI_TYPE(ot) { Tcl_RegisterObjType(&(ot)); } + +#define CHTI_COMMANDS(cl) { cht_setup__commands(ip,cl); } + +#endif /*CHIARK_TCL_H*/