1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009, 2010 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/>. */
23 #include <data/case.h>
24 #include <data/caseinit.h>
25 #include <data/casereader-provider.h>
26 #include <data/dictionary.h>
27 #include <data/procedure.h>
28 #include <data/transformations.h>
29 #include <data/variable.h>
30 #include <language/command.h>
31 #include <language/data-io/data-reader.h>
32 #include <language/data-io/file-handle.h>
33 #include <language/data-io/inpt-pgm.h>
34 #include <language/expressions/public.h>
35 #include <language/lexer/lexer.h>
36 #include <libpspp/assertion.h>
37 #include <libpspp/compiler.h>
38 #include <libpspp/message.h>
39 #include <libpspp/misc.h>
40 #include <libpspp/str.h>
45 #define _(msgid) gettext (msgid)
47 /* Private result codes for use within INPUT PROGRAM. */
48 enum cmd_result_extensions
50 CMD_END_INPUT_PROGRAM = CMD_PRIVATE_FIRST,
54 /* Indicates how a `union value' should be initialized. */
55 struct input_program_pgm
57 struct trns_chain *trns_chain;
58 enum trns_result restart;
60 casenumber case_nr; /* Incremented by END CASE transformation. */
62 struct caseinit *init;
63 struct caseproto *proto;
66 static void destroy_input_program (struct input_program_pgm *);
67 static trns_proc_func end_case_trns_proc;
68 static trns_proc_func reread_trns_proc;
69 static trns_proc_func end_file_trns_proc;
70 static trns_free_func reread_trns_free;
72 static const struct casereader_class input_program_casereader_class;
74 static bool inside_input_program;
76 /* Returns true if we're parsing the inside of a INPUT
77 PROGRAM...END INPUT PROGRAM construct, false otherwise. */
79 in_input_program (void)
81 return inside_input_program;
84 /* Emits an END CASE transformation for INP. */
86 emit_END_CASE (struct dataset *ds, struct input_program_pgm *inp)
88 add_transformation (ds, end_case_trns_proc, NULL, inp);
92 cmd_input_program (struct lexer *lexer, struct dataset *ds)
94 struct input_program_pgm *inp;
95 bool saw_END_CASE = false;
97 proc_discard_active_file (ds);
98 if (lex_token (lexer) != T_ENDCMD)
99 return lex_end_of_command (lexer);
101 inp = xmalloc (sizeof *inp);
102 inp->trns_chain = NULL;
106 inside_input_program = true;
109 enum cmd_result result = cmd_parse_in_state (lexer, ds, CMD_STATE_INPUT_PROGRAM);
110 if (result == CMD_END_INPUT_PROGRAM)
112 else if (result == CMD_END_CASE)
114 emit_END_CASE (ds, inp);
117 else if (cmd_result_is_failure (result) && result != CMD_FAILURE)
119 if (result == CMD_EOF)
120 msg (SE, _("Unexpected end-of-file within INPUT PROGRAM."));
121 inside_input_program = false;
122 proc_discard_active_file (ds);
123 destroy_input_program (inp);
128 emit_END_CASE (ds, inp);
129 inside_input_program = false;
131 if (dict_get_next_value_idx (dataset_dict (ds)) == 0)
133 msg (SE, _("Input program did not create any variables."));
134 proc_discard_active_file (ds);
135 destroy_input_program (inp);
139 inp->trns_chain = proc_capture_transformations (ds);
140 trns_chain_finalize (inp->trns_chain);
142 inp->restart = TRNS_CONTINUE;
144 /* Figure out how to initialize each input case. */
145 inp->init = caseinit_create ();
146 caseinit_mark_for_init (inp->init, dataset_dict (ds));
147 inp->proto = caseproto_ref (dict_get_proto (dataset_dict (ds)));
149 proc_set_active_file_data (
150 ds, casereader_create_sequential (NULL, inp->proto, CASENUMBER_MAX,
151 &input_program_casereader_class, inp));
157 cmd_end_input_program (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
159 assert (in_input_program ());
160 return CMD_END_INPUT_PROGRAM;
163 /* Returns true if STATE is valid given the transformations that
164 are allowed within INPUT PROGRAM. */
166 is_valid_state (enum trns_result state)
168 return (state == TRNS_CONTINUE
169 || state == TRNS_ERROR
170 || state == TRNS_END_FILE
174 /* Reads and returns one case.
175 Returns the case if successful, null at end of file or if an
176 I/O error occurred. */
177 static struct ccase *
178 input_program_casereader_read (struct casereader *reader UNUSED, void *inp_)
180 struct input_program_pgm *inp = inp_;
181 struct ccase *c = case_create (inp->proto);
185 assert (is_valid_state (inp->restart));
186 if (inp->restart == TRNS_ERROR || inp->restart == TRNS_END_FILE)
192 c = case_unshare (c);
193 caseinit_init_vars (inp->init, c);
194 inp->restart = trns_chain_execute (inp->trns_chain, inp->restart,
196 assert (is_valid_state (inp->restart));
197 caseinit_update_left_vars (inp->init, c);
199 while (inp->restart < 0);
205 destroy_input_program (struct input_program_pgm *pgm)
209 trns_chain_destroy (pgm->trns_chain);
210 caseinit_destroy (pgm->init);
211 caseproto_unref (pgm->proto);
216 /* Destroys the casereader. */
218 input_program_casereader_destroy (struct casereader *reader UNUSED, void *inp_)
220 struct input_program_pgm *inp = inp_;
221 if (inp->restart == TRNS_ERROR)
222 casereader_force_error (reader);
223 destroy_input_program (inp);
226 static const struct casereader_class input_program_casereader_class =
228 input_program_casereader_read,
229 input_program_casereader_destroy,
235 cmd_end_case (struct lexer *lexer, struct dataset *ds UNUSED)
237 assert (in_input_program ());
238 if (lex_token (lexer) == T_ENDCMD)
240 return lex_end_of_command (lexer);
243 /* Outputs the current case */
245 end_case_trns_proc (void *inp_, struct ccase **c UNUSED,
246 casenumber case_nr UNUSED)
248 struct input_program_pgm *inp = inp_;
250 return TRNS_END_CASE;
253 /* REREAD transformation. */
256 struct dfm_reader *reader; /* File to move file pointer back on. */
257 struct expression *column; /* Column to reset file pointer to. */
260 /* Parses REREAD command. */
262 cmd_reread (struct lexer *lexer, struct dataset *ds)
264 struct file_handle *fh; /* File to be re-read. */
265 struct expression *e; /* Expression for column to set. */
266 struct reread_trns *t; /* Created transformation. */
268 fh = fh_get_default_handle ();
270 while (lex_token (lexer) != T_ENDCMD)
272 if (lex_match_id (lexer, "COLUMN"))
274 lex_match (lexer, T_EQUALS);
278 msg (SE, _("%s subcommand may be given at most once."), "COLUMN");
280 return CMD_CASCADING_FAILURE;
283 e = expr_parse (lexer, ds, EXPR_NUMBER);
285 return CMD_CASCADING_FAILURE;
287 else if (lex_match_id (lexer, "FILE"))
289 lex_match (lexer, T_EQUALS);
291 fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE);
295 return CMD_CASCADING_FAILURE;
300 lex_error (lexer, NULL);
302 return CMD_CASCADING_FAILURE;
306 t = xmalloc (sizeof *t);
307 t->reader = dfm_open_reader (fh, lexer);
309 add_transformation (ds, reread_trns_proc, reread_trns_free, t);
315 /* Executes a REREAD transformation. */
317 reread_trns_proc (void *t_, struct ccase **c, casenumber case_num)
319 struct reread_trns *t = t_;
321 if (t->column == NULL)
322 dfm_reread_record (t->reader, 1);
325 double column = expr_evaluate_num (t->column, *c, case_num);
326 if (!isfinite (column) || column < 1)
328 msg (SE, _("REREAD: Column numbers must be positive finite "
329 "numbers. Column set to 1."));
330 dfm_reread_record (t->reader, 1);
333 dfm_reread_record (t->reader, column);
335 return TRNS_CONTINUE;
338 /* Frees a REREAD transformation.
339 Returns true if successful, false if an I/O error occurred. */
341 reread_trns_free (void *t_)
343 struct reread_trns *t = t_;
344 expr_free (t->column);
345 dfm_close_reader (t->reader);
349 /* Parses END FILE command. */
351 cmd_end_file (struct lexer *lexer, struct dataset *ds)
353 assert (in_input_program ());
355 add_transformation (ds, end_file_trns_proc, NULL, NULL);
357 return lex_end_of_command (lexer);
360 /* Executes an END FILE transformation. */
362 end_file_trns_proc (void *trns_ UNUSED, struct ccase **c UNUSED,
363 casenumber case_num UNUSED)
365 return TRNS_END_FILE;