error codes and better docs for mask-map

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

diff --git a/base/chiark-tcl.h b/base/chiark-tcl.h
index 10141825f3f3d1f35fd052014e8e7436edba378c..f57b037f649078b6c2661b968f338a1c48ffe893 100644 (file)
--- a/base/chiark-tcl.h
+++ b/base/chiark-tcl.h
@@ -65,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 address too short
+ *  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 (!)
@@ -78,6 +86,10 @@
  * 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 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
  * 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
@@ -105,7 +117,7 @@
 #include <sys/un.h>
 #include <arpa/inet.h>
 
-#include <tcl.h>
+#include <tcl8.3/tcl.h>
 
 typedef unsigned char Byte;
 
@@ -234,12 +246,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 */