1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc.
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.
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.
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/>. */
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>
38 #define _(msgid) gettext (msgid)
43 /* Target of a COMPUTE or IF assignment, either a variable or a
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 *);
52 /* COMPUTE and IF transformation. */
55 /* Test expression (IF only). */
56 struct expression *test; /* Test expression. */
58 /* Variable lvalue, if variable != NULL. */
59 struct variable *variable; /* Destination variable, if any. */
60 int width; /* Lvalue string width; 0=numeric. */
62 /* Vector lvalue, if vector != NULL. */
63 const struct vector *vector; /* Destination vector, if any. */
64 struct expression *element; /* Destination vector element expr. */
67 struct expression *rvalue; /* Rvalue expression. */
70 static struct expression *parse_rvalue (struct lexer *lexer,
71 const struct lvalue *,
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;
81 cmd_compute (struct lexer *lexer, struct dataset *ds)
83 struct dictionary *dict = dataset_dict (ds);
84 struct lvalue *lvalue = NULL;
85 struct compute_trns *compute = NULL;
87 compute = compute_trns_create ();
89 lvalue = lvalue_parse (lexer, ds);
93 if (!lex_force_match (lexer, '='))
95 compute->rvalue = parse_rvalue (lexer, lvalue, ds);
96 if (compute->rvalue == NULL)
99 add_transformation (ds, get_proc_func (lvalue), compute_trns_free, compute);
101 lvalue_finalize (lvalue, compute, dict);
103 return lex_end_of_command (lexer);
106 lvalue_destroy (lvalue, dict);
107 compute_trns_free (compute);
108 return CMD_CASCADING_FAILURE;
111 /* Transformation functions. */
113 /* Handle COMPUTE or IF with numeric target variable. */
115 compute_num (void *compute_, struct ccase **c, casenumber case_num)
117 struct compute_trns *compute = compute_;
119 if (compute->test == NULL
120 || expr_evaluate_num (compute->test, *c, case_num) == 1.0)
122 *c = case_unshare (*c);
123 case_data_rw (*c, compute->variable)->f
124 = expr_evaluate_num (compute->rvalue, *c, case_num);
127 return TRNS_CONTINUE;
130 /* Handle COMPUTE or IF with numeric vector element target
133 compute_num_vec (void *compute_, struct ccase **c, casenumber case_num)
135 struct compute_trns *compute = compute_;
137 if (compute->test == NULL
138 || expr_evaluate_num (compute->test, *c, case_num) == 1.0)
140 double index; /* Index into the vector. */
141 int rindx; /* Rounded index value. */
143 index = expr_evaluate_num (compute->element, *c, case_num);
144 rindx = floor (index + EPSILON);
146 || rindx < 1 || rindx > vector_get_var_cnt (compute->vector))
149 msg (SW, _("When executing COMPUTE: SYSMIS is not a valid value "
150 "as an index into vector %s."),
151 vector_get_name (compute->vector));
153 msg (SW, _("When executing COMPUTE: %g is not a valid value as "
154 "an index into vector %s."),
155 index, vector_get_name (compute->vector));
156 return TRNS_CONTINUE;
159 *c = case_unshare (*c);
160 case_data_rw (*c, vector_get_var (compute->vector, rindx - 1))->f
161 = expr_evaluate_num (compute->rvalue, *c, case_num);
164 return TRNS_CONTINUE;
167 /* Handle COMPUTE or IF with string target variable. */
169 compute_str (void *compute_, struct ccase **c, casenumber case_num)
171 struct compute_trns *compute = compute_;
173 if (compute->test == NULL
174 || expr_evaluate_num (compute->test, *c, case_num) == 1.0)
176 *c = case_unshare (*c);
177 expr_evaluate_str (compute->rvalue, *c, case_num,
178 case_data_rw (*c, compute->variable)->s,
182 return TRNS_CONTINUE;
185 /* Handle COMPUTE or IF with string vector element target
188 compute_str_vec (void *compute_, struct ccase **c, casenumber case_num)
190 struct compute_trns *compute = compute_;
192 if (compute->test == NULL
193 || expr_evaluate_num (compute->test, *c, case_num) == 1.0)
195 double index; /* Index into the vector. */
196 int rindx; /* Rounded index value. */
197 struct variable *vr; /* Variable reference by indexed vector. */
199 index = expr_evaluate_num (compute->element, *c, case_num);
200 rindx = floor (index + EPSILON);
203 msg (SW, _("When executing COMPUTE: SYSMIS is not a valid "
204 "value as an index into vector %s."),
205 vector_get_name (compute->vector));
206 return TRNS_CONTINUE;
208 else if (rindx < 1 || rindx > vector_get_var_cnt (compute->vector))
210 msg (SW, _("When executing COMPUTE: %g is not a valid value as "
211 "an index into vector %s."),
212 index, vector_get_name (compute->vector));
213 return TRNS_CONTINUE;
216 vr = vector_get_var (compute->vector, rindx - 1);
217 *c = case_unshare (*c);
218 expr_evaluate_str (compute->rvalue, *c, case_num,
219 case_data_rw (*c, vr)->s,
223 return TRNS_CONTINUE;
229 cmd_if (struct lexer *lexer, struct dataset *ds)
231 struct dictionary *dict = dataset_dict (ds);
232 struct compute_trns *compute = NULL;
233 struct lvalue *lvalue = NULL;
235 compute = compute_trns_create ();
237 /* Test expression. */
238 compute->test = expr_parse (lexer, ds, EXPR_BOOLEAN);
239 if (compute->test == NULL)
242 /* Lvalue variable. */
243 lvalue = lvalue_parse (lexer, ds);
247 /* Rvalue expression. */
248 if (!lex_force_match (lexer, '='))
250 compute->rvalue = parse_rvalue (lexer, lvalue, ds);
251 if (compute->rvalue == NULL)
254 add_transformation (ds, get_proc_func (lvalue), compute_trns_free, compute);
256 lvalue_finalize (lvalue, compute, dict);
258 return lex_end_of_command (lexer);
261 lvalue_destroy (lvalue, dict);
262 compute_trns_free (compute);
263 return CMD_CASCADING_FAILURE;
266 /* Code common to COMPUTE and IF. */
268 static trns_proc_func *
269 get_proc_func (const struct lvalue *lvalue)
271 bool is_numeric = lvalue_get_type (lvalue) == VAL_NUMERIC;
272 bool is_vector = lvalue_is_vector (lvalue);
275 ? (is_vector ? compute_num_vec : compute_num)
276 : (is_vector ? compute_str_vec : compute_str));
279 /* Parses and returns an rvalue expression of the same type as
280 LVALUE, or a null pointer on failure. */
281 static struct expression *
282 parse_rvalue (struct lexer *lexer,
283 const struct lvalue *lvalue, struct dataset *ds)
285 bool is_numeric = lvalue_get_type (lvalue) == VAL_NUMERIC;
287 return expr_parse (lexer, ds, is_numeric ? EXPR_NUMBER : EXPR_STRING);
290 /* Returns a new struct compute_trns after initializing its fields. */
291 static struct compute_trns *
292 compute_trns_create (void)
294 struct compute_trns *compute = xmalloc (sizeof *compute);
295 compute->test = NULL;
296 compute->variable = NULL;
297 compute->vector = NULL;
298 compute->element = NULL;
299 compute->rvalue = NULL;
303 /* Deletes all the fields in COMPUTE. */
305 compute_trns_free (void *compute_)
307 struct compute_trns *compute = compute_;
311 expr_free (compute->test);
312 expr_free (compute->element);
313 expr_free (compute->rvalue);
319 /* COMPUTE or IF target variable or vector element.
320 For a variable, the `variable' member is non-null.
321 For a vector element, the `vector' member is non-null. */
324 struct variable *variable; /* Destination variable. */
325 bool is_new_variable; /* Did we create the variable? */
327 const struct vector *vector; /* Destination vector, if any, or NULL. */
328 struct expression *element; /* Destination vector element, or NULL. */
331 /* Parses the target variable or vector element into a new
332 `struct lvalue', which is returned. */
333 static struct lvalue *
334 lvalue_parse (struct lexer *lexer, struct dataset *ds)
336 struct dictionary *dict = dataset_dict (ds);
337 struct lvalue *lvalue;
339 lvalue = xmalloc (sizeof *lvalue);
340 lvalue->variable = NULL;
341 lvalue->is_new_variable = false;
342 lvalue->vector = NULL;
343 lvalue->element = NULL;
345 if (!lex_force_id (lexer))
348 if (lex_look_ahead (lexer) == '(')
351 lvalue->vector = dict_lookup_vector (dict, lex_tokid (lexer));
352 if (lvalue->vector == NULL)
354 msg (SE, _("There is no vector named %s."), lex_tokid (lexer));
358 /* Vector element. */
360 if (!lex_force_match (lexer, '('))
362 lvalue->element = expr_parse (lexer, ds, EXPR_NUMBER);
363 if (lvalue->element == NULL)
365 if (!lex_force_match (lexer, ')'))
371 const char *var_name = lex_tokid (lexer);
372 lvalue->variable = dict_lookup_var (dict, var_name);
373 if (lvalue->variable == NULL)
375 lvalue->variable = dict_create_var_assert (dict, var_name, 0);
376 lvalue->is_new_variable = true;
383 lvalue_destroy (lvalue, dict);
387 /* Returns the type (NUMERIC or ALPHA) of the target variable or
390 lvalue_get_type (const struct lvalue *lvalue)
392 return (lvalue->variable != NULL
393 ? var_get_type (lvalue->variable)
394 : vector_get_type (lvalue->vector));
397 /* Returns true if LVALUE has a vector as its target. */
399 lvalue_is_vector (const struct lvalue *lvalue)
401 return lvalue->vector != NULL;
404 /* Finalizes making LVALUE the target of COMPUTE, by creating the
405 target variable if necessary and setting fields in COMPUTE. */
407 lvalue_finalize (struct lvalue *lvalue,
408 struct compute_trns *compute,
409 struct dictionary *dict)
411 if (lvalue->vector == NULL)
413 compute->variable = lvalue->variable;
414 compute->width = var_get_width (compute->variable);
416 /* Goofy behavior, but compatible: Turn off LEAVE. */
417 if (!var_must_leave (compute->variable))
418 var_set_leave (compute->variable, false);
420 /* Prevent lvalue_destroy from deleting variable. */
421 lvalue->is_new_variable = false;
425 compute->vector = lvalue->vector;
426 compute->element = lvalue->element;
427 lvalue->element = NULL;
430 lvalue_destroy (lvalue, dict);
433 /* Destroys LVALUE. */
435 lvalue_destroy (struct lvalue *lvalue, struct dictionary *dict)
440 if (lvalue->is_new_variable)
441 dict_delete_var (dict, lvalue->variable);
442 expr_free (lvalue->element);