1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
37 /* FIXME? Should the output configuration format be changed to
38 drivername:classname:devicetype:options, where devicetype is zero
39 or more of screen, printer, listing? */
41 /* FIXME: Have the reentrancy problems been solved? */
43 /* Where the output driver name came from. */
46 OUTP_S_COMMAND_LINE, /* Specified by the user. */
47 OUTP_S_INIT_FILE /* `default' or the init file. */
50 /* Names the output drivers to be used. */
53 char *name; /* Name of the output driver. */
54 int source; /* OUTP_S_* */
55 struct outp_names *next, *prev;
58 /* Defines an init file macro. */
63 struct outp_defn *next, *prev;
66 static struct outp_defn *outp_macros;
67 static struct outp_names *outp_configure_vec;
69 struct outp_driver_class_list *outp_class_list;
70 struct outp_driver *outp_driver_list;
75 /* A set of OUTP_DEV_* bits indicating the devices that are
79 static void destroy_driver (struct outp_driver *);
80 static void configure_driver (char *);
83 /* This mechanism attempts to catch reentrant use of outp_driver_list. */
84 static int iterating_driver_list;
86 #define reentrancy() msg (FE, _("Attempt to iterate driver list reentrantly."))
89 /* Add a class to the class list. */
91 add_class (struct outp_class *class)
93 struct outp_driver_class_list *new_list = xmalloc (sizeof *new_list);
95 new_list->class = class;
96 new_list->ref_count = 0;
100 outp_class_list = new_list;
101 new_list->next = NULL;
105 new_list->next = outp_class_list;
106 outp_class_list = new_list;
110 /* Finds the outp_names in outp_configure_vec with name between BP and
112 static struct outp_names *
113 search_names (char *bp, char *ep)
115 struct outp_names *n;
117 for (n = outp_configure_vec; n; n = n->next)
118 if ((int) strlen (n->name) == ep - bp && !memcmp (n->name, bp, ep - bp))
123 /* Deletes outp_names NAME from outp_configure_vec. */
125 delete_name (struct outp_names * n)
129 n->prev->next = n->next;
131 n->next->prev = n->prev;
132 if (n == outp_configure_vec)
133 outp_configure_vec = n->next;
137 /* Adds the name between BP and EP exclusive to list
138 outp_configure_vec with source SOURCE. */
140 add_name (char *bp, char *ep, int source)
142 struct outp_names *n = xmalloc (sizeof *n);
143 n->name = xmalloc (ep - bp + 1);
144 memcpy (n->name, bp, ep - bp);
145 n->name[ep - bp] = 0;
147 n->next = outp_configure_vec;
149 if (outp_configure_vec)
150 outp_configure_vec->prev = n;
151 outp_configure_vec = n;
154 /* Checks that outp_configure_vec is empty, bitches & clears it if it
157 check_configure_vec (void)
159 struct outp_names *n;
161 for (n = outp_configure_vec; n; n = n->next)
162 if (n->source == OUTP_S_COMMAND_LINE)
163 msg (ME, _("Unknown output driver `%s'."), n->name);
165 msg (IE, _("Output driver `%s' referenced but never defined."), n->name);
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_DIGITS + 1];
204 for (d = outp_macros; d; d = d->next)
205 if (!strcmp (key, d->key))
207 if (!strcmp (key, "viewwidth"))
209 sprintf (buf, "%d", set_viewwidth);
212 else if (!strcmp (key, "viewlength"))
214 sprintf (buf, "%d", set_viewlength);
221 /* Initializes global variables. */
225 extern struct outp_class ascii_class;
227 extern struct outp_class postscript_class;
228 extern struct outp_class epsf_class;
230 extern struct outp_class html_class;
231 extern struct outp_class devind_class;
233 char def[] = "default";
236 add_class (&html_class);
239 add_class (&epsf_class);
240 add_class (&postscript_class);
242 add_class (&devind_class);
243 add_class (&ascii_class);
245 add_name (def, &def[strlen (def)], OUTP_S_INIT_FILE);
250 /* Deletes all the output macros. */
254 struct outp_defn *d, *next;
256 for (d = outp_macros; d; d = next)
265 /* Reads the initialization file; initializes outp_driver_list. */
267 outp_read_devices (void)
275 struct file_locator where;
278 if (iterating_driver_list)
282 init_fn = fn_search_path (fn_getenv_default ("STAT_OUTPUT_INIT_FILE",
284 fn_getenv_default ("STAT_OUTPUT_INIT_PATH",
287 where.filename = init_fn;
288 where.line_number = 0;
289 err_push_file_locator (&where);
291 ds_init (NULL, &line, 128);
295 msg (IE, _("Cannot find output initialization file. Use `-vv' to view "
300 msg (VM (1), _("%s: Opening device description file..."), init_fn);
301 f = fopen (init_fn, "r");
304 msg (IE, _("Opening %s: %s."), init_fn, strerror (errno));
312 if (!ds_get_config_line (f, &line, &where))
315 msg (ME, _("Reading %s: %s."), init_fn, strerror (errno));
318 for (cp = ds_value (&line); isspace ((unsigned char) *cp); cp++);
319 if (!strncmp ("define", cp, 6) && isspace ((unsigned char) cp[6]))
320 outp_configure_macro (&cp[7]);
324 for (ep = cp; *ep && *ep != ':' && *ep != '='; ep++);
326 expand_name (cp, ep);
329 struct outp_names *n = search_names (cp, ep);
332 configure_driver (cp);
337 msg (IS, _("Syntax error."));
342 check_configure_vec ();
345 err_pop_file_locator (&where);
346 if (f && -1 == fclose (f))
347 msg (MW, _("Closing %s: %s."), init_fn, strerror (errno));
351 if (outp_driver_list == NULL)
352 msg (MW, _("No output drivers are active."));
355 msg (VM (2), _("Device definition file read successfully."));
357 msg (VM (1), _("Error reading device definition file."));
361 /* Clear the list of drivers to configure. */
363 outp_configure_clear (void)
365 struct outp_names *n, *next;
367 for (n = outp_configure_vec; n; n = next)
373 outp_configure_vec = NULL;
376 /* Adds the name BP to the list of drivers to configure into
379 outp_configure_add (char *bp)
381 char *ep = &bp[strlen (bp)];
382 if (!search_names (bp, ep))
383 add_name (bp, ep, OUTP_S_COMMAND_LINE);
386 /* Defines one configuration macro based on the text in BP, which
387 should be of the form `KEY=VALUE'. */
389 outp_configure_macro (char *bp)
394 while (isspace ((unsigned char) *bp))
397 while (*ep && !isspace ((unsigned char) *ep) && *ep != '=')
400 d = xmalloc (sizeof *d);
401 d->key = xmalloc (ep - bp + 1);
402 memcpy (d->key, bp, ep - bp);
405 /* Earlier definitions for a particular KEY override later ones. */
406 if (find_defn_value (d->key))
415 while (isspace ((unsigned char) *ep))
417 d->value = fn_interp_vars (ep, find_defn_value);
418 d->next = outp_macros;
421 outp_macros->prev = d;
425 /* Destroys all the drivers in driver list *DL and sets *DL to
428 destroy_list (struct outp_driver ** dl)
430 struct outp_driver *d, *next;
432 for (d = *dl; d; d = next)
441 /* Closes all the output drivers. */
446 if (iterating_driver_list)
449 destroy_list (&outp_driver_list);
454 /* Display on stdout a list of all registered driver classes. */
456 outp_list_classes (void)
458 int width = set_viewwidth;
459 struct outp_driver_class_list *c;
461 printf (_("Driver classes:\n\t"));
463 for (c = outp_class_list; c; c = c->next)
465 if ((int) strlen (c->class->name) + 1 > width)
468 width = set_viewwidth - 8;
472 fputs (c->class->name, stdout);
477 static int op_token; /* `=', 'a', 0. */
478 static struct string op_tokstr;
481 /* Parses a token from prog into op_token, op_tokstr. Sets op_token
482 to '=' on an equals sign, to 'a' on a string or identifier token,
483 or to 0 at end of line. Returns the new op_token. */
489 msg (IS, _("Syntax error."));
493 while (isspace ((unsigned char) *prog))
505 ds_clear (&op_tokstr);
507 if (*prog == '\'' || *prog == '"')
511 while (*prog && *prog != quote)
514 ds_putchar (&op_tokstr, *prog++);
520 assert ((int) *prog); /* How could a line end in `\'? */
569 while (*prog >= '0' && *prog <= '7')
570 c = c * 8 + *prog++ - '0';
577 while (isxdigit ((unsigned char) *prog))
580 if (isdigit ((unsigned char) *prog))
583 c += (tolower ((unsigned char) (*prog))
590 msg (IS, _("Syntax error in string constant."));
592 ds_putchar (&op_tokstr, (unsigned char) c);
598 while (*prog && !isspace ((unsigned char) *prog) && *prog != '=')
599 ds_putchar (&op_tokstr, *prog++);
606 /* Applies the user-specified options in string S to output driver D
607 (at configuration time). */
609 parse_options (char *s, struct outp_driver * d)
614 ds_init (NULL, &op_tokstr, 64);
621 msg (IS, _("Syntax error in options."));
625 ds_truncate (&op_tokstr, 64);
626 strcpy (key, ds_value (&op_tokstr));
631 msg (IS, _("Syntax error in options (`=' expected)."));
638 msg (IS, _("Syntax error in options (value expected after `=')."));
641 d->class->option (d, key, &op_tokstr);
643 ds_destroy (&op_tokstr);
646 /* Find the driver in outp_driver_list with name NAME. */
647 static struct outp_driver *
648 find_driver (char *name)
650 struct outp_driver *d;
653 if (iterating_driver_list)
656 for (d = outp_driver_list; d; d = d->next)
657 if (!strcmp (d->name, name))
662 /* Tokenize string S into colon-separated fields, removing leading and
663 trailing whitespace on tokens. Returns a pointer to the
664 null-terminated token, which is formed by setting a NUL character
665 into the string. After the first call, subsequent calls should set
666 S to NULL. CP should be consistent across calls. Returns NULL
667 after all fields have been used up.
669 FIXME: Should ignore colons inside double quotes. */
671 colon_tokenize (char *s, char **cp)
681 token = s += strspn (s, " \t\v\r");
682 *cp = strchr (s, ':');
684 s = *cp = strchr (s, 0);
687 while (s > token && strchr (" \t\v\r", s[-1]))
693 /* String S is in format:
694 DRIVERNAME:CLASSNAME:DEVICETYPE:OPTIONS
695 Adds a driver to outp_driver_list pursuant to the specification
698 configure_driver (char *s)
701 struct outp_driver *d = NULL, *iter;
702 struct outp_driver_class_list *c = NULL;
704 s = fn_interp_vars (s, find_defn_value);
707 token = colon_tokenize (s, &cp);
710 msg (IS, _("Driver name expected."));
714 d = xmalloc (sizeof *d);
717 d->name = xstrdup (token);
721 d->next = d->prev = NULL;
723 d->device = OUTP_DEV_NONE;
728 token = colon_tokenize (NULL, &cp);
731 msg (IS, _("Class name expected."));
735 for (c = outp_class_list; c; c = c->next)
736 if (!strcmp (c->class->name, token))
740 msg (IS, _("Unknown output driver class `%s'."), token);
745 if (!c->ref_count && !d->class->open_global (d->class))
747 msg (IS, _("Can't initialize output driver class `%s'."),
752 if (!d->class->preopen_driver (d))
754 msg (IS, _("Can't initialize output driver `%s' of class `%s'."),
755 d->name, d->class->name);
760 token = colon_tokenize (NULL, &cp);
765 for (type = strtok_r (token, " \t\r\v", &sp); type;
766 type = strtok_r (NULL, " \t\r\v", &sp))
768 if (!strcmp (type, "listing"))
769 d->device |= OUTP_DEV_LISTING;
770 else if (!strcmp (type, "screen"))
771 d->device |= OUTP_DEV_SCREEN;
772 else if (!strcmp (type, "printer"))
773 d->device |= OUTP_DEV_PRINTER;
776 msg (IS, _("Unknown device type `%s'."), type);
783 token = colon_tokenize (NULL, &cp);
785 parse_options (token, d);
786 if (!d->class->postopen_driver (d))
788 msg (IS, _("Can't complete initialization of output driver `%s' of "
789 "class `%s'."), d->name, d->class->name);
793 /* Find like-named driver and delete. */
794 iter = find_driver (d->name);
796 destroy_driver (iter);
799 d->next = outp_driver_list;
801 if (outp_driver_list)
802 outp_driver_list->prev = d;
803 outp_driver_list = d;
813 /* Destroys output driver D. */
815 destroy_driver (struct outp_driver *d)
818 d->class->close_page (d);
821 struct outp_driver_class_list *c;
824 d->class->close_driver (d);
826 for (c = outp_class_list; c; c = c->next)
827 if (c->class == d->class)
832 if (c->ref_count == 0)
834 if (!d->class->close_global (d->class))
835 msg (IS, _("Can't deinitialize output driver class `%s'."),
841 /* Remove this driver from the global driver list. */
843 d->prev->next = d->next;
845 d->next->prev = d->prev;
846 if (d == outp_driver_list)
847 outp_driver_list = d->next;
851 option_cmp (const void *a, const void *b)
853 const struct outp_option *o1 = a;
854 const struct outp_option *o2 = b;
855 return strcmp (o1->keyword, o2->keyword);
858 /* Tries to match S as one of the keywords in TAB, with corresponding
859 information structure INFO. Returns category code or 0 on failure;
860 if category code is negative then stores subcategory in *SUBCAT. */
862 outp_match_keyword (const char *s, struct outp_option *tab,
863 struct outp_option_info *info, int *subcat)
866 struct outp_option *oip;
868 /* Form hash table. */
869 if (NULL == info->initial)
874 struct outp_option *ptr[255], **oip;
876 for (count = 0; tab[count].keyword[0]; count++)
880 qsort (tab, count, sizeof *tab, option_cmp);
884 *cp = tab[0].keyword[0];
886 for (i = 0; i < count; i++)
887 if (tab[i].keyword[0] != *cp)
889 *++cp = tab[i].keyword[0];
894 info->initial = xstrdup (s);
895 info->options = xmalloc (sizeof *info->options * (cp - s));
896 memcpy (info->options, ptr, sizeof *info->options * (cp - s));
900 oip = *info->options;
904 cp = strchr (info->initial, s[0]);
908 printf (_("Trying to find keyword `%s'...\n"), s);
910 oip = info->options[cp - info->initial];
911 while (oip->keyword[0] == s[0])
914 printf ("- %s\n", oip->keyword);
916 if (!strcmp (s, oip->keyword))
919 *subcat = oip->subcat;
928 /* Encapsulate two characters in a single int. */
929 #define TWO_CHARS(A, B) \
932 /* Determines the size of a dimensional measurement and returns the
933 size in units of 1/72000". Units if not specified explicitly are
934 inches for values under 50, millimeters otherwise. Returns 0,
935 stores NULL to *TAIL on error; otherwise returns dimension, stores
938 outp_evaluate_dimension (char *dimen, char **tail)
944 value = strtod (s, &ptail);
951 b = strtod (s, &ptail);
952 if (b <= 0.0 || ptail == s)
957 c = strtod (s, &ptail);
958 if (c <= 0.0 || ptail == s)
968 else if (*ptail == '/')
972 b = strtod (s, &ptail);
973 if (b <= 0.0 || ptail == s)
980 if (*s == 0 || isspace ((unsigned char) *s))
985 value *= 72000 / 25.4;
991 /* Standard TeX units are supported. */
995 switch (TWO_CHARS (s[0], s[1]))
997 case TWO_CHARS ('p', 't'):
998 factor = 72000 / 72.27;
1000 case TWO_CHARS ('p', 'c'):
1001 factor = 72000 / 72.27 * 12.0;
1003 case TWO_CHARS ('i', 'n'):
1006 case TWO_CHARS ('b', 'p'):
1007 factor = 72000 / 72.0;
1009 case TWO_CHARS ('c', 'm'):
1010 factor = 72000 / 2.54;
1012 case TWO_CHARS ('m', 'm'):
1013 factor = 72000 / 25.4;
1015 case TWO_CHARS ('d', 'd'):
1016 factor = 72000 / 72.27 * 1.0700086;
1018 case TWO_CHARS ('c', 'c'):
1019 factor = 72000 / 72.27 * 12.840104;
1021 case TWO_CHARS ('s', 'p'):
1022 factor = 72000 / 72.27 / 65536.0;
1025 msg (SE, _("Unit \"%s\" is unknown in dimension \"%s\"."), s, dimen);
1040 msg (SE, _("Bad dimension \"%s\"."), dimen);
1044 /* Stores the dimensions in 1/72000" units of paper identified by
1045 SIZE, which is of form `HORZ x VERT' or `HORZ by VERT' where each
1046 of HORZ and VERT are dimensions, into *H and *V. Return nonzero on
1049 internal_get_paper_size (char *size, int *h, int *v)
1053 while (isspace ((unsigned char) *size))
1055 *h = outp_evaluate_dimension (size, &tail);
1058 while (isspace ((unsigned char) *tail))
1062 else if (*tail == 'b' && tail[1] == 'y')
1066 msg (SE, _("`x' expected in paper size `%s'."), size);
1069 *v = outp_evaluate_dimension (tail, &tail);
1072 while (isspace ((unsigned char) *tail))
1076 msg (SE, _("Trailing garbage `%s' on paper size `%s'."), tail, size);
1083 /* Stores the dimensions, in 1/72000" units, of paper identified by
1084 SIZE into *H and *V. SIZE may be a pair of dimensions of form `H x
1085 V', or it may be a case-insensitive paper identifier, which is
1086 looked up in the `papersize' configuration file. Returns nonzero
1087 on success. May modify SIZE. */
1088 /* Don't read further unless you've got a strong stomach. */
1090 outp_get_paper_size (char *size, int *h, int *v)
1099 static struct paper_size cache[4];
1106 struct file_locator where;
1110 int min_value, min_index;
1114 while (isspace ((unsigned char) *size))
1116 if (isdigit ((unsigned char) *size))
1117 return internal_get_paper_size (size, h, v);
1121 while (isspace ((unsigned char) *ep) && ep >= size)
1125 msg (SE, _("Paper size name must not be empty."));
1134 for (i = 0; i < 4; i++)
1135 if (cache[i].name != NULL && !strcasecmp (cache[i].name, size))
1143 pprsz_fn = fn_search_path (fn_getenv_default ("STAT_OUTPUT_PAPERSIZE_FILE",
1145 fn_getenv_default ("STAT_OUTPUT_INIT_PATH",
1149 where.filename = pprsz_fn;
1150 where.line_number = 0;
1151 err_push_file_locator (&where);
1152 ds_init (NULL, &line, 128);
1154 if (pprsz_fn == NULL)
1156 msg (IE, _("Cannot find `papersize' configuration file."));
1160 msg (VM (1), _("%s: Opening paper size definition file..."), pprsz_fn);
1161 f = fopen (pprsz_fn, "r");
1164 msg (IE, _("Opening %s: %s."), pprsz_fn, strerror (errno));
1172 if (!ds_get_config_line (f, &line, &where))
1175 msg (ME, _("Reading %s: %s."), pprsz_fn, strerror (errno));
1178 for (cp = ds_value (&line); isspace ((unsigned char) *cp); cp++);
1183 for (bp = ep = cp + 1; *ep && *ep != '"'; ep++);
1187 if (0 != strcasecmp (bp, size))
1190 for (cp = ep + 1; isspace ((unsigned char) *cp); cp++);
1193 size = xmalloc (ep - bp + 1);
1202 msg (IE, _("Syntax error in paper size definition."));
1205 /* We found the one we want! */
1206 result = internal_get_paper_size (size, h, v);
1209 min_value = cache[0].use;
1211 for (i = 1; i < 4; i++)
1212 if (cache[0].use < min_value)
1214 min_value = cache[i].use;
1217 free (cache[min_index].name);
1218 cache[min_index].name = xstrdup (size);
1219 cache[min_index].use = use;
1220 cache[min_index].h = *h;
1221 cache[min_index].v = *v;
1225 err_pop_file_locator (&where);
1231 msg (VM (2), _("Paper size definition file read successfully."));
1233 msg (VM (1), _("Error reading paper size definition file."));
1238 /* If D is NULL, returns the first enabled driver if any, NULL if
1239 none. Otherwise D must be the last driver returned by this
1240 function, in which case the next enabled driver is returned or NULL
1241 if that was the last. */
1242 struct outp_driver *
1243 outp_drivers (struct outp_driver *d)
1245 #if GLOBAL_DEBUGGING
1246 struct outp_driver *orig_d = d;
1252 d = outp_driver_list;
1259 || (d->device & disabled_devices) != d->device)))
1263 #if GLOBAL_DEBUGGING
1266 if (iterating_driver_list++)
1269 else if (orig_d && !d)
1271 assert (iterating_driver_list == 1);
1272 iterating_driver_list = 0;
1279 /* Enables (if ENABLE is nonzero) or disables (if ENABLE is zero) the
1280 device(s) given in mask DEVICE. */
1282 outp_enable_device (int enable, int device)
1285 disabled_devices &= ~device;
1287 disabled_devices |= device;
1290 /* Ejects the paper on device D, if the page is not blank. */
1292 outp_eject_page (struct outp_driver *d)
1294 if (d->page_open == 0)
1299 d->cp_x = d->cp_y = 0;
1301 if (d->class->close_page (d) == 0)
1302 msg (ME, _("Error closing page on %s device of %s class."),
1303 d->name, d->class->name);
1304 if (d->class->open_page (d) == 0)
1306 msg (ME, _("Error opening page on %s device of %s class."),
1307 d->name, d->class->name);
1314 /* Returns the width of string S, in device units, when output on
1317 outp_string_width (struct outp_driver *d, const char *s)
1319 struct outp_text text;
1321 text.options = OUTP_T_JUST_LEFT;
1322 ls_init (&text.s, (char *) s, strlen (s));
1323 d->class->text_metrics (d, &text);