1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006 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/dictionary.h>
27 #include <data/format.h>
28 #include <data/procedure.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 <language/prompt.h>
36 #include <libpspp/alloc.h>
37 #include <libpspp/compiler.h>
38 #include <libpspp/copyleft.h>
39 #include <libpspp/float-format.h>
40 #include <libpspp/integer-format.h>
41 #include <libpspp/message.h>
42 #include <math/random.h>
43 #include <output/journal.h>
44 #include <output/output.h>
49 #else /* !HAVE_TERMCAP_H */
50 int tgetent (char *, const char *);
51 int tgetnum (const char *);
52 #endif /* !HAVE_TERMCAP_H */
53 #endif /* !HAVE_LIBTERMCAP */
56 #define _(msgid) gettext (msgid)
61 block=string "x==1" "one character long";
62 boxstring=string "x==3 || x==11" "3 or 11 characters long";
63 case=size:upper/uplow;
69 compression=compress:on/off;
70 cpi=integer "x>0" "%s must be greater than 0";
72 decimal=dec:dot/comma;
76 endcmd=string "x==1" "one character long";
78 errorbreak=errbrk:on/off;
79 errors=errors:terminal/listing/both/on/none/off;
81 headers=headers:no/yes/blank;
83 histogram=string "x==1" "one character long";
89 lowres=lores:auto/on/off;
90 lpi=integer "x>0" "%s must be greater than 0";
91 menus=menus:standard/extended;
92 messages=messages:on/off/terminal/listing/both/on/none/off;
94 miterate=integer "x>0" "%s must be greater than 0";
95 mnest=integer "x>0" "%s must be greater than 0";
97 mxerrs=integer "x >= 1" "%s must be at least 1";
98 mxloops=integer "x >=1" "%s must be at least 1";
102 printback=prtbck:on/off;
104 results=res:on/off/terminal/listing/both/on/none/off;
105 rib=rib:msbfirst/lsbfirst/vax/native;
106 rrb=rrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
108 scompression=scompress:on/off;
109 scripttab=string "x==1" "one character long";
111 tb1=string "x==3 || x==11" "3 or 11 characters long";
113 undefined=undef:warn/nowarn;
114 wib=wib:msbfirst/lsbfirst/vax/native;
115 wrb=wrb:native/isl/isb/idl/idb/vf/vd/vg/zs/zl;
117 workspace=integer "x>=1024" "%s must be at least 1 MB";
127 static bool do_cc (const char *cc_string, enum fmt_type);
128 static enum integer_format stc_to_integer_format (int stc);
129 static enum float_format stc_to_float_format (int stc);
132 cmd_set (struct lexer *lexer, struct dataset *ds)
136 if (!parse_set (lexer, ds, &cmd, NULL))
143 do_cc (cmd.s_cca, FMT_CCA);
145 do_cc (cmd.s_ccb, FMT_CCB);
147 do_cc (cmd.s_ccc, FMT_CCC);
149 do_cc (cmd.s_ccd, FMT_CCD);
151 do_cc (cmd.s_cce, FMT_CCE);
154 prompt_set (PROMPT_FIRST, cmd.s_prompt);
156 prompt_set (PROMPT_LATER, cmd.s_cprompt);
158 prompt_set (PROMPT_DATA, cmd.s_dprompt);
161 fmt_set_decimal (cmd.dec == STC_DOT ? '.' : ',');
163 set_echo (cmd.echo == STC_ON);
165 set_endcmd (cmd.s_endcmd[0]);
166 if (cmd.sbc_errorbreak)
167 set_errorbreak (cmd.errbrk == STC_ON);
170 bool both = cmd.errors == STC_BOTH || cmd.errors == STC_ON;
171 set_error_routing_to_terminal (cmd.errors == STC_TERMINAL || both);
172 set_error_routing_to_listing (cmd.errors == STC_LISTING || both);
175 set_include (cmd.inc == STC_ON);
177 set_mxerrs (cmd.n_mxerrs[0]);
179 set_mxwarns (cmd.n_mxwarns[0]);
181 set_nulline (cmd.null == STC_ON);
183 data_in_set_integer_format (stc_to_integer_format (cmd.rib));
185 data_in_set_float_format (stc_to_float_format (cmd.rrb));
188 if (cmd.sbc_scompression)
189 set_scompression (cmd.scompress == STC_ON);
190 if (cmd.sbc_undefined)
191 set_undefined (cmd.undef == STC_WARN);
193 data_out_set_integer_format (stc_to_integer_format (cmd.wib));
195 data_out_set_float_format (stc_to_float_format (cmd.wrb));
196 if (cmd.sbc_workspace)
197 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");
203 if (cmd.sbc_histogram)
204 msg (SW, _("%s is obsolete."), "HISTOGRAM");
206 msg (SW, _("%s is obsolete."), "MENUS");
208 msg (SW, _("%s is obsolete."), "XSORT");
209 if (cmd.sbc_mxmemory)
210 msg (SE, _("%s is obsolete."), "MXMEMORY");
211 if (cmd.sbc_scripttab)
212 msg (SE, _("%s is obsolete."), "SCRIPTTAB");
214 msg (SW, _("%s is obsolete."), "TBFONTS");
215 if (cmd.sbc_tb1 && cmd.s_tb1)
216 msg (SW, _("%s is obsolete."), "TB1");
219 msg (SW, _("%s is not implemented."), "CASE");
221 if (cmd.sbc_compression)
222 msg (SW, _("Active file compression is not implemented."));
229 /* Returns the integer_format value corresponding to STC,
230 which should be the value of cmd.rib or cmd.wib. */
231 static enum integer_format
232 stc_to_integer_format (int stc)
234 return (stc == STC_MSBFIRST ? INTEGER_MSB_FIRST
235 : stc == STC_LSBFIRST ? INTEGER_LSB_FIRST
236 : stc == STC_VAX ? INTEGER_VAX
240 /* Returns the float_format value corresponding to STC,
241 which should be the value of cmd.rrb or cmd.wrb. */
242 static enum float_format
243 stc_to_float_format (int stc)
248 return FLOAT_NATIVE_DOUBLE;
251 return FLOAT_IEEE_SINGLE_LE;
253 return FLOAT_IEEE_SINGLE_BE;
255 return FLOAT_IEEE_DOUBLE_LE;
257 return FLOAT_IEEE_DOUBLE_BE;
267 return FLOAT_Z_SHORT;
275 /* Find the grouping characters in CC_STRING and set CC's
276 grouping and decimal members appropriately. Returns true if
277 successful, false otherwise. */
279 find_cc_separators (const char *cc_string, struct fmt_number_style *cc)
282 int comma_cnt, dot_cnt;
284 /* Count commas and periods. There must be exactly three of
285 one or the other, except that an apostrophe escapes a
286 following comma or period. */
287 comma_cnt = dot_cnt = 0;
288 for (sp = cc_string; *sp; sp++)
293 else if (*sp == '\'' && (sp[1] == '.' || sp[1] == ',' || sp[1] == '\''))
296 if ((comma_cnt == 3) == (dot_cnt == 3))
312 /* Extracts a token from IN into a newly allocated AFFIX. Tokens
313 are delimited by GROUPING. The token is truncated to at most
314 FMT_STYLE_AFFIX_MAX characters. Returns the first character
315 following the token. */
317 extract_cc_token (const char *in, int grouping, struct substring *affix)
320 ss_alloc_uninit (affix, FMT_STYLE_AFFIX_MAX);
321 for (; *in != '\0' && *in != grouping; in++)
323 if (*in == '\'' && in[1] == grouping)
325 if (ofs < FMT_STYLE_AFFIX_MAX)
326 ss_data (*affix)[ofs++] = *in;
335 /* Sets custom currency specifier CC having name CC_NAME ('A' through
336 'E') to correspond to the settings in CC_STRING. */
338 do_cc (const char *cc_string, enum fmt_type type)
340 struct fmt_number_style *cc = fmt_number_style_create ();
342 /* Determine separators. */
343 if (!find_cc_separators (cc_string, cc))
345 fmt_number_style_destroy (cc);
346 msg (SE, _("%s: Custom currency string `%s' does not contain "
347 "exactly three periods or commas (or it contains both)."),
348 fmt_name (type), cc_string);
352 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->neg_prefix);
353 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->prefix);
354 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->suffix);
355 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->neg_suffix);
357 fmt_set_style (type, cc);
362 /* Parses the BLANKS subcommand, which controls the value that
363 completely blank fields in numeric data imply. X, Wnd: Syntax is
364 SYSMIS or a numeric value. */
366 stc_custom_blanks (struct lexer *lexer,
367 struct dataset *ds UNUSED,
368 struct cmd_set *cmd UNUSED, void *aux UNUSED)
370 lex_match (lexer, '=');
371 if (lex_match_id (lexer, "SYSMIS"))
378 if (!lex_force_num (lexer))
380 set_blanks (lex_number (lexer));
386 /* Parses the EPOCH subcommand, which controls the epoch used for
387 parsing 2-digit years. */
389 stc_custom_epoch (struct lexer *lexer,
390 struct dataset *ds UNUSED,
391 struct cmd_set *cmd UNUSED, void *aux UNUSED)
393 lex_match (lexer, '=');
394 if (lex_match_id (lexer, "AUTOMATIC"))
396 else if (lex_is_integer (lexer))
398 int new_epoch = lex_integer (lexer);
400 if (new_epoch < 1500)
402 msg (SE, _("EPOCH must be 1500 or later."));
405 set_epoch (new_epoch);
409 lex_error (lexer, _("expecting AUTOMATIC or year"));
417 stc_custom_length (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
421 lex_match (lexer, '=');
422 if (lex_match_id (lexer, "NONE"))
426 if (!lex_force_int (lexer))
428 if (lex_integer (lexer) < 1)
430 msg (SE, _("LENGTH must be at least 1."));
433 page_length = lex_integer (lexer);
437 if (page_length != -1)
438 set_viewlength (page_length);
444 stc_custom_seed (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
446 lex_match (lexer, '=');
447 if (lex_match_id (lexer, "RANDOM"))
451 if (!lex_force_num (lexer))
453 set_rng (lex_number (lexer));
461 stc_custom_width (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
463 lex_match (lexer, '=');
464 if (lex_match_id (lexer, "NARROW"))
466 else if (lex_match_id (lexer, "WIDE"))
470 if (!lex_force_int (lexer))
472 if (lex_integer (lexer) < 40)
474 msg (SE, _("WIDTH must be at least 40."));
477 set_viewwidth (lex_integer (lexer));
484 /* Parses FORMAT subcommand, which consists of a numeric format
487 stc_custom_format (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
491 lex_match (lexer, '=');
492 if (!parse_format_specifier (lexer, &fmt))
494 if (fmt_is_string (fmt.type))
496 char str[FMT_STRING_LEN_MAX + 1];
497 msg (SE, _("FORMAT requires numeric output format as an argument. "
498 "Specified format %s is of type string."),
499 fmt_to_string (&fmt, str));
508 stc_custom_journal (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
510 lex_match (lexer, '=');
511 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "YES"))
513 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NO"))
515 else if (lex_token (lexer) == T_STRING || lex_token (lexer) == T_ID)
517 journal_set_file_name (ds_cstr (lex_tokstr (lexer)));
522 lex_error (lexer, NULL);
529 stc_custom_log (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
531 return stc_custom_journal (lexer, ds, cmd, aux);
535 stc_custom_listing (struct lexer *lexer, struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
539 lex_match (lexer, '=');
540 if (lex_match_id (lexer, "ON") || lex_match_id (lexer, "YES"))
542 else if (lex_match_id (lexer, "OFF") || lex_match_id (lexer, "NO"))
549 outp_enable_device (listing, OUTP_DEV_LISTING);
555 stc_custom_disk (struct lexer *lexer, struct dataset *ds, struct cmd_set *cmd UNUSED, void *aux)
557 return stc_custom_listing (lexer, ds, cmd, aux);
561 show_blanks (const struct dataset *ds UNUSED)
563 if (get_blanks () == SYSMIS)
564 msg (SN, _("BLANKS is SYSMIS."));
566 msg (SN, _("BLANKS is %g."), get_blanks ());
571 format_cc (struct substring in, char grouping, char *out)
573 while (!ss_is_empty (in))
575 char c = ss_get_char (&in);
576 if (c == grouping || c == '\'')
586 show_cc (enum fmt_type type)
588 const struct fmt_number_style *cc = fmt_get_style (type);
589 char cc_string[FMT_STYLE_AFFIX_MAX * 4 * 2 + 3 + 1];
592 out = format_cc (cc->neg_prefix, cc->grouping, cc_string);
593 *out++ = cc->grouping;
594 out = format_cc (cc->prefix, cc->grouping, out);
595 *out++ = cc->grouping;
596 out = format_cc (cc->suffix, cc->grouping, out);
597 *out++ = cc->grouping;
598 out = format_cc (cc->neg_suffix, cc->grouping, out);
601 msg (SN, _("%s is \"%s\"."), fmt_name (type), cc_string);
605 show_cca (const struct dataset *ds UNUSED)
611 show_ccb (const struct dataset *ds UNUSED)
617 show_ccc (const struct dataset *ds UNUSED)
623 show_ccd (const struct dataset *ds UNUSED)
629 show_cce (const struct dataset *ds UNUSED)
635 show_decimals (const struct dataset *ds UNUSED)
637 msg (SN, _("DECIMAL is \"%c\"."), fmt_decimal_char (FMT_F));
641 show_endcmd (const struct dataset *ds UNUSED)
643 msg (SN, _("ENDCMD is \"%c\"."), get_endcmd ());
647 show_errors (const struct dataset *ds UNUSED)
649 bool terminal = get_error_routing_to_terminal ();
650 bool listing = get_error_routing_to_listing ();
651 msg (SN, _("ERRORS is \"%s\"."),
652 terminal && listing ? "BOTH"
653 : terminal ? "TERMINAL"
654 : listing ? "LISTING"
659 show_format (const struct dataset *ds UNUSED)
661 char str[FMT_STRING_LEN_MAX + 1];
662 msg (SN, _("FORMAT is %s."), fmt_to_string (get_format (), str));
666 show_length (const struct dataset *ds UNUSED)
668 msg (SN, _("LENGTH is %d."), get_viewlength ());
672 show_mxerrs (const struct dataset *ds UNUSED)
674 msg (SN, _("MXERRS is %d."), get_mxerrs ());
678 show_mxloops (const struct dataset *ds UNUSED)
680 msg (SN, _("MXLOOPS is %d."), get_mxloops ());
684 show_mxwarns (const struct dataset *ds UNUSED)
686 msg (SN, _("MXWARNS is %d."), get_mxwarns ());
689 /* Outputs that SETTING has the given INTEGER_FORMAT value. */
691 show_integer_format (const char *setting, enum integer_format integer_format)
693 msg (SN, _("%s is %s (%s)."),
695 (integer_format == INTEGER_MSB_FIRST ? "MSBFIRST"
696 : integer_format == INTEGER_LSB_FIRST ? "LSBFIRST"
698 integer_format == INTEGER_NATIVE ? "NATIVE" : "nonnative");
701 /* Outputs that SETTING has the given FLOAT_FORMAT value. */
703 show_float_format (const char *setting, enum float_format float_format)
705 const char *format_name = "";
707 switch (float_format)
709 case FLOAT_IEEE_SINGLE_LE:
710 format_name = "ISL (32-bit IEEE 754 single, little-endian)";
712 case FLOAT_IEEE_SINGLE_BE:
713 format_name = "ISB (32-bit IEEE 754 single, big-endian)";
715 case FLOAT_IEEE_DOUBLE_LE:
716 format_name = "IDL (64-bit IEEE 754 double, little-endian)";
718 case FLOAT_IEEE_DOUBLE_BE:
719 format_name = "IDB (64-bit IEEE 754 double, big-endian)";
723 format_name = "VF (32-bit VAX F, VAX-endian)";
726 format_name = "VD (64-bit VAX D, VAX-endian)";
729 format_name = "VG (64-bit VAX G, VAX-endian)";
733 format_name = "ZS (32-bit IBM Z hexadecimal short, big-endian)";
736 format_name = "ZL (64-bit IBM Z hexadecimal long, big-endian)";
744 msg (SN, _("%s is %s (%s)."),
745 setting, format_name,
746 float_format == FLOAT_NATIVE_DOUBLE ? "NATIVE" : "nonnative");
750 show_rib (const struct dataset *ds UNUSED)
752 show_integer_format ("RIB", data_in_get_integer_format ());
756 show_rrb (const struct dataset *ds UNUSED)
758 show_float_format ("RRB", data_in_get_float_format ());
762 show_scompression (const struct dataset *ds UNUSED)
764 if (get_scompression ())
765 msg (SN, _("SCOMPRESSION is ON."));
767 msg (SN, _("SCOMPRESSION is OFF."));
771 show_undefined (const struct dataset *ds UNUSED)
773 if (get_undefined ())
774 msg (SN, _("UNDEFINED is WARN."));
776 msg (SN, _("UNDEFINED is NOWARN."));
780 show_weight (const struct dataset *ds)
782 struct variable *var = dict_get_weight (dataset_dict (ds));
784 msg (SN, _("WEIGHT is off."));
786 msg (SN, _("WEIGHT is variable %s."), var_get_name (var));
790 show_wib (const struct dataset *ds UNUSED)
792 show_integer_format ("WIB", data_out_get_integer_format ());
796 show_wrb (const struct dataset *ds UNUSED)
798 show_float_format ("WRB", data_out_get_float_format ());
802 show_width (const struct dataset *ds UNUSED)
804 msg (SN, _("WIDTH is %d."), get_viewwidth ());
810 void (*function) (const struct dataset *);
813 const struct show_sbc show_table[] =
815 {"BLANKS", show_blanks},
821 {"DECIMALS", show_decimals},
822 {"ENDCMD", show_endcmd},
823 {"ERRORS", show_errors},
824 {"FORMAT", show_format},
825 {"LENGTH", show_length},
826 {"MXERRS", show_mxerrs},
827 {"MXLOOPS", show_mxloops},
828 {"MXWARNS", show_mxwarns},
831 {"SCOMPRESSION", show_scompression},
832 {"UNDEFINED", show_undefined},
833 {"WEIGHT", show_weight},
836 {"WIDTH", show_width},
840 show_all (const struct dataset *ds)
844 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
845 show_table[i].function (ds);
853 for (i = 0; i < 5; i++)
858 show_warranty (const struct dataset *ds UNUSED)
860 fputs (lack_of_warranty, stdout);
864 show_copying (const struct dataset *ds UNUSED)
866 fputs (copyleft, stdout);
870 cmd_show (struct lexer *lexer, struct dataset *ds)
872 if (lex_token (lexer) == '.')
880 if (lex_match (lexer, T_ALL))
882 else if (lex_match_id (lexer, "CC"))
884 else if (lex_match_id (lexer, "WARRANTY"))
886 else if (lex_match_id (lexer, "COPYING"))
888 else if (lex_token (lexer) == T_ID)
892 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
893 if (lex_match_id (lexer, show_table[i].name))
895 show_table[i].function (ds);
898 lex_error (lexer, NULL);
905 lex_error (lexer, NULL);
909 lex_match (lexer, '/');
911 while (lex_token (lexer) != '.');