pintos-os.org Git - pspp/blob - src/output/driver.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2014, 2019 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #include <config.h>
  18
  19 #include "output/driver.h"
  20 #include "output/driver-provider.h"
  21
  22 #include <ctype.h>
  23 #include <errno.h>
  24 #include <limits.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <time.h>
  28
  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/group-item.h"
  40 #include "output/message-item.h"
  41 #include "output/output-item.h"
  42 #include "output/text-item.h"
  43
  44 #include "gl/error.h"
  45 #include "gl/xalloc.h"
  46 #include "gl/xmemdup0.h"
  47
  48 #include "gettext.h"
  49 #define _(msgid) gettext (msgid)
  50
  51 struct output_engine
  52   {
  53     struct ll ll;                  /* Node for this engine. */
  54     struct llx_list drivers;       /* Contains "struct output_driver"s. */
  55     struct text_item *deferred_text;   /* Output text being accumulated. */
  56     char *command_name;            /* Name of command being processed. */
  57     char *title, *subtitle;        /* Components of page title. */
  58
  59     /* Output grouping stack.
  60
  61        TEXT_ITEM_GROUP_OPEN pushes a group on the stack and
  62        TEXT_ITEM_GROUP_CLOSE pops one off. */
  63     char **groups;               /* Command names of nested sections. */
  64     size_t n_groups;
  65     size_t allocated_groups;
  66
  67     struct string_map heading_vars;
  68   };
  69
  70 static struct ll_list engine_stack = LL_INITIALIZER (engine_stack);
  71
  72 static const struct output_driver_factory *factories[];
  73
  74 static struct output_engine *
  75 engine_stack_top (void)
  76 {
  77   struct ll *head = ll_head (&engine_stack);
  78   if (ll_is_empty (&engine_stack))
  79     return NULL;
  80   return ll_data (head, struct output_engine, ll);
  81 }
  82
  83 static void
  84 put_strftime (const char *key, const char *format,
  85               const struct tm *tm, struct string_map *vars)
  86 {
  87   if (!string_map_find (vars, key))
  88     {
  89       char value[128];
  90       strftime (value, sizeof value, format, tm);
  91       string_map_insert (vars, key, value);
  92     }
  93 }
  94
  95 void
  96 output_engine_push (void)
  97 {
  98   struct output_engine *e = xzalloc (sizeof (*e));
  99
 100   llx_init (&e->drivers);
 101
 102   string_map_init (&e->heading_vars);
 103
 104   time_t t = time (NULL);
 105   const struct tm *tm = localtime (&t);
 106   put_strftime ("Date", "%x", tm, &e->heading_vars);
 107   put_strftime ("Time", "%X", tm, &e->heading_vars);
 108
 109   ll_push_head (&engine_stack, &e->ll);
 110 }
 111
 112 void
 113 output_engine_pop (void)
 114 {
 115   struct ll *head = ll_pop_head (&engine_stack);
 116   struct output_engine *e =ll_data (head, struct output_engine, ll);
 117
 118   while (!llx_is_empty (&e->drivers))
 119     {
 120       struct output_driver *d = llx_pop_head (&e->drivers, &llx_malloc_mgr);
 121       output_driver_destroy (d);
 122     }
 123   text_item_unref (e->deferred_text);
 124   free (e->command_name);
 125   free (e->title);
 126   free (e->subtitle);
 127   for (size_t i = 0; i < e->n_groups; i++)
 128     free (e->groups[i]);
 129   free (e->groups);
 130   string_map_destroy (&e->heading_vars);
 131   free (e);
 132 }
 133
 134 void
 135 output_get_supported_formats (struct string_set *formats)
 136 {
 137   const struct output_driver_factory **fp;
 138
 139   for (fp = factories; *fp != NULL; fp++)
 140     string_set_insert (formats, (*fp)->extension);
 141 }
 142
 143 static void
 144 output_submit__ (struct output_engine *e, struct output_item *item)
 145 {
 146   struct llx *llx, *next;
 147
 148   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers); llx = next)
 149     {
 150       struct output_driver *d = llx_data (llx);
 151       enum settings_output_type type;
 152
 153       next = llx_next (llx);
 154
 155       if (is_message_item (item))
 156         {
 157           const struct msg *m = message_item_get_msg (to_message_item (item));
 158           if (m->severity == MSG_S_NOTE)
 159             type = SETTINGS_OUTPUT_NOTE;
 160           else
 161             type = SETTINGS_OUTPUT_ERROR;
 162         }
 163       else if (is_text_item (item)
 164                && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
 165         type = SETTINGS_OUTPUT_SYNTAX;
 166       else
 167         type = SETTINGS_OUTPUT_RESULT;
 168
 169       if (settings_get_output_routing (type) & d->device_type)
 170         d->class->submit (d, item);
 171     }
 172
 173   output_item_unref (item);
 174 }
 175
 176 static void
 177 flush_deferred_text (struct output_engine *e)
 178 {
 179   struct text_item *deferred_text = e->deferred_text;
 180   if (deferred_text)
 181     {
 182       e->deferred_text = NULL;
 183       output_submit__ (e, text_item_super (deferred_text));
 184     }
 185 }
 186
 187 static bool
 188 defer_text (struct output_engine *e, struct output_item *output_item)
 189 {
 190   if (!is_text_item (output_item))
 191     return false;
 192
 193   struct text_item *text = to_text_item (output_item);
 194   if (!e->deferred_text)
 195     e->deferred_text = text_item_unshare (text);
 196   else if (text_item_append (e->deferred_text, text))
 197     text_item_unref (text);
 198   else
 199     {
 200       flush_deferred_text (e);
 201       e->deferred_text = text_item_unshare (text);
 202     }
 203   return true;
 204 }
 205
 206 /* Submits ITEM to the configured output drivers, and transfers ownership to
 207    the output subsystem. */
 208 void
 209 output_submit (struct output_item *item)
 210 {
 211   struct output_engine *e = engine_stack_top ();
 212
 213   if (e == NULL)
 214     return;
 215
 216   if (item == NULL)
 217     return;
 218
 219   if (defer_text (e, item))
 220     return;
 221   flush_deferred_text (e);
 222
 223   if (is_group_open_item (item))
 224     {
 225       const struct group_open_item *group_open_item
 226         = to_group_open_item (item);
 227       if (e->n_groups >= e->allocated_groups)
 228         e->groups = x2nrealloc (e->groups, &e->allocated_groups,
 229                                 sizeof *e->groups);
 230       e->groups[e->n_groups] = xstrdup_if_nonnull (
 231         group_open_item->command_name);
 232       e->n_groups++;
 233     }
 234   else if (is_group_close_item (item))
 235     {
 236       assert (e->n_groups > 0);
 237
 238       size_t idx = --e->n_groups;
 239       free (e->groups[idx]);
 240
 241       char *key = xasprintf ("Head%zu", idx);
 242       free (string_map_find_and_delete (&e->heading_vars, key));
 243       free (key);
 244     }
 245   else if (is_text_item (item))
 246     {
 247       const struct text_item *text_item = to_text_item (item);
 248       enum text_item_type type = text_item_get_type (text_item);
 249       char *key = (type == TEXT_ITEM_TITLE ? xasprintf ("Head%zu", e->n_groups)
 250                    : type == TEXT_ITEM_PAGE_TITLE ? xstrdup ("PageTitle")
 251                    : NULL);
 252       if (key)
 253         string_map_replace_nocopy (&e->heading_vars, key,
 254                                    text_item_get_plain_text (text_item));
 255     }
 256
 257   output_submit__ (e, item);
 258 }
 259
 260 /* Returns the name of the command currently being parsed, in all uppercase.
 261    The caller must free the returned value.
 262
 263    Returns NULL if no command is being parsed. */
 264 char *
 265 output_get_command_name (void)
 266 {
 267   struct output_engine *e = engine_stack_top ();
 268   if (e == NULL)
 269     return NULL;
 270
 271   for (size_t i = e->n_groups; i-- > 0;)
 272     if (e->groups[i])
 273       return utf8_to_upper (e->groups[i]);
 274
 275   return NULL;
 276 }
 277
 278 /* Flushes output to screen devices, so that the user can see
 279    output that doesn't fill up an entire page. */
 280 void
 281 output_flush (void)
 282 {
 283   struct output_engine *e = engine_stack_top ();
 284   struct llx *llx;
 285
 286   flush_deferred_text (e);
 287   for (llx = llx_head (&e->drivers); llx != llx_null (&e->drivers);
 288        llx = llx_next (llx))
 289     {
 290       struct output_driver *d = llx_data (llx);
 291       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
 292         d->class->flush (d);
 293     }
 294 }
 295
 296 static void
 297 output_set_title__ (struct output_engine *e, char **dst, const char *src)
 298 {
 299   free (*dst);
 300   *dst = xstrdup_if_nonnull (src);
 301
 302   char *page_title
 303     = (e->title && e->subtitle ? xasprintf ("%s\n%s", e->title, e->subtitle)
 304        : e->title ? xstrdup (e->title)
 305        : e->subtitle ? xstrdup (e->subtitle)
 306        : xzalloc (1));
 307   text_item_submit (text_item_create_nocopy (TEXT_ITEM_PAGE_TITLE,
 308                                              page_title, NULL));
 309 }
 310
 311 void
 312 output_set_title (const char *title)
 313 {
 314   struct output_engine *e = engine_stack_top ();
 315
 316   output_set_title__ (e, &e->title, title);
 317 }
 318
 319 void
 320 output_set_subtitle (const char *subtitle)
 321 {
 322   struct output_engine *e = engine_stack_top ();
 323
 324   output_set_title__ (e, &e->subtitle, subtitle);
 325 }
 326
 327 void
 328 output_set_filename (const char *filename)
 329 {
 330   struct output_engine *e = engine_stack_top ();
 331
 332   string_map_replace (&e->heading_vars, "Filename", filename);
 333 }
 334
 335 size_t
 336 output_get_group_level (void)
 337 {
 338   struct output_engine *e = engine_stack_top ();
 339
 340   return e->n_groups;
 341 }
 342 \f
 343 void
 344 output_driver_init (struct output_driver *driver,
 345                     const struct output_driver_class *class,
 346                     const char *name, enum settings_output_devices type)
 347 {
 348   driver->class = class;
 349   driver->name = xstrdup (name);
 350   driver->device_type = type;
 351 }
 352
 353 void
 354 output_driver_destroy (struct output_driver *driver)
 355 {
 356   if (driver != NULL)
 357     {
 358       char *name = driver->name;
 359       if (output_driver_is_registered (driver))
 360         output_driver_unregister (driver);
 361       if (driver->class->destroy)
 362         driver->class->destroy (driver);
 363       free (name);
 364     }
 365 }
 366
 367 const char *
 368 output_driver_get_name (const struct output_driver *driver)
 369 {
 370   return driver->name;
 371 }
 372 \f
 373 static struct output_engine *
 374 output_driver_get_engine (const struct output_driver *driver)
 375 {
 376   struct output_engine *e;
 377
 378   ll_for_each (e, struct output_engine, ll, &engine_stack)
 379     {
 380       if (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver))
 381         return e;
 382     }
 383
 384   return NULL;
 385 }
 386
 387 void
 388 output_driver_register (struct output_driver *driver)
 389 {
 390   struct output_engine *e = engine_stack_top ();
 391
 392   assert (!output_driver_is_registered (driver));
 393   llx_push_tail (&e->drivers, driver, &llx_malloc_mgr);
 394 }
 395
 396 void
 397 output_driver_unregister (struct output_driver *driver)
 398 {
 399   struct output_engine *e = output_driver_get_engine (driver);
 400
 401   assert (e != NULL);
 402   llx_remove (llx_find (llx_head (&e->drivers), llx_null (&e->drivers), driver),
 403               &llx_malloc_mgr);
 404 }
 405
 406 bool
 407 output_driver_is_registered (const struct output_driver *driver)
 408 {
 409   return output_driver_get_engine (driver) != NULL;
 410 }
 411 \f
 412 extern const struct output_driver_factory csv_driver_factory;
 413 extern const struct output_driver_factory html_driver_factory;
 414 extern const struct output_driver_factory list_driver_factory;
 415 extern const struct output_driver_factory odt_driver_factory;
 416 extern const struct output_driver_factory pdf_driver_factory;
 417 extern const struct output_driver_factory png_driver_factory;
 418 extern const struct output_driver_factory ps_driver_factory;
 419 extern const struct output_driver_factory spv_driver_factory;
 420 extern const struct output_driver_factory svg_driver_factory;
 421 extern const struct output_driver_factory tex_driver_factory;
 422 extern const struct output_driver_factory txt_driver_factory;
 423
 424 static const struct output_driver_factory *factories[] =
 425   {
 426     &txt_driver_factory,
 427     &list_driver_factory,
 428     &html_driver_factory,
 429     &csv_driver_factory,
 430     &odt_driver_factory,
 431     &spv_driver_factory,
 432     &pdf_driver_factory,
 433     &ps_driver_factory,
 434     &svg_driver_factory,
 435     &png_driver_factory,
 436     &tex_driver_factory,
 437     NULL
 438   };
 439
 440 static const struct output_driver_factory *
 441 find_factory (const char *format)
 442 {
 443   const struct output_driver_factory **fp;
 444
 445   for (fp = factories; *fp != NULL; fp++)
 446     {
 447       const struct output_driver_factory *f = *fp;
 448
 449       if (!strcmp (f->extension, format))
 450         return f;
 451     }
 452   return &txt_driver_factory;
 453 }
 454
 455 static enum settings_output_devices
 456 default_device_type (const char *file_name)
 457 {
 458   return (!strcmp (file_name, "-")
 459           ? SETTINGS_DEVICE_TERMINAL
 460           : SETTINGS_DEVICE_LISTING);
 461 }
 462
 463 struct output_driver *
 464 output_driver_create (struct string_map *options)
 465 {
 466   enum settings_output_devices device_type;
 467   const struct output_driver_factory *f;
 468   struct output_driver *driver;
 469   char *device_string;
 470   char *file_name;
 471   char *format;
 472
 473   format = string_map_find_and_delete (options, "format");
 474   file_name = string_map_find_and_delete (options, "output-file");
 475
 476   if (format == NULL)
 477     {
 478       if (file_name != NULL)
 479         {
 480           const char *extension = strrchr (file_name, '.');
 481           format = xstrdup (extension != NULL ? extension + 1 : "");
 482         }
 483       else
 484         format = xstrdup ("txt");
 485     }
 486   f = find_factory (format);
 487
 488   if (file_name == NULL)
 489     file_name = xstrdup (f->default_file_name);
 490
 491   /* XXX should use parse_enum(). */
 492   device_string = string_map_find_and_delete (options, "device");
 493   if (device_string == NULL || device_string[0] == '\0')
 494     device_type = default_device_type (file_name);
 495   else if (!strcmp (device_string, "terminal"))
 496     device_type = SETTINGS_DEVICE_TERMINAL;
 497   else if (!strcmp (device_string, "listing"))
 498     device_type = SETTINGS_DEVICE_LISTING;
 499   else
 500     {
 501       msg (MW, _("%s is not a valid device type (the choices are `%s' and `%s')"),
 502                      device_string, "terminal", "listing");
 503       device_type = default_device_type (file_name);
 504     }
 505
 506   struct file_handle *fh = fh_create_file (NULL, file_name, NULL, fh_default_properties ());
 507
 508   driver = f->create (fh, device_type, options);
 509   if (driver != NULL)
 510     {
 511       const struct string_map_node *node;
 512       const char *key;
 513
 514       STRING_MAP_FOR_EACH_KEY (key, node, options)
 515         msg (MW, _("%s: unknown option `%s'"), file_name, key);
 516     }
 517   string_map_clear (options);
 518
 519   free (file_name);
 520   free (format);
 521   free (device_string);
 522
 523   return driver;
 524 }
 525
 526 void
 527 output_driver_parse_option (const char *option, struct string_map *options)
 528 {
 529   const char *equals = strchr (option, '=');
 530   if (equals == NULL)
 531     {
 532       error (0, 0, _("%s: output option missing `='"), option);
 533       return;
 534     }
 535
 536   char *key = xmemdup0 (option, equals - option);
 537   if (string_map_contains (options, key))
 538     {
 539       error (0, 0, _("%s: output option specified more than once"), key);
 540       free (key);
 541       return;
 542     }
 543
 544   char *value = xmemdup0 (equals + 1, strlen (equals + 1));
 545   string_map_insert_nocopy (options, key, value);
 546 }
 547 \f
 548 char *
 549 output_driver_substitute_heading_vars (const char *src, int page_number)
 550 {
 551   struct output_engine *e = engine_stack_top ();
 552   struct string dst = DS_EMPTY_INITIALIZER;
 553   ds_extend (&dst, strlen (src));
 554   for (const char *p = src; *p;)
 555     {
 556       if (!strncmp (p, "&amp;[", 6))
 557         {
 558           if (page_number != INT_MIN)
 559             {
 560               const char *start = p + 6;
 561               const char *end = strchr (start, ']');
 562               if (end)
 563                 {
 564                   const char *value = string_map_find__ (&e->heading_vars,
 565                                                          start, end - start);
 566                   if (value)
 567                     ds_put_cstr (&dst, value);
 568                   else if (ss_equals (ss_buffer (start, end - start),
 569                                       ss_cstr ("Page")))
 570                     ds_put_format (&dst, "%d", page_number);
 571                   p = end + 1;
 572                   continue;
 573                 }
 574             }
 575           ds_put_cstr (&dst, "&amp;");
 576           p += 5;
 577         }
 578       else
 579         ds_put_byte (&dst, *p++);
 580     }
 581   return ds_steal_cstr (&dst);
 582 }