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/page-eject-item.h"
34 #include "output/table-item.h"
35 #include "output/table-provider.h"
37 #include "gl/minmax.h"
38 #include "gl/xalloc.h"
39 #include "gl/xvasprintf.h"
42 #define _(msgid) gettext (msgid)
44 /* Comma-separated value output driver. */
47 struct output_driver driver;
49 char *separator; /* Field separator (usually comma or tab). */
50 int quote; /* Quote character (usually ' or ") or 0. */
51 char *quote_set; /* Characters that force quoting. */
52 bool titles; /* Print table titles? */
53 bool captions; /* Print table captions? */
55 struct file_handle *handle;
56 FILE *file; /* Output file. */
57 int n_items; /* Number of items output so far. */
60 static const struct output_driver_class csv_driver_class;
62 static struct csv_driver *
63 csv_driver_cast (struct output_driver *driver)
65 assert (driver->class == &csv_driver_class);
66 return UP_CAST (driver, struct csv_driver, driver);
69 static struct driver_option *
70 opt (struct output_driver *d, struct string_map *options, const char *key,
71 const char *default_value)
73 return driver_option_get (d, options, key, default_value);
76 static struct output_driver *
77 csv_create (struct file_handle *fh, enum settings_output_devices device_type,
80 struct output_driver *d;
81 struct csv_driver *csv;
84 csv = xzalloc (sizeof *csv);
86 output_driver_init (&csv->driver, &csv_driver_class, fh_get_file_name (fh), device_type);
88 csv->separator = parse_string (opt (d, o, "separator", ","));
89 quote = parse_string (opt (d, o, "quote", "\""));
90 csv->quote = quote[0];
92 csv->quote_set = xasprintf ("\n\r\t%s%c", csv->separator, csv->quote);
93 csv->titles = parse_boolean (opt (d, o, "titles", "true"));
94 csv->captions = parse_boolean (opt (d, o, "captions", "true"));
96 csv->file = fn_open (fh, "w");
99 if (csv->file == NULL)
101 msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
102 output_driver_destroy (d);
110 csv_destroy (struct output_driver *driver)
112 struct csv_driver *csv = csv_driver_cast (driver);
114 if (csv->file != NULL)
115 fn_close (csv->handle, csv->file);
117 free (csv->separator);
118 free (csv->quote_set);
119 fh_unref (csv->handle);
124 csv_flush (struct output_driver *driver)
126 struct csv_driver *csv = csv_driver_cast (driver);
127 if (csv->file != NULL)
132 csv_output_field__ (struct csv_driver *csv, struct substring field)
134 ss_ltrim (&field, ss_cstr (" "));
136 if (csv->quote && ss_cspan (field, ss_cstr (csv->quote_set)) < field.length)
138 putc (csv->quote, csv->file);
139 for (size_t i = 0; i < field.length; i++)
141 if (field.string[i] == csv->quote)
142 putc (csv->quote, csv->file);
143 putc (field.string[i], csv->file);
145 putc (csv->quote, csv->file);
148 fwrite (field.string, field.length, 1, csv->file);
152 csv_output_field (struct csv_driver *csv, const char *field)
154 csv_output_field__ (csv, ss_cstr (field));
158 csv_put_separator (struct csv_driver *csv)
160 if (csv->n_items++ > 0)
161 putc ('\n', csv->file);
165 csv_output_lines (struct csv_driver *csv, const char *text_)
167 struct substring text = ss_cstr (text_);
168 struct substring line;
170 while (ss_separate (text, ss_cstr ("\n"), &save_idx, &line))
172 csv_output_field__ (csv, line);
173 putc ('\n', csv->file);
178 csv_format_footnotes (const struct footnote **f, size_t n, struct string *s)
180 for (size_t i = 0; i < n; i++)
181 ds_put_format (s, "[%s]", f[i]->marker);
185 csv_output_table_item_text (struct csv_driver *csv,
186 const struct table_item_text *text,
192 struct string s = DS_EMPTY_INITIALIZER;
193 ds_put_format (&s, "%s: %s", leader, text->content);
194 csv_format_footnotes (text->footnotes, text->n_footnotes, &s);
195 csv_output_field (csv, ds_cstr (&s));
197 putc ('\n', csv->file);
201 csv_submit (struct output_driver *driver,
202 const struct output_item *output_item)
204 struct csv_driver *csv = csv_driver_cast (driver);
206 if (is_table_item (output_item))
208 struct table_item *table_item = to_table_item (output_item);
209 const struct table *t = table_item_get_table (table_item);
212 csv_put_separator (csv);
215 csv_output_table_item_text (csv, table_item_get_title (table_item),
218 for (y = 0; y < table_nr (t); y++)
220 for (x = 0; x < table_nc (t); x++)
222 struct table_cell cell;
224 table_get_cell (t, x, y, &cell);
227 fputs (csv->separator, csv->file);
229 if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
230 csv_output_field (csv, "");
231 else if (!(cell.options & TAB_MARKUP) && !cell.n_footnotes
232 && !cell.n_subscripts && !cell.superscript)
233 csv_output_field (csv, cell.text);
236 struct string s = DS_EMPTY_INITIALIZER;
238 if (cell.options & TAB_MARKUP)
240 char *t = output_get_text_from_markup (cell.text);
245 ds_put_cstr (&s, cell.text);
247 if (cell.n_subscripts)
248 for (size_t i = 0; i < cell.n_subscripts; i++)
249 ds_put_format (&s, "%c%s",
250 i ? ',' : '_', cell.subscripts[i]);
251 if (cell.superscript)
252 ds_put_format (&s, "^%s", cell.superscript);
253 csv_format_footnotes (cell.footnotes, cell.n_footnotes, &s);
254 csv_output_field (csv, ds_cstr (&s));
258 putc ('\n', csv->file);
262 csv_output_table_item_text (csv, table_item_get_caption (table_item),
265 const struct footnote **f;
266 size_t n_footnotes = table_collect_footnotes (table_item, &f);
269 fputs ("\nFootnotes:\n", csv->file);
271 for (size_t i = 0; i < n_footnotes; i++)
273 csv_output_field (csv, f[i]->marker);
274 fputs (csv->separator, csv->file);
275 csv_output_field (csv, f[i]->content);
276 putc ('\n', csv->file);
282 else if (is_text_item (output_item))
284 const struct text_item *text_item = to_text_item (output_item);
285 enum text_item_type type = text_item_get_type (text_item);
286 const char *text = text_item_get_text (text_item);
288 if (type == TEXT_ITEM_SYNTAX || type == TEXT_ITEM_PAGE_TITLE)
291 csv_put_separator (csv);
293 if (text_item->markup)
295 char *plain_text = output_get_text_from_markup (text);
296 csv_output_lines (csv, plain_text);
300 csv_output_lines (csv, text);
302 else if (is_page_eject_item (output_item))
304 csv_put_separator (csv);
305 csv_output_lines (csv, "");
307 else if (is_message_item (output_item))
309 const struct message_item *message_item = to_message_item (output_item);
310 char *s = msg_to_string (message_item_get_msg (message_item));
311 csv_put_separator (csv);
312 csv_output_field (csv, s);
314 putc ('\n', csv->file);
318 struct output_driver_factory csv_driver_factory = { "csv", "-", csv_create };
320 static const struct output_driver_class csv_driver_class =