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
  53     struct trns_chain xforms;
  54     size_t idx;
  55     bool eof;
  56
  57     casenumber case_nr;             /* Incremented by END CASE transformation. */
  58
  59     struct caseinit *init;
  60     struct caseproto *proto;
  61   };
  62
  63 static void destroy_input_program (struct input_program_pgm *);
  64 static const struct trns_class end_case_trns_class;
  65 static const struct trns_class reread_trns_class;
  66 static const struct trns_class end_file_trns_class;
  67
  68 static const struct casereader_class input_program_casereader_class;
  69
  70 static bool inside_input_program;
  71 static bool saw_END_CASE;
  72 static bool saw_END_FILE;
  73 static bool saw_DATA_LIST;
  74
  75 /* Returns true if we're parsing the inside of a INPUT
  76    PROGRAM...END INPUT PROGRAM construct, false otherwise. */
  77 bool
  78 in_input_program (void)
  79 {
  80   return inside_input_program;
  81 }
  82
  83 void
  84 data_list_seen (void)
  85 {
  86   saw_DATA_LIST = true;
  87 }
  88
  89 /* Emits an END CASE transformation for INP. */
  90 static void
  91 emit_END_CASE (struct dataset *ds)
  92 {
  93   add_transformation (ds, &end_case_trns_class, xzalloc (sizeof (bool)));
  94 }
  95
  96 int
  97 cmd_input_program (struct lexer *lexer, struct dataset *ds)
  98 {
  99   struct msg_location *location = lex_ofs_location (lexer, 0, 1);
 100   if (!lex_match (lexer, T_ENDCMD))
 101     {
 102       msg_location_destroy (location);
 103       return lex_end_of_command (lexer);
 104     }
 105
 106   struct session *session = session_create (dataset_session (ds));
 107   struct dataset *inp_ds = dataset_create (session, "INPUT PROGRAM");
 108
 109   struct input_program_pgm *inp = xmalloc (sizeof *inp);
 110   *inp = (struct input_program_pgm) { .session = session, .ds = inp_ds };
 111
 112   proc_push_transformations (inp->ds);
 113   inside_input_program = true;
 114   saw_END_CASE = saw_END_FILE = saw_DATA_LIST = false;
 115   while (!lex_match_phrase (lexer, "END INPUT PROGRAM"))
 116     {
 117       enum cmd_result result;
 118
 119       result = cmd_parse_in_state (lexer, inp->ds, CMD_STATE_INPUT_PROGRAM);
 120       if (result == CMD_EOF
 121           || result == CMD_FINISH
 122           || result == CMD_CASCADING_FAILURE)
 123         {
 124           proc_pop_transformations (inp->ds, &inp->xforms);
 125
 126           if (result == CMD_EOF)
 127             msg (SE, _("Unexpected end-of-file within %s."), "INPUT PROGRAM");
 128           inside_input_program = false;
 129           destroy_input_program (inp);
 130           msg_location_destroy (location);
 131           return result;
 132         }
 133     }
 134   if (!saw_END_CASE)
 135     emit_END_CASE (inp->ds);
 136   inside_input_program = false;
 137   proc_pop_transformations (inp->ds, &inp->xforms);
 138
 139   struct msg_location *end = lex_ofs_location (lexer, 0, 2);
 140   msg_location_merge (&location, end);
 141   location->omit_underlines = true;
 142   msg_location_destroy (end);
 143
 144   if (!saw_DATA_LIST && !saw_END_FILE)
 145     {
 146       msg_at (SE, location, _("Input program does not contain %s or %s."),
 147               "DATA LIST", "END FILE");
 148       destroy_input_program (inp);
 149       msg_location_destroy (location);
 150       return CMD_FAILURE;
 151     }
 152   if (dict_get_next_value_idx (dataset_dict (inp->ds)) == 0)
 153     {
 154       msg_at (SE, location, _("Input program did not create any variables."));
 155       destroy_input_program (inp);
 156       msg_location_destroy (location);
 157       return CMD_FAILURE;
 158     }
 159   msg_location_destroy (location);
 160
 161   /* Figure out how to initialize each input case. */
 162   inp->init = caseinit_create ();
 163   caseinit_mark_for_init (inp->init, dataset_dict (inp->ds));
 164   inp->proto = caseproto_ref (dict_get_proto (dataset_dict (inp->ds)));
 165
 166   dataset_set_dict (ds, dict_clone (dataset_dict (inp->ds)));
 167   dataset_set_source (
 168     ds, casereader_create_sequential (NULL, inp->proto, CASENUMBER_MAX,
 169                                       &input_program_casereader_class, inp));
 170
 171   return CMD_SUCCESS;
 172 }
 173
 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_)
 179 {
 180   struct input_program_pgm *inp = inp_;
 181
 182   if (inp->eof || !inp->xforms.n)
 183     return NULL;
 184
 185   struct ccase *c = case_create (inp->proto);
 186   caseinit_init_vars (inp->init, c);
 187
 188   for (size_t i = inp->idx < inp->xforms.n ? inp->idx : 0; ; i++)
 189     {
 190       if (i >= inp->xforms.n)
 191         {
 192           i = 0;
 193           c = case_unshare (c);
 194           caseinit_update_left_vars (inp->init, c);
 195           caseinit_init_vars (inp->init, c);
 196         }
 197
 198       const struct transformation *trns = &inp->xforms.xforms[i];
 199       switch (trns->class->execute (trns->aux, &c, inp->case_nr))
 200         {
 201         case TRNS_END_CASE:
 202           inp->case_nr++;
 203           inp->idx = i;
 204           return c;
 205
 206         case TRNS_ERROR:
 207           casereader_force_error (reader);
 208           /* Fall through. */
 209         case TRNS_END_FILE:
 210           inp->eof = true;
 211           case_unref (c);
 212           return NULL;
 213
 214         case TRNS_CONTINUE:
 215           break;
 216
 217         default:
 218           NOT_REACHED ();
 219         }
 220     }
 221 }
 222
 223 static void
 224 destroy_input_program (struct input_program_pgm *pgm)
 225 {
 226   if (pgm != NULL)
 227     {
 228       session_destroy (pgm->session);
 229       trns_chain_uninit (&pgm->xforms);
 230       caseinit_destroy (pgm->init);
 231       caseproto_unref (pgm->proto);
 232       free (pgm);
 233     }
 234 }
 235
 236 /* Destroys the casereader. */
 237 static void
 238 input_program_casereader_destroy (struct casereader *reader UNUSED, void *inp_)
 239 {
 240   struct input_program_pgm *inp = inp_;
 241   destroy_input_program (inp);
 242 }
 243
 244 static const struct casereader_class input_program_casereader_class =
 245   {
 246     input_program_casereader_read,
 247     input_program_casereader_destroy,
 248     NULL,
 249     NULL,
 250   };
 251 \f
 252 int
 253 cmd_end_case (struct lexer *lexer UNUSED, struct dataset *ds)
 254 {
 255   assert (in_input_program ());
 256   emit_END_CASE (ds);
 257   saw_END_CASE = true;
 258   return CMD_SUCCESS;
 259 }
 260
 261 /* Outputs the current case */
 262 static enum trns_result
 263 end_case_trns_proc (void *resume_, struct ccase **c UNUSED,
 264                     casenumber case_nr UNUSED)
 265 {
 266   bool *resume = resume_;
 267   enum trns_result retval = *resume ? TRNS_CONTINUE : TRNS_END_CASE;
 268   *resume = !*resume;
 269   return retval;
 270 }
 271
 272 static bool
 273 end_case_trns_free (void *resume)
 274 {
 275   free (resume);
 276   return true;
 277 }
 278
 279 static const struct trns_class end_case_trns_class = {
 280   .name = "END CASE",
 281   .execute = end_case_trns_proc,
 282   .destroy = end_case_trns_free,
 283 };
 284
 285 /* REREAD transformation. */
 286 struct reread_trns
 287   {
 288     struct dfm_reader *reader;  /* File to move file pointer back on. */
 289     struct expression *column;  /* Column to reset file pointer to. */
 290   };
 291
 292 /* Parses REREAD command. */
 293 int
 294 cmd_reread (struct lexer *lexer, struct dataset *ds)
 295 {
 296   char *encoding = NULL;
 297   struct file_handle *fh = fh_get_default_handle ();
 298   struct expression *e = NULL;
 299   while (lex_token (lexer) != T_ENDCMD)
 300     {
 301       if (lex_match_id (lexer, "COLUMN"))
 302         {
 303           lex_match (lexer, T_EQUALS);
 304
 305           if (e)
 306             {
 307               lex_sbc_only_once (lexer, "COLUMN");
 308               goto error;
 309             }
 310
 311           e = expr_parse (lexer, ds, VAL_NUMERIC);
 312           if (!e)
 313             goto error;
 314         }
 315       else if (lex_match_id (lexer, "FILE"))
 316         {
 317           lex_match (lexer, T_EQUALS);
 318           fh_unref (fh);
 319           fh = fh_parse (lexer, FH_REF_FILE | FH_REF_INLINE, NULL);
 320           if (fh == NULL)
 321             goto error;
 322         }
 323       else if (lex_match_id (lexer, "ENCODING"))
 324         {
 325           lex_match (lexer, T_EQUALS);
 326           if (!lex_force_string (lexer))
 327             goto error;
 328
 329           free (encoding);
 330           encoding = ss_xstrdup (lex_tokss (lexer));
 331
 332           lex_get (lexer);
 333         }
 334       else
 335         {
 336           lex_error_expecting (lexer, "COLUMN", "FILE", "ENCODING");
 337           goto error;
 338         }
 339     }
 340
 341   struct reread_trns *t = xmalloc (sizeof *t);
 342   *t = (struct reread_trns) {
 343     .reader = dfm_open_reader (fh, lexer, encoding),
 344     .column = e,
 345   };
 346   add_transformation (ds, &reread_trns_class, t);
 347
 348   fh_unref (fh);
 349   free (encoding);
 350   return CMD_SUCCESS;
 351
 352 error:
 353   expr_free (e);
 354   free (encoding);
 355   return CMD_CASCADING_FAILURE;
 356 }
 357
 358 /* Executes a REREAD transformation. */
 359 static enum trns_result
 360 reread_trns_proc (void *t_, struct ccase **c, casenumber case_num)
 361 {
 362   struct reread_trns *t = t_;
 363
 364   if (t->column == NULL)
 365     dfm_reread_record (t->reader, 1);
 366   else
 367     {
 368       double column = expr_evaluate_num (t->column, *c, case_num);
 369       if (!isfinite (column) || column < 1)
 370         {
 371           msg (SE, _("REREAD: Column numbers must be positive finite "
 372                "numbers.  Column set to 1."));
 373           dfm_reread_record (t->reader, 1);
 374         }
 375       else
 376         dfm_reread_record (t->reader, column);
 377     }
 378   return TRNS_CONTINUE;
 379 }
 380
 381 /* Frees a REREAD transformation.
 382    Returns true if successful, false if an I/O error occurred. */
 383 static bool
 384 reread_trns_free (void *t_)
 385 {
 386   struct reread_trns *t = t_;
 387   expr_free (t->column);
 388   dfm_close_reader (t->reader);
 389   return true;
 390 }
 391
 392 static const struct trns_class reread_trns_class = {
 393   .name = "REREAD",
 394   .execute = reread_trns_proc,
 395   .destroy = reread_trns_free,
 396 };
 397
 398 /* Parses END FILE command. */
 399 int
 400 cmd_end_file (struct lexer *lexer UNUSED, struct dataset *ds)
 401 {
 402   assert (in_input_program ());
 403
 404   add_transformation (ds, &end_file_trns_class, NULL);
 405   saw_END_FILE = true;
 406
 407   return CMD_SUCCESS;
 408 }
 409
 410 /* Executes an END FILE transformation. */
 411 static enum trns_result
 412 end_file_trns_proc (void *trns_ UNUSED, struct ccase **c UNUSED,
 413                     casenumber case_num UNUSED)
 414 {
 415   return TRNS_END_FILE;
 416 }
 417
 418 static const struct trns_class end_file_trns_class = {
 419   .name = "END FILE",
 420   .execute = end_file_trns_proc,
 421 };