1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA
27 #include <data/dictionary.h>
28 #include <data/format.h>
29 #include <data/procedure.h>
30 #include <data/settings.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/line-buffer.h>
36 #include <libpspp/alloc.h>
37 #include <libpspp/compiler.h>
38 #include <libpspp/copyleft.h>
39 #include <libpspp/magic.h>
40 #include <libpspp/message.h>
41 #include <math/random.h>
42 #include <output/output.h>
47 #else /* !HAVE_TERMCAP_H */
48 int tgetent (char *, const char *);
49 int tgetnum (const char *);
50 #endif /* !HAVE_TERMCAP_H */
51 #endif /* !HAVE_LIBTERMCAP */
54 #define _(msgid) gettext (msgid)
59 block=string "x==1" "one character long";
60 boxstring=string "x==3 || x==11" "3 or 11 characters long";
61 case=size:upper/uplow;
67 compression=compress:on/off;
68 cpi=integer "x>0" "%s must be greater than 0";
70 decimal=dec:dot/comma;
74 endcmd=string "x==1" "one character long";
76 errorbreak=errbrk:on/off;
77 errors=errors:terminal/listing/both/on/none/off;
79 headers=headers:no/yes/blank;
81 histogram=string "x==1" "one character long";
86 lowres=lores:auto/on/off;
87 lpi=integer "x>0" "%s must be greater than 0";
88 menus=menus:standard/extended;
89 messages=messages:on/off/terminal/listing/both/on/none/off;
91 miterate=integer "x>0" "%s must be greater than 0";
92 mnest=integer "x>0" "%s must be greater than 0";
94 mxerrs=integer "x >= 1" "%s must be at least 1";
95 mxloops=integer "x >=1" "%s must be at least 1";
99 printback=prtbck:on/off;
101 results=res:on/off/terminal/listing/both/on/none/off;
103 scompression=scompress:on/off;
104 scripttab=string "x==1" "one character long";
106 tb1=string "x==3 || x==11" "3 or 11 characters long";
108 undefined=undef:warn/nowarn;
110 workspace=integer "x>=1024" "%s must be at least 1 MB";
120 static bool do_cc (const char *cc_string, enum fmt_type);
123 cmd_set (struct dataset *ds)
127 if (!parse_set (ds, &cmd, NULL))
131 do_cc (cmd.s_cca, FMT_CCA);
133 do_cc (cmd.s_ccb, FMT_CCB);
135 do_cc (cmd.s_ccc, FMT_CCC);
137 do_cc (cmd.s_ccd, FMT_CCD);
139 do_cc (cmd.s_cce, FMT_CCE);
142 getl_set_prompt (GETL_PROMPT_FIRST, cmd.s_prompt);
144 getl_set_prompt (GETL_PROMPT_LATER, cmd.s_cprompt);
146 getl_set_prompt (GETL_PROMPT_DATA, cmd.s_dprompt);
149 fmt_set_decimal (cmd.dec == STC_DOT ? '.' : ',');
151 set_echo (cmd.echo == STC_ON);
153 set_endcmd (cmd.s_endcmd[0]);
154 if (cmd.sbc_errorbreak)
155 set_errorbreak (cmd.errbrk == STC_ON);
158 bool both = cmd.errors == STC_BOTH || cmd.errors == STC_ON;
159 set_error_routing_to_terminal (cmd.errors == STC_TERMINAL || both);
160 set_error_routing_to_listing (cmd.errors == STC_LISTING || both);
163 set_include (cmd.inc == STC_ON);
165 set_mxerrs (cmd.n_mxerrs[0]);
167 set_mxwarns (cmd.n_mxwarns[0]);
169 set_nulline (cmd.null == STC_ON);
172 if (cmd.sbc_scompression)
173 set_scompression (cmd.scompress == STC_ON);
174 if (cmd.sbc_undefined)
175 set_undefined (cmd.undef == STC_WARN);
176 if (cmd.sbc_workspace)
177 set_workspace (cmd.n_workspace[0] * 1024L);
180 msg (SW, _("%s is obsolete."), "BLOCK");
181 if (cmd.sbc_boxstring)
182 msg (SW, _("%s is obsolete."), "BOXSTRING");
183 if (cmd.sbc_histogram)
184 msg (SW, _("%s is obsolete."), "HISTOGRAM");
186 msg (SW, _("%s is obsolete."), "MENUS");
188 msg (SW, _("%s is obsolete."), "XSORT");
189 if (cmd.sbc_mxmemory)
190 msg (SE, _("%s is obsolete."), "MXMEMORY");
191 if (cmd.sbc_scripttab)
192 msg (SE, _("%s is obsolete."), "SCRIPTTAB");
194 msg (SW, _("%s is obsolete."), "TBFONTS");
195 if (cmd.sbc_tb1 && cmd.s_tb1)
196 msg (SW, _("%s is obsolete."), "TB1");
199 msg (SW, _("%s is not implemented."), "CASE");
201 if (cmd.sbc_compression)
202 msg (SW, _("Active file compression is not implemented."));
207 /* Find the grouping characters in CC_STRING and set CC's
208 grouping and decimal members appropriately. Returns true if
209 successful, false otherwise. */
211 find_cc_separators (const char *cc_string, struct fmt_number_style *cc)
214 int comma_cnt, dot_cnt;
216 /* Count commas and periods. There must be exactly three of
217 one or the other, except that an apostrophe escapes a
218 following comma or period. */
219 comma_cnt = dot_cnt = 0;
220 for (sp = cc_string; *sp; sp++)
225 else if (*sp == '\'' && (sp[1] == '.' || sp[1] == ',' || sp[1] == '\''))
228 if ((comma_cnt == 3) == (dot_cnt == 3))
244 /* Extracts a token from IN into a newly allocated AFFIX. Tokens
245 are delimited by GROUPING. The token is truncated to at most
246 FMT_STYLE_AFFIX_MAX characters. Returns the first character
247 following the token. */
249 extract_cc_token (const char *in, int grouping, struct substring *affix)
252 ss_alloc_uninit (affix, FMT_STYLE_AFFIX_MAX);
253 for (; *in != '\0' && *in != grouping; in++)
255 if (*in == '\'' && in[1] == grouping)
257 if (ofs < FMT_STYLE_AFFIX_MAX)
258 ss_data (*affix)[ofs++] = *in;
267 /* Sets custom currency specifier CC having name CC_NAME ('A' through
268 'E') to correspond to the settings in CC_STRING. */
270 do_cc (const char *cc_string, enum fmt_type type)
272 struct fmt_number_style *cc = fmt_number_style_create ();
274 /* Determine separators. */
275 if (!find_cc_separators (cc_string, cc))
277 fmt_number_style_destroy (cc);
278 msg (SE, _("%s: Custom currency string `%s' does not contain "
279 "exactly three periods or commas (or it contains both)."),
280 fmt_name (type), cc_string);
284 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->neg_prefix);
285 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->prefix);
286 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->suffix);
287 cc_string = extract_cc_token (cc_string, cc->grouping, &cc->neg_suffix);
289 fmt_set_style (type, cc);
294 /* Parses the BLANKS subcommand, which controls the value that
295 completely blank fields in numeric data imply. X, Wnd: Syntax is
296 SYSMIS or a numeric value. */
298 stc_custom_blanks (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
301 if ((token == T_ID && lex_id_match ("SYSMIS", tokid)))
308 if (!lex_force_num ())
310 set_blanks (lex_number ());
316 /* Parses the EPOCH subcommand, which controls the epoch used for
317 parsing 2-digit years. */
319 stc_custom_epoch (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
322 if (lex_match_id ("AUTOMATIC"))
324 else if (lex_is_integer ())
326 int new_epoch = lex_integer ();
328 if (new_epoch < 1500)
330 msg (SE, _("EPOCH must be 1500 or later."));
333 set_epoch (new_epoch);
337 lex_error (_("expecting AUTOMATIC or year"));
345 stc_custom_length (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
350 if (lex_match_id ("NONE"))
354 if (!lex_force_int ())
356 if (lex_integer () < 1)
358 msg (SE, _("LENGTH must be at least 1."));
361 page_length = lex_integer ();
365 if (page_length != -1)
366 set_viewlength (page_length);
372 stc_custom_seed (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
375 if (lex_match_id ("RANDOM"))
379 if (!lex_force_num ())
381 set_rng (lex_number ());
389 stc_custom_width (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
392 if (lex_match_id ("NARROW"))
394 else if (lex_match_id ("WIDE"))
398 if (!lex_force_int ())
400 if (lex_integer () < 40)
402 msg (SE, _("WIDTH must be at least 40."));
405 set_viewwidth (lex_integer ());
412 /* Parses FORMAT subcommand, which consists of a numeric format
415 stc_custom_format (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
420 if (!parse_format_specifier (&fmt))
422 if (fmt_is_string (fmt.type))
424 char str[FMT_STRING_LEN_MAX + 1];
425 msg (SE, _("FORMAT requires numeric output format as an argument. "
426 "Specified format %s is of type string."),
427 fmt_to_string (&fmt, str));
436 stc_custom_journal (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
439 if (!lex_match_id ("ON") && !lex_match_id ("OFF"))
441 if (token == T_STRING)
453 stc_custom_listing (struct dataset *ds UNUSED, struct cmd_set *cmd UNUSED, void *aux UNUSED)
458 if (lex_match_id ("ON") || lex_match_id ("YES"))
460 else if (lex_match_id ("OFF") || lex_match_id ("NO"))
467 outp_enable_device (listing, OUTP_DEV_LISTING);
473 stc_custom_disk (struct dataset *ds, struct cmd_set *cmd UNUSED, void *aux)
475 return stc_custom_listing (ds, cmd, aux);
479 show_blanks (const struct dataset *ds UNUSED)
481 if (get_blanks () == SYSMIS)
482 msg (SN, _("BLANKS is SYSMIS."));
484 msg (SN, _("BLANKS is %g."), get_blanks ());
489 format_cc (struct substring in, char grouping, char *out)
491 while (!ss_is_empty (in))
493 char c = ss_get_char (&in);
494 if (c == grouping || c == '\'')
504 show_cc (enum fmt_type type)
506 const struct fmt_number_style *cc = fmt_get_style (type);
507 char cc_string[FMT_STYLE_AFFIX_MAX * 4 * 2 + 3 + 1];
510 out = format_cc (cc->neg_prefix, cc->grouping, cc_string);
511 *out++ = cc->grouping;
512 out = format_cc (cc->prefix, cc->grouping, out);
513 *out++ = cc->grouping;
514 out = format_cc (cc->suffix, cc->grouping, out);
515 *out++ = cc->grouping;
516 out = format_cc (cc->neg_suffix, cc->grouping, out);
519 msg (SN, _("%s is \"%s\"."), fmt_name (type), cc_string);
523 show_cca (const struct dataset *ds UNUSED)
529 show_ccb (const struct dataset *ds UNUSED)
535 show_ccc (const struct dataset *ds UNUSED)
541 show_ccd (const struct dataset *ds UNUSED)
547 show_cce (const struct dataset *ds UNUSED)
553 show_decimals (const struct dataset *ds UNUSED)
555 msg (SN, _("DECIMAL is \"%c\"."), fmt_decimal_char (FMT_F));
559 show_endcmd (const struct dataset *ds UNUSED)
561 msg (SN, _("ENDCMD is \"%c\"."), get_endcmd ());
565 show_errors (const struct dataset *ds UNUSED)
567 bool terminal = get_error_routing_to_terminal ();
568 bool listing = get_error_routing_to_listing ();
569 msg (SN, _("ERRORS is \"%s\"."),
570 terminal && listing ? "BOTH"
571 : terminal ? "TERMINAL"
572 : listing ? "LISTING"
577 show_format (const struct dataset *ds UNUSED)
579 char str[FMT_STRING_LEN_MAX + 1];
580 msg (SN, _("FORMAT is %s."), fmt_to_string (get_format (), str));
584 show_length (const struct dataset *ds UNUSED)
586 msg (SN, _("LENGTH is %d."), get_viewlength ());
590 show_mxerrs (const struct dataset *ds UNUSED)
592 msg (SN, _("MXERRS is %d."), get_mxerrs ());
596 show_mxloops (const struct dataset *ds UNUSED)
598 msg (SN, _("MXLOOPS is %d."), get_mxloops ());
602 show_mxwarns (const struct dataset *ds UNUSED)
604 msg (SN, _("MXWARNS is %d."), get_mxwarns ());
608 show_scompression (const struct dataset *ds UNUSED)
610 if (get_scompression ())
611 msg (SN, _("SCOMPRESSION is ON."));
613 msg (SN, _("SCOMPRESSION is OFF."));
617 show_undefined (const struct dataset *ds UNUSED)
619 if (get_undefined ())
620 msg (SN, _("UNDEFINED is WARN."));
622 msg (SN, _("UNDEFINED is NOWARN."));
626 show_weight (const struct dataset *ds)
628 struct variable *var = dict_get_weight (dataset_dict (ds));
630 msg (SN, _("WEIGHT is off."));
632 msg (SN, _("WEIGHT is variable %s."), var->name);
636 show_width (const struct dataset *ds UNUSED)
638 msg (SN, _("WIDTH is %d."), get_viewwidth ());
644 void (*function) (const struct dataset *);
647 const struct show_sbc show_table[] =
649 {"BLANKS", show_blanks},
655 {"DECIMALS", show_decimals},
656 {"ENDCMD", show_endcmd},
657 {"ERRORS", show_errors},
658 {"FORMAT", show_format},
659 {"LENGTH", show_length},
660 {"MXERRS", show_mxerrs},
661 {"MXLOOPS", show_mxloops},
662 {"MXWARNS", show_mxwarns},
663 {"SCOMPRESSION", show_scompression},
664 {"UNDEFINED", show_undefined},
665 {"WEIGHT", show_weight},
666 {"WIDTH", show_width},
670 show_all (const struct dataset *ds)
674 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
675 show_table[i].function (ds);
683 for (i = 0; i < 5; i++)
688 show_warranty (const struct dataset *ds UNUSED)
690 msg (MN, lack_of_warranty);
694 show_copying (const struct dataset *ds UNUSED)
700 cmd_show (struct dataset *ds)
710 if (lex_match (T_ALL))
712 else if (lex_match_id ("CC"))
714 else if (lex_match_id ("WARRANTY"))
716 else if (lex_match_id ("COPYING"))
718 else if (token == T_ID)
722 for (i = 0; i < sizeof show_table / sizeof *show_table; i++)
723 if (lex_match_id (show_table[i].name))
725 show_table[i].function (ds);
741 while (token != '.');