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., 51 Franklin Street, Fifth Floor, Boston, MA
32 #define _(msgid) gettext (msgid)
34 #define DEFFMT(LABEL, NAME, N_ARGS, IMIN_W, IMAX_W, OMIN_W, OMAX_W, CAT, \
36 {NAME, N_ARGS, IMIN_W, IMAX_W, OMIN_W, OMAX_W, CAT, OUTPUT, SPSS_FMT},
37 struct fmt_desc formats[FMT_NUMBER_OF_FORMATS + 1] =
40 {"", -1, -1, -1, -1, -1, 0000, -1, -1},
44 const struct fmt_spec f8_2 = {FMT_F, 8, 2};
46 /* Parses the alphabetic prefix of the current token as a format
47 specifier name. Returns the corresponding format specifier
48 type if successful, or -1 on failure. If ALLOW_XT is zero,
49 then X and T format specifiers are not allowed. If CP is
50 nonzero, then *CP is set to the first non-alphabetic character
51 in the current token on success or to a null pointer on
54 parse_format_specifier_name (const char **cp, enum fmt_parse_flags flags)
59 sp = ep = ds_c_str (&tokstr);
60 while (isalpha ((unsigned char) *ep))
66 for (idx = 0; idx < FMT_NUMBER_OF_FORMATS; idx++)
67 if (strlen (formats[idx].name) == ep - sp
68 && !buf_compare_case (formats[idx].name, sp, ep - sp))
72 if (idx < FMT_NUMBER_OF_FORMATS)
74 if (!(flags & FMTP_ALLOW_XT) && (idx == FMT_T || idx == FMT_X))
76 if (!(flags & FMTP_SUPPRESS_ERRORS))
77 msg (SE, _("X and T format specifiers not allowed here."));
84 if (!(flags & FMTP_SUPPRESS_ERRORS))
85 msg (SE, _("%.*s is not a valid data format."),
86 (int) (ep - sp), ds_c_str (&tokstr));
92 lex_error ("expecting data format");
107 /* Converts F to its string representation (for instance, "F8.2") and
108 returns a pointer to a static buffer containing that string. */
110 fmt_to_string (const struct fmt_spec *f)
114 if (formats[f->type].n_args >= 2)
115 sprintf (buf, "%s%d.%d", formats[f->type].name, f->w, f->d);
117 sprintf (buf, "%s%d", formats[f->type].name, f->w);
121 /* Does checks in common betwen check_input_specifier() and
122 check_output_specifier() and returns true if so. Otherwise,
123 emits an error message (if EMIT_ERROR is nonzero) and returns
126 check_common_specifier (const struct fmt_spec *spec, bool emit_error)
128 struct fmt_desc *f = &formats[spec->type];
129 char *str = fmt_to_string (spec);
131 if ((f->cat & FCAT_EVEN_WIDTH) && spec->w % 2)
134 msg (SE, _("Format %s specifies an odd width %d, but "
135 "an even width is required."),
139 if (f->n_args > 1 && (spec->d < 0 || spec->d > 16))
142 msg (SE, _("Format %s specifies a bad number of "
143 "implied decimal places %d. Input format %s allows "
144 "up to 16 implied decimal places."), str, spec->d, f->name);
150 /* Checks whether SPEC is valid as an input format and returns
151 nonzero if so. Otherwise, emits an error message (if
152 EMIT_ERROR is nonzero) and returns zero. */
154 check_input_specifier (const struct fmt_spec *spec, int emit_error)
156 struct fmt_desc *f = &formats[spec->type];
157 char *str = fmt_to_string (spec);
159 if (!check_common_specifier (spec, emit_error))
161 if (spec->type == FMT_X)
163 if (f->cat & FCAT_OUTPUT_ONLY)
166 msg (SE, _("Format %s may not be used for input."), f->name);
169 if (spec->w < f->Imin_w || spec->w > f->Imax_w)
172 msg (SE, _("Input format %s specifies a bad width %d. "
173 "Format %s requires a width between %d and %d."),
174 str, spec->w, f->name, f->Imin_w, f->Imax_w);
177 if ((spec->type == FMT_F || spec->type == FMT_COMMA
178 || spec->type == FMT_DOLLAR)
179 && spec->d > spec->w)
182 msg (SE, _("Input format %s is invalid because it specifies more "
183 "decimal places than the field width."), str);
189 /* Checks whether SPEC is valid as an output format and returns
190 nonzero if so. Otherwise, emits an error message (if
191 EMIT_ERROR is nonzero) and returns zero. */
193 check_output_specifier (const struct fmt_spec *spec, int emit_error)
195 struct fmt_desc *f = &formats[spec->type];
196 char *str = fmt_to_string (spec);
198 if (!check_common_specifier (spec, emit_error))
200 if (spec->type == FMT_X)
202 if (spec->w < f->Omin_w || spec->w > f->Omax_w)
205 msg (SE, _("Output format %s specifies a bad width %d. "
206 "Format %s requires a width between %d and %d."),
207 str, spec->w, f->name, f->Omin_w, f->Omax_w);
210 if ((spec->type == FMT_F || spec->type == FMT_COMMA
211 || spec->type == FMT_DOLLAR)
212 && spec->d >= spec->w)
215 msg (SE, _("Output format %s is invalid because it specifies as "
216 "many decimal places as the field width, which "
217 "fails to allow space for a decimal point. "
218 "Try %s%d.%d instead."),
219 str, f->name, spec->d + 1, spec->d);
225 /* Checks that FORMAT is appropriate for a variable of the given
226 TYPE and returns true if so. Otherwise returns false and (if
227 EMIT_ERROR is true) emits an error message. */
229 check_specifier_type (const struct fmt_spec *format,
230 int type, bool emit_error)
232 const struct fmt_desc *f = &formats[format->type];
233 assert (type == NUMERIC || type == ALPHA);
234 if ((type == ALPHA) != ((f->cat & FCAT_STRING) != 0))
237 msg (SE, _("%s variables are not compatible with %s format %s."),
238 type == ALPHA ? _("String") : _("Numeric"),
239 type == ALPHA ? _("numeric") : _("string"),
240 fmt_to_string (format));
246 /* Checks that FORMAT is appropriate for a variable of the given
247 WIDTH and returns true if so. Otherwise returns false and (if
248 EMIT_ERROR is true) emits an error message. */
250 check_specifier_width (const struct fmt_spec *format,
251 int width, bool emit_error)
253 if (!check_specifier_type (format, width != 0 ? ALPHA : NUMERIC, emit_error))
255 if (get_format_var_width (format) != width)
258 msg (SE, _("String variable with width %d not compatible with "
260 width, fmt_to_string (format));
266 /* Converts input format specifier INPUT into output format
269 convert_fmt_ItoO (const struct fmt_spec *input, struct fmt_spec *output)
271 assert (check_input_specifier (input, 0));
273 output->type = formats[input->type].output;
274 output->w = input->w;
275 if (output->w > formats[output->type].Omax_w)
276 output->w = formats[output->type].Omax_w;
277 output->d = input->d;
287 output->w = max (max (input->w, input->d+7), 10);
288 output->d = max (input->d, 3);
292 /* nothing is necessary */
301 static const int map[] = {4, 6, 9, 11, 14, 16, 18, 21};
302 assert (input->w % 2 == 0 && input->w >= 2 && input->w <= 16);
303 output->w = map[input->w / 2 - 1];
307 output->w = 8, output->d = 2; /* FIXME */
315 output->w = 8, output->d = 2;
317 output->w = 9 + input->d;
327 /* nothing is necessary */
330 output->w = input->w / 2;
337 /* nothing is necessary */
344 /* nothing is necessary */
355 /* nothing is necessary */
361 assert (check_output_specifier (output, 0));
364 /* Parses a format specifier from the token stream and returns
365 nonzero only if successful. Emits an error message on
366 failure. Allows X and T format specifiers only if ALLOW_XT is
367 nonzero. The caller should call check_input_specifier() or
368 check_output_specifier() on the parsed format as
371 parse_format_specifier (struct fmt_spec *input, enum fmt_parse_flags flags)
373 struct fmt_spec spec;
381 if (!(flags & FMTP_SUPPRESS_ERRORS))
382 msg (SE, _("Format specifier expected."));
385 type = parse_format_specifier_name (&cp, flags);
390 w = strtol (cp, &cp2, 10);
391 if (cp2 == cp && type != FMT_X)
393 if (!(flags & FMTP_SUPPRESS_ERRORS))
394 msg (SE, _("Data format %s does not specify a width."),
400 if (f->n_args > 1 && *cp == '.')
403 d = strtol (cp, &cp2, 10);
411 if (!(flags & FMTP_SUPPRESS_ERRORS))
412 msg (SE, _("Data format %s is not valid."), ds_c_str (&tokstr));
425 /* Returns the width corresponding to the format specifier. The
426 return value is the value of the `width' member of a `struct
427 variable' for such an input format. */
429 get_format_var_width (const struct fmt_spec *spec)
431 if (spec->type == FMT_AHEX)
433 else if (spec->type == FMT_A)
439 /* Returns the PSPP format corresponding to the given SPSS
442 translate_fmt (int spss)
446 for (type = 0; type < FMT_NUMBER_OF_FORMATS; type++)
447 if (formats[type].spss == spss)
452 /* Returns an input format specification with type TYPE, width W,
455 make_input_format (int type, int w, int d)
461 assert (check_input_specifier (&f, 0));
465 /* Returns an output format specification with type TYPE, width
466 W, and D decimals. */
468 make_output_format (int type, int w, int d)
474 assert (check_output_specifier (&f, 0));