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/>. */
24 #include "data/data-in.h"
25 #include "data/data-out.h"
26 #include "data/dataset.h"
27 #include "data/dictionary.h"
28 #include "data/format.h"
29 #include "data/settings.h"
30 #include "data/value.h"
31 #include "data/variable.h"
32 #include "language/command.h"
33 #include "language/lexer/format-parser.h"
34 #include "language/lexer/lexer.h"
35 #include "libpspp/compiler.h"
36 #include "libpspp/copyleft.h"
37 #include "libpspp/float-format.h"
38 #include "libpspp/i18n.h"
39 #include "libpspp/integer-format.h"
40 #include "libpspp/message.h"
41 #include "math/random.h"
42 #include "output/driver.h"
43 #include "output/journal.h"
48 #else /* !HAVE_TERMCAP_H */
49 int tgetent (char *, const char *);
50 int tgetnum (const char *);
51 #endif /* !HAVE_TERMCAP_H */
52 #endif /* !HAVE_LIBTERMCAP */
57 #define _(msgid) gettext (msgid)
62 block=string "x==1" "one character long";
63 boxstring=string "x==3 || x==11" "3 or 11 characters long";
64 case=size:upper/uplow;
70 compression=compress:on/off;
71 cpi=integer "x>0" "%s must be greater than 0";
72 decimal=dec:dot/comma;
76 headers=headers:no/yes/blank;
78 histogram=string "x==1" "one character long";
84 lowres=lores:auto/on/off;
85 lpi=integer "x>0" "%s must be greater than 0";
86 menus=menus:standard/extended;
89 miterate=integer "x>0" "%s must be greater than 0";
90 mnest=integer "x>0" "%s must be greater than 0";
92 mxerrs=integer "x >= 1" "%s must be at least 1";
93 mxloops=integer "x >=1" "%s must be at least 1";
98 rib=rib:msbfirst/lsbfirst/vax/native;
99 rrb=rrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
101 scompression=scompress:on/off;
102 scripttab=string "x==1" "one character long";
105 tb1=string "x==3 || x==11" "3 or 11 characters long";
107 undefined=undef:warn/nowarn;
108 wib=wib:msbfirst/lsbfirst/vax/native;
109 wrb=wrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
111 workspace=integer "x>0" "%s must be positive";
121 static enum integer_format stc_to_integer_format (int stc);
122 static enum float_format stc_to_float_format (int stc);
125 cmd_set (struct lexer *lexer, struct dataset *ds)
129 if (!parse_set (lexer, ds, &cmd, NULL))
136 settings_set_cc ( cmd.s_cca, FMT_CCA);
138 settings_set_cc ( cmd.s_ccb, FMT_CCB);
140 settings_set_cc ( cmd.s_ccc, FMT_CCC);
142 settings_set_cc ( cmd.s_ccd, FMT_CCD);
144 settings_set_cc ( cmd.s_cce, FMT_CCE);
147 settings_set_decimal_char (cmd.dec == STC_DOT ? '.' : ',');
150 settings_set_include (cmd.inc == STC_ON);
152 settings_set_max_messages (MSG_S_ERROR, cmd.n_mxerrs[0]);
155 if (cmd.n_mxloops[0] >= 1)
156 settings_set_mxloops (cmd.n_mxloops[0]);
158 msg (SE, _("%s must be at least 1."), "MXLOOPS");
161 settings_set_max_messages (MSG_S_WARNING, cmd.n_mxwarns[0]);
163 settings_set_input_integer_format (stc_to_integer_format (cmd.rib));
165 settings_set_input_float_format (stc_to_float_format (cmd.rrb));
167 settings_set_safer_mode ();
168 if (cmd.sbc_scompression)
169 settings_set_scompression (cmd.scompress == STC_ON);
170 if (cmd.sbc_undefined)
171 settings_set_undefined (cmd.undef == STC_WARN);
173 settings_set_output_integer_format (stc_to_integer_format (cmd.wib));
175 settings_set_output_float_format (stc_to_float_format (cmd.wrb));
176 if (cmd.sbc_workspace)
178 if ( cmd.n_workspace[0] < 1024 && ! settings_get_testing_mode ())
179 msg (SE, _("WORKSPACE must be at least 1MB"));
181 settings_set_workspace (cmd.n_workspace[0] * 1024L);
185 msg (SW, _("%s is obsolete."), "BLOCK");
186 if (cmd.sbc_boxstring)
187 msg (SW, _("%s is obsolete."), "BOXSTRING");
189 msg (SW, _("%s is obsolete."), "CPI");
190 if (cmd.sbc_histogram)
191 msg (SW, _("%s is obsolete."), "HISTOGRAM");
193 msg (SW, _("%s is obsolete."), "LPI");
195 msg (SW, _("%s is obsolete."), "MENUS");
197 msg (SW, _("%s is obsolete."), "XSORT");
198 if (cmd.sbc_mxmemory)
199 msg (SE, _("%s is obsolete."), "MXMEMORY");
200 if (cmd.sbc_scripttab)
201 msg (SE, _("%s is obsolete."), "SCRIPTTAB");
203 msg (SW, _("%s is obsolete."), "TBFONTS");
204 if (cmd.sbc_tb1 && cmd.s_tb1)
205 msg (SW, _("%s is obsolete."), "TB1");
208 msg (SW, _("%s is not yet implemented."), "CASE");
210 if (cmd.sbc_compression)
211 msg (SW, _("Active file compression is not implemented."));
218 /* Returns the integer_format value corresponding to STC,
219 which should be the value of cmd.rib or cmd.wib. */
220 static enum integer_format
221 stc_to_integer_format (int stc)
223 return (stc == STC_MSBFIRST ? INTEGER_MSB_FIRST
224 : stc == STC_LSBFIRST ? INTEGER_LSB_FIRST
225 : stc == STC_VAX ? INTEGER_VAX
229 /* Returns the float_format value corresponding to STC,
230 which should be the value of cmd.rrb or cmd.wrb. */
231 static enum float_format
232 stc_to_float_format (int stc)
237 return FLOAT_NATIVE_DOUBLE;
240 return FLOAT_IEEE_SINGLE_LE;
242 return FLOAT_IEEE_SINGLE_BE;
244 return FLOAT_IEEE_DOUBLE_LE;
246 return FLOAT_IEEE_DOUBLE_BE;
256 return FLOAT_Z_SHORT;
265 set_output_routing (struct lexer *lexer, enum settings_output_type type)
267 enum settings_output_devices devices;
269 lex_match (lexer, T_EQUALS);
270 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "BOTH"))
271 devices = SETTINGS_DEVICE_LISTING | SETTINGS_DEVICE_TERMINAL;
272 else if (lex_match_id (lexer, "TERMINAL"))
273 devices = SETTINGS_DEVICE_TERMINAL;
274 else if (lex_match_id (lexer, "LISTING"))
275 devices = SETTINGS_DEVICE_LISTING;
276 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NONE"))
280 lex_error (lexer, NULL);
284 settings_set_output_routing (type, devices);
289 /* Parses the BLANKS subcommand, which controls the value that
290 completely blank fields in numeric data imply. X, Wnd: Syntax is
291 SYSMIS or a numeric value. */
293 stc_custom_blanks (struct lexer *lexer,
294 struct dataset *ds UNUSED,
295 struct cmd_set *cmd UNUSED, void *aux UNUSED)
297 lex_match (lexer, T_EQUALS);
298 if (lex_match_id (lexer, "SYSMIS"))
301 settings_set_blanks (SYSMIS);
305 if (!lex_force_num (lexer))
307 settings_set_blanks (lex_number (lexer));
314 stc_custom_tnumbers (struct lexer *lexer,
315 struct dataset *ds UNUSED,
316 struct cmd_set *cmd UNUSED, void *aux UNUSED)
318 lex_match (lexer, T_EQUALS);
320 if (lex_match_id (lexer, "VALUES"))
322 settings_set_value_style (SETTINGS_VAL_STYLE_VALUES);
324 else if (lex_match_id (lexer, "LABELS"))
326 settings_set_value_style (SETTINGS_VAL_STYLE_LABELS);
328 else if (lex_match_id (lexer, "BOTH"))
330 settings_set_value_style (SETTINGS_VAL_STYLE_BOTH);
334 lex_error (lexer, _("expecting VALUES, LABELS or BOTH"));
342 /* Parses the EPOCH subcommand, which controls the epoch used for
343 parsing 2-digit years. */
345 stc_custom_epoch (struct lexer *lexer,
346 struct dataset *ds UNUSED,
347 struct cmd_set *cmd UNUSED, void *aux UNUSED)
349 lex_match (lexer, T_EQUALS);
350 if (lex_match_id (lexer, "AUTOMATIC"))
351 settings_set_epoch (-1);
352 else if (lex_is_integer (lexer))
354 int new_epoch = lex_integer (lexer);
356 if (new_epoch < 1500)
358 msg (SE, _("EPOCH must be 1500 or later."));
361 settings_set_epoch (new_epoch);
365 lex_error (lexer, _("expecting AUTOMATIC or year"));
373 stc_custom_errors (struct lexer *lexer, struct dataset *ds UNUSED,
374 struct cmd_set *cmd UNUSED, void *aux UNUSED)
376 return set_output_routing (lexer, SETTINGS_OUTPUT_ERROR);
380 stc_custom_length (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
384 lex_match (lexer, T_EQUALS);
385 if (lex_match_id (lexer, "NONE"))
389 if (!lex_force_int (lexer))
391 if (lex_integer (lexer) < 1)
393 msg (SE, _("LENGTH must be at least 1."));
396 page_length = lex_integer (lexer);
400 if (page_length != -1)
401 settings_set_viewlength (page_length);
407 stc_custom_locale (struct lexer *lexer, struct dataset *ds UNUSED,
408 struct cmd_set *cmd UNUSED, void *aux UNUSED)
412 lex_match (lexer, T_EQUALS);
414 if ( !lex_force_string (lexer))
417 s = lex_tokcstr (lexer);
419 /* First try this string as an encoding name */
420 if ( valid_encoding (s))
421 set_default_encoding (s);
423 /* Now try as a locale name (or alias) */
424 else if (set_encoding_from_locale (s))
429 msg (ME, _("%s is not a recognized encoding or locale name"), s);
439 stc_custom_messages (struct lexer *lexer, struct dataset *ds UNUSED,
440 struct cmd_set *cmd UNUSED, void *aux UNUSED)
442 return set_output_routing (lexer, SETTINGS_OUTPUT_NOTE);
446 stc_custom_printback (struct lexer *lexer, struct dataset *ds UNUSED,
447 struct cmd_set *cmd UNUSED, void *aux UNUSED)
449 return set_output_routing (lexer, SETTINGS_OUTPUT_SYNTAX);
453 stc_custom_results (struct lexer *lexer, struct dataset *ds UNUSED,
454 struct cmd_set *cmd UNUSED, void *aux UNUSED)
456 return set_output_routing (lexer, SETTINGS_OUTPUT_RESULT);
460 stc_custom_seed (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
462 lex_match (lexer, T_EQUALS);
463 if (lex_match_id (lexer, "RANDOM"))
467 if (!lex_force_num (lexer))
469 set_rng (lex_number (lexer));
477 stc_custom_width (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
479 lex_match (lexer, T_EQUALS);
480 if (lex_match_id (lexer, "NARROW"))
481 settings_set_viewwidth (79);
482 else if (lex_match_id (lexer, "WIDE"))
483 settings_set_viewwidth (131);
486 if (!lex_force_int (lexer))
488 if (lex_integer (lexer) < 40)
490 msg (SE, _("WIDTH must be at least 40."));
493 settings_set_viewwidth (lex_integer (lexer));
500 /* Parses FORMAT subcommand, which consists of a numeric format
503 stc_custom_format (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
507 lex_match (lexer, T_EQUALS);
508 if (!parse_format_specifier (lexer, &fmt))
511 if (!fmt_check_output (&fmt))
514 if (fmt_is_string (fmt.type))
516 char str[FMT_STRING_LEN_MAX + 1];
517 msg (SE, _("FORMAT requires numeric output format as an argument. "
518 "Specified format %s is of type string."),
519 fmt_to_string (&fmt, str));
523 settings_set_format (&fmt);
528 stc_custom_journal (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
530 lex_match (lexer, T_EQUALS);
531 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "YES"))
533 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NO"))
535 else if (lex_is_string (lexer) || lex_token (lexer) == T_ID)
537 char *filename = utf8_to_filename (lex_tokcstr (lexer));
538 journal_set_file_name (filename);
545 lex_error (lexer, NULL);
552 stc_custom_log (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
554 return stc_custom_journal (lexer, ds, cmd, aux);
558 show_output_routing (enum settings_output_type type)
560 enum settings_output_devices devices;
563 devices = settings_get_output_routing (type);
564 if (devices & SETTINGS_DEVICE_LISTING)
565 s = devices & SETTINGS_DEVICE_TERMINAL ? "BOTH" : "LISTING";
566 else if (devices & SETTINGS_DEVICE_TERMINAL)
575 show_blanks (const struct dataset *ds UNUSED)
577 return (settings_get_blanks () == SYSMIS
579 : xasprintf ("%g", settings_get_blanks ()));
583 format_cc (struct string *out, const char *in, char grouping)
588 if (c == grouping || c == '\'')
589 ds_put_byte (out, '\'');
591 ds_put_byte (out, '"');
592 ds_put_byte (out, c);
597 show_cc (enum fmt_type type)
599 const struct fmt_number_style *cc = settings_get_style (type);
602 ds_init_empty (&out);
603 format_cc (&out, cc->neg_prefix.s, cc->grouping);
604 ds_put_byte (&out, cc->grouping);
605 format_cc (&out, cc->prefix.s, cc->grouping);
606 ds_put_byte (&out, cc->grouping);
607 format_cc (&out, cc->suffix.s, cc->grouping);
608 ds_put_byte (&out, cc->grouping);
609 format_cc (&out, cc->neg_suffix.s, cc->grouping);
611 return ds_cstr (&out);
615 show_cca (const struct dataset *ds UNUSED)
617 return show_cc (FMT_CCA);
621 show_ccb (const struct dataset *ds UNUSED)
623 return show_cc (FMT_CCB);
627 show_ccc (const struct dataset *ds UNUSED)
629 return show_cc (FMT_CCC);
633 show_ccd (const struct dataset *ds UNUSED)
635 return show_cc (FMT_CCD);
639 show_cce (const struct dataset *ds UNUSED)
641 return show_cc (FMT_CCE);
645 show_decimals (const struct dataset *ds UNUSED)
647 return xasprintf ("`%c'", settings_get_decimal_char (FMT_F));
651 show_errors (const struct dataset *ds UNUSED)
653 return show_output_routing (SETTINGS_OUTPUT_ERROR);
657 show_format (const struct dataset *ds UNUSED)
659 char str[FMT_STRING_LEN_MAX + 1];
660 return xstrdup (fmt_to_string (settings_get_format (), str));
664 show_length (const struct dataset *ds UNUSED)
666 return xasprintf ("%d", settings_get_viewlength ());
670 show_locale (const struct dataset *ds UNUSED)
672 return xstrdup (get_default_encoding ());
676 show_messages (const struct dataset *ds UNUSED)
678 return show_output_routing (SETTINGS_OUTPUT_NOTE);
682 show_printback (const struct dataset *ds UNUSED)
684 return show_output_routing (SETTINGS_OUTPUT_SYNTAX);
688 show_results (const struct dataset *ds UNUSED)
690 return show_output_routing (SETTINGS_OUTPUT_RESULT);
694 show_mxerrs (const struct dataset *ds UNUSED)
696 return xasprintf ("%d", settings_get_max_messages (MSG_S_ERROR));
700 show_mxloops (const struct dataset *ds UNUSED)
702 return xasprintf ("%d", settings_get_mxloops ());
706 show_mxwarns (const struct dataset *ds UNUSED)
708 return xasprintf ("%d", settings_get_max_messages (MSG_S_WARNING));
711 /* Returns a name for the given INTEGER_FORMAT value. */
713 show_integer_format (enum integer_format integer_format)
715 return xasprintf ("%s (%s)",
716 (integer_format == INTEGER_MSB_FIRST ? "MSBFIRST"
717 : integer_format == INTEGER_LSB_FIRST ? "LSBFIRST"
719 integer_format == INTEGER_NATIVE ? "NATIVE" : "nonnative");
722 /* Returns a name for the given FLOAT_FORMAT value. */
724 show_float_format (enum float_format float_format)
726 const char *format_name = "";
728 switch (float_format)
730 case FLOAT_IEEE_SINGLE_LE:
731 format_name = _("ISL (32-bit IEEE 754 single, little-endian)");
733 case FLOAT_IEEE_SINGLE_BE:
734 format_name = _("ISB (32-bit IEEE 754 single, big-endian)");
736 case FLOAT_IEEE_DOUBLE_LE:
737 format_name = _("IDL (64-bit IEEE 754 double, little-endian)");
739 case FLOAT_IEEE_DOUBLE_BE:
740 format_name = _("IDB (64-bit IEEE 754 double, big-endian)");
744 format_name = _("VF (32-bit VAX F, VAX-endian)");
747 format_name = _("VD (64-bit VAX D, VAX-endian)");
750 format_name = _("VG (64-bit VAX G, VAX-endian)");
754 format_name = _("ZS (32-bit IBM Z hexadecimal short, big-endian)");
757 format_name = _("ZL (64-bit IBM Z hexadecimal long, big-endian)");
765 return xasprintf ("%s (%s)", format_name,
766 (float_format == FLOAT_NATIVE_DOUBLE
767 ? "NATIVE" : "nonnative"));
771 show_rib (const struct dataset *ds UNUSED)
773 return show_integer_format (settings_get_input_integer_format ());
777 show_rrb (const struct dataset *ds UNUSED)
779 return show_float_format (settings_get_input_float_format ());
783 show_scompression (const struct dataset *ds UNUSED)
785 return xstrdup (settings_get_scompression () ? "ON" : "OFF");
789 show_undefined (const struct dataset *ds UNUSED)
791 return xstrdup (settings_get_undefined () ? "WARN" : "NOWARN");
795 show_weight (const struct dataset *ds)
797 const struct variable *var = dict_get_weight (dataset_dict (ds));
798 return xstrdup (var != NULL ? var_get_name (var) : "OFF");
802 show_wib (const struct dataset *ds UNUSED)
804 return show_integer_format (settings_get_output_integer_format ());
808 show_wrb (const struct dataset *ds UNUSED)
810 return show_float_format (settings_get_output_float_format ());
814 show_width (const struct dataset *ds UNUSED)
816 return xasprintf ("%d", settings_get_viewwidth ());
822 char *(*function) (const struct dataset *);
825 const struct show_sbc show_table[] =
827 {"BLANKS", show_blanks},
833 {"DECIMALS", show_decimals},
834 {"ERRORS", show_errors},
835 {"FORMAT", show_format},
836 {"LENGTH", show_length},
837 {"LOCALE", show_locale},
838 {"MESSAGES", show_messages},
839 {"MXERRS", show_mxerrs},
840 {"MXLOOPS", show_mxloops},
841 {"MXWARNS", show_mxwarns},
842 {"PRINTBACk", show_printback},
843 {"RESULTS", show_results},
846 {"SCOMPRESSION", show_scompression},
847 {"UNDEFINED", show_undefined},
848 {"WEIGHT", show_weight},
851 {"WIDTH", show_width},
855 do_show (const struct dataset *ds, const struct show_sbc *sbc)
857 char *value = sbc->function (ds);
858 msg (SN, _("%s is %s."), sbc->name, value);
863 show_all (const struct dataset *ds)
867 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
868 do_show (ds, &show_table[i]);
872 show_all_cc (const struct dataset *ds)
876 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
878 const struct show_sbc *sbc = &show_table[i];
879 if (!strncmp (sbc->name, "CC", 2))
885 show_warranty (const struct dataset *ds UNUSED)
887 fputs (lack_of_warranty, stdout);
891 show_copying (const struct dataset *ds UNUSED)
893 fputs (copyleft, stdout);
897 cmd_show (struct lexer *lexer, struct dataset *ds)
899 if (lex_token (lexer) == T_ENDCMD)
907 if (lex_match (lexer, T_ALL))
909 else if (lex_match_id (lexer, "CC"))
911 else if (lex_match_id (lexer, "WARRANTY"))
913 else if (lex_match_id (lexer, "COPYING"))
915 else if (lex_token (lexer) == T_ID)
919 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
921 const struct show_sbc *sbc = &show_table[i];
922 if (lex_match_id (lexer, sbc->name))
928 lex_error (lexer, NULL);
935 lex_error (lexer, NULL);
939 lex_match (lexer, T_SLASH);
941 while (lex_token (lexer) != T_ENDCMD);
946 #define MAX_SAVED_SETTINGS 5
948 static struct settings *saved_settings[MAX_SAVED_SETTINGS];
949 static int n_saved_settings;
952 cmd_preserve (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
954 if (n_saved_settings < MAX_SAVED_SETTINGS)
956 saved_settings[n_saved_settings++] = settings_get ();
961 msg (SE, _("Too many PRESERVE commands without a RESTORE: at most "
962 "%d levels of saved settings are allowed."),
964 return CMD_CASCADING_FAILURE;
969 cmd_restore (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
971 if (n_saved_settings > 0)
973 struct settings *s = saved_settings[--n_saved_settings];
975 settings_destroy (s);
980 msg (SE, _("RESTORE without matching PRESERVE."));