treewide: Replace <name>_cnt by n_<name>s and <name>_cap by allocated_<name>.
[pspp] / src / output / tex.c
index 8fad5623114b1e65eb4fc8a4f909a673d3f5239e..de111ec13f47b74177b0a48aed47046a59053e39 100644 (file)
 #include "libpspp/message.h"
 #include "libpspp/temp-file.h"
 #include "libpspp/version.h"
-#include "output/cairo.h"
-#include "output/chart-item.h"
+#include "output/cairo-chart.h"
 #include "output/driver-provider.h"
-#include "output/message-item.h"
 #include "output/options.h"
-#include "output/output-item-provider.h"
+#include "output/output-item.h"
+#include "output/pivot-output.h"
+#include "output/pivot-table.h"
 #include "output/table-provider.h"
-#include "output/table-item.h"
-#include "output/text-item.h"
 #include "output/tex-rendering.h"
 #include "output/tex-parsing.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
+/* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
+#define H TABLE_HORZ
+#define V TABLE_VERT
+
 /* The desired maximum line length in the TeX file.  */
 #define TEX_LINE_MAX 80
 
@@ -66,15 +68,14 @@ struct tex_driver
     struct output_driver driver;
     /* A hash table containing any Tex macros which need to be emitted.  */
     struct hmap macros;
-#ifdef HAVE_CAIRO
+    bool require_graphics;
     struct cell_color fg;
     struct cell_color bg;
-#endif
     struct file_handle *handle;
     char *chart_file_name;
 
     FILE *file;
-    size_t chart_cnt;
+    size_t n_charts;
 
     struct ll_list preamble_list;
     struct ll_list token_list;
@@ -98,7 +99,7 @@ shipout (struct ll_list *list, const char *str, ...)
 
 static const struct output_driver_class tex_driver_class;
 
-static void tex_output_table (struct tex_driver *, const struct table_item *);
+static void tex_output_table (struct tex_driver *, const struct pivot_table *);
 
 static struct tex_driver *
 tex_driver_cast (struct output_driver *driver)
@@ -130,11 +131,9 @@ tex_create (struct file_handle *fh, enum settings_output_devices device_type,
   tex->handle = fh;
   tex->chart_file_name = parse_chart_file_name (opt (d, o, "charts",
                                                       fh_get_file_name (fh)));
-  tex->chart_cnt = 1;
-#ifdef HAVE_CAIRO
-  parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &tex->bg);
-  parse_color (d, o, "foreground-color", "#000000000000", &tex->fg);
-#endif
+  tex->n_charts = 1;
+  tex->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
+  tex->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
 
   tex->file = fn_open (tex->handle, "w");
   if (tex->file == NULL)
@@ -176,7 +175,11 @@ post_process_tokens (FILE *file, struct ll_list *list)
               if (nt->cat == CAT_SPACE || nt->cat == CAT_EOL)
                 break;
               if (prev_x && (prev_x->cat == CAT_COMMENT) && (nt->cat != CAT_COMMENT))
-                break;
+                {
+                  ds_destroy (&prev_x->str);
+                  free (prev_x);
+                  break;
+                }
               word_len += ds_length (&nt->str);
               prev_x = nt;
             }
@@ -185,6 +188,11 @@ post_process_tokens (FILE *file, struct ll_list *list)
             {
               fputs ("\n", file);
               line_len = 0;
+              if (tt)
+                {
+                  ds_destroy (&tt->str);
+                  free (tt);
+                }
               continue;
             }
         }
@@ -215,8 +223,6 @@ tex_destroy (struct output_driver *driver)
   shipout (&tex->preamble_list, "%%%% Define the horizontal space between table columns\n");
   shipout (&tex->preamble_list, "\\def\\psppcolumnspace{1mm}\n\n");
 
-  shipout (&tex->preamble_list, "\\input graphicx\n\n");
-
   char *ln = get_language ();
   if (ln)
     shipout (&tex->preamble_list, "%%%% Language is \"%s\"\n", ln);
@@ -260,6 +266,9 @@ tex_destroy (struct output_driver *driver)
     }
   hmap_destroy (&tex->macros);
 
+  if (tex->require_graphics)
+    shipout (&tex->preamble_list, "\\input graphicx\n\n");
+
   post_process_tokens (tex->file, &tex->preamble_list);
 
   shipout (&tex->token_list, "\n\\bye\n");
@@ -303,142 +312,183 @@ tex_escape_string (struct tex_driver *tex, const char *text,
 }
 
 static void
