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
25 #include "bitvector.h"
32 /* Parses a name as a variable within VS and returns the variable
33 if successful. On failure emits an error message and returns
35 static struct variable *
36 parse_vs_variable (struct var_set *vs)
42 lex_error ("expecting variable name");
46 vp = var_set_lookup_var (vs, tokid);
48 msg (SE, _("%s is not a variable name."), tokid);
54 /* Parses a variable name in dictionary D and returns the
55 variable if successful. On failure emits an error message and
56 returns a null pointer. */
58 parse_dict_variable (struct dictionary *d)
60 struct var_set *vs = var_set_create_from_dict (d);
61 struct variable *var = parse_vs_variable (vs);
66 /* Parses a variable name in default_dict and returns the
67 variable if successful. On failure emits an error message and
68 returns a null pointer. */
72 return parse_dict_variable (default_dict);
75 /* Returns the dictionary class corresponding to a variable named
78 dict_class_from_id (const char *name)
80 assert (name != NULL);
93 /* Returns the name of dictionary class DICT_CLASS. */
95 dict_class_to_name (enum dict_class dict_class)
100 return _("ordinary");
110 /* Parses a set of variables from dictionary D given options
111 OPTS. Resulting list of variables stored in *VAR and the
112 number of variables into *CNT. */
114 parse_variables (struct dictionary *d, struct variable ***var, int *cnt,
121 assert (var != NULL);
122 assert (cnt != NULL);
124 vs = var_set_create_from_dict (d);
125 success = parse_var_set_vars (vs, var, cnt, opts);
126 var_set_destroy (vs);
130 /* Note that if parse_variables() returns 0, *v is free()'d.
131 Conversely, if parse_variables() returns non-zero, then *nv is
132 nonzero and *v is non-NULL. */
134 parse_var_set_vars (struct var_set *vs,
135 struct variable ***v, int *nv,
140 char *included = NULL;
142 struct variable *v1, *v2;
144 enum dict_class dict_class;
150 /* At most one of PV_NUMERIC, PV_STRING, PV_SAME_TYPE may be
152 assert ((((pv_opts & PV_NUMERIC) != 0)
153 + ((pv_opts & PV_STRING) != 0)
154 + ((pv_opts & PV_SAME_TYPE) != 0)) <= 1);
156 /* PV_DUPLICATE and PV_NO_DUPLICATE are incompatible. */
157 assert (!(pv_opts & PV_DUPLICATE) || !(pv_opts & PV_NO_DUPLICATE));
159 vs_var_cnt = var_set_get_cnt (vs);
161 if (!(pv_opts & PV_APPEND))
170 if (!(pv_opts & PV_DUPLICATE))
172 included = xmalloc (vs_var_cnt);
173 memset (included, 0, vs_var_cnt);
174 for (i = 0; i < *nv; i++)
175 included[(*v)[i]->index] = 1;
180 if (lex_match (T_ALL))
182 v1 = var_set_get_var (vs, 0);
183 v2 = var_set_get_var (vs, vs_var_cnt - 1);
185 dict_class = DC_ORDINARY;
189 v1 = parse_vs_variable (vs);
193 if (lex_match (T_TO))
195 enum dict_class dict_class_2;
197 v2 = parse_vs_variable (vs);
200 lex_error ("expecting variable name");
204 count = v2->index - v1->index + 1;
207 msg (SE, _("%s TO %s is not valid syntax since %s "
208 "precedes %s in the dictionary."),
209 v1->name, v2->name, v2->name, v1->name);
213 dict_class = dict_class_from_id (v1->name);
214 dict_class_2 = dict_class_from_id (v2->name);
215 if (dict_class != dict_class_2)
217 msg (SE, _("When using the TO keyword to specify several "
218 "variables, both variables must be from "
219 "the same variable dictionaries, of either "
220 "ordinary, scratch, or system variables. "
221 "%s is a %s variable, whereas %s is %s."),
222 v1->name, dict_class_to_name (dict_class),
223 v2->name, dict_class_to_name (dict_class_2));
231 dict_class = dict_class_from_id (v1->name);
233 if (dict_class == DC_SCRATCH && (pv_opts & PV_NO_SCRATCH))
235 msg (SE, _("Scratch variables (such as %s) are not allowed "
241 if (*nv + count > mv)
243 mv += ROUND_UP (count, 16);
244 *v = xrealloc (*v, mv * sizeof **v);
247 /* Add v1...v2 to the list. */
248 for (i = v1->index; i <= v2->index; i++)
250 struct variable *add = var_set_get_var (vs, i);
252 /* Skip over other dictionaries. */
253 if (dict_class != dict_class_from_id (add->name))
256 /* Different kinds of errors. */
257 if ((pv_opts & PV_NUMERIC) && add->type != NUMERIC)
258 msg (SW, _("%s is not a numeric variable. It will not be "
259 "included in the variable list."), add->name);
260 else if ((pv_opts & PV_STRING) && add->type != ALPHA)
261 msg (SE, _("%s is not a string variable. It will not be "
262 "included in the variable list."), add->name);
263 else if ((pv_opts & PV_SAME_TYPE) && *nv
264 && add->type != (*v)[0]->type)
265 msg (SE, _("%s and %s are not the same type. All variables in "
266 "this variable list must be of the same type. %s "
267 "will be omitted from list."),
268 (*v)[0]->name, add->name, add->name);
269 else if ((pv_opts & PV_NO_DUPLICATE) && included[add->index])
270 msg (SE, _("Variable %s appears twice in variable list."),
273 /* Success--add the variable to the list. */
274 if ((pv_opts & PV_DUPLICATE) || !included[add->index])
276 (*v)[(*nv)++] = var_set_get_var (vs, i);
277 if (!(pv_opts & PV_DUPLICATE))
278 included[add->index] = 1;
285 /* Arrive here only on failure. */
286 if (pv_opts & PV_SINGLE)
290 /* We finished adding v1...v2 to the list. */
291 if (pv_opts & PV_SINGLE)
295 while ((token == T_ID && var_set_lookup_var (vs, tokid) != NULL)
298 if (!(pv_opts & PV_DUPLICATE))
308 if (!(pv_opts & PV_DUPLICATE))
313 /* Extracts a numeric suffix from variable name S, copying it
314 into string R. Sets *D to the length of R and *N to its
317 extract_num (char *s, char *r, int *n, int *d)
321 /* Find first digit. */
322 cp = s + strlen (s) - 1;
323 while (isdigit ((unsigned char) *cp) && cp > s)
328 strncpy (r, s, cp - s);
331 /* Count initial zeros. */
340 while (isdigit ((unsigned char) *cp))
343 *n = (*n * 10) + (*cp - '0');
348 if (*n == 0 && *d == 0)
350 msg (SE, _("incorrect use of TO convention"));
356 /* Parses a list of variable names according to the DATA LIST version
357 of the TO convention. */
359 parse_DATA_LIST_vars (char ***names, int *nnames, int pv_opts)
369 assert (names != NULL);
370 assert (nnames != NULL);
371 assert ((pv_opts & ~(PV_APPEND | PV_SINGLE
372 | PV_NO_SCRATCH | PV_NO_DUPLICATE)) == 0);
373 /* FIXME: PV_NO_DUPLICATE is not implemented. */
375 if (pv_opts & PV_APPEND)
376 nvar = mvar = *nnames;
383 name1 = xmalloc (36);
384 name2 = &name1[1 * 9];
385 root1 = &name1[2 * 9];
386 root2 = &name1[3 * 9];
391 lex_error ("expecting variable name");
394 if (dict_class_from_id (tokid) == DC_SCRATCH
395 && (pv_opts & PV_NO_SCRATCH))
397 msg (SE, _("Scratch variables not allowed here."));
400 strcpy (name1, tokid);
407 lex_error ("expecting variable name");
410 strcpy (name2, tokid);
413 if (!extract_num (name1, root1, &n1, &d1)
414 || !extract_num (name2, root2, &n2, &d2))
417 if (strcmp (root1, root2))
419 msg (SE, _("Prefixes don't match in use of TO convention."));
424 msg (SE, _("Bad bounds in use of TO convention."));
430 if (mvar < nvar + (n2 - n1 + 1))
432 mvar += ROUND_UP (n2 - n1 + 1, 16);
433 *names = xrealloc (*names, mvar * sizeof **names);
436 for (n = n1; n <= n2; n++)
438 (*names)[nvar] = xmalloc (9);
439 sprintf ((*names)[nvar], "%s%0*d", root1, d1, n);
448 *names = xrealloc (*names, mvar * sizeof **names);
450 (*names)[nvar++] = xstrdup (name1);
455 if (pv_opts & PV_SINGLE)
458 while (token == T_ID);
467 for (i = 0; i < nvar; i++)
476 /* Parses a list of variables where some of the variables may be
477 existing and the rest are to be created. Same args as
478 parse_DATA_LIST_vars(). */
480 parse_mixed_vars (char ***names, int *nnames, int pv_opts)
484 assert (names != NULL);
485 assert (nnames != NULL);
486 assert ((pv_opts & ~PV_APPEND) == 0);
488 if (!(pv_opts & PV_APPEND))
493 while (token == T_ID || token == T_ALL)
495 if (token == T_ALL || dict_lookup_var (default_dict, tokid) != NULL)
500 if (!parse_variables (default_dict, &v, &nv, PV_NONE))
502 *names = xrealloc (*names, (*nnames + nv) * sizeof **names);
503 for (i = 0; i < nv; i++)
504 (*names)[*nnames + i] = xstrdup (v[i]->name);
508 else if (!parse_DATA_LIST_vars (names, nnames, PV_APPEND))
514 for (i = 0; i < *nnames; i++)
515 free ((*names)[*nnames]);
522 /* A set of variables. */
525 size_t (*get_cnt) (struct var_set *);
526 struct variable *(*get_var) (struct var_set *, size_t idx);
527 struct variable *(*lookup_var) (struct var_set *, const char *);
528 void (*destroy) (struct var_set *);
532 /* Returns the number of variables in VS. */
534 var_set_get_cnt (struct var_set *vs)
538 return vs->get_cnt (vs);
541 /* Return variable with index IDX in VS.
542 IDX must be less than the number of variables in VS. */
544 var_set_get_var (struct var_set *vs, size_t idx)
547 assert (idx < var_set_get_cnt (vs));
549 return vs->get_var (vs, idx);
552 /* Returns the variable in VS named NAME, or a null pointer if VS
553 contains no variable with that name. */
555 var_set_lookup_var (struct var_set *vs, const char *name)
558 assert (name != NULL);
559 assert (strlen (name) < 9);
561 return vs->lookup_var (vs, name);
566 var_set_destroy (struct var_set *vs)
572 /* Returns the number of variables in VS. */
574 dict_var_set_get_cnt (struct var_set *vs)
576 struct dictionary *d = vs->aux;
578 return dict_get_var_cnt (d);
581 /* Return variable with index IDX in VS.
582 IDX must be less than the number of variables in VS. */
583 static struct variable *
584 dict_var_set_get_var (struct var_set *vs, size_t idx)
586 struct dictionary *d = vs->aux;
588 return dict_get_var (d, idx);
591 /* Returns the variable in VS named NAME, or a null pointer if VS
592 contains no variable with that name. */
593 static struct variable *
594 dict_var_set_lookup_var (struct var_set *vs, const char *name)
596 struct dictionary *d = vs->aux;
598 return dict_lookup_var (d, name);
603 dict_var_set_destroy (struct var_set *vs)
608 /* Returns a variable set based on D. */
610 var_set_create_from_dict (struct dictionary *d)
612 struct var_set *vs = xmalloc (sizeof *vs);
613 vs->get_cnt = dict_var_set_get_cnt;
614 vs->get_var = dict_var_set_get_var;
615 vs->lookup_var = dict_var_set_lookup_var;
616 vs->destroy = dict_var_set_destroy;
621 /* A variable set based on an array. */
624 struct variable **var; /* Array of variables. */
625 size_t var_cnt; /* Number of elements in var. */
626 struct hsh_table *name_tab; /* Hash from variable names to variables. */
629 /* Returns the number of variables in VS. */
631 array_var_set_get_cnt (struct var_set *vs)
633 struct array_var_set *avs = vs->aux;
638 /* Return variable with index IDX in VS.
639 IDX must be less than the number of variables in VS. */
640 static struct variable *
641 array_var_set_get_var (struct var_set *vs, size_t idx)
643 struct array_var_set *avs = vs->aux;
645 return avs->var[idx];
648 /* Returns the variable in VS named NAME, or a null pointer if VS
649 contains no variable with that name. */
650 static struct variable *
651 array_var_set_lookup_var (struct var_set *vs, const char *name)
653 struct array_var_set *avs = vs->aux;
656 strcpy (v.name, name);
658 return hsh_find (avs->name_tab, &v);
663 array_var_set_destroy (struct var_set *vs)
665 struct array_var_set *avs = vs->aux;
667 hsh_destroy (avs->name_tab);
672 /* Returns a variable set based on the VAR_CNT variables in
675 var_set_create_from_array (struct variable **var, size_t var_cnt)
678 struct array_var_set *avs;
681 vs = xmalloc (sizeof *vs);
682 vs->get_cnt = array_var_set_get_cnt;
683 vs->get_var = array_var_set_get_var;
684 vs->lookup_var = array_var_set_lookup_var;
685 vs->destroy = array_var_set_destroy;
686 vs->aux = avs = xmalloc (sizeof *avs);
688 avs->var_cnt = var_cnt;
689 avs->name_tab = hsh_create (2 * var_cnt,
690 compare_variables, hash_variable, NULL,
692 for (i = 0; i < var_cnt; i++)
693 if (hsh_insert (avs->name_tab, var[i]) != NULL)
695 var_set_destroy (vs);