1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26 #include "bitvector.h"
33 /* Parses a name as a variable within VS and returns the variable
34 if successful. On failure emits an error message and returns
36 static struct variable *
37 parse_vs_variable (struct var_set *vs)
43 lex_error ("expecting variable name");
47 vp = var_set_lookup_var (vs, tokid);
49 msg (SE, _("%s is not a variable name."), tokid);
55 /* Parses a variable name in dictionary D and returns the
56 variable if successful. On failure emits an error message and
57 returns a null pointer. */
59 parse_dict_variable (struct dictionary *d)
61 struct var_set *vs = var_set_create_from_dict (d);
62 struct variable *var = parse_vs_variable (vs);
67 /* Parses a variable name in default_dict and returns the
68 variable if successful. On failure emits an error message and
69 returns a null pointer. */
73 return parse_dict_variable (default_dict);
76 /* Returns the dictionary class corresponding to a variable named
79 dict_class_from_id (const char *name)
81 assert (name != NULL);
94 /* Returns the name of dictionary class DICT_CLASS. */
96 dict_class_to_name (enum dict_class dict_class)
101 return _("ordinary");
111 /* Parses a set of variables from dictionary D given options
112 OPTS. Resulting list of variables stored in *VAR and the
113 number of variables into *CNT. */
115 parse_variables (struct dictionary *d, struct variable ***var, int *cnt,
122 assert (var != NULL);
123 assert (cnt != NULL);
125 vs = var_set_create_from_dict (d);
126 success = parse_var_set_vars (vs, var, cnt, opts);
127 var_set_destroy (vs);
131 /* Note that if parse_variables() returns 0, *v is free()'d.
132 Conversely, if parse_variables() returns non-zero, then *nv is
133 nonzero and *v is non-NULL. */
135 parse_var_set_vars (struct var_set *vs,
136 struct variable ***v, int *nv,
141 char *included = NULL;
143 struct variable *v1, *v2;
145 enum dict_class dict_class;
151 /* At most one of PV_NUMERIC, PV_STRING, PV_SAME_TYPE may be
153 assert ((((pv_opts & PV_NUMERIC) != 0)
154 + ((pv_opts & PV_STRING) != 0)
155 + ((pv_opts & PV_SAME_TYPE) != 0)) <= 1);
157 /* PV_DUPLICATE and PV_NO_DUPLICATE are incompatible. */
158 assert (!(pv_opts & PV_DUPLICATE) || !(pv_opts & PV_NO_DUPLICATE));
160 vs_var_cnt = var_set_get_cnt (vs);
162 if (!(pv_opts & PV_APPEND))
171 if (!(pv_opts & PV_DUPLICATE))
173 included = xmalloc (vs_var_cnt);
174 memset (included, 0, vs_var_cnt);
175 for (i = 0; i < *nv; i++)
176 included[(*v)[i]->index] = 1;
181 if (lex_match (T_ALL))
183 v1 = var_set_get_var (vs, 0);
184 v2 = var_set_get_var (vs, vs_var_cnt - 1);
186 dict_class = DC_ORDINARY;
190 v1 = parse_vs_variable (vs);
194 if (lex_match (T_TO))
196 enum dict_class dict_class_2;
198 v2 = parse_vs_variable (vs);
201 lex_error ("expecting variable name");
205 count = v2->index - v1->index + 1;
208 msg (SE, _("%s TO %s is not valid syntax since %s "
209 "precedes %s in the dictionary."),
210 v1->name, v2->name, v2->name, v1->name);
214 dict_class = dict_class_from_id (v1->name);
215 dict_class_2 = dict_class_from_id (v2->name);
216 if (dict_class != dict_class_2)
218 msg (SE, _("When using the TO keyword to specify several "
219 "variables, both variables must be from "
220 "the same variable dictionaries, of either "
221 "ordinary, scratch, or system variables. "
222 "%s is a %s variable, whereas %s is %s."),
223 v1->name, dict_class_to_name (dict_class),
224 v2->name, dict_class_to_name (dict_class_2));
232 dict_class = dict_class_from_id (v1->name);
234 if (dict_class == DC_SCRATCH && (pv_opts & PV_NO_SCRATCH))
236 msg (SE, _("Scratch variables (such as %s) are not allowed "
242 if (*nv + count > mv)
244 mv += ROUND_UP (count, 16);
245 *v = xrealloc (*v, mv * sizeof **v);
248 /* Add v1...v2 to the list. */
249 for (i = v1->index; i <= v2->index; i++)
251 struct variable *add = var_set_get_var (vs, i);
253 /* Skip over other dictionaries. */
254 if (dict_class != dict_class_from_id (add->name))
257 /* Different kinds of errors. */
258 if ((pv_opts & PV_NUMERIC) && add->type != NUMERIC)
259 msg (SW, _("%s is not a numeric variable. It will not be "
260 "included in the variable list."), add->name);
261 else if ((pv_opts & PV_STRING) && add->type != ALPHA)
262 msg (SE, _("%s is not a string variable. It will not be "
263 "included in the variable list."), add->name);
264 else if ((pv_opts & PV_SAME_TYPE) && *nv
265 && add->type != (*v)[0]->type)
266 msg (SE, _("%s and %s are not the same type. All variables in "
267 "this variable list must be of the same type. %s "
268 "will be omitted from list."),
269 (*v)[0]->name, add->name, add->name);
270 else if ((pv_opts & PV_NO_DUPLICATE) && included[add->index])
271 msg (SE, _("Variable %s appears twice in variable list."),
274 /* Success--add the variable to the list. */
275 if ((pv_opts & PV_DUPLICATE) || !included[add->index])
277 (*v)[(*nv)++] = var_set_get_var (vs, i);
278 if (!(pv_opts & PV_DUPLICATE))
279 included[add->index] = 1;
286 /* Arrive here only on failure. */
287 if (pv_opts & PV_SINGLE)
291 /* We finished adding v1...v2 to the list. */
292 if (pv_opts & PV_SINGLE)
296 while ((token == T_ID && var_set_lookup_var (vs, tokid) != NULL)
299 if (!(pv_opts & PV_DUPLICATE))
309 if (!(pv_opts & PV_DUPLICATE))
314 /* Extracts a numeric suffix from variable name S, copying it
315 into string R. Sets *D to the length of R and *N to its
318 extract_num (char *s, char *r, int *n, int *d)
322 /* Find first digit. */
323 cp = s + strlen (s) - 1;
324 while (isdigit ((unsigned char) *cp) && cp > s)
329 strncpy (r, s, cp - s);
332 /* Count initial zeros. */
341 while (isdigit ((unsigned char) *cp))
344 *n = (*n * 10) + (*cp - '0');
349 if (*n == 0 && *d == 0)
351 msg (SE, _("incorrect use of TO convention"));
357 /* Parses a list of variable names according to the DATA LIST version
358 of the TO convention. */
360 parse_DATA_LIST_vars (char ***names, int *nnames, int pv_opts)
370 assert (names != NULL);
371 assert (nnames != NULL);
372 assert ((pv_opts & ~(PV_APPEND | PV_SINGLE
373 | PV_NO_SCRATCH | PV_NO_DUPLICATE)) == 0);
374 /* FIXME: PV_NO_DUPLICATE is not implemented. */
376 if (pv_opts & PV_APPEND)
377 nvar = mvar = *nnames;
384 name1 = xmalloc (36);
385 name2 = &name1[1 * 9];
386 root1 = &name1[2 * 9];
387 root2 = &name1[3 * 9];
392 lex_error ("expecting variable name");
395 if (dict_class_from_id (tokid) == DC_SCRATCH
396 && (pv_opts & PV_NO_SCRATCH))
398 msg (SE, _("Scratch variables not allowed here."));
401 strcpy (name1, tokid);
408 lex_error ("expecting variable name");
411 strcpy (name2, tokid);
414 if (!extract_num (name1, root1, &n1, &d1)
415 || !extract_num (name2, root2, &n2, &d2))
418 if (strcmp (root1, root2))
420 msg (SE, _("Prefixes don't match in use of TO convention."));
425 msg (SE, _("Bad bounds in use of TO convention."));
431 if (mvar < nvar + (n2 - n1 + 1))
433 mvar += ROUND_UP (n2 - n1 + 1, 16);
434 *names = xrealloc (*names, mvar * sizeof **names);
437 for (n = n1; n <= n2; n++)
439 (*names)[nvar] = xmalloc (9);
440 sprintf ((*names)[nvar], "%s%0*d", root1, d1, n);
449 *names = xrealloc (*names, mvar * sizeof **names);
451 (*names)[nvar++] = xstrdup (name1);
456 if (pv_opts & PV_SINGLE)
459 while (token == T_ID);
468 for (i = 0; i < nvar; i++)
477 /* Parses a list of variables where some of the variables may be
478 existing and the rest are to be created. Same args as
479 parse_DATA_LIST_vars(). */
481 parse_mixed_vars (char ***names, int *nnames, int pv_opts)
485 assert (names != NULL);
486 assert (nnames != NULL);
487 assert ((pv_opts & ~PV_APPEND) == 0);
489 if (!(pv_opts & PV_APPEND))
494 while (token == T_ID || token == T_ALL)
496 if (token == T_ALL || dict_lookup_var (default_dict, tokid) != NULL)
501 if (!parse_variables (default_dict, &v, &nv, PV_NONE))
503 *names = xrealloc (*names, (*nnames + nv) * sizeof **names);
504 for (i = 0; i < nv; i++)
505 (*names)[*nnames + i] = xstrdup (v[i]->name);
509 else if (!parse_DATA_LIST_vars (names, nnames, PV_APPEND))
515 for (i = 0; i < *nnames; i++)
516 free ((*names)[*nnames]);
523 /* A set of variables. */
526 size_t (*get_cnt) (struct var_set *);
527 struct variable *(*get_var) (struct var_set *, size_t idx);
528 struct variable *(*lookup_var) (struct var_set *, const char *);
529 void (*destroy) (struct var_set *);
533 /* Returns the number of variables in VS. */
535 var_set_get_cnt (struct var_set *vs)
539 return vs->get_cnt (vs);
542 /* Return variable with index IDX in VS.
543 IDX must be less than the number of variables in VS. */
545 var_set_get_var (struct var_set *vs, size_t idx)
548 assert (idx < var_set_get_cnt (vs));
550 return vs->get_var (vs, idx);
553 /* Returns the variable in VS named NAME, or a null pointer if VS
554 contains no variable with that name. */
556 var_set_lookup_var (struct var_set *vs, const char *name)
559 assert (name != NULL);
560 assert (strlen (name) < 9);
562 return vs->lookup_var (vs, name);
567 var_set_destroy (struct var_set *vs)
573 /* Returns the number of variables in VS. */
575 dict_var_set_get_cnt (struct var_set *vs)
577 struct dictionary *d = vs->aux;
579 return dict_get_var_cnt (d);
582 /* Return variable with index IDX in VS.
583 IDX must be less than the number of variables in VS. */
584 static struct variable *
585 dict_var_set_get_var (struct var_set *vs, size_t idx)
587 struct dictionary *d = vs->aux;
589 return dict_get_var (d, idx);
592 /* Returns the variable in VS named NAME, or a null pointer if VS
593 contains no variable with that name. */
594 static struct variable *
595 dict_var_set_lookup_var (struct var_set *vs, const char *name)
597 struct dictionary *d = vs->aux;
599 return dict_lookup_var (d, name);
604 dict_var_set_destroy (struct var_set *vs)
609 /* Returns a variable set based on D. */
611 var_set_create_from_dict (struct dictionary *d)
613 struct var_set *vs = xmalloc (sizeof *vs);
614 vs->get_cnt = dict_var_set_get_cnt;
615 vs->get_var = dict_var_set_get_var;
616 vs->lookup_var = dict_var_set_lookup_var;
617 vs->destroy = dict_var_set_destroy;
622 /* A variable set based on an array. */
625 struct variable **var; /* Array of variables. */
626 size_t var_cnt; /* Number of elements in var. */
627 struct hsh_table *name_tab; /* Hash from variable names to variables. */
630 /* Returns the number of variables in VS. */
632 array_var_set_get_cnt (struct var_set *vs)
634 struct array_var_set *avs = vs->aux;
639 /* Return variable with index IDX in VS.
640 IDX must be less than the number of variables in VS. */
641 static struct variable *
642 array_var_set_get_var (struct var_set *vs, size_t idx)
644 struct array_var_set *avs = vs->aux;
646 return avs->var[idx];
649 /* Returns the variable in VS named NAME, or a null pointer if VS
650 contains no variable with that name. */
651 static struct variable *
652 array_var_set_lookup_var (struct var_set *vs, const char *name)
654 struct array_var_set *avs = vs->aux;
657 strcpy (v.name, name);
659 return hsh_find (avs->name_tab, &v);
664 array_var_set_destroy (struct var_set *vs)
666 struct array_var_set *avs = vs->aux;
668 hsh_destroy (avs->name_tab);
673 /* Returns a variable set based on the VAR_CNT variables in
676 var_set_create_from_array (struct variable **var, size_t var_cnt)
679 struct array_var_set *avs;
682 vs = xmalloc (sizeof *vs);
683 vs->get_cnt = array_var_set_get_cnt;
684 vs->get_var = array_var_set_get_var;
685 vs->lookup_var = array_var_set_lookup_var;
686 vs->destroy = array_var_set_destroy;
687 vs->aux = avs = xmalloc (sizeof *avs);
689 avs->var_cnt = var_cnt;
690 avs->name_tab = hsh_create (2 * var_cnt,
691 compare_variables, hash_variable, NULL,
693 for (i = 0; i < var_cnt; i++)
694 if (hsh_insert (avs->name_tab, var[i]) != NULL)
696 var_set_destroy (vs);