chiark / gitweb /
working on new addrmap instead of maskmap - compiles, but have not yet implemented...
[chiark-tcl.git] / base / chiark-tcl.h
index 17a05942b84a6b69b887fc015309c55f944993cb..206f97e909931730cf35315485bcfb915a631a19 100644 (file)
  *               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
+ * Address ranges (addrmap.c):
+ *
+ *  An address range is a slightly efficient partial mapping from
+ *  addresses to arbitrary data values.  An address is a number of
+ *  octets expressed as an hbytes.  All the addresses covered by the
+ *  same addrmap should have the same length.
+ *
+ *  hbytes addr-map lookup MAP-VAR ADDRESS [DEFAULT]   => DATA
+ *     Error on missing default or if any prefix longer than ADDRESS.
+ *
+ *  hbytes addr-map amend-range MAP-VAR START END DATA
+ *  hbytes addr-map amend-mask MAP-VAR PREFIX PREFIX-LENGTH DATA
+ *     Sets all of the addresses in PREFIX/PREFIX-LENGTH to the
+ *     relevant value.
+ *
+ *  Representation:
+ *     An address map MAP is
+ *           [list BIT-LENGTH                           \
+ *                 [list START END DATA-VALUE]          \
+ *                 [list START' END' DATA-VALUE']       \
+ *                 ...
+ *            ]
+ *     The list is sorted by ascending START and entries do not overlap.
+ *     START and END are both inclusive.  BIT-LENGTH is in usual Tcl
+ *     integer notation and must be a multiple of 8.
  *
  * Error codes
  *
  * 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
- * HBYTES MASKMAP SYNTAX EXCLBITS      mask-map has 1-bits outside prefix len
+ * HBYTES ADDRMAP NOMATCH              no addr/mask matches address for lookup
+ * HBYTES ADDRMAP UNDERRUN             addr for lookup or amend is too short
+ * HBYTES ADDRMAP OVERRUN              addr for lookup or amend is too long
+ * HBYTES ADDRMAP EXCLBITS             amend-mask 1-bits outside prefix len
+ * HBYTES ADDRMAP BADRANGE             amend-range start > end
+ * HBYTES ADDRMAP VALUE                addr-map string value is erroneous
  * 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
  * TUNTAP IFNAME LENGTH                tun/tap interface name too long
  * TUNTAP MTU OVERRUN                  tun/tap mtu limited to 2^16 bytes
  *
- * Refs: HMAC: RFC2104
- */
+ * Refs: HMAC: RFC2104 */
 
 #ifndef HBYTES_H
 #define HBYTES_H
 
 #include <tcl8.3/tcl.h>
 
+#include <adns.h>
+
 typedef unsigned char Byte;
 
 /* from hbytes.c */
@@ -198,35 +218,53 @@ void sockaddr_free(const SockAddr_Value*);
 typedef struct { /* semi-opaque - read only, and then only where commented */
   Tcl_Interp *ip; /* valid, non-0 and useable if set */
   Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */
+  Tcl_Obj *xargs;
   int llength;
 } ScriptToInvoke;
 
 void scriptinv_init(ScriptToInvoke *si);
-int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript);
+int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip,
+                 Tcl_Obj *newscript, Tcl_Obj *xargs);
 void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */
   /* no separate free function - just cancel */
 
-void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv);
+void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj *const *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 */
 
@@ -261,16 +299,16 @@ typedef struct {
   Something_Var sth;
 } HBytes_Var;
 
-/* from maskmap.c */
+/* from addrmap.c */
 
-typedef struct MaskMap_Value MaskMap_Value;
+typedef struct AddrMap_Value AddrMap_Value;
 
 typedef struct {
-  MaskMap_Value *mm;
+  AddrMap_Value *am;
   Something_Var sth;
-} MaskMap_Var;
+} AddrMap_Var;
 
-extern Tcl_ObjType maskmap_type;
+extern Tcl_ObjType addrmap_type;
 
 /* from chop.c */
   /* only do_... functions declared in tables.h */