1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014, 2019 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/>. */
19 #include "output/driver.h"
20 #include "output/driver-provider.h"
24 #include <libxml/parser.h>
25 #include <libxml/tree.h>
31 #include "data/file-handle-def.h"
32 #include "data/settings.h"
33 #include "libpspp/array.h"
34 #include "libpspp/assertion.h"
35 #include "libpspp/i18n.h"
36 #include "libpspp/message.h"
37 #include "libpspp/llx.h"
38 #include "libpspp/string-map.h"
39 #include "libpspp/string-set.h"
40 #include "libpspp/str.h"
41 #include "output/group-item.h"
42 #include "output/message-item.h"
43 #include "output/output-item.h"
44 #include "output/text-item.h"
47 #include "gl/xalloc.h"
48 #include "gl/xmemdup0.h"
51 #define _(msgid) gettext (msgid)
55 struct ll ll; /* Node for this engine. */
56 struct llx_list drivers; /* Contains "struct output_driver"s. */
57 struct text_item *deferred_text; /* Output text being accumulated. */
58 char *command_name; /* Name of command being processed. */
59 char *title, *subtitle; /* Components of page title. */
61 /* Output grouping stack.
63 TEXT_ITEM_GROUP_OPEN pushes a group on the stack and
64 TEXT_ITEM_GROUP_CLOSE pops one off. */
65 char **groups; /* Command names of nested sections. */
67 size_t allocated_groups;
69 struct string_map heading_vars;
72 static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
74 static const struct output_driver_factory *factories[];
76 static struct output_engine *
77 engine_stack_top (void)
79 struct ll *head = ll_head (&engine_stack);
80 if (ll_is_empty (&engine_stack))
82 return ll_data (head, struct output_engine, ll);
86 put_strftime (const char *key, const char *format,
87 const struct tm *tm, struct string_map *vars)
89 if (!string_map_find (vars, key))
92 strftime (value, sizeof value, format, tm);
93 string_map_insert (vars, key, value);
98 output_engine_push (void)
100 struct output_engine *e = xzalloc (sizeof (*e));
102 llx_init (&e->drivers);
104 string_map_init (&e->heading_vars);
106 time_t t = time (NULL);
107 const struct tm *tm = localtime (&t);
108 put_strftime ("Date", "%x", tm, &e->heading_vars);
109 put_strftime ("Time", "%X", tm, &e->heading_vars);
111 ll_push_head (&engine_stack, &e->ll);
115 output_engine_pop (void)
117 struct ll *head = ll_pop_head (&engine_stack);
118 struct output_engine *e =ll_data (head, struct output_engine, ll);
120 while (!llx_is_empty (&e->drivers))
122 struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
123 output_driver_destroy (d);
125 text_item_unref (e->deferred_text);
126 free (e->command_name);
129 for (size_t i = 0; i < e->n_groups; i++)
132 string_map_destroy (&e->heading_vars);
137 output_get_supported_formats (struct string_set *formats)
139 const struct output_driver_factory **fp;
141 for (fp = factories; *fp != NULL; fp++)
142 string_set_insert (formats, (*fp)->extension);
146 output_submit__ (struct output_engine *e, struct output_item *item)
148 struct llx *llx, *next;
150 for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
152 struct output_driver *d = llx_data (llx);
153 enum settings_output_type type;
155 next = llx_next (llx);
157 if (is_message_item (item))
159 const struct msg *m = message_item_get_msg (to_message_item (item));
160 if (m->severity == MSG_S_NOTE)
161 type = SETTINGS_OUTPUT_NOTE;
163 type = SETTINGS_OUTPUT_ERROR;
165 else if (is_text_item (item)
166 && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
167 type = SETTINGS_OUTPUT_SYNTAX;
169 type = SETTINGS_OUTPUT_RESULT;
171 if (settings_get_output_routing (type) & d->device_type)
172 d->class->submit (d, item);
175 output_item_unref (item);
179 flush_deferred_text (struct output_engine *e)
181 struct text_item *deferred_text = e->deferred_text;
184 e->deferred_text = NULL;
185 output_submit__ (e, text_item_super (deferred_text));
190 defer_text (struct output_engine *e, struct output_item *output_item)
192 if (!is_text_item (output_item))
195 struct text_item *text = to_text_item (output_item);
196 if (!e->deferred_text)
197 e->deferred_text = text_item_unshare (text);
198 else if (text_item_append (e->deferred_text, text))
199 text_item_unref (text);
202 flush_deferred_text (e);
203 e->deferred_text = text_item_unshare (text);
208 /* Submits ITEM to the configured output drivers, and transfers ownership to
209 the output subsystem. */
211 output_submit (struct output_item *item)
213 struct output_engine *e = engine_stack_top ();
221 if (defer_text (e, item))
223 flush_deferred_text (e);
225 if (is_group_open_item (item))
227 const struct group_open_item *group_open_item
228 = to_group_open_item (item);
229 if (e->n_groups >= e->allocated_groups)
230 e->groups = x2nrealloc (e->groups, &e->allocated_groups,
232 e->groups[e->n_groups] = (group_open_item->command_name
233 ? xstrdup (group_open_item->command_name)
237 else if (is_group_close_item (item))
239 assert (e->n_groups > 0);
241 size_t idx = --e->n_groups;
242 free (e->groups[idx]);
243 if (idx >= 1 && idx <= 4)
245 char *key = xasprintf ("Head%zu", idx);
246 free (string_map_find_and_delete (&e->heading_vars, key));
250 else if (is_text_item (item))
252 const struct text_item *text_item = to_text_item (item);
253 enum text_item_type type = text_item_get_type (text_item);
254 const char *text = text_item_get_text (text_item);
255 if (type == TEXT_ITEM_TITLE
256 && e->n_groups >= 1 && e->n_groups <= 4)
258 char *key = xasprintf ("Head%zu", e->n_groups);
259 string_map_replace (&e->heading_vars, key, text);
262 else if (type == TEXT_ITEM_PAGE_TITLE)
263 string_map_replace (&e->heading_vars, "PageTitle", text);
266 output_submit__ (e, item);
269 /* Returns the name of the command currently being parsed, in all uppercase.
270 The caller must free the returned value.
272 Returns NULL if no command is being parsed. */
274 output_get_command_name (void)
276 struct output_engine *e = engine_stack_top ();
280 for (size_t i = e->n_groups; i-- > 0;)
282 return utf8_to_upper (e->groups[i]);
287 /* Flushes output to screen devices, so that the user can see
288 output that doesn't fill up an entire page. */
292 struct output_engine *e = engine_stack_top ();
295 flush_deferred_text (e);
296 for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
297 llx = llx_next (llx))
299 struct output_driver *d = llx_data (llx);
300 if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
306 output_set_title__ (struct output_engine *e, char **dst, const char *src)
309 *dst = src ? xstrdup (src) : NULL;
312 = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
313 : e->title ? xstrdup (e->title)
314 : e->subtitle ? xstrdup (e->subtitle)
316 text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
321 output_set_title (const char *title)
323 struct output_engine *e = engine_stack_top ();
325 output_set_title__ (e, &e->title, title);
329 output_set_subtitle (const char *subtitle)
331 struct output_engine *e = engine_stack_top ();
333 output_set_title__ (e, &e->subtitle, subtitle);
337 output_set_filename (const char *filename)
339 struct output_engine *e = engine_stack_top ();
341 string_map_replace (&e->heading_vars, "Filename", filename);
345 output_get_group_level (void)
347 struct output_engine *e = engine_stack_top ();
353 output_driver_init (struct output_driver *driver,
354 const struct output_driver_class *class,
355 const char *name, enum settings_output_devices type)
357 driver->class = class;
358 driver->name = xstrdup (name);
359 driver->device_type = type;
363 output_driver_destroy (struct output_driver *driver)
367 char *name = driver->name;
368 if (output_driver_is_registered (driver))
369 output_driver_unregister (driver);
370 if (driver->class->destroy)
371 driver->class->destroy (driver);
377 output_driver_get_name (const struct output_driver *driver)
382 static struct output_engine *
383 output_driver_get_engine (const struct output_driver *driver)
385 struct output_engine *e;
387 ll_for_each (e, struct output_engine, ll, &engine_stack)
389 if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
397 output_driver_register (struct output_driver *driver)
399 struct output_engine *e = engine_stack_top ();
401 assert (!output_driver_is_registered (driver));
402 llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
406 output_driver_unregister (struct output_driver *driver)
408 struct output_engine *e = output_driver_get_engine (driver);
411 llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
416 output_driver_is_registered (const struct output_driver *driver)
418 return output_driver_get_engine (driver) != NULL;
421 extern const struct output_driver_factory txt_driver_factory;
422 extern const struct output_driver_factory list_driver_factory;
423 extern const struct output_driver_factory html_driver_factory;
424 extern const struct output_driver_factory csv_driver_factory;
425 extern const struct output_driver_factory odt_driver_factory;
426 extern const struct output_driver_factory spv_driver_factory;
428 extern const struct output_driver_factory pdf_driver_factory;
429 extern const struct output_driver_factory ps_driver_factory;
430 extern const struct output_driver_factory svg_driver_factory;
431 extern const struct output_driver_factory png_driver_factory;
433 extern const struct output_driver_factory tex_driver_factory;
435 static const struct output_driver_factory *factories[] =
438 &list_driver_factory,
439 &html_driver_factory,
453 static const struct output_driver_factory *
454 find_factory (const char *format)
456 const struct output_driver_factory **fp;
458 for (fp = factories; *fp != NULL; fp++)
460 const struct output_driver_factory *f = *fp;
462 if (!strcmp (f->extension, format))
465 return &txt_driver_factory;
468 static enum settings_output_devices
469 default_device_type (const char *file_name)
471 return (!strcmp (file_name, "-")
472 ? SETTINGS_DEVICE_TERMINAL
473 : SETTINGS_DEVICE_LISTING);
476 struct output_driver *
477 output_driver_create (struct string_map *options)
479 enum settings_output_devices device_type;
480 const struct output_driver_factory *f;
481 struct output_driver *driver;
486 format = string_map_find_and_delete (options, "format");
487 file_name = string_map_find_and_delete (options, "output-file");
491 if (file_name != NULL)
493 const char *extension = strrchr (file_name, '.');
494 format = xstrdup (extension != NULL ? extension + 1 : "");
497 format = xstrdup ("txt");
499 f = find_factory (format);
501 if (file_name == NULL)
502 file_name = xstrdup (f->default_file_name);
504 /* XXX should use parse_enum(). */
505 device_string = string_map_find_and_delete (options, "device");
506 if (device_string == NULL || device_string[0] == '\0')
507 device_type = default_device_type (file_name);
508 else if (!strcmp (device_string, "terminal"))
509 device_type = SETTINGS_DEVICE_TERMINAL;
510 else if (!strcmp (device_string, "listing"))
511 device_type = SETTINGS_DEVICE_LISTING;
514 msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
515 device_string, "terminal", "listing");
516 device_type = default_device_type (file_name);
519 struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
521 driver = f->create (fh, device_type, options);
524 const struct string_map_node *node;
527 STRING_MAP_FOR_EACH_KEY (key, node, options)
528 msg (MW, _("%s: unknown option `%s'"), file_name, key);
530 string_map_clear (options);
534 free (device_string);
540 output_driver_parse_option (const char *option, struct string_map *options)
542 const char *equals = strchr (option, '=');
545 error (0, 0, _("%s: output option missing `='"), option);
549 char *key = xmemdup0 (option, equals - option);
550 if (string_map_contains (options, key))
552 error (0, 0, _("%s: output option specified more than once"), key);
557 char *value = xmemdup0 (equals + 1, strlen (equals + 1));
558 string_map_insert_nocopy (options, key, value);
561 /* Extracts the actual text content from the given Pango MARKUP and returns it
562 as as a malloc()'d string. */
564 output_get_text_from_markup (const char *markup)
566 xmlParserCtxt *parser = xmlCreatePushParserCtxt (NULL, NULL, NULL, 0, NULL);
568 return xstrdup (markup);
570 xmlParseChunk (parser, "<xml>", strlen ("<xml>"), false);
571 xmlParseChunk (parser, markup, strlen (markup), false);
572 xmlParseChunk (parser, "</xml>", strlen ("</xml>"), true);
575 = (parser->wellFormed
577 xmlNodeGetContent (xmlDocGetRootElement (parser->myDoc)))
579 xmlFreeDoc (parser->myDoc);
580 xmlFreeParserCtxt (parser);
586 output_driver_substitute_heading_vars (const char *src, int page_number)
588 struct output_engine *e = engine_stack_top ();
589 struct string dst = DS_EMPTY_INITIALIZER;
590 ds_extend (&dst, strlen (src));
591 for (const char *p = src; *p;)
593 if (!strncmp (p, "&[", 6))
595 if (page_number != INT_MIN)
597 const char *start = p + 6;
598 const char *end = strchr (start, ']');
601 const char *value = string_map_find__ (&e->heading_vars,
604 ds_put_cstr (&dst, value);
605 else if (ss_equals (ss_buffer (start, end - start),
607 ds_put_format (&dst, "%d", page_number);
612 ds_put_cstr (&dst, "&");
616 ds_put_byte (&dst, *p++);
618 return ds_steal_cstr (&dst);