Added explanation and improved format (idea).
authorRoland Haeder <roland@mxchange.org>
Wed, 14 May 2014 18:54:32 +0000 (20:54 +0200)
committerRoland Haeder <roland@mxchange.org>
Wed, 14 May 2014 18:54:32 +0000 (20:54 +0200)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
contrib/file_stack/format.txt

index 12c1886..03b6165 100644 (file)
@@ -9,12 +9,24 @@ Purpose: | "magic"   | separator | count    | position      | separator |
 ---------+-----------+-----------+----------+---------------+-----------+
 Bytes:   | 9         | 1         | 20 (hex) | 2 - n^2 (hex) | 1         |
 ---------+-----------+-----------+----------+---------------+-----------+
-Example: | STACKv1.0 |    ???    | 0...ff   | 01            |    ???    |
+Example: | STACKv1.0 |    ???    | 00...ff  | 01            |    ???    |
 
 Continued:
 
-Purpose: | name 0 | entry 0    | separator | name 1 | entry 1    | separator | name n | entry n    | EOF |
----------+--------+------------+-----------+--------+------------+-----------+--------+------------+-----+
-Bytes:   | 10     | 1-n (pack) | 1         | 10     | 1-n (pack) | 1         | 10     | 1-n (pack) | 1   |
----------+--------+------------+-----------+--------+------------+-----------+--------+------------+-----+
-Example: | foo    |     ...    |    ???    | bar    |     ...    |    ???    | bar    |     ...    | EOF |
+Purpose: | hash 0 | separator | name 0 | entry 0    | hash n | separator | name n | entry n    | EOF |
+---------+--------+-----------+--------+------------+--------+-----------+--------+------------+-----+
+Bytes:   |  ???   | 1         | 10     | 1-n (pack) |  ???   | 1         | 10     | 1-n (pack) | 1   |
+---------+--------+-----------+--------+------------+--------+-----------+--------+------------+-----+
+Example: | abc    |    ???    | foo    |    ...     | abc    |    ???    | bar    |     ...    | EOF |
+
+Explanations:
+-------------
+ magic        - Identifies the file and version of format
+ separator    - Serves to detect end of strings with unknown/flexible length
+ count        - Total amount of entries (not deleted) encoded in hexa-decimal
+ position     - Seek position of current entry (which current() will give)
+ hash X       - Hash sum of entry X
+ name X       - Name of stack the entries belongs in
+ entry X      - The actual data, compressed with pack()
+ EOF          - End-of-file character
+ ???          - Must be still found out which character/hashing algorthym fits best