/* PSPP - a program for statistical analysis.
- Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014 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
#include <ctype.h>
#include <errno.h>
-#include <libxml/parser.h>
-#include <libxml/tree.h>
#include <limits.h>
+#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <time.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"
#include "gl/error.h"
#include "gl/xalloc.h"
#include "gl/xmemdup0.h"
+#include "gl/xvasprintf.h"
#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_syntax; /* TEXT_ITEM_SYNTAX being accumulated. */
+ 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. */
+ /* Output grouping stack. */
+ struct output_item **groups;
size_t n_groups;
size_t allocated_groups;
struct string_map heading_vars;
};
-static const struct output_driver_factory *factories[];
+static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
-/* A stack of output engines.. */
-static struct output_engine *engine_stack;
-static size_t n_stack, allocated_stack;
+static const struct output_driver_factory *factories[];
static struct output_engine *
engine_stack_top (void)
{
- assert (n_stack > 0);
- return &engine_stack[n_stack - 1];
+ 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
void
output_engine_push (void)
{
- struct output_engine *e;
-
- if (n_stack >= allocated_stack)
- engine_stack = x2nrealloc (engine_stack, &allocated_stack,
- sizeof *engine_stack);
+ struct output_engine *e = XZALLOC (struct output_engine);
- e = &engine_stack[n_stack++];
- memset (e, 0, sizeof *e);
llx_init (&e->drivers);
- ds_init_empty (&e->deferred_syntax);
string_map_init (&e->heading_vars);
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 output_engine *e;
+ struct ll *head = ll_pop_head (&engine_stack);
+ struct output_engine *e = ll_data (head, struct output_engine, ll);
- assert (n_stack > 0);
- e = &engine_stack[--n_stack];
- while (!llx_is_empty (&e->drivers))
- {
- struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
- output_driver_destroy (d);
- }
- ds_destroy (&e->deferred_syntax);
+ struct output_driver *d;
+ llx_for_each_preremove (d, &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]);
+ if (e->n_groups)
+ output_item_unref (e->groups[0]);
free (e->groups);
string_map_destroy (&e->heading_vars);
+ free (e);
}
void
string_set_insert (formats, (*fp)->extension);
}
-static void
-output_submit__ (struct output_engine *e, struct output_item *item)
+static bool
+output_driver_should_show (const struct output_driver *d,
+ const struct output_item *item)
{
- struct llx *llx, *next;
-
- for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
+ enum settings_output_type type = SETTINGS_OUTPUT_RESULT;
+ switch (item->type)
{
- struct output_driver *d = llx_data (llx);
- enum settings_output_type type;
+ 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:
+ case OUTPUT_ITEM_IMAGE:
+ case OUTPUT_ITEM_PAGE_BREAK:
+ case OUTPUT_ITEM_TABLE:
+ break;
+ }
- next = llx_next (llx);
+ return (settings_get_output_routing (type) & d->device_type) != 0;
+}
- if (is_message_item (item))
+/* Adds to OUT the subset of IN that driver D should show, considering routing
+ and visibility of each item, and flattening groups for drivers that don't
+ handle them internally. */
+static void
+make_driver_output_subset (const struct output_item *in,
+ const struct output_driver *d,
+ struct output_item *out)
+{
+ if (in->type == OUTPUT_ITEM_GROUP)
+ {
+ /* If we should include the group itself, then clone IN inside OUT, and
+ add any children to the clone instead to OUT directly. */
+ if (output_driver_should_show (d, in) && d->class->handles_groups)
{
- 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;
+ struct output_item *group = group_item_clone_empty (in);
+ group_item_add_child (out, group);
+ out = group;
}
- 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);
+ for (size_t i = 0; i < in->group.n_children; i++)
+ make_driver_output_subset (in->group.children[i], d, out);
+ }
+ else
+ {
+ if (output_driver_should_show (d, in)
+ && (in->show || d->class->handles_show))
+ group_item_add_child (out, output_item_ref (in));
+ }
+}
+
+static void
+output_submit__ (struct output_engine *e, struct output_item *item)
+{
+ if (e->n_groups > 0)
+ {
+ group_item_add_child (e->groups[e->n_groups - 1], item);
+ return;
+ }
+
+ struct llx *llx, *next;
+ llx_for_each_safe (llx, next, &e->drivers)
+ {
+ struct output_driver *d = llx_data (llx);
+
+ struct output_item *root = root_item_create ();
+ make_driver_output_subset (item, d, root);
+ for (size_t i = 0; i < root->group.n_children; i++)
+ d->class->submit (d, root->group.children[i]);
+ output_item_unref (root);
}
output_item_unref (item);
}
static void
-flush_deferred_syntax (struct output_engine *e)
+flush_deferred_text (struct output_engine *e)
{
- if (!ds_is_empty (&e->deferred_syntax))
+ struct output_item *deferred_text = e->deferred_text;
+ if (deferred_text)
{
- ds_trim (&e->deferred_syntax, ss_cstr ("\n"));
- if (!ds_is_empty (&e->deferred_syntax))
- {
- char *syntax = ds_steal_cstr (&e->deferred_syntax);
- output_submit__ (e, text_item_super (text_item_create_nocopy (
- TEXT_ITEM_SYNTAX, syntax)));
- }
+ e->deferred_text = NULL;
+ output_submit__ (e, deferred_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 (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
{
struct output_engine *e = engine_stack_top ();
- if (item == NULL)
+ if (e == NULL)
return;
- if (is_syntax_item (item))
- {
- ds_put_cstr (&e->deferred_syntax, text_item_get_text (to_text_item (item)));
- output_item_unref (item);
- return;
- }
-
- flush_deferred_syntax (e);
+ if (item == NULL)
+ return;
- if (is_group_open_item (item))
- {
- 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);
+ if (defer_text (e, item))
+ return;
+ flush_deferred_text (e);
- size_t idx = --e->n_groups;
- free (e->groups[idx]);
- if (idx >= 1 && idx <= 4)
- {
- char *key = xasprintf ("Head%zu", idx);
- 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);
- }
+ /* XXX heading_vars */
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)
{
- if (n_stack)
- {
- struct output_engine *e = engine_stack_top ();
- for (size_t i = e->n_groups; i-- > 0; )
- if (e->groups[i])
- return e->groups[i];
- }
+ 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]->command_name)
+ return e->groups[i]->command_name;
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;
+}
+
+size_t
+output_open_group (struct output_item *item)
+{
+ struct output_engine *e = engine_stack_top ();
+ if (e == NULL)
+ return 0;
+
+ if (e->n_groups >= e->allocated_groups)
+ e->groups = x2nrealloc (e->groups, &e->allocated_groups,
+ sizeof *e->groups);
+ e->groups[e->n_groups++] = item;
+ if (e->n_groups > 1)
+ group_item_add_child (e->groups[e->n_groups - 2], item);
+
+ return e->n_groups - 1;
+}
+
+void
+output_close_groups (size_t nesting_level)
+{
+ struct output_engine *e = engine_stack_top ();
+ if (e == NULL)
+ return;
+
+ while (e->n_groups > nesting_level)
+ {
+ flush_deferred_text (e);
+
+ struct output_item *group = e->groups[--e->n_groups];
+ if (e->n_groups == 0)
+ output_submit__ (e, group);
+ }
+}
+
/* Flushes output to screen devices, so that the user can see
output that doesn't fill up an entire page. */
void
output_flush (void)
{
struct output_engine *e = engine_stack_top ();
- struct llx *llx;
- flush_deferred_syntax (e);
- for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
- llx = llx_next (llx))
+ flush_deferred_text (e);
+
+ struct llx *llx;
+ llx_for_each (llx, &e->drivers)
{
struct output_driver *d = llx_data (llx);
if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
output_set_title__ (struct output_engine *e, char **dst, const char *src)
{
free (*dst);
- *dst = src ? xstrdup (src) : NULL;
+ *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));
- text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
- page_title));
+ output_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
+ page_title, NULL));
+}
+
+void PRINTF_FORMAT (1, 2)
+output_log (const char *format, ...)
+{
+ va_list args;
+ va_start (args, format);
+ char *s = xvasprintf (format, args);
+ va_end (args);
+
+ output_submit (text_item_create_nocopy (TEXT_ITEM_LOG, s, NULL));
+}
+
+const char *
+output_get_title (void)
+{
+ return engine_stack_top ()->title;
}
void
output_set_title__ (e, &e->title, title);
}
+const char *
+output_get_subtitle (void)
+{
+ return engine_stack_top ()->subtitle;
+}
+
void
output_set_subtitle (const char *subtitle)
{
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;
-}
\f
void
output_driver_init (struct output_driver *driver,
{
struct output_engine *e;
- for (e = engine_stack; e < &engine_stack[n_stack]; e++)
- if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
- return 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;
}
{
return output_driver_get_engine (driver) != NULL;
}
+
+void
+output_set_page_setup (const struct page_setup *ps)
+{
+ struct output_engine *e = engine_stack_top ();
+
+ struct llx *llx;
+ llx_for_each (llx, &e->drivers)
+ {
+ struct output_driver *d = llx_data (llx);
+ if (d->class->setup)
+ d->class->setup (d, ps);
+ }
+}
\f
-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;
+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;
-#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[] =
{
&html_driver_factory,
&csv_driver_factory,
&odt_driver_factory,
-#ifdef HAVE_CAIRO
+ &spv_driver_factory,
&pdf_driver_factory,
&ps_driver_factory,
&svg_driver_factory,
-#endif
+ &png_driver_factory,
+ &tex_driver_factory,
NULL
};
string_map_insert_nocopy (options, key, value);
}
\f
-/* 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, "<xml>", strlen ("<xml>"), false);
- xmlParseChunk (parser, markup, strlen (markup), false);
- xmlParseChunk (parser, "</xml>", strlen ("</xml>"), 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; )
+ for (const char *p = src; *p;)
{
if (!strncmp (p, "&[", 6))
{
projects / pspp / blobdiff