Check category indexes.
[pspp] / dump.c
1 #include <stdbool.h>
2 #include <stdint.h>
3 #include <stdio.h>
4 #include <stdlib.h>
5 #include <string.h>
6 #include <sys/stat.h>
7 #include <unistd.h>
8
9 static uint8_t *data;
10 static size_t n;
11
12 static bool
13 all_ascii(const uint8_t *p, size_t n)
14 {
15   for (size_t i = 0; i < n; i++)
16     if (p[i] < 32 || p[i] > 126)
17       return false;
18   return true;
19 }
20
21 static size_t
22 try_find(const char *target, size_t target_len)
23 {
24   const uint8_t *pos = (const uint8_t *) memmem (data, n, target, target_len);
25   return pos ? pos - data : 0;
26 }
27
28 static size_t
29 try_find_tail(const char *target, size_t target_len)
30 {
31   size_t pos = try_find(target, target_len);
32   return pos ? pos + target_len : 0;
33 }
34
35 static size_t
36 find(const char *target, size_t target_len)
37 {
38   size_t pos = try_find(target, target_len);
39   if (!pos)
40     {
41       fprintf (stderr, "not found\n");
42       exit(1);
43     }
44   return pos;
45 }
46
47 static size_t
48 find_tail(const char *target, size_t target_len)
49 {
50   size_t pos = try_find_tail(target, target_len);
51   if (!pos)
52     {
53       fprintf (stderr, "not found\n");
54       exit(1);
55     }
56   return pos;
57 }
58
59 size_t pos;
60
61 #define XSTR(x) #x
62 #define STR(x) XSTR(x)
63 #define WHERE __FILE__":" STR(__LINE__)
64
65 static unsigned int
66 get_u32(void)
67 {
68   uint32_t x;
69   memcpy(&x, &data[pos], 4);
70   pos += 4;
71   return x;
72 }
73
74 static double
75 get_double(void)
76 {
77   double x;
78   memcpy(&x, &data[pos], 8);
79   pos += 8;
80   return x;
81 }
82
83 static bool
84 match_u32(uint32_t x)
85 {
86   if (get_u32() == x)
87     return true;
88   pos -= 4;
89   return false;
90 }
91
92 static void
93 match_u32_assert(uint32_t x, const char *where)
94 {
95   unsigned int y = get_u32();
96   if (x != y)
97     {
98       fprintf(stderr, "%s: 0x%x: expected i%u, got i%u\n", where, pos - 4, x, y);
99       exit(1);
100     }
101 }
102 #define match_u32_assert(x) match_u32_assert(x, WHERE)
103
104 static bool
105 match_byte(uint8_t b)
106 {
107   if (pos < n && data[pos] == b)
108     {
109       pos++;
110       return true;
111     }
112   else
113     return false;
114 }
115
116 static void
117 match_byte_assert(uint8_t b, const char *where)
118 {
119   if (!match_byte(b))
120     {
121       fprintf(stderr, "%s: 0x%x: expected %02x, got %02x\n", where, pos, b, data[pos]);
122       exit(1);
123     }
124 }
125 #define match_byte_assert(b) match_byte_assert(b, WHERE)
126
127 static char *
128 get_string(const char *where)
129 {
130   if (1
131       /*data[pos + 1] == 0 && data[pos + 2] == 0 && data[pos + 3] == 0*/
132       /*&& all_ascii(&data[pos + 4], data[pos])*/)
133     {
134       int len = data[pos] + data[pos + 1] * 256;
135       char *s = malloc(len + 1);
136
137       memcpy(s, &data[pos + 4], len);
138       s[len] = 0;
139       pos += 4 + len;
140       return s;
141     }
142   else
143     {
144       fprintf(stderr, "%s: 0x%x: expected string\n", where, pos);
145       exit(1);
146     }
147 }
148 #define get_string() get_string(WHERE)
149
150 static void
151 dump_value_31(void)
152 {
153   if (match_byte (0x31))
154     {
155       if (match_u32 (0))
156         {
157           if (match_u32 (1))
158             get_string();
159           else
160             match_u32_assert (0);
161           int subn = get_u32 ();
162           printf ("nested %d bytes", subn);
163           pos += subn;
164         }
165       else if (match_u32 (1))
166         {
167           printf("(footnote %d) ", get_u32());
168           match_byte_assert (0);
169           match_byte_assert (0);
170           int subn = get_u32 ();
171           printf ("nested %d bytes", subn);
172           pos += subn;
173         }
174       else if (match_u32 (2))
175         {
176           printf("(special 2)");
177           match_byte_assert(0);
178           match_byte_assert(0);
179           if (!match_u32 (2))
180             match_u32_assert(1);
181           match_byte_assert(0);
182           match_byte_assert(0);
183           int subn = get_u32 ();
184           printf ("nested %d bytes", subn);
185           pos += subn;
186         }
187       else
188         {
189           match_u32_assert(3);
190           printf("(special 3)");
191           match_byte_assert(0);
192           match_byte_assert(0);
193           match_byte_assert(1);
194           match_byte_assert(0);
195           int subn = get_u32 ();
196           printf ("nested %d bytes, ", subn);
197           pos += subn;
198           subn = get_u32 ();
199           printf ("nested %d bytes, ", subn);
200           pos += subn;
201         }
202     }
203   else
204     match_byte_assert (0x58);
205 }
206
207 static void
208 dump_value__(int level, bool match1)
209 {
210   for (int i = 0; i <= level; i++)
211     printf ("    ");
212
213   match_byte(0);
214   match_byte(0);
215   match_byte(0);
216   match_byte(0);
217
218   if (match_byte (3))
219     {
220       char *s1 = get_string();
221       dump_value_31();
222       char *s2 = get_string();
223       char *s3 = get_string();
224       if (strcmp(s1, s3))
225         printf("strings \"%s\", \"%s\" and \"%s\"", s1, s2, s3);
226       else
227         printf("string \"%s\" and \"%s\"", s1, s2);
228       if (!match_byte (0))
229         match_byte_assert(1);
230       if (match1)
231         match_byte (1);
232     }
233   else if (match_byte (5))
234     {
235       dump_value_31();
236       printf ("variable \"%s\"", get_string());
237       get_string();
238       if (!match_byte(1) && !match_byte(2))
239         match_byte_assert(3);
240     }
241   else if (match_byte (2))
242     {
243       unsigned int format;
244       char *var, *vallab;
245       double value;
246
247       match_byte_assert (0x58);
248       format = get_u32 ();
249       value = get_double ();
250       var = get_string ();
251       vallab = get_string ();
252       printf ("value %g format %d(%d.%d) var \"%s\" vallab \"%s\"",
253               value, format >> 16, (format >> 8) & 0xff, format & 0xff, var, vallab);
254       if (!match_byte (1) && !match_byte(2))
255         match_byte_assert (3);
256     }
257   else if (match_byte (4))
258     {
259       unsigned int format;
260       char *var, *vallab, *value;
261
262       match_byte_assert (0x58);
263       format = get_u32 ();
264       vallab = get_string ();
265       var = get_string ();
266       if (!match_byte(1) && !match_byte(2))
267         match_byte_assert (3);
268       value = get_string ();
269       printf ("value \"%s\" format %d(%d.%d) var \"%s\" vallab \"%s\"",
270               value, format >> 16, (format >> 8) & 0xff, format & 0xff, var, vallab);
271     }
272   else if (match_byte (1))
273     {
274       unsigned int format;
275       double value;
276
277       dump_value_31();
278       format = get_u32 ();
279       value = get_double ();
280       printf ("value %g format %d(%d.%d)", value, format >> 16, (format >> 8) & 0xff, format & 0xff);
281       if (match1)
282         match_byte (1);
283     }
284   else
285     {
286       dump_value_31();
287
288       char *base = get_string();
289       int x = get_u32();
290       printf ("\"%s\" with %d variables:\n", base, x);
291       for (int i = 0; i < x; i++)
292         {
293           int y = get_u32();
294           if (!y)
295             y = 1;
296           else
297             match_u32_assert(0);
298           for (int j = 0; j <= level; j++)
299             printf ("    ");
300           printf("variable %d has %d values:\n", i, y);
301           for (int j = 0; j < y; j++)
302             {
303               dump_value__ (level + 1, false);
304               putchar('\n');
305             }
306         }
307     }
308 }
309
310 static int
311 compare_int(const void *a_, const void *b_)
312 {
313   const int *a = a_;
314   const int *b = b_;
315   return *a < *b ? -1 : *a > *b;
316 }
317
318 static void
319 check_permutation(int *a, int n, const char *name)
320 {
321   int b[n];
322   memcpy(b, a, n * sizeof *a);
323   qsort(b, n, sizeof *b, compare_int);
324   for (int i = 0; i < n; i++)
325     if (b[i] != i)
326       {
327         fprintf(stderr, "bad %s permutation:", name);
328         for (int i = 0; i < n; i++)
329           fprintf(stderr, " %d", a[i]);
330         putc('\n', stderr);
331         exit(1);
332       }
333 }
334
335 static void
336 dump_category(int level, int *indexes, int *n_indexes)
337 {
338   dump_value__ (level, true);
339   match_byte(0);
340   match_byte(0);
341   match_byte(0);
342
343   if (match_u32 (1))
344     match_byte (0);
345   else if (match_byte (1))
346     {
347       match_byte (0);
348       if (!match_u32 (2))
349         match_u32_assert (1);
350       match_byte (0);
351     }
352   else if (!match_u32(2))
353     match_u32_assert (0);
354
355   int indx = get_u32();
356   int n_categories = get_u32();
357   if (indx != -1)
358     {
359       if (n_categories != 0)
360         {
361           fprintf(stderr, "index not -1 but subcategories\n");
362           exit(1);
363         }
364       indexes[(*n_indexes)++] = indx;
365     }
366   if (n_categories > 0)
367     printf (", %d subcategories:", n_categories);
368   else
369     printf (", index %d", indx);
370   printf("\n");
371   for (int i = 0; i < n_categories; i++)
372     dump_category (level + 1, indexes, n_indexes);
373 }
374
375 static void
376 dump_dim(void)
377 {
378   int n_categories;
379   printf("next dim\n");
380   dump_value__ (0, false);
381
382   /* This byte is usually 0x02 but 0x00 and 0x75 (!) have also been spotted. */
383   pos++;
384
385   if (!match_byte(0) && !match_byte(1))
386     match_byte_assert(2);
387   if (!match_u32(0))
388     match_u32_assert(2);
389   if (!match_byte(0))
390     match_byte_assert(1);
391   get_u32();
392   match_byte(0);
393   match_byte(0);
394   n_categories = get_u32();
395   printf("%d nested categories\n", n_categories);
396
397   int indexes[1024];
398   int n_indexes = 0;
399   for (int i = 0; i < n_categories; i++)
400     dump_category (0, indexes, &n_indexes);
401   check_permutation(indexes, n_indexes, "categories");
402 }
403
404 int n_dims;
405 static void
406 dump_dims(void)
407 {
408   n_dims = get_u32();
409   printf ("%u dimensions\n", n_dims);
410   for (int i = 0; i < n_dims; i++)
411     {
412       printf("\n");
413       dump_dim ();
414     }
415 }
416
417 static void
418 dump_data(void)
419 {
420   /* The first three numbers add to the number of dimensions. */
421   int t = get_u32();
422   t += get_u32();
423   match_u32_assert(n_dims - t);
424
425   /* The next n_dims numbers are a permutation of the dimension numbers. */
426   int a[n_dims];
427   for (int i = 0; i < n_dims; i++)
428     a[i] = get_u32();
429   check_permutation(a, n_dims, "dimensions");
430
431   int x = get_u32();
432   printf ("%d data values, starting at %08x\n", x, pos);
433   for (int i = 0; i < x; i++)
434     {
435       printf("%08x, index %d:\n", pos, get_u32());
436       match_u32_assert(0);
437       dump_value__(0, false);
438       putchar('\n');
439     }
440 }
441
442 static void
443 dump_title(void)
444 {
445   pos = 0x27;
446   dump_value__(0, true); putchar('\n');
447   dump_value__(0, true); putchar('\n');
448   match_byte_assert(0x31);
449   dump_value__(0, true); putchar('\n');
450   match_byte(0);
451   match_byte_assert(0x58);
452   if (match_byte(0x31))
453     {
454       dump_value__(0, false); putchar('\n');
455     }
456   else
457     match_byte_assert(0x58);
458
459
460   int n_footnotes = get_u32();
461   if (n_footnotes >= 20)
462     {
463       fprintf(stderr, "%08x: %d footnotes\n", pos - 4, n_footnotes);
464       exit(1);
465     }
466
467   printf("------\n%d footnotes\n", n_footnotes);
468   if (n_footnotes < 20)
469     {
470       for (int i = 0; i < n_footnotes; i++)
471         {
472           printf("footnote %d:\n", i);
473           dump_value__(0, false);
474           if (match_byte (0x31))
475             {
476               /* Custom footnote marker string. */
477               match_byte_assert(3);
478               get_string();
479               match_byte_assert(0x58);
480               match_u32_assert(0);
481               get_string();
482             }
483           else
484             match_byte_assert (0x58);
485           printf("(%d)\n", get_u32());
486         }
487     }
488 }
489
490 static int
491 find_dimensions(void)
492 {
493   {
494     const char dimensions[] = "-,,,.\0";
495     int x = try_find_tail(dimensions, sizeof dimensions - 1);
496     if (x)
497       return x;
498   }
499
500   const char dimensions[] = "-,,, .\0";
501   return find_tail(dimensions, sizeof dimensions - 1);
502 }
503
504 static void
505 dump_fonts(void)
506 {
507   printf("fonts: offset=%08x\n", pos);
508   match_byte(0);
509   for (int i = 1; i <= 8; i++)
510     {
511       printf("%08x: font %d, ", pos, i);
512       match_byte_assert(i);
513       match_byte_assert(0x31);
514       printf("%s, ", get_string());
515       match_byte_assert(0);
516       match_byte_assert(0);
517       if (!match_byte(0x40) && !match_byte(0x20) && !match_byte(0x80) && !match_byte(0x10))
518         match_byte_assert(0x50);
519       if (!match_byte(0x41))
520         match_byte_assert(0x51);
521       pos += 13;
522       printf ("%s, ", get_string());
523       printf ("%s, ", get_string());
524       match_u32_assert(0);
525       match_u32_assert(0);
526       pos++;
527       get_u32();
528       get_u32();
529       get_u32();
530       get_u32();
531       putchar('\n');
532     }
533
534   match_u32_assert(240);
535   pos += 240;
536
537   match_u32_assert(18);
538   pos += 18;
539
540   if (match_u32(117))
541     pos += 117;
542   else
543     {
544       match_u32_assert(142);
545       pos += 142;
546     }
547
548   int count = get_u32();
549   pos += 4 * count;
550
551   char *encoding = get_string();
552   printf("encoding=%s\n", encoding);
553
554   if (!match_u32(0))
555     match_u32_assert(UINT32_MAX);
556   if (!match_byte(0))
557     match_byte_assert(1);
558   match_byte_assert(0);
559   if (!match_byte(0))
560     match_byte_assert(1);
561   if (!match_byte(0x99) && !match_byte(0x98))
562     match_byte_assert(0x97);
563   match_byte_assert(7);
564   match_byte_assert(0);
565   match_byte_assert(0);
566   if (match_byte('.'))
567     match_byte_assert(',');
568   else
569     {
570       match_byte_assert(',');
571       if (!match_byte('.'))
572         match_byte_assert(' ');
573     }
574   match_u32_assert(5);
575   for (int i = 0; i < 5; i++)
576     get_string();
577   pos += get_u32();
578   if (pos != find_dimensions())
579     fprintf (stderr, "%08x / %08x\n", pos, find_dimensions());
580 }
581
582 int
583 main(int argc, char *argv[])
584 {
585   size_t start;
586   struct stat s;
587
588   if (isatty(STDIN_FILENO))
589     {
590       fprintf(stderr, "redirect stdin from a .bin file\n");
591       exit(1);
592     }
593   if (fstat(STDIN_FILENO, &s))
594     {
595       perror("fstat");
596       exit(1);
597     }
598   n = s.st_size;
599   data = malloc(n);
600   if (!data)
601     {
602       perror("malloc");
603       exit(1);
604     }
605   if (read(STDIN_FILENO, data, n) != n)
606     {
607       perror("read");
608       exit(1);
609     }
610
611   if (argc > 1)
612     {
613       if (!strcmp(argv[1], "title0"))
614         {
615           pos = 0x27;
616           if (match_byte (0x03)
617               || (match_byte (0x05) && match_byte (0x58)))
618             printf ("%s\n", get_string());
619           else
620             printf ("<unknown>\n");
621           return 0;
622         }
623       else if (!strcmp(argv[1], "title"))
624         {
625           dump_title();
626           exit(0);
627         }
628       else if (!strcmp(argv[1], "titleraw"))
629         {
630           const char fonts[] = "\x01\x31\x09\0\0\0SansSerif";
631           start = 0x27;
632           n = find(fonts, sizeof fonts - 1);
633         }
634       else if (!strcmp(argv[1], "fonts"))
635         {
636           const char fonts[] = "\x01\x31\x09\0\0\0SansSerif";
637           const char styles[] = "\xf0\0\0\0";
638           start = find(fonts, sizeof fonts - 1);
639           n = find(styles, sizeof styles - 1);
640         }
641       else if (!strcmp(argv[1], "styles"))
642         {
643           const char styles[] = "\xf0\0\0\0";
644           const char dimensions[] = "-,,,.\0";
645           start = find(styles, sizeof styles - 1);
646           n = find(dimensions, sizeof dimensions - 1) + sizeof dimensions - 1;
647         }
648       else if (!strcmp(argv[1], "dimensions") || !strcmp(argv[1], "all"))
649         {
650           pos = 0;
651           match_byte_assert(1);
652           match_byte_assert(0);
653           match_u32_assert(3);
654           match_byte_assert(1);
655           if (!match_byte(0))
656             match_byte_assert(1);
657           match_byte_assert(0);
658           match_byte_assert(0);
659           if (!match_byte(0))
660             match_byte_assert(1);
661           pos++;
662           match_byte_assert(0);
663           match_byte_assert(0);
664           match_byte_assert(0);
665           dump_title ();
666           dump_fonts();
667           dump_dims ();
668           printf("\n\ndata:\n");
669           dump_data ();
670           match_byte (1);
671           if (pos != n)
672             {
673               fprintf (stderr, "%x / %x\n", pos, n);
674               exit(1);
675             }
676           exit(0);
677         }
678       else
679         {
680           fprintf (stderr, "unknown section %s\n", argv[1]);
681           exit(1);
682         }
683     }
684   else
685     start = 0x27;
686
687   for (size_t i = start; i < n; )
688     {
689       if (i + 5 <= n
690           && data[i]
691           //&& !data[i + 1]
692           && !data[i + 2]
693           && !data[i + 3]
694           && i + 4 + data[i] + data[i + 1] * 256 <= n
695           && all_ascii(&data[i + 4], data[i] + data[i + 1] * 256))
696         {
697           fputs("\n\"", stdout);
698           fwrite(&data[i + 4], 1, data[i] + data[i + 1] * 256, stdout);
699           fputs("\" ", stdout);
700
701           i += 4 + data[i] + data[i + 1] * 256;
702         }
703       else if (i + 12 <= n
704                && data[i + 1] == 40
705                && data[i + 2] == 5
706                && data[i + 3] == 0)
707         {
708           double d;
709
710           memcpy (&d, &data[i + 4], 8);
711           printf ("F40.%d(%.*f)\n", data[i], data[i], d);
712           i += 12;
713         }
714       else if (i + 12 <= n
715                && data[i + 1] == 40
716                && data[i + 2] == 31
717                && data[i + 3] == 0)
718         {
719           double d;
720
721           memcpy (&d, &data[i + 4], 8);
722           printf ("PCT40.%d(%.*f)\n", data[i], data[i], d);
723           i += 12;
724         }
725       else if (i + 4 <= n
726                && (data[i] && data[i] != 88 && data[i] != 0x41)
727                && !data[i + 1]
728                && !data[i + 2]
729                && !data[i + 3])
730         {
731           printf ("i%d ", data[i]);
732           i += 4;
733         }
734       else
735         {
736           printf("%02x ", data[i]);
737           i++;
738         }
739     }
740
741   return 0;
742 }