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

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   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.
   9
  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.
  14
  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
  18    02110-1301, USA. */
  19
  20 #include <config.h>
  21
  22 #include <language/data-io/inpt-pgm.h>
  23
  24 #include <float.h>
  25 #include <stdlib.h>
  26
  27 #include <data/case-source.h>
  28 #include <data/case.h>
  29 #include <data/case-source.h>
  30 #include <data/dictionary.h>
  31 #include <data/procedure.h>
  32 #include <data/transformations.h>
  33 #include <data/variable.h>
  34 #include <language/command.h>
  35 #include <language/data-io/data-reader.h>
  36 #include <language/data-io/file-handle.h>
  37 #include <language/expressions/public.h>
  38 #include <language/lexer/lexer.h>
  39 #include <libpspp/alloc.h>
  40 #include <libpspp/assertion.h>
  41 #include <libpspp/compiler.h>
  42 #include <libpspp/message.h>
  43 #include <libpspp/message.h>
  44 #include <libpspp/misc.h>
  45 #include <libpspp/str.h>
  46
  47 #include "gettext.h"
  48 #define _(msgid) gettext (msgid)
  49
  50 /* Private result codes for use within INPUT PROGRAM. */
  51 enum cmd_result_extensions
  52   {
  53     CMD_END_INPUT_PROGRAM = CMD_PRIVATE_FIRST,
  54     CMD_END_CASE
  55   };
  56
  57 /* Indicates how a `union value' should be initialized. */
  58 enum value_init_type
  59   {
  60     INP_NUMERIC = 01,           /* Numeric. */
  61     INP_STRING = 0,             /* String. */
  62
  63     INP_INIT_ONCE = 02,         /* Initialize only once. */
  64     INP_REINIT = 0,             /* Reinitialize for each iteration. */
  65   };
  66
  67 struct input_program_pgm
  68   {
  69     struct trns_chain *trns_chain;
  70
  71     size_t case_nr;             /* Incremented by END CASE transformation. */
  72     write_case_func *write_case;/* Called by END CASE. */
  73     write_case_data wc_data;    /* Aux data used by END CASE. */
  74
  75     enum value_init_type *init; /* How to initialize each `union value'. */
  76     size_t init_cnt;            /* Number of elements in inp_init. */
  77     size_t case_size;           /* Size of case in bytes. */
  78   };
  79
  80 static void destroy_input_program (struct input_program_pgm *);
  81 static trns_proc_func end_case_trns_proc;
  82 static trns_proc_func reread_trns_proc;
  83 static trns_proc_func end_file_trns_proc;
  84 static trns_free_func reread_trns_free;
  85
  86 static const struct case_source_class input_program_source_class;
  87
  88 static bool inside_input_program;
  89
  90 /* Returns true if we're parsing the inside of a INPUT
  91    PROGRAM...END INPUT PROGRAM construct, false otherwise. */
  92 bool
  93 in_input_program (void)
  94 {
  95   return inside_input_program;
  96 }
  97
  98 /* Emits an END CASE transformation for INP. */
  99 static void
 100 emit_END_CASE (struct dataset *ds, struct input_program_pgm *inp)
 101 {
 102   add_transformation (ds, end_case_trns_proc, NULL, inp);
 103 }
 104
 105 int
 106 cmd_input_program (struct lexer *lexer, struct dataset *ds)
 107 {
 108   struct input_program_pgm *inp;
 109   size_t i;
 110   bool saw_END_CASE = false;
 111
 112   discard_variables (ds);
 113   if (lex_token (lexer) != '.')
 114     return lex_end_of_command (lexer);
 115
 116   inp = xmalloc (sizeof *inp);
 117   inp->trns_chain = NULL;
 118   inp->init = NULL;
 119
 120   inside_input_program = true;
 121   for (;;)
 122     {
 123       enum cmd_result result = cmd_parse (lexer, ds, CMD_STATE_INPUT_PROGRAM);
 124       if (result == CMD_END_INPUT_PROGRAM)
 125         break;
 126       else if (result == CMD_END_CASE)
 127         {
 128           emit_END_CASE (ds, inp);
 129           saw_END_CASE = true;
 130         }
 131       else if (cmd_result_is_failure (result) && result != CMD_FAILURE)
 132         {
 133           if (result == CMD_EOF)
 134             msg (SE, _("Unexpected end-of-file within INPUT PROGRAM."));
 135           inside_input_program = false;
 136           discard_variables (ds);
 137           destroy_input_program (inp);
 138           return result;
 139         }
 140     }
 141   if (!saw_END_CASE)
 142     emit_END_CASE (ds, inp);
 143   inside_input_program = false;
 144
 145   if (dict_get_next_value_idx (dataset_dict (ds)) == 0)
 146     {
 147       msg (SE, _("Input program did not create any variables."));
 148       discard_variables (ds);
 149       destroy_input_program (inp);
 150       return CMD_FAILURE;
 151     }
 152
 153   inp->trns_chain = proc_capture_transformations (ds);
 154   trns_chain_finalize (inp->trns_chain);
 155
 156   /* Figure out how to initialize each input case. */
 157   inp->init_cnt = dict_get_next_value_idx (dataset_dict (ds));
 158   inp->init = xnmalloc (inp->init_cnt, sizeof *inp->init);
 159   for (i = 0; i < inp->init_cnt; i++)
 160     inp->init[i] = -1;
 161   for (i = 0; i < dict_get_var_cnt (dataset_dict (ds)); i++)
 162     {
 163       struct variable *var = dict_get_var (dataset_dict (ds), i);
 164       size_t value_cnt = var_get_value_cnt (var);
 165       enum value_init_type value_init;
 166       size_t j;
 167
 168       value_init = var_is_numeric (var) ? INP_NUMERIC : INP_STRING;
 169       value_init |= var_get_leave (var) ? INP_INIT_ONCE : INP_REINIT;
 170
 171       for (j = 0; j < value_cnt; j++)
 172         inp->init[j + var_get_case_index (var)] = value_init;
 173     }
 174   for (i = 0; i < inp->init_cnt; i++)
 175     assert (inp->init[i] != -1);
 176   inp->case_size = dict_get_case_size (dataset_dict (ds));
 177
 178   proc_set_source (ds,
 179                   create_case_source (&input_program_source_class, inp));
 180
 181   return CMD_SUCCESS;
 182 }
 183
 184 int
 185 cmd_end_input_program (struct lexer *lexer UNUSED, struct dataset *ds UNUSED)
 186 {
 187   assert (in_input_program ());
 188   return CMD_END_INPUT_PROGRAM;
 189 }
 190
 191 /* Initializes case C.  Called before the first case is read. */
 192 static void
 193 init_case (const struct input_program_pgm *inp, struct ccase *c)
 194 {
 195   size_t i;
 196
 197   for (i = 0; i < inp->init_cnt; i++)
 198     switch (inp->init[i])
 199       {
 200       case INP_NUMERIC | INP_INIT_ONCE:
 201         case_data_rw_idx (c, i)->f = 0.0;
 202         break;
 203       case INP_NUMERIC | INP_REINIT:
 204         case_data_rw_idx (c, i)->f = SYSMIS;
 205         break;
 206       case INP_STRING | INP_INIT_ONCE:
 207       case INP_STRING | INP_REINIT:
 208         memset (case_data_rw_idx (c, i)->s, ' ',
 209                 sizeof case_data_rw_idx (c, i)->s);
 210         break;
 211       default:
 212         NOT_REACHED ();
 213       }
 214 }
 215
 216 /* Clears case C.  Called between reading successive records. */
 217 static void
 218 clear_case (const struct input_program_pgm *inp, struct ccase *c)
 219 {
 220   size_t i;
 221
 222   for (i = 0; i < inp->init_cnt; i++)
 223     switch (inp->init[i])
 224       {
 225       case INP_NUMERIC | INP_INIT_ONCE:
 226         break;
 227       case INP_NUMERIC | INP_REINIT:
 228         case_data_rw_idx (c, i)->f = SYSMIS;
 229         break;
 230       case INP_STRING | INP_INIT_ONCE:
 231         break;
 232       case INP_STRING | INP_REINIT:
 233         memset (case_data_rw_idx (c, i)->s, ' ',
 234                 sizeof case_data_rw_idx (c, i)->s);
 235         break;
 236       default:
 237         NOT_REACHED ();
 238       }
 239 }
 240
 241 /* Executes each transformation in turn on a `blank' case.
 242    Returns true if successful, false if an I/O error occurred. */
 243 static bool
 244 input_program_source_read (struct case_source *source,
 245                            struct ccase *c,
 246                            write_case_func *write_case,
 247                            write_case_data wc_data)
 248 {
 249   struct input_program_pgm *inp = source->aux;
 250
 251   inp->case_nr = 1;
 252   inp->write_case = write_case;
 253   inp->wc_data = wc_data;
 254   for (init_case (inp, c); ; clear_case (inp, c))
 255     {
 256       enum trns_result result = trns_chain_execute (inp->trns_chain, c,
 257                                                     &inp->case_nr);
 258       if (result == TRNS_ERROR)
 259         return false;
 260       else if (result == TRNS_END_FILE)
 261         return true;
 262     }
 263 }
 264
 265 static void
 266 destroy_input_program (struct input_program_pgm *pgm)
 267 {
 268   if (pgm != NULL)
 269     {
 270       trns_chain_destroy (pgm->trns_chain);
 271       free (pgm->init);
 272       free (pgm);
 273     }
 274 }
 275
 276 /* Destroys an INPUT PROGRAM source. */
 277 static void
 278 input_program_source_destroy (struct case_source *source)
 279 {
 280   struct input_program_pgm *inp = source->aux;
 281
 282   destroy_input_program (inp);
 283 }
 284
 285 static const struct case_source_class input_program_source_class =
 286   {
 287     "INPUT PROGRAM",
 288     NULL,
 289     input_program_source_read,
 290     input_program_source_destroy,
 291   };
 292 \f
 293 int
 294 cmd_end_case (struct lexer *lexer, struct dataset *ds UNUSED)
 295 {
 296   assert (in_input_program ());
 297   if (lex_token (lexer) == '.')
 298     return CMD_END_CASE;
 299   return lex_end_of_command (lexer);
 300 }
 301
 302 /* Sends the current case as the source's output. */
 303 int
 304 end_case_trns_proc (void *inp_, struct ccase *c, casenumber case_nr UNUSED)
 305 {
 306   struct input_program_pgm *inp = inp_;
 307
 308   if (!inp->write_case (inp->wc_data))
 309     return TRNS_ERROR;
 310
 311   inp->case_nr++;
 312   clear_case (inp, c);
 313   return TRNS_CONTINUE;
 314 }
 315
 316 /* REREAD transformation. */
 317 struct reread_trns
 318   {
 319     struct dfm_reader *reader;  /* File to move file pointer back on. */
 320     struct expression *column;  /* Column to reset file pointer to. */
 321   };
 322
 323 /* Parses REREAD command. */
 324 int
 325 cmd_reread (struct lexer *lexer, struct dataset *ds)
 326 {
 327   struct file_handle *fh;       /* File to be re-read. */
 328   struct expression *e;         /* Expression for column to set. */
 329   struct reread_trns *t;        /* Created transformation. */
 330
 331   fh = fh_get_default_handle ();
 332   e = NULL;
 333   while (lex_token (lexer) != '.')
 334     {
 335       if (lex_match_id (lexer, "COLUMN"))
 336         {
 337           lex_match (lexer, '=');
 338
 339           if (e)
 340             {
 341               msg (SE, _("COLUMN subcommand multiply specified."));
 342               expr_free (e);
 343               return CMD_CASCADING_FAILURE;
 344             }
 345
 346           e = expr_parse (lexer, ds, EXPR_NUMBER);
 347           if (!e)
 348             return CMD_CASCADING_FAILURE;
 349         }
 350       else if (lex_match_id (lexer, "FILE"))
 351         {
 352           lex_match (lexer, '=');
 353           fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE);
 354           if (fh == NULL)
 355             {
 356               expr_free (e);
 357               return CMD_CASCADING_FAILURE;
 358             }
 359         }
 360       else
 361         {
 362           lex_error (lexer, NULL);
 363           expr_free (e);
 364           return CMD_CASCADING_FAILURE;
 365         }
 366     }
 367
 368   t = xmalloc (sizeof *t);
 369   t->reader = dfm_open_reader (fh, lexer);
 370   t->column = e;
 371   add_transformation (ds, reread_trns_proc, reread_trns_free, t);
 372
 373   return CMD_SUCCESS;
 374 }
 375
 376 /* Executes a REREAD transformation. */
 377 static int
 378 reread_trns_proc (void *t_, struct ccase *c, casenumber case_num)
 379 {
 380   struct reread_trns *t = t_;
 381
 382   if (t->column == NULL)
 383     dfm_reread_record (t->reader, 1);
 384   else
 385     {
 386       double column = expr_evaluate_num (t->column, c, case_num);
 387       if (!finite (column) || column < 1)
 388         {
 389           msg (SE, _("REREAD: Column numbers must be positive finite "
 390                "numbers.  Column set to 1."));
 391           dfm_reread_record (t->reader, 1);
 392         }
 393       else
 394         dfm_reread_record (t->reader, column);
 395     }
 396   return TRNS_CONTINUE;
 397 }
 398
 399 /* Frees a REREAD transformation.
 400    Returns true if successful, false if an I/O error occurred. */
 401 static bool
 402 reread_trns_free (void *t_)
 403 {
 404   struct reread_trns *t = t_;
 405   expr_free (t->column);
 406   dfm_close_reader (t->reader);
 407   return true;
 408 }
 409
 410 /* Parses END FILE command. */
 411 int
 412 cmd_end_file (struct lexer *lexer, struct dataset *ds)
 413 {
 414   assert (in_input_program ());
 415
 416   add_transformation (ds, end_file_trns_proc, NULL, NULL);
 417
 418   return lex_end_of_command (lexer);
 419 }
 420
 421 /* Executes an END FILE transformation. */
 422 static int
 423 end_file_trns_proc (void *trns_ UNUSED, struct ccase *c UNUSED,
 424                     casenumber case_num UNUSED)
 425 {
 426   return TRNS_END_FILE;
 427 }