output: Introduce group_item in place of TEXT_ITEM_COMMAND_OPEN and CLOSE.
[pspp] / src / output / csv.c
index 2784b24998757649e96c7f863f709753873abd6c..8493df34c613e02b35c519126f73364ce55e0473 100644 (file)
@@ -20,6 +20,7 @@
 #include <stdlib.h>
 
 #include "data/file-name.h"
+#include "data/file-handle-def.h"
 #include "libpspp/assertion.h"
 #include "libpspp/compiler.h"
 #include "libpspp/message.h"
@@ -32,6 +33,7 @@
 #include "output/table-item.h"
 #include "output/table-provider.h"
 
+#include "gl/minmax.h"
 #include "gl/xalloc.h"
 #include "gl/xvasprintf.h"
 
@@ -47,9 +49,9 @@ struct csv_driver
     int quote;                  /* Quote character (usually ' or ") or 0. */
     char *quote_set;            /* Characters that force quoting. */
     bool titles;                /* Print table titles? */
+    bool captions;              /* Print table captions? */
 
-    char *file_name;            /* Output file name. */
-    char *command_name;         /* Current command. */
+    struct file_handle *handle;
     FILE *file;                 /* Output file. */
     int n_items;                /* Number of items output so far. */
   };
@@ -71,7 +73,7 @@ opt (struct output_driver *d, struct string_map *options, const char *key,
 }
 
 static struct output_driver *
-csv_create (const char *file_name, enum settings_output_devices device_type,
+csv_create (struct file_handle *fh, enum settings_output_devices device_type,
             struct string_map *o)
 {
   struct output_driver *d;
@@ -80,7 +82,7 @@ csv_create (const char *file_name, enum settings_output_devices device_type,
 
   csv = xzalloc (sizeof *csv);
   d = &csv->driver;
-  output_driver_init (&csv->driver, &csv_driver_class, file_name, device_type);
+  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", "\""));
@@ -88,13 +90,14 @@ csv_create (const char *file_name, enum settings_output_devices device_type,
   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->file_name = xstrdup (file_name);
-  csv->file = fn_open (csv->file_name, "w");
+  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)
     {
-      msg_error (errno, _("error opening output file `%s'"), csv->file_name);
+      msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
       output_driver_destroy (d);
       return NULL;
     }
@@ -108,11 +111,11 @@ csv_destroy (struct output_driver *driver)
   struct csv_driver *csv = csv_driver_cast (driver);
 
   if (csv->file != NULL)
-    fn_close (csv->file_name, csv->file);
+    fn_close (csv->handle, csv->file);
 
   free (csv->separator);
   free (csv->quote_set);
-  free (csv->file_name);
+  fh_unref (csv->handle);
   free (csv);
 }
 
@@ -147,98 +150,27 @@ csv_output_field (struct csv_driver *csv, const char *field)
     fputs (field, csv->file);
 }
 
-static void PRINTF_FORMAT (2, 3)
-csv_output_field_format (struct csv_driver *csv, const char *format, ...)
-{
-  va_list args;
-  char *s;
-
-  va_start (args, format);
-  s = xvasprintf (format, args);
-  va_end (args);
-
-  csv_output_field (csv, s);
-  free (s);
-}
-
 static void
-csv_put_field (struct csv_driver *csv, struct string *s, const char *field)
+csv_format_footnotes (const struct footnote **f, size_t n, struct string *s)
 {
-  while (*field == ' ')
-    field++;
-
-  if (csv->quote && field[strcspn (field, csv->quote_set)])
-    {
-      const char *p;
-
-      ds_put_byte (s, csv->quote);
-      for (p = field; *p != '\0'; p++)
-        {
-          if (*p == csv->quote)
-            ds_put_byte (s, csv->quote);
-          ds_put_byte (s, *p);
-        }
-      ds_put_byte (s, csv->quote);
-    }
-  else
-    ds_put_cstr (s, field);
+  for (size_t i = 0; i < n; i++)
+    ds_put_format (s, "[%s]", f[i]->marker);
 }
 
 static void
-csv_output_subtable (struct csv_driver *csv, struct string *s,
-                     const struct table_item *item)
+csv_output_table_item_text (struct csv_driver *csv,
+                            const struct table_item_text *text,
+                            const char *leader)
 {
-  const struct table *t = table_item_get_table (item);
-  const char *title = table_item_get_title (item);
-  int y, x;
-
-  if (csv->titles && title != NULL)
-    {
-      csv_output_field_format (csv, "Table: %s", title);
-      putc ('\n', csv->file);
-    }
-
-  for (y = 0; y < table_nr (t); y++)
-    {
-      if (y > 0)
-        ds_put_byte (s, '\n');
-
-      for (x = 0; x < table_nc (t); x++)
-        {
-          struct table_cell cell;
-
-          table_get_cell (t, x, y, &cell);
-
-          if (x > 0)
-            ds_put_cstr (s, csv->separator);
-
-          if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
-            csv_put_field (csv, s, "");
-          else if (cell.n_contents == 1 && cell.contents[0].text != NULL)
-            csv_put_field (csv, s, cell.contents[0].text);
-          else
-            {
-              struct string s2;
-              size_t i;
-
-              ds_init_empty (&s2);
-              for (i = 0; i < cell.n_contents; i++)
-                {
-                  if (i > 0)
-                    ds_put_cstr (&s2, "\n\n");
-
-                  if (cell.contents[i].text != NULL)
-                    ds_put_cstr (&s2, cell.contents[i].text);
-                  else
-                    csv_output_subtable (csv, &s2, cell.contents[i].table);
-                }
-              csv_put_field (csv, s, ds_cstr (&s2));
-              ds_destroy (&s2);
-            }
-
-          table_cell_free (&cell);
-        }
-    }
+  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);
+  csv_output_field (csv, ds_cstr (&s));
+  ds_destroy (&s);
+  putc ('\n', csv->file);
 }
 
 static void
