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"
30 #include "data/file-handle-def.h"
31 #include "data/settings.h"
32 #include "libpspp/array.h"
33 #include "libpspp/assertion.h"
34 #include "libpspp/i18n.h"
35 #include "libpspp/message.h"
36 #include "libpspp/llx.h"
37 #include "libpspp/string-map.h"
38 #include "libpspp/string-set.h"
39 #include "libpspp/str.h"
40 #include "output/output-item.h"
43 #include "gl/xalloc.h"
44 #include "gl/xmemdup0.h"
45 #include "gl/xvasprintf.h"
48 #define _(msgid) gettext (msgid)
52 struct ll ll; /* Node for this engine. */
53 struct llx_list drivers; /* Contains "struct output_driver"s. */
54 struct output_item *deferred_text; /* Output text being accumulated. */
55 char *command_name; /* Name of command being processed. */
56 char *title, *subtitle; /* Components of page title. */
58 /* Output grouping stack. */
59 struct output_item **groups;
61 size_t allocated_groups;
63 struct string_map heading_vars;
66 static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
68 static const struct output_driver_factory *factories[];
70 static struct output_engine *
71 engine_stack_top (void)
73 struct ll *head = ll_head (&engine_stack);
74 if (ll_is_empty (&engine_stack))
76 return ll_data (head, struct output_engine, ll);
80 put_strftime (const char *key, const char *format,
81 const struct tm *tm, struct string_map *vars)
83 if (!string_map_find (vars, key))
86 strftime (value, sizeof value, format, tm);
87 string_map_insert (vars, key, value);
92 output_engine_push (void)
94 struct output_engine *e = xzalloc (sizeof (*e));
96 llx_init (&e->drivers);
98 string_map_init (&e->heading_vars);
100 time_t t = time (NULL);
101 const struct tm *tm = localtime (&t);
102 put_strftime ("Date", "%x", tm, &e->heading_vars);
103 put_strftime ("Time", "%X", tm, &e->heading_vars);
105 ll_push_head (&engine_stack, &e->ll);
109 output_engine_pop (void)
111 struct ll *head = ll_pop_head (&engine_stack);
112 struct output_engine *e = ll_data (head, struct output_engine, ll);
114 struct output_driver *d;
115 llx_for_each_preremove (d, &e->drivers, &llx_malloc_mgr)
116 output_driver_destroy (d);
117 output_item_unref (e->deferred_text);
118 free (e->command_name);
122 output_item_unref (e->groups[0]);
124 string_map_destroy (&e->heading_vars);
129 output_get_supported_formats (struct string_set *formats)
131 const struct output_driver_factory **fp;
133 for (fp = factories; *fp != NULL; fp++)
134 string_set_insert (formats, (*fp)->extension);
138 output_driver_should_show (const struct output_driver *d,
139 const struct output_item *item)
141 enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
144 case OUTPUT_ITEM_MESSAGE:
145 type = (item->message->severity == MSG_S_NOTE
146 ? SETTINGS_OUTPUT_NOTE
147 : SETTINGS_OUTPUT_ERROR);
150 case OUTPUT_ITEM_TEXT:
151 if (item->text.subtype == TEXT_ITEM_SYNTAX)
152 type = SETTINGS_OUTPUT_SYNTAX;
155 case OUTPUT_ITEM_CHART:
156 case OUTPUT_ITEM_GROUP:
157 case OUTPUT_ITEM_IMAGE:
158 case OUTPUT_ITEM_PAGE_BREAK:
159 case OUTPUT_ITEM_TABLE:
163 return (settings_get_output_routing (type) & d->device_type) != 0;
166 /* Adds to OUT the subset of IN that driver D should show, considering routing
167 and visibility of each item, and flattening groups for drivers that don't
168 handle them internally. */
170 make_driver_output_subset (const struct output_item *in,
171 const struct output_driver *d,
172 struct output_item *out)
174 if (in->type == OUTPUT_ITEM_GROUP)
176 /* If we should include the group itself, then clone IN inside OUT, and
177 add any children to the clone instead to OUT directly. */
178 if (output_driver_should_show (d, in) && d->class->handles_groups)
180 struct output_item *group = group_item_clone_empty (in);
181 group_item_add_child (out, group);
185 for (size_t i = 0; i < in->group.n_children; i++)
186 make_driver_output_subset (in->group.children[i], d, out);
190 if (output_driver_should_show (d, in)
191 && (in->show || d->class->handles_show))
192 group_item_add_child (out, output_item_ref (in));
197 output_submit__ (struct output_engine *e, struct output_item *item)
201 group_item_add_child (e->groups[e->n_groups - 1], item);
205 struct llx *llx, *next;
206 llx_for_each_safe (llx, next, &e->drivers)
208 struct output_driver *d = llx_data (llx);
210 struct output_item *root = root_item_create ();
211 make_driver_output_subset (item, d, root);
212 for (size_t i = 0; i < root->group.n_children; i++)
213 d->class->submit (d, root->group.children[i]);
214 output_item_unref (root);
217 output_item_unref (item);
221 flush_deferred_text (struct output_engine *e)
223 struct output_item *deferred_text = e->deferred_text;
226 e->deferred_text = NULL;
227 output_submit__ (e, deferred_text);
232 defer_text (struct output_engine *e, struct output_item *item)
234 if (item->type != OUTPUT_ITEM_TEXT)
237 if (!e->deferred_text)
238 e->deferred_text = output_item_unshare (item);
239 else if (text_item_append (e->deferred_text, item))
240 output_item_unref (item);
243 flush_deferred_text (e);
244 e->deferred_text = output_item_unshare (item);
249 /* Submits ITEM to the configured output drivers, and transfers ownership to
250 the output subsystem. */
252 output_submit (struct output_item *item)
254 struct output_engine *e = engine_stack_top ();
262 if (defer_text (e, item))
264 flush_deferred_text (e);
266 /* XXX heading_vars */
268 output_submit__ (e, item);
271 /* Returns the name of the command currently being parsed, or NULL if no
272 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;)
281 if (e->groups[i]->command_name)
282 return e->groups[i]->command_name;
288 output_get_uppercase_command_name (void)
290 const char *command_name = output_get_command_name ();
291 return command_name ? utf8_to_upper (command_name) : NULL;
295 output_open_group (struct output_item *item)
297 struct output_engine *e = engine_stack_top ();
301 if (e->n_groups >= e->allocated_groups)
302 e->groups = x2nrealloc (e->groups, &e->allocated_groups,
304 e->groups[e->n_groups++] = item;
306 group_item_add_child (e->groups[e->n_groups - 2], item);
308 return e->n_groups - 1;
312 output_close_groups (size_t nesting_level)
314 struct output_engine *e = engine_stack_top ();
318 while (e->n_groups > nesting_level)
320 flush_deferred_text (e);
322 struct output_item *group = e->groups[--e->n_groups];
323 if (e->n_groups == 0)
324 output_submit__ (e, group);
328 /* Flushes output to screen devices, so that the user can see
329 output that doesn't fill up an entire page. */
333 struct output_engine *e = engine_stack_top ();
335 flush_deferred_text (e);
338 llx_for_each (llx, &e->drivers)
340 struct output_driver *d = llx_data (llx);
341 if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
347 output_set_title__ (struct output_engine *e, char **dst, const char *src)
350 *dst = xstrdup_if_nonnull (src);
353 = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
354 : e->title ? xstrdup (e->title)
355 : e->subtitle ? xstrdup (e->subtitle)
357 output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
361 void PRINTF_FORMAT (1, 2)
362 output_log (const char *format, ...)
365 va_start (args, format);
366 char *s = xvasprintf (format, args);
369 output_log_nocopy (s);
373 output_log_nocopy (char *s)
375 output_submit (text_item_create_nocopy (TEXT_ITEM_LOG, s, NULL));
379 output_get_title (void)
381 return engine_stack_top ()->title;
385 output_set_title (const char *title)
387 struct output_engine *e = engine_stack_top ();
389 output_set_title__ (e, &e->title, title);
393 output_get_subtitle (void)
395 return engine_stack_top ()->subtitle;
399 output_set_subtitle (const char *subtitle)
401 struct output_engine *e = engine_stack_top ();
403 output_set_title__ (e, &e->subtitle, subtitle);
407 output_set_filename (const char *filename)
409 struct output_engine *e = engine_stack_top ();
411 string_map_replace (&e->heading_vars, "Filename", filename);
415 output_driver_init (struct output_driver *driver,
416 const struct output_driver_class *class,
417 const char *name, enum settings_output_devices type)
419 driver->class = class;
420 driver->name = xstrdup (name);
421 driver->device_type = type;
425 output_driver_destroy (struct output_driver *driver)
429 char *name = driver->name;
430 if (output_driver_is_registered (driver))
431 output_driver_unregister (driver);
432 if (driver->class->destroy)
433 driver->class->destroy (driver);
439 output_driver_get_name (const struct output_driver *driver)
444 static struct output_engine *
445 output_driver_get_engine (const struct output_driver *driver)
447 struct output_engine *e;
449 ll_for_each (e, struct output_engine, ll, &engine_stack)
451 if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
459 output_driver_register (struct output_driver *driver)
461 struct output_engine *e = engine_stack_top ();
463 assert (!output_driver_is_registered (driver));
464 llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
468 output_driver_unregister (struct output_driver *driver)
470 struct output_engine *e = output_driver_get_engine (driver);
473 llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
478 output_driver_is_registered (const struct output_driver *driver)
480 return output_driver_get_engine (driver) != NULL;
484 output_set_page_setup (const struct page_setup *ps)
486 struct output_engine *e = engine_stack_top ();
489 llx_for_each (llx, &e->drivers)
491 struct output_driver *d = llx_data (llx);
493 d->class->setup (d, ps);
497 extern const struct output_driver_factory csv_driver_factory;
498 extern const struct output_driver_factory html_driver_factory;
499 extern const struct output_driver_factory list_driver_factory;
500 extern const struct output_driver_factory odt_driver_factory;
501 extern const struct output_driver_factory pdf_driver_factory;
502 extern const struct output_driver_factory png_driver_factory;
503 extern const struct output_driver_factory ps_driver_factory;
504 extern const struct output_driver_factory spv_driver_factory;
505 extern const struct output_driver_factory svg_driver_factory;
506 extern const struct output_driver_factory tex_driver_factory;
507 extern const struct output_driver_factory txt_driver_factory;
509 static const struct output_driver_factory *factories[] =
512 &list_driver_factory,
513 &html_driver_factory,
525 static const struct output_driver_factory *
526 find_factory (const char *format)
528 const struct output_driver_factory **fp;
530 for (fp = factories; *fp != NULL; fp++)
532 const struct output_driver_factory *f = *fp;
534 if (!strcmp (f->extension, format))
537 return &txt_driver_factory;
540 static enum settings_output_devices
541 default_device_type (const char *file_name)
543 return (!strcmp (file_name, "-")
544 ? SETTINGS_DEVICE_TERMINAL
545 : SETTINGS_DEVICE_LISTING);
548 struct output_driver *
549 output_driver_create (struct string_map *options)
551 enum settings_output_devices device_type;
552 const struct output_driver_factory *f;
553 struct output_driver *driver;
558 format = string_map_find_and_delete (options, "format");
559 file_name = string_map_find_and_delete (options, "output-file");
563 if (file_name != NULL)
565 const char *extension = strrchr (file_name, '.');
566 format = xstrdup (extension != NULL ? extension + 1 : "");
569 format = xstrdup ("txt");
571 f = find_factory (format);
573 if (file_name == NULL)
574 file_name = xstrdup (f->default_file_name);
576 /* XXX should use parse_enum(). */
577 device_string = string_map_find_and_delete (options, "device");
578 if (device_string == NULL || device_string[0] == '\0')
579 device_type = default_device_type (file_name);
580 else if (!strcmp (device_string, "terminal"))
581 device_type = SETTINGS_DEVICE_TERMINAL;
582 else if (!strcmp (device_string, "listing"))
583 device_type = SETTINGS_DEVICE_LISTING;
586 msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
587 device_string, "terminal", "listing");
588 device_type = default_device_type (file_name);
591 struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
593 driver = f->create (fh, device_type, options);
596 const struct string_map_node *node;
599 STRING_MAP_FOR_EACH_KEY (key, node, options)
600 msg (MW, _("%s: unknown option `%s'"), file_name, key);
602 string_map_clear (options);
606 free (device_string);
612 output_driver_parse_option (const char *option, struct string_map *options)
614 const char *equals = strchr (option, '=');
617 error (0, 0, _("%s: output option missing `='"), option);
621 char *key = xmemdup0 (option, equals - option);
622 if (string_map_contains (options, key))
624 error (0, 0, _("%s: output option specified more than once"), key);
629 char *value = xmemdup0 (equals + 1, strlen (equals + 1));
630 string_map_insert_nocopy (options, key, value);
634 output_driver_substitute_heading_vars (const char *src, int page_number)
636 struct output_engine *e = engine_stack_top ();
637 struct string dst = DS_EMPTY_INITIALIZER;
638 ds_extend (&dst, strlen (src));
639 for (const char *p = src; *p;)
641 if (!strncmp (p, "&[", 6))
643 if (page_number != INT_MIN)
645 const char *start = p + 6;
646 const char *end = strchr (start, ']');
649 const char *value = string_map_find__ (&e->heading_vars,
652 ds_put_cstr (&dst, value);
653 else if (ss_equals (ss_buffer (start, end - start),
655 ds_put_format (&dst, "%d", page_number);
660 ds_put_cstr (&dst, "&");
664 ds_put_byte (&dst, *p++);
666 return ds_steal_cstr (&dst);