many improvements: use Get/SetAssocData for idtables to avoid globals, and adns bindi...

[chiark-tcl.git] / base / chiark-tcl.h

diff --git a/base/chiark-tcl.h b/base/chiark-tcl.h
index afdae9a37e25c863b43c04a9371bb0919e5c0577..b49301f02a935950b0c9a17c725ce395dde0671e 100644 (file)
--- a/base/chiark-tcl.h
+++ b/base/chiark-tcl.h
@@ -17,6 +17,9 @@
  *  hbytes overwrite VAR START VALUE
  *  hbytes trimleft VAR                         removes any leading 0 octets
  *  hbytes repeat VALUE COUNT                    => COUNT copies of VALUE
+ *  hbytes zeroes COUNT                          => COUNT zero bytes
+ *  hbytes random COUNT                          => COUNT random bytes
+ *  hbytes xor VAR VALUE                         $VAR (+)= VALUE
  *
  *  hbytes ushort2h LONG           => LONG must be <2^16, returns as hex
  *  hbytes h2ushort HEX            => |HEX| must be 2 bytes, returns as ulong
@@ -62,6 +65,14 @@
  *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
  *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
  *
+ *  hbytes mask-map lookup MAP-VAR ADDRESS [DEFAULT]   => DATA
+ *     error on missing default or if any prefix longer than address
+ *  hbytes mask-map amend MAP-VAR PREFIX PREFIX-LENGTH DATA
+ *     a maskmap MAP is [list [list PREFIX PREFIX-LENGTH DATA]] sorted
+ *     first by descending PREFIX-LENGTH and then by ascending PREFIX
+ *     each PREFIX _in the map_ is truncated to the shortest number of
+ *     pairs of hex digits which can represent it
+ *
  * Error codes
  *
  * HBYTES BLOCKCIPHER CRYPTFAIL CRYPT  block cipher mode failed somehow (!)
@@ -75,6 +86,13 @@
  * HBYTES LENGTH MISMATCH              when blocks must be exactly same length
  * HBYTES SYNTAX                       supposed hex block had wrong syntax
  * HBYTES VALUE OVERFLOW               value to be conv'd to hex too big/long
+ * HBYTES MASKMAP NOMATCH              no addr/mask matches address for lookup
+ * HBYTES MASKMAP UNDERRUN             addr value for lookup is too short
+ * HBYTES MASKMAP SYNTAX LLENGTH       value for mask-map entry not llength==3
+ * HBYTES MASKMAP SYNTAX UNDERRUN      value for mask-map entry hex too short
+ * HBYTES MASKMAP SYNTAX OVERRUN       actual mask-map entry hex too short
+ * HBYTES MASKMAP SYNTAX ORDER         actual mask-map is disordered
+ * HBYTES MASKMAP SYNTAX EXCLBITS      mask-map has 1-bits outside prefix len
  * SOCKADDR AFUNIX LENGTH              path for AF_UNIX socket too long
  * SOCKADDR SYNTAX IPV4                bad IPv4 socket address &/or port
  * SOCKADDR SYNTAX OTHER               bad socket addr, couldn't tell what kind
@@ -102,7 +120,9 @@
 #include <sys/un.h>
 #include <arpa/inet.h>
 
-#include <tcl.h>
+#include <tcl8.3/tcl.h>
+
+#include <adns.h>
 
 typedef unsigned char Byte;
 
@@ -195,22 +215,38 @@ void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv);
 /* from idtable.c */
 
 typedef struct {
-  const char *const prefix;
-  int n;
-  void **a;
-} IdDataTable;
+  const char *valprefix, *assockey;
+  void (*destroyitem)(Tcl_Interp *ip, void *val);
+} IdDataSpec;
+
+/* 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 tabledataid_nearlytype;
-int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, IdDataTable *tab);
+int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, const IdDataSpec *idds);
+void 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 adns.c */
+
+typedef struct {
+  const char *name;
+  adns_rrtype number;
+} AdnsTclRRTypeInfo;
+
+extern const IdDataSpec adnstcl_queries, adnstcl_resolvers;
 
 /* from dgram.c */
 
-extern IdDataTable dgram_socks;
+extern const IdDataSpec dgram_socks;
 int newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
 
 /* from tuntap.c */
 
-extern IdDataTable tuntap_socks;
+extern const IdDataSpec tuntap_socks;
 
 /* from hook.c */
 
@@ -231,12 +267,30 @@ void obj_updatestr_string(Tcl_Obj *o, const char *str);
 /* from parse.c */
 
 typedef struct {
-  HBytes_Value *hb;
   Tcl_Obj *obj, *var;
   int copied;
+} Something_Var;
+
+void init_somethingv(Something_Var *sth);
+void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
+int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
+                  Something_Var *sth, Tcl_ObjType *type);
+
+typedef struct {
+  HBytes_Value *hb;
+  Something_Var sth;
 } HBytes_Var;
 
-void fini_hbv(Tcl_Interp *ip, int rc, HBytes_Var *agg);
+/* from maskmap.c */
+
+typedef struct MaskMap_Value MaskMap_Value;
+
+typedef struct {
+  MaskMap_Value *mm;
+  Something_Var sth;
+} MaskMap_Var;
+
+extern Tcl_ObjType maskmap_type;
 
 /* from chop.c */
   /* only do_... functions declared in tables.h */
@@ -356,5 +410,6 @@ int setnonblock(int fd, int isnonblock);
 
 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
 #define TFREE(f) (Tcl_Free((void*)(f)))
+#define TREALLOC(p,l) ((void*)Tcl_Realloc((void*)(p),(l)))
 
 #endif /*HBYTES_H*/