spv: Encode and decode AHEX format in light binary members.
[pspp] / src / output / spv / spv-writer.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2019 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "output/spv/spv-writer.h"
20
21 #include <inttypes.h>
22 #include <libxml/xmlwriter.h>
23 #include <math.h>
24 #include <stdlib.h>
25 #include <time.h>
26
27 #include "libpspp/array.h"
28 #include "libpspp/assertion.h"
29 #include "libpspp/cast.h"
30 #include "libpspp/float-format.h"
31 #include "libpspp/integer-format.h"
32 #include "libpspp/temp-file.h"
33 #include "libpspp/version.h"
34 #include "libpspp/zip-writer.h"
35 #include "output/page-setup-item.h"
36 #include "output/pivot-table.h"
37 #include "output/text-item.h"
38
39 #include "gl/xalloc.h"
40 #include "gl/xvasprintf.h"
41
42 #include "gettext.h"
43 #define _(msgid) gettext (msgid)
44 #define N_(msgid) (msgid)
45
46 struct spv_writer
47   {
48     struct zip_writer *zw;
49
50     FILE *heading;
51     int heading_depth;
52     xmlTextWriter *xml;
53
54     int n_tables;
55
56     int n_headings;
57     struct page_setup *page_setup;
58     bool need_page_break;
59   };
60
61 char * WARN_UNUSED_RESULT
62 spv_writer_open (const char *filename, struct spv_writer **writerp)
63 {
64   *writerp = NULL;
65
66   struct zip_writer *zw = zip_writer_create (filename);
67   if (!zw)
68     return xasprintf (_("%s: create failed"), filename);
69
70   struct spv_writer *w = xmalloc (sizeof *w);
71   *w = (struct spv_writer) { .zw = zw };
72   *writerp = w;
73   return NULL;
74 }
75
76 char * WARN_UNUSED_RESULT
77 spv_writer_close (struct spv_writer *w)
78 {
79   if (!w)
80     return NULL;
81
82   zip_writer_add_string (w->zw, "META-INF/MANIFEST.MF", "allowPivoting=true");
83
84   while (w->heading_depth)
85     spv_writer_close_heading (w);
86
87   char *error = NULL;
88   if (!zip_writer_close (w->zw))
89     error = xstrdup (_("I/O error writing SPV file"));
90
91   page_setup_destroy (w->page_setup);
92   free (w);
93   return error;
94 }
95
96 void
97 spv_writer_set_page_setup (struct spv_writer *w,
98                            const struct page_setup *page_setup)
99 {
100   page_setup_destroy (w->page_setup);
101   w->page_setup = page_setup_clone (page_setup);
102 }
103
104 static void
105 write_attr (struct spv_writer *w, const char *name, const char *value)
106 {
107   xmlTextWriterWriteAttribute (w->xml,
108                                CHAR_CAST (xmlChar *, name),
109                                CHAR_CAST (xmlChar *, value));
110 }
111
112 static void PRINTF_FORMAT (3, 4)
113 write_attr_format (struct spv_writer *w, const char *name,
114                    const char *format, ...)
115 {
116   va_list args;
117   va_start (args, format);
118   char *value = xvasprintf (format, args);
119   va_end (args);
120
121   write_attr (w, name, value);
122   free (value);
123 }
124
125 static void
126 start_elem (struct spv_writer *w, const char *name)
127 {
128   xmlTextWriterStartElement (w->xml, CHAR_CAST (xmlChar *, name));
129 }
130
131 static void
132 end_elem (struct spv_writer *w)
133 {
134   xmlTextWriterEndElement (w->xml);
135 }
136
137 static void
138 write_text (struct spv_writer *w, const char *text)
139 {
140   xmlTextWriterWriteString (w->xml, CHAR_CAST (xmlChar *, text));
141 }
142
143 static void
144 write_page_heading (struct spv_writer *w, const struct page_heading *h,
145                     const char *name)
146 {
147   start_elem (w, name);
148   if (h->n)
149     {
150       start_elem (w, "pageParagraph");
151       for (size_t i = 0; i < h->n; i++)
152         {
153           start_elem (w, "text");
154           write_attr (w, "type", "title");
155           write_text (w, h->paragraphs[i].markup); /* XXX */
156           end_elem (w);
157         }
158       end_elem (w);
159     }
160   end_elem (w);
161 }
162
163 static void
164 write_page_setup (struct spv_writer *w, const struct page_setup *ps)
165 {
166   start_elem (w, "pageSetup");
167   write_attr_format (w, "initial-page-number", "%d", ps->initial_page_number);
168   write_attr (w, "chart-size",
169               (ps->chart_size == PAGE_CHART_AS_IS ? "as-is"
170                : ps->chart_size == PAGE_CHART_FULL_HEIGHT ? "full-height"
171                : ps->chart_size == PAGE_CHART_HALF_HEIGHT ? "half-height"
172                : "quarter-height"));
173   write_attr_format (w, "margin-left", "%.2fin", ps->margins[TABLE_HORZ][0]);
174   write_attr_format (w, "margin-right", "%.2fin", ps->margins[TABLE_HORZ][1]);
175   write_attr_format (w, "margin-top", "%.2fin", ps->margins[TABLE_VERT][0]);
176   write_attr_format (w, "margin-bottom", "%.2fin", ps->margins[TABLE_VERT][1]);
177   write_attr_format (w, "paper-height", "%.2fin", ps->paper[TABLE_VERT]);
178   write_attr_format (w, "paper-width", "%.2fin", ps->paper[TABLE_HORZ]);
179   write_attr (w, "reference-orientation",
180               ps->orientation == PAGE_PORTRAIT ? "portrait" : "landscape");
181   write_attr_format (w, "space-after", "%.1fpt", ps->object_spacing * 72.0);
182   write_page_heading (w, &ps->headings[0], "pageHeader");
183   write_page_heading (w, &ps->headings[1], "pageFooter");
184   end_elem (w);
185 }
186
187 static bool
188 spv_writer_open_file (struct spv_writer *w)
189 {
190   w->heading = create_temp_file ();
191   if (!w->heading)
192     return false;
193
194   w->xml = xmlNewTextWriter (xmlOutputBufferCreateFile (w->heading, NULL));
195   xmlTextWriterStartDocument (w->xml, NULL, "UTF-8", NULL);
196   start_elem (w, "heading");
197
198   time_t t = time (NULL);
199   struct tm *tm = gmtime (&t);
200   char *tm_s = asctime (tm);
201   write_attr (w, "creation-date-time", tm_s);
202
203   write_attr (w, "creator", version);
204
205   write_attr (w, "creator-version", "21");
206
207   write_attr (w, "xmlns", "http://xml.spss.com/spss/viewer/viewer-tree");
208   write_attr (w, "xmlns:vps", "http://xml.spss.com/spss/viewer/viewer-pagesetup");
209   write_attr (w, "xmlns:vtx", "http://xml.spss.com/spss/viewer/viewer-text");
210   write_attr (w, "xmlns:vtb", "http://xml.spss.com/spss/viewer/viewer-table");
211
212   start_elem (w, "label");
213   write_text (w, _("Output"));
214   end_elem (w);
215
216   if (w->page_setup)
217     {
218       write_page_setup (w, w->page_setup);
219
220       page_setup_destroy (w->page_setup);
221       w->page_setup = NULL;
222     }
223
224   return true;
225 }
226
227 void
228 spv_writer_open_heading (struct spv_writer *w, const char *command_id,
229                          const char *label)
230 {
231   if (!w->heading)
232     {
233       if (!spv_writer_open_file (w))
234         return;
235     }
236
237   w->heading_depth++;
238   start_elem (w, "heading");
239   write_attr (w, "commandName", command_id);
240   /* XXX locale */
241   /* XXX olang */
242
243   start_elem (w, "label");
244   write_text (w, label);
245   end_elem (w);
246 }
247
248 static void
249 spv_writer_close_file (struct spv_writer *w, const char *infix)
250 {
251   if (!w->heading)
252     return;
253
254   end_elem (w);
255   xmlTextWriterEndDocument (w->xml);
256   xmlFreeTextWriter (w->xml);
257
258   char *member_name = xasprintf ("outputViewer%010d%s.xml",
259                                  w->n_headings++, infix);
260   zip_writer_add (w->zw, w->heading, member_name);
261   free (member_name);
262
263   w->heading = NULL;
264 }
265
266 void
267 spv_writer_close_heading (struct spv_writer *w)
268 {
269   const char *infix = "";
270   if (w->heading_depth)
271     {
272       infix = "_heading";
273       end_elem (w);
274       w->heading_depth--;
275     }
276
277   if (!w->heading_depth)
278     spv_writer_close_file (w, infix);
279 }
280
281 static void
282 start_container (struct spv_writer *w)
283 {
284   start_elem (w, "container");
285   write_attr (w, "visibility", "visible");
286   if (w->need_page_break)
287     {
288       write_attr (w, "page-break-before", "always");
289       w->need_page_break = false;
290     }
291 }
292
293 void
294 spv_writer_put_text (struct spv_writer *w, const struct text_item *text,
295                      const char *command_id)
296 {
297   bool initial_depth = w->heading_depth;
298   if (!initial_depth)
299     spv_writer_open_file (w);
300
301   start_container (w);
302
303   start_elem (w, "label");
304   write_text (w, (text->type == TEXT_ITEM_TITLE ? "Title"
305                   : text->type == TEXT_ITEM_PAGE_TITLE ? "Page Title"
306                   : "Log"));
307   end_elem (w);
308
309   start_elem (w, "vtx:text");
310   write_attr (w, "type", (text->type == TEXT_ITEM_TITLE ? "title"
311                           : text->type == TEXT_ITEM_PAGE_TITLE ? "page-title"
312                           : "log"));
313   if (command_id)
314     write_attr (w, "commandName", command_id);
315
316   start_elem (w, "html");
317   write_text (w, text->text);   /* XXX */
318   end_elem (w); /* html */
319   end_elem (w); /* vtx:text */
320   end_elem (w); /* container */
321
322   if (!initial_depth)
323     spv_writer_close_file (w, "");
324 }
325
326 void
327 spv_writer_eject_page (struct spv_writer *w)
328 {
329   w->need_page_break = true;
330 }
331 \f
332 #define H TABLE_HORZ
333 #define V TABLE_VERT
334
335 struct buf
336   {
337     uint8_t *data;
338     size_t len;
339     size_t allocated;
340   };
341
342 static uint8_t *
343 put_uninit (struct buf *b, size_t n)
344 {
345   while (b->allocated - b->len < n)
346     b->data = x2nrealloc (b->data, &b->allocated, sizeof b->data);
347   uint8_t *p = &b->data[b->len];
348   b->len += n;
349   return p;
350 }
351
352 static void
353 put_byte (struct buf *b, uint8_t byte)
354 {
355   *put_uninit (b, 1) = byte;
356 }
357
358 static void
359 put_bool (struct buf *b, bool boolean)
360 {
361   put_byte (b, boolean);
362 }
363
364 static void
365 put_bytes (struct buf *b, const char *bytes, size_t n)
366 {
367   memcpy (put_uninit (b, n), bytes, n);
368 }
369
370 static void
371 put_u16 (struct buf *b, uint16_t x)
372 {
373   put_uint16 (native_to_le16 (x), put_uninit (b, sizeof x));
374 }
375
376 static void
377 put_u32 (struct buf *b, uint32_t x)
378 {
379   put_uint32 (native_to_le32 (x), put_uninit (b, sizeof x));
380 }
381
382 static void
383 put_u64 (struct buf *b, uint64_t x)
384 {
385   put_uint64 (native_to_le64 (x), put_uninit (b, sizeof x));
386 }
387
388 static void
389 put_be32 (struct buf *b, uint32_t x)
390 {
391   put_uint32 (native_to_be32 (x), put_uninit (b, sizeof x));
392 }
393
394 static void
395 put_double (struct buf *b, double x)
396 {
397   float_convert (FLOAT_NATIVE_DOUBLE, &x,
398                  FLOAT_IEEE_DOUBLE_LE, put_uninit (b, 8));
399 }
400
401 static void
402 put_float (struct buf *b, float x)
403 {
404   float_convert (FLOAT_NATIVE_FLOAT, &x,
405                  FLOAT_IEEE_SINGLE_LE, put_uninit (b, 4));
406 }
407
408 static void
409 put_string (struct buf *b, const char *s_)
410 {
411   const char *s = s_ ? s_ : "";
412   size_t len = strlen (s);
413   put_u32 (b, len);
414   memcpy (put_uninit (b, len), s, len);
415 }
416
417 static void
418 put_bestring (struct buf *b, const char *s_)
419 {
420   const char *s = s_ ? s_ : "";
421   size_t len = strlen (s);
422   put_be32 (b, len);
423   memcpy (put_uninit (b, len), s, len);
424 }
425
426 static size_t
427 start_count (struct buf *b)
428 {
429   put_u32 (b, 0);
430   return b->len;
431 }
432
433 static void
434 end_count_u32 (struct buf *b, size_t start)
435 {
436   put_uint32 (native_to_le32 (b->len - start), &b->data[start - 4]);
437 }
438
439 static void
440 end_count_be32 (struct buf *b, size_t start)
441 {
442   put_uint32 (native_to_be32 (b->len - start), &b->data[start - 4]);
443 }
444
445 static void
446 put_color (struct buf *buf, const struct cell_color *color)
447 {
448   char *s = xasprintf ("#%02"PRIx8"%02"PRIx8"%02"PRIx8,
449                        color->r, color->g, color->b);
450   put_string (buf, s);
451   free (s);
452 }
453
454 static void
455 put_font_style (struct buf *buf, const struct font_style *font_style)
456 {
457   put_bool (buf, font_style->bold);
458   put_bool (buf, font_style->italic);
459   put_bool (buf, font_style->underline);
460   put_bool (buf, 1);
461   put_color (buf, &font_style->fg[0]);
462   put_color (buf, &font_style->bg[0]);
463   put_string (buf, font_style->typeface ? font_style->typeface : "SansSerif");
464   put_byte (buf, ceil (font_style->size * 1.33));
465 }
466
467 static void
468 put_halign (struct buf *buf, enum table_halign halign,
469             uint32_t mixed, uint32_t decimal)
470 {
471   put_u32 (buf, (halign == TABLE_HALIGN_RIGHT ? 4
472                  : halign == TABLE_HALIGN_LEFT ? 2
473                  : halign == TABLE_HALIGN_CENTER ? 0
474                  : halign == TABLE_HALIGN_MIXED ? mixed
475                  : decimal));
476 }
477
478 static void
479 put_valign (struct buf *buf, enum table_valign valign)
480 {
481   put_u32 (buf, (valign == TABLE_VALIGN_TOP ? 1
482                  : valign == TABLE_VALIGN_CENTER ? 0
483                  : 3));
484 }
485
486 static void
487 put_cell_style (struct buf *buf, const struct cell_style *cell_style)
488 {
489   put_halign (buf, cell_style->halign, 0xffffffad, 6);
490   put_valign (buf, cell_style->valign);
491   put_double (buf, cell_style->decimal_offset);
492   put_u16 (buf, cell_style->margin[H][0]);
493   put_u16 (buf, cell_style->margin[H][1]);
494   put_u16 (buf, cell_style->margin[V][0]);
495   put_u16 (buf, cell_style->margin[V][1]);
496 }
497
498 static void UNUSED
499 put_style_pair (struct buf *buf, const struct font_style *font_style,
500                 const struct cell_style *cell_style)
501 {
502   if (font_style)
503     {
504       put_byte (buf, 0x31);
505       put_font_style (buf, font_style);
506     }
507   else
508     put_byte (buf, 0x58);
509
510   if (cell_style)
511     {
512       put_byte (buf, 0x31);
513       put_cell_style (buf, cell_style);
514     }
515   else
516     put_byte (buf, 0x58);
517 }
518
519 static void
520 put_value_mod (struct buf *buf, const struct pivot_value *value,
521                const char *template)
522 {
523   if (value->n_footnotes || value->n_subscripts
524       || template || value->font_style || value->cell_style)
525     {
526       put_byte (buf, 0x31);
527
528       /* Footnotes. */
529       put_u32 (buf, value->n_footnotes);
530       for (size_t i = 0; i < value->n_footnotes; i++)
531         put_u16 (buf, value->footnote_indexes[i]);
532
533       /* Subscripts. */
534       put_u32 (buf, value->n_subscripts);
535       for (size_t i = 0; i < value->n_subscripts; i++)
536         put_string (buf, value->subscripts[i]);
537
538       /* Template and style. */
539       uint32_t v3_start = start_count (buf);
540       uint32_t template_string_start = start_count (buf);
541       if (template)
542         {
543           uint32_t inner_start = start_count (buf);
544           end_count_u32 (buf, inner_start);
545
546           put_byte (buf, 0x31);
547           put_string (buf, template);
548         }
549       end_count_u32 (buf, template_string_start);
550       put_style_pair (buf, value->font_style, value->cell_style);
551       end_count_u32 (buf, v3_start);
552     }
553   else
554     put_byte (buf, 0x58);
555 }
556
557 static void
558 put_format (struct buf *buf, const struct fmt_spec *f, bool honor_small)
559 {
560   int type = f->type == FMT_F && honor_small ? 40 : fmt_to_io (f->type);
561   put_u32 (buf, (type << 16) | (f->w << 8) | f->d);
562 }
563
564 static int
565 show_values_to_spvlb (enum settings_value_show show)
566 {
567   return (show == SETTINGS_VALUE_SHOW_DEFAULT ? 0
568           : show == SETTINGS_VALUE_SHOW_VALUE ? 1
569           : show == SETTINGS_VALUE_SHOW_LABEL ? 2
570           : 3);
571 }
572
573 static void
574 put_show_values (struct buf *buf, enum settings_value_show show)
575 {
576   put_byte (buf, show_values_to_spvlb (show));
577 }
578
579 static void
580 put_value (struct buf *buf, const struct pivot_value *value)
581 {
582   switch (value->type)
583     {
584     case PIVOT_VALUE_NUMERIC:
585       if (value->numeric.var_name || value->numeric.value_label)
586         {
587           put_byte (buf, 2);
588           put_value_mod (buf, value, NULL);
589           put_format (buf, &value->numeric.format, value->numeric.honor_small);
590           put_double (buf, value->numeric.x);
591           put_string (buf, value->numeric.var_name);
592           put_string (buf, value->numeric.value_label);
593           put_show_values (buf, value->numeric.show);
594         }
595       else
596         {
597           put_byte (buf, 1);
598           put_value_mod (buf, value, NULL);
599           put_format (buf, &value->numeric.format, value->numeric.honor_small);
600           put_double (buf, value->numeric.x);
601         }
602       break;
603
604     case PIVOT_VALUE_STRING:
605       put_byte (buf, 4);
606       put_value_mod (buf, value, NULL);
607       size_t len = strlen (value->string.s);
608       if (value->string.hex)
609         put_format (buf, &(struct fmt_spec) { FMT_AHEX, len * 2, 0 }, false);
610       else
611         put_format (buf, &(struct fmt_spec) { FMT_A, len, 0 }, false);
612       put_string (buf, value->string.value_label);
613       put_string (buf, value->string.var_name);
614       put_show_values (buf, value->string.show);
615       put_string (buf, value->string.s);
616       break;
617
618     case PIVOT_VALUE_VARIABLE:
619       put_byte (buf, 5);
620       put_value_mod (buf, value, NULL);
621       put_string (buf, value->variable.var_name);
622       put_string (buf, value->variable.var_label);
623       put_show_values (buf, value->variable.show);
624       break;
625
626     case PIVOT_VALUE_TEXT:
627       put_byte (buf, 3);
628       put_string (buf, value->text.local);
629       put_value_mod (buf, value, NULL);
630       put_string (buf, value->text.id);
631       put_string (buf, value->text.c);
632       put_byte (buf, 1);        /* XXX user-provided */
633       break;
634
635     case PIVOT_VALUE_TEMPLATE:
636       put_byte (buf, 0);
637       put_value_mod (buf, value, value->template.id);
638       put_string (buf, value->template.local);
639       put_u32 (buf, value->template.n_args);
640       for (size_t i = 0; i < value->template.n_args; i++)
641         {
642           const struct pivot_argument *arg = &value->template.args[i];
643           assert (arg->n >= 1);
644           if (arg->n > 1)
645             {
646               put_u32 (buf, arg->n);
647               put_u32 (buf, 0);
648               for (size_t j = 0; j < arg->n; j++)
649                 {
650                   if (j > 0)
651                     put_bytes (buf, "\0\0\0\0", 4);
652                   put_value (buf, arg->values[j]);
653                 }
654             }
655           else
656             {
657               put_u32 (buf, 0);
658               put_value (buf, arg->values[0]);
659             }
660         }
661       break;
662
663     default:
664       NOT_REACHED ();
665     }
666 }
667
668 static void
669 put_optional_value (struct buf *buf, const struct pivot_value *value)
670 {
671   if (value)
672     {
673       put_byte (buf, 0x31);
674       put_value (buf, value);
675     }
676   else
677     put_byte (buf, 0x58);
678 }
679
680 static void
681 put_category (struct buf *buf, const struct pivot_category *c)
682 {
683   put_value (buf, c->name);
684   if (pivot_category_is_leaf (c))
685     {
686       put_bytes (buf, "\0\0\0", 3);
687       put_u32 (buf, 2);
688       put_u32 (buf, c->data_index);
689       put_u32 (buf, 0);
690     }
691   else
692     {
693       put_bytes (buf, "\0\0\1", 3);
694       put_u32 (buf, 0);
695       put_u32 (buf, -1);
696       put_u32 (buf, c->n_subs);
697       for (size_t i = 0; i < c->n_subs; i++)
698         put_category (buf, c->subs[i]);
699     }
700 }
701
702 static void
703 put_y0 (struct buf *buf, const struct pivot_table *table)
704 {
705   put_u32 (buf, table->settings.epoch);
706   put_byte (buf, table->settings.decimal);
707   put_byte (buf, table->grouping);
708 }
709
710 static void
711 put_custom_currency (struct buf *buf, const struct pivot_table *table)
712 {
713   put_u32 (buf, 5);
714   for (int i = 0; i < 5; i++)
715     {
716       enum fmt_type types[5] = { FMT_CCA, FMT_CCB, FMT_CCC, FMT_CCD, FMT_CCE };
717       char *cc = fmt_number_style_to_string (fmt_settings_get_style (
718                                                &table->settings, types[i]));
719       put_string (buf, cc);
720       free (cc);
721     }
722 }
723
724 static void
725 put_x1 (struct buf *buf, const struct pivot_table *table)
726 {
727   put_byte (buf, 0);
728   put_byte (buf, table->show_title ? 1 : 10);
729   put_byte (buf, 0);
730   put_byte (buf, 0);
731   put_show_values (buf, table->show_variables);
732   put_show_values (buf, table->show_values);
733   put_u32 (buf, -1);
734   put_u32 (buf, -1);
735   for (int i = 0; i < 17; i++)
736     put_byte (buf, 0);
737   put_bool (buf, false);
738   put_byte (buf, table->show_caption);
739 }
740
741 static void
742 put_x2 (struct buf *buf)
743 {
744   put_u32 (buf, 0);             /* n-row-heights */
745   put_u32 (buf, 0);             /* n-style-map */
746   put_u32 (buf, 0);             /* n-styles */
747   put_u32 (buf, 0);
748 }
749
750 static void
751 put_x3 (struct buf *buf, const struct pivot_table *table)
752 {
753   put_bytes (buf, "\1\0\4\0\0\0", 6);
754   put_string (buf, table->command_c);
755   put_string (buf, table->command_local);
756   put_string (buf, table->language);
757   put_string (buf, "UTF-8");    /* XXX */
758   put_string (buf, table->locale);
759   put_bytes (buf, "\0\0\1\1", 4);
760   put_y0 (buf, table);
761   put_double (buf, table->small);
762   put_byte (buf, 1);
763   put_string (buf, table->dataset);
764   put_string (buf, table->datafile);
765   put_u32 (buf, 0);
766   put_u32 (buf, table->date);
767   put_u32 (buf, 0);
768
769   /* Y2. */
770   put_custom_currency (buf, table);
771   put_byte (buf, '.');
772   put_bool (buf, 0);
773 }
774
775 static void
776 put_light_table (struct buf *buf, uint64_t table_id,
777                  const struct pivot_table *table)
778 {
779   /* Header. */
780   put_bytes (buf, "\1\0", 2);
781   put_u32 (buf, 3);
782   put_bool (buf, true);
783   put_bool (buf, false);
784   put_bool (buf, table->rotate_inner_column_labels);
785   put_bool (buf, table->rotate_outer_row_labels);
786   put_bool (buf, true);
787   put_u32 (buf, 0x15);
788   put_u32 (buf, table->look->width_ranges[H][0]);
789   put_u32 (buf, table->look->width_ranges[H][1]);
790   put_u32 (buf, table->look->width_ranges[V][0]);
791   put_u32 (buf, table->look->width_ranges[V][1]);
792   put_u64 (buf, table_id);
793
794   /* Titles. */
795   put_value (buf, table->title);
796   put_value (buf, table->subtype);
797   put_optional_value (buf, table->title);
798   put_optional_value (buf, table->corner_text);
799   put_optional_value (buf, table->caption);
800
801   /* Footnotes. */
802   put_u32 (buf, table->n_footnotes);
803   for (size_t i = 0; i < table->n_footnotes; i++)
804     {
805       put_value (buf, table->footnotes[i]->content);
806       put_optional_value (buf, table->footnotes[i]->marker);
807       put_u32 (buf, 0);
808     }
809
810   /* Areas. */
811   for (size_t i = 0; i < PIVOT_N_AREAS; i++)
812     {
813       const struct table_area_style *a = &table->look->areas[i];
814       put_byte (buf, i + 1);
815       put_byte (buf, 0x31);
816       put_string (buf, (a->font_style.typeface
817                         ? a->font_style.typeface
818                         : "SansSerif"));
819       put_float (buf, ceil (a->font_style.size * 1.33));
820       put_u32 (buf, ((a->font_style.bold ? 1 : 0)
821                      | (a->font_style.italic ? 2 : 0)));
822       put_bool (buf, a->font_style.underline);
823       put_halign (buf, a->cell_style.halign, 64173, 61453);
824       put_valign (buf, a->cell_style.valign);
825
826       put_color (buf, &a->font_style.fg[0]);
827       put_color (buf, &a->font_style.bg[0]);
828
829       bool alt
830         = (!cell_color_equal (&a->font_style.fg[0], &a->font_style.fg[1])
831            || !cell_color_equal (&a->font_style.bg[0], &a->font_style.bg[1]));
832       put_bool (buf, alt);
833       if (alt)
834         {
835           put_color (buf, &a->font_style.fg[1]);
836           put_color (buf, &a->font_style.bg[1]);
837         }
838       else
839         {
840           put_string (buf, "");
841           put_string (buf, "");
842         }
843
844       put_u32 (buf, a->cell_style.margin[H][0]);
845       put_u32 (buf, a->cell_style.margin[H][1]);
846       put_u32 (buf, a->cell_style.margin[V][0]);
847       put_u32 (buf, a->cell_style.margin[V][1]);
848     }
849
850   /* Borders. */
851   uint32_t borders_start = start_count (buf);
852   put_be32 (buf, 1);
853   put_be32 (buf, PIVOT_N_BORDERS);
854   for (size_t i = 0; i < PIVOT_N_BORDERS; i++)
855     {
856       const struct table_border_style *b = &table->look->borders[i];
857       put_be32 (buf, i);
858       put_be32 (buf, (b->stroke == TABLE_STROKE_NONE ? 0
859                       : b->stroke == TABLE_STROKE_SOLID ? 1
860                       : b->stroke == TABLE_STROKE_DASHED ? 2
861                       : b->stroke == TABLE_STROKE_THICK ? 3
862                       : b->stroke == TABLE_STROKE_THIN ? 4
863                       : 5));
864       put_be32 (buf, ((b->color.alpha << 24)
865                       | (b->color.r << 16)
866                       | (b->color.g << 8)
867                       | b->color.b));
868     }
869   put_bool (buf, table->show_grid_lines);
870   put_bytes (buf, "\0\0\0", 3);
871   end_count_u32 (buf, borders_start);
872
873   /* Print Settings. */
874   uint32_t ps_start = start_count (buf);
875   put_be32 (buf, 1);
876   put_bool (buf, table->look->print_all_layers);
877   put_bool (buf, table->look->paginate_layers);
878   put_bool (buf, table->look->shrink_to_fit[H]);
879   put_bool (buf, table->look->shrink_to_fit[V]);
880   put_bool (buf, table->look->top_continuation);
881   put_bool (buf, table->look->bottom_continuation);
882   put_be32 (buf, table->look->n_orphan_lines);
883   put_bestring (buf, table->look->continuation);
884   end_count_u32 (buf, ps_start);
885
886   /* Table Settings. */
887   uint32_t ts_start = start_count (buf);
888   put_be32 (buf, 1);
889   put_be32 (buf, 4);
890   put_be32 (buf, 0);            /* XXX current_layer */
891   put_bool (buf, table->look->omit_empty);
892   put_bool (buf, table->look->row_labels_in_corner);
893   put_bool (buf, !table->look->show_numeric_markers);
894   put_bool (buf, table->look->footnote_marker_superscripts);
895   put_byte (buf, 0);
896   uint32_t keep_start = start_count (buf);
897   put_be32 (buf, 0);            /* n-row-breaks */
898   put_be32 (buf, 0);            /* n-column-breaks */
899   put_be32 (buf, 0);            /* n-row-keeps */
900   put_be32 (buf, 0);            /* n-column-keeps */
901   put_be32 (buf, 0);            /* n-row-point-keeps */
902   put_be32 (buf, 0);            /* n-column-point-keeps */
903   end_count_be32 (buf, keep_start);
904   put_bestring (buf, table->notes);
905   put_bestring (buf, table->look->name);
906   for (size_t i = 0; i < 82; i++)
907     put_byte (buf, 0);
908   end_count_u32 (buf, ts_start);
909
910   /* Formats. */
911   put_u32 (buf, 0);             /* n-widths */
912   put_string (buf, "en_US.ISO_8859-1:1987"); /* XXX */
913   put_u32 (buf, 0);                /* XXX current-layer */
914   put_bool (buf, 0);
915   put_bool (buf, 0);
916   put_bool (buf, 1);
917   put_y0 (buf, table);
918   put_custom_currency (buf, table);
919   uint32_t formats_start = start_count (buf);
920   uint32_t x1_start = start_count (buf);
921   put_x1 (buf, table);
922   uint32_t x2_start = start_count (buf);
923   put_x2 (buf);
924   end_count_u32 (buf, x2_start);
925   end_count_u32 (buf, x1_start);
926   uint32_t x3_start = start_count (buf);
927   put_x3 (buf, table);
928   end_count_u32 (buf, x3_start);
929   end_count_u32 (buf, formats_start);
930
931   /* Dimensions. */
932   put_u32 (buf, table->n_dimensions);
933   int *x2 = xnmalloc (table->n_dimensions, sizeof *x2);
934   for (size_t i = 0; i < table->axes[PIVOT_AXIS_LAYER].n_dimensions; i++)
935     x2[i] = 2;
936   for (size_t i = 0; i < table->axes[PIVOT_AXIS_ROW].n_dimensions; i++)
937     x2[i + table->axes[PIVOT_AXIS_LAYER].n_dimensions] = 0;
938   for (size_t i = 0; i < table->axes[PIVOT_AXIS_COLUMN].n_dimensions; i++)
939     x2[i
940        + table->axes[PIVOT_AXIS_LAYER].n_dimensions
941        + table->axes[PIVOT_AXIS_ROW].n_dimensions] = 1;
942   for (size_t i = 0; i < table->n_dimensions; i++)
943     {
944       const struct pivot_dimension *d = table->dimensions[i];
945       put_value (buf, d->root->name);
946       put_byte (buf, 0);
947       put_byte (buf, x2[i]);
948       put_u32 (buf, 2);
949       put_bool (buf, !d->root->show_label);
950       put_bool (buf, d->hide_all_labels);
951       put_bool (buf, 1);
952       put_u32 (buf, i);
953
954       put_u32 (buf, d->root->n_subs);
955       for (size_t j = 0; j < d->root->n_subs; j++)
956         put_category (buf, d->root->subs[j]);
957     }
958   free (x2);
959
960   /* Axes. */
961   put_u32 (buf, table->axes[PIVOT_AXIS_LAYER].n_dimensions);
962   put_u32 (buf, table->axes[PIVOT_AXIS_ROW].n_dimensions);
963   put_u32 (buf, table->axes[PIVOT_AXIS_COLUMN].n_dimensions);
964   for (size_t i = 0; i < table->axes[PIVOT_AXIS_LAYER].n_dimensions; i++)
965     put_u32 (buf, table->axes[PIVOT_AXIS_LAYER].dimensions[i]->top_index);
966   for (size_t i = 0; i < table->axes[PIVOT_AXIS_ROW].n_dimensions; i++)
967     put_u32 (buf, table->axes[PIVOT_AXIS_ROW].dimensions[i]->top_index);
968   for (size_t i = 0; i < table->axes[PIVOT_AXIS_COLUMN].n_dimensions; i++)
969     put_u32 (buf, table->axes[PIVOT_AXIS_COLUMN].dimensions[i]->top_index);
970
971   /* Cells. */
972   put_u32 (buf, hmap_count (&table->cells));
973   const struct pivot_cell *cell;
974   HMAP_FOR_EACH (cell, struct pivot_cell, hmap_node, &table->cells)
975     {
976       uint64_t index = 0;
977       for (size_t j = 0; j < table->n_dimensions; j++)
978         index = (table->dimensions[j]->n_leaves * index) + cell->idx[j];
979       put_u64 (buf, index);
980
981       put_value (buf, cell->value);
982     }
983 }
984
985 void
986 spv_writer_put_table (struct spv_writer *w, const struct pivot_table *table)
987 {
988   struct pivot_table *table_rw = CONST_CAST (struct pivot_table *, table);
989   if (!table_rw->subtype)
990     table_rw->subtype = pivot_value_new_user_text ("unknown", -1);
991
992   int table_id = ++w->n_tables;
993
994   bool initial_depth = w->heading_depth;
995   if (!initial_depth)
996     spv_writer_open_file (w);
997
998   start_container (w);
999
1000   char *title = pivot_value_to_string (table->title, table);
1001   char *subtype = pivot_value_to_string (table->subtype, table);
1002   
1003   start_elem (w, "label");
1004   write_text (w, title);
1005   end_elem (w);
1006
1007   start_elem (w, "vtb:table");
1008   write_attr (w, "commandName", table->command_c);
1009   write_attr (w, "type", "table"); /* XXX */
1010   write_attr (w, "subType", subtype);
1011   write_attr_format (w, "tableId", "%d", table_id);
1012
1013   free (subtype);
1014   free (title);
1015
1016   start_elem (w, "vtb:tableStructure");
1017   start_elem (w, "vtb:dataPath");
1018   char *data_path = xasprintf ("%010d_lightTableData.bin", table_id);
1019   write_text (w, data_path);
1020   end_elem (w); /* vtb:dataPath */
1021   end_elem (w); /* vtb:tableStructure */
1022   end_elem (w); /* vtb:table */
1023   end_elem (w); /* container */
1024
1025   if (!initial_depth)
1026     spv_writer_close_file (w, "");
1027
1028   struct buf buf = { NULL, 0, 0 };
1029   put_light_table (&buf, table_id, table);
1030   zip_writer_add_memory (w->zw, data_path, buf.data, buf.len);
1031   free (buf.data);
1032
1033   free (data_path);
1034 }