-tex_submit (struct output_driver *driver,
-             const struct output_item *output_item)
+tex_submit (struct output_driver *driver, const struct output_item *item)
 {
   struct tex_driver *tex = tex_driver_cast (driver);
 
-  if (is_table_item (output_item))
+  switch (item->type)
     {
-      struct table_item *table_item = to_table_item (output_item);
-      tex_output_table (tex, table_item);
-    }
-#ifdef HAVE_CAIRO
-  else if (is_chart_item (output_item) && tex->chart_file_name != NULL)
-    {
-      struct chart_item *chart_item = to_chart_item (output_item);
-      char *file_name = xr_draw_png_chart (chart_item, tex->chart_file_name,
-                                           tex->chart_cnt++,
-                                           &tex->fg,
-                                           &tex->bg);
-      if (file_name != NULL)
+    case OUTPUT_ITEM_CHART:
+      if (tex->chart_file_name != NULL)
         {
-         const char *title = chart_item_get_title (chart_item);
-          //          printf ("The chart title is %s\n", title);
-
-          shipout (&tex->token_list, "\\includegraphics{%s}\n", file_name);
-          free (file_name);
-        }
-    }
-#endif  /* HAVE_CAIRO */
-  else if (is_text_item (output_item))
-    {
-      struct text_item *text_item = to_text_item (output_item);
-      const char *s = text_item_get_text (text_item);
+          char *file_name = xr_draw_png_chart (item->chart,
+                                               tex->chart_file_name,
+                                               tex->n_charts++,
+                                               &tex->fg, &tex->bg);
+          if (file_name != NULL)
+            {
+              //const char *title = chart_item_get_title (chart_item);
+              //          printf ("The chart title is %s\n", title);
 
-      switch (text_item_get_type (text_item))
-        {
-        case TEXT_ITEM_PAGE_TITLE:
-          shipout (&tex->token_list, "\\headline={\\bf ");
-          tex_escape_string (tex, s, false);
-          shipout (&tex->token_list, "\\hfil}\n");
-          break;
-
-        case TEXT_ITEM_LOG:
-          shipout (&tex->token_list, "{\\tt ");
-          tex_escape_string (tex, s, false);
-          shipout (&tex->token_list, "}\\par\n\n");
-          break;
-
-        case TEXT_ITEM_EJECT_PAGE:
-          /* Nothing to do. */
-          break;
-
-        case TEXT_ITEM_SYNTAX:
-          /* So far as I'm aware, this can never happen.  */
-        default:
-          printf ("Unhandled type %d\n", text_item_get_type (text_item));
-          break;
+              shipout (&tex->token_list, "\\includegraphics{%s}\n", file_name);
+              tex->require_graphics = true;
+              free (file_name);
+            }
         }
-    }
-  else if (is_message_item (output_item))
-    {
-      const struct message_item *message_item = to_message_item (output_item);
-      char *s = msg_to_string (message_item_get_msg (message_item));
-      tex_escape_string (tex, s, false);
-      shipout (&tex->token_list, "\\par\n");
-      free (s);
+      break;
+
+    case OUTPUT_ITEM_GROUP:
+      break;
+
+    case OUTPUT_ITEM_IMAGE:
+      {
+        char *file_name = xr_write_png_image (
+          item->image, tex->chart_file_name, tex->n_charts++);
+        if (file_name != NULL)
+          {
+            shipout (&tex->token_list, "\\includegraphics{%s}\n", file_name);
+            tex->require_graphics = true;
+            free (file_name);
+          }
+      }
+      break;
+
+    case OUTPUT_ITEM_MESSAGE:
+      {
+        char *s = msg_to_string (item->message);
+        tex_escape_string (tex, s, false);
+        shipout (&tex->token_list, "\\par\n");
+        free (s);
+      }
+      break;
+
+    case OUTPUT_ITEM_PAGE_BREAK:
+      break;
+
+    case OUTPUT_ITEM_TABLE:
+      tex_output_table (tex, item->table);
+      break;
+
+    case OUTPUT_ITEM_TEXT:
+      {
+        char *s = text_item_get_plain_text (item);
+
+        switch (item->text.subtype)
+          {
+          case TEXT_ITEM_PAGE_TITLE:
+            shipout (&tex->token_list, "\\headline={\\bf ");
+            tex_escape_string (tex, s, false);
+            shipout (&tex->token_list, "\\hfil}\n");
+            break;
+
+          case TEXT_ITEM_LOG:
+            shipout (&tex->token_list, "{\\tt ");
+            tex_escape_string (tex, s, false);
+            shipout (&tex->token_list, "}\\par\n\n");
+            break;
+
+          case TEXT_ITEM_SYNTAX:
+            /* So far as I'm aware, this can never happen.  */
+          default:
+            printf ("Unhandled type %d\n", item->text.subtype);
+            break;
+          }
+        free (s);
+      }
+      break;
     }
 }
 
 static void
 tex_put_footnote_markers (struct tex_driver *tex,
-                           const struct footnote **footnotes,
-                           size_t n_footnotes)
+                          const struct pivot_table *pt,
+                          const struct pivot_value_ex *ex)
 {
-  if (n_footnotes > 0)
-    shipout (&tex->token_list, "$^{");
-  for (size_t i = 0; i < n_footnotes; i++)
+  size_t n_visible = 0;
+  for (size_t i = 0; i < ex->n_footnotes; i++)
     {
-      const struct footnote *f = footnotes[i];
+      const struct pivot_footnote *f = pt->footnotes[ex->footnote_indexes[i]];
+      if (f->show)
+        {
+          if (!n_visible++)
+            shipout (&tex->token_list, "$^{");
 
-      tex_escape_string (tex, f->marker, true);
+          char *marker = pivot_footnote_marker_string (f, pt);
+          tex_escape_string (tex, marker, true);
+          free (marker);
+        }
     }
-  if (n_footnotes > 0)
+  if (n_visible)
     shipout (&tex->token_list, "}$");
 }
 
 static void
