output: Render pivot tables monolithically.
[pspp] / src / output / csv.c
index e2c97a64cd479b3ad5b5e921f6e27ef9d8979bca..e6b769b383039c740abdb9c5321c86b5d889724a 100644 (file)
 #include "libpspp/message.h"
 #include "libpspp/str.h"
 #include "libpspp/string-map.h"
-#include "output/text-item.h"
 #include "output/driver-provider.h"
 #include "output/options.h"
-#include "output/message-item.h"
-#include "output/page-eject-item.h"
-#include "output/table-item.h"
+#include "output/output-item.h"
+#include "output/pivot-output.h"
+#include "output/pivot-table.h"
 #include "output/table-provider.h"
 
 #include "gl/minmax.h"
@@ -66,44 +65,46 @@ csv_driver_cast (struct output_driver *driver)
   return UP_CAST (driver, struct csv_driver, driver);
 }
 
-static struct driver_option *
-opt (struct output_driver *d, struct string_map *options, const char *key,
-     const char *default_value)
+static struct driver_option
+opt (struct driver_options *options, const char *key, const char *default_value)
 {
-  return driver_option_get (d, options, key, default_value);
+  return driver_option_get (options, key, default_value);
 }
 
 static struct output_driver *
 csv_create (struct file_handle *fh, enum settings_output_devices device_type,
-            struct string_map *o)
+            struct driver_options *o)
 {
-  struct output_driver *d;
-  struct csv_driver *csv;
-  char *quote;
-
-  csv = xzalloc (sizeof *csv);
-  d = &csv->driver;
-  output_driver_init (&csv->driver, &csv_driver_class, fh_get_file_name (fh), device_type);
-
-  csv->separator = parse_string (opt (d, o, "separator", ","));
-  quote = parse_string (opt (d, o, "quote", "\""));
-  csv->quote = quote[0];
-  free (quote);
-  csv->quote_set = xasprintf ("\n\r\t%s%c", csv->separator, csv->quote);
-  csv->titles = parse_boolean (opt (d, o, "titles", "true"));
-  csv->captions = parse_boolean (opt (d, o, "captions", "true"));
-  csv->handle = fh;
-  csv->file = fn_open (fh, "w");
-  csv->n_items = 0;
-
-  if (csv->file == NULL)
+  FILE *file = fn_open (fh, "w");
+  if (!file)
     {
       msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
-      output_driver_destroy (d);
       return NULL;
     }
 
-  return d;
+  char *quote_s = parse_string (opt (o, "quote", "\""));
+  int quote = quote_s[0];
+  free (quote_s);
+
+  char *separator = parse_string (opt (o, "separator", ","));
+
+  struct csv_driver *csv = xmalloc (sizeof *csv);
+  *csv = (struct csv_driver) {
+    .driver = {
+      .class = &csv_driver_class,
+      .name = xstrdup (fh_get_file_name (fh)),
+      .device_type = device_type,
+    },
+    .separator = separator,
+    .quote = quote,
+    .quote_set = xasprintf ("\n\r\t%s%c", separator, quote),
+    .titles = parse_boolean (opt (o, "titles", "true")),
+    .captions = parse_boolean (opt (o, "captions", "true")),
+    .handle = fh,
+    .file = file,
+  };
+
+  return &csv->driver;
 }
 
 static void
@@ -175,143 +176,115 @@ csv_output_lines (struct csv_driver *csv, const char *text_)
 }
 
 static void
-csv_format_footnotes (const struct footnote **f, size_t n, struct string *s)
-{
-  for (size_t i = 0; i < n; i++)
-    ds_put_format (s, "[%s]", f[i]->marker);
-}
-
-static void
-csv_output_table_item_text (struct csv_driver *csv,
-                            const struct table_item_text *text,
-                            const char *leader)
+csv_output_table_cell (struct csv_driver *csv, const struct pivot_table *pt,
+                       const struct table_cell *cell, const char *leader)
 {
-  if (!text)
-    return;
-
   struct string s = DS_EMPTY_INITIALIZER;
-  ds_put_format (&s, "%s: %s", leader, text->content);
-  csv_format_footnotes (text->footnotes, text->n_footnotes, &s);
+  if (leader)
+    ds_put_format (&s, "%s: ", leader);
+  pivot_value_format (cell->value, pt, &s);
   csv_output_field (csv, ds_cstr (&s));
   ds_destroy (&s);
-  putc ('\n', csv->file);
 }
 
 static void
