src/language/data-io/inpt-pgm.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #include <config.h>
  18
  19 #include <language/data-io/inpt-pgm.h>
  20
  21 #include <float.h>
  22 #include <stdlib.h>
  23
  24 #include <data/case.h>
  25 #include <data/caseinit.h>
  26 #include <data/casereader-provider.h>
  27 #include <data/dictionary.h>
  28 #include <data/procedure.h>
  29 #include <data/transformations.h>
  30 #include <data/variable.h>
  31 #include <language/command.h>
  32 #include <language/data-io/data-reader.h>
  33 #include <language/data-io/file-handle.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/message.h>
  40 #include <libpspp/misc.h>
  41 #include <libpspp/str.h>
  42
  43 #include "xalloc.h"
  44
  45 #include "gettext.h"
  46 #define _(msgid) gettext (msgid)
  47
  48 /* Private result codes for use within INPUT PROGRAM. */
  49 enum cmd_result_extensions
  50   {
  51     CMD_END_INPUT_PROGRAM = CMD_PRIVATE_FIRST,
  52     CMD_END_CASE
  53   };
  54
  55 /* Indicates how a `union value' should be initialized. */
  56 enum value_init_type
  57   {
  58     INP_NUMERIC = 01,           /* Numeric. */
  59     INP_STRING = 0,             /* String. */
  60
  61     INP_INIT_ONCE = 02,         /* Initialize only once. */
  62     INP_REINIT = 0,             /* Reinitialize for each iteration. */
  63   };
  64
  65 struct input_program_pgm
  66   {
  67     struct trns_chain *trns_chain;
  68     enum trns_result restart;
  69
  70     casenumber case_nr;             /* Incremented by END CASE transformation. */
  71
  72     struct caseinit *init;
  73     size_t value_cnt;
  74   };
  75
  76 static void destroy_input_program (struct input_program_pgm *);
  77 static trns_proc_func end_case_trns_proc;
  78 static trns_proc_func reread_trns_proc;
  79 static trns_proc_func end_file_trns_proc;
  80 static trns_free_func reread_trns_free;
  81
  82 static const struct casereader_class input_program_casereader_class;
  83
  84 static bool inside_input_program;
  85
  86 /* Returns true if we're parsing the inside of a INPUT
  87    PROGRAM...END INPUT PROGRAM construct, false otherwise. */
  88 bool
  89 in_input_program (void)
  90 {
  91   return inside_input_program;
  92 }
  93
  94 /* Emits an END CASE transformation for INP. */
  95 static void
  96 emit_END_CASE (struct dataset *ds, struct input_program_pgm *inp)
  97 {
  98   add_transformation (ds, end_case_trns_proc, NULL, inp);
  99 }
 100
 101 int
 102 cmd_input_program (struct lexer *lexer, struct dataset *ds)
 103 {
 104   struct input_program_pgm *inp;
 105   bool saw_END_CASE = false;
 106
 107   proc_discard_active_file (ds);
 108   if (lex_token (lexer) != '.')
 109     return lex_end_of_command (lexer);
 110
 111   inp = xmalloc (sizeof *inp);
 112   inp->trns_chain = NULL;
 113   inp->init = NULL;
 114
 115   inside_input_program = true;
 116   for (;;)
 117     {
 118       enum cmd_result result = cmd_parse_in_state (lexer, ds, CMD_STATE_INPUT_PROGRAM);
 119       if (result == CMD_END_INPUT_PROGRAM)
 120         break;
 121       else if (result == CMD_END_CASE)
 122         {
 123           emit_END_CASE (ds, inp);
 124           saw_END_CASE = true;
 125         }
 126       else if (cmd_result_is_failure (result) && result != CMD_FAILURE)
 127         {
 128           if (result == CMD_EOF)
 129             msg (SE, _("Unexpected end-of-file within INPUT PROGRAM."));
 130           inside_input_program = false;
 131           proc_discard_active_file (ds);
 132           destroy_input_program (inp);
 133           return result;
 134         }
 135     }
 136   if (!saw_END_CASE)
 137     emit_END_CASE (ds, inp);
 138   inside_input_program = false;
 139
 140   if (dict_get_next_value_idx (dataset_dict (ds)) == 0)
 141     {
 142       msg (SE, _("Input program did not create any variables."));
 143       proc_discard_active_file (ds);
 144       destroy_input_program (inp);
 145       return CMD_FAILURE;
 146     }
 147
 148   inp->trns_chain = proc_capture_transformations (ds);
 149   trns_chain_finalize (inp->trns_chain);
 150
 151   inp->restart = TRNS_CONTINUE;
 152
 153   /* Figure out how to initialize each input case. */
 154   inp->init = caseinit_create ();
 155   caseinit_mark_for_init (inp->init, dataset_dict (ds));
 156   inp->value_cnt = dict_get_next_value_idx (dataset_dict (ds));
 157
 158   proc_set_active_file_data (
 159     ds, casereader_create_sequential (NULL, inp->value_cnt, CASENUMBER_MAX,
 160                                       &input_program_casereader_class, inp));
 161
 162   return CMD_SUCCESS;
 163 }
 164
 165 int
 166 cmd_end_input_program (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
 167 {
 168   assert (in_input_program ());
 169   return CMD_END_INPUT_PROGRAM;
 170 }
 171
 172 /* Returns true if STATE is valid given the transformations that
 173    are allowed within INPUT PROGRAM. */
 174 static bool
 175 is_valid_state (enum trns_result state)
 176 {
 177   return (state == TRNS_CONTINUE
 178           || state == TRNS_ERROR
 179           || state == TRNS_END_FILE
 180           || state >= 0);
 181 }
 182
 183 /* Reads and returns one case.
 184    Returns the case if successful, null at end of file or if an
 185    I/O error occurred. */
 186 static struct ccase *
 187 input_program_casereader_read (struct casereader *reader UNUSED, void *inp_)
 188 {
 189   struct input_program_pgm *inp = inp_;
 190   struct ccase *c = case_create (inp->value_cnt);
 191
 192   do
 193     {
 194       assert (is_valid_state (inp->restart));
 195       if (inp->restart == TRNS_ERROR || inp->restart == TRNS_END_FILE)
 196         {
 197           case_unref (c);
 198           return NULL;
 199         }
 200
 201       c = case_unshare (c);
 202       caseinit_init_vars (inp->init, c);
 203       inp->restart = trns_chain_execute (inp->trns_chain, inp->restart,
 204                                          &c, inp->case_nr);
 205       assert (is_valid_state (inp->restart));
 206       caseinit_update_left_vars (inp->init, c);
 207     }
 208   while (inp->restart < 0);
 209
 210   return c;
 211 }
 212
 213 static void
 214 destroy_input_program (struct input_program_pgm *pgm)
 215 {
 216   if (pgm != NULL)
 217     {
 218       trns_chain_destroy (pgm->trns_chain);
 219       caseinit_destroy (pgm->init);
 220       free (pgm);
 221     }
 222 }
 223
 224 /* Destroys the casereader. */
 225 static void
 226 input_program_casereader_destroy (struct casereader *reader UNUSED, void *inp_)
 227 {
 228   struct input_program_pgm *inp = inp_;
 229   if (inp->restart == TRNS_ERROR)
 230     casereader_force_error (reader);
 231   destroy_input_program (inp);
 232 }
 233
 234 static const struct casereader_class input_program_casereader_class =
 235   {
 236     input_program_casereader_read,
 237     input_program_casereader_destroy,
 238     NULL,
 239     NULL,
 240   };
 241 \f
 242 int
 243 cmd_end_case (struct lexer *lexer, struct dataset *ds UNUSED)
 244 {
 245   assert (in_input_program ());
 246   if (lex_token (lexer) == '.')
 247     return CMD_END_CASE;
 248   return lex_end_of_command (lexer);
 249 }
 250
 251 /* Outputs the current case */
 252 int
 253 end_case_trns_proc (void *inp_, struct ccase **c UNUSED,
 254                     casenumber case_nr UNUSED)
 255 {
 256   struct input_program_pgm *inp = inp_;
 257   inp->case_nr++;
 258   return TRNS_END_CASE;
 259 }
 260
 261 /* REREAD transformation. */
 262 struct reread_trns
 263   {
 264     struct dfm_reader *reader;  /* File to move file pointer back on. */
 265     struct expression *column;  /* Column to reset file pointer to. */
 266   };
 267
 268 /* Parses REREAD command. */
 269 int
 270 cmd_reread (struct lexer *lexer, struct dataset *ds)
 271 {
 272   struct file_handle *fh;       /* File to be re-read. */
 273   struct expression *e;         /* Expression for column to set. */
 274   struct reread_trns *t;        /* Created transformation. */
 275
 276   fh = fh_get_default_handle ();
 277   e = NULL;
 278   while (lex_token (lexer) != '.')
 279     {
 280       if (lex_match_id (lexer, "COLUMN"))
 281         {
 282           lex_match (lexer, '=');
 283
 284           if (e)
 285             {
 286               msg (SE, _("COLUMN subcommand multiply specified."));
 287               expr_free (e);
 288               return CMD_CASCADING_FAILURE;
 289             }
 290
 291           e = expr_parse (lexer, ds, EXPR_NUMBER);
 292           if (!e)
 293             return CMD_CASCADING_FAILURE;
 294         }
 295       else if (lex_match_id (lexer, "FILE"))
 296         {
 297           lex_match (lexer, '=');
 298           fh_unref (fh);
 299           fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE);
 300           if (fh == NULL)
 301             {
 302               expr_free (e);
 303               return CMD_CASCADING_FAILURE;
 304             }
 305         }
 306       else
 307         {
 308           lex_error (lexer, NULL);
 309           expr_free (e);
 310           return CMD_CASCADING_FAILURE;
 311         }
 312     }
 313
 314   t = xmalloc (sizeof *t);
 315   t->reader = dfm_open_reader (fh, lexer);
 316   t->column = e;
 317   add_transformation (ds, reread_trns_proc, reread_trns_free, t);
 318
 319   fh_unref (fh);
 320   return CMD_SUCCESS;
 321 }
 322
 323 /* Executes a REREAD transformation. */
 324 static int
 325 reread_trns_proc (void *t_, struct ccase **c, casenumber case_num)
 326 {
 327   struct reread_trns *t = t_;
 328
 329   if (t->column == NULL)
 330     dfm_reread_record (t->reader, 1);
 331   else
 332     {
 333       double column = expr_evaluate_num (t->column, *c, case_num);
 334       if (!isfinite (column) || column < 1)
 335         {
 336           msg (SE, _("REREAD: Column numbers must be positive finite "
 337                "numbers.  Column set to 1."));
 338           dfm_reread_record (t->reader, 1);
 339         }
 340       else
 341         dfm_reread_record (t->reader, column);
 342     }
 343   return TRNS_CONTINUE;
 344 }
 345
 346 /* Frees a REREAD transformation.
 347    Returns true if successful, false if an I/O error occurred. */
 348 static bool
 349 reread_trns_free (void *t_)
 350 {
 351   struct reread_trns *t = t_;
 352   expr_free (t->column);
 353   dfm_close_reader (t->reader);
 354   return true;
 355 }
 356
 357 /* Parses END FILE command. */
 358 int
 359 cmd_end_file (struct lexer *lexer, struct dataset *ds)
 360 {
 361   assert (in_input_program ());
 362
 363   add_transformation (ds, end_file_trns_proc, NULL, NULL);
 364
 365   return lex_end_of_command (lexer);
 366 }
 367
 368 /* Executes an END FILE transformation. */
 369 static int
 370 end_file_trns_proc (void *trns_ UNUSED, struct ccase **c UNUSED,
 371                     casenumber case_num UNUSED)
 372 {
 373   return TRNS_END_FILE;
 374 }