idtable better documented and sorted

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

diff --git a/hbytes/hbytes.h b/hbytes/hbytes.h
index 17a05942b84a6b69b887fc015309c55f944993cb..2b032877587cebcf815a987fd8883edcc2da9293 100644 (file)
--- a/hbytes/hbytes.h
+++ b/hbytes/hbytes.h
@@ -66,7 +66,7 @@
  *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
  *
  *  hbytes mask-map lookup MAP-VAR ADDRESS [DEFAULT]   => DATA
- *     error on missing default or if address too short
+ *     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
@@ -86,6 +86,8 @@
  * 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
@@ -120,6 +122,8 @@
 
 #include <tcl8.3/tcl.h>
 
+#include <adns.h>
+
 typedef unsigned char Byte;
 
 /* from hbytes.c */
@@ -216,8 +220,25 @@ typedef struct {
   void **a;
 } IdDataTable;
 
+/* 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);
+void tabledataid_disposing(void *val, IdDataTable *tab);
+  /* 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 IdDataTable adnstcl_queries, adnstcl_resolvers;
 
 /* from dgram.c */