#include <stdlib.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 "output/driver-provider.h"
#include "output/options.h"
#include "output/message-item.h"
+#include "output/page-eject-item.h"
#include "output/table-item.h"
#include "output/table-provider.h"
+#include "gl/minmax.h"
#include "gl/xalloc.h"
#include "gl/xvasprintf.h"
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. */
- char *command_name; /* Current command. */
+ struct file_handle *handle;
FILE *file; /* Output file. */
int n_items; /* Number of items output so far. */
};
}
static struct output_driver *
-csv_create (const char *file_name, enum settings_output_devices device_type,
+csv_create (struct file_handle *fh, enum settings_output_devices device_type,
struct string_map *o)
{
struct output_driver *d;
csv = xzalloc (sizeof *csv);
d = &csv->driver;
- output_driver_init (&csv->driver, &csv_driver_class, file_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", ","));
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->file_name = xstrdup (file_name);
- csv->file = fn_open (csv->file_name, "w");
+ csv->handle = fh;
+ csv->file = fn_open (fh, "w");
csv->n_items = 0;
if (csv->file == NULL)
{
- msg_error (errno, _("error opening output file `%s'"), csv->file_name);
+ msg_error (errno, _("error opening output file `%s'"), fh_get_file_name (fh));
output_driver_destroy (d);
return NULL;
}
struct csv_driver *csv = csv_driver_cast (driver);
if (csv->file != NULL)
- fn_close (csv->file_name, csv->file);
+ fn_close (csv->handle, csv->file);
free (csv->separator);
free (csv->quote_set);
- free (csv->file_name);
+ fh_unref (csv->handle);
free (csv);
}
}
static void
-csv_output_field (struct csv_driver *csv, const char *field)
+csv_output_field__ (struct csv_driver *csv, struct substring field)
{
- while (*field == ' ')
- field++;
+ ss_ltrim (&field, ss_cstr (" "));
- if (csv->quote && field[strcspn (field, csv->quote_set)])
+ if (csv->quote && ss_cspan (field, ss_cstr (csv->quote_set)) < field.length)
{
- const char *p;
-
putc (csv->quote, csv->file);
- for (p = field; *p != '\0'; p++)
+ for (size_t i = 0; i < field.length; i++)
{
- if (*p == csv->quote)
+ if (field.string[i] == csv->quote)
putc (csv->quote, csv->file);
- putc (*p, csv->file);
+ putc (field.string[i], csv->file);
}
putc (csv->quote, csv->file);
}
else
- fputs (field, csv->file);
+ fwrite (field.string, field.length, 1, csv->file);
}
-static void PRINTF_FORMAT (2, 3)
-csv_output_field_format (struct csv_driver *csv, const char *format, ...)
+static void
+csv_output_field (struct csv_driver *csv, const char *field)
{
- va_list args;
- char *s;
-
- va_start (args, format);
- s = xvasprintf (format, args);
- va_end (args);
-
- csv_output_field (csv, s);
- free (s);
+ csv_output_field__ (csv, ss_cstr (field));
}
static void
-csv_put_field (struct csv_driver *csv, struct string *s, const char *field)
+csv_put_separator (struct csv_driver *csv)
{
- while (*field == ' ')
- field++;
-
- if (csv->quote && field[strcspn (field, csv->quote_set)])
- {
- const char *p;
-
- ds_put_byte (s, csv->quote);
- for (p = field; *p != '\0'; p++)
- {
- if (*p == csv->quote)
- ds_put_byte (s, csv->quote);
- ds_put_byte (s, *p);
- }
- ds_put_byte (s, csv->quote);
- }
- else
- ds_put_cstr (s, field);
+ if (csv->n_items++ > 0)
+ putc ('\n', csv->file);
}
static void
-csv_output_subtable (struct csv_driver *csv, struct string *s,
- const struct table_item *item)
+csv_output_lines (struct csv_driver *csv, const char *text_)
{
- const struct table *t = table_item_get_table (item);
- const char *caption = table_item_get_caption (item);
- int y, x;
-
- if (csv->captions && caption != NULL)
+ struct substring text = ss_cstr (text_);
+ struct substring line;
+ size_t save_idx = 0;
+ while (ss_separate (text, ss_cstr ("\n"), &save_idx, &line))
{
- csv_output_field_format (csv, "Table: %s", caption);
+ csv_output_field__ (csv, line);
putc ('\n', csv->file);
}
+}
- for (y = 0; y < table_nr (t); y++)
- {
- if (y > 0)
- ds_put_byte (s, '\n');
+static void
+csv_format_footnotes (struct footnote **f, size_t n, struct string *s)
+{
+ for (size_t i = 0; i < n; i++)
+ ds_put_format (s, "[%s]", f[i]->marker);
+}
- for (x = 0; x < table_nc (t); x++)
- {
- struct table_cell cell;
+static void
+csv_output_table_item_text (struct csv_driver *csv,
+ const struct table_item_text *text,
+ const char *leader)
+{
+ if (!text)
+ return;
+
+ struct string s = DS_EMPTY_INITIALIZER;
+ ds_put_format (&s, "%s: %s", leader, text->content);
+ csv_format_footnotes (text->footnotes, text->n_footnotes, &s);
+ csv_output_field (csv, ds_cstr (&s));
+ ds_destroy (&s);
+ putc ('\n', csv->file);
+}
- table_get_cell (t, x, y, &cell);
+static void
+csv_output_table_cell (struct csv_driver *csv,
+ const struct table_cell *cell,
+ const char *leader)
+{
+ if (!cell)
+ return;
- if (x > 0)
- ds_put_cstr (s, csv->separator);
+ if (!(cell->options & TAB_MARKUP) && !cell->n_footnotes
+ && !cell->n_subscripts && !leader)
+ csv_output_field (csv, cell->text);
+ else
+ {
+ struct string s = DS_EMPTY_INITIALIZER;
- 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);
- }
+ if (leader)
+ ds_put_format (&s, "%s: ", leader);
- table_cell_free (&cell);
+ if (cell->options & TAB_MARKUP)
+ {
+ char *t = output_get_text_from_markup (cell->text);
+ ds_put_cstr (&s, t);
+ free (t);
}
+ else
+ ds_put_cstr (&s, cell->text);
+
+ if (cell->n_subscripts)
+ for (size_t i = 0; i < cell->n_subscripts; i++)
+ ds_put_format (&s, "%c%s",
+ i ? ',' : '_', cell->subscripts[i]);
+ csv_format_footnotes (cell->footnotes, cell->n_footnotes, &s);
+ csv_output_field (csv, ds_cstr (&s));
+ ds_destroy (&s);
+
+ if (leader)
+ putc ('\n', csv->file);
}
}
-static void
-csv_put_separator (struct csv_driver *csv)
-{
- if (csv->n_items++ > 0)
- putc ('\n', csv->file);
-}
-
static void
csv_submit (struct output_driver *driver,
const struct output_item *output_item)
{
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 *caption = table_item_get_caption (table_item);
const struct table *t = table_item_get_table (table_item);
int x, y;
csv_put_separator (csv);
- if (csv->captions && caption != NULL)
- {
- csv_output_field_format (csv, "Table: %s", caption);
- putc ('\n', csv->file);
- }
+ if (csv->titles)
+ csv_output_table_cell (csv, table_item_get_title (table_item), "Table");
- for (y = 0; y < table_nr (t); y++)
+ for (y = 0; y < t->n[TABLE_VERT]; y++)
{
- for (x = 0; x < table_nc (t); x++)
+ for (x = 0; x < t->n[TABLE_HORZ]; x++)
{
struct table_cell cell;
if (x != cell.d[TABLE_HORZ][0] || y != cell.d[TABLE_VERT][0])
csv_output_field (csv, "");
- else if (cell.n_contents == 1 && cell.contents[0].text != NULL)
- csv_output_field (csv, cell.contents[0].text);
else
- {
- struct string s;
- size_t i;
-
- ds_init_empty (&s);
- for (i = 0; i < cell.n_contents; i++)
- {
- if (i > 0)
- ds_put_cstr (&s, "\n\n");
-
- if (cell.contents[i].text != NULL)
- ds_put_cstr (&s, cell.contents[i].text);
- else
- csv_output_subtable (csv, &s, cell.contents[i].table);
- }
- csv_output_field (csv, ds_cstr (&s));
- ds_destroy (&s);
- }
-
- table_cell_free (&cell);
+ csv_output_table_cell (csv, &cell, NULL);
}
putc ('\n', csv->file);
}
+
+ if (csv->captions)
+ csv_output_table_item_text (csv, table_item_get_caption (table_item),
+ "Caption");
+
+ struct footnote **f;
+ size_t n_footnotes = table_collect_footnotes (table_item, &f);
+ if (n_footnotes)
+ {
+ fputs ("\nFootnotes:\n", csv->file);
+
+ for (size_t i = 0; i < n_footnotes; i++)
+ {
+ csv_output_field (csv, f[i]->marker);
+ fputs (csv->separator, csv->file);
+ csv_output_field (csv, f[i]->content);
+ putc ('\n', csv->file);
+ }
+
+ free (f);
+ }
}
else if (is_text_item (output_item))
{
enum text_item_type type = text_item_get_type (text_item);
const char *text = text_item_get_text (text_item);
- if (type == TEXT_ITEM_COMMAND_OPEN || type == TEXT_ITEM_COMMAND_CLOSE
- || type == TEXT_ITEM_SYNTAX)
+ if (type == TEXT_ITEM_SYNTAX || type == TEXT_ITEM_PAGE_TITLE)
return;
csv_put_separator (csv);
- switch (type)
- {
- case TEXT_ITEM_TITLE:
- csv_output_field_format (csv, "Title: %s", text);
- break;
-
- case TEXT_ITEM_SUBTITLE:
- csv_output_field_format (csv, "Subtitle: %s", text);
- break;
- default:
- csv_output_field (csv, text);
- break;
+ if (text_item->markup)
+ {
+ char *plain_text = output_get_text_from_markup (text);
+ csv_output_lines (csv, plain_text);
+ free (plain_text);
}
- putc ('\n', csv->file);
+ else
+ csv_output_lines (csv, text);
+ }
+ else if (is_page_eject_item (output_item))
+ {
+ csv_put_separator (csv);
+ csv_output_lines (csv, "");
}
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);
+ char *s = msg_to_string (message_item_get_msg (message_item));
csv_put_separator (csv);
csv_output_field (csv, s);
free (s);