X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fcsv.c;h=2802f4bbef3e630158b06349c0c0891066a62aa2;hb=7344ce41487d4294726d597b99bbef5c3cfa1ce6;hp=158c78952233282e4580d1f5814f80f498c27db8;hpb=dfd1972f7bcb550a4fc3b05dbe7e71d12334b0a7;p=pspp

diff --git a/src/output/csv.c b/src/output/csv.c
index 158c789522..2802f4bbef 100644
--- a/src/output/csv.c
+++ b/src/output/csv.c
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2009 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
@@ -19,17 +19,20 @@
 #include <errno.h>
 #include <stdlib.h>
 
-#include <data/file-name.h>
-#include <libpspp/assertion.h>
-#include <libpspp/compiler.h>
-#include <libpspp/string-map.h>
-#include <output/text-item.h>
-#include <output/driver-provider.h>
-#include <output/options.h>
-#include <output/table-item.h>
-#include <output/table-provider.h>
-
-#include "gl/error.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"
+#include "output/options.h"
+#include "output/message-item.h"
+#include "output/table-item.h"
+#include "output/table-provider.h"
+
 #include "gl/xalloc.h"
 #include "gl/xvasprintf.h"
 
@@ -41,17 +44,24 @@ struct csv_driver
   {
     struct output_driver driver;
 
-    char *separator;            /* Comma or tab. */
+    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. */
+    struct file_handle *handle;
+    char *command_name;         /* Current command. */
     FILE *file;                 /* Output file. */
-    bool reported_error;        /* Reported file open error? */
+    int n_items;                /* Number of items output so far. */
   };
 
+static const struct output_driver_class csv_driver_class;
+
 static struct csv_driver *
 csv_driver_cast (struct output_driver *driver)
 {
-  assert (driver->class == &csv_class);
+  assert (driver->class == &csv_driver_class);
   return UP_CAST (driver, struct csv_driver, driver);
 }
 
@@ -63,20 +73,34 @@ opt (struct output_driver *d, struct string_map *options, const char *key,
 }
 
 static struct output_driver *