-csv_submit (struct output_driver *driver,
-            const struct output_item *output_item)
+csv_output_table__ (struct csv_driver *csv, const struct pivot_table *pt,
+                    const struct table *t, const char *leader)
 {
-  struct csv_driver *csv = csv_driver_cast (driver);
+  if (!t)
+    return;
 
-  if (is_table_item (output_item))
+  for (int y = 0; y < t->n[TABLE_VERT]; y++)
     {
-      struct table_item *table_item = to_table_item (output_item);
-      const struct table *t = table_item_get_table (table_item);
-      int x, y;
+      for (int x = 0; x < t->n[TABLE_HORZ]; x++)
+        {
+          struct table_cell cell;
 
-      csv_put_separator (csv);
+          table_get_cell (t, x, y, &cell);
 
-      if (csv->titles)
-        csv_output_table_item_text (csv, table_item_get_title (table_item),
-                                    "Table");
+          if (x > 0)
+            fputs (csv->separator, csv->file);
 
-      for (y = 0; y < table_nr (t); y++)
-        {
-          for (x = 0; x < table_nc (t); x++)
-            {
-              struct table_cell cell;
-
-              table_get_cell (t, x, y, &cell);
-
-              if (x > 0)
-                fputs (csv->separator, csv->file);
-
-              if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
-                csv_output_field (csv, "");
-              else if (!(cell.options & TAB_MARKUP) && !cell.n_footnotes
-                       && !cell.n_subscripts && !cell.superscript)
-                csv_output_field (csv, cell.text);
-              else
-                {
-                  struct string s = DS_EMPTY_INITIALIZER;
-
-                  if (cell.options & TAB_MARKUP)
-                    {
-                      char *t = output_get_text_from_markup (cell.text);
-                      ds_put_cstr (&s, t);
-                      free (t);
-                    }
-                  else
-                    ds_put_cstr (&s, cell.text);
-
-                  if (cell.n_subscripts)
-                    for (size_t i = 0; i < cell.n_subscripts; i++)
-                      ds_put_format (&s, "%c%s",
-                                     i ? ',' : '_', cell.subscripts[i]);
-                  if (cell.superscript)
-                    ds_put_format (&s, "^%s", cell.superscript);
-                  csv_format_footnotes (cell.footnotes, cell.n_footnotes, &s);
-                  csv_output_field (csv, ds_cstr (&s));
-                  ds_destroy (&s);
-                }
-            }
-          putc ('\n', csv->file);
+          if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
+            csv_output_field (csv, "");
+          else
+            csv_output_table_cell (csv, pt, &cell, !x ? leader : NULL);
         }
+      putc ('\n', csv->file);
+    }
+}
 
-      if (csv->captions)
-        csv_output_table_item_text (csv, table_item_get_caption (table_item),
-                                    "Caption");
-
-      const struct footnote **f;
-      size_t n_footnotes = table_collect_footnotes (table_item, &f);
-      if (n_footnotes)
-        {
-          fputs ("\nFootnotes:\n", csv->file);
+static void
+csv_output_table_layer (struct csv_driver *csv, const struct pivot_table *pt,
+                        const size_t *layer_indexes)
+{
+  struct table *title, *layers, *body, *caption, *footnotes;
+  pivot_output (pt, layer_indexes, true, &title, &layers, &body,
+                &caption, &footnotes, NULL, NULL);
+
+  csv_put_separator (csv);
+  csv_output_table__ (csv, pt, title, "Table");
+  csv_output_table__ (csv, pt, layers, "Layer");
+  csv_output_table__ (csv, pt, body, NULL);
+  csv_output_table__ (csv, pt, caption, "Caption");
+  csv_output_table__ (csv, pt, footnotes, "Footnote");
+
+  table_unref (title);
+  table_unref (layers);
+  table_unref (body);
+  table_unref (caption);
+  table_unref (footnotes);
+}
 
-          for (size_t i = 0; i < n_footnotes; i++)
-            {
-              csv_output_field (csv, f[i]->marker);
-              fputs (csv->separator, csv->file);
-              csv_output_field (csv, f[i]->content);
-              putc ('\n', csv->file);
-            }
+static void
+csv_submit (struct output_driver *driver,
+            const struct output_item *item)
+{
+  struct csv_driver *csv = csv_driver_cast (driver);
 
-          free (f);
-        }
-    }
-  else if (is_text_item (output_item))
+  switch (item->type)
     {
-      const struct text_item *text_item = to_text_item (output_item);
-      enum text_item_type type = text_item_get_type (text_item);
-      const char *text = text_item_get_text (text_item);
+    case OUTPUT_ITEM_CHART:
+      break;
 
-      if (type == TEXT_ITEM_SYNTAX || type == TEXT_ITEM_PAGE_TITLE)
-        return;
+    case OUTPUT_ITEM_GROUP:
+      break;
 
-      csv_put_separator (csv);
+    case OUTPUT_ITEM_IMAGE:
+      break;
 
-      if (text_item->markup)
-        {
-          char *plain_text = output_get_text_from_markup (text);
-          csv_output_lines (csv, plain_text);
-          free (plain_text);
-        }
-      else
-        csv_output_lines (csv, text);
-    }
-  else if (is_page_eject_item (output_item))
-    {
-      csv_put_separator (csv);
-      csv_output_lines (csv, "");
-    }
-  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));
+    case OUTPUT_ITEM_MESSAGE:
       csv_put_separator (csv);
+      char *s = msg_to_string (item->message);
       csv_output_field (csv, s);
       free (s);
       putc ('\n', csv->file);
+      break;
+
+    case OUTPUT_ITEM_PAGE_BREAK:
+      csv_put_separator (csv);
+      csv_output_lines (csv, "");
+      break;
+
+    case OUTPUT_ITEM_TABLE:
+      {
+        size_t *layer_indexes;
+        PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
+          csv_output_table_layer (csv, item->table, layer_indexes);
+      }
+      break;
+
+    case OUTPUT_ITEM_TEXT:
+      if (item->text.subtype == TEXT_ITEM_SYNTAX
+          || item->text.subtype == TEXT_ITEM_PAGE_TITLE)
+        return;
+
+      csv_put_separator (csv);
+
+      char *text = text_item_get_plain_text (item);
+      csv_output_lines (csv, text);
+      free (text);
+      break;
     }
 }
 
@@ -319,8 +292,8 @@ struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
 
 static const struct output_driver_class csv_driver_class =
   {
-    "csv",
-    csv_destroy,
-    csv_submit,
-    csv_flush,
+    .name = "csv",
+    .destroy = csv_destroy,
+    .submit = csv_submit,
+    .flush = csv_flush,
   };