Start work on documenting values.
[pspp] / dump.c
diff --git a/dump.c b/dump.c
index 55ad4bc64ca55316839a244f0a7bb1692d023548..c247c4af661be8c50ef6312aa18f05c524088b68 100644 (file)
--- a/dump.c
+++ b/dump.c
@@ -1,3 +1,4 @@
+#include <assert.h>
 #include <float.h>
 #include <stdbool.h>
 #include <stdint.h>
@@ -6,6 +7,7 @@
 #include <string.h>
 #include <sys/stat.h>
 #include <unistd.h>
+#include "u8-mbtouc.h"
 
 static uint8_t *data;
 static size_t n;
@@ -177,6 +179,22 @@ dump_raw(FILE *stream, int start, int end)
 
 }
 
+static bool __attribute__((unused))
+all_utf8(const char *p_)
+{
+  const uint8_t *p = (const uint8_t *) p_;
+  size_t len = strlen ((char *) p);
+  for (size_t ofs = 0, mblen; ofs < len; ofs += mblen)
+    {
+      ucs4_t uc;
+
+      mblen = u8_mbtouc (&uc, p + ofs, len - ofs);
+      if ((uc < 32 && uc != '\n') || uc == 127 || uc == 0xfffd)
+        return false;
+    }
+  return true;
+}
+
 static char *
 get_string(const char *where)
 {
@@ -201,13 +219,9 @@ get_string(const char *where)
 #define get_string() get_string(WHERE)
 
 static char *
-dump_nested_string(void)
+dump_counted_string(void)
 {
   char *s = NULL;
-
-  match_byte_assert (0);
-  match_byte_assert (0);
-  int outer_end = pos + get_u32();
   int inner_end = pos + get_u32();
   if (pos != inner_end)
     {
@@ -222,6 +236,18 @@ dump_nested_string(void)
           exit(1);
         }
     }
+  return s;
+}
+
+static char *
+dump_nested_string(void)
+{
+  char *s = NULL;
+
+  match_byte_assert (0);
+  match_byte_assert (0);
+  int outer_end = pos + get_u32();
+  s = dump_counted_string();
   match_byte_assert(0x58);
   match_byte_assert(0x58);
   if (pos != outer_end)
@@ -234,7 +260,7 @@ dump_nested_string(void)
 }
 
 static void