-csv_create (const char *name, enum output_device_type device_type,
+csv_create (struct file_handle *fh, enum settings_output_devices device_type,
             struct string_map *o)
 {
   struct output_driver *d;
   struct csv_driver *csv;
+  char *quote;
 
   csv = xzalloc (sizeof *csv);
   d = &csv->driver;
-  output_driver_init (&csv->driver, &csv_class, 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", ","));
-  csv->file_name = parse_string (opt (d, o, "output-file", "pspp.csv"));
-  csv->file = NULL;
-  csv->reported_error = false;
+  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_fopen (fh, "w");
+  csv->n_items = 0;
+
+  if (csv->file == NULL)
+    {
+      msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
+      output_driver_destroy (d);
+      return NULL;
+    }
 
   return d;
 }
@@ -86,10 +110,12 @@ csv_destroy (struct output_driver *driver)
 {
   struct csv_driver *csv = csv_driver_cast (driver);
 
-  free (csv->separator);
-  free (csv->file_name);
   if (csv->file != NULL)
-    fclose (csv->file);
+    fn_close (csv->handle, csv->file);
+
+  free (csv->separator);
+  free (csv->quote_set);
+  fh_unref (csv->handle);
   free (csv);
 }
 
@@ -102,34 +128,30 @@ csv_flush (struct output_driver *driver)
 }
 
 static void
-csv_output_field (FILE *file, const char *field)
+csv_output_field (struct csv_driver *csv, const char *field)
 {
   while (*field == ' ')
     field++;
 
-  if (field[strcspn (field, "\"\n\r,\t")])
+  if (csv->quote && field[strcspn (field, csv->quote_set)])
     {
       const char *p;
 
-      putc ('"', file);
+      putc (csv->quote, csv->file);
       for (p = field; *p != '\0'; p++)
         {
-          if (*p == '"')
-            putc ('"', file);
-          putc (*p, file);
+          if (*p == csv->quote)
+            putc (csv->quote, csv->file);
+          putc (*p, csv->file);
         }
-      putc ('"', file);
+      putc (csv->quote, csv->file);
     }
   else
-    fputs (field, file);
+    fputs (field, csv->file);
 }
 
-static void
-csv_output_field_format (FILE *file, const char *format, ...)
-  PRINTF_FORMAT (2, 3);
-
-static void
-csv_output_field_format (FILE *file, const char *format, ...)
+static void PRINTF_FORMAT (2, 3)
+csv_output_field_format (struct csv_driver *csv, const char *format, ...)
 {
   va_list args;
   char *s;
@@ -138,29 +160,102 @@ csv_output_field_format (FILE *file, const char *format, ...)
   s = xvasprintf (format, args);
   va_end (args);
 
-  csv_output_field (file, s);
+  csv_output_field (csv, s);
   free (s);
 }
 
-static bool
-csv_open_file (struct csv_driver *csv)
+static void
+csv_put_field (struct csv_driver *csv, struct string *s, const char *field)
 {
-  if (csv->file == NULL)
+  while (*field == ' ')
+    field++;
+
+  if (csv->quote && field[strcspn (field, csv->quote_set)])
     {
-      csv->file = fn_open (csv->file_name, "w");
-      if (csv->file == NULL)
+      const char *p;
+
+      ds_put_byte (s, csv->quote);
+      for (p = field; *p != '\0'; p++)
         {
-          if (!csv->reported_error)
-            error (0, errno, _("csv: opening output file \"%s\""),
-                   csv->file_name);
-          csv->reported_error = true;
-          return false;
+          if (*p == csv->quote)
+            ds_put_byte (s, csv->quote);
+          ds_put_byte (s, *p);
         }
+      ds_put_byte (s, csv->quote);
     }
   else
-    putc ('\n', csv->file);
+    ds_put_cstr (s, field);
+}
+
+static void
+csv_output_subtable (struct csv_driver *csv, struct string *s,
+                     const struct table_item *item)
+{
+  const struct table *t = table_item_get_table (item);
+  const char *title = table_item_get_title (item);
+  const char *caption = table_item_get_caption (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);
 
-  return true;
+          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 (csv->captions && caption != NULL)
+    {
+      csv_output_field_format (csv, "Caption: %s", caption);
+      putc ('\n', csv->file);
+    }
+}
+
+static void
+csv_put_separator (struct csv_driver *csv)
+{
+  if (csv->n_items++ > 0)
+    putc ('\n', csv->file);
 }
 
 static void
@@ -169,22 +264,26 @@ 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 char *caption = table_item_get_caption (table_item);
       const struct table *t = table_item_get_table (table_item);
+      int footnote_idx;
       int x, y;
 
-      if (!csv_open_file (csv))
-        return;
+      csv_put_separator (csv);
 
-      if (caption != NULL)
+      if (csv->titles && title != NULL)
         {
-          csv_output_field_format (csv->file, "Table: %s", caption);
+          csv_output_field_format (csv, "Table: %s", title);
           putc ('\n', csv->file);
         }
 
+      footnote_idx = 0;
       for (y = 0; y < table_nr (t); y++)
         {
           for (x = 0; x < table_nc (t); x++)
@@ -197,14 +296,90 @@ csv_submit (struct output_driver *driver,
                 fputs (csv->separator, csv->file);
 
               if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
-                csv_output_field (csv->file, "");
+                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->file, 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];
+                      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);
+                        }
+                    }
+                  csv_output_field (csv, ds_cstr (&s));
+                  ds_destroy (&s);
+                }
 
               table_cell_free (&cell);
             }
           putc ('\n', csv->file);
         }
+
+      if (csv->captions && caption != NULL)
+        {
+          csv_output_field_format (csv, "Caption: %s", caption);
+          putc ('\n', csv->file);
+        }
+
+      if (footnote_idx)
+        {
+          size_t i;
+
+          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);
+                }
+            }
+        }
     }
   else if (is_text_item (output_item))
     {
@@ -216,29 +391,40 @@ csv_submit (struct output_driver *driver,
           || type == TEXT_ITEM_SYNTAX)
         return;
 
-      csv_open_file (csv);
+      csv_put_separator (csv);
       switch (type)
         {
         case TEXT_ITEM_TITLE:
-          csv_output_field_format (csv->file, "Title: %s", text);
+          csv_output_field_format (csv, "Title: %s", text);
           break;
 
         case TEXT_ITEM_SUBTITLE:
-          csv_output_field_format (csv->file, "Subtitle: %s", text);
+          csv_output_field_format (csv, "Subtitle: %s", text);
           break;
 
         default:
-          csv_output_field (csv->file, text);
+          csv_output_field (csv, text);
           break;
         }
       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);
+      csv_put_separator (csv);
+      csv_output_field (csv, s);
+      free (s);
+      putc ('\n', csv->file);
+    }
 }
 
-const struct output_driver_class csv_class =
+struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
+
+static const struct output_driver_class csv_driver_class =
   {
     "csv",
-    csv_create,
     csv_destroy,
     csv_submit,
     csv_flush,