X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fdriver.c;h=6f5d4633ce015e754deddb8c34480ae4af451bf3;hb=188de2a0766e6116c4534eb766441d8f0b10653d;hp=203644584f162eade6f30663c26ffaa81625d58d;hpb=ddb7b52128d8f1f54d9632dc3a15c7869e0fbcce;p=pspp diff --git a/src/output/driver.c b/src/output/driver.c index 203644584f..6f5d4633ce 100644 --- a/src/output/driver.c +++ b/src/output/driver.c @@ -1,5 +1,5 @@ /* PSPP - a program for statistical analysis. - Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc. + Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014, 2019 Free Software Foundation, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -24,19 +24,19 @@ #include #include #include +#include -#include "data/file-name.h" +#include "data/file-handle-def.h" #include "data/settings.h" #include "libpspp/array.h" #include "libpspp/assertion.h" +#include "libpspp/i18n.h" #include "libpspp/message.h" #include "libpspp/llx.h" #include "libpspp/string-map.h" #include "libpspp/string-set.h" #include "libpspp/str.h" -#include "output/message-item.h" #include "output/output-item.h" -#include "output/text-item.h" #include "gl/error.h" #include "gl/xalloc.h" @@ -45,22 +45,87 @@ #include "gettext.h" #define _(msgid) gettext (msgid) +struct output_engine + { + struct ll ll; /* Node for this engine. */ + struct llx_list drivers; /* Contains "struct output_driver"s. */ + struct output_item *deferred_text; /* Output text being accumulated. */ + char *command_name; /* Name of command being processed. */ + char *title, *subtitle; /* Components of page title. */ + + /* Output grouping stack. + + TEXT_ITEM_GROUP_OPEN pushes a group on the stack and + TEXT_ITEM_GROUP_CLOSE pops one off. */ + char **groups; /* Command names of nested sections. */ + size_t n_groups; + size_t allocated_groups; + + struct string_map heading_vars; + }; + +static struct ll_list engine_stack = LL_INITIALIZER (engine_stack); + static const struct output_driver_factory *factories[]; -/* Drivers currently registered with output_driver_register(). */ -static struct llx_list drivers = LLX_INITIALIZER (drivers); +static struct output_engine * +engine_stack_top (void) +{ + struct ll *head = ll_head (&engine_stack); + if (ll_is_empty (&engine_stack)) + return NULL; + return ll_data (head, struct output_engine, ll); +} -static struct output_item *deferred_syntax; -static bool in_command; +static void +put_strftime (const char *key, const char *format, + const struct tm *tm, struct string_map *vars) +{ + if (!string_map_find (vars, key)) + { + char value[128]; + strftime (value, sizeof value, format, tm); + string_map_insert (vars, key, value); + } +} void -output_close (void) +output_engine_push (void) { - while (!llx_is_empty (&drivers)) + struct output_engine *e = xzalloc (sizeof (*e)); + + llx_init (&e->drivers); + + string_map_init (&e->heading_vars); + + time_t t = time (NULL); + const struct tm *tm = localtime (&t); + put_strftime ("Date", "%x", tm, &e->heading_vars); + put_strftime ("Time", "%X", tm, &e->heading_vars); + + ll_push_head (&engine_stack, &e->ll); +} + +void +output_engine_pop (void) +{ + struct ll *head = ll_pop_head (&engine_stack); + struct output_engine *e =ll_data (head, struct output_engine, ll); + + while (!llx_is_empty (&e->drivers)) { - struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr); + struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr); output_driver_destroy (d); } + output_item_unref (e->deferred_text); + free (e->command_name); + free (e->title); + free (e->subtitle); + for (size_t i = 0; i < e->n_groups; i++) + free (e->groups[i]); + free (e->groups); + string_map_destroy (&e->heading_vars); + free (e); } void @@ -73,30 +138,39 @@ output_get_supported_formats (struct string_set *formats) } static void -output_submit__ (struct output_item *item) +output_submit__ (struct output_engine *e, struct output_item *item) { struct llx *llx, *next; - for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next) + for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next) { struct output_driver *d = llx_data (llx); - enum settings_output_type type; next = llx_next (llx); - if (is_message_item (item)) + enum settings_output_type type = SETTINGS_OUTPUT_RESULT; + switch (item->type) { - const struct msg *m = message_item_get_msg (to_message_item (item)); - if (m->severity == MSG_S_NOTE) - type = SETTINGS_OUTPUT_NOTE; - else - type = SETTINGS_OUTPUT_ERROR; + case OUTPUT_ITEM_MESSAGE: + type = (item->message->severity == MSG_S_NOTE + ? SETTINGS_OUTPUT_NOTE + : SETTINGS_OUTPUT_ERROR); + break; + + case OUTPUT_ITEM_TEXT: + if (item->text.subtype == TEXT_ITEM_SYNTAX) + type = SETTINGS_OUTPUT_SYNTAX; + break; + + case OUTPUT_ITEM_CHART: + case OUTPUT_ITEM_GROUP_OPEN: + case OUTPUT_ITEM_GROUP_CLOSE: + case OUTPUT_ITEM_IMAGE: + case OUTPUT_ITEM_PAGE_BREAK: + case OUTPUT_ITEM_PAGE_SETUP: + case OUTPUT_ITEM_TABLE: + break; } - else if (is_text_item (item) - && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX) - type = SETTINGS_OUTPUT_SYNTAX; - else - type = SETTINGS_OUTPUT_RESULT; if (settings_get_output_routing (type) & d->device_type) d->class->submit (d, item); @@ -106,50 +180,117 @@ output_submit__ (struct output_item *item) } static void -flush_deferred_syntax (void) +flush_deferred_text (struct output_engine *e) { - if (deferred_syntax != NULL) + struct output_item *deferred_text = e->deferred_text; + if (deferred_text) { - output_submit__ (deferred_syntax); - deferred_syntax = NULL; + e->deferred_text = NULL; + output_submit__ (e, deferred_text); } } +static bool +defer_text (struct output_engine *e, struct output_item *item) +{ + if (item->type != OUTPUT_ITEM_TEXT) + return false; + + if (!e->deferred_text) + e->deferred_text = output_item_unshare (item); + else if (text_item_append (e->deferred_text, item)) + output_item_unref (item); + else + { + flush_deferred_text (e); + e->deferred_text = output_item_unshare (item); + } + return true; +} + /* Submits ITEM to the configured output drivers, and transfers ownership to the output subsystem. */ void output_submit (struct output_item *item) { - if (is_text_item (item)) - { - struct text_item *text = to_text_item (item); - switch (text_item_get_type (text)) - { - case TEXT_ITEM_SYNTAX: - if (!in_command) - { - flush_deferred_syntax (); - deferred_syntax = item; - return; - } - break; + struct output_engine *e = engine_stack_top (); - case TEXT_ITEM_COMMAND_OPEN: - output_submit__ (item); - flush_deferred_syntax (); - in_command = true; - return; + if (e == NULL) + return; - case TEXT_ITEM_COMMAND_CLOSE: - in_command = false; - break; + if (item == NULL) + return; - default: - break; - } + if (defer_text (e, item)) + return; + flush_deferred_text (e); + + switch (item->type) + { + case OUTPUT_ITEM_GROUP_OPEN: + if (e->n_groups >= e->allocated_groups) + e->groups = x2nrealloc (e->groups, &e->allocated_groups, + sizeof *e->groups); + e->groups[e->n_groups] = xstrdup_if_nonnull (item->command_name); + e->n_groups++; + break; + + case OUTPUT_ITEM_GROUP_CLOSE: + assert (e->n_groups > 0); + + size_t idx = --e->n_groups; + free (e->groups[idx]); + + char *key = xasprintf ("Head%zu", idx); + free (string_map_find_and_delete (&e->heading_vars, key)); + free (key); + break; + + case OUTPUT_ITEM_TEXT: + { + enum text_item_subtype st = item->text.subtype; + char *key = (st == TEXT_ITEM_TITLE ? xasprintf ("Head%zu", e->n_groups) + : st == TEXT_ITEM_PAGE_TITLE ? xstrdup ("PageTitle") + : NULL); + if (key) + string_map_replace_nocopy (&e->heading_vars, key, + text_item_get_plain_text (item)); + } + break; + + case OUTPUT_ITEM_CHART: + case OUTPUT_ITEM_IMAGE: + case OUTPUT_ITEM_MESSAGE: + case OUTPUT_ITEM_PAGE_BREAK: + case OUTPUT_ITEM_PAGE_SETUP: + case OUTPUT_ITEM_TABLE: + break; } - output_submit__ (item); + output_submit__ (e, item); +} + +/* Returns the name of the command currently being parsed, or NULL if no + command is being parsed. */ +const char * +output_get_command_name (void) +{ + struct output_engine *e = engine_stack_top (); + if (e == NULL) + return NULL; + + for (size_t i = e->n_groups; i-- > 0;) + if (e->groups[i]) + return e->groups[i]; + + return NULL; +} + +char * +output_get_uppercase_command_name (void) +{ + const char *command_name = output_get_command_name (); + return command_name ? utf8_to_upper (command_name) : NULL; } /* Flushes output to screen devices, so that the user can see @@ -157,9 +298,11 @@ output_submit (struct output_item *item) void output_flush (void) { + struct output_engine *e = engine_stack_top (); struct llx *llx; - for (llx = llx_head (&drivers); llx != llx_null (&drivers); + flush_deferred_text (e); + for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = llx_next (llx)) { struct output_driver *d = llx_data (llx); @@ -167,6 +310,53 @@ output_flush (void) d->class->flush (d); } } + +static void +output_set_title__ (struct output_engine *e, char **dst, const char *src) +{ + free (*dst); + *dst = xstrdup_if_nonnull (src); + + char *page_title + = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle) + : e->title ? xstrdup (e->title) + : e->subtitle ? xstrdup (e->subtitle) + : xzalloc (1)); + output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE, + page_title, NULL)); +} + +void +output_set_title (const char *title) +{ + struct output_engine *e = engine_stack_top (); + + output_set_title__ (e, &e->title, title); +} + +void +output_set_subtitle (const char *subtitle) +{ + struct output_engine *e = engine_stack_top (); + + output_set_title__ (e, &e->subtitle, subtitle); +} + +void +output_set_filename (const char *filename) +{ + struct output_engine *e = engine_stack_top (); + + string_map_replace (&e->heading_vars, "Filename", filename); +} + +size_t +output_get_group_level (void) +{ + struct output_engine *e = engine_stack_top (); + + return e->n_groups; +} void output_driver_init (struct output_driver *driver, @@ -198,74 +388,70 @@ output_driver_get_name (const struct output_driver *driver) return driver->name; } +static struct output_engine * +output_driver_get_engine (const struct output_driver *driver) +{ + struct output_engine *e; + + ll_for_each (e, struct output_engine, ll, &engine_stack) + { + if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver)) + return e; + } + + return NULL; +} + void output_driver_register (struct output_driver *driver) { + struct output_engine *e = engine_stack_top (); + assert (!output_driver_is_registered (driver)); - llx_push_tail (&drivers, driver, &llx_malloc_mgr); + llx_push_tail (&e->drivers, driver, &llx_malloc_mgr); } void output_driver_unregister (struct output_driver *driver) { - llx_remove (llx_find (llx_head (&drivers), llx_null (&drivers), driver), + struct output_engine *e = output_driver_get_engine (driver); + + assert (e != NULL); + llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver), &llx_malloc_mgr); } bool output_driver_is_registered (const struct output_driver *driver) { - return llx_find (llx_head (&drivers), llx_null (&drivers), driver) != NULL; + return output_driver_get_engine (driver) != NULL; } -/* Useful functions for output driver implementation. */ - -void -output_driver_track_current_command (const struct output_item *output_item, - char **command_namep) -{ - if (is_text_item (output_item)) - { - const struct text_item *item = to_text_item (output_item); - const char *text = text_item_get_text (item); - enum text_item_type type = text_item_get_type (item); - - if (type == TEXT_ITEM_COMMAND_OPEN) - { - free (*command_namep); - *command_namep = xstrdup (text); - } - else if (type == TEXT_ITEM_COMMAND_CLOSE) - { - free (*command_namep); - *command_namep = NULL; - } - } -} - -extern const struct output_driver_factory txt_driver_factory; -extern const struct output_driver_factory list_driver_factory; +extern const struct output_driver_factory csv_driver_factory; extern const struct output_driver_factory html_driver_factory; +extern const struct output_driver_factory list_driver_factory; extern const struct output_driver_factory odt_driver_factory; -extern const struct output_driver_factory csv_driver_factory; -#ifdef HAVE_CAIRO extern const struct output_driver_factory pdf_driver_factory; +extern const struct output_driver_factory png_driver_factory; extern const struct output_driver_factory ps_driver_factory; +extern const struct output_driver_factory spv_driver_factory; extern const struct output_driver_factory svg_driver_factory; -#endif +extern const struct output_driver_factory tex_driver_factory; +extern const struct output_driver_factory txt_driver_factory; static const struct output_driver_factory *factories[] = { &txt_driver_factory, &list_driver_factory, &html_driver_factory, - &odt_driver_factory, &csv_driver_factory, -#ifdef HAVE_CAIRO + &odt_driver_factory, + &spv_driver_factory, &pdf_driver_factory, &ps_driver_factory, &svg_driver_factory, -#endif + &png_driver_factory, + &tex_driver_factory, NULL }; @@ -302,16 +488,23 @@ output_driver_create (struct string_map *options) char *file_name; char *format; + format = string_map_find_and_delete (options, "format"); file_name = string_map_find_and_delete (options, "output-file"); - if (file_name == NULL) - file_name = xstrdup ("-"); - format = string_map_find_and_delete (options, "format"); if (format == NULL) { - const char *extension = strrchr (file_name, '.'); - format = xstrdup (extension != NULL ? extension + 1 : ""); + if (file_name != NULL) + { + const char *extension = strrchr (file_name, '.'); + format = xstrdup (extension != NULL ? extension + 1 : ""); + } + else + format = xstrdup ("txt"); } + f = find_factory (format); + + if (file_name == NULL) + file_name = xstrdup (f->default_file_name); /* XXX should use parse_enum(). */ device_string = string_map_find_and_delete (options, "device"); @@ -323,20 +516,21 @@ output_driver_create (struct string_map *options) device_type = SETTINGS_DEVICE_LISTING; else { - error (0, 0, _("%s is not a valid device type (the choices are " - "\"terminal\" and \"listing\")"), device_string); + msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"), + device_string, "terminal", "listing"); device_type = default_device_type (file_name); } - f = find_factory (format); - driver = f->create (file_name, device_type, options); + struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ()); + + driver = f->create (fh, device_type, options); if (driver != NULL) { const struct string_map_node *node; const char *key; STRING_MAP_FOR_EACH_KEY (key, node, options) - error (0, 0, _("%s: unknown option \"%s\""), file_name, key); + msg (MW, _("%s: unknown option `%s'"), file_name, key); } string_map_clear (options); @@ -346,3 +540,61 @@ output_driver_create (struct string_map *options) return driver; } + +void +output_driver_parse_option (const char *option, struct string_map *options) +{ + const char *equals = strchr (option, '='); + if (equals == NULL) + { + error (0, 0, _("%s: output option missing `='"), option); + return; + } + + char *key = xmemdup0 (option, equals - option); + if (string_map_contains (options, key)) + { + error (0, 0, _("%s: output option specified more than once"), key); + free (key); + return; + } + + char *value = xmemdup0 (equals + 1, strlen (equals + 1)); + string_map_insert_nocopy (options, key, value); +} + +char * +output_driver_substitute_heading_vars (const char *src, int page_number) +{ + struct output_engine *e = engine_stack_top (); + struct string dst = DS_EMPTY_INITIALIZER; + ds_extend (&dst, strlen (src)); + for (const char *p = src; *p;) + { + if (!strncmp (p, "&[", 6)) + { + if (page_number != INT_MIN) + { + const char *start = p + 6; + const char *end = strchr (start, ']'); + if (end) + { + const char *value = string_map_find__ (&e->heading_vars, + start, end - start); + if (value) + ds_put_cstr (&dst, value); + else if (ss_equals (ss_buffer (start, end - start), + ss_cstr ("Page"))) + ds_put_format (&dst, "%d", page_number); + p = end + 1; + continue; + } + } + ds_put_cstr (&dst, "&"); + p += 5; + } + else + ds_put_byte (&dst, *p++); + } + return ds_steal_cstr (&dst); +}