Update status
[ocaml-bitstring.git] / TODO
1 $Id$
2 Major to-do items.
3
4 (1) DONE - In bitmatch operator, use patterns not expressions.
5
6 (2) DONE - Allow matching against strings.
7
8 (3) DONE - Change the syntax so { ... } surrounds match patterns.
9
10 (4) Provide UInt32 and UInt64 types.
11
12 (5) DONE - Allow for specific offsets and alignment.  Something like this:
13
14     { start : 16;
15       another : 16 : offset(256);   (* location would be 256 bits from start *)
16     }
17
18 (6) and:
19
20     { start : 16;
21       another : 16 : align(32);     (* implicit 16 bit gap before this *)
22     }
23
24 (7) Assertions:
25
26     { start : 16 : assert (offset = 0); }
27
28    (Q: Are these evaluated at compile time or at run time or selectable?)
29
30 (8) Named but unbound patterns to avoid "Warning Y: unused variable".
31
32 (9) DONE -
33     Make the error locations fine-grained, particularly so they point to
34     individual fields, not the whole match.
35
36 (10) DONE - Cross-module, persistent, named patterns, see:
37   http://caml.inria.fr/pub/ml-archives/caml-list/2008/04/25992c9c9fa999fe1d35d961dd9917a2.en.html
38
39 (11) DONE -
40      Runtime endiannness expressions.  The suggested syntax is:
41
42     { field : len : endian (expr) }
43
44     where expr would evaluate to something like BigEndian or
45     LittleEndian.
46
47     There are several protocols around where endianness is only
48     determined at runtime, examples are libpcap and TIFF.
49
50 (12) DONE - More constant field lengths.
51
52 (13) PARTLY DONE - Implement native endian functions.
53
54 (14) PARTLY DONE - A proper test suite.
55
56 (15) DONE - More examples:
57
58     ELF binaries
59     GIF images
60
61 (16) We now know the offset of the current field relative to the
62      whole match.  This may allow more efficient aligned versions
63      of functions to be called (at compile time).  However do note
64      that the offset in the bitstring is usually not known.
65
66 (17) Fix the META file.  Current one is very broken.