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
25 #include "dictionary.h"
30 #include "value-labels.h"
33 #define _(msgid) gettext (msgid)
35 /* Returns an adjective describing the given variable TYPE,
36 suitable for use in phrases like "numeric variable". */
38 var_type_adj (enum var_type type)
40 return type == NUMERIC ? _("numeric") : _("string");
43 /* Returns a noun describing a value of the given variable TYPE,
44 suitable for use in phrases like "a number". */
46 var_type_noun (enum var_type type)
48 return type == NUMERIC ? _("number") : _("string");
51 /* Assign auxiliary data AUX to variable V, which must not
52 already have auxiliary data. Before V's auxiliary data is
53 cleared, AUX_DTOR(V) will be called. */
55 var_attach_aux (struct variable *v,
56 void *aux, void (*aux_dtor) (struct variable *))
58 assert (v->aux == NULL);
61 v->aux_dtor = aux_dtor;
65 /* Remove auxiliary data, if any, from V, and returns it, without
66 calling any associated destructor. */
68 var_detach_aux (struct variable *v)
76 /* Clears auxiliary data, if any, from V, and calls any
77 associated destructor. */
79 var_clear_aux (struct variable *v)
84 if (v->aux_dtor != NULL)
90 /* This function is appropriate for use an auxiliary data
91 destructor (passed as AUX_DTOR to var_attach_aux()) for the
92 case where the auxiliary data should be passed to free(). */
94 var_dtor_free (struct variable *v)
99 /* Compares A and B, which both have the given WIDTH, and returns
100 a strcmp()-type result. */
102 compare_values (const union value *a, const union value *b, int width)
105 return a->f < b->f ? -1 : a->f > b->f;
107 return memcmp (a->s, b->s, min(MAX_SHORT_STRING, width));
110 /* Create a hash of v */
112 hash_value(const union value *v, int width)
117 id_hash = hsh_hash_double (v->f);
119 id_hash = hsh_hash_bytes (v->s, min(MAX_SHORT_STRING, width));
127 /* Returns true if NAME is an acceptable name for a variable,
128 false otherwise. If ISSUE_ERROR is true, issues an
129 explanatory error message on failure. */
131 var_is_valid_name (const char *name, bool issue_error)
135 assert (name != NULL);
137 length = strlen (name);
141 msg (SE, _("Variable name cannot be empty string."));
144 else if (length > LONG_NAME_LEN)
147 msg (SE, _("Variable name %s exceeds %d-character limit."),
148 name, (int) LONG_NAME_LEN);
152 for (i = 0; i < length; i++)
153 if (!CHAR_IS_IDN (name[i]))
156 msg (SE, _("Character `%c' (in %s) may not appear in "
162 if (!CHAR_IS_ID1 (name[0]))
165 msg (SE, _("Character `%c' (in %s), may not appear "
166 "as the first character in a variable name."),
171 if (lex_id_to_token (name, strlen (name)) != T_ID)
174 msg (SE, _("%s may not be used as a variable name because it "
175 "is a reserved word."), name);
182 /* A hsh_compare_func that orders variables A and B by their
185 compare_var_names (const void *a_, const void *b_, void *foo UNUSED)
187 const struct variable *a = a_;
188 const struct variable *b = b_;
190 return strcasecmp (a->name, b->name);
193 /* A hsh_hash_func that hashes variable V based on its name. */
195 hash_var_name (const void *v_, void *foo UNUSED)
197 const struct variable *v = v_;
199 return hsh_hash_case_string (v->name);
202 /* A hsh_compare_func that orders pointers to variables A and B
205 compare_var_ptr_names (const void *a_, const void *b_, void *foo UNUSED)
207 struct variable *const *a = a_;
208 struct variable *const *b = b_;
210 return strcasecmp ((*a)->name, (*b)->name);
213 /* A hsh_hash_func that hashes pointer to variable V based on its
216 hash_var_ptr_name (const void *v_, void *foo UNUSED)
218 struct variable *const *v = v_;
220 return hsh_hash_case_string ((*v)->name);
223 /* Sets V's short_name to SHORT_NAME, truncating it to
224 SHORT_NAME_LEN characters and converting it to uppercase in
227 var_set_short_name (struct variable *v, const char *short_name)
230 assert (short_name[0] == '\0' || var_is_valid_name (short_name, false));
232 str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
233 str_uppercase (v->short_name);
236 /* Clears V's short name. */
238 var_clear_short_name (struct variable *v)
242 v->short_name[0] = '\0';
245 /* Sets V's short name to BASE, followed by a suffix of the form
246 _A, _B, _C, ..., _AA, _AB, etc. according to the value of
247 SUFFIX. Truncates BASE as necessary to fit. */
249 var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
251 char string[SHORT_NAME_LEN + 1];
256 assert (suffix >= 0);
257 assert (strlen (v->short_name) > 0);
260 var_set_short_name (v, base);
262 /* Compose suffix_string. */
263 start = end = string + sizeof string - 1;
267 *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
268 if (start <= string + 1)
269 msg (SE, _("Variable suffix too large."));
275 /* Append suffix_string to V's short name. */
277 if (len + strlen (v->short_name) > SHORT_NAME_LEN)
278 ofs = SHORT_NAME_LEN - len;
280 ofs = strlen (v->short_name);
281 strcpy (v->short_name + ofs, start);
285 /* Returns the dictionary class corresponding to a variable named
288 dict_class_from_id (const char *name)
290 assert (name != NULL);
303 /* Returns the name of dictionary class DICT_CLASS. */
305 dict_class_to_name (enum dict_class dict_class)
310 return _("ordinary");