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"
29 #include "data/file-handle-def.h"
30 #include "data/settings.h"
31 #include "libpspp/array.h"
32 #include "libpspp/assertion.h"
33 #include "libpspp/i18n.h"
34 #include "libpspp/message.h"
35 #include "libpspp/llx.h"
36 #include "libpspp/string-map.h"
37 #include "libpspp/string-set.h"
38 #include "libpspp/str.h"
39 #include "output/output-item.h"
42 #include "gl/xalloc.h"
43 #include "gl/xmemdup0.h"
46 #define _(msgid) gettext (msgid)
50 struct ll ll; /* Node for this engine. */
51 struct llx_list drivers; /* Contains "struct output_driver"s. */
52 struct output_item *deferred_text; /* Output text being accumulated. */
53 char *command_name; /* Name of command being processed. */
54 char *title, *subtitle; /* Components of page title. */
56 /* Output grouping stack.
58 TEXT_ITEM_GROUP_OPEN pushes a group on the stack and
59 TEXT_ITEM_GROUP_CLOSE pops one off. */
60 char **groups; /* Command names of nested sections. */
62 size_t allocated_groups;
64 struct string_map heading_vars;
67 static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
69 static const struct output_driver_factory *factories[];
71 static struct output_engine *
72 engine_stack_top (void)
74 struct ll *head = ll_head (&engine_stack);
75 if (ll_is_empty (&engine_stack))
77 return ll_data (head, struct output_engine, ll);
81 put_strftime (const char *key, const char *format,
82 const struct tm *tm, struct string_map *vars)
84 if (!string_map_find (vars, key))
87 strftime (value, sizeof value, format, tm);
88 string_map_insert (vars, key, value);
93 output_engine_push (void)
95 struct output_engine *e = xzalloc (sizeof (*e));
97 llx_init (&e->drivers);
99 string_map_init (&e->heading_vars);
101 time_t t = time (NULL);
102 const struct tm *tm = localtime (&t);
103 put_strftime ("Date", "%x", tm, &e->heading_vars);
104 put_strftime ("Time", "%X", tm, &e->heading_vars);
106 ll_push_head (&engine_stack, &e->ll);
110 output_engine_pop (void)
112 struct ll *head = ll_pop_head (&engine_stack);
113 struct output_engine *e = ll_data (head, struct output_engine, ll);
115 struct output_driver *d;
116 llx_for_each_preremove (d, &e->drivers, &llx_malloc_mgr)
117 output_driver_destroy (d);
118 output_item_unref (e->deferred_text);
119 free (e->command_name);
122 for (size_t i = 0; i < e->n_groups; i++)
125 string_map_destroy (&e->heading_vars);
130 output_get_supported_formats (struct string_set *formats)
132 const struct output_driver_factory **fp;
134 for (fp = factories; *fp != NULL; fp++)
135 string_set_insert (formats, (*fp)->extension);
139 output_submit__ (struct output_engine *e, struct output_item *item)
141 struct llx *llx, *next;
142 llx_for_each_safe (llx, next, &e->drivers)
144 struct output_driver *d = llx_data (llx);
146 enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
149 case OUTPUT_ITEM_MESSAGE:
150 type = (item->message->severity == MSG_S_NOTE
151 ? SETTINGS_OUTPUT_NOTE
152 : SETTINGS_OUTPUT_ERROR);
155 case OUTPUT_ITEM_TEXT:
156 if (item->text.subtype == TEXT_ITEM_SYNTAX)
157 type = SETTINGS_OUTPUT_SYNTAX;
160 case OUTPUT_ITEM_CHART:
161 case OUTPUT_ITEM_GROUP_OPEN:
162 case OUTPUT_ITEM_GROUP_CLOSE:
163 case OUTPUT_ITEM_IMAGE:
164 case OUTPUT_ITEM_PAGE_BREAK:
165 case OUTPUT_ITEM_PAGE_SETUP:
166 case OUTPUT_ITEM_TABLE:
170 if (settings_get_output_routing (type) & d->device_type)
171 d->class->submit (d, item);
174 output_item_unref (item);
178 flush_deferred_text (struct output_engine *e)
180 struct output_item *deferred_text = e->deferred_text;
183 e->deferred_text = NULL;
184 output_submit__ (e, deferred_text);
189 defer_text (struct output_engine *e, struct output_item *item)
191 if (item->type != OUTPUT_ITEM_TEXT)
194 if (!e->deferred_text)
195 e->deferred_text = output_item_unshare (item);
196 else if (text_item_append (e->deferred_text, item))
197 output_item_unref (item);
200 flush_deferred_text (e);
201 e->deferred_text = output_item_unshare (item);
206 /* Submits ITEM to the configured output drivers, and transfers ownership to
207 the output subsystem. */
209 output_submit (struct output_item *item)
211 struct output_engine *e = engine_stack_top ();
219 if (defer_text (e, item))
221 flush_deferred_text (e);
225 case OUTPUT_ITEM_GROUP_OPEN:
226 if (e->n_groups >= e->allocated_groups)
227 e->groups = x2nrealloc (e->groups, &e->allocated_groups,
229 e->groups[e->n_groups] = xstrdup_if_nonnull (item->command_name);
233 case OUTPUT_ITEM_GROUP_CLOSE:
234 assert (e->n_groups > 0);
236 size_t idx = --e->n_groups;
237 free (e->groups[idx]);
239 char *key = xasprintf ("Head%zu", idx);
240 free (string_map_find_and_delete (&e->heading_vars, key));
244 case OUTPUT_ITEM_TEXT:
246 enum text_item_subtype st = item->text.subtype;
247 char *key = (st == TEXT_ITEM_TITLE ? xasprintf ("Head%zu", e->n_groups)
248 : st == TEXT_ITEM_PAGE_TITLE ? xstrdup ("PageTitle")
251 string_map_replace_nocopy (&e->heading_vars, key,
252 text_item_get_plain_text (item));
256 case OUTPUT_ITEM_CHART:
257 case OUTPUT_ITEM_IMAGE:
258 case OUTPUT_ITEM_MESSAGE:
259 case OUTPUT_ITEM_PAGE_BREAK:
260 case OUTPUT_ITEM_PAGE_SETUP:
261 case OUTPUT_ITEM_TABLE:
265 output_submit__ (e, item);
268 /* Returns the name of the command currently being parsed, or NULL if no
269 command is being parsed. */
271 output_get_command_name (void)
273 struct output_engine *e = engine_stack_top ();
277 for (size_t i = e->n_groups; i-- > 0;)
285 output_get_uppercase_command_name (void)
287 const char *command_name = output_get_command_name ();
288 return command_name ? utf8_to_upper (command_name) : NULL;
291 /* Flushes output to screen devices, so that the user can see
292 output that doesn't fill up an entire page. */
296 struct output_engine *e = engine_stack_top ();
298 flush_deferred_text (e);
301 llx_for_each (llx, &e->drivers)
303 struct output_driver *d = llx_data (llx);
304 if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
310 output_set_title__ (struct output_engine *e, char **dst, const char *src)
313 *dst = xstrdup_if_nonnull (src);
316 = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
317 : e->title ? xstrdup (e->title)
318 : e->subtitle ? xstrdup (e->subtitle)
320 output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
325 output_set_title (const char *title)
327 struct output_engine *e = engine_stack_top ();
329 output_set_title__ (e, &e->title, title);
333 output_set_subtitle (const char *subtitle)
335 struct output_engine *e = engine_stack_top ();
337 output_set_title__ (e, &e->subtitle, subtitle);
341 output_set_filename (const char *filename)
343 struct output_engine *e = engine_stack_top ();
345 string_map_replace (&e->heading_vars, "Filename", filename);
349 output_get_group_level (void)
351 struct output_engine *e = engine_stack_top ();
357 output_driver_init (struct output_driver *driver,
358 const struct output_driver_class *class,
359 const char *name, enum settings_output_devices type)
361 driver->class = class;
362 driver->name = xstrdup (name);
363 driver->device_type = type;
367 output_driver_destroy (struct output_driver *driver)
371 char *name = driver->name;
372 if (output_driver_is_registered (driver))
373 output_driver_unregister (driver);
374 if (driver->class->destroy)
375 driver->class->destroy (driver);
381 output_driver_get_name (const struct output_driver *driver)
386 static struct output_engine *
387 output_driver_get_engine (const struct output_driver *driver)
389 struct output_engine *e;
391 ll_for_each (e, struct output_engine, ll, &engine_stack)
393 if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
401 output_driver_register (struct output_driver *driver)
403 struct output_engine *e = engine_stack_top ();
405 assert (!output_driver_is_registered (driver));
406 llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
410 output_driver_unregister (struct output_driver *driver)
412 struct output_engine *e = output_driver_get_engine (driver);
415 llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
420 output_driver_is_registered (const struct output_driver *driver)
422 return output_driver_get_engine (driver) != NULL;
425 extern const struct output_driver_factory csv_driver_factory;
426 extern const struct output_driver_factory html_driver_factory;
427 extern const struct output_driver_factory list_driver_factory;
428 extern const struct output_driver_factory odt_driver_factory;
429 extern const struct output_driver_factory pdf_driver_factory;
430 extern const struct output_driver_factory png_driver_factory;
431 extern const struct output_driver_factory ps_driver_factory;
432 extern const struct output_driver_factory spv_driver_factory;
433 extern const struct output_driver_factory svg_driver_factory;
434 extern const struct output_driver_factory tex_driver_factory;
435 extern const struct output_driver_factory txt_driver_factory;
437 static const struct output_driver_factory *factories[] =
440 &list_driver_factory,
441 &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);
562 output_driver_substitute_heading_vars (const char *src, int page_number)
564 struct output_engine *e = engine_stack_top ();
565 struct string dst = DS_EMPTY_INITIALIZER;
566 ds_extend (&dst, strlen (src));
567 for (const char *p = src; *p;)
569 if (!strncmp (p, "&[", 6))
571 if (page_number != INT_MIN)
573 const char *start = p + 6;
574 const char *end = strchr (start, ']');
577 const char *value = string_map_find__ (&e->heading_vars,
580 ds_put_cstr (&dst, value);
581 else if (ss_equals (ss_buffer (start, end - start),
583 ds_put_format (&dst, "%d", page_number);
588 ds_put_cstr (&dst, "&");
592 ds_put_byte (&dst, *p++);
594 return ds_steal_cstr (&dst);