src/language/stats/flip.c

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