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->fv] = 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 (c, i)->f = 0.0;
 202         break;
 203       case INP_NUMERIC | INP_REINIT:
 204         case_data_rw (c, i)->f = SYSMIS;
 205         break;
 206       case INP_STRING | INP_INIT_ONCE:
 207       case INP_STRING | INP_REINIT:
 208         memset (case_data_rw (c, i)->s, ' ', sizeof case_data_rw (c, i)->s);
 209         break;
 210       default:
 211         NOT_REACHED ();
 212       }
 213 }
 214
 215 /* Clears case C.  Called between reading successive records. */
 216 static void
 217 clear_case (const struct input_program_pgm *inp, struct ccase *c)
 218 {
 219   size_t i;
 220
 221   for (i = 0; i < inp->init_cnt; i++)
 222     switch (inp->init[i])
 223       {
 224       case INP_NUMERIC | INP_INIT_ONCE:
 225         break;
 226       case INP_NUMERIC | INP_REINIT:
 227         case_data_rw (c, i)->f = SYSMIS;
 228         break;
 229       case INP_STRING | INP_INIT_ONCE:
 230         break;
 231       case INP_STRING | INP_REINIT:
 232         memset (case_data_rw (c, i)->s, ' ', sizeof case_data_rw (c, i)->s);
 233         break;
 234       default:
 235         NOT_REACHED ();
 236       }
 237 }
 238
 239 /* Executes each transformation in turn on a `blank' case.
 240    Returns true if successful, false if an I/O error occurred. */
 241 static bool
 242 input_program_source_read (struct case_source *source,
 243                            struct ccase *c,
 244                            write_case_func *write_case,
 245                            write_case_data wc_data)
 246 {
 247   struct input_program_pgm *inp = source->aux;
 248
 249   inp->case_nr = 1;
 250   inp->write_case = write_case;
 251   inp->wc_data = wc_data;
 252   for (init_case (inp, c); ; clear_case (inp, c))
 253     {
 254       enum trns_result result = trns_chain_execute (inp->trns_chain, c,
 255                                                     &inp->case_nr);
 256       if (result == TRNS_ERROR)
 257         return false;
 258       else if (result == TRNS_END_FILE)
 259         return true;
 260     }
 261 }
 262
 263 static void
 264 destroy_input_program (struct input_program_pgm *pgm)
 265 {
 266   if (pgm != NULL)
 267     {
 268       trns_chain_destroy (pgm->trns_chain);
 269       free (pgm->init);
 270       free (pgm);
 271     }
 272 }
 273
 274 /* Destroys an INPUT PROGRAM source. */
 275 static void
 276 input_program_source_destroy (struct case_source *source)
 277 {
 278   struct input_program_pgm *inp = source->aux;
 279
 280   destroy_input_program (inp);
 281 }
 282
 283 static const struct case_source_class input_program_source_class =
 284   {
 285     "INPUT PROGRAM",
 286     NULL,
 287     input_program_source_read,
 288     input_program_source_destroy,
 289   };
 290 \f
 291 int
 292 cmd_end_case (struct lexer *lexer, struct dataset *ds UNUSED)
 293 {
 294   assert (in_input_program ());
 295   if (lex_token (lexer) == '.')
 296     return CMD_END_CASE;
 297   return lex_end_of_command (lexer);
 298 }
 299
 300 /* Sends the current case as the source's output. */
 301 int
 302 end_case_trns_proc (void *inp_, struct ccase *c, casenumber case_nr UNUSED)
 303 {
 304   struct input_program_pgm *inp = inp_;
 305
 306   if (!inp->write_case (inp->wc_data))
 307     return TRNS_ERROR;
 308
 309   inp->case_nr++;
 310   clear_case (inp, c);
 311   return TRNS_CONTINUE;
 312 }
 313
 314 /* REREAD transformation. */
 315 struct reread_trns
 316   {
 317     struct dfm_reader *reader;  /* File to move file pointer back on. */
 318     struct expression *column;  /* Column to reset file pointer to. */
 319   };
 320
 321 /* Parses REREAD command. */
 322 int
 323 cmd_reread (struct lexer *lexer, struct dataset *ds)
 324 {
 325   struct file_handle *fh;       /* File to be re-read. */
 326   struct expression *e;         /* Expression for column to set. */
 327   struct reread_trns *t;        /* Created transformation. */
 328
 329   fh = fh_get_default_handle ();
 330   e = NULL;
 331   while (lex_token (lexer) != '.')
 332     {
 333       if (lex_match_id (lexer, "COLUMN"))
 334         {
 335           lex_match (lexer, '=');
 336
 337           if (e)
 338             {
 339               msg (SE, _("COLUMN subcommand multiply specified."));
 340               expr_free (e);
 341               return CMD_CASCADING_FAILURE;
 342             }
 343
 344           e = expr_parse (lexer, ds, EXPR_NUMBER);
 345           if (!e)
 346             return CMD_CASCADING_FAILURE;
 347         }
 348       else if (lex_match_id (lexer, "FILE"))
 349         {
 350           lex_match (lexer, '=');
 351           fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE);
 352           if (fh == NULL)
 353             {
 354               expr_free (e);
 355               return CMD_CASCADING_FAILURE;
 356             }
 357         }
 358       else
 359         {
 360           lex_error (lexer, NULL);
 361           expr_free (e);
 362           return CMD_CASCADING_FAILURE;
 363         }
 364     }
 365
 366   t = xmalloc (sizeof *t);
 367   t->reader = dfm_open_reader (fh, lexer);
 368   t->column = e;
 369   add_transformation (ds, reread_trns_proc, reread_trns_free, t);
 370
 371   return CMD_SUCCESS;
 372 }
 373
 374 /* Executes a REREAD transformation. */
 375 static int
 376 reread_trns_proc (void *t_, struct ccase *c, casenumber case_num)
 377 {
 378   struct reread_trns *t = t_;
 379
 380   if (t->column == NULL)
 381     dfm_reread_record (t->reader, 1);
 382   else
 383     {
 384       double column = expr_evaluate_num (t->column, c, case_num);
 385       if (!finite (column) || column < 1)
 386         {
 387           msg (SE, _("REREAD: Column numbers must be positive finite "
 388                "numbers.  Column set to 1."));
 389           dfm_reread_record (t->reader, 1);
 390         }
 391       else
 392         dfm_reread_record (t->reader, column);
 393     }
 394   return TRNS_CONTINUE;
 395 }
 396
 397 /* Frees a REREAD transformation.
 398    Returns true if successful, false if an I/O error occurred. */
 399 static bool
 400 reread_trns_free (void *t_)
 401 {
 402   struct reread_trns *t = t_;
 403   expr_free (t->column);
 404   dfm_close_reader (t->reader);
 405   return true;
 406 }
 407
 408 /* Parses END FILE command. */
 409 int
 410 cmd_end_file (struct lexer *lexer, struct dataset *ds)
 411 {
 412   assert (in_input_program ());
 413
 414   add_transformation (ds, end_file_trns_proc, NULL, NULL);
 415
 416   return lex_end_of_command (lexer);
 417 }
 418
 419 /* Executes an END FILE transformation. */
 420 static int
 421 end_file_trns_proc (void *trns_ UNUSED, struct ccase *c UNUSED,
 422                     casenumber case_num UNUSED)
 423 {
 424   return TRNS_END_FILE;
 425 }