src/language/xforms/compute.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 <stdint.h>
  20 #include <stdlib.h>
  21
  22 #include <data/case.h>
  23 #include <data/dictionary.h>
  24 #include <data/procedure.h>
  25 #include <data/transformations.h>
  26 #include <data/variable.h>
  27 #include <data/vector.h>
  28 #include <language/command.h>
  29 #include <language/expressions/public.h>
  30 #include <language/lexer/lexer.h>
  31 #include <libpspp/message.h>
  32 #include <libpspp/misc.h>
  33 #include <libpspp/str.h>
  34
  35 #include "xalloc.h"
  36
  37 #include "gettext.h"
  38 #define _(msgid) gettext (msgid)
  39
  40 struct compute_trns;
  41 struct lvalue;
  42
  43 /* Target of a COMPUTE or IF assignment, either a variable or a
  44    vector element. */
  45 static struct lvalue *lvalue_parse (struct lexer *lexer, struct dataset *);
  46 static int lvalue_get_type (const struct lvalue *);
  47 static bool lvalue_is_vector (const struct lvalue *);
  48 static void lvalue_finalize (struct lvalue *,
  49                              struct compute_trns *, struct dictionary *);
  50 static void lvalue_destroy (struct lvalue *, struct dictionary *);
  51
  52 /* COMPUTE and IF transformation. */
  53 struct compute_trns
  54   {
  55     /* Test expression (IF only). */
  56     struct expression *test;     /* Test expression. */
  57
  58     /* Variable lvalue, if variable != NULL. */
  59     struct variable *variable;   /* Destination variable, if any. */
  60     int width;                   /* Lvalue string width; 0=numeric. */
  61
  62     /* Vector lvalue, if vector != NULL. */
  63     const struct vector *vector; /* Destination vector, if any. */
  64     struct expression *element;  /* Destination vector element expr. */
  65
  66     /* Rvalue. */
  67     struct expression *rvalue;   /* Rvalue expression. */
  68   };
  69
  70 static struct expression *parse_rvalue (struct lexer *lexer,
  71                                         const struct lvalue *,
  72                                         struct dataset *);
  73
  74 static struct compute_trns *compute_trns_create (void);
  75 static trns_proc_func *get_proc_func (const struct lvalue *);
  76 static trns_free_func compute_trns_free;
  77 \f
  78 /* COMPUTE. */
  79
  80 int
  81 cmd_compute (struct lexer *lexer, struct dataset *ds)
  82 {
  83   struct dictionary *dict = dataset_dict (ds);
  84   struct lvalue *lvalue = NULL;
  85   struct compute_trns *compute = NULL;
  86
  87   compute = compute_trns_create ();
  88
  89   lvalue = lvalue_parse (lexer, ds);
  90   if (lvalue == NULL)
  91     goto fail;
  92
  93   if (!lex_force_match (lexer, '='))
  94     goto fail;
  95   compute->rvalue = parse_rvalue (lexer, lvalue, ds);
  96   if (compute->rvalue == NULL)
  97     goto fail;
  98
  99   add_transformation (ds, get_proc_func (lvalue), compute_trns_free, compute);
 100
 101   lvalue_finalize (lvalue, compute, dict);
 102
 103   return lex_end_of_command (lexer);
 104
 105  fail:
 106   lvalue_destroy (lvalue, dict);
 107   compute_trns_free (compute);
 108   return CMD_CASCADING_FAILURE;
 109 }
 110 \f
 111 /* Transformation functions. */
 112
 113 /* Handle COMPUTE or IF with numeric target variable. */
 114 static int
 115 compute_num (void *compute_, struct ccase *c, casenumber case_num)
 116 {
 117   struct compute_trns *compute = compute_;
 118
 119   if (compute->test == NULL
 120       || expr_evaluate_num (compute->test, c, case_num) == 1.0)
 121     case_data_rw (c, compute->variable)->f
 122       = expr_evaluate_num (compute->rvalue, c, case_num);
 123
 124   return TRNS_CONTINUE;
 125 }
 126
 127 /* Handle COMPUTE or IF with numeric vector element target
 128    variable. */
 129 static int
 130 compute_num_vec (void *compute_, struct ccase *c, casenumber case_num)
 131 {
 132   struct compute_trns *compute = compute_;
 133
 134   if (compute->test == NULL
 135       || expr_evaluate_num (compute->test, c, case_num) == 1.0)
 136     {
 137       double index;     /* Index into the vector. */
 138       int rindx;        /* Rounded index value. */
 139
 140       index = expr_evaluate_num (compute->element, c, case_num);
 141       rindx = floor (index + EPSILON);
 142       if (index == SYSMIS
 143           || rindx < 1 || rindx > vector_get_var_cnt (compute->vector))
 144         {
 145           if (index == SYSMIS)
 146             msg (SW, _("When executing COMPUTE: SYSMIS is not a valid value "
 147                        "as an index into vector %s."),
 148                  vector_get_name (compute->vector));
 149           else
 150             msg (SW, _("When executing COMPUTE: %g is not a valid value as "
 151                        "an index into vector %s."),
 152                  index, vector_get_name (compute->vector));
 153           return TRNS_CONTINUE;
 154         }
 155       case_data_rw (c, vector_get_var (compute->vector, rindx - 1))->f
 156         = expr_evaluate_num (compute->rvalue, c, case_num);
 157     }
 158
 159   return TRNS_CONTINUE;
 160 }
 161
 162 /* Handle COMPUTE or IF with string target variable. */
 163 static int
 164 compute_str (void *compute_, struct ccase *c, casenumber case_num)
 165 {
 166   struct compute_trns *compute = compute_;
 167
 168   if (compute->test == NULL
 169       || expr_evaluate_num (compute->test, c, case_num) == 1.0)
 170     expr_evaluate_str (compute->rvalue, c, case_num,
 171                        case_data_rw (c, compute->variable)->s, compute->width);
 172
 173   return TRNS_CONTINUE;
 174 }
 175
 176 /* Handle COMPUTE or IF with string vector element target
 177    variable. */
 178 static int
 179 compute_str_vec (void *compute_, struct ccase *c, casenumber case_num)
 180 {
 181   struct compute_trns *compute = compute_;
 182
 183   if (compute->test == NULL
 184       || expr_evaluate_num (compute->test, c, case_num) == 1.0)
 185     {
 186       double index;             /* Index into the vector. */
 187       int rindx;                /* Rounded index value. */
 188       struct variable *vr;      /* Variable reference by indexed vector. */
 189
 190       index = expr_evaluate_num (compute->element, c, case_num);
 191       rindx = floor (index + EPSILON);
 192       if (index == SYSMIS)
 193         {
 194           msg (SW, _("When executing COMPUTE: SYSMIS is not a valid "
 195                      "value as an index into vector %s."),
 196                vector_get_name (compute->vector));
 197           return TRNS_CONTINUE;
 198         }
 199       else if (rindx < 1 || rindx > vector_get_var_cnt (compute->vector))
 200         {
 201           msg (SW, _("When executing COMPUTE: %g is not a valid value as "
 202                      "an index into vector %s."),
 203                index, vector_get_name (compute->vector));
 204           return TRNS_CONTINUE;
 205         }
 206
 207       vr = vector_get_var (compute->vector, rindx - 1);
 208       expr_evaluate_str (compute->rvalue, c, case_num,
 209                          case_data_rw (c, vr)->s,
 210                          var_get_width (vr));
 211     }
 212
 213   return TRNS_CONTINUE;
 214 }
 215 \f
 216 /* IF. */
 217
 218 int
 219 cmd_if (struct lexer *lexer, struct dataset *ds)
 220 {
 221   struct dictionary *dict = dataset_dict (ds);
 222   struct compute_trns *compute = NULL;
 223   struct lvalue *lvalue = NULL;
 224
 225   compute = compute_trns_create ();
 226
 227   /* Test expression. */
 228   compute->test = expr_parse (lexer, ds, EXPR_BOOLEAN);
 229   if (compute->test == NULL)
 230     goto fail;
 231
 232   /* Lvalue variable. */
 233   lvalue = lvalue_parse (lexer, ds);
 234   if (lvalue == NULL)
 235     goto fail;
 236
 237   /* Rvalue expression. */
 238   if (!lex_force_match (lexer, '='))
 239     goto fail;
 240   compute->rvalue = parse_rvalue (lexer, lvalue, ds);
 241   if (compute->rvalue == NULL)
 242     goto fail;
 243
 244   add_transformation (ds, get_proc_func (lvalue), compute_trns_free, compute);
 245
 246   lvalue_finalize (lvalue, compute, dict);
 247
 248   return lex_end_of_command (lexer);
 249
 250  fail:
 251   lvalue_destroy (lvalue, dict);
 252   compute_trns_free (compute);
 253   return CMD_CASCADING_FAILURE;
 254 }
 255 \f
 256 /* Code common to COMPUTE and IF. */
 257
 258 static trns_proc_func *
 259 get_proc_func (const struct lvalue *lvalue)
 260 {
 261   bool is_numeric = lvalue_get_type (lvalue) == VAL_NUMERIC;
 262   bool is_vector = lvalue_is_vector (lvalue);
 263
 264   return (is_numeric
 265           ? (is_vector ? compute_num_vec : compute_num)
 266           : (is_vector ? compute_str_vec : compute_str));
 267 }
 268
 269 /* Parses and returns an rvalue expression of the same type as
 270    LVALUE, or a null pointer on failure. */
 271 static struct expression *
 272 parse_rvalue (struct lexer *lexer,
 273               const struct lvalue *lvalue, struct dataset *ds)
 274 {
 275   bool is_numeric = lvalue_get_type (lvalue) == VAL_NUMERIC;
 276
 277   return expr_parse (lexer, ds, is_numeric ? EXPR_NUMBER : EXPR_STRING);
 278 }
 279
 280 /* Returns a new struct compute_trns after initializing its fields. */
 281 static struct compute_trns *
 282 compute_trns_create (void)
 283 {
 284   struct compute_trns *compute = xmalloc (sizeof *compute);
 285   compute->test = NULL;
 286   compute->variable = NULL;
 287   compute->vector = NULL;
 288   compute->element = NULL;
 289   compute->rvalue = NULL;
 290   return compute;
 291 }
 292
 293 /* Deletes all the fields in COMPUTE. */
 294 static bool
 295 compute_trns_free (void *compute_)
 296 {
 297   struct compute_trns *compute = compute_;
 298
 299   if (compute != NULL)
 300     {
 301       expr_free (compute->test);
 302       expr_free (compute->element);
 303       expr_free (compute->rvalue);
 304       free (compute);
 305     }
 306   return true;
 307 }
 308 \f
 309 /* COMPUTE or IF target variable or vector element.
 310    For a variable, the `variable' member is non-null.
 311    For a vector element, the `vector' member is non-null. */
 312 struct lvalue
 313   {
 314     struct variable *variable;   /* Destination variable. */
 315     bool is_new_variable;        /* Did we create the variable? */
 316
 317     const struct vector *vector; /* Destination vector, if any, or NULL. */
 318     struct expression *element;  /* Destination vector element, or NULL. */
 319   };
 320
 321 /* Parses the target variable or vector element into a new
 322    `struct lvalue', which is returned. */
 323 static struct lvalue *
 324 lvalue_parse (struct lexer *lexer, struct dataset *ds)
 325 {
 326   struct dictionary *dict = dataset_dict (ds);
 327   struct lvalue *lvalue;
 328
 329   lvalue = xmalloc (sizeof *lvalue);
 330   lvalue->variable = NULL;
 331   lvalue->is_new_variable = false;
 332   lvalue->vector = NULL;
 333   lvalue->element = NULL;
 334
 335   if (!lex_force_id (lexer))
 336     goto lossage;
 337
 338   if (lex_look_ahead (lexer) == '(')
 339     {
 340       /* Vector. */
 341       lvalue->vector = dict_lookup_vector (dict, lex_tokid (lexer));
 342       if (lvalue->vector == NULL)
 343         {
 344           msg (SE, _("There is no vector named %s."), lex_tokid (lexer));
 345           goto lossage;
 346         }
 347
 348       /* Vector element. */
 349       lex_get (lexer);
 350       if (!lex_force_match (lexer, '('))
 351         goto lossage;
 352       lvalue->element = expr_parse (lexer, ds, EXPR_NUMBER);
 353       if (lvalue->element == NULL)
 354         goto lossage;
 355       if (!lex_force_match (lexer, ')'))
 356         goto lossage;
 357     }
 358   else
 359     {
 360       /* Variable name. */
 361       const char *var_name = lex_tokid (lexer);
 362       lvalue->variable = dict_lookup_var (dict, var_name);
 363       if (lvalue->variable == NULL)
 364         {
 365           lvalue->variable = dict_create_var_assert (dict, var_name, 0);
 366           lvalue->is_new_variable = true;
 367         }
 368       lex_get (lexer);
 369     }
 370   return lvalue;
 371
 372  lossage:
 373   lvalue_destroy (lvalue, dict);
 374   return NULL;
 375 }
 376
 377 /* Returns the type (NUMERIC or ALPHA) of the target variable or
 378    vector in LVALUE. */
 379 static int
 380 lvalue_get_type (const struct lvalue *lvalue)
 381 {
 382   return (lvalue->variable != NULL
 383           ? var_get_type (lvalue->variable)
 384           : vector_get_type (lvalue->vector));
 385 }
 386
 387 /* Returns true if LVALUE has a vector as its target. */
 388 static bool
 389 lvalue_is_vector (const struct lvalue *lvalue)
 390 {
 391   return lvalue->vector != NULL;
 392 }
 393
 394 /* Finalizes making LVALUE the target of COMPUTE, by creating the
 395    target variable if necessary and setting fields in COMPUTE. */
 396 static void
 397 lvalue_finalize (struct lvalue *lvalue,
 398                  struct compute_trns *compute,
 399                  struct dictionary *dict)
 400 {
 401   if (lvalue->vector == NULL)
 402     {
 403       compute->variable = lvalue->variable;
 404       compute->width = var_get_width (compute->variable);
 405
 406       /* Goofy behavior, but compatible: Turn off LEAVE. */
 407       if (!var_must_leave (compute->variable))
 408         var_set_leave (compute->variable, false);
 409
 410       /* Prevent lvalue_destroy from deleting variable. */
 411       lvalue->is_new_variable = false;
 412     }
 413   else
 414     {
 415       compute->vector = lvalue->vector;
 416       compute->element = lvalue->element;
 417       lvalue->element = NULL;
 418     }
 419
 420   lvalue_destroy (lvalue, dict);
 421 }
 422
 423 /* Destroys LVALUE. */
 424 static void
 425 lvalue_destroy (struct lvalue *lvalue, struct dictionary *dict)
 426 {
 427   if (lvalue == NULL)
 428      return;
 429
 430   if (lvalue->is_new_variable)
 431     dict_delete_var (dict, lvalue->variable);
 432   expr_free (lvalue->element);
 433   free (lvalue);
 434 }