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., 59 Temple Place - Suite 330, Boston, MA
28 #include "file-handle.h"
35 /* Defines the three types of complex files read by FILE TYPE. */
43 /* Limited variable column specifications. */
46 char name[9]; /* Variable name. */
47 int fc, nc; /* First column (1-based), # of columns. */
48 int fmt; /* Format type. */
49 struct variable *v; /* Variable. */
52 /* RCT_* record type constants. */
55 RCT_OTHER = 001, /* 1=OTHER. */
56 RCT_SKIP = 002, /* 1=SKIP. */
57 RCT_DUPLICATE = 004, /* DUPLICATE: 0=NOWARN, 1=WARN. */
58 RCT_MISSING = 010, /* MISSING: 0=NOWARN, 1=WARN. */
59 RCT_SPREAD = 020 /* SPREAD: 0=NO, 1=YES. */
62 /* Represents a RECORD TYPE command. */
65 struct record_type *next;
66 unsigned flags; /* RCT_* constants. */
67 union value *v; /* Vector of values for this record type. */
68 int nv; /* Length of vector V. */
69 struct col_spec case_sbc; /* CASE subcommand. */
70 int ft, lt; /* First, last transformation index. */
73 /* Represents a FILE TYPE input program. Does not contain a
74 trns_header because it's never submitted as a transformation. */
77 int type; /* One of the FTY_* constants. */
78 struct file_handle *handle; /* File handle of input file. */
79 struct col_spec record; /* RECORD subcommand. */
80 struct col_spec case_sbc; /* CASE subcommand. */
81 int wild; /* 0=NOWARN, 1=WARN. */
82 int duplicate; /* 0=NOWARN, 1=WARN. */
83 int missing; /* 0=NOWARN, 1=WARN, 2=CASE. */
84 int ordered; /* 0=NO, 1=YES. */
85 int had_rec_type; /* 1=Had a RECORD TYPE command.
86 RECORD TYPE must precede the first
88 struct record_type *recs_head; /* List of record types. */
89 struct record_type *recs_tail; /* Last in list of record types. */
92 /* Current FILE TYPE input program. */
93 static struct file_type_pgm fty;
95 static int parse_col_spec (struct col_spec *, const char *);
96 static void create_col_var (struct col_spec *c);
98 /* Parses FILE TYPE command. */
103 discard_variables ();
104 fty.handle = inline_file;
105 fty.record.name[0] = 0;
106 fty.case_sbc.name[0] = 0;
107 fty.wild = fty.duplicate = fty.missing = fty.ordered = 0;
108 fty.had_rec_type = 0;
109 fty.recs_head = fty.recs_tail = NULL;
111 lex_match_id ("TYPE");
112 if (lex_match_id ("MIXED"))
113 fty.type = FTY_MIXED;
114 else if (lex_match_id ("GROUPED"))
116 fty.type = FTY_GROUPED;
122 else if (lex_match_id ("NESTED"))
123 fty.type = FTY_NESTED;
126 msg (SE, _("MIXED, GROUPED, or NESTED expected."));
132 if (lex_match_id ("FILE"))
135 fty.handle = fh_parse_file_handle ();
139 else if (lex_match_id ("RECORD"))
142 if (!parse_col_spec (&fty.record, "####RECD"))
145 else if (lex_match_id ("CASE"))
147 if (fty.type == FTY_MIXED)
149 msg (SE, _("The CASE subcommand is not valid on FILE TYPE "
155 if (!parse_col_spec (&fty.case_sbc, "####CASE"))
158 else if (lex_match_id ("WILD"))
161 if (lex_match_id ("WARN"))
163 else if (lex_match_id ("NOWARN"))
167 msg (SE, _("WARN or NOWARN expected after WILD."));
171 else if (lex_match_id ("DUPLICATE"))
173 if (fty.type == FTY_MIXED)
175 msg (SE, _("The DUPLICATE subcommand is not valid on "
176 "FILE TYPE MIXED."));
181 if (lex_match_id ("WARN"))
183 else if (lex_match_id ("NOWARN"))
185 else if (lex_match_id ("CASE"))
187 if (fty.type != FTY_NESTED)
189 msg (SE, _("DUPLICATE=CASE is only valid on "
190 "FILE TYPE NESTED."));
198 msg (SE, _("WARN%s expected after DUPLICATE."),
199 (fty.type == FTY_NESTED ? _(", NOWARN, or CASE")
204 else if (lex_match_id ("MISSING"))
206 if (fty.type == FTY_MIXED)
208 msg (SE, _("The MISSING subcommand is not valid on "
209 "FILE TYPE MIXED."));
214 if (lex_match_id ("NOWARN"))
216 else if (lex_match_id ("WARN"))
220 msg (SE, _("WARN or NOWARN after MISSING."));
224 else if (lex_match_id ("ORDERED"))
226 if (fty.type != FTY_GROUPED)
228 msg (SE, _("ORDERED is only valid on FILE TYPE GROUPED."));
233 if (lex_match_id ("YES"))
235 else if (lex_match_id ("NO"))
239 msg (SE, _("YES or NO expected after ORDERED."));
245 lex_error (_("while expecting a valid subcommand"));
250 if (fty.record.name[0] == 0)
252 msg (SE, _("The required RECORD subcommand was not present."));
256 if (fty.type == FTY_GROUPED)
258 if (fty.case_sbc.name[0] == 0)
260 msg (SE, _("The required CASE subcommand was not present."));
264 if (!strcmp (fty.case_sbc.name, fty.record.name))
266 msg (SE, _("CASE and RECORD must specify different variable "
272 default_handle = fty.handle;
274 vfm_source = &file_type_source;
275 create_col_var (&fty.record);
276 if (fty.case_sbc.name[0])
277 create_col_var (&fty.case_sbc);
282 /* Creates a variable with attributes specified by struct col_spec C, and
283 stores it into C->V. */
285 create_col_var (struct col_spec *c)
290 type = (formats[c->fmt].cat & FCAT_STRING) ? ALPHA : NUMERIC;
295 c->v = force_create_variable (&default_dict, c->name, type, width);
298 /* Parses variable, column, type specifications for a variable. */
300 parse_col_spec (struct col_spec *c, const char *def_name)
302 struct fmt_spec spec;
306 strcpy (c->name, tokid);
310 strcpy (c->name, def_name);
312 if (!lex_force_int ())
314 c->fc = lex_integer ();
317 msg (SE, _("Column value must be positive."));
322 lex_negative_to_dash ();
325 if (!lex_force_int ())
327 c->nc = lex_integer ();
332 msg (SE, _("Ending column precedes beginning column."));
344 if (!lex_force_id ())
346 c->fmt = parse_format_specifier_name (&cp, 0);
351 msg (SE, _("Bad format specifier name."));
355 if (!lex_force_match (')'))
364 return check_input_specifier (&spec);
369 /* Structure being filled in by internal_cmd_record_type. */
370 static struct record_type rct;
372 static int internal_cmd_record_type (void);
374 /* Parse the RECORD TYPE command. */
376 cmd_record_type (void)
378 int result = internal_cmd_record_type ();
380 if (result == CMD_FAILURE)
384 if (formats[fty.record.fmt].cat & FCAT_STRING)
385 for (i = 0; i < rct.nv; i++)
394 internal_cmd_record_type (void)
396 /* Initialize the record_type structure. */
400 rct.flags |= RCT_DUPLICATE;
402 rct.flags |= RCT_MISSING;
406 if (fty.case_sbc.name[0])
407 rct.case_sbc = fty.case_sbc;
410 memset (&rct.case_sbc, 0, sizeof rct.case_sbc);
414 /* Make sure we're inside a FILE TYPE structure. */
415 if (pgm_state != STATE_INPUT || vfm_source != &file_type_source)
417 msg (SE, _("This command may only appear within a "
418 "FILE TYPE/END FILE TYPE structure."));
422 if (fty.recs_tail && (fty.recs_tail->flags & RCT_OTHER))
424 msg (SE, _("OTHER may appear only on the last RECORD TYPE command."));
430 fty.recs_tail->lt = n_trns - 1;
431 if (!(fty.recs_tail->flags & RCT_SKIP)
432 && fty.recs_tail->ft == fty.recs_tail->lt)
434 msg (SE, _("No input commands (DATA LIST, REPEATING DATA) "
435 "for above RECORD TYPE."));
440 lex_match_id ("RECORD");
441 lex_match_id ("TYPE");
443 /* Parse record type values. */
444 if (lex_match_id ("OTHER"))
445 rct.flags |= RCT_OTHER;
450 while (token == T_NUM || token == T_STRING)
455 rct.v = xrealloc (rct.v, mv * sizeof *rct.v);
458 if (formats[fty.record.fmt].cat & FCAT_STRING)
460 if (!lex_force_string ())
462 rct.v[rct.nv].c = xmalloc (fty.record.nc + 1);
463 st_bare_pad_copy (rct.v[rct.nv].c, ds_value (&tokstr),
468 if (!lex_force_num ())
470 rct.v[rct.nv].f = tokval;
479 /* Parse the rest of the subcommands. */
482 if (lex_match_id ("SKIP"))
483 rct.flags |= RCT_SKIP;
484 else if (lex_match_id ("CASE"))
486 if (fty.type == FTY_MIXED)
488 msg (SE, _("The CASE subcommand is not allowed on "
489 "the RECORD TYPE command for FILE TYPE MIXED."));
494 if (!parse_col_spec (&rct.case_sbc, ""))
496 if (rct.case_sbc.name[0])
498 msg (SE, _("No variable name may be specified for the "
499 "CASE subcommand on RECORD TYPE."));
503 if ((formats[rct.case_sbc.fmt].cat ^ formats[fty.case_sbc.fmt].cat)
506 msg (SE, _("The CASE column specification on RECORD TYPE "
507 "must give a format specifier that is the "
508 "same type as that of the CASE column "
509 "specification given on FILE TYPE."));
513 else if (lex_match_id ("DUPLICATE"))
516 if (lex_match_id ("WARN"))
517 rct.flags |= RCT_DUPLICATE;
518 else if (lex_match_id ("NOWARN"))
519 rct.flags &= ~RCT_DUPLICATE;
522 msg (SE, _("WARN or NOWARN expected on DUPLICATE "
527 else if (lex_match_id ("MISSING"))
530 if (lex_match_id ("WARN"))
531 rct.flags |= RCT_MISSING;
532 else if (lex_match_id ("NOWARN"))
533 rct.flags &= ~RCT_MISSING;
536 msg (SE, _("WARN or NOWARN expected on MISSING subcommand."));
540 else if (lex_match_id ("SPREAD"))
543 if (lex_match_id ("YES"))
544 rct.flags |= RCT_SPREAD;
545 else if (lex_match_id ("NO"))
546 rct.flags &= ~RCT_SPREAD;
549 msg (SE, _("YES or NO expected on SPREAD subcommand."));
555 lex_error (_("while expecting a valid subcommand"));
561 fty.recs_tail = fty.recs_tail->next = xmalloc (sizeof *fty.recs_tail);
563 fty.recs_head = fty.recs_tail = xmalloc (sizeof *fty.recs_tail);
564 memcpy (fty.recs_tail, &rct, sizeof *fty.recs_tail);
572 cmd_end_file_type (void)
574 if (pgm_state != STATE_INPUT || vfm_source != &file_type_source)
576 msg (SE, _("This command may only appear within a "
577 "FILE TYPE/END FILE TYPE structure."));
581 lex_match_id ("TYPE");
585 fty.recs_tail->lt = n_trns - 1;
586 if (!(fty.recs_tail->flags & RCT_SKIP)
587 && fty.recs_tail->ft == fty.recs_tail->lt)
589 msg (SE, _("No input commands (DATA LIST, REPEATING DATA) "
590 "on above RECORD TYPE."));
596 msg (SE, _("No commands between FILE TYPE and END FILE TYPE."));
602 return lex_end_of_command ();
605 /* Come here on discovering catastrophic error. */
607 discard_variables ();
611 /* FILE TYPE runtime. */
613 /*static void read_from_file_type_mixed(void);
614 static void read_from_file_type_grouped(void);
615 static void read_from_file_type_nested(void); */
617 /* Reads any number of cases into temp_case and calls write_case() for
618 each one. Compare data-list.c:read_from_data_list. */
620 file_type_source_read (void)
625 struct fmt_spec format;
627 dfm_push (fty.handle);
629 format.type = fty.record.fmt;
630 format.w = fty.record.nc;
632 while (NULL != (line = dfm_get_record (fty.handle, &len)))
634 struct record_type *iter;
638 if (formats[fty.record.fmt].cat & FCAT_STRING)
642 v.c = temp_case->data[fty.record.v->fv].s;
644 data_in_finite_line (&di, line, len,
645 fty.record.fc, fty.record.fc + fty.record.nc);
646 di.v = (union value *) v.c;
648 di.f1 = fty.record.fc;
652 for (iter = fty.recs_head; iter; iter = iter->next)
654 if (iter->flags & RCT_OTHER)
656 for (i = 0; i < iter->nv; i++)
657 if (!memcmp (iter->v[i].c, v.c, fty.record.nc))
661 msg (SW, _("Unknown record type \"%.*s\"."), fty.record.nc, v.c);
667 data_in_finite_line (&di, line, len,
668 fty.record.fc, fty.record.fc + fty.record.nc);
671 di.f1 = fty.record.fc;
675 memcpy (&temp_case->data[fty.record.v->fv].f, &v.f, sizeof v.f);
676 for (iter = fty.recs_head; iter; iter = iter->next)
678 if (iter->flags & RCT_OTHER)
680 for (i = 0; i < iter->nv; i++)
681 if (approx_eq (iter->v[i].f, v.f))
685 msg (SW, _("Unknown record type %g."), v.f);
687 dfm_fwd_record (fty.handle);
691 /* Arrive here if there is a matching record_type, which is in
693 dfm_fwd_record (fty.handle);
698 case FTY_MIXED: read_from_file_type_mixed(); break;
699 case FTY_GROUPED: read_from_file_type_grouped(); break;
700 case FTY_NESTED: read_from_file_type_nested(); break;
704 dfm_pop (fty.handle);
708 file_type_source_destroy_source (void)
710 struct record_type *iter, *next;
712 cancel_transformations ();
713 for (iter = fty.recs_head; iter; iter = next)
720 struct case_stream file_type_source =
723 file_type_source_read,
726 file_type_source_destroy_source,