X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fdriver.c;h=067bf831ae7d988388743a30d836b2932e0e9de2;hb=300d3db698d3ac82a0a302a91ee62bcaad6337b6;hp=c0a525edae2f4963c3b34067c8c8f474b5b1a017;hpb=5d8fa2ae8c6e7d890570585aedec66bd51630814;p=pspp diff --git a/src/output/driver.c b/src/output/driver.c index c0a525edae..067bf831ae 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, 2011 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 @@ -21,19 +21,24 @@ #include #include +#include +#include #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/group-item.h" #include "output/message-item.h" #include "output/output-item.h" #include "output/text-item.h" @@ -45,22 +50,89 @@ #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 string deferred_text; /* Output text being accumulated. */ + enum text_item_type deferred_type; /* Type of 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 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_engine_push (void) +{ + struct output_engine *e = xzalloc (sizeof (*e)); + + llx_init (&e->drivers); + ds_init_empty (&e->deferred_text); -/* TEXT_ITEM_SYNTAX being accumulated until another kind of output arrives. */ -static struct string deferred_syntax = DS_EMPTY_INITIALIZER; + 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_close (void) +output_engine_pop (void) { - while (!llx_is_empty (&drivers)) + 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); } + ds_destroy (&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,11 +145,11 @@ 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; @@ -106,21 +178,43 @@ output_submit__ (struct output_item *item) } static void -flush_deferred_syntax (void) +flush_deferred_text (struct output_engine *e) { - if (!ds_is_empty (&deferred_syntax)) + if (!ds_is_empty (&e->deferred_text)) { - char *syntax = ds_steal_cstr (&deferred_syntax); - output_submit__ (text_item_super ( - text_item_create_nocopy (TEXT_ITEM_SYNTAX, syntax))); + char *text = ds_steal_cstr (&e->deferred_text); + output_submit__ (e, text_item_super (text_item_create_nocopy ( + e->deferred_type, text))); } } static bool -is_syntax_item (const struct output_item *item) +defer_text (struct output_engine *e, struct output_item *item) { - return (is_text_item (item) - && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX); + if (!is_text_item (item)) + return false; + + struct text_item *text_item = to_text_item (item); + if (text_item->markup) /* XXX */ + return false; + + enum text_item_type type = text_item_get_type (text_item); + if (type != TEXT_ITEM_SYNTAX && type != TEXT_ITEM_LOG) + return false; + + if (!ds_is_empty (&e->deferred_text) && e->deferred_type != type) + flush_deferred_text (e); + + e->deferred_type = type; + + if (!ds_is_empty (&e->deferred_text)) + ds_put_byte (&e->deferred_text, '\n'); + + const char *text = text_item_get_text (text_item); + ds_put_cstr (&e->deferred_text, text); + output_item_unref (item); + + return true; } /* Submits ITEM to the configured output drivers, and transfers ownership to @@ -128,15 +222,78 @@ is_syntax_item (const struct output_item *item) void output_submit (struct output_item *item) { - if (is_syntax_item (item)) + struct output_engine *e = engine_stack_top (); + + if (e == NULL) + return; + + if (item == NULL) + return; + + if (defer_text (e, item)) + return; + flush_deferred_text (e); + + if (is_group_open_item (item)) { - ds_put_cstr (&deferred_syntax, text_item_get_text (to_text_item (item))); - output_item_unref (item); - return; + const struct group_open_item *group_open_item + = to_group_open_item (item); + if (e->n_groups >= e->allocated_groups) + e->groups = x2nrealloc (e->groups, &e->allocated_groups, + sizeof *e->groups); + e->groups[e->n_groups] = (group_open_item->command_name + ? xstrdup (group_open_item->command_name) + : NULL); + e->n_groups++; + } + else if (is_group_close_item (item)) + { + assert (e->n_groups > 0); + + size_t idx = --e->n_groups; + free (e->groups[idx]); + if (idx >= 1 && idx <= 4) + { + char *key = xasprintf ("Head%zu", idx); + free (string_map_find_and_delete (&e->heading_vars, key)); + free (key); + } + } + else if (is_text_item (item)) + { + const struct text_item *text_item = to_text_item (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_TITLE + && e->n_groups >= 1 && e->n_groups <= 4) + { + char *key = xasprintf ("Head%zu", e->n_groups); + string_map_replace (&e->heading_vars, key, text); + free (key); + } + else if (type == TEXT_ITEM_PAGE_TITLE) + string_map_replace (&e->heading_vars, "PageTitle", text); } - flush_deferred_syntax (); - output_submit__ (item); + output_submit__ (e, item); +} + +/* Returns the name of the command currently being parsed, in all uppercase. + The caller must free the returned value. + + Returns NULL if no command is being parsed. */ +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 utf8_to_upper (e->groups[i]); + + return NULL; } /* Flushes output to screen devices, so that the user can see @@ -144,10 +301,11 @@ output_submit (struct output_item *item) void output_flush (void) { + struct output_engine *e = engine_stack_top (); struct llx *llx; - flush_deferred_syntax (); - 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); @@ -155,6 +313,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 = src ? xstrdup (src) : NULL; + + 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)); + text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE, + page_title)); +} + +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, @@ -186,63 +391,57 @@ 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; -} - -/* 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; - } - } + return output_driver_get_engine (driver) != 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 html_driver_factory; extern const struct output_driver_factory csv_driver_factory; -#ifdef ODT_SUPPORT extern const struct output_driver_factory odt_driver_factory; -#endif +extern const struct output_driver_factory spv_driver_factory; #ifdef HAVE_CAIRO extern const struct output_driver_factory pdf_driver_factory; extern const struct output_driver_factory ps_driver_factory; extern const struct output_driver_factory svg_driver_factory; #endif +extern const struct output_driver_factory tex_driver_factory; static const struct output_driver_factory *factories[] = { @@ -250,14 +449,14 @@ static const struct output_driver_factory *factories[] = &list_driver_factory, &html_driver_factory, &csv_driver_factory, -#ifdef ODT_SUPPORT &odt_driver_factory, -#endif + &spv_driver_factory, #ifdef HAVE_CAIRO &pdf_driver_factory, &ps_driver_factory, &svg_driver_factory, #endif + &tex_driver_factory, NULL }; @@ -294,16 +493,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"); @@ -315,21 +521,21 @@ output_driver_create (struct string_map *options) device_type = SETTINGS_DEVICE_LISTING; else { - /* TRANSLATORS: Don't translate the words `terminal' or `listing'. */ - 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); @@ -339,3 +545,85 @@ 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); +} + +/* Extracts the actual text content from the given Pango MARKUP and returns it + as as a malloc()'d string. */ +char * +output_get_text_from_markup (const char *markup) +{ + xmlParserCtxt *parser = xmlCreatePushParserCtxt (NULL, NULL, NULL, 0, NULL); + if (!parser) + return xstrdup (markup); + + xmlParseChunk (parser, "", strlen (""), false); + xmlParseChunk (parser, markup, strlen (markup), false); + xmlParseChunk (parser, "", strlen (""), true); + + char *content + = (parser->wellFormed + ? CHAR_CAST (char *, + xmlNodeGetContent (xmlDocGetRootElement (parser->myDoc))) + : xstrdup (markup)); + xmlFreeDoc (parser->myDoc); + xmlFreeParserCtxt (parser); + + return content; +} + +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); +}