output: Expand footnote support.
[pspp] / src / output / csv.c
index c8619a9a7d403ebc84ebc55d9c307976a49b734b..763d19137219c0aaa38a77ad0e41879e818a646d 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2009, 2010, 2012, 2013, 2014 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 #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"
+#include "libpspp/str.h"
 #include "libpspp/string-map.h"
 #include "output/text-item.h"
 #include "output/driver-provider.h"
@@ -31,7 +33,7 @@
 #include "output/table-item.h"
 #include "output/table-provider.h"
 
-#include "gl/error.h"
+#include "gl/minmax.h"
 #include "gl/xalloc.h"
 #include "gl/xvasprintf.h"
 
@@ -46,10 +48,10 @@ struct csv_driver
     char *separator;            /* Field separator (usually comma or tab). */
     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,21 +82,22 @@ 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", "\""));
   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->file_name = xstrdup (file_name);
-  csv->file = fn_open (csv->file_name, "w");
+  csv->handle = fh;
+  csv->file = fn_open (fh, "w");
   csv->n_items = 0;
 
   if (csv->file == NULL)
     {
-      error (0, 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,11 +150,7 @@ csv_output_field (struct csv_driver *csv, const char *field)
     fputs (field, csv->file);
 }
 
-static void
-csv_output_field_format (struct csv_driver *csv, const char *format, ...)
-  PRINTF_FORMAT (2, 3);
-
-static void
+static void PRINTF_FORMAT (2, 3)
 csv_output_field_format (struct csv_driver *csv, const char *format, ...)
 {
   va_list args;
@@ -165,6 +164,29 @@ csv_output_field_format (struct csv_driver *csv, const char *format, ...)
   free (s);
 }
 
+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)
+{
+  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
 csv_put_separator (struct csv_driver *csv)
 {
@@ -178,22 +200,17 @@ 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 *caption = table_item_get_caption (table_item);
       const struct table *t = table_item_get_table (table_item);
       int x, y;
 
       csv_put_separator (csv);
 
-      if (csv->captions && caption != NULL)
-        {
-          csv_output_field_format (csv, "Table: %s", caption);
-          putc ('\n', csv->file);
-        }
+      if (csv->titles)
+        csv_output_table_item_text (csv, table_item_get_title (table_item),
+                                    "Table");
 
       for (y = 0; y < table_nr (t); y++)
         {
@@ -208,13 +225,56 @@ csv_submit (struct output_driver *driver,
 
               if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
                 csv_output_field (csv, "");
+              else if (cell.n_contents == 1
+                       && cell.contents[0].text != NULL
+                       && cell.contents[0].n_footnotes == 0)
+                csv_output_field (csv, cell.contents[0].text);
               else
-                csv_output_field (csv, cell.contents);
+                {
+                  struct string s;
+                  size_t i;
+
+                  ds_init_empty (&s);
+                  for (i = 0; i < cell.n_contents; i++)
+                    {
+                      const struct cell_contents *c = &cell.contents[i];
+
+                      if (i > 0)
+                        ds_put_cstr (&s, "\n\n");
+
+                      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);
+                }
 
               table_cell_free (&cell);
             }
           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);
+
+          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))
     {
@@ -247,7 +307,7 @@ csv_submit (struct output_driver *driver,
     {
       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 (msg, message_item->command_name);
       csv_put_separator (csv);
       csv_output_field (csv, s);
       free (s);
@@ -255,7 +315,7 @@ csv_submit (struct output_driver *driver,
     }
 }
 
-struct output_driver_factory csv_driver_factory = { "csv", csv_create };
+struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
 
 static const struct output_driver_class csv_driver_class =
   {