/* 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 <limits.h>
#include <stdlib.h>
#include <string.h>
+#include <time.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"
#include "gl/error.h"
#include "gl/xalloc.h"
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. */
char **groups; /* Command names of nested sections. */
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
+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;
-
- if (n_stack >= allocated_stack)
- engine_stack = x2nrealloc (engine_stack, &allocated_stack,
- sizeof *engine_stack);
+ struct output_engine *e = xzalloc (sizeof (*e));
- e = &engine_stack[n_stack++];
- memset (e, 0, sizeof *e);
llx_init (&e->drivers);
- ds_init_empty (&e->deferred_syntax);
- e->title = NULL;
- e->subtitle = NULL;
+
+ 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 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);
+ 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
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);
}
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;
- }
+ if (item == NULL)
+ return;
- flush_deferred_syntax (e);
+ if (defer_text (e, item))
+ return;
+ flush_deferred_text (e);
- if (is_group_open_item (item))
+ switch (item->type)
{
- const struct group_open_item *group_open_item
- = to_group_open_item (item);
+ 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] = (group_open_item->command_name
- ? xstrdup (group_open_item->command_name)
- : NULL);
+ e->groups[e->n_groups] = xstrdup_if_nonnull (item->command_name);
e->n_groups++;
- }
- else if (is_group_close_item (item))
- {
+ 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__ (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])
+ 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
output that doesn't fill up an entire page. */
void
struct output_engine *e = engine_stack_top ();
struct llx *llx;
- flush_deferred_syntax (e);
+ flush_deferred_text (e);
for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
llx = llx_next (llx))
{
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
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;
- 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;
}
\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
};
char *value = xmemdup0 (equals + 1, strlen (equals + 1));
string_map_insert_nocopy (options, key, value);
}
+\f
+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);
+}
projects / pspp / blobdiff