1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011 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/>. */
25 #include "data/data-in.h"
26 #include "data/data-out.h"
27 #include "data/dataset.h"
28 #include "data/dictionary.h"
29 #include "data/format.h"
30 #include "data/settings.h"
31 #include "data/value.h"
32 #include "data/variable.h"
33 #include "language/command.h"
34 #include "language/lexer/format-parser.h"
35 #include "language/lexer/lexer.h"
36 #include "libpspp/compiler.h"
37 #include "libpspp/copyleft.h"
38 #include "libpspp/temp-file.h"
39 #include "libpspp/version.h"
40 #include "libpspp/float-format.h"
41 #include "libpspp/i18n.h"
42 #include "libpspp/integer-format.h"
43 #include "libpspp/message.h"
44 #include "math/random.h"
45 #include "output/driver.h"
46 #include "output/journal.h"
51 #else /* !HAVE_TERMCAP_H */
52 int tgetent (char *, const char *);
53 int tgetnum (const char *);
54 #endif /* !HAVE_TERMCAP_H */
55 #endif /* !HAVE_LIBTERMCAP */
60 #define _(msgid) gettext (msgid)
67 case=size:upper/uplow;
73 compression=compress:on/off;
75 decimal=dec:dot/comma;
79 headers=headers:no/yes/blank;
87 lowres=lores:auto/on/off;
89 menus=menus:standard/extended;
101 rib=rib:msbfirst/lsbfirst/vax/native;
102 rrb=rrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
104 scompression=scompress:on/off;
110 undefined=undef:warn/nowarn;
111 wib=wib:msbfirst/lsbfirst/vax/native;
112 wrb=wrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
124 static enum integer_format stc_to_integer_format (int stc);
125 static enum float_format stc_to_float_format (int stc);
128 cmd_set (struct lexer *lexer, struct dataset *ds)
132 if (!parse_set (lexer, ds, &cmd, NULL))
139 settings_set_cc ( cmd.s_cca, FMT_CCA);
141 settings_set_cc ( cmd.s_ccb, FMT_CCB);
143 settings_set_cc ( cmd.s_ccc, FMT_CCC);
145 settings_set_cc ( cmd.s_ccd, FMT_CCD);
147 settings_set_cc ( cmd.s_cce, FMT_CCE);
150 settings_set_decimal_char (cmd.dec == STC_DOT ? '.' : ',');
153 settings_set_include (cmd.inc == STC_ON);
156 if (cmd.n_mxerrs[0] >= 1)
157 settings_set_max_messages (MSG_S_ERROR, cmd.n_mxerrs[0]);
159 msg (SE, _("%s must be at least 1."), "MXERRS");
163 if (cmd.n_mxloops[0] >= 1)
164 settings_set_mxloops (cmd.n_mxloops[0]);
166 msg (SE, _("%s must be at least 1."), "MXLOOPS");
170 if (cmd.n_mxwarns[0] >= 0)
171 settings_set_max_messages (MSG_S_WARNING, cmd.n_mxwarns[0]);
173 msg (SE, _("%s must not be negative."), "MXWARNS");
176 settings_set_input_integer_format (stc_to_integer_format (cmd.rib));
178 settings_set_input_float_format (stc_to_float_format (cmd.rrb));
180 settings_set_safer_mode ();
181 if (cmd.sbc_scompression)
182 settings_set_scompression (cmd.scompress == STC_ON);
183 if (cmd.sbc_undefined)
184 settings_set_undefined (cmd.undef == STC_WARN);
186 settings_set_output_integer_format (stc_to_integer_format (cmd.wib));
188 settings_set_output_float_format (stc_to_float_format (cmd.wrb));
189 if (cmd.sbc_workspace)
191 if ( cmd.n_workspace[0] < 1024 && ! settings_get_testing_mode ())
192 msg (SE, _("WORKSPACE must be at least 1MB"));
193 else if (cmd.n_workspace[0] <= 0)
194 msg (SE, _("WORKSPACE must be positive"));
196 settings_set_workspace (cmd.n_workspace[0] * 1024L);
200 msg (SW, _("%s is obsolete."), "BLOCK");
201 if (cmd.sbc_boxstring)
202 msg (SW, _("%s is obsolete."), "BOXSTRING");
204 msg (SW, _("%s is obsolete."), "CPI");
205 if (cmd.sbc_histogram)
206 msg (SW, _("%s is obsolete."), "HISTOGRAM");
208 msg (SW, _("%s is obsolete."), "LPI");
210 msg (SW, _("%s is obsolete."), "MENUS");
212 msg (SW, _("%s is obsolete."), "XSORT");
213 if (cmd.sbc_mxmemory)
214 msg (SE, _("%s is obsolete."), "MXMEMORY");
215 if (cmd.sbc_scripttab)
216 msg (SE, _("%s is obsolete."), "SCRIPTTAB");
218 msg (SW, _("%s is obsolete."), "TBFONTS");
219 if (cmd.sbc_tb1 && cmd.s_tb1)
220 msg (SW, _("%s is obsolete."), "TB1");
223 msg (SW, _("%s is not yet implemented."), "CASE");
225 if (cmd.sbc_compression)
226 msg (SW, _("Active file compression is not implemented."));
233 /* Returns the integer_format value corresponding to STC,
234 which should be the value of cmd.rib or cmd.wib. */
235 static enum integer_format
236 stc_to_integer_format (int stc)
238 return (stc == STC_MSBFIRST ? INTEGER_MSB_FIRST
239 : stc == STC_LSBFIRST ? INTEGER_LSB_FIRST
240 : stc == STC_VAX ? INTEGER_VAX
244 /* Returns the float_format value corresponding to STC,
245 which should be the value of cmd.rrb or cmd.wrb. */
246 static enum float_format
247 stc_to_float_format (int stc)
252 return FLOAT_NATIVE_DOUBLE;
255 return FLOAT_IEEE_SINGLE_LE;
257 return FLOAT_IEEE_SINGLE_BE;
259 return FLOAT_IEEE_DOUBLE_LE;
261 return FLOAT_IEEE_DOUBLE_BE;
271 return FLOAT_Z_SHORT;
280 set_output_routing (struct lexer *lexer, enum settings_output_type type)
282 enum settings_output_devices devices;
284 lex_match (lexer, T_EQUALS);
285 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "BOTH"))
286 devices = SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL;
287 else if (lex_match_id (lexer, "TERMINAL"))
288 devices = SETTINGS_DEVICE_TERMINAL;
289 else if (lex_match_id (lexer, "LISTING"))
290 devices = SETTINGS_DEVICE_LISTING;
291 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NONE"))
295 lex_error (lexer, NULL);
299 settings_set_output_routing (type, devices);
304 /* Parses the BLANKS subcommand, which controls the value that
305 completely blank fields in numeric data imply. X, Wnd: Syntax is
306 SYSMIS or a numeric value. */
308 stc_custom_blanks (struct lexer *lexer,
309 struct dataset *ds UNUSED,
310 struct cmd_set *cmd UNUSED, void *aux UNUSED)
312 lex_match (lexer, T_EQUALS);
313 if (lex_match_id (lexer, "SYSMIS"))
316 settings_set_blanks (SYSMIS);
320 if (!lex_force_num (lexer))
322 settings_set_blanks (lex_number (lexer));
329 stc_custom_tnumbers (struct lexer *lexer,
330 struct dataset *ds UNUSED,
331 struct cmd_set *cmd UNUSED, void *aux UNUSED)
333 lex_match (lexer, T_EQUALS);
335 if (lex_match_id (lexer, "VALUES"))
337 settings_set_value_style (SETTINGS_VAL_STYLE_VALUES);
339 else if (lex_match_id (lexer, "LABELS"))
341 settings_set_value_style (SETTINGS_VAL_STYLE_LABELS);
343 else if (lex_match_id (lexer, "BOTH"))
345 settings_set_value_style (SETTINGS_VAL_STYLE_BOTH);
349 lex_error_expecting (lexer, "VALUES", "LABELS", "BOTH", NULL_SENTINEL);
357 /* Parses the EPOCH subcommand, which controls the epoch used for
358 parsing 2-digit years. */
360 stc_custom_epoch (struct lexer *lexer,
361 struct dataset *ds UNUSED,
362 struct cmd_set *cmd UNUSED, void *aux UNUSED)
364 lex_match (lexer, T_EQUALS);
365 if (lex_match_id (lexer, "AUTOMATIC"))
366 settings_set_epoch (-1);
367 else if (lex_is_integer (lexer))
369 int new_epoch = lex_integer (lexer);
371 if (new_epoch < 1500)
373 msg (SE, _("EPOCH must be 1500 or later."));
376 settings_set_epoch (new_epoch);
380 lex_error (lexer, _("expecting AUTOMATIC or year"));
388 stc_custom_errors (struct lexer *lexer, struct dataset *ds UNUSED,
389 struct cmd_set *cmd UNUSED, void *aux UNUSED)
391 return set_output_routing (lexer, SETTINGS_OUTPUT_ERROR);
395 stc_custom_length (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
399 lex_match (lexer, T_EQUALS);
400 if (lex_match_id (lexer, "NONE"))
404 if (!lex_force_int (lexer))
406 if (lex_integer (lexer) < 1)
408 msg (SE, _("LENGTH must be at least 1."));
411 page_length = lex_integer (lexer);
415 if (page_length != -1)
416 settings_set_viewlength (page_length);
422 stc_custom_locale (struct lexer *lexer, struct dataset *ds UNUSED,
423 struct cmd_set *cmd UNUSED, void *aux UNUSED)
427 lex_match (lexer, T_EQUALS);
429 if ( !lex_force_string (lexer))
432 s = lex_tokcstr (lexer);
434 /* First try this string as an encoding name */
435 if ( valid_encoding (s))
436 set_default_encoding (s);
438 /* Now try as a locale name (or alias) */
439 else if (set_encoding_from_locale (s))
444 msg (ME, _("%s is not a recognized encoding or locale name"), s);
454 stc_custom_messages (struct lexer *lexer, struct dataset *ds UNUSED,
455 struct cmd_set *cmd UNUSED, void *aux UNUSED)
457 return set_output_routing (lexer, SETTINGS_OUTPUT_NOTE);
461 stc_custom_printback (struct lexer *lexer, struct dataset *ds UNUSED,
462 struct cmd_set *cmd UNUSED, void *aux UNUSED)
464 return set_output_routing (lexer, SETTINGS_OUTPUT_SYNTAX);
468 stc_custom_results (struct lexer *lexer, struct dataset *ds UNUSED,
469 struct cmd_set *cmd UNUSED, void *aux UNUSED)
471 return set_output_routing (lexer, SETTINGS_OUTPUT_RESULT);
475 stc_custom_seed (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
477 lex_match (lexer, T_EQUALS);
478 if (lex_match_id (lexer, "RANDOM"))
482 if (!lex_force_num (lexer))
484 set_rng (lex_number (lexer));
492 stc_custom_width (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
494 lex_match (lexer, T_EQUALS);
495 if (lex_match_id (lexer, "NARROW"))
496 settings_set_viewwidth (79);
497 else if (lex_match_id (lexer, "WIDE"))
498 settings_set_viewwidth (131);
501 if (!lex_force_int (lexer))
503 if (lex_integer (lexer) < 40)
505 msg (SE, _("WIDTH must be at least 40."));
508 settings_set_viewwidth (lex_integer (lexer));
515 /* Parses FORMAT subcommand, which consists of a numeric format
518 stc_custom_format (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
522 lex_match (lexer, T_EQUALS);
523 if (!parse_format_specifier (lexer, &fmt))
526 if (!fmt_check_output (&fmt))
529 if (fmt_is_string (fmt.type))
531 char str[FMT_STRING_LEN_MAX + 1];
532 msg (SE, _("FORMAT requires numeric output format as an argument. "
533 "Specified format %s is of type string."),
534 fmt_to_string (&fmt, str));
538 settings_set_format (&fmt);
543 stc_custom_journal (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
545 lex_match (lexer, T_EQUALS);
546 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "YES"))
548 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NO"))
550 else if (lex_is_string (lexer) || lex_token (lexer) == T_ID)
552 char *filename = utf8_to_filename (lex_tokcstr (lexer));
553 journal_set_file_name (filename);
560 lex_error (lexer, NULL);
567 stc_custom_log (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
569 return stc_custom_journal (lexer, ds, cmd, aux);
573 show_output_routing (enum settings_output_type type)
575 enum settings_output_devices devices;
578 devices = settings_get_output_routing (type);
579 if (devices & SETTINGS_DEVICE_LISTING)
580 s = devices & SETTINGS_DEVICE_TERMINAL ? "BOTH" : "LISTING";
581 else if (devices & SETTINGS_DEVICE_TERMINAL)
590 show_blanks (const struct dataset *ds UNUSED)
592 return (settings_get_blanks () == SYSMIS
594 : xasprintf ("%g", settings_get_blanks ()));
598 format_cc (struct string *out, const char *in, char grouping)
603 if (c == grouping || c == '\'')
604 ds_put_byte (out, '\'');
606 ds_put_byte (out, '"');
607 ds_put_byte (out, c);
612 show_cc (enum fmt_type type)
614 const struct fmt_number_style *cc = settings_get_style (type);
617 ds_init_empty (&out);
618 format_cc (&out, cc->neg_prefix.s, cc->grouping);
619 ds_put_byte (&out, cc->grouping);
620 format_cc (&out, cc->prefix.s, cc->grouping);
621 ds_put_byte (&out, cc->grouping);
622 format_cc (&out, cc->suffix.s, cc->grouping);
623 ds_put_byte (&out, cc->grouping);
624 format_cc (&out, cc->neg_suffix.s, cc->grouping);
626 return ds_cstr (&out);
630 show_cca (const struct dataset *ds UNUSED)
632 return show_cc (FMT_CCA);
636 show_ccb (const struct dataset *ds UNUSED)
638 return show_cc (FMT_CCB);
642 show_ccc (const struct dataset *ds UNUSED)
644 return show_cc (FMT_CCC);
648 show_ccd (const struct dataset *ds UNUSED)
650 return show_cc (FMT_CCD);
654 show_cce (const struct dataset *ds UNUSED)
656 return show_cc (FMT_CCE);
660 show_decimals (const struct dataset *ds UNUSED)
662 return xasprintf ("`%c'", settings_get_decimal_char (FMT_F));
666 show_errors (const struct dataset *ds UNUSED)
668 return show_output_routing (SETTINGS_OUTPUT_ERROR);
672 show_format (const struct dataset *ds UNUSED)
674 char str[FMT_STRING_LEN_MAX + 1];
675 return xstrdup (fmt_to_string (settings_get_format (), str));
679 show_length (const struct dataset *ds UNUSED)
681 return xasprintf ("%d", settings_get_viewlength ());
685 show_locale (const struct dataset *ds UNUSED)
687 return xstrdup (get_default_encoding ());
691 show_messages (const struct dataset *ds UNUSED)
693 return show_output_routing (SETTINGS_OUTPUT_NOTE);
697 show_printback (const struct dataset *ds UNUSED)
699 return show_output_routing (SETTINGS_OUTPUT_SYNTAX);
703 show_results (const struct dataset *ds UNUSED)
705 return show_output_routing (SETTINGS_OUTPUT_RESULT);
709 show_mxerrs (const struct dataset *ds UNUSED)
711 return xasprintf ("%d", settings_get_max_messages (MSG_S_ERROR));
715 show_mxloops (const struct dataset *ds UNUSED)
717 return xasprintf ("%d", settings_get_mxloops ());
721 show_mxwarns (const struct dataset *ds UNUSED)
723 return xasprintf ("%d", settings_get_max_messages (MSG_S_WARNING));
726 /* Returns a name for the given INTEGER_FORMAT value. */
728 show_integer_format (enum integer_format integer_format)
730 return xasprintf ("%s (%s)",
731 (integer_format == INTEGER_MSB_FIRST ? "MSBFIRST"
732 : integer_format == INTEGER_LSB_FIRST ? "LSBFIRST"
734 integer_format == INTEGER_NATIVE ? "NATIVE" : "nonnative");
737 /* Returns a name for the given FLOAT_FORMAT value. */
739 show_float_format (enum float_format float_format)
741 const char *format_name = "";
743 switch (float_format)
745 case FLOAT_IEEE_SINGLE_LE:
746 format_name = _("ISL (32-bit IEEE 754 single, little-endian)");
748 case FLOAT_IEEE_SINGLE_BE:
749 format_name = _("ISB (32-bit IEEE 754 single, big-endian)");
751 case FLOAT_IEEE_DOUBLE_LE:
752 format_name = _("IDL (64-bit IEEE 754 double, little-endian)");
754 case FLOAT_IEEE_DOUBLE_BE:
755 format_name = _("IDB (64-bit IEEE 754 double, big-endian)");
759 format_name = _("VF (32-bit VAX F, VAX-endian)");
762 format_name = _("VD (64-bit VAX D, VAX-endian)");
765 format_name = _("VG (64-bit VAX G, VAX-endian)");
769 format_name = _("ZS (32-bit IBM Z hexadecimal short, big-endian)");
772 format_name = _("ZL (64-bit IBM Z hexadecimal long, big-endian)");
780 return xasprintf ("%s (%s)", format_name,
781 (float_format == FLOAT_NATIVE_DOUBLE
782 ? "NATIVE" : "nonnative"));
786 show_rib (const struct dataset *ds UNUSED)
788 return show_integer_format (settings_get_input_integer_format ());
792 show_rrb (const struct dataset *ds UNUSED)
794 return show_float_format (settings_get_input_float_format ());
798 show_scompression (const struct dataset *ds UNUSED)
800 return xstrdup (settings_get_scompression () ? "ON" : "OFF");
804 show_undefined (const struct dataset *ds UNUSED)
806 return xstrdup (settings_get_undefined () ? "WARN" : "NOWARN");
810 show_weight (const struct dataset *ds)
812 const struct variable *var = dict_get_weight (dataset_dict (ds));
813 return xstrdup (var != NULL ? var_get_name (var) : "OFF");
817 show_wib (const struct dataset *ds UNUSED)
819 return show_integer_format (settings_get_output_integer_format ());
823 show_wrb (const struct dataset *ds UNUSED)
825 return show_float_format (settings_get_output_float_format ());
829 show_width (const struct dataset *ds UNUSED)
831 return xasprintf ("%d", settings_get_viewwidth ());
835 show_current_directory (const struct dataset *ds UNUSED)
844 buf = xrealloc (buf, len);
846 while (NULL == (wd = getcwd (buf, len)));
852 show_tempdir (const struct dataset *ds UNUSED)
854 return strdup (temp_dir_name ());
858 show_version (const struct dataset *ds UNUSED)
860 return strdup (version);
864 show_system (const struct dataset *ds UNUSED)
866 return strdup (host_system);
872 char *(*function) (const struct dataset *);
875 const struct show_sbc show_table[] =
877 {"BLANKS", show_blanks},
883 {"DECIMALS", show_decimals},
884 {"DIRECTORY", show_current_directory},
885 {"ENVIRONMENT", show_system},
886 {"ERRORS", show_errors},
887 {"FORMAT", show_format},
888 {"LENGTH", show_length},
889 {"LOCALE", show_locale},
890 {"MESSAGES", show_messages},
891 {"MXERRS", show_mxerrs},
892 {"MXLOOPS", show_mxloops},
893 {"MXWARNS", show_mxwarns},
894 {"PRINTBACk", show_printback},
895 {"RESULTS", show_results},
898 {"SCOMPRESSION", show_scompression},
899 {"TEMPDIR", show_tempdir},
900 {"UNDEFINED", show_undefined},
901 {"VERSION", show_version},
902 {"WEIGHT", show_weight},
905 {"WIDTH", show_width},
909 do_show (const struct dataset *ds, const struct show_sbc *sbc)
911 char *value = sbc->function (ds);
912 msg (SN, _("%s is %s."), sbc->name, value);
917 show_all (const struct dataset *ds)
921 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
922 do_show (ds, &show_table[i]);
926 show_all_cc (const struct dataset *ds)
930 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
932 const struct show_sbc *sbc = &show_table[i];
933 if (!strncmp (sbc->name, "CC", 2))
939 show_warranty (const struct dataset *ds UNUSED)
941 fputs (lack_of_warranty, stdout);
945 show_copying (const struct dataset *ds UNUSED)
947 fputs (copyleft, stdout);
952 cmd_show (struct lexer *lexer, struct dataset *ds)
954 if (lex_token (lexer) == T_ENDCMD)
962 if (lex_match (lexer, T_ALL))
964 else if (lex_match_id (lexer, "CC"))
966 else if (lex_match_id (lexer, "WARRANTY"))
968 else if (lex_match_id (lexer, "COPYING") || lex_match_id (lexer, "LICENSE"))
970 else if (lex_token (lexer) == T_ID)
974 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
976 const struct show_sbc *sbc = &show_table[i];
977 if (lex_match_id (lexer, sbc->name))
983 lex_error (lexer, NULL);
990 lex_error (lexer, NULL);
994 lex_match (lexer, T_SLASH);
996 while (lex_token (lexer) != T_ENDCMD);
1001 #define MAX_SAVED_SETTINGS 5
1003 static struct settings *saved_settings[MAX_SAVED_SETTINGS];
1004 static int n_saved_settings;
1007 cmd_preserve (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
1009 if (n_saved_settings < MAX_SAVED_SETTINGS)
1011 saved_settings[n_saved_settings++] = settings_get ();
1016 msg (SE, _("Too many PRESERVE commands without a RESTORE: at most "
1017 "%d levels of saved settings are allowed."),
1018 MAX_SAVED_SETTINGS);
1019 return CMD_CASCADING_FAILURE;
1024 cmd_restore (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
1026 if (n_saved_settings > 0)
1028 struct settings *s = saved_settings[--n_saved_settings];
1030 settings_destroy (s);
1035 msg (SE, _("RESTORE without matching PRESERVE."));