Start work on documenting values.

[pspp] / spv-file-format.texi

diff --git a/spv-file-format.texi b/spv-file-format.texi
index a5f45e5b4979f7a86307413c2ad4a8c304658a5c..f9d698706e50acf0ba48e577f2f1647a2737a118 100644 (file)
--- a/spv-file-format.texi
+++ b/spv-file-format.texi
@@ -411,8 +411,12 @@ In every example in the corpus, @code{x2} is 18 and the bytes that
 follow it are @code{00 00 00 01 00 00 00 00 00 00 00 00 00 02 00 00 00
 00}.  The meaning of these bytes is unknown.
 
-Observed values of @code{x3} vary from 16 to 150.  The bytes that
-follow it vary somewhat.
+In every example in the corpus for version 1, @code{x3} is 16 and the
+bytes that follow it are @code{00 00 00 01 00 00 00 01 00 00 00 00 01
+01 01 01}.  In version 3, observed @code{x3} varies from 117 to 150 and
+the bytes that follow it vary somewhat and often include a readable
+text string, e.g. ``Default'' or ``Academic'', which appears to be the
+name of a ``TableLook''.
 
 Observed values of @code{x4} vary from 0 to 17.  Out of 7060 examples
 in the corpus, it is nonzero only 36 times.
@@ -574,10 +578,13 @@ When there is more than one dimension of a given kind, the inner
 dimensions are given first.
 
 @example
-datum := int64[index] 00? value        @r{# Version 1.}
-datum := int64[index] value            @r{# Version 3.}
+datum := int64[index] 00? value      /* @r{version 1} */
+datum := int64[index] value          /* @r{version 3} */
 @end example
 
+The format of a datum varies slightly from version 1 to version 3: in
+version 1 it allows for an extra optional 00 byte.
+
 A datum consists of an index and a value.  Suppose there are @math{d}
 dimensions and dimension @math{i} for @math{0 \le i < d} has
 @math{n_i} categories.  Consider the datum at coordinates @math{x_i}
@@ -594,5 +601,34 @@ For example, suppose there are 3 dimensions with 3, 4, and 5
 categories, respectively.  The datum at coordinates (1, 2, 3) has
 index @math{5 \times (4 \times (3 \times 0 + 1) + 2) + 3 = 33}.
 
-The format of a datum varies slightly from version 1 to version 3, in
-that version 1 has an extra optional 00 byte.
+@example
+value := 00? 00? 00? 00? raw-value
+raw-value := 01 opt-value int32[format] double
+           | 02 opt-value int32[format] double string[varname] string[vallab]
+             (01 | 02 | 03)
+           | 03 string[local] opt-value string[id] string[c] (00 | 01)
+           | 04 opt-value int32[format] string[vallab] string[varname]
+             (01 | 02 | 03) string[vallab]
+           | 05 opt-value string[varname] string[varlabel] (01 | 02 | 03)
+           | opt-value string[format] int32[n-substs] substitution*[n-substs]
+substitution := i0 value
+              | int32[x] value*[x + 1]      /* @r{x > 0} */
+opt-value := 31 i0 (i0 | i1 string) opt-value-i0-v1        /* @r{version 1} */
+           | 31 i0 (i0 | i1 string) opt-value-i0-v3        /* @r{version 3} */
+           | 31 i1 int32[footnote-number] nested-string
+           | 31 i2 (00 | 02) 00 (i1 | i2 | i3) nested-string
+           | 31 i3 00 00 01 00 i2 nested-string
+           | 58
+opt-value-i0-v1 := 00 (i1 | i2) 00 00 int32 00 00
+opt-value-i0-v3 := count(counted-string
+                         (58
+                          | 31 01? 00? 00? 00? 01
+                            string[fgcolor] string[bgcolor] string[typeface]
+                            byte)
+                         (58
+                          | 31 i0 i0 i0 i0 01 00 (01 | 02 | 08)
+                            00 08 00 0a 00))
+
+nested-string := 00 00 count(counted-string 58 58)
+counted-string := count((i0 (58 | 31 string))?)
+@end example