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
27 #include "data-list.h"
31 #include "file-handle.h"
38 #include "debug-print.h"
40 /* Indicates how a `union value' should be initialized. */
43 INP_NUMERIC = 01, /* Numeric. */
44 INP_STRING = 0, /* String. */
46 INP_INIT_ONCE = 02, /* Initialize only once. */
47 INP_REINIT = 0, /* Reinitialize for each iteration. */
50 struct input_program_pgm
52 enum value_init_type *init; /* How to initialize each `union value'. */
53 size_t init_cnt; /* Number of elements in inp_init. */
54 size_t case_size; /* Size of case in bytes. */
57 static trns_proc_func end_case_trns_proc, reread_trns_proc, end_file_trns_proc;
58 static trns_free_func reread_trns_free;
61 cmd_input_program (void)
65 /* FIXME: we shouldn't do this here, but I'm afraid that other
66 code will check the class of vfm_source. */
67 vfm_source = create_case_source (&input_program_source_class,
70 return lex_end_of_command ();
74 cmd_end_input_program (void)
76 struct input_program_pgm *inp;
79 if (!case_source_is_class (vfm_source, &input_program_source_class))
81 msg (SE, _("No matching INPUT PROGRAM command."));
85 if (dict_get_next_value_idx (default_dict) == 0)
86 msg (SW, _("No data-input or transformation commands specified "
87 "between INPUT PROGRAM and END INPUT PROGRAM."));
89 /* Mark the boundary between INPUT PROGRAM transformations and
90 ordinary transformations. */
93 /* Figure out how to initialize each input case. */
94 inp = xmalloc (sizeof *inp);
95 inp->init_cnt = dict_get_next_value_idx (default_dict);
96 inp->init = xmalloc (inp->init_cnt * sizeof *inp->init);
97 for (i = 0; i < inp->init_cnt; i++)
99 for (i = 0; i < dict_get_var_cnt (default_dict); i++)
101 struct variable *var = dict_get_var (default_dict, i);
102 enum value_init_type value_init;
105 value_init = var->type == NUMERIC ? INP_NUMERIC : INP_STRING;
106 value_init |= var->reinit ? INP_REINIT : INP_INIT_ONCE;
108 for (j = 0; j < var->nv; j++)
109 inp->init[j + var->fv] = value_init;
111 for (i = 0; i < inp->init_cnt; i++)
112 assert (inp->init[i] != -1);
113 inp->case_size = dict_get_case_size (default_dict);
115 /* Put inp into vfm_source for later use. */
116 vfm_source->aux = inp;
118 /* FIXME: we should use create_case_source() here. */
119 vfm_source->value_cnt = dict_get_next_value_idx (default_dict);
121 return lex_end_of_command ();
124 /* Initializes case C. Called before the first case is read. */
126 init_case (const struct input_program_pgm *inp, struct ccase *c)
130 for (i = 0; i < inp->init_cnt; i++)
131 switch (inp->init[i])
133 case INP_NUMERIC | INP_INIT_ONCE:
134 case_data_rw (c, i)->f = 0.0;
136 case INP_NUMERIC | INP_REINIT:
137 case_data_rw (c, i)->f = SYSMIS;
139 case INP_STRING | INP_INIT_ONCE:
140 case INP_STRING | INP_REINIT:
141 memset (case_data_rw (c, i)->s, ' ', sizeof case_data_rw (c, i)->s);
148 /* Clears case C. Called between reading successive records. */
150 clear_case (const struct input_program_pgm *inp, struct ccase *c)
154 for (i = 0; i < inp->init_cnt; i++)
155 switch (inp->init[i])
157 case INP_NUMERIC | INP_INIT_ONCE:
159 case INP_NUMERIC | INP_REINIT:
160 case_data_rw (c, i)->f = SYSMIS;
162 case INP_STRING | INP_INIT_ONCE:
164 case INP_STRING | INP_REINIT:
165 memset (case_data_rw (c, i)->s, ' ', sizeof case_data_rw (c, i)->s);
172 /* Executes each transformation in turn on a `blank' case. When a
173 transformation fails, returning -2, then that's the end of the
174 file. -1 means go on to the next transformation. Otherwise the
175 return value is the index of the transformation to go to next. */
177 input_program_source_read (struct case_source *source,
179 write_case_func *write_case,
180 write_case_data wc_data)
182 struct input_program_pgm *inp = source->aux;
185 /* Nonzero if there were any END CASE commands in the set of
186 transformations. If so, we don't automatically write out
190 /* FIXME? This is the number of cases sent out of the input
191 program, not the number of cases written to the procedure.
192 The difference should only show up in $CASENUM in COMPUTE.
193 We should check behavior against SPSS. */
194 int cases_written = 0;
196 assert (inp != NULL);
198 /* Figure end_case. */
199 for (i = 0; i < f_trns; i++)
200 if (t_trns[i]->proc == end_case_trns_proc)
203 /* FIXME: This is an ugly kluge. */
204 for (i = 0; i < f_trns; i++)
205 if (t_trns[i]->proc == repeating_data_trns_proc)
206 repeating_data_set_write_case (t_trns[i], write_case, wc_data);
211 /* Perform transformations on `blank' case. */
212 for (i = 0; i < f_trns; )
214 int code; /* Return value of last-called transformation. */
216 if (t_trns[i]->proc == end_case_trns_proc)
219 if (!write_case (wc_data))
226 code = t_trns[i]->proc (t_trns[i], c, cases_written + 1);
242 /* Write the case if appropriate. */
246 if (!write_case (wc_data))
250 /* Blank out the case for the next iteration. */
257 /* Destroys an INPUT PROGRAM source. */
259 input_program_source_destroy (struct case_source *source)
261 struct input_program_pgm *inp = source->aux;
263 cancel_transformations ();
272 const struct case_source_class input_program_source_class =
276 input_program_source_read,
277 input_program_source_destroy,
283 struct trns_header *t;
285 if (!case_source_is_class (vfm_source, &input_program_source_class))
287 msg (SE, _("This command may only be executed between INPUT PROGRAM "
288 "and END INPUT PROGRAM."));
292 t = xmalloc (sizeof *t);
293 t->proc = end_case_trns_proc;
295 add_transformation ((struct trns_header *) t);
297 return lex_end_of_command ();
300 /* Should never be called, because this is handled in
301 input_program_source_read(). */
303 end_case_trns_proc (struct trns_header *t UNUSED, struct ccase * c UNUSED,
310 /* REREAD transformation. */
313 struct trns_header h;
315 struct file_handle *handle; /* File to move file pointer back on. */
316 struct expression *column; /* Column to reset file pointer to. */
319 /* Parses REREAD command. */
323 /* File to be re-read. */
324 struct file_handle *h;
326 /* Expression for column to set file pointer to. */
327 struct expression *e;
329 /* Created transformation. */
330 struct reread_trns *t;
336 if (lex_match_id ("COLUMN"))
342 msg (SE, _("COLUMN subcommand multiply specified."));
347 e = expr_parse (EXPR_NUMERIC);
351 else if (lex_match_id ("FILE"))
354 h = fh_parse_file_handle ();
369 t = xmalloc (sizeof *t);
370 t->h.proc = reread_trns_proc;
371 t->h.free = reread_trns_free;
374 add_transformation ((struct trns_header *) t);
379 /* Executes a REREAD transformation. */
381 reread_trns_proc (struct trns_header * pt, struct ccase * c,
384 struct reread_trns *t = (struct reread_trns *) pt;
386 if (t->column == NULL)
387 dfm_reread_record (t->handle, 1);
392 expr_evaluate (t->column, c, case_num, &column);
393 if (!finite (column.f) || column.f < 1)
395 msg (SE, _("REREAD: Column numbers must be positive finite "
396 "numbers. Column set to 1."));
397 dfm_reread_record (t->handle, 1);
400 dfm_reread_record (t->handle, column.f);
405 /* Frees a REREAD transformation. */
407 reread_trns_free (struct trns_header * t)
409 expr_free (((struct reread_trns *) t)->column);
412 /* Parses END FILE command. */
416 struct trns_header *t;
418 if (!case_source_is_class (vfm_source, &input_program_source_class))
420 msg (SE, _("This command may only be executed between INPUT PROGRAM "
421 "and END INPUT PROGRAM."));
425 t = xmalloc (sizeof *t);
426 t->proc = end_file_trns_proc;
428 add_transformation ((struct trns_header *) t);
430 return lex_end_of_command ();
433 /* Executes an END FILE transformation. */
435 end_file_trns_proc (struct trns_header * t UNUSED, struct ccase * c UNUSED,