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 "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/text-item.h"
30 #include "output/driver-provider.h"
31 #include "output/options.h"
32 #include "output/message-item.h"
33 #include "output/table-item.h"
34 #include "output/table-provider.h"
36 #include "gl/xalloc.h"
37 #include "gl/xvasprintf.h"
40 #define _(msgid) gettext (msgid)
42 /* Comma-separated value output driver. */
45 struct output_driver driver;
47 char *separator; /* Field separator (usually comma or tab). */
48 int quote; /* Quote character (usually ' or ") or 0. */
49 char *quote_set; /* Characters that force quoting. */
50 bool titles; /* Print table titles? */
51 bool captions; /* Print table captions? */
53 struct file_handle *handle;
54 char *command_name; /* Current command. */
55 FILE *file; /* Output file. */
56 int n_items; /* Number of items output so far. */
59 static const struct output_driver_class csv_driver_class;
61 static struct csv_driver *
62 csv_driver_cast (struct output_driver *driver)
64 assert (driver->class == &csv_driver_class);
65 return UP_CAST (driver, struct csv_driver, driver);
68 static struct driver_option *
69 opt (struct output_driver *d, struct string_map *options, const char *key,
70 const char *default_value)
72 return driver_option_get (d, options, key, default_value);
75 static struct output_driver *
76 csv_create (struct file_handle *fh, enum settings_output_devices device_type,
79 struct output_driver *d;
80 struct csv_driver *csv;
83 csv = xzalloc (sizeof *csv);
85 output_driver_init (&csv->driver, &csv_driver_class, fh_get_file_name (fh), device_type);
87 csv->separator = parse_string (opt (d, o, "separator", ","));
88 quote = parse_string (opt (d, o, "quote", "\""));
89 csv->quote = quote[0];
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"));
95 csv->file = fn_open (fh, "w");
98 if (csv->file == NULL)
100 msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
101 output_driver_destroy (d);
109 csv_destroy (struct output_driver *driver)
111 struct csv_driver *csv = csv_driver_cast (driver);
113 if (csv->file != NULL)
114 fn_close (csv->handle, csv->file);
116 free (csv->separator);
117 free (csv->quote_set);
118 fh_unref (csv->handle);
123 csv_flush (struct output_driver *driver)
125 struct csv_driver *csv = csv_driver_cast (driver);
126 if (csv->file != NULL)
131 csv_output_field (struct csv_driver *csv, const char *field)
133 while (*field == ' ')
136 if (csv->quote && field[strcspn (field, csv->quote_set)])
140 putc (csv->quote, csv->file);
141 for (p = field; *p != '\0'; p++)
143 if (*p == csv->quote)
144 putc (csv->quote, csv->file);
145 putc (*p, csv->file);
147 putc (csv->quote, csv->file);
150 fputs (field, csv->file);
153 static void PRINTF_FORMAT (2, 3)
154 csv_output_field_format (struct csv_driver *csv, const char *format, ...)
159 va_start (args, format);
160 s = xvasprintf (format, args);
163 csv_output_field (csv, s);
168 csv_put_field (struct csv_driver *csv, struct string *s, const char *field)
170 while (*field == ' ')
173 if (csv->quote && field[strcspn (field, csv->quote_set)])
177 ds_put_byte (s, csv->quote);
178 for (p = field; *p != '\0'; p++)
180 if (*p == csv->quote)
181 ds_put_byte (s, csv->quote);
184 ds_put_byte (s, csv->quote);
187 ds_put_cstr (s, field);
191 csv_output_subtable (struct csv_driver *csv, struct string *s,
192 const struct table_item *item)
194 const struct table *t = table_item_get_table (item);
195 const char *title = table_item_get_title (item);
196 const char *caption = table_item_get_caption (item);
199 if (csv->titles && title != NULL)
201 csv_output_field_format (csv, "Table: %s", title);
202 putc ('\n', csv->file);
205 for (y = 0; y < table_nr (t); y++)
208 ds_put_byte (s, '\n');
210 for (x = 0; x < table_nc (t); x++)
212 struct table_cell cell;
214 table_get_cell (t, x, y, &cell);
217 ds_put_cstr (s, csv->separator);
219 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
220 csv_put_field (csv, s, "");
221 else if (cell.n_contents == 1 && cell.contents[0].text != NULL)
222 csv_put_field (csv, s, cell.contents[0].text);
229 for (i = 0; i < cell.n_contents; i++)
232 ds_put_cstr (&s2, "\n\n");
234 if (cell.contents[i].text != NULL)
235 ds_put_cstr (&s2, cell.contents[i].text);
237 csv_output_subtable (csv, &s2, cell.contents[i].table);
239 csv_put_field (csv, s, ds_cstr (&s2));
243 table_cell_free (&cell);
247 if (csv->captions && caption != NULL)
249 csv_output_field_format (csv, "Caption: %s", caption);
250 putc ('\n', csv->file);
255 csv_put_separator (struct csv_driver *csv)
257 if (csv->n_items++ > 0)
258 putc ('\n', csv->file);
262 csv_submit (struct output_driver *driver,
263 const struct output_item *output_item)
265 struct csv_driver *csv = csv_driver_cast (driver);
267 output_driver_track_current_command (output_item, &csv->command_name);
269 if (is_table_item (output_item))
271 struct table_item *table_item = to_table_item (output_item);
272 const char *title = table_item_get_title (table_item);
273 const char *caption = table_item_get_caption (table_item);
274 const struct table *t = table_item_get_table (table_item);
278 csv_put_separator (csv);
280 if (csv->titles && title != NULL)
282 csv_output_field_format (csv, "Table: %s", title);
283 putc ('\n', csv->file);
287 for (y = 0; y < table_nr (t); y++)
289 for (x = 0; x < table_nc (t); x++)
291 struct table_cell cell;
293 table_get_cell (t, x, y, &cell);
296 fputs (csv->separator, csv->file);
298 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
299 csv_output_field (csv, "");
300 else if (cell.n_contents == 1
301 && cell.contents[0].text != NULL
302 && cell.contents[0].n_footnotes == 0)
303 csv_output_field (csv, cell.contents[0].text);
310 for (i = 0; i < cell.n_contents; i++)
312 const struct cell_contents *c = &cell.contents[i];
316 ds_put_cstr (&s, "\n\n");
319 ds_put_cstr (&s, c->text);
321 csv_output_subtable (csv, &s, c->table);
323 for (j = 0; j < c->n_footnotes; j++)
327 str_format_26adic (++footnote_idx, false,
328 marker, sizeof marker);
329 ds_put_format (&s, "[%s]", marker);
332 csv_output_field (csv, ds_cstr (&s));
336 table_cell_free (&cell);
338 putc ('\n', csv->file);
341 if (csv->captions && caption != NULL)
343 csv_output_field_format (csv, "Caption: %s", caption);
344 putc ('\n', csv->file);
351 fputs ("\nFootnotes:\n", csv->file);
354 for (y = 0; y < table_nr (t); y++)
356 struct table_cell cell;
357 for (x = 0; x < table_nc (t); x = cell.d[TABLE_HORZ][1])
359 table_get_cell (t, x, y, &cell);
361 if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
362 for (i = 0; i < cell.n_contents; i++)
364 const struct cell_contents *c = &cell.contents[i];
367 for (j = 0; j < c->n_footnotes; j++)
371 str_format_26adic (++footnote_idx, false,
372 marker, sizeof marker);
373 csv_output_field (csv, marker);
374 fputs (csv->separator, csv->file);
375 csv_output_field (csv, c->footnotes[j]);
376 putc ('\n', csv->file);
379 table_cell_free (&cell);
384 else if (is_text_item (output_item))
386 const struct text_item *text_item = to_text_item (output_item);
387 enum text_item_type type = text_item_get_type (text_item);
388 const char *text = text_item_get_text (text_item);
390 if (type == TEXT_ITEM_COMMAND_OPEN || type == TEXT_ITEM_COMMAND_CLOSE
391 || type == TEXT_ITEM_SYNTAX)
394 csv_put_separator (csv);
397 case TEXT_ITEM_TITLE:
398 csv_output_field_format (csv, "Title: %s", text);
401 case TEXT_ITEM_SUBTITLE:
402 csv_output_field_format (csv, "Subtitle: %s", text);
406 csv_output_field (csv, text);
409 putc ('\n', csv->file);
411 else if (is_message_item (output_item))
413 const struct message_item *message_item = to_message_item (output_item);
414 const struct msg *msg = message_item_get_msg (message_item);
415 char *s = msg_to_string (msg, csv->command_name);
416 csv_put_separator (csv);
417 csv_output_field (csv, s);
419 putc ('\n', csv->file);
423 struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
425 static const struct output_driver_class csv_driver_class =