1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2012, 2013, 2014 Free Software Foundation, Inc.
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.
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.
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/>. */
22 #include "data/file-name.h"
23 #include "libpspp/assertion.h"
24 #include "libpspp/compiler.h"
25 #include "libpspp/message.h"
26 #include "libpspp/str.h"
27 #include "libpspp/string-map.h"
28 #include "output/text-item.h"
29 #include "output/driver-provider.h"
30 #include "output/options.h"
31 #include "output/message-item.h"
32 #include "output/table-item.h"
33 #include "output/table-provider.h"
35 #include "gl/xalloc.h"
36 #include "gl/xvasprintf.h"
39 #define _(msgid) gettext (msgid)
41 /* Comma-separated value output driver. */
44 struct output_driver driver;
46 char *separator; /* Field separator (usually comma or tab). */
47 int quote; /* Quote character (usually ' or ") or 0. */
48 char *quote_set; /* Characters that force quoting. */
49 bool titles; /* Print table titles? */
50 bool captions; /* Print table captions? */
52 char *file_name; /* Output file name. */
53 char *command_name; /* Current command. */
54 FILE *file; /* Output file. */
55 int n_items; /* Number of items output so far. */
58 static const struct output_driver_class csv_driver_class;
60 static struct csv_driver *
61 csv_driver_cast (struct output_driver *driver)
63 assert (driver->class == &csv_driver_class);
64 return UP_CAST (driver, struct csv_driver, driver);
67 static struct driver_option *
68 opt (struct output_driver *d, struct string_map *options, const char *key,
69 const char *default_value)
71 return driver_option_get (d, options, key, default_value);
74 static struct output_driver *
75 csv_create (const char *file_name, enum settings_output_devices device_type,
78 struct output_driver *d;
79 struct csv_driver *csv;
82 csv = xzalloc (sizeof *csv);
84 output_driver_init (&csv->driver, &csv_driver_class, file_name, device_type);
86 csv->separator = parse_string (opt (d, o, "separator", ","));
87 quote = parse_string (opt (d, o, "quote", "\""));
88 csv->quote = quote[0];
90 csv->quote_set = xasprintf ("\n\r\t%s%c", csv->separator, csv->quote);
91 csv->titles = parse_boolean (opt (d, o, "titles", "true"));
92 csv->captions = parse_boolean (opt (d, o, "captions", "true"));
93 csv->file_name = xstrdup (file_name);
94 csv->file = fn_open (csv->file_name, "w");
97 if (csv->file == NULL)
99 msg_error (errno, _("error opening output file `%s'"), csv->file_name);
100 output_driver_destroy (d);
108 csv_destroy (struct output_driver *driver)
110 struct csv_driver *csv = csv_driver_cast (driver);
112 if (csv->file != NULL)
113 fn_close (csv->file_name, csv->file);
115 free (csv->separator);
116 free (csv->quote_set);
117 free (csv->file_name);
122 csv_flush (struct output_driver *driver)
124 struct csv_driver *csv = csv_driver_cast (driver);
125 if (csv->file != NULL)
130 csv_output_field (struct csv_driver *csv, const char *field)
132 while (*field == ' ')
135 if (csv->quote && field[strcspn (field, csv->quote_set)])
139 putc (csv->quote, csv->file);
140 for (p = field; *p != '\0'; p++)
142 if (*p == csv->quote)
143 putc (csv->quote, csv->file);
144 putc (*p, csv->file);
146 putc (csv->quote, csv->file);
149 fputs (field, csv->file);
152 static void PRINTF_FORMAT (2, 3)
153 csv_output_field_format (struct csv_driver *csv, const char *format, ...)
158 va_start (args, format);
159 s = xvasprintf (format, args);
162 csv_output_field (csv, s);
167 csv_put_field (struct csv_driver *csv, struct string *s, const char *field)
169 while (*field == ' ')
172 if (csv->quote && field[strcspn (field, csv->quote_set)])
176 ds_put_byte (s, csv->quote);
177 for (p = field; *p != '\0'; p++)
179 if (*p == csv->quote)
180 ds_put_byte (s, csv->quote);
183 ds_put_byte (s, csv->quote);
186 ds_put_cstr (s, field);
190 csv_output_subtable (struct csv_driver *csv, struct string *s,
191 const struct table_item *item)
193 const struct table *t = table_item_get_table (item);
194 const char *title = table_item_get_title (item);
195 const char *caption = table_item_get_caption (item);
198 if (csv->titles && title != NULL)
200 csv_output_field_format (csv, "Table: %s", title);
201 putc ('\n', csv->file);
204 for (y = 0; y < table_nr (t); y++)
207 ds_put_byte (s, '\n');
209 for (x = 0; x < table_nc (t); x++)
211 struct table_cell cell;
213 table_get_cell (t, x, y, &cell);
216 ds_put_cstr (s, csv->separator);
218 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
219 csv_put_field (csv, s, "");
220 else if (cell.n_contents == 1 && cell.contents[0].text != NULL)
221 csv_put_field (csv, s, cell.contents[0].text);
228 for (i = 0; i < cell.n_contents; i++)
231 ds_put_cstr (&s2, "\n\n");
233 if (cell.contents[i].text != NULL)
234 ds_put_cstr (&s2, cell.contents[i].text);
236 csv_output_subtable (csv, &s2, cell.contents[i].table);
238 csv_put_field (csv, s, ds_cstr (&s2));
242 table_cell_free (&cell);
246 if (csv->captions && caption != NULL)
248 csv_output_field_format (csv, "Caption: %s", caption);
249 putc ('\n', csv->file);
254 csv_put_separator (struct csv_driver *csv)
256 if (csv->n_items++ > 0)
257 putc ('\n', csv->file);
261 csv_submit (struct output_driver *driver,
262 const struct output_item *output_item)
264 struct csv_driver *csv = csv_driver_cast (driver);
266 output_driver_track_current_command (output_item, &csv->command_name);
268 if (is_table_item (output_item))
270 struct table_item *table_item = to_table_item (output_item);
271 const char *title = table_item_get_title (table_item);
272 const char *caption = table_item_get_caption (table_item);
273 const struct table *t = table_item_get_table (table_item);
277 csv_put_separator (csv);
279 if (csv->titles && title != NULL)
281 csv_output_field_format (csv, "Table: %s", title);
282 putc ('\n', csv->file);
286 for (y = 0; y < table_nr (t); y++)
288 for (x = 0; x < table_nc (t); x++)
290 struct table_cell cell;
292 table_get_cell (t, x, y, &cell);
295 fputs (csv->separator, csv->file);
297 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
298 csv_output_field (csv, "");
299 else if (cell.n_contents == 1
300 && cell.contents[0].text != NULL
301 && cell.contents[0].n_footnotes == 0)
302 csv_output_field (csv, cell.contents[0].text);
309 for (i = 0; i < cell.n_contents; i++)
311 const struct cell_contents *c = &cell.contents[i];
315 ds_put_cstr (&s, "\n\n");
318 ds_put_cstr (&s, c->text);
320 csv_output_subtable (csv, &s, c->table);
322 for (j = 0; j < c->n_footnotes; j++)
326 str_format_26adic (++footnote_idx, false,
327 marker, sizeof marker);
328 ds_put_format (&s, "[%s]", marker);
331 csv_output_field (csv, ds_cstr (&s));
335 table_cell_free (&cell);
337 putc ('\n', csv->file);
340 if (csv->captions && caption != NULL)
342 csv_output_field_format (csv, "Caption: %s", caption);
343 putc ('\n', csv->file);
350 fputs ("\nFootnotes:\n", csv->file);
353 for (y = 0; y < table_nr (t); y++)
355 struct table_cell cell;
356 for (x = 0; x < table_nc (t); x = cell.d[TABLE_HORZ][1])
358 table_get_cell (t, x, y, &cell);
360 if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
361 for (i = 0; i < cell.n_contents; i++)
363 const struct cell_contents *c = &cell.contents[i];
366 for (j = 0; j < c->n_footnotes; j++)
370 str_format_26adic (++footnote_idx, false,
371 marker, sizeof marker);
372 csv_output_field (csv, marker);
373 fputs (csv->separator, csv->file);
374 csv_output_field (csv, c->footnotes[j]);
375 putc ('\n', csv->file);
378 table_cell_free (&cell);
383 else if (is_text_item (output_item))
385 const struct text_item *text_item = to_text_item (output_item);
386 enum text_item_type type = text_item_get_type (text_item);
387 const char *text = text_item_get_text (text_item);
389 if (type == TEXT_ITEM_COMMAND_OPEN || type == TEXT_ITEM_COMMAND_CLOSE
390 || type == TEXT_ITEM_SYNTAX)
393 csv_put_separator (csv);
396 case TEXT_ITEM_TITLE:
397 csv_output_field_format (csv, "Title: %s", text);
400 case TEXT_ITEM_SUBTITLE:
401 csv_output_field_format (csv, "Subtitle: %s", text);
405 csv_output_field (csv, text);
408 putc ('\n', csv->file);
410 else if (is_message_item (output_item))
412 const struct message_item *message_item = to_message_item (output_item);
413 const struct msg *msg = message_item_get_msg (message_item);
414 char *s = msg_to_string (msg, csv->command_name);
415 csv_put_separator (csv);
416 csv_output_field (csv, s);
418 putc ('\n', csv->file);
422 struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
424 static const struct output_driver_class csv_driver_class =