src/language/xforms/recode.c

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