-tex_put_table_item_text (struct tex_driver *tex,
-                          const struct table_item_text *text)
+tex_put_table_cell (struct tex_driver *tex, const struct pivot_table *pt,
+                    const struct table_cell *cell)
 {
-  tex_escape_string (tex, text->content, false);
-  tex_put_footnote_markers (tex, text->footnotes, text->n_footnotes);
+  struct string s = DS_EMPTY_INITIALIZER;
+  pivot_value_format_body (cell->value, pt, &s);
+  tex_escape_string (tex, ds_cstr (&s), false);
+  ds_destroy (&s);
+
+  tex_put_footnote_markers (tex, pt, pivot_value_ex (cell->value));
 }
 
 static void
-tex_output_table (struct tex_driver *tex, const struct table_item *item)
+tex_output_table_layer (struct tex_driver *tex, const struct pivot_table *pt,
+                        const size_t *layer_indexes)
 {
   /* Tables are rendered in TeX with the \halign command.
      This is described in the TeXbook Ch. 22 */
-
-  const struct table *t = table_item_get_table (item);
+  struct table *title, *layers, *body, *caption;
+  struct pivot_footnote **footnotes;
+  size_t n_footnotes;
+  pivot_output (pt, layer_indexes, true, &title, &layers, &body,
+                &caption, NULL, &footnotes, &n_footnotes);
 
   shipout (&tex->token_list, "\n{\\parindent=0pt\n");
 
-  const struct table_item_text *caption = table_item_get_caption (item);
   if (caption)
     {
       shipout (&tex->token_list, "{\\sl ");
-      tex_escape_string (tex, caption->content, false);
+      struct table_cell cell;
+      table_get_cell (caption, 0, 0, &cell);
+      tex_put_table_cell (tex, pt, &cell);
       shipout (&tex->token_list, "}\n\n");
     }
-  const struct footnote **f;
-  size_t n_footnotes = table_collect_footnotes (item, &f);
 
-  const struct table_item_text *title = table_item_get_title (item);
-  const struct table_item_layers *layers = table_item_get_layers (item);
   if (title || layers)
     {
       if (title)
         {
           shipout (&tex->token_list, "{\\bf ");
-          tex_put_table_item_text (tex, title);
-          shipout (&tex->token_list, "}");
+          struct table_cell cell;
+          table_get_cell (title, 0, 0, &cell);
+          tex_put_table_cell (tex, pt, &cell);
+          shipout (&tex->token_list, "}\\par\n");
         }
+
       if (layers)
-        abort ();
-      shipout (&tex->token_list, "\\par\n");
+        {
+          for (size_t y = 0; y < layers->n[V]; y++)
+            {
+              shipout (&tex->token_list, "{");
+              struct table_cell cell;
+              table_get_cell (layers, 0, y, &cell);
+              tex_put_table_cell (tex, pt, &cell);
+              shipout (&tex->token_list, "}\\par\n");
+            }
+        }
     }
 
   shipout (&tex->token_list, "\\offinterlineskip\\halign{\\strut%%\n");
 
   /* Generate the preamble */
-  for (int x = 0; x < table_nc (t); ++x)
+  for (int x = 0; x < body->n[H]; ++x)
     {
-      shipout (&tex->token_list, "{\\vbox{\\cell{%d}#}}", table_nc (t));
+      shipout (&tex->token_list, "{\\vbox{\\cell{%d}#}}", body->n[H]);
 
-      if (x < table_nc (t) - 1)
+      if (x < body->n[H] - 1)
         {
           shipout (&tex->token_list, "\\hskip\\psppcolumnspace\\hfil");
           shipout (&tex->token_list, "&\\vrule\n");
@@ -448,17 +498,17 @@ tex_output_table (struct tex_driver *tex, const struct table_item *item)
     }
 
   /* Emit the row data */
-  for (int y = 0; y < table_nr (t); y++)
+  for (int y = 0; y < body->n[V]; y++)
     {
-      bool is_column_header = (y < table_ht (t)
-                               || y >= table_nr (t) - table_hb (t));
+      enum { H = TABLE_HORZ, V = TABLE_VERT };
+      bool is_column_header = y < body->h[V][0] || y >= body->n[V] - body->h[V][1];
       int prev_x = -1;
       int skipped = 0;
-      for (int x = 0; x < table_nc (t);)
+      for (int x = 0; x < body->n[H];)
         {
           struct table_cell cell;
 
-          table_get_cell (t, x, y, &cell);
+          table_get_cell (body, x, y, &cell);
 
           int colspan = table_cell_colspan (&cell);
           if (x > 0)
@@ -471,15 +521,16 @@ tex_output_table (struct tex_driver *tex, const struct table_item *item)
           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
             goto next_1;
 
-          /* bool is_header = (y < table_ht (t) */
-          /*                   || y >= table_nr (t) - table_hb (t) */
-          /*                   || x < table_hl (t) */
-          /*                   || x >= table_nc (t) - table_hr (t)); */
+          /* bool is_header = (y < body->h[V][0] */
+          /*                   || y >= body->n[V] - body->h[V][1] */
+          /*                   || x < body->h[H][0] */
+          /*                   || x >= body->n[H] - body->h[H][1]); */
 
+          struct string s = DS_EMPTY_INITIALIZER;
+          bool numeric = pivot_value_format_body (cell.value, pt, &s);
 
-          enum table_halign halign =
-            table_halign_interpret (cell.style->cell_style.halign,
-                                    cell.options & TAB_NUMERIC);
+          enum table_halign halign = table_halign_interpret (
+            cell.cell_style->halign, numeric);
 
           /* int rowspan = table_cell_rowspan (&cell); */
 
@@ -501,8 +552,10 @@ tex_output_table (struct tex_driver *tex, const struct table_item *item)
             shipout (&tex->token_list, "\\right{");
 
           /* Output cell contents. */
-          tex_escape_string (tex, cell.text, true);
-          tex_put_footnote_markers (tex, cell.footnotes, cell.n_footnotes);
+          tex_escape_string (tex, ds_cstr (&s), true);
+          ds_destroy (&s);
+
+          tex_put_footnote_markers (tex, pt, pivot_value_ex (cell.value));
           if (halign == TABLE_HALIGN_CENTER || halign == TABLE_HALIGN_RIGHT)
             {
               shipout (&tex->token_list, "}");
@@ -526,14 +579,33 @@ tex_output_table (struct tex_driver *tex, const struct table_item *item)
 
   for (int i = 0; i < n_footnotes; ++i)
     {
+      char *marker = pivot_footnote_marker_string (footnotes[i], pt);
+      char *content = pivot_value_to_string (footnotes[i]->content, pt);
+
       shipout (&tex->token_list, "$^{");
-      tex_escape_string (tex, f[i]->marker, false);
+      tex_escape_string (tex, marker, false);
       shipout (&tex->token_list, "}$");
-      tex_escape_string (tex, f[i]->content, false);
+      tex_escape_string (tex, content, false);
+
+      free (content);
+      free (marker);
     }
-  free (f);
 
   shipout (&tex->token_list, "}\n\\vskip 3ex\n\n");
+
+  table_unref (title);
+  table_unref (layers);
+  table_unref (body);
+  table_unref (caption);
+  free (footnotes);
+}
+
+static void
+tex_output_table (struct tex_driver *tex, const struct pivot_table *pt)
+{
+  size_t *layer_indexes;
+  PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, pt, true)
+    tex_output_table_layer (tex, pt, layer_indexes);
 }
 
 struct output_driver_factory tex_driver_factory =
@@ -541,8 +613,7 @@ struct output_driver_factory tex_driver_factory =
 
 static const struct output_driver_class tex_driver_class =
   {
-    "tex",
-    tex_destroy,
-    tex_submit,
-    NULL,
+    .name = "tex",
+    .destroy = tex_destroy,
+    .submit = tex_submit,
   };