pintos-os.org Git - pspp/blob - src/language/data-io/inpt-pgm.c

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