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., 51 Franklin Street, Fifth Floor, Boston, MA
26 #include "dictionary.h"
28 #include "expressions/public.h"
29 #include "file-handle.h"
34 #include "value-labels.h"
38 #define _(msgid) gettext (msgid)
40 #include "debug-print.h"
42 /* Assign auxiliary data AUX to variable V, which must not
43 already have auxiliary data. Before V's auxiliary data is
44 cleared, AUX_DTOR(V) will be called. */
46 var_attach_aux (struct variable *v,
47 void *aux, void (*aux_dtor) (struct variable *))
49 assert (v->aux == NULL);
52 v->aux_dtor = aux_dtor;
56 /* Remove auxiliary data, if any, from V, and returns it, without
57 calling any associated destructor. */
59 var_detach_aux (struct variable *v)
67 /* Clears auxiliary data, if any, from V, and calls any
68 associated destructor. */
70 var_clear_aux (struct variable *v)
75 if (v->aux_dtor != NULL)
81 /* This function is appropriate for use an auxiliary data
82 destructor (passed as AUX_DTOR to var_attach_aux()) for the
83 case where the auxiliary data should be passed to free(). */
85 var_dtor_free (struct variable *v)
90 /* Compares A and B, which both have the given WIDTH, and returns
91 a strcmp()-type result. */
93 compare_values (const union value *a, const union value *b, int width)
96 return a->f < b->f ? -1 : a->f > b->f;
98 return memcmp (a->s, b->s, min(MAX_SHORT_STRING, width));
101 /* Create a hash of v */
103 hash_value(const union value *v, int width)
108 id_hash = hsh_hash_double (v->f);
110 id_hash = hsh_hash_bytes (v->s, min(MAX_SHORT_STRING, width));
118 /* Returns true if NAME is an acceptable name for a variable,
119 false otherwise. If ISSUE_ERROR is true, issues an
120 explanatory error message on failure. */
122 var_is_valid_name (const char *name, bool issue_error)
126 assert (name != NULL);
128 length = strlen (name);
132 msg (SE, _("Variable name cannot be empty string."));
135 else if (length > LONG_NAME_LEN)
138 msg (SE, _("Variable name %s exceeds %d-character limit."),
139 name, (int) LONG_NAME_LEN);
143 for (i = 0; i < length; i++)
144 if (!CHAR_IS_IDN (name[i]))
147 msg (SE, _("Character `%c' (in %s) may not appear in "
153 if (!CHAR_IS_ID1 (name[0]))
156 msg (SE, _("Character `%c' (in %s), may not appear "
157 "as the first character in a variable name."),
162 if (lex_id_to_token (name, strlen (name)) != T_ID)
165 msg (SE, _("%s may not be used as a variable name because it "
166 "is a reserved word."), name);
173 /* A hsh_compare_func that orders variables A and B by their
176 compare_var_names (const void *a_, const void *b_, void *foo UNUSED)
178 const struct variable *a = a_;
179 const struct variable *b = b_;
181 return strcasecmp (a->name, b->name);
184 /* A hsh_hash_func that hashes variable V based on its name. */
186 hash_var_name (const void *v_, void *foo UNUSED)
188 const struct variable *v = v_;
190 return hsh_hash_case_string (v->name);
193 /* A hsh_compare_func that orders pointers to variables A and B
196 compare_var_ptr_names (const void *a_, const void *b_, void *foo UNUSED)
198 struct variable *const *a = a_;
199 struct variable *const *b = b_;
201 return strcasecmp ((*a)->name, (*b)->name);
204 /* A hsh_hash_func that hashes pointer to variable V based on its
207 hash_var_ptr_name (const void *v_, void *foo UNUSED)
209 struct variable *const *v = v_;
211 return hsh_hash_case_string ((*v)->name);
214 /* Sets V's short_name to SHORT_NAME, truncating it to
215 SHORT_NAME_LEN characters and converting it to uppercase in
218 var_set_short_name (struct variable *v, const char *short_name)
221 assert (short_name[0] == '\0' || var_is_valid_name (short_name, false));
223 str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
224 str_uppercase (v->short_name);
227 /* Clears V's short name. */
229 var_clear_short_name (struct variable *v)
233 v->short_name[0] = '\0';
236 /* Sets V's short name to BASE, followed by a suffix of the form
237 _A, _B, _C, ..., _AA, _AB, etc. according to the value of
238 SUFFIX. Truncates BASE as necessary to fit. */
240 var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
242 char string[SHORT_NAME_LEN + 1];
247 assert (suffix >= 0);
248 assert (strlen (v->short_name) > 0);
251 var_set_short_name (v, base);
253 /* Compose suffix_string. */
254 start = end = string + sizeof string - 1;
258 *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
259 if (start <= string + 1)
260 msg (SE, _("Variable suffix too large."));
266 /* Append suffix_string to V's short name. */
268 if (len + strlen (v->short_name) > SHORT_NAME_LEN)
269 ofs = SHORT_NAME_LEN - len;
271 ofs = strlen (v->short_name);
272 strcpy (v->short_name + ofs, start);
276 /* Returns the dictionary class corresponding to a variable named
279 dict_class_from_id (const char *name)
281 assert (name != NULL);
294 /* Returns the name of dictionary class DICT_CLASS. */
296 dict_class_to_name (enum dict_class dict_class)
301 return _("ordinary");