src/language/xforms/recode.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000 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 <math.h>
  21 #include <stdlib.h>
  22
  23 #include <data/case.h>
  24 #include <data/data-in.h>
  25 #include <data/format.h>
  26 #include <data/dictionary.h>
  27 #include <data/procedure.h>
  28 #include <data/transformations.h>
  29 #include <data/variable.h>
  30 #include <language/command.h>
  31 #include <language/lexer/lexer.h>
  32 #include <language/lexer/variable-parser.h>
  33 #include <language/lexer/range-parser.h>
  34 #include <libpspp/assertion.h>
  35 #include <libpspp/compiler.h>
  36 #include <libpspp/message.h>
  37 #include <libpspp/pool.h>
  38 #include <libpspp/str.h>
  39
  40 #include "xalloc.h"
  41
  42 #include "gettext.h"
  43 #define _(msgid) gettext (msgid)
  44 \f
  45 /* Definitions. */
  46
  47 /* Type of source value for RECODE. */
  48 enum map_in_type
  49   {
  50     MAP_SINGLE,                 /* Specific value. */
  51     MAP_RANGE,                  /* Range of values. */
  52     MAP_SYSMIS,                 /* System missing value. */
  53     MAP_MISSING,                /* Any missing value. */
  54     MAP_ELSE,                   /* Any value. */
  55     MAP_CONVERT                 /* "123" => 123. */
  56   };
  57
  58 /* A value involved in a RECODE mapping. */
  59 union recode_value
  60   {
  61     double f;                   /* Numeric. */
  62     char *c;                    /* Short or long string. */
  63   };
  64
  65 /* Describes input values to be mapped. */
  66 struct map_in
  67   {
  68     enum map_in_type type;      /* One of MAP_*. */
  69     union recode_value x, y;    /* Source values. */
  70   };
  71
  72 /* Describes the value used as output from a mapping. */
  73 struct map_out
  74   {
  75     bool copy_input;            /* If true, copy input to output. */
  76     union recode_value value;   /* If copy_input false, recoded value. */
  77     int width;                  /* If copy_input false, output value width. */
  78   };
  79
  80 /* Describes how to recode a single value or range of values into a
  81    single value.  */
  82 struct mapping
  83   {
  84     struct map_in in;           /* Input values. */
  85     struct map_out out;         /* Output value. */
  86   };
  87
  88 /* RECODE transformation. */
  89 struct recode_trns
  90   {
  91     struct pool *pool;
  92
  93     /* Variable types, for convenience. */
  94     enum val_type src_type;     /* src_vars[*] type. */
  95     enum val_type dst_type;     /* dst_vars[*] type. */
  96
  97     /* Variables. */
  98     const struct variable **src_vars;   /* Source variables. */
  99     const struct variable **dst_vars;   /* Destination variables. */
 100     char **dst_names;           /* Name of dest variables, if they're new. */
 101     size_t var_cnt;             /* Number of variables. */
 102
 103     /* Mappings. */
 104     struct mapping *mappings;   /* Value mappings. */
 105     size_t map_cnt;             /* Number of mappings. */
 106   };
 107
 108 static bool parse_src_vars (struct lexer *, struct recode_trns *, const struct dictionary *dict);
 109 static bool parse_mappings (struct lexer *, struct recode_trns *);
 110 static bool parse_dst_vars (struct lexer *, struct recode_trns *, const struct dictionary *dict);
 111
 112 static void add_mapping (struct recode_trns *,
 113                          size_t *map_allocated, const struct map_in *);
 114
 115 static bool parse_map_in (struct lexer *lexer, struct map_in *, struct pool *,
 116                           enum val_type src_type, size_t max_src_width);
 117 static void set_map_in_generic (struct map_in *, enum map_in_type);
 118 static void set_map_in_num (struct map_in *, enum map_in_type, double, double);
 119 static void set_map_in_str (struct map_in *, struct pool *,
 120                             const struct string *, size_t width);
 121
 122 static bool parse_map_out (struct lexer *lexer, struct pool *, struct map_out *);
 123 static void set_map_out_num (struct map_out *, double);
 124 static void set_map_out_str (struct map_out *, struct pool *,
 125                              const struct string *);
 126
 127 static void enlarge_dst_widths (struct recode_trns *);
 128 static void create_dst_vars (struct recode_trns *, struct dictionary *);
 129
 130 static trns_proc_func recode_trns_proc;
 131 static trns_free_func recode_trns_free;
 132 \f
 133 /* Parser. */
 134
 135 /* Parses the RECODE transformation. */
 136 int
 137 cmd_recode (struct lexer *lexer, struct dataset *ds)
 138 {
 139   do
 140     {
 141       struct recode_trns *trns
 142         = pool_create_container (struct recode_trns, pool);
 143
 144       /* Parse source variable names,
 145          then input to output mappings,
 146          then destintation variable names. */
 147       if (!parse_src_vars (lexer, trns, dataset_dict (ds) )
 148           || !parse_mappings (lexer, trns)
 149           || !parse_dst_vars (lexer, trns, dataset_dict (ds)))
 150         {
 151           recode_trns_free (trns);
 152           return CMD_FAILURE;
 153         }
 154
 155       /* Ensure that all the output strings are at least as wide
 156          as the widest destination variable. */
 157       if (trns->dst_type == VAL_STRING)
 158         enlarge_dst_widths (trns);
 159
 160       /* Create destination variables, if needed.
 161          This must be the final step; otherwise we'd have to
 162          delete destination variables on failure. */
 163       if (trns->src_vars != trns->dst_vars)
 164         create_dst_vars (trns, dataset_dict (ds));
 165
 166       /* Done. */
 167       add_transformation (ds,
 168                           recode_trns_proc, recode_trns_free, trns);
 169     }
 170   while (lex_match (lexer, '/'));
 171
 172   return lex_end_of_command (lexer);
 173 }
 174
 175 /* Parses a set of variables to recode into TRNS->src_vars and
 176    TRNS->var_cnt.  Sets TRNS->src_type.  Returns true if
 177    successful, false on parse error. */
 178 static bool
 179 parse_src_vars (struct lexer *lexer,
 180                 struct recode_trns *trns, const struct dictionary *dict)
 181 {
 182   if (!parse_variables_const (lexer, dict, &trns->src_vars, &trns->var_cnt,
 183                         PV_SAME_TYPE))
 184     return false;
 185   pool_register (trns->pool, free, trns->src_vars);
 186   trns->src_type = var_get_type (trns->src_vars[0]);
 187   return true;
 188 }
 189
 190 /* Parses a set of mappings, which take the form (input=output),
 191    into TRNS->mappings and TRNS->map_cnt.  Sets TRNS->dst_type.
 192    Returns true if successful, false on parse error. */
 193 static bool
 194 parse_mappings (struct lexer *lexer, struct recode_trns *trns)
 195 {
 196   size_t max_src_width;
 197   size_t map_allocated;
 198   bool have_dst_type;
 199   size_t i;
 200
 201   /* Find length of longest source variable. */
 202   max_src_width = var_get_width (trns->src_vars[0]);
 203   for (i = 1; i < trns->var_cnt; i++)
 204     {
 205       size_t var_width = var_get_width (trns->src_vars[i]);
 206       if (var_width > max_src_width)
 207         max_src_width = var_width;
 208     }
 209
 210   /* Parse the mappings in parentheses. */
 211   trns->mappings = NULL;
 212   trns->map_cnt = 0;
 213   map_allocated = 0;
 214   have_dst_type = false;
 215   if (!lex_force_match (lexer, '('))
 216     return false;
 217   do
 218     {
 219       enum val_type dst_type;
 220
 221       if (!lex_match_id (lexer, "CONVERT"))
 222         {
 223           struct map_out out;
 224           size_t first_map_idx;
 225           size_t i;
 226
 227           first_map_idx = trns->map_cnt;
 228
 229           /* Parse source specifications. */
 230           do
 231             {
 232               struct map_in in;
 233               if (!parse_map_in (lexer, &in, trns->pool,
 234                                  trns->src_type, max_src_width))
 235                 return false;
 236               add_mapping (trns, &map_allocated, &in);
 237               lex_match (lexer, ',');
 238             }
 239           while (!lex_match (lexer, '='));
 240
 241           if (!parse_map_out (lexer, trns->pool, &out))
 242             return false;
 243           dst_type = val_type_from_width (out.width);
 244           if (have_dst_type && dst_type != trns->dst_type)
 245             {
 246               msg (SE, _("Inconsistent target variable types.  "
 247                          "Target variables "
 248                          "must be all numeric or all string."));
 249               return false;
 250             }
 251
 252           for (i = first_map_idx; i < trns->map_cnt; i++)
 253             trns->mappings[i].out = out;
 254         }
 255       else
 256         {
 257           /* Parse CONVERT as a special case. */
 258           struct map_in in;
 259           set_map_in_generic (&in, MAP_CONVERT);
 260           add_mapping (trns, &map_allocated, &in);
 261           set_map_out_num (&trns->mappings[trns->map_cnt - 1].out, 0.0);
 262
 263           dst_type = VAL_NUMERIC;
 264           if (trns->src_type != VAL_STRING
 265               || (have_dst_type && trns->dst_type != VAL_NUMERIC))
 266             {
 267               msg (SE, _("CONVERT requires string input values and "
 268                          "numeric output values."));
 269               return false;
 270             }
 271         }
 272       trns->dst_type = dst_type;
 273       have_dst_type = true;
 274
 275       if (!lex_force_match (lexer, ')'))
 276         return false;
 277     }
 278   while (lex_match (lexer, '('));
 279
 280   return true;
 281 }
 282
 283 /* Parses a mapping input value into IN, allocating memory from
 284    POOL.  The source value type must be provided as SRC_TYPE and,
 285    if string, the maximum width of a string source variable must
 286    be provided in MAX_SRC_WIDTH.  Returns true if successful,
 287    false on parse error. */
 288 static bool
 289 parse_map_in (struct lexer *lexer, struct map_in *in, struct pool *pool,
 290               enum val_type src_type, size_t max_src_width)
 291 {
 292   if (lex_match_id (lexer, "ELSE"))
 293     set_map_in_generic (in, MAP_ELSE);
 294   else if (src_type == VAL_NUMERIC)
 295     {
 296       if (lex_match_id (lexer, "MISSING"))
 297         set_map_in_generic (in, MAP_MISSING);
 298       else if (lex_match_id (lexer, "SYSMIS"))
 299         set_map_in_generic (in, MAP_SYSMIS);
 300       else
 301         {
 302           double x, y;
 303           if (!parse_num_range (lexer, &x, &y, NULL))
 304             return false;
 305           set_map_in_num (in, x == y ? MAP_SINGLE : MAP_RANGE, x, y);
 306         }
 307     }
 308   else
 309     {
 310       if (!lex_force_string (lexer))
 311         return false;
 312       set_map_in_str (in, pool, lex_tokstr (lexer), max_src_width);
 313       lex_get (lexer);
 314       if (lex_token (lexer) == T_ID
 315           && lex_id_match (ss_cstr ("THRU"), ss_cstr (lex_tokid (lexer))))
 316         {
 317           msg (SE, _("THRU is not allowed with string variables."));
 318           return false;
 319         }
 320     }
 321
 322   return true;
 323 }
 324
 325 /* Adds IN to the list of mappings in TRNS.
 326    MAP_ALLOCATED is the current number of allocated mappings,
 327    which is updated as needed. */
 328 static void
 329 add_mapping (struct recode_trns *trns,
 330              size_t *map_allocated, const struct map_in *in)
 331 {
 332   struct mapping *m;
 333   if (trns->map_cnt >= *map_allocated)
 334     trns->mappings = pool_2nrealloc (trns->pool, trns->mappings,
 335                                      map_allocated,
 336                                      sizeof *trns->mappings);
 337   m = &trns->mappings[trns->map_cnt++];
 338   m->in = *in;
 339 }
 340
 341 /* Sets IN as a mapping of the given TYPE. */
 342 static void
 343 set_map_in_generic (struct map_in *in, enum map_in_type type)
 344 {
 345   in->type = type;
 346 }
 347
 348 /* Sets IN as a numeric mapping of the given TYPE,
 349    with X and Y as the two numeric values. */
 350 static void
 351 set_map_in_num (struct map_in *in, enum map_in_type type, double x, double y)
 352 {
 353   in->type = type;
 354   in->x.f = x;
 355   in->y.f = y;
 356 }
 357
 358 /* Sets IN as a string mapping, with STRING as the string,
 359    allocated from POOL.  The string is padded with spaces on the
 360    right to WIDTH characters long. */
 361 static void
 362 set_map_in_str (struct map_in *in, struct pool *pool,
 363                 const struct string *string, size_t width)
 364 {
 365   in->type = MAP_SINGLE;
 366   in->x.c = pool_alloc_unaligned (pool, width);
 367   buf_copy_rpad (in->x.c, width, ds_data (string), ds_length (string));
 368 }
 369
 370 /* Parses a mapping output value into OUT, allocating memory from
 371    POOL.  Returns true if successful, false on parse error. */
 372 static bool
 373 parse_map_out (struct lexer *lexer, struct pool *pool, struct map_out *out)
 374 {
 375   if (lex_is_number (lexer))
 376     {
 377       set_map_out_num (out, lex_number (lexer));
 378       lex_get (lexer);
 379     }
 380   else if (lex_match_id (lexer, "SYSMIS"))
 381     set_map_out_num (out, SYSMIS);
 382   else if (lex_token (lexer) == T_STRING)
 383     {
 384       set_map_out_str (out, pool, lex_tokstr (lexer));
 385       lex_get (lexer);
 386     }
 387   else if (lex_match_id (lexer, "COPY"))
 388     out->copy_input = true;
 389   else
 390     {
 391       lex_error (lexer, _("expecting output value"));
 392       return false;
 393     }
 394   return true;
 395 }
 396
 397 /* Sets OUT as a numeric mapping output with the given VALUE. */
 398 static void
 399 set_map_out_num (struct map_out *out, double value)
 400 {
 401   out->copy_input = false;
 402   out->value.f = value;
 403   out->width = 0;
 404 }
 405
 406 /* Sets OUT as a string mapping output with the given VALUE. */
 407 static void
 408 set_map_out_str (struct map_out *out, struct pool *pool,
 409                  const struct string *value)
 410 {
 411   const char *string = ds_data (value);
 412   size_t length = ds_length (value);
 413
 414   out->copy_input = false;
 415   out->value.c = pool_alloc_unaligned (pool, length);
 416   memcpy (out->value.c, string, length);
 417   out->width = length;
 418 }
 419
 420 /* Parses a set of target variables into TRNS->dst_vars and
 421    TRNS->dst_names. */
 422 static bool
 423 parse_dst_vars (struct lexer *lexer, struct recode_trns *trns,
 424                 const struct dictionary *dict)
 425 {
 426   size_t i;
 427
 428   if (lex_match_id (lexer, "INTO"))
 429     {
 430       size_t name_cnt;
 431       size_t i;
 432
 433       if (!parse_mixed_vars_pool (lexer, dict, trns->pool,
 434                                   &trns->dst_names, &name_cnt,
 435                                   PV_NONE))
 436         return false;
 437
 438       if (name_cnt != trns->var_cnt)
 439         {
 440           msg (SE, _("%zu variable(s) cannot be recoded into "
 441                      "%zu variable(s).  Specify the same number "
 442                      "of variables as source and target variables."),
 443                trns->var_cnt, name_cnt);
 444           return false;
 445         }
 446
 447       trns->dst_vars = pool_nalloc (trns->pool,
 448                                     trns->var_cnt, sizeof *trns->dst_vars);
 449       for (i = 0; i < trns->var_cnt; i++)
 450         {
 451           const struct variable *v;
 452           v = trns->dst_vars[i] = dict_lookup_var (dict, trns->dst_names[i]);
 453           if (v == NULL && trns->dst_type == VAL_STRING)
 454             {
 455               msg (SE, _("There is no variable named "
 456                          "%s.  (All string variables specified "
 457                          "on INTO must already exist.  Use the "
 458                          "STRING command to create a string "
 459                          "variable.)"),
 460                    trns->dst_names[i]);
 461               return false;
 462             }
 463         }
 464     }
 465   else
 466     {
 467       trns->dst_vars = trns->src_vars;
 468       if (trns->src_type != trns->dst_type)
 469         {
 470           msg (SE, _("INTO is required with %s input values "
 471                      "and %s output values."),
 472                trns->src_type == VAL_NUMERIC ? _("numeric") : _("string"),
 473                trns->dst_type == VAL_NUMERIC ? _("numeric") : _("string"));
 474           return false;
 475         }
 476     }
 477
 478   for (i = 0; i < trns->var_cnt; i++)
 479     {
 480       const struct variable *v = trns->dst_vars[i];
 481       if (v != NULL && var_get_type (v) != trns->dst_type)
 482         {
 483           msg (SE, _("Type mismatch.  Cannot store %s data in "
 484                      "%s variable %s."),
 485                trns->dst_type == VAL_STRING ? _("string") : _("numeric"),
 486                var_is_alpha (v) ? _("string") : _("numeric"),
 487                var_get_name (v));
 488           return false;
 489         }
 490     }
 491
 492   return true;
 493 }
 494
 495 /* Ensures that all the output values in TRNS are as wide as the
 496    widest destination variable. */
 497 static void
 498 enlarge_dst_widths (struct recode_trns *trns)
 499 {
 500   size_t max_dst_width;
 501   size_t i;
 502
 503   max_dst_width = 0;
 504   for (i = 0; i < trns->var_cnt; i++)
 505     {
 506       const struct variable *v = trns->dst_vars[i];
 507       if (var_get_width (v) > max_dst_width)
 508         max_dst_width = var_get_width (v);
 509     }
 510
 511   for (i = 0; i < trns->map_cnt; i++)
 512     {
 513       struct map_out *out = &trns->mappings[i].out;
 514       if (!out->copy_input && out->width < max_dst_width)
 515         {
 516           char *s = pool_alloc_unaligned (trns->pool, max_dst_width + 1);
 517           buf_copy_rpad (s, max_dst_width + 1, out->value.c, out->width);
 518           out->value.c = s;
 519         }
 520     }
 521 }
 522
 523 /* Creates destination variables that don't already exist. */
 524 static void
 525 create_dst_vars (struct recode_trns *trns, struct dictionary *dict)
 526 {
 527   size_t i;
 528
 529   for (i = 0; i < trns->var_cnt; i++)
 530     {
 531       const struct variable **var = &trns->dst_vars[i];
 532       const char *name = trns->dst_names[i];
 533
 534       *var = dict_lookup_var (dict, name);
 535       if (*var == NULL)
 536         *var = dict_create_var_assert (dict, name, 0);
 537       assert (var_get_type (*var) == trns->dst_type);
 538     }
 539 }
 540 \f
 541 /* Data transformation. */
 542
 543 /* Returns the output mapping in TRNS for an input of VALUE on
 544    variable V, or a null pointer if there is no mapping. */
 545 static const struct map_out *
 546 find_src_numeric (struct recode_trns *trns, double value, const struct variable *v)
 547 {
 548   struct mapping *m;
 549
 550   for (m = trns->mappings; m < trns->mappings + trns->map_cnt; m++)
 551     {
 552       const struct map_in *in = &m->in;
 553       const struct map_out *out = &m->out;
 554       bool match;
 555
 556       switch (in->type)
 557         {
 558         case MAP_SINGLE:
 559           match = value == in->x.f;
 560           break;
 561         case MAP_MISSING:
 562           match = var_is_num_missing (v, value, MV_ANY);
 563           break;
 564         case MAP_RANGE:
 565           match = value >= in->x.f && value <= in->y.f;
 566           break;
 567         case MAP_SYSMIS:
 568           match = value == SYSMIS;
 569           break;
 570         case MAP_ELSE:
 571           match = true;
 572           break;
 573         default:
 574           NOT_REACHED ();
 575         }
 576
 577       if (match)
 578         return out;
 579     }
 580
 581   return NULL;
 582 }
 583
 584 /* Returns the output mapping in TRNS for an input of VALUE with
 585    the given WIDTH, or a null pointer if there is no mapping. */
 586 static const struct map_out *
 587 find_src_string (struct recode_trns *trns, const char *value, int width)
 588 {
 589   struct mapping *m;
 590
 591   for (m = trns->mappings; m < trns->mappings + trns->map_cnt; m++)
 592     {
 593       const struct map_in *in = &m->in;
 594       struct map_out *out = &m->out;
 595       bool match;
 596
 597       switch (in->type)
 598         {
 599         case MAP_SINGLE:
 600           match = !memcmp (value, in->x.c, width);
 601           break;
 602         case MAP_ELSE:
 603           match = true;
 604           break;
 605         case MAP_CONVERT:
 606           {
 607             union value uv;
 608
 609             msg_disable ();
 610             match = data_in (ss_buffer (value, width), LEGACY_NATIVE,
 611                              FMT_F, 0, 0, 0, &uv, 0);
 612             msg_enable ();
 613             out->value.f = uv.f;
 614             break;
 615           }
 616         default:
 617           NOT_REACHED ();
 618         }
 619
 620       if (match)
 621         return out;
 622     }
 623
 624   return NULL;
 625 }
 626
 627 /* Performs RECODE transformation. */
 628 static int
 629 recode_trns_proc (void *trns_, struct ccase *c, casenumber case_idx UNUSED)
 630 {
 631   struct recode_trns *trns = trns_;
 632   size_t i;
 633
 634   for (i = 0; i < trns->var_cnt; i++)
 635     {
 636       const struct variable *src_var = trns->src_vars[i];
 637       const struct variable *dst_var = trns->dst_vars[i];
 638
 639       const union value *src_data = case_data (c, src_var);
 640       union value *dst_data = case_data_rw (c, dst_var);
 641
 642       const struct map_out *out;
 643
 644       if (trns->src_type == VAL_NUMERIC)
 645         out = find_src_numeric (trns, src_data->f, src_var);
 646       else
 647         out = find_src_string (trns, src_data->s, var_get_width (src_var));
 648
 649       if (trns->dst_type == VAL_NUMERIC)
 650         {
 651           if (out != NULL)
 652             dst_data->f = !out->copy_input ? out->value.f : src_data->f;
 653           else if (trns->src_vars != trns->dst_vars)
 654             dst_data->f = SYSMIS;
 655         }
 656       else
 657         {
 658           if (out != NULL)
 659             {
 660               if (!out->copy_input)
 661                 memcpy (dst_data->s, out->value.c, var_get_width (dst_var));
 662               else if (trns->src_vars != trns->dst_vars)
 663                 buf_copy_rpad (dst_data->s, var_get_width (dst_var),
 664                                src_data->s, var_get_width (src_var));
 665             }
 666           else if (trns->src_vars != trns->dst_vars)
 667             memset (dst_data->s, ' ', var_get_width (dst_var));
 668         }
 669     }
 670
 671   return TRNS_CONTINUE;
 672 }
 673
 674 /* Frees a RECODE transformation. */
 675 static bool
 676 recode_trns_free (void *trns_)
 677 {
 678   struct recode_trns *trns = trns_;
 679   pool_destroy (trns->pool);
 680   return true;
 681 }