-dump_value_31(FILE *stream)
+dump_optional_value(FILE *stream)
 {
   if (match_byte (0x31))
     {
@@ -242,7 +268,11 @@ dump_value_31(FILE *stream)
         {
           if (match_u32 (1))
             {
-              /* Only "a" observed as a sample value (although it appears 44 times in the corpus). */
+              /* Corpus frequencies:
+                 124 "a"
+                 12 "b"
+                 8 "a, b"
+              */
               get_string();
             }
           else
@@ -265,25 +295,10 @@ dump_value_31(FILE *stream)
             }
 
           int outer_end = pos + get_u32();
-          int inner_end = pos + get_u32();
-          if (pos != inner_end)
-            {
-              match_u32_assert(0);
-              if (match_byte(0x31))
-                {
-                  /* Appears to be a template string, e.g. '^1 cells (^2) expf < 5. Min exp = ^3...'.
-                     Probably doesn't actually appear in output because many examples look unpolished,
-                     e.g. 'partial list cases value ^1 shown upper...' */
-                  get_string();
-                }
-              else
-                match_byte_assert(0x58);
-              if (pos != inner_end)
-                {
-                  fprintf(stderr, "inner end discrepancy\n");
-                  exit(1);
-                }
-            }
+
+          /* This counted-string appears to be a template string,
+             e.g. "Design\: [:^1:]1 Within Subjects Design\: [:^1:]2". */
+          dump_counted_string();
 
           if (match_byte(0x31))
             {
@@ -340,7 +355,7 @@ dump_value_31(FILE *stream)
           match_byte_assert(0);
           if (!match_u32 (2) && !match_u32(1))
             match_u32_assert(3);
-          dump_nested_string(); /* Our corpus doesn't contain any examples with strings though. */
+          dump_nested_string();
         }
       else
         {
@@ -407,7 +422,7 @@ format_to_string (int type)
 }
 
 static void
-dump_value(FILE *stream, int level, bool match1)
+dump_value(FILE *stream, int level)
 {
   match_byte(0);
   match_byte(0);
@@ -417,34 +432,16 @@ dump_value(FILE *stream, int level, bool match1)
   for (int i = 0; i <= level; i++)
     fprintf (stream, "    ");
 
-  if (match_byte (3))
-    {
-      char *text = get_string();
-      dump_value_31(stream);
-      char *identifier = get_string();
-      char *text_eng = get_string();
-      fprintf (stream, "<string c=\"%s\"", text_eng);
-      if (identifier[0])
-        fprintf (stream, " identifier=\"%s\"", identifier);
-      if (strcmp(text_eng, text))
-        fprintf (stream, " local=\"%s\"", text);
-      fprintf (stream, "/>\n");
-      if (!match_byte (0))
-        match_byte_assert(1);
-      if (match1)
-        match_byte (1);
-    }
-  else if (match_byte (5))
+  if (match_byte (1))
     {
-      dump_value_31(stream);
-      char *name = get_string ();
-      char *label = get_string ();
-      fprintf (stream, "<variable name=\"%s\"", name);
-      if (label[0])
-        fprintf (stream, " label=\"%s\"", label);
-      fprintf (stream, "/>\n");
-      if (!match_byte(1) && !match_byte(2))
-        match_byte_assert(3);
+      unsigned int format;
+      double value;
+
+      dump_optional_value(stream);
+      format = get_u32 ();
+      value = get_double ();
+      fprintf (stream, "<number value=\"%.*g\" format=\"%s%d.%d\"/>\n",
+               DBL_DIG, value, format_to_string(format >> 16), (format >> 8) & 0xff, format & 0xff);
     }
   else if (match_byte (2))
     {
@@ -452,7 +449,7 @@ dump_value(FILE *stream, int level, bool match1)
       char *var, *vallab;
       double value;
 
-      dump_value_31 (stream);
+      dump_optional_value (stream);
       format = get_u32 ();
       value = get_double ();
       var = get_string ();
@@ -467,12 +464,27 @@ dump_value(FILE *stream, int level, bool match1)
       if (!match_byte (1) && !match_byte(2))
         match_byte_assert (3);
     }
+  else if (match_byte (3))
+    {
+      char *text =  get_string();
+      dump_optional_value(stream);
+      char *identifier = get_string();
+      char *text_eng = get_string();
+      fprintf (stream, "<string c=\"%s\"", text_eng);
+      if (identifier[0])
+        fprintf (stream, " identifier=\"%s\"", identifier);
+      if (strcmp(text_eng, text))
+        fprintf (stream, " local=\"%s\"", text);
+      fprintf (stream, "/>\n");
+      if (!match_byte (0))
+        match_byte_assert(1);
+    }
   else if (match_byte (4))
     {
       unsigned int format;
       char *var, *vallab, *value;
 
-      match_byte_assert (0x58);
+      dump_optional_value(stream);
       format = get_u32 ();
       vallab = get_string ();
       var = get_string ();
@@ -487,22 +499,21 @@ dump_value(FILE *stream, int level, bool match1)
         fprintf (stream, " label=\"%s\"/>\n", vallab);
       fprintf (stream, "/>\n");
     }
-  else if (match_byte (1))
+  else if (match_byte (5))
     {
-      unsigned int format;
-      double value;
-
-      dump_value_31(stream);
-      format = get_u32 ();
-      value = get_double ();
-      fprintf (stream, "<number value=\"%.*g\" format=\"%s%d.%d\"/>\n",
-               DBL_DIG, value, format_to_string(format >> 16), (format >> 8) & 0xff, format & 0xff);
-      if (match1)
-        match_byte (1);
+      dump_optional_value(stream);
+      char *name = get_string ();
+      char *label = get_string ();
+      fprintf (stream, "<variable name=\"%s\"", name);
+      if (label[0])
+        fprintf (stream, " label=\"%s\"", label);
+      fprintf (stream, "/>\n");
+      if (!match_byte(1) && !match_byte(2))
+        match_byte_assert(3);
     }
   else
     {
-      dump_value_31(stream);
+      dump_optional_value(stream);
 
       char *base = get_string();
       int x = get_u32();
@@ -518,7 +529,7 @@ dump_value(FILE *stream, int level, bool match1)
             fprintf (stream, "    ");
           fprintf (stream, "<substitution index=\"%d\">\n", i + 1);
           for (int j = 0; j < y; j++)
-            dump_value (stream, level + 2, false);
+            dump_value (stream, level + 2);
           for (int j = 0; j <= level + 1; j++)
             fprintf (stream, "    ");
           fprintf (stream, "</substitution>\n");
@@ -555,32 +566,51 @@ check_permutation(int *a, int n, const char *name)
 }
 
 static void
-dump_category(int level, int *indexes, int *n_indexes, int max_indexes)
+dump_category(FILE *stream, int level, int *indexes, int *n_indexes, int max_indexes)
 {
   for (int i = 0; i <= level; i++)
-    fprintf (stdout, "    ");
+    fprintf (stream, "    ");
   printf ("<category>\n");
-  dump_value (stdout, level + 1, true);
-  match_byte(0);
-  match_byte(0);
-  match_byte(0);
+  dump_value (stream, level + 1);
 
-  if (match_u32 (1))
-    match_byte (0);
-  else if (match_byte (1))
-    {
-      match_byte (0);
-      if (!match_u32 (2))
-        match_u32_assert (1);
-      match_byte (0);
-    }
-  else if (!match_u32(2))
-    match_u32_assert (0);
+  int merge = data[pos];
+  if (!match_byte(0))
+    match_byte_assert (1);
+
+  match_byte_assert (0);
+
+  int unindexed = data[pos];
+  if (!match_byte(0))
+    match_byte_assert (1);
+
+  int x = get_u32 ();
+  pos -= 4;
+  if (!match_u32 (0))
+    match_u32_assert (2);
 
   int indx = get_u32();
   int n_categories = get_u32();
-  if (indx != -1)
+  if (indx == -1)
+    {
+      if (merge)
+        {
+          for (int i = 0; i <= level + 1; i++)
+            fprintf (stream, "    ");
+          fprintf (stream, "<merge/>\n");
+        }
+    }
+  else
     {
+      if (merge)
+        {
+          fprintf(stderr, "index not -1 but merged\n");
+          exit(1);
+        }
+      if (x != 2)
+        {
+          fprintf(stderr, "index not -1 but x != 2\n");
+          exit(1);
+        }
       if (n_categories != 0)
         {
           fprintf(stderr, "index not -1 but subcategories\n");
@@ -593,28 +623,37 @@ dump_category(int level, int *indexes, int *n_indexes, int max_indexes)
         }
       indexes[(*n_indexes)++] = indx;
     }
+
+  int expected_unindexed = indx == -1;
+  if (unindexed != expected_unindexed)
+    {
+      fprintf(stderr, "unindexed (%d) mismatch with indx (%d)\n",
+              unindexed, indx);
+      exit(1);
+    }
+
   if (n_categories == 0)
     {
       for (int i = 0; i <= level + 1; i++)
-        fprintf (stdout, "    ");
-      fprintf (stdout, "<category-index>%d</category-index>\n", indx);
+        fprintf (stream, "    ");
+      fprintf (stream, "<category-index>%d</category-index>\n", indx);
     }
   for (int i = 0; i < n_categories; i++)
-    dump_category (level + 1, indexes, n_indexes, max_indexes);
+    dump_category (stream, level + 1, indexes, n_indexes, max_indexes);
   for (int i = 0; i <= level; i++)
-    fprintf (stdout, "    ");
+    fprintf (stream, "    ");
   printf ("</category>\n");
 }
 
-static void
+static int
 dump_dim(int indx)
 {
   int n_categories;
 
   printf ("<dimension index=\"%d\">\n", indx);
-  dump_value (stdout, 0, false);
+  dump_value (stdout, 0);
 
-  /* This byte is usually 0x02 but many other values have been spotted. */
+  /* This byte is usually 0 but many other values have been spotted. */
   pos++;
 
   if (!match_byte(0) && !match_byte(1))
@@ -633,44 +672,68 @@ dump_dim(int indx)
   int indexes[2048];
   int n_indexes = 0;
   for (int i = 0; i < n_categories; i++)
-    dump_category (0, indexes, &n_indexes, sizeof indexes / sizeof *indexes);
+    dump_category (stdout, 0, indexes, &n_indexes, sizeof indexes / sizeof *indexes);
   check_permutation(indexes, n_indexes, "categories");
 
   fprintf (stdout, "</dimension>\n");
+  return n_indexes;
 }
 
 int n_dims;
+static int dim_n_cats[64];
+#define MAX_DIMS (sizeof dim_n_cats / sizeof *dim_n_cats)
+
 static void
 dump_dims(void)
 {
   n_dims = get_u32();
+  assert(n_dims < MAX_DIMS);
   for (int i = 0; i < n_dims; i++)
-    dump_dim (i);
+    dim_n_cats[i] = dump_dim (i);
 }
 
 static void
 dump_data(void)
 {
   /* The first three numbers add to the number of dimensions. */
-  int t = get_u32();
-  t += get_u32();
-  match_u32_assert(n_dims - t);
+  int l = get_u32();
+  int r = get_u32();
+  int c = n_dims - l - r;
+  match_u32_assert(c);
 
   /* The next n_dims numbers are a permutation of the dimension numbers. */
   int a[n_dims];
   for (int i = 0; i < n_dims; i++)
-    a[i] = get_u32();
+    {
+      int dim = get_u32();
+      a[i] = dim;
+
+      const char *name = i < l ? "layer" : i < l + r ? "row" : "column";
+      printf ("<%s dimension=\"%d\"/>\n", name, dim);
+    }
   check_permutation(a, n_dims, "dimensions");
 
   int x = get_u32();
   printf ("<data>\n");
   for (int i = 0; i < x; i++)
     {
-      printf ("    <datum index=\"%d\">\n", get_u32());
+      unsigned int indx = get_u32();
+      printf ("    <datum index=\"%d\" coords=", indx);
+
+      int coords[MAX_DIMS];
+      for (int i = n_dims; i-- > 0; )
+        {
+          coords[i] = indx % dim_n_cats[i];
+          indx /= dim_n_cats[i];
+        }
+      for (int i = 0; i < n_dims; i++)
+        printf("%c%d", i ? ',' : '"', coords[i]);
+
+      printf ("\">\n");
       match_u32_assert(0);
       if (version == 1)
         match_byte(0);
-      dump_value(stdout, 1, false);
+      dump_value(stdout, 1);
       fprintf (stdout, "    </datum>\n");
     }
   printf ("</data>\n");
@@ -679,19 +742,21 @@ dump_data(void)
 static void
 dump_title(void)
 {
-  pos = 0x27;
   printf ("<title-local>\n");
-  dump_value(stdout, 0, true);
+  dump_value(stdout, 0);
+  match_byte(1);
   printf ("</title-local>\n");
 
   printf ("<subtype>\n");
-  dump_value(stdout, 0, true);
+  dump_value(stdout, 0);
+  match_byte(1);
   printf ("</subtype>\n");
 
   match_byte_assert(0x31);
 
   printf ("<title-c>\n");
-  dump_value(stdout, 0, true);
+  dump_value(stdout, 0);
+  match_byte(1);
   printf ("</title-c>\n");
 
   match_byte(0);
@@ -699,30 +764,23 @@ dump_title(void)
   if (match_byte(0x31))
     {
       printf ("<caption>\n");
-      dump_value(stdout, 0, false);
+      dump_value(stdout, 0);
       printf ("</caption>\n");
     }
   else
     match_byte_assert(0x58);
 
-
   int n_footnotes = get_u32();
   for (int i = 0; i < n_footnotes; i++)
     {
       printf ("<footnote index=\"%d\">\n", i);
-      dump_value(stdout, 0, false);
+      dump_value(stdout, 0);
+      /* Custom footnote marker string. */
       if (match_byte (0x31))
-        {
-          /* Custom footnote marker string. */
-          match_byte_assert(3);
-          get_string();
-          match_byte_assert(0x58);
-          match_u32_assert(0);
-          get_string();
-        }
+        dump_value(stdout, 0);
       else
         match_byte_assert (0x58);
-      printf("(%d)\n", get_u32());
+      get_u32 ();
       printf ("</footnote>\n");
     }
 }
@@ -741,15 +799,19 @@ dump_fonts(void)
       match_byte_assert(0);
       if (!match_byte(0x40) && !match_byte(0x20) && !match_byte(0x80) && !match_byte(0x10) && !match_byte(0x70))
         match_byte_assert(0x50);
-      if (!match_byte(0x41))
-        match_byte_assert(0x51);
+      match_byte_assert(0x41);
       if (!match_u32(0) && !match_u32(1))
         match_u32_assert(2);
       match_byte_assert(0);
 
       /* OK, this seems really unlikely to be totally correct, but it matches my corpus... */
       if (!match_u32(0) && !match_u32(2))
-        match_u32_assert(0xfaad);
+        {
+          if (i == 7)
+            match_u32_assert(0xfaad);
+          else
+            match_u32_assert(0);
+        }
 
       if (!match_u32(0) && !match_u32(1) && !match_u32(2))
         match_u32_assert(3);
@@ -761,7 +823,6 @@ dump_fonts(void)
 
       if (version > 1)
         {
-          /* These seem unlikely to be correct too. */
           if (i != 3)
             {
               if (!match_u32(8))
@@ -810,7 +871,8 @@ dump_fonts(void)
   int count = get_u32();
   pos += 4 * count;
 
-  printf ("<encoding>%s</encoding>\n", get_string ());
+  const char *encoding = get_string();
+  printf ("<encoding>%s</encoding>\n", encoding);
 
   if (!match_u32(0))
     match_u32_assert(UINT32_MAX);
@@ -829,9 +891,12 @@ dump_fonts(void)
     }
   else
     match_u32_assert(UINT32_MAX);
+
+  int decimal = data[pos];
+  int grouping = data[pos + 1];
   if (match_byte('.'))
     {
-      if (!match_byte(','))
+      if (!match_byte(',') && !match_byte('\''))
         match_byte_assert(' ');
     }
   else
@@ -840,10 +905,14 @@ dump_fonts(void)
       if (!match_byte('.') && !match_byte(' '))
         match_byte_assert(0);
     }
+  printf("<format decimal=\"%c\" grouping=\"", decimal);
+  if (grouping)
+    putchar(grouping);
+  printf("\"/>\n");
   if (match_u32(5))
     {
       for (int i = 0; i < 5; i++)
-        get_string();
+        printf("<CC%c>%s</CC%c>\n", 'A' + i, get_string(), 'A' + i);
     }
   else
     match_u32_assert(0);
@@ -898,6 +967,7 @@ main(int argc, char *argv[])
     }
   else if (!strcmp(argv[1], "title"))
     {
+      pos = 0x27;
       dump_title();
       exit(0);
     }
@@ -929,7 +999,7 @@ main(int argc, char *argv[])
 
       /* This might be a version number of some kind, because value 1 seems
          to only appear in an SPV file that also required its own weird
-         special cases in dump_value_31(). */
+         special cases in dump_optional_value(). */
       version = get_u32();
       pos -= 4;
       if (!match_u32(1))
@@ -938,14 +1008,55 @@ main(int argc, char *argv[])
       match_byte_assert(1);
       if (!match_byte(0))
         match_byte_assert(1);
+
+      /* Offset 8. */
       match_byte_assert(0);
       match_byte_assert(0);
       if (!match_byte(0))
         match_byte_assert(1);
+
+      /* Offset 11. */
       pos++;
       match_byte_assert(0);
       match_byte_assert(0);
       match_byte_assert(0);
+
+      /* Offset 15. */
+      pos++;
+      if (!match_byte(0))
+        match_byte_assert(1);
+      match_byte_assert(0);
+      match_byte_assert(0);
+
+      /* Offset 19. */
+      pos++;
+      if (!match_byte(0))
+        match_byte_assert(1);
+      match_byte_assert(0);
+      match_byte_assert(0);
+
+      /* Offset 23. */
+      pos++;
+      if (!match_byte(0))
+        match_byte_assert(1);
+      match_byte_assert(0);
+      match_byte_assert(0);
+
+      /* Offset 27. */
+      pos++;
+      pos++;
+      match_byte_assert(0);
+      match_byte_assert(0);
+
+      /* Offset 31.
+
+         This is the tableId, e.g. -4154297861994971133 would be 0xdca00003.
+         We don't have enough context to validate it. */
+      pos += 4;
+
+      /* Offset 35. */
+      pos += 4;
+
       dump_title ();
       dump_fonts();
       dump_dims ();