src/language/expressions/evaluate.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010 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 #include "evaluate.h"
  19
  20 #include <ctype.h>
  21 #include <libpspp/assertion.h>
  22 #include <libpspp/message.h>
  23 #include <language/expressions/helpers.h>
  24 #include <language/expressions/private.h>
  25 #include <language/lexer/value-parser.h>
  26 #include <libpspp/pool.h>
  27
  28 #include "xalloc.h"
  29
  30 static void
  31 expr_evaluate (struct expression *e, const struct ccase *c, int case_idx,
  32                void *result)
  33 {
  34   struct dataset *ds = e->ds;
  35   union operation_data *op = e->ops;
  36
  37   double *ns = e->number_stack;
  38   struct substring *ss = e->string_stack;
  39
  40   /* Without a dictionary/dataset, the expression can't refer to variables,
  41      and you don't need to specify a case when you evaluate the
  42      expression.  With a dictionary/dataset, the expression can refer
  43      to variables, so you must specify a case when you evaluate the
  44      expression. */
  45   assert ((c != NULL) == (e->ds != NULL));
  46
  47   pool_clear (e->eval_pool);
  48
  49   for (;;)
  50     {
  51       assert (op < e->ops + e->op_cnt);
  52       switch (op++->operation)
  53         {
  54         case OP_number:
  55         case OP_boolean:
  56           *ns++ = op++->number;
  57           break;
  58
  59         case OP_string:
  60           {
  61             const struct substring *s = &op++->string;
  62             *ss++ = copy_string (e, s->string, s->length);
  63           }
  64           break;
  65
  66         case OP_return_number:
  67           *(double *) result = isfinite (ns[-1]) ? ns[-1] : SYSMIS;
  68           return;
  69
  70         case OP_return_string:
  71           *(struct substring *) result = ss[-1];
  72           return;
  73
  74 #include "evaluate.inc"
  75
  76         default:
  77           NOT_REACHED ();
  78         }
  79     }
  80 }
  81
  82 double
  83 expr_evaluate_num (struct expression *e, const struct ccase *c, int case_idx)
  84 {
  85   double d;
  86
  87   assert (e->type == OP_number || e->type == OP_boolean);
  88   expr_evaluate (e, c, case_idx, &d);
  89   return d;
  90 }
  91
  92 void
  93 expr_evaluate_str (struct expression *e, const struct ccase *c, int case_idx,
  94                    char *dst, size_t dst_size)
  95 {
  96   struct substring s;
  97
  98   assert (e->type == OP_string);
  99   assert ((dst == NULL) == (dst_size == 0));
 100   expr_evaluate (e, c, case_idx, &s);
 101
 102   buf_copy_rpad (dst, dst_size, s.string, s.length, ' ');
 103 }
 104 \f
 105 #include <language/lexer/lexer.h>
 106 #include <language/command.h>
 107
 108 int
 109 cmd_debug_evaluate (struct lexer *lexer, struct dataset *dsother UNUSED)
 110 {
 111   bool optimize = true;
 112   int retval = CMD_FAILURE;
 113   bool dump_postfix = false;
 114
 115   struct ccase *c = NULL;
 116
 117   struct dataset *ds = NULL;
 118
 119   struct expression *expr;
 120
 121   for (;;)
 122     {
 123       struct dictionary *d = NULL;
 124       if (lex_match_id (lexer, "NOOPTIMIZE"))
 125         optimize = 0;
 126       else if (lex_match_id (lexer, "POSTFIX"))
 127         dump_postfix = 1;
 128       else if (lex_match (lexer, T_LPAREN))
 129         {
 130           char name[VAR_NAME_LEN + 1];
 131           struct variable *v;
 132           size_t old_value_cnt;
 133           int width;
 134
 135           if (!lex_force_id (lexer))
 136             goto done;
 137           strcpy (name, lex_tokcstr (lexer));
 138
 139           lex_get (lexer);
 140           if (!lex_force_match (lexer, T_EQUALS))
 141             goto done;
 142
 143           if (lex_is_number (lexer))
 144             width = 0;
 145           else if (lex_is_string (lexer))
 146             width = ss_length (lex_tokss (lexer));
 147           else
 148             {
 149               lex_error (lexer, _("expecting number or string"));
 150               goto done;
 151             }
 152
 153           if  ( ds == NULL )
 154             {
 155               ds = create_dataset ();
 156               d = dataset_dict (ds);
 157             }
 158
 159           old_value_cnt = dict_get_next_value_idx (d);
 160           v = dict_create_var (d, name, width);
 161           if (v == NULL)
 162             {
 163               msg (SE, _("Duplicate variable name %s."), name);
 164               goto done;
 165             }
 166
 167           if (c == NULL)
 168             c = case_create (dict_get_proto (d));
 169           else
 170             c = case_unshare_and_resize (c, dict_get_proto (d));
 171
 172           if (!parse_value (lexer, case_data_rw (c, v), var_get_width (v)))
 173             NOT_REACHED ();
 174
 175           if (!lex_force_match (lexer, T_RPAREN))
 176             goto done;
 177         }
 178       else
 179         break;
 180     }
 181   if (lex_token (lexer) != T_SLASH)
 182     {
 183       lex_force_match (lexer, T_SLASH);
 184       goto done;
 185     }
 186
 187   lex_get (lexer);
 188
 189   expr = expr_parse_any (lexer, ds, optimize);
 190   if (!expr || lex_end_of_command (lexer) != CMD_SUCCESS)
 191     {
 192       if (expr != NULL)
 193         expr_free (expr);
 194       printf ("error\n");
 195       goto done;
 196     }
 197
 198   if (dump_postfix)
 199     expr_debug_print_postfix (expr);
 200   else
 201     switch (expr->type)
 202       {
 203       case OP_number:
 204         {
 205           double d = expr_evaluate_num (expr, c, 0);
 206           if (d == SYSMIS)
 207             printf ("sysmis\n");
 208           else
 209             printf ("%.2f\n", d);
 210         }
 211         break;
 212
 213       case OP_boolean:
 214         {
 215           double b = expr_evaluate_num (expr, c, 0);
 216           printf ("%s\n",
 217                    b == SYSMIS ? "sysmis" : b == 0.0 ? "false" : "true");
 218         }
 219         break;
 220
 221       case OP_string:
 222         {
 223           struct substring s;
 224           expr_evaluate (expr, c, 0, &s);
 225
 226           putchar ('"');
 227           fwrite (s.string, s.length, 1, stdout);
 228           puts ("\"");
 229           break;
 230         }
 231
 232       default:
 233         NOT_REACHED ();
 234       }
 235
 236   expr_free (expr);
 237   retval = CMD_SUCCESS;
 238
 239  done:
 240   if (ds)
 241     destroy_dataset (ds);
 242
 243   case_unref (c);
 244
 245   return retval;
 246 }
 247
 248 void
 249 expr_debug_print_postfix (const struct expression *e)
 250 {
 251   size_t i;
 252
 253   for (i = 0; i < e->op_cnt; i++)
 254     {
 255       union operation_data *op = &e->ops[i];
 256       if (i > 0)
 257         putc (' ', stderr);
 258       switch (e->op_types[i])
 259         {
 260         case OP_operation:
 261           if (op->operation == OP_return_number)
 262             printf ("return_number");
 263           else if (op->operation == OP_return_string)
 264             printf ("return_string");
 265           else if (is_function (op->operation))
 266             printf ("%s", operations[op->operation].prototype);
 267           else if (is_composite (op->operation))
 268             printf ("%s", operations[op->operation].name);
 269           else
 270             printf ("%s:", operations[op->operation].name);
 271           break;
 272         case OP_number:
 273           if (op->number != SYSMIS)
 274             printf ("n<%g>", op->number);
 275           else
 276             printf ("n<SYSMIS>");
 277           break;
 278         case OP_string:
 279           printf ("s<%.*s>",
 280                    (int) op->string.length,
 281                    op->string.string != NULL ? op->string.string : "");
 282           break;
 283         case OP_format:
 284           {
 285             char str[FMT_STRING_LEN_MAX + 1];
 286             fmt_to_string (op->format, str);
 287             printf ("f<%s>", str);
 288           }
 289           break;
 290         case OP_variable:
 291           printf ("v<%s>", var_get_name (op->variable));
 292           break;
 293         case OP_vector:
 294           printf ("vec<%s>", vector_get_name (op->vector));
 295           break;
 296         case OP_integer:
 297           printf ("i<%d>", op->integer);
 298           break;
 299         default:
 300           NOT_REACHED ();
 301         }
 302     }
 303   printf ("\n");
 304 }