Changes between Version 10 and Version 11 of StructuredBinaryData

Timestamp:

2012-06-27T22:21:47Z (12 years ago)

Author:

Sean Bartell

Comment:

update to reflect new commits

StructuredBinaryData

@@ -128 +128 @@
 == Built‐in transforms ==
 
-These transforms will be implemented in C and included with Bithenge. Note that
+These transforms are implemented in C and included with Bithenge. Note that
 precise names are preferred; scripts can define shorter aliases if necessary.
 
 ||= name =||= input =||= output =||= description =||= example =||
-||uint32le        ||4‐byte blob node ||integer node ||decodes a 4‐byte little‐endian unsigned integer ||  `x"01010000"` becomes `257` ||
-||zero_terminated ||blob node        ||blob node    ||takes bytes up until the first `00` ||  `x"7f0400"` becomes `x"7f04"` ||
-||ascii           ||blob node        ||string       ||decodes some bytes as ASCII characters ||  `x"6869"` becomes `"hi"` ||
-||padded_with_spaces_at_end ||string ||string       ||removes spaces from the end of a string ||  `"README  "` becomes `"README"`
+||ascii           ||blob node        ||string       ||decodes some bytes as ASCII characters ||  `hex:6869` becomes `"hi"` ||
+||uint32be        ||4‐byte blob node ||integer node ||decodes a 4‐byte big‐endian unsigned integer ||  `hex:00000201` becomes `513` ||
+||uint32le        ||4‐byte blob node ||integer node ||decodes a 4‐byte little‐endian unsigned integer ||  `hex:01010000` becomes `257` ||
+||zero_terminated ||blob node        ||blob node    ||takes bytes up until the first `00` ||  `hex:7f0400` becomes `hex:7f04` ||
 
 == Basic syntax ==
@@ -148 +148 @@
 
 Transforms can be composed to create a new transform that applies them in
-order. The transform `padded_with_spaces_at_end . ascii . zero_terminated`
-first removes the 0x00 from the end of the blob, then decodes it as ascii and
-removes spaces from the end. Note that the order of composition is consistent
-with function composition and nested application in mathematics, and also
-consistent with the general idea that data moves from right to left as it is
-decoded.
+order. The transform `ascii <- zero_terminated`
+first removes the 0x00 from the end of the blob, then decodes it as ascii. Note
+that the order of composition is consistent with function composition and
+nested application in mathematics, and also consistent with the general idea
+that data moves from right to left as it is decoded.
 
 == Structs ==
@@ -168 +167 @@
 {{{
 transform point = struct {
-    .x = uint32le;
-    .y = uint32le;
+    .x <- uint32le;
+    .y <- uint32le;
 };
 
 transform labeled_point = struct {
-    .id = uint32le;
-    .label = ascii . zero_terminated;
-    point;
+    .id <- uint32le;
+    .label <- ascii <- zero_terminated;
+    <- point;
 };
 }}}
 
-If `labeled_point` is applied to `x"06000000 4100 03000000 08000000"`, the
-result is `{"id": 6, "label": "A", "x": 3, "y": 8}`.
+If `labeled_point` is applied to `hex:0600000041000300000008000000`, the result
+is `{"id": 6, "label": "A", "x": 3, "y": 8}`.
+
+== Using Bithenge ==
+
+The Bithenge source code is in `uspace/app/bithenge` and is built along with
+HelenOS. It can be built for Linux instead with `make -f Makefile.linux`.
+
+The program can be run with `bithenge <script file> <source>`. The script file
+must define a transform called `main`. The source can start with one of the
+following prefixes:
+
+||= Prefix =||= Example =||= Description =||
+|| file: || file:/textdemo || Read the contents of a file. This is the default if no prefix is used. ||
+|| block: || block:bd/initrd || Read the contents of a block device. (HelenOS only.) ||
+|| hex: || hex:01000000 || Use a string of hexadecimal characters to create a blob node. ||
+
+There are some example files in `uspace/dist/src/bithenge`.
 
 == Future features ==