@@ -254,25 +186,18 @@ csv_submit (struct output_driver *driver,
 {
   struct csv_driver *csv = csv_driver_cast (driver);
 
-  output_driver_track_current_command (output_item, &csv->command_name);
-
   if (is_table_item (output_item))
     {
       struct table_item *table_item = to_table_item (output_item);
-      const char *title = table_item_get_title (table_item);
       const struct table *t = table_item_get_table (table_item);
-      int footnote_idx;
       int x, y;
 
       csv_put_separator (csv);
 
-      if (csv->titles && title != NULL)
-        {
-          csv_output_field_format (csv, "Table: %s", title);
-          putc ('\n', csv->file);
-        }
+      if (csv->titles)
+        csv_output_table_item_text (csv, table_item_get_title (table_item),
+                                    "Table");
 
-      footnote_idx = 0;
       for (y = 0; y < table_nr (t); y++)
         {
           for (x = 0; x < table_nc (t); x++)
@@ -299,24 +224,12 @@ csv_submit (struct output_driver *driver,
                   for (i = 0; i < cell.n_contents; i++)
                     {
                       const struct cell_contents *c = &cell.contents[i];
-                      int j;
 
                       if (i > 0)
                         ds_put_cstr (&s, "\n\n");
 
-                      if (c->text != NULL)
-                        ds_put_cstr (&s, c->text);
-                      else
-                        csv_output_subtable (csv, &s, c->table);
-
-                      for (j = 0; j < c->n_footnotes; j++)
-                        {
-                          char marker[16];
-
-                          str_format_26adic (++footnote_idx, false,
-                                             marker, sizeof marker);
-                          ds_put_format (&s, "[%s]", marker);
-                        }
+                      ds_put_cstr (&s, c->text);
+                      csv_format_footnotes (c->footnotes, c->n_footnotes, &s);
                     }
                   csv_output_field (csv, ds_cstr (&s));
                   ds_destroy (&s);
@@ -327,41 +240,26 @@ csv_submit (struct output_driver *driver,
           putc ('\n', csv->file);
         }
 
-      if (footnote_idx)
-        {
-          size_t i;
+      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);
 
-          footnote_idx = 0;
-          for (y = 0; y < table_nr (t); y++)
-            {
-              struct table_cell cell;
-              for (x = 0; x < table_nc (t); x = cell.d[TABLE_HORZ][1])
-                {
-                  table_get_cell (t, x, y, &cell);
-
-                  if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
-                    for (i = 0; i < cell.n_contents; i++)
-                      {
-                        const struct cell_contents *c = &cell.contents[i];
-                        int j;
-
-                        for (j = 0; j < c->n_footnotes; j++)
-                          {
-                            char marker[16];
-
-                            str_format_26adic (++footnote_idx, false,
-                                               marker, sizeof marker);
-                            csv_output_field (csv, marker);
-                            fputs (csv->separator, csv->file);
-                            csv_output_field (csv, c->footnotes[j]);
-                            putc ('\n', csv->file);
-                          }
-                      }
-                  table_cell_free (&cell);
-                }
-            }
+          for (size_t i = 0; i < n_footnotes; i++)
+            if (f[i])
+              {
+                csv_output_field (csv, f[i]->marker);
+                fputs (csv->separator, csv->file);
+                csv_output_field (csv, f[i]->content);
+                putc ('\n', csv->file);
+              }
+
+          free (f);
         }
     }
   else if (is_text_item (output_item))
@@ -370,32 +268,17 @@ csv_submit (struct output_driver *driver,
       enum text_item_type type = text_item_get_type (text_item);
       const char *text = text_item_get_text (text_item);
 
-      if (type == TEXT_ITEM_COMMAND_OPEN || type == TEXT_ITEM_COMMAND_CLOSE
-          || type == TEXT_ITEM_SYNTAX)
+      if (type == TEXT_ITEM_SYNTAX || type == TEXT_ITEM_PAGE_TITLE)
         return;
 
       csv_put_separator (csv);
-      switch (type)
-        {
-        case TEXT_ITEM_TITLE:
-          csv_output_field_format (csv, "Title: %s", text);
-          break;
-
-        case TEXT_ITEM_SUBTITLE:
-          csv_output_field_format (csv, "Subtitle: %s", text);
-          break;
-
-        default:
-          csv_output_field (csv, text);
-          break;
-        }
+      csv_output_field (csv, text);
       putc ('\n', csv->file);
     }
   else if (is_message_item (output_item))
     {
       const struct message_item *message_item = to_message_item (output_item);
-      const struct msg *msg = message_item_get_msg (message_item);
-      char *s = msg_to_string (msg, csv->command_name);
+      char *s = msg_to_string (message_item_get_msg (message_item));
       csv_put_separator (csv);
       csv_output_field (csv, s);
       free (s);