1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009 Free Software Foundation, Inc.
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.
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.
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/>. */
28 #include <data/file-name.h>
29 #include <data/settings.h>
30 #include <libpspp/misc.h>
31 #include <libpspp/str.h>
32 #include <output/htmlP.h>
33 #include <output/output.h>
40 #define _(msgid) gettext (msgid)
42 /* Where the output driver name came from. */
45 OUTP_S_COMMAND_LINE, /* Specified by the user. */
46 OUTP_S_INIT_FILE /* `default' or the init file. */
49 /* Names the output drivers to be used. */
52 char *name; /* Name of the output driver. */
53 int source; /* OUTP_S_* */
54 struct outp_names *next, *prev;
57 /* Defines an init file macro. */
62 struct outp_defn *next, *prev;
65 static struct outp_defn *outp_macros;
66 static struct outp_names *outp_configure_vec;
68 /* A list of driver classes. */
69 struct outp_driver_class_list
71 const struct outp_class *class;
72 struct outp_driver_class_list *next;
75 static struct outp_driver_class_list *outp_class_list;
76 static struct ll_list outp_driver_list = LL_INITIALIZER (outp_driver_list);
81 /* A set of OUTP_DEV_* bits indicating the devices that are
83 static int disabled_devices;
85 static void destroy_driver (struct outp_driver *);
86 static void configure_driver (const struct substring, const struct substring,
87 const struct substring, const struct substring);
89 /* Add a class to the class list. */
91 add_class (const struct outp_class *class)
93 struct outp_driver_class_list *new_list = xmalloc (sizeof *new_list);
95 new_list->class = class;
99 outp_class_list = new_list;
100 new_list->next = NULL;
104 new_list->next = outp_class_list;
105 outp_class_list = new_list;
109 /* Finds the outp_names in outp_configure_vec with name between BP and
111 static struct outp_names *
112 search_names (char *bp, char *ep)
114 struct outp_names *n;
116 for (n = outp_configure_vec; n; n = n->next)
117 if ((int) strlen (n->name) == ep - bp && !memcmp (n->name, bp, ep - bp))
122 /* Deletes outp_names NAME from outp_configure_vec. */
124 delete_name (struct outp_names * n)
128 n->prev->next = n->next;
130 n->next->prev = n->prev;
131 if (n == outp_configure_vec)
132 outp_configure_vec = n->next;
136 /* Adds the name between BP and EP exclusive to list
137 outp_configure_vec with source SOURCE. */
139 add_name (char *bp, char *ep, int source)
141 struct outp_names *n = xmalloc (sizeof *n);
142 n->name = xmalloc (ep - bp + 1);
143 memcpy (n->name, bp, ep - bp);
144 n->name[ep - bp] = 0;
146 n->next = outp_configure_vec;
148 if (outp_configure_vec)
149 outp_configure_vec->prev = n;
150 outp_configure_vec = n;
153 /* Checks that outp_configure_vec is empty, complains and clears
156 check_configure_vec (void)
158 struct outp_names *n;
160 for (n = outp_configure_vec; n; n = n->next)
161 if (n->source == OUTP_S_COMMAND_LINE)
162 error (0, 0, _("unknown output driver `%s'"), n->name);
164 error (0, 0, _("output driver `%s' referenced but never defined"),
166 outp_configure_clear ();
169 /* Searches outp_configure_vec for the name between BP and EP
170 exclusive. If found, it is deleted, then replaced by the names
171 given in EP+1, if any. */
173 expand_name (char *bp, char *ep)
175 struct outp_names *n = search_names (bp, ep);
183 while (isspace ((unsigned char) *bp))
186 while (*ep && !isspace ((unsigned char) *ep))
190 if (!search_names (bp, ep))
191 add_name (bp, ep, OUTP_S_INIT_FILE);
196 /* Looks for a macro with key KEY, and returns the corresponding value
197 if found, or NULL if not. */
199 find_defn_value (const char *key)
201 static char buf[INT_STRLEN_BOUND (int) + 1];
204 for (d = outp_macros; d; d = d->next)
205 if (!strcmp (key, d->key))
206 return ds_cstr (&d->value);
207 if (!strcmp (key, "viewwidth"))
209 sprintf (buf, "%d", settings_get_viewwidth ());
212 else if (!strcmp (key, "viewlength"))
214 sprintf (buf, "%d", settings_get_viewlength ());
221 /* Initializes global variables. */
225 char def[] = "default";
227 add_class (&html_class);
228 add_class (&postscript_class);
229 add_class (&ascii_class);
231 add_class (&cairo_class);
234 add_name (def, &def[strlen (def)], OUTP_S_INIT_FILE);
237 /* Deletes all the output macros. */
241 struct outp_defn *d, *next;
243 for (d = outp_macros; d; d = next)
247 ds_destroy (&d->value);
253 init_default_drivers (void)
255 error (0, 0, _("using default output driver configuration"));
256 configure_driver (ss_cstr ("list"),
259 ss_cstr ("length=66 width=79 output-file=\"pspp.list\""));
262 /* Reads the initialization file; initializes
265 outp_read_devices (void)
275 init_fn = fn_search_path (fn_getenv_default ("STAT_OUTPUT_INIT_FILE",
277 fn_getenv_default ("STAT_OUTPUT_INIT_PATH",
280 ds_init_empty (&line);
284 error (0, 0, _("cannot find output initialization file "
285 "(use `-vv' to view search path)"));
289 f = fopen (init_fn, "r");
292 error (0, errno, _("cannot open \"%s\""), init_fn);
301 if (!ds_read_config_line (&line, &line_number, f))
304 error (0, errno, _("reading \"%s\""), init_fn);
307 for (cp = ds_cstr (&line); isspace ((unsigned char) *cp); cp++);
308 if (!strncmp ("define", cp, 6) && isspace ((unsigned char) cp[6]))
309 outp_configure_macro (&cp[7]);
313 for (ep = cp; *ep && *ep != ':' && *ep != '='; ep++);
315 expand_name (cp, ep);
318 struct outp_names *n = search_names (cp, ep);
321 outp_configure_driver_line (ds_ss (&line));
326 error_at_line (0, 0, init_fn, line_number, _("syntax error"));
331 check_configure_vec ();
334 if (f && -1 == fclose (f))
335 error (0, errno, _("error closing \"%s\""), init_fn);
342 if (ll_is_empty (&outp_driver_list))
343 error (0, 0, _("no active output drivers"));
346 error (0, 0, _("error reading device definition file"));
348 if (!result || ll_is_empty (&outp_driver_list))
349 init_default_drivers ();
352 /* Clear the list of drivers to configure. */
354 outp_configure_clear (void)
356 struct outp_names *n, *next;
358 for (n = outp_configure_vec; n; n = next)
364 outp_configure_vec = NULL;
367 /* Adds the name BP to the list of drivers to configure into
370 outp_configure_add (char *bp)
372 char *ep = &bp[strlen (bp)];
373 if (!search_names (bp, ep))
374 add_name (bp, ep, OUTP_S_COMMAND_LINE);
377 /* Defines one configuration macro based on the text in BP, which
378 should be of the form `KEY=VALUE'. */
380 outp_configure_macro (char *bp)
385 while (isspace ((unsigned char) *bp))
388 while (*ep && !isspace ((unsigned char) *ep) && *ep != '=')
391 d = xmalloc (sizeof *d);
392 d->key = xmalloc (ep - bp + 1);
393 memcpy (d->key, bp, ep - bp);
396 /* Earlier definitions for a particular KEY override later ones. */
397 if (find_defn_value (d->key))
406 while (isspace ((unsigned char) *ep))
409 ds_init_cstr (&d->value, ep);
410 fn_interp_vars (ds_ss (&d->value), find_defn_value, &d->value);
411 d->next = outp_macros;
414 outp_macros->prev = d;
418 /* Closes all the output drivers. */
422 struct outp_driver_class_list *n = outp_class_list ;
423 outp_configure_clear ();
424 while (!ll_is_empty (&outp_driver_list))
426 struct outp_driver *d = ll_data (ll_head (&outp_driver_list),
427 struct outp_driver, node);
433 struct outp_driver_class_list *next = n->next;
437 outp_class_list = NULL;
442 free (outp_subtitle);
443 outp_subtitle = NULL;
446 /* Display on stdout a list of all registered driver classes. */
448 outp_list_classes (void)
450 int width = settings_get_viewwidth ();
451 struct outp_driver_class_list *c;
453 printf (_("Driver classes:\n\t"));
455 for (c = outp_class_list; c; c = c->next)
457 if ((int) strlen (c->class->name) + 1 > width)
460 width = settings_get_viewwidth () - 8;
464 fputs (c->class->name, stdout);
469 /* Obtains a token from S and advances its position. Errors are
470 reported against the given DRIVER_NAME.
471 The token is stored in TOKEN. Returns true if successful,
472 false on syntax error.
474 Caller is responsible for skipping leading spaces. */
476 get_option_token (struct substring *s, const char *driver_name,
477 struct string *token)
485 error (0, 0, _("syntax error parsing options for \"%s\" driver"),
489 else if (c == '\'' || c == '"')
501 _("reached end of options inside quoted string "
502 "parsing options for \"%s\" driver"),
507 ds_put_char (token, c);
554 while (ss_first (*s) >= '0' && ss_first (*s) <= '7')
555 out = out * 8 + (ss_get_char (s) - '0');
560 while (isxdigit (ss_first (*s)))
567 out += tolower (c) - 'a' + 10;
571 error (0, 0, _("syntax error in string constant "
572 "parsing options for \"%s\" driver"),
576 ds_put_char (token, out);
584 ds_put_char (token, c);
587 if (c == EOF || c == '=' || isspace (c))
597 outp_parse_options (struct substring options,
598 bool (*callback) (struct outp_driver *, const char *key,
599 const struct string *value),
600 struct outp_driver *driver)
602 struct string key = DS_EMPTY_INITIALIZER;
603 struct string value = DS_EMPTY_INITIALIZER;
604 struct substring left = options;
609 ss_ltrim (&left, ss_cstr (CC_SPACES));
610 if (ss_is_empty (left))
613 if (!get_option_token (&left, driver->name, &key))
616 ss_ltrim (&left, ss_cstr (CC_SPACES));
617 if (!ss_match_char (&left, '='))
619 error (0, 0, _("syntax error expecting `=' "
620 "parsing options for driver \"%s\""),
625 ss_ltrim (&left, ss_cstr (CC_SPACES));
626 if (!get_option_token (&left, driver->name, &value))
629 ok = callback (driver, ds_cstr (&key), &value);
639 /* Find the driver in outp_driver_list with name NAME. */
640 static struct outp_driver *
641 find_driver (char *name)
643 struct outp_driver *d;
644 ll_for_each (d, struct outp_driver, node, &outp_driver_list)
645 if (!strcmp (d->name, name))
650 /* Adds a driver to outp_driver_list pursuant to the
651 specification provided. */
653 configure_driver (struct substring driver_name, struct substring class_name,
654 struct substring device_type, struct substring options)
656 struct outp_driver_class_list *c;
657 struct substring token;
663 for (c = outp_class_list; c; c = c->next)
664 if (!ss_compare (ss_cstr (c->class->name), class_name))
668 error (0, 0, _("unknown output driver class `%.*s'"),
669 (int) ss_length (class_name), ss_data (class_name));
673 /* Parse device type. */
675 while (ss_tokenize (device_type, ss_cstr (CC_SPACES), &save_idx, &token))
676 if (!ss_compare (token, ss_cstr ("listing")))
677 device |= OUTP_DEV_LISTING;
678 else if (!ss_compare (token, ss_cstr ("screen")))
679 device |= OUTP_DEV_SCREEN;
680 else if (!ss_compare (token, ss_cstr ("printer")))
681 device |= OUTP_DEV_PRINTER;
683 error (0, 0, _("unknown device type `%.*s'"),
684 (int) ss_length (token), ss_data (token));
687 name = ss_xstrdup (driver_name);
688 if (!c->class->open_driver (name, device, options))
689 error (0, 0, _("cannot initialize output driver `%s' of class `%s'"),
690 name, c->class->name);
694 /* Allocates and returns a new outp_driver for a device with the
695 given NAME and CLASS and the OUTP_DEV_* type(s) in TYPES
697 This function is intended to be used by output drivers, not
700 outp_allocate_driver (const struct outp_class *class,
701 const char *name, int types)
703 struct outp_driver *d = xmalloc (sizeof *d);
705 d->name = xstrdup (name);
706 d->page_open = false;
708 d->cp_x = d->cp_y = 0;
714 /* Frees driver D and the data that it owns directly. The
715 driver's class must already have unregistered D (if it was
716 registered) and freed data private to its class.
718 This function is intended to be used by output drivers, not
721 outp_free_driver (struct outp_driver *d)
727 /* Adds D to the list of drivers that will be used for output. */
729 outp_register_driver (struct outp_driver *d)
731 struct outp_driver *victim;
733 /* Find like-named driver and delete. */
734 victim = find_driver (d->name);
736 destroy_driver (victim);
739 ll_push_tail (&outp_driver_list, &d->node);
742 /* Remove driver D from the list of drivers that will be used for
745 outp_unregister_driver (struct outp_driver *d)
747 ll_remove (&d->node);
750 /* String LINE is in format:
751 DRIVERNAME:CLASSNAME:DEVICETYPE:OPTIONS
752 Adds a driver to outp_driver_list pursuant to the specification
755 outp_configure_driver_line (struct substring line_)
757 struct string line = DS_EMPTY_INITIALIZER;
758 struct substring tokens[4];
762 fn_interp_vars (line_, find_defn_value, &line);
765 for (i = 0; i < 4; i++)
767 struct substring *token = &tokens[i];
768 ds_separate (&line, ss_cstr (i < 3 ? ":" : ""), &save_idx, token);
769 ss_trim (token, ss_cstr (CC_SPACES));
772 if (!ss_is_empty (tokens[0]) && !ss_is_empty (tokens[1]))
773 configure_driver (tokens[0], tokens[1], tokens[2], tokens[3]);
776 _("driver definition line missing driver name or class name"));
781 /* Destroys output driver D. */
783 destroy_driver (struct outp_driver *d)
786 if (d->class && d->class->close_driver)
787 d->class->close_driver (d);
788 outp_unregister_driver (d);
789 outp_free_driver (d);
792 /* Tries to match S as one of the keywords in TAB, with
793 corresponding information structure INFO. Returns category
794 code and stores subcategory in *SUBCAT on success. Returns -1
797 outp_match_keyword (const char *s, const struct outp_option *tab, int *subcat)
799 for (; tab->keyword != NULL; tab++)
800 if (!strcmp (s, tab->keyword))
802 *subcat = tab->subcat;
808 /* Parses UNIT as a dimensional unit. Returns the multiplicative
809 factor needed to change a quantity measured in that unit into
810 1/72000" units. If UNIT is empty, it is treated as
811 millimeters. If the unit is unrecognized, returns 0. */
813 parse_unit (const char *unit)
821 static const struct unit units[] =
824 {"pc", 72000 / 72 * 12.0},
826 {"cm", 72000 / 2.54},
827 {"mm", 72000 / 25.4},
831 const struct unit *p;
833 unit += strspn (unit, CC_SPACES);
834 for (p = units; p < units + sizeof units / sizeof *units; p++)
835 if (!strcasecmp (unit, p->name))
840 /* Determines the size of a dimensional measurement and returns
841 the size in units of 1/72000". Units are assumed to be
842 millimeters unless otherwise specified. Returns 0 on
845 outp_evaluate_dimension (const char *dimen)
851 raw = strtod (dimen, &tail);
856 factor = parse_unit (tail);
863 error (0, 0, _("`%s' is not a valid length."), dimen);
867 /* Stores the dimensions in 1/72000" units of paper identified by
868 SIZE, which is of form `HORZ x VERT [UNIT]' where HORZ and
869 VERT are numbers and UNIT is an optional unit of measurement,
870 into *H and *V. Return true on success. */
872 parse_paper_size (const char *size, int *h, int *v)
874 double raw_h, raw_v, factor;
878 raw_h = strtod (size, &tail);
883 tail += strspn (tail, CC_SPACES "x,");
886 raw_v = strtod (tail, &tail);
891 factor = parse_unit (tail);
895 *h = raw_h * factor + .5;
896 *v = raw_v * factor + .5;
901 get_standard_paper_size (struct substring name, int *h, int *v)
903 static const char *sizes[][2] =
905 {"a0", "841 x 1189 mm"},
906 {"a1", "594 x 841 mm"},
907 {"a2", "420 x 594 mm"},
908 {"a3", "297 x 420 mm"},
909 {"a4", "210 x 297 mm"},
910 {"a5", "148 x 210 mm"},
911 {"b5", "176 x 250 mm"},
912 {"a6", "105 x 148 mm"},
913 {"a7", "74 x 105 mm"},
914 {"a8", "52 x 74 mm"},
915 {"a9", "37 x 52 mm"},
916 {"a10", "26 x 37 mm"},
917 {"b0", "1000 x 1414 mm"},
918 {"b1", "707 x 1000 mm"},
919 {"b2", "500 x 707 mm"},
920 {"b3", "353 x 500 mm"},
921 {"b4", "250 x 353 mm"},
922 {"letter", "612 x 792 pt"},
923 {"legal", "612 x 1008 pt"},
924 {"executive", "522 x 756 pt"},
925 {"note", "612 x 792 pt"},
926 {"11x17", "792 x 1224 pt"},
927 {"tabloid", "792 x 1224 pt"},
928 {"statement", "396 x 612 pt"},
929 {"halfletter", "396 x 612 pt"},
930 {"halfexecutive", "378 x 522 pt"},
931 {"folio", "612 x 936 pt"},
932 {"quarto", "610 x 780 pt"},
933 {"ledger", "1224 x 792 pt"},
934 {"archA", "648 x 864 pt"},
935 {"archB", "864 x 1296 pt"},
936 {"archC", "1296 x 1728 pt"},
937 {"archD", "1728 x 2592 pt"},
938 {"archE", "2592 x 3456 pt"},
939 {"flsa", "612 x 936 pt"},
940 {"flse", "612 x 936 pt"},
941 {"csheet", "1224 x 1584 pt"},
942 {"dsheet", "1584 x 2448 pt"},
943 {"esheet", "2448 x 3168 pt"},
948 for (i = 0; i < sizeof sizes / sizeof *sizes; i++)
949 if (ss_equals_case (ss_cstr (sizes[i][0]), name))
951 bool ok = parse_paper_size (sizes[i][1], h, v);
955 error (0, 0, _("unknown paper type `%.*s'"),
956 (int) ss_length (name), ss_data (name));
960 /* Reads file FILE_NAME to find a paper size. Stores the
961 dimensions, in 1/72000" units, into *H and *V. Returns true
962 on success, false on failure. */
964 read_paper_conf (const char *file_name, int *h, int *v)
966 struct string line = DS_EMPTY_INITIALIZER;
970 file = fopen (file_name, "r");
973 error (0, errno, _("error opening \"%s\""), file_name);
979 struct substring name;
981 if (!ds_read_config_line (&line, &line_number, file))
984 error (0, errno, _("error reading \"%s\""), file_name);
988 name = ds_ss (&line);
989 ss_trim (&name, ss_cstr (CC_SPACES));
990 if (!ss_is_empty (name))
992 bool ok = get_standard_paper_size (name, h, v);
1001 error (0, 0, _("paper size file \"%s\" does not state a paper size"),
1006 /* The user didn't specify a paper size, so let's choose a
1007 default based on his environment. Stores the
1008 dimensions, in 1/72000" units, into *H and *V. Returns true
1009 on success, false on failure. */
1011 get_default_paper_size (int *h, int *v)
1013 /* libpaper in Debian (and other distributions?) allows the
1014 paper size to be specified in $PAPERSIZE or in a file
1015 specified in $PAPERCONF. */
1016 if (getenv ("PAPERSIZE") != NULL)
1017 return get_standard_paper_size (ss_cstr (getenv ("PAPERSIZE")), h, v);
1018 if (getenv ("PAPERCONF") != NULL)
1019 return read_paper_conf (getenv ("PAPERCONF"), h, v);
1022 /* LC_PAPER is a non-standard glibc extension. */
1023 *h = (int) nl_langinfo(_NL_PAPER_WIDTH) * (72000 / 25.4);
1024 *v = (int) nl_langinfo(_NL_PAPER_HEIGHT) * (72000 / 25.4);
1025 if (*h > 0 && *v > 0)
1029 /* libpaper defaults to /etc/papersize. */
1030 if (fn_exists ("/etc/papersize"))
1031 return read_paper_conf ("/etc/papersize", h, v);
1033 /* Can't find a default. */
1037 /* Stores the dimensions, in 1/72000" units, of paper identified
1038 by SIZE into *H and *V. SIZE can be the name of a kind of
1039 paper ("a4", "letter", ...) or a pair of dimensions
1040 ("210x297", "8.5x11in", ...). Returns true on success, false
1041 on failure. On failure, *H and *V are set for A4 paper. */
1043 outp_get_paper_size (const char *size, int *h, int *v)
1049 ss_trim (&s, ss_cstr (CC_SPACES));
1051 if (ss_is_empty (s))
1053 /* Treat empty string as default paper size. */
1054 ok = get_default_paper_size (h, v);
1056 else if (isdigit (ss_first (s)))
1058 /* Treat string that starts with digit as explicit size. */
1059 ok = parse_paper_size (size, h, v);
1061 error (0, 0, _("syntax error in paper size `%s'"), size);
1065 /* Check against standard paper sizes. */
1066 ok = get_standard_paper_size (s, h, v);
1069 /* Default to A4 on error. */
1072 *h = 210 * (72000 / 25.4);
1073 *v = 297 * (72000 / 25.4);
1078 /* If D is NULL, returns the first enabled driver if any, NULL if
1079 none. Otherwise D must be the last driver returned by this
1080 function, in which case the next enabled driver is returned or NULL
1081 if that was the last. */
1082 struct outp_driver *
1083 outp_drivers (struct outp_driver *d)
1089 next = d == NULL ? ll_head (&outp_driver_list) : ll_next (&d->node);
1090 if (next == ll_null (&outp_driver_list))
1093 d = ll_data (next, struct outp_driver, node);
1095 while (d->device != 0 && (d->device & disabled_devices) == d->device);
1100 /* Enables (if ENABLE is true) or disables (if ENABLE is false) the
1101 device(s) given in mask DEVICE. */
1103 outp_enable_device (bool enable, int device)
1106 disabled_devices &= ~device;
1108 disabled_devices |= device;
1111 /* Opens a page on driver D (if one is not open). */
1113 outp_open_page (struct outp_driver *d)
1117 d->cp_x = d->cp_y = 0;
1119 d->page_open = true;
1120 if (d->class->open_page != NULL)
1121 d->class->open_page (d);
1125 /* Closes the page on driver D (if one is open). */
1127 outp_close_page (struct outp_driver *d)
1131 if (d->class->close_page != NULL)
1132 d->class->close_page (d);
1133 d->page_open = false;
1137 /* Ejects the page on device D, if a page is open and non-blank,
1138 and opens a new page. */
1140 outp_eject_page (struct outp_driver *d)
1142 if (d->page_open && d->cp_y != 0)
1143 outp_close_page (d);
1147 /* Flushes output to screen devices, so that the user can see
1148 output that doesn't fill up an entire page. */
1150 outp_flush (struct outp_driver *d)
1152 if (d->device & OUTP_DEV_SCREEN && d->class->flush != NULL)
1154 outp_close_page (d);
1155 d->class->flush (d);
1159 /* Returns the width of string S, in device units, when output on
1162 outp_string_width (struct outp_driver *d, const char *s, enum outp_font font)
1164 struct outp_text text;
1168 text.justification = OUTP_LEFT;
1169 text.string = ss_cstr (s);
1170 text.h = text.v = INT_MAX;
1171 d->class->text_metrics (d, &text, &width, NULL);