Logging fixes.

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

diff --git a/base/chiark-tcl.h b/base/chiark-tcl.h
index c9975f2adea212c8fd1602dcb0c6a9bd2e73bbf4..7b66932a2eb87c45ba4bcb8809a29d03f9b76582 100644 (file)
--- a/base/chiark-tcl.h
+++ b/base/chiark-tcl.h
@@ -18,30 +18,8 @@
  *  hbytes trimleft VAR                         removes any leading 0 octets
  *  hbytes repeat VALUE COUNT                    => COUNT copies of VALUE
  *
- *  hbytes clockincrement VAR INTEGER      adds INTEGER to VAR mod 256^|VAR|
- *                                         INTEGER must be -255 .. 255
- *                                               => carry (-255 to 255,
- *                                               and -1,0,1 if VAR not empty)
- *
- *  hbytes h2ulong HEX                           => ulong  (HEX len must be 4)
- *  hbytes ulong2h UL                            => hex
- *
- *  ulong ul2bitfields VALUE [SIZE TYPE [TYPE-ARG...] ...]  => 0/1
- *  ulong bitfields2ul BASE  [SIZE TYPE [TYPE-ARG...] ...]  => ULONG
- *      goes from left (MSbit) to right (LSbit) where
- *            SIZE is size in bits
- *            TYPE [TYPE-ARGS...] is as below
- *               zero
- *               ignore
- *               fixed ULONG-VALUE
- *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
- *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
- *
- *  ulong ul2int ULONG    => INT            can fail if >INT_MAX
- *  ulong int2ul INT      => ULONG          can fail if <0
- *
- *  hbytes shift l|r ULONG BITS             fails if BITS >32
- *  hbytes mask A B                         => A & B
+ *  hbytes ushort2h LONG           => LONG must be <2^16, returns as hex
+ *  hbytes h2ushort HEX            => |HEX| must be 2 bytes, returns as ulong
  *
  *  hbytes compare A B
  *      =>  -2   A is lexically earlier than B and not a prefix of B  (A<B)
@@ -58,6 +36,46 @@
  *  hbytes hash ALG MESSAGE                      => hash
  *  hbytes hmac ALG MESSAGE KEY [MACLENGTH]      => mac
  *
+ *  ulong ul2int ULONG    => INT           can fail if >INT_MAX
+ *  ulong int2ul INT      => ULONG         can fail if <0
+ *  ulong mask A B                         => A & B
+ *  ulong add A B                          => A + B  (mod 2^32)
+ *  ulong subtract A B                     => A - B  (mod 2^32)
+ *  ulong compare A B                      => 0/-1/1
+ *  ulong shift l|r ULONG BITS             fails if BITS >32
+ *
+ *  ulong ul2bitfields VALUE [SIZE TYPE [TYPE-ARG...] ...]  => 0/1
+ *  ulong bitfields2ul BASE  [SIZE TYPE [TYPE-ARG...] ...]  => ULONG
+ *      goes from left (MSbit) to right (LSbit) where
+ *            SIZE is size in bits
+ *            TYPE [TYPE-ARGS...] is as below
+ *               zero
+ *               ignore
+ *               fixed ULONG-VALUE
+ *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
+ *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
+ *
+ * Error codes
+ *
+ * HBYTES BLOCKCIPHER CRYPTFAIL CRYPT  block cipher mode failed somehow (!)
+ * HBYTES BLOCKCIPHER CRYPTFAIL MAC    HMAC failed somehow (!)
+ * HBYTES BLOCKCIPHER LENGTH           block cipher input has unsuitable length
+ * HBYTES BLOCKCIPHER PARAMS           key or iv not suitable
+ * HBYTES HMAC PARAMS                  key, input or output size not suitable
+ * HBYTES LENGTH OVERRUN               block too long
+ * HBYTES LENGTH RANGE                 input length or offset is -ve or silly
+ * HBYTES LENGTH UNDERRUN              block too short (or offset too big)
+ * HBYTES SYNTAX                       supposed hex block had wrong syntax
+ * HBYTES VALUE OVERFLOW               value to be conv'd to hex too big/long
+ * 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
+ * ULONG BITCOUNT NEGATIVE             -ve bitcount specified where not allowed
+ * ULONG BITCOUNT OVERRUN              attempt to use more than 32 bits
+ * 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
+ *
  * Refs: HMAC: RFC2104
  */
 
@@ -156,7 +174,7 @@ typedef struct DgramSocket *DgramSockID;
 
 /* from hook.c */
 
-int staticerr(Tcl_Interp *ip, const char *m);
+int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
 void objfreeir(Tcl_Obj *o);
 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);