pintos-os.org Git - pspp/blob - src/output/csv.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2012, 2013, 2014 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include <errno.h>
  20 #include <stdlib.h>
  21
  22 #include "data/file-name.h"
  23 #include "data/file-handle-def.h"
  24 #include "libpspp/assertion.h"
  25 #include "libpspp/compiler.h"
  26 #include "libpspp/message.h"
  27 #include "libpspp/str.h"
  28 #include "libpspp/string-map.h"
  29 #include "output/driver-provider.h"
  30 #include "output/options.h"
  31 #include "output/output-item.h"
  32 #include "output/pivot-output.h"
  33 #include "output/pivot-table.h"
  34 #include "output/table-provider.h"
  35
  36 #include "gl/minmax.h"
  37 #include "gl/xalloc.h"
  38 #include "gl/xvasprintf.h"
  39
  40 #include "gettext.h"
  41 #define _(msgid) gettext (msgid)
  42
  43 /* Comma-separated value output driver. */
  44 struct csv_driver
  45   {
  46     struct output_driver driver;
  47
  48     char *separator;            /* Field separator (usually comma or tab). */
  49     int quote;                  /* Quote character (usually ' or ") or 0. */
  50     char *quote_set;            /* Characters that force quoting. */
  51     bool titles;                /* Print table titles? */
  52     bool captions;              /* Print table captions? */
  53
  54     struct file_handle *handle;
  55     FILE *file;                 /* Output file. */
  56     int n_items;                /* Number of items output so far. */
  57   };
  58
  59 static const struct output_driver_class csv_driver_class;
  60
  61 static struct csv_driver *
  62 csv_driver_cast (struct output_driver *driver)
  63 {
  64   assert (driver->class == &csv_driver_class);
  65   return UP_CAST (driver, struct csv_driver, driver);
  66 }
  67
  68 static struct driver_option *
  69 opt (struct output_driver *d, struct string_map *options, const char *key,
  70      const char *default_value)
  71 {
  72   return driver_option_get (d, options, key, default_value);
  73 }
  74
  75 static struct output_driver *
  76 csv_create (struct file_handle *fh, enum settings_output_devices device_type,
  77             struct string_map *o)
  78 {
  79   struct output_driver *d;
  80   struct csv_driver *csv;
  81   char *quote;
  82
  83   csv = xzalloc (sizeof *csv);
  84   d = &csv->driver;
  85   output_driver_init (&csv->driver, &csv_driver_class, fh_get_file_name (fh), device_type);
  86
  87   csv->separator = parse_string (opt (d, o, "separator", ","));
  88   quote = parse_string (opt (d, o, "quote", "\""));
  89   csv->quote = quote[0];
  90   free (quote);
  91   csv->quote_set = xasprintf ("\n\r\t%s%c", csv->separator, csv->quote);
  92   csv->titles = parse_boolean (opt (d, o, "titles", "true"));
  93   csv->captions = parse_boolean (opt (d, o, "captions", "true"));
  94   csv->handle = fh;
  95   csv->file = fn_open (fh, "w");
  96   csv->n_items = 0;
  97
  98   if (csv->file == NULL)
  99     {
 100       msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
 101       output_driver_destroy (d);
 102       return NULL;
 103     }
 104
 105   return d;
 106 }
 107
 108 static void
 109 csv_destroy (struct output_driver *driver)
 110 {
 111   struct csv_driver *csv = csv_driver_cast (driver);
 112
 113   if (csv->file != NULL)
 114     fn_close (csv->handle, csv->file);
 115
 116   free (csv->separator);
 117   free (csv->quote_set);
 118   fh_unref (csv->handle);
 119   free (csv);
 120 }
 121
 122 static void
 123 csv_flush (struct output_driver *driver)
 124 {
 125   struct csv_driver *csv = csv_driver_cast (driver);
 126   if (csv->file != NULL)
 127     fflush (csv->file);
 128 }
 129
 130 static void
 131 csv_output_field__ (struct csv_driver *csv, struct substring field)
 132 {
 133   ss_ltrim (&field, ss_cstr (" "));
 134
 135   if (csv->quote && ss_cspan (field, ss_cstr (csv->quote_set)) < field.length)
 136     {
 137       putc (csv->quote, csv->file);
 138       for (size_t i = 0; i < field.length; i++)
 139         {
 140           if (field.string[i] == csv->quote)
 141             putc (csv->quote, csv->file);
 142           putc (field.string[i], csv->file);
 143         }
 144       putc (csv->quote, csv->file);
 145     }
 146   else
 147     fwrite (field.string, field.length, 1, csv->file);
 148 }
 149
 150 static void
 151 csv_output_field (struct csv_driver *csv, const char *field)
 152 {
 153   csv_output_field__ (csv, ss_cstr (field));
 154 }
 155
 156 static void
 157 csv_put_separator (struct csv_driver *csv)
 158 {
 159   if (csv->n_items++ > 0)
 160     putc ('\n', csv->file);
 161 }
 162
 163 static void
 164 csv_output_lines (struct csv_driver *csv, const char *text_)
 165 {
 166   struct substring text = ss_cstr (text_);
 167   struct substring line;
 168   size_t save_idx = 0;
 169   while (ss_separate (text, ss_cstr ("\n"), &save_idx, &line))
 170     {
 171       csv_output_field__ (csv, line);
 172       putc ('\n', csv->file);
 173     }
 174 }
 175
 176 static void
 177 csv_output_table_cell (struct csv_driver *csv, const struct pivot_table *pt,
 178                        const struct table_cell *cell, const char *leader)
 179 {
 180   struct string s = DS_EMPTY_INITIALIZER;
 181   if (leader)
 182     ds_put_format (&s, "%s: ", leader);
 183   pivot_value_format (cell->value, pt, &s);
 184   csv_output_field (csv, ds_cstr (&s));
 185   ds_destroy (&s);
 186 }
 187
 188 static void
 189 csv_output_table__ (struct csv_driver *csv, const struct pivot_table *pt,
 190                     const struct table *t, const char *leader)
 191 {
 192   if (!t)
 193     return;
 194
 195   for (int y = 0; y < t->n[TABLE_VERT]; y++)
 196     {
 197       for (int x = 0; x < t->n[TABLE_HORZ]; x++)
 198         {
 199           struct table_cell cell;
 200
 201           table_get_cell (t, x, y, &cell);
 202
 203           if (x > 0)
 204             fputs (csv->separator, csv->file);
 205
 206           if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
 207             csv_output_field (csv, "");
 208           else
 209             csv_output_table_cell (csv, pt, &cell, !x ? leader : NULL);
 210         }
 211       putc ('\n', csv->file);
 212     }
 213 }
 214
 215 static void
 216 csv_output_table_layer (struct csv_driver *csv, const struct pivot_table *pt,
 217                         const size_t *layer_indexes)
 218 {
 219   struct table *title, *layers, *body, *caption, *footnotes;
 220   pivot_output (pt, layer_indexes, true, &title, &layers, &body,
 221                 &caption, &footnotes, NULL, NULL);
 222
 223   csv_put_separator (csv);
 224   csv_output_table__ (csv, pt, title, "Table");
 225   csv_output_table__ (csv, pt, layers, "Layer");
 226   csv_output_table__ (csv, pt, body, NULL);
 227   csv_output_table__ (csv, pt, caption, "Caption");
 228   csv_output_table__ (csv, pt, footnotes, "Footnote");
 229
 230   table_unref (title);
 231   table_unref (layers);
 232   table_unref (body);
 233   table_unref (caption);
 234   table_unref (footnotes);
 235 }
 236
 237 static void
 238 csv_submit (struct output_driver *driver,
 239             const struct output_item *item)
 240 {
 241   struct csv_driver *csv = csv_driver_cast (driver);
 242
 243   switch (item->type)
 244     {
 245     case OUTPUT_ITEM_CHART:
 246       break;
 247
 248     case OUTPUT_ITEM_GROUP:
 249       break;
 250
 251     case OUTPUT_ITEM_IMAGE:
 252       break;
 253
 254     case OUTPUT_ITEM_MESSAGE:
 255       csv_put_separator (csv);
 256       char *s = msg_to_string (item->message);
 257       csv_output_field (csv, s);
 258       free (s);
 259       putc ('\n', csv->file);
 260       break;
 261
 262     case OUTPUT_ITEM_PAGE_BREAK:
 263       csv_put_separator (csv);
 264       csv_output_lines (csv, "");
 265       break;
 266
 267     case OUTPUT_ITEM_TABLE:
 268       {
 269         size_t *layer_indexes;
 270         PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
 271           csv_output_table_layer (csv, item->table, layer_indexes);
 272       }
 273       break;
 274
 275     case OUTPUT_ITEM_TEXT:
 276       if (item->text.subtype == TEXT_ITEM_SYNTAX
 277           || item->text.subtype == TEXT_ITEM_PAGE_TITLE)
 278         return;
 279
 280       csv_put_separator (csv);
 281
 282       char *text = text_item_get_plain_text (item);
 283       csv_output_lines (csv, text);
 284       free (text);
 285       break;
 286     }
 287 }
 288
 289 struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
 290
 291 static const struct output_driver_class csv_driver_class =
 292   {
 293     .name = "csv",
 294     .destroy = csv_destroy,
 295     .submit = csv_submit,
 296     .flush = csv_flush,
 297   };