CIL: Include dynlink for OCaml 3.11.

[ocaml-bitstring.git] / TODO

diff --git a/TODO b/TODO
index f4fe3cc..900ae21 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,15 +1,15 @@
-$Id: TODO,v 1.3 2008-04-25 12:08:51 rjones Exp $
+$Id$
 Major to-do items.
 
 (1) DONE - In bitmatch operator, use patterns not expressions.
 
-(2) Allow matching against strings.
+(2) DONE - Allow matching against strings.
 
 (3) DONE - Change the syntax so { ... } surrounds match patterns.
 
 (4) Provide UInt32 and UInt64 types.
 
-(5) Allow for specific offsets and alignment.  Something like this:
+(5) DONE - Allow for specific offsets and alignment.  Something like this:
 
     { start : 16;
       another : 16 : offset(256);   (* location would be 256 bits from start *)
@@ -28,3 +28,73 @@ Major to-do items.
    (Q: Are these evaluated at compile time or at run time or selectable?)
 
 (8) Named but unbound patterns to avoid "Warning Y: unused variable".
+
+(9) DONE -
+    Make the error locations fine-grained, particularly so they point to
+    individual fields, not the whole match.
+
+(10) DONE - Cross-module, persistent, named patterns, see:
+  http://caml.inria.fr/pub/ml-archives/caml-list/2008/04/25992c9c9fa999fe1d35d961dd9917a2.en.html
+
+(11) DONE -
+     Runtime endiannness expressions.  The suggested syntax is:
+
+    { field : len : endian (expr) }
+
+    where expr would evaluate to something like BigEndian or
+    LittleEndian.
+
+    There are several protocols around where endianness is only
+    determined at runtime, examples are libpcap and TIFF.
+
+(12) DONE - More constant field lengths.
+
+(13) PARTLY DONE - Implement native endian functions.
+
+(14) PARTLY DONE - A proper test suite.
+
+(15) DONE - More examples:
+
+    ELF binaries
+    GIF images
+
+(16) We now know the offset of the current field relative to the
+     whole match.  This may allow more efficient aligned versions
+     of functions to be called (at compile time).  However do note
+     that the offset in the bitstring is usually not known.
+
+(17) PARTLY DONE - Fix the META file.  Current one is very broken.
+
+(18) DONE - check() qualifier:
+
+     { field : 16 : check (field > 100) }
+
+     The check(expr) qualifier will abort the rest of the match if the
+     expression is false.
+
+(19) DONE - bind() qualifier:
+
+     { field : 16 : bind (field * 3) }
+       ^pattern           ^new value
+
+     The bind(expr) qualifier binds the pattern to a new value,
+     equivalent to doing:
+
+     let field = field * 3 in
+     (* remainder of match *)
+
+     There is a question of whether bind() should run before or
+     after when() [best is probably when() first, then bind()].
+
+(20) DONE - save_offset_to() qualifier:
+
+     { field : 16 : save_offset_to (offset), bind (field - offset) }
+
+     or:
+
+     { field : 16 : save_offset_to (field_offset) } ->
+       printf "the offset of field (%d) is %d\n" field field_offset
+
+     save_offset_to(patt) binds the current match offset to
+     the variable, for later use within bind(), when() or
+     any later parts of the match.