document some undocumented hbytes ops

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

diff --git a/base/chiark-tcl.h b/base/chiark-tcl.h
index f7d0110efa0e2d857cc53e2a0e205fa42bae9b66..10141825f3f3d1f35fd052014e8e7436edba378c 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
@@ -83,6 +86,8 @@
  * ULONG BITCOUNT UNDERRUN             bitfields add up to less than 32
  * ULONG VALUE NEGATIVE                attempt convert -ve integers to ulong
  * ULONG VALUE OVERFLOW                converted value does not fit in result
+ * TUNTAP IFNAME LENGTH                tun/tap interface name too long
+ * TUNTAP MTU OVERRUN                  tun/tap mtu limited to 2^16 bytes
  *
  * Refs: HMAC: RFC2104
  */
@@ -175,6 +180,21 @@ int sockaddr_len(const SockAddr_Value*);
 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
 void sockaddr_free(const SockAddr_Value*);
 
+/* from scriptinv.c */
+
+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) */
+  int llength;
+} ScriptToInvoke;
+
+void scriptinv_init(ScriptToInvoke *si);
+int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript);
+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);
+
 /* from idtable.c */
 
 typedef struct {