pintos-os.org Git - pspp/blob - src/language/stats/flip.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 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 <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/dataset.h"
  29 #include "data/dictionary.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 #include "data/data-in.h"
  44 #include "data/data-out.h"
  45
  46 #include "gl/intprops.h"
  47 #include "gl/minmax.h"
  48 #include "gl/xalloc.h"
  49
  50 #include "gettext.h"
  51 #define _(msgid) gettext (msgid)
  52
  53 /* List of variable names. */
  54 struct var_names
  55   {
  56     const char **names;
  57     size_t n_names, allocated_names;
  58   };
  59
  60 static void var_names_init (struct var_names *);
  61 static void var_names_add (struct pool *, struct var_names *, const char *);
  62
  63 /* Represents a FLIP input program. */
  64 struct flip_pgm
  65   {
  66     struct pool *pool;          /* Pool containing FLIP data. */
  67     size_t n_vars;              /* Pre-flip number of variables. */
  68     int n_cases;                /* Pre-flip number of cases. */
  69
  70     struct variable *new_names_var; /* Variable with new variable names. */
  71     const char *encoding;           /* Variable names' encoding. */
  72     struct var_names old_names; /* Variable names before FLIP. */
  73     struct var_names new_names; /* Variable names after FLIP. */
  74
  75     FILE *file;                 /* Temporary file containing data. */
  76     size_t cases_read;          /* Number of cases already read. */
  77     bool error;                 /* Error reading temporary file? */
  78   };
  79
  80 static const struct casereader_class flip_casereader_class;
  81
  82 static void destroy_flip_pgm (struct flip_pgm *);
  83 static bool flip_file (struct flip_pgm *);
  84 static void make_new_var (struct dictionary *, const char *name);
  85
  86 /* Parses and executes FLIP. */
  87 int
  88 cmd_flip (struct lexer *lexer, struct dataset *ds)
  89 {
  90   struct dictionary *old_dict = dataset_dict (ds);
  91   struct dictionary *new_dict = NULL;
  92   const struct variable **vars;
  93   struct flip_pgm *flip;
  94   struct casereader *input, *reader;
  95   struct ccase *c;
  96   size_t i;
  97   bool ok;
  98
  99   if (proc_make_temporary_transformations_permanent (ds))
 100     msg (SW, _("FLIP ignores TEMPORARY.  "
 101                "Temporary transformations will be made permanent."));
 102
 103   flip = pool_create_container (struct flip_pgm, pool);
 104   flip->n_vars = 0;
 105   flip->n_cases = 0;
 106   flip->new_names_var = NULL;
 107   var_names_init (&flip->old_names);
 108   var_names_init (&flip->new_names);
 109   flip->file = NULL;
 110   flip->cases_read = 0;
 111   flip->error = false;
 112
 113   lex_match (lexer, T_SLASH);
 114   if (lex_match_id (lexer, "VARIABLES"))
 115     {
 116       lex_match (lexer, T_EQUALS);
 117       if (!parse_variables_const (lexer, old_dict, &vars, &flip->n_vars,
 118                                   PV_NO_DUPLICATE))
 119         goto error;
 120       lex_match (lexer, T_SLASH);
 121     }
 122   else
 123     dict_get_vars (old_dict, &vars, &flip->n_vars, DC_SYSTEM);
 124   pool_register (flip->pool, free, vars);
 125
 126   lex_match (lexer, T_SLASH);
 127   if (lex_match_id (lexer, "NEWNAMES"))
 128     {
 129       lex_match (lexer, T_EQUALS);
 130       flip->new_names_var = parse_variable (lexer, old_dict);
 131       if (!flip->new_names_var)
 132         goto error;
 133     }
 134   else
 135     flip->new_names_var = dict_lookup_var (old_dict, "CASE_LBL");
 136
 137   if (flip->new_names_var)
 138     {
 139       for (i = 0; i < flip->n_vars; i++)
 140         if (vars[i] == flip->new_names_var)
 141           {
 142             remove_element (vars, flip->n_vars, sizeof *vars, i);
 143             flip->n_vars--;
 144             break;
 145           }
 146     }
 147
 148   flip->file = pool_create_temp_file (flip->pool);
 149   if (flip->file == NULL)
 150     {
 151       msg (SE, _("Could not create temporary file for FLIP."));
 152       goto error;
 153     }
 154
 155   /* Save old variable names for use as values of CASE_LBL
 156      variable in flipped file. */
 157   for (i = 0; i < flip->n_vars; i++)
 158     var_names_add (flip->pool, &flip->old_names,
 159                    pool_strdup (flip->pool, var_get_name (vars[i])));
 160
 161   /* Read the active dataset into a flip_sink. */
 162   proc_discard_output (ds);
 163
 164   /* Save old dictionary. */
 165   new_dict = dict_clone (old_dict);
 166   flip->encoding = dict_get_encoding (new_dict);
 167   dict_clear (new_dict);
 168
 169   input = proc_open_filtering (ds, false);
 170   while ((c = casereader_read (input)) != NULL)
 171     {
 172       flip->n_cases++;
 173       for (i = 0; i < flip->n_vars; i++)
 174         {
 175           const struct variable *v = vars[i];
 176           double out = var_is_numeric (v) ? case_num (c, v) : SYSMIS;
 177           fwrite (&out, sizeof out, 1, flip->file);
 178         }
 179       if (flip->new_names_var != NULL)
 180         {
 181           const union value *value = case_data (c, flip->new_names_var);
 182           const char *name;
 183           if (var_is_numeric (flip->new_names_var))
 184             {
 185               double f = value->f;
 186               name = (f == SYSMIS ? "VSYSMIS"
 187                       : f < INT_MIN ? "VNEGINF"
 188                       : f > INT_MAX ? "VPOSINF"
 189                       : pool_asprintf (flip->pool, "V%d", (int) f));
 190             }
 191           else
 192             {
 193               name = data_out_pool (value, dict_get_encoding (old_dict),
 194                                     var_get_write_format (flip->new_names_var),
 195                                     flip->pool);
 196             }
 197           var_names_add (flip->pool, &flip->new_names, name);
 198         }
 199       case_unref (c);
 200     }
 201   ok = casereader_destroy (input);
 202   ok = proc_commit (ds) && ok;
 203
 204   /* Flip the data we read. */
 205   if (!ok || !flip_file (flip))
 206     {
 207       dataset_clear (ds);
 208       goto error;
 209     }
 210
 211   /* Flip the dictionary. */
 212   dict_create_var_assert (new_dict, "CASE_LBL", 8);
 213   for (i = 0; i < flip->n_cases; i++)
 214     if (flip->new_names.n_names)
 215       make_new_var (new_dict, flip->new_names.names[i]);
 216     else
 217       {
 218         char s[3 + INT_STRLEN_BOUND (i) + 1];
 219         sprintf (s, "VAR%03zu", i);
 220         dict_create_var_assert (new_dict, s, 0);
 221       }
 222
 223   /* Set up flipped data for reading. */
 224   reader = casereader_create_sequential (NULL, dict_get_proto (new_dict),
 225                                          flip->n_vars,
 226                                          &flip_casereader_class, flip);
 227   dataset_set_dict (ds, new_dict);
 228   dataset_set_source (ds, reader);
 229   return CMD_SUCCESS;
 230
 231  error:
 232   dict_destroy (new_dict);
 233   destroy_flip_pgm (flip);
 234   return CMD_CASCADING_FAILURE;
 235 }
 236
 237 /* Destroys FLIP. */
 238 static void
 239 destroy_flip_pgm (struct flip_pgm *flip)
 240 {
 241   if (flip != NULL)
 242     pool_destroy (flip->pool);
 243 }
 244
 245 /* Make a new variable with base name NAME, which is bowdlerized and
 246    mangled until acceptable. */
 247 static void
 248 make_new_var (struct dictionary *dict, const char *name_)
 249 {
 250   char *name = xstrdup (name_);
 251   char *cp;
 252
 253   /* Trim trailing spaces. */
 254   cp = strchr (name, '\0');
 255   while (cp > name && isspace ((unsigned char) cp[-1]))
 256     *--cp = '\0';
 257
 258   /* Fix invalid characters. */
 259   for (cp = name; *cp && cp < name + ID_MAX_LEN; cp++)
 260     if (cp == name)
 261       {
 262         if (!lex_is_id1 (*cp) || *cp == '$')
 263           *cp = 'V';
 264       }
 265     else
 266       {
 267         if (!lex_is_idn (*cp))
 268           *cp = '_';
 269       }
 270   *cp = '\0';
 271
 272   /* Use the mangled name, if it is available, or add numeric
 273      extensions until we find one that is. */
 274   if (!dict_create_var (dict, name, 0))
 275     {
 276       int len = strlen (name);
 277       int i;
 278       for (i = 1; ; i++)
 279         {
 280           char n[ID_MAX_LEN + 1];
 281           int ofs = MIN (ID_MAX_LEN - 1 - intlog10 (i), len);
 282           strncpy (n, name, ofs);
 283           sprintf (&n[ofs], "%d", i);
 284
 285           if (dict_create_var (dict, n, 0))
 286             break;
 287         }
 288     }
 289   free (name);
 290 }
 291
 292 /* Transposes the external file into a new file. */
 293 static bool
 294 flip_file (struct flip_pgm *flip)
 295 {
 296   size_t case_bytes;
 297   size_t case_capacity;
 298   size_t case_idx;
 299   double *input_buf, *output_buf;
 300   FILE *input_file, *output_file;
 301
 302   /* Allocate memory for many cases. */
 303   case_bytes = flip->n_vars * sizeof *input_buf;
 304   case_capacity = settings_get_workspace () / case_bytes;
 305   if (case_capacity > flip->n_cases * 2)
 306     case_capacity = flip->n_cases * 2;
 307   if (case_capacity < 2)
 308     case_capacity = 2;
 309   for (;;)
 310     {
 311       size_t bytes = case_bytes * case_capacity;
 312       if (case_capacity > 2)
 313         input_buf = malloc (bytes);
 314       else
 315         input_buf = xmalloc (bytes);
 316       if (input_buf != NULL)
 317         break;
 318
 319       case_capacity /= 2;
 320       if (case_capacity < 2)
 321         case_capacity = 2;
 322     }
 323   pool_register (flip->pool, free, input_buf);
 324
 325   /* Use half the allocated memory for input_buf, half for
 326      output_buf. */
 327   case_capacity /= 2;
 328   output_buf = input_buf + flip->n_vars * case_capacity;
 329
 330   input_file = flip->file;
 331   if (fseeko (input_file, 0, SEEK_SET) != 0)
 332     {
 333       msg (SE, _("Error rewinding FLIP file: %s."), strerror (errno));
 334       return false;
 335     }
 336
 337   output_file = pool_create_temp_file (flip->pool);
 338   if (output_file == NULL)
 339     {
 340       msg (SE, _("Error creating FLIP source file."));
 341       return false;
 342     }
 343
 344   for (case_idx = 0; case_idx < flip->n_cases; )
 345     {
 346       unsigned long read_cases = MIN (flip->n_cases - case_idx,
 347                                       case_capacity);
 348       size_t i;
 349
 350       if (read_cases != fread (input_buf, case_bytes, read_cases, input_file))
 351         {
 352           if (ferror (input_file))
 353             msg (SE, _("Error reading FLIP file: %s."), strerror (errno));
 354           else
 355             msg (SE, _("Unexpected end of file reading FLIP file."));
 356           return false;
 357         }
 358
 359       for (i = 0; i < flip->n_vars; i++)
 360         {
 361           unsigned long j;
 362
 363           for (j = 0; j < read_cases; j++)
 364             output_buf[j] = input_buf[i + j * flip->n_vars];
 365
 366           if (fseeko (output_file,
 367                       sizeof *input_buf * (case_idx
 368                                            + (off_t) i * flip->n_cases),
 369                       SEEK_SET) != 0)
 370             {
 371               msg (SE, _("Error seeking FLIP source file: %s."),
 372                    strerror (errno));
 373               return false;
 374             }
 375
 376           if (fwrite (output_buf, sizeof *output_buf, read_cases, output_file)
 377               != read_cases)
 378             {
 379               msg (SE, _("Error writing FLIP source file: %s."),
 380                    strerror (errno));
 381               return false;
 382             }
 383         }
 384
 385       case_idx += read_cases;
 386     }
 387
 388   pool_fclose_temp_file (flip->pool, input_file);
 389   pool_unregister (flip->pool, input_buf);
 390   free (input_buf);
 391
 392   if (fseeko (output_file, 0, SEEK_SET) != 0)
 393     {
 394       msg (SE, _("Error rewinding FLIP source file: %s."), strerror (errno));
 395       return false;
 396     }
 397   flip->file = output_file;
 398
 399   return true;
 400 }
 401
 402 /* Reads and returns one case.
 403    Returns a null pointer at end of file or if an I/O error occurred. */
 404 static struct ccase *
 405 flip_casereader_read (struct casereader *reader, void *flip_)
 406 {
 407   struct flip_pgm *flip = flip_;
 408   struct ccase *c;
 409   size_t i;
 410
 411   if (flip->error || flip->cases_read >= flip->n_vars)
 412     return false;
 413
 414   c = case_create (casereader_get_proto (reader));
 415   data_in (ss_cstr (flip->old_names.names[flip->cases_read]), flip->encoding,
 416            FMT_A, case_data_rw_idx (c, 0), 8, flip->encoding);
 417
 418   for (i = 0; i < flip->n_cases; i++)
 419     {
 420       double in;
 421       if (fread (&in, sizeof in, 1, flip->file) != 1)
 422         {
 423           case_unref (c);
 424           if (ferror (flip->file))
 425             msg (SE, _("Error reading FLIP temporary file: %s."),
 426                  strerror (errno));
 427           else if (feof (flip->file))
 428             msg (SE, _("Unexpected end of file reading FLIP temporary file."));
 429           else
 430             NOT_REACHED ();
 431           flip->error = true;
 432           return NULL;
 433         }
 434       case_data_rw_idx (c, i + 1)->f = in;
 435     }
 436
 437   flip->cases_read++;
 438
 439   return c;
 440 }
 441
 442 /* Destroys the source.
 443    Returns true if successful read, false if an I/O occurred
 444    during destruction or previously. */
 445 static void
 446 flip_casereader_destroy (struct casereader *reader UNUSED, void *flip_)
 447 {
 448   struct flip_pgm *flip = flip_;
 449   if (flip->error)
 450     casereader_force_error (reader);
 451   destroy_flip_pgm (flip);
 452 }
 453
 454 static const struct casereader_class flip_casereader_class =
 455   {
 456     flip_casereader_read,
 457     flip_casereader_destroy,
 458     NULL,
 459     NULL,
 460   };
 461 \f
 462 static void
 463 var_names_init (struct var_names *vn)
 464 {
 465   vn->names = NULL;
 466   vn->n_names = 0;
 467   vn->allocated_names = 0;
 468 }
 469
 470 static void
 471 var_names_add (struct pool *pool, struct var_names *vn, const char *name)
 472 {
 473   if (vn->n_names >= vn->allocated_names)
 474     vn->names = pool_2nrealloc (pool, vn->names, &vn->allocated_names,
 475                                 sizeof *vn->names);
 476   vn->names[vn->n_names++] = name;
 477 }
 478