src/language/stats/flip.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 <ctype.h>
  23 #include <errno.h>
  24 #include <float.h>
  25 #include <limits.h>
  26 #include <stdlib.h>
  27 #ifdef HAVE_SYS_TYPES_H
  28 #include <sys/types.h>
  29 #endif
  30
  31 #include <data/case-sink.h>
  32 #include <data/case-source.h>
  33 #include <data/case.h>
  34 #include <data/dictionary.h>
  35 #include <data/procedure.h>
  36 #include <data/settings.h>
  37 #include <data/value.h>
  38 #include <data/variable.h>
  39 #include <language/command.h>
  40 #include <language/lexer/lexer.h>
  41 #include <language/lexer/variable-parser.h>
  42 #include <libpspp/alloc.h>
  43 #include <libpspp/array.h>
  44 #include <libpspp/assertion.h>
  45 #include <libpspp/message.h>
  46 #include <libpspp/message.h>
  47 #include <libpspp/misc.h>
  48 #include <libpspp/pool.h>
  49 #include <libpspp/str.h>
  50
  51 #include "intprops.h"
  52 #include "minmax.h"
  53
  54 #include "gettext.h"
  55 #define _(msgid) gettext (msgid)
  56
  57 /* List of variable names. */
  58 struct varname
  59   {
  60     struct varname *next;
  61     char name[SHORT_NAME_LEN + 1];
  62   };
  63
  64 /* Represents a FLIP input program. */
  65 struct flip_pgm
  66   {
  67     struct pool *pool;          /* Pool containing FLIP data. */
  68     struct variable **var;      /* Variables to transpose. */
  69     int *idx_to_fv;             /* var[]->index to compacted sink case fv. */
  70     size_t var_cnt;             /* Number of elements in `var'. */
  71     int case_cnt;               /* Pre-flip case count. */
  72     size_t case_size;           /* Post-flip bytes per case. */
  73
  74     union value *output_buf;            /* Case output buffer. */
  75
  76     struct variable *new_names; /* Variable containing new variable names. */
  77     struct varname *new_names_head; /* First new variable. */
  78     struct varname *new_names_tail; /* Last new variable. */
  79
  80     FILE *file;                 /* Temporary file containing data. */
  81   };
  82
  83 static void destroy_flip_pgm (struct flip_pgm *);
  84 static struct case_sink *flip_sink_create (struct dictionary *d, struct flip_pgm *);
  85 static struct case_source *flip_source_create (struct flip_pgm *);
  86 static bool flip_file (struct flip_pgm *);
  87 static int build_dictionary (struct dictionary *, struct flip_pgm *);
  88
  89 static const struct case_source_class flip_source_class;
  90 static const struct case_sink_class flip_sink_class;
  91
  92 /* Parses and executes FLIP. */
  93 int
  94 cmd_flip (struct lexer *lexer, struct dataset *ds)
  95 {
  96   struct flip_pgm *flip;
  97   struct case_sink *sink;
  98   struct dictionary *dict = dataset_dict (ds);
  99   bool ok;
 100
 101   if (proc_make_temporary_transformations_permanent (ds))
 102     msg (SW, _("FLIP ignores TEMPORARY.  "
 103                "Temporary transformations will be made permanent."));
 104
 105   flip = pool_create_container (struct flip_pgm, pool);
 106   flip->var = NULL;
 107   flip->idx_to_fv = dict_get_compacted_dict_index_to_case_index (dict);
 108   pool_register (flip->pool, free, flip->idx_to_fv);
 109   flip->var_cnt = 0;
 110   flip->case_cnt = 0;
 111   flip->new_names = NULL;
 112   flip->new_names_head = NULL;
 113   flip->new_names_tail = NULL;
 114   flip->file = NULL;
 115
 116   lex_match (lexer, '/');
 117   if (lex_match_id (lexer, "VARIABLES"))
 118     {
 119       lex_match (lexer, '=');
 120       if (!parse_variables (lexer, dict, &flip->var, &flip->var_cnt,
 121                             PV_NO_DUPLICATE))
 122         goto error;
 123       lex_match (lexer, '/');
 124     }
 125   else
 126     dict_get_vars (dict, &flip->var, &flip->var_cnt, 1u << DC_SYSTEM);
 127   pool_register (flip->pool, free, flip->var);
 128
 129   lex_match (lexer, '/');
 130   if (lex_match_id (lexer, "NEWNAMES"))
 131     {
 132       lex_match (lexer, '=');
 133       flip->new_names = parse_variable (lexer, dict);
 134       if (!flip->new_names)
 135         goto error;
 136     }
 137   else
 138     flip->new_names = dict_lookup_var (dict, "CASE_LBL");
 139
 140   if (flip->new_names)
 141     {
 142       size_t i;
 143
 144       for (i = 0; i < flip->var_cnt; i++)
 145         if (flip->var[i] == flip->new_names)
 146           {
 147             remove_element (flip->var, flip->var_cnt, sizeof *flip->var, i);
 148             flip->var_cnt--;
 149             break;
 150           }
 151     }
 152
 153   /* Read the active file into a flip_sink. */
 154   flip->case_cnt = 0;
 155   proc_make_temporary_transformations_permanent (ds);
 156   sink = flip_sink_create (dict, flip);
 157   if (sink == NULL)
 158     goto error;
 159   proc_set_sink (ds, sink);
 160   flip->new_names_tail = NULL;
 161   ok = procedure (ds,NULL, NULL);
 162
 163   /* Flip the data we read. */
 164   if (!flip_file (flip))
 165     {
 166       discard_variables (ds);
 167       goto error;
 168     }
 169
 170   /* Flip the dictionary. */
 171   dict_clear (dict);
 172   if (!build_dictionary (dict, flip))
 173     {
 174       discard_variables (ds);
 175       goto error;
 176     }
 177   flip->case_size = dict_get_case_size (dict);
 178
 179   /* Set up flipped data for reading. */
 180   proc_set_source (ds, flip_source_create (flip));
 181
 182   return ok ? lex_end_of_command (lexer) : CMD_CASCADING_FAILURE;
 183
 184  error:
 185   destroy_flip_pgm (flip);
 186   return CMD_CASCADING_FAILURE;
 187 }
 188
 189 /* Destroys FLIP. */
 190 static void
 191 destroy_flip_pgm (struct flip_pgm *flip)
 192 {
 193   if (flip != NULL)
 194     pool_destroy (flip->pool);
 195 }
 196
 197 /* Make a new variable with base name NAME, which is bowdlerized and
 198    mangled until acceptable, and returns success. */
 199 static int
 200 make_new_var (struct dictionary *dict, char name[])
 201 {
 202   char *cp;
 203
 204   /* Trim trailing spaces. */
 205   cp = strchr (name, '\0');
 206   while (cp > name && isspace ((unsigned char) cp[-1]))
 207     *--cp = '\0';
 208
 209   /* Fix invalid characters. */
 210   for (cp = name; *cp && cp < name + SHORT_NAME_LEN; cp++)
 211     if (cp == name)
 212       {
 213         if (!lex_is_id1 (*cp) || *cp == '$')
 214           *cp = 'V';
 215       }
 216     else
 217       {
 218         if (!lex_is_idn (*cp))
 219           *cp = '_';
 220       }
 221   *cp = '\0';
 222   str_uppercase (name);
 223
 224   if (dict_create_var (dict, name, 0))
 225     return 1;
 226
 227   /* Add numeric extensions until acceptable. */
 228   {
 229     const int len = (int) strlen (name);
 230     char n[SHORT_NAME_LEN + 1];
 231     int i;
 232
 233     for (i = 1; i < 10000000; i++)
 234       {
 235         int ofs = MIN (7 - intlog10 (i), len);
 236         memcpy (n, name, ofs);
 237         sprintf (&n[ofs], "%d", i);
 238
 239         if (dict_create_var (dict, n, 0))
 240           return 1;
 241       }
 242   }
 243
 244   msg (SE, _("Could not create acceptable variant for variable %s."), name);
 245   return 0;
 246 }
 247
 248 /* Make a new dictionary for all the new variable names. */
 249 static int
 250 build_dictionary (struct dictionary *dict, struct flip_pgm *flip)
 251 {
 252   dict_create_var_assert (dict, "CASE_LBL", 8);
 253
 254   if (flip->new_names_head == NULL)
 255     {
 256       int i;
 257
 258       if (flip->case_cnt > 99999)
 259         {
 260           msg (SE, _("Cannot create more than 99999 variable names."));
 261           return 0;
 262         }
 263
 264       for (i = 0; i < flip->case_cnt; i++)
 265         {
 266           struct variable *v;
 267           char s[SHORT_NAME_LEN + 1];
 268
 269           sprintf (s, "VAR%03d", i);
 270           v = dict_create_var_assert (dict, s, 0);
 271         }
 272     }
 273   else
 274     {
 275       struct varname *v;
 276
 277       for (v = flip->new_names_head; v; v = v->next)
 278         if (!make_new_var (dict, v->name))
 279           return 0;
 280     }
 281
 282   return 1;
 283 }
 284
 285 /* Creates a flip sink based on FLIP. */
 286 static struct case_sink *
 287 flip_sink_create (struct dictionary *dict, struct flip_pgm *flip)
 288 {
 289   size_t i;
 290
 291   flip->output_buf = pool_nalloc (flip->pool,
 292                                   flip->var_cnt, sizeof *flip->output_buf);
 293
 294   flip->file = pool_tmpfile (flip->pool);
 295   if (flip->file == NULL)
 296     {
 297       msg (SE, _("Could not create temporary file for FLIP."));
 298       return NULL;
 299     }
 300
 301   /* Write variable names as first case. */
 302   for (i = 0; i < flip->var_cnt; i++)
 303     buf_copy_str_rpad (flip->output_buf[i].s, MAX_SHORT_STRING,
 304                        var_get_name (flip->var[i]));
 305   if (fwrite (flip->output_buf, sizeof *flip->output_buf,
 306               flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
 307     {
 308       msg (SE, _("Error writing FLIP file: %s."), strerror (errno));
 309       return NULL;
 310     }
 311
 312   flip->case_cnt = 1;
 313
 314   return create_case_sink (&flip_sink_class, dict, flip);
 315 }
 316
 317 /* Writes case C to the FLIP sink.
 318    Returns true if successful, false if an I/O error occurred. */
 319 static bool
 320 flip_sink_write (struct case_sink *sink, const struct ccase *c)
 321 {
 322   struct flip_pgm *flip = sink->aux;
 323   size_t i;
 324
 325   flip->case_cnt++;
 326
 327   if (flip->new_names != NULL)
 328     {
 329       struct varname *v = pool_alloc (flip->pool, sizeof *v);
 330       int fv = flip->idx_to_fv[var_get_dict_index (flip->new_names)];
 331       v->next = NULL;
 332       if (var_is_numeric (flip->new_names))
 333         {
 334           double f = case_num_idx (c, fv);
 335
 336           if (f == SYSMIS)
 337             strcpy (v->name, "VSYSMIS");
 338           else if (f < INT_MIN)
 339             strcpy (v->name, "VNEGINF");
 340           else if (f > INT_MAX)
 341             strcpy (v->name, "VPOSINF");
 342           else
 343             snprintf (v->name, sizeof v->name, "V%d", (int) f);
 344         }
 345       else
 346         {
 347           int width = MIN (var_get_width (flip->new_names), MAX_SHORT_STRING);
 348           memcpy (v->name, case_str_idx (c, fv), width);
 349           v->name[width] = 0;
 350         }
 351
 352       if (flip->new_names_head == NULL)
 353         flip->new_names_head = v;
 354       else
 355         flip->new_names_tail->next = v;
 356       flip->new_names_tail = v;
 357     }
 358
 359   /* Write to external file. */
 360   for (i = 0; i < flip->var_cnt; i++)
 361     {
 362       double out;
 363
 364       if (var_is_numeric (flip->var[i]))
 365         {
 366           int fv = flip->idx_to_fv[var_get_dict_index (flip->var[i])];
 367           out = case_num_idx (c, fv);
 368         }
 369       else
 370         out = SYSMIS;
 371       flip->output_buf[i].f = out;
 372     }
 373
 374   if (fwrite (flip->output_buf, sizeof *flip->output_buf,
 375               flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
 376     {
 377       msg (SE, _("Error writing FLIP file: %s."), strerror (errno));
 378       return false;
 379     }
 380   return true;
 381 }
 382
 383 /* Transposes the external file into a new file. */
 384 static bool
 385 flip_file (struct flip_pgm *flip)
 386 {
 387   size_t case_bytes;
 388   size_t case_capacity;
 389   size_t case_idx;
 390   union value *input_buf, *output_buf;
 391   FILE *input_file, *output_file;
 392
 393   /* Allocate memory for many cases. */
 394   case_bytes = flip->var_cnt * sizeof *input_buf;
 395   case_capacity = get_workspace () / case_bytes;
 396   if (case_capacity > flip->case_cnt * 2)
 397     case_capacity = flip->case_cnt * 2;
 398   if (case_capacity < 2)
 399     case_capacity = 2;
 400   for (;;)
 401     {
 402       size_t bytes = case_bytes * case_capacity;
 403       if (case_capacity > 2)
 404         input_buf = malloc (bytes);
 405       else
 406         input_buf = xmalloc (bytes);
 407       if (input_buf != NULL)
 408         break;
 409
 410       case_capacity /= 2;
 411       if (case_capacity < 2)
 412         case_capacity = 2;
 413     }
 414   pool_register (flip->pool, free, input_buf);
 415
 416   /* Use half the allocated memory for input_buf, half for
 417      output_buf. */
 418   case_capacity /= 2;
 419   output_buf = input_buf + flip->var_cnt * case_capacity;
 420
 421   input_file = flip->file;
 422   if (fseek (input_file, 0, SEEK_SET) != 0)
 423     {
 424       msg (SE, _("Error rewinding FLIP file: %s."), strerror (errno));
 425       return false;
 426     }
 427
 428   output_file = pool_tmpfile (flip->pool);
 429   if (output_file == NULL)
 430     {
 431       msg (SE, _("Error creating FLIP source file."));
 432       return false;
 433     }
 434
 435   for (case_idx = 0; case_idx < flip->case_cnt; )
 436     {
 437       unsigned long read_cases = MIN (flip->case_cnt - case_idx,
 438                                       case_capacity);
 439       size_t i;
 440
 441       if (read_cases != fread (input_buf, case_bytes, read_cases, input_file))
 442         {
 443           msg (SE, _("Error reading FLIP file: %s."), strerror (errno));
 444           return false;
 445         }
 446
 447       for (i = 0; i < flip->var_cnt; i++)
 448         {
 449           unsigned long j;
 450
 451           for (j = 0; j < read_cases; j++)
 452             output_buf[j] = input_buf[i + j * flip->var_cnt];
 453
 454 #ifndef HAVE_FSEEKO
 455 #define fseeko fseek
 456 #endif
 457
 458 #ifndef HAVE_OFF_T
 459 #define off_t long int
 460 #endif
 461
 462           if (fseeko (output_file,
 463                       sizeof *input_buf * (case_idx
 464                                            + (off_t) i * flip->case_cnt),
 465                       SEEK_SET) != 0)
 466             {
 467               msg (SE, _("Error seeking FLIP source file: %s."),
 468                    strerror (errno));
 469               return false;
 470             }
 471
 472           if (fwrite (output_buf, sizeof *output_buf, read_cases, output_file)
 473               != read_cases)
 474             {
 475               msg (SE, _("Error writing FLIP source file: %s."),
 476                    strerror (errno));
 477               return false;
 478             }
 479         }
 480
 481       case_idx += read_cases;
 482     }
 483
 484   if (pool_fclose (flip->pool, input_file) == EOF)
 485     {
 486       msg (SE, _("Error closing FLIP source file: %s."), strerror (errno));
 487       return false;
 488     }
 489   pool_unregister (flip->pool, input_buf);
 490   free (input_buf);
 491
 492   if (fseek (output_file, 0, SEEK_SET) != 0)
 493     {
 494       msg (SE, _("Error rewinding FLIP source file: %s."), strerror (errno));
 495       return false;
 496     }
 497   flip->file = output_file;
 498
 499   return true;
 500 }
 501
 502 /* FLIP sink class. */
 503 static const struct case_sink_class flip_sink_class =
 504   {
 505     "FLIP",
 506     NULL,
 507     flip_sink_write,
 508     NULL,
 509     NULL,
 510   };
 511
 512 /* Creates and returns a FLIP source based on PGM,
 513    which should have already been used as a sink. */
 514 static struct case_source *
 515 flip_source_create (struct flip_pgm *pgm)
 516 {
 517   return create_case_source (&flip_source_class, pgm);
 518 }
 519
 520 /* Reads the FLIP stream.  Copies each case into C and calls
 521    WRITE_CASE passing WC_DATA.
 522    Returns true if successful, false if an I/O error occurred. */
 523 static bool
 524 flip_source_read (struct case_source *source,
 525                   struct ccase *c,
 526                   write_case_func *write_case, write_case_data wc_data)
 527 {
 528   struct flip_pgm *flip = source->aux;
 529   union value *input_buf;
 530   size_t i;
 531   bool ok = true;
 532
 533   input_buf = xnmalloc (flip->case_cnt, sizeof *input_buf);
 534   for (i = 0; ok && i < flip->var_cnt; i++)
 535     {
 536       size_t j;
 537
 538       if (fread (input_buf, sizeof *input_buf, flip->case_cnt,
 539                  flip->file) != flip->case_cnt)
 540         {
 541           if (ferror (flip->file))
 542             msg (SE, _("Error reading FLIP temporary file: %s."),
 543                  strerror (errno));
 544           else if (feof (flip->file))
 545             msg (SE, _("Unexpected end of file reading FLIP temporary file."));
 546           else
 547             NOT_REACHED ();
 548           ok = false;
 549           break;
 550         }
 551
 552       for (j = 0; j < flip->case_cnt; j++)
 553         case_data_rw_idx (c, j)->f = input_buf[j].f;
 554       ok = write_case (wc_data);
 555     }
 556   free (input_buf);
 557
 558   return ok;
 559 }
 560
 561 /* Destroy internal data in SOURCE. */
 562 static void
 563 flip_source_destroy (struct case_source *source)
 564 {
 565   struct flip_pgm *flip = source->aux;
 566
 567   destroy_flip_pgm (flip);
 568 }
 569
 570 static const struct case_source_class flip_source_class =
 571   {
 572     "FLIP",
 573     NULL,
 574     flip_source_read,
 575     flip_source_destroy
 576   };