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
22 #include <libpspp/assertion.h>
23 #include <libpspp/message.h>
25 #include <libpspp/alloc.h>
26 #include <libpspp/compiler.h>
27 #include "dictionary.h"
28 #include <libpspp/hash.h>
29 #include "identifier.h"
30 #include <libpspp/misc.h>
31 #include <libpspp/str.h>
32 #include "value-labels.h"
35 #define _(msgid) gettext (msgid)
37 /* Returns an adjective describing the given variable TYPE,
38 suitable for use in phrases like "numeric variable". */
40 var_type_adj (enum var_type type)
42 return type == NUMERIC ? _("numeric") : _("string");
45 /* Returns a noun describing a value of the given variable TYPE,
46 suitable for use in phrases like "a number". */
48 var_type_noun (enum var_type type)
50 return type == NUMERIC ? _("number") : _("string");
53 /* Assign auxiliary data AUX to variable V, which must not
54 already have auxiliary data. Before V's auxiliary data is
55 cleared, AUX_DTOR(V) will be called. */
57 var_attach_aux (struct variable *v,
58 void *aux, void (*aux_dtor) (struct variable *))
60 assert (v->aux == NULL);
63 v->aux_dtor = aux_dtor;
67 /* Remove auxiliary data, if any, from V, and returns it, without
68 calling any associated destructor. */
70 var_detach_aux (struct variable *v)
78 /* Clears auxiliary data, if any, from V, and calls any
79 associated destructor. */
81 var_clear_aux (struct variable *v)
86 if (v->aux_dtor != NULL)
92 /* This function is appropriate for use an auxiliary data
93 destructor (passed as AUX_DTOR to var_attach_aux()) for the
94 case where the auxiliary data should be passed to free(). */
96 var_dtor_free (struct variable *v)
101 /* Compares A and B, which both have the given WIDTH, and returns
102 a strcmp()-type result. */
104 compare_values (const union value *a, const union value *b, int width)
107 return a->f < b->f ? -1 : a->f > b->f;
109 return memcmp (a->s, b->s, min(MAX_SHORT_STRING, width));
112 /* Create a hash of v */
114 hash_value(const union value *v, int width)
119 id_hash = hsh_hash_double (v->f);
121 id_hash = hsh_hash_bytes (v->s, min(MAX_SHORT_STRING, width));
129 /* Returns true if NAME is an acceptable name for a variable,
130 false otherwise. If ISSUE_ERROR is true, issues an
131 explanatory error message on failure. */
133 var_is_valid_name (const char *name, bool issue_error)
138 assert (name != NULL);
140 /* Note that strlen returns number of BYTES, not the number of
142 length = strlen (name);
144 plausible = var_is_plausible_name(name, issue_error);
150 if (!lex_is_id1 (name[0]))
153 msg (SE, _("Character `%c' (in %s), may not appear "
154 "as the first character in a variable name."),
160 for (i = 0; i < length; i++)
162 if (!lex_is_idn (name[i]))
165 msg (SE, _("Character `%c' (in %s) may not appear in "
176 Returns true if NAME is an plausible name for a variable,
177 false otherwise. If ISSUE_ERROR is true, issues an
178 explanatory error message on failure.
179 This function makes no use of LC_CTYPE.
182 var_is_plausible_name (const char *name, bool issue_error)
186 assert (name != NULL);
188 /* Note that strlen returns number of BYTES, not the number of
190 length = strlen (name);
194 msg (SE, _("Variable name cannot be empty string."));
197 else if (length > LONG_NAME_LEN)
200 msg (SE, _("Variable name %s exceeds %d-character limit."),
201 name, (int) LONG_NAME_LEN);
205 if (lex_id_to_token (name, strlen (name)) != T_ID)
208 msg (SE, _("`%s' may not be used as a variable name because it "
209 "is a reserved word."), name);
216 /* A hsh_compare_func that orders variables A and B by their
219 compare_var_names (const void *a_, const void *b_, void *foo UNUSED)
221 const struct variable *a = a_;
222 const struct variable *b = b_;
224 return strcasecmp (a->name, b->name);
227 /* A hsh_hash_func that hashes variable V based on its name. */
229 hash_var_name (const void *v_, void *foo UNUSED)
231 const struct variable *v = v_;
233 return hsh_hash_case_string (v->name);
236 /* A hsh_compare_func that orders pointers to variables A and B
239 compare_var_ptr_names (const void *a_, const void *b_, void *foo UNUSED)
241 struct variable *const *a = a_;
242 struct variable *const *b = b_;
244 return strcasecmp ((*a)->name, (*b)->name);
247 /* A hsh_hash_func that hashes pointer to variable V based on its
250 hash_var_ptr_name (const void *v_, void *foo UNUSED)
252 struct variable *const *v = v_;
254 return hsh_hash_case_string ((*v)->name);
257 /* Sets V's short_name to SHORT_NAME, truncating it to
258 SHORT_NAME_LEN characters and converting it to uppercase in
261 var_set_short_name (struct variable *v, const char *short_name)
264 assert (short_name[0] == '\0' || var_is_plausible_name (short_name, false));
266 str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
267 str_uppercase (v->short_name);
270 /* Clears V's short name. */
272 var_clear_short_name (struct variable *v)
276 v->short_name[0] = '\0';
279 /* Sets V's short name to BASE, followed by a suffix of the form
280 _A, _B, _C, ..., _AA, _AB, etc. according to the value of
281 SUFFIX. Truncates BASE as necessary to fit. */
283 var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
285 char string[SHORT_NAME_LEN + 1];
290 assert (suffix >= 0);
291 assert (strlen (v->short_name) > 0);
294 var_set_short_name (v, base);
296 /* Compose suffix_string. */
297 start = end = string + sizeof string - 1;
301 *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
302 if (start <= string + 1)
303 msg (SE, _("Variable suffix too large."));
309 /* Append suffix_string to V's short name. */
311 if (len + strlen (v->short_name) > SHORT_NAME_LEN)
312 ofs = SHORT_NAME_LEN - len;
314 ofs = strlen (v->short_name);
315 strcpy (v->short_name + ofs, start);
319 /* Returns the dictionary class corresponding to a variable named
322 dict_class_from_id (const char *name)
324 assert (name != NULL);
337 /* Returns the name of dictionary class DICT_CLASS. */
339 dict_class_to_name (enum dict_class dict_class)
344 return _("ordinary");
354 /* Return the number of bytes used when writing case_data for a variable
357 width_to_bytes(int width)
362 return MAX_SHORT_STRING ;
363 else if (width <= MAX_LONG_STRING)
364 return ROUND_UP (width, MAX_SHORT_STRING);
367 int chunks = width / EFFECTIVE_LONG_STRING_LENGTH ;
368 int remainder = width % EFFECTIVE_LONG_STRING_LENGTH ;
369 int bytes = remainder + (chunks * (MAX_LONG_STRING + 1) );
370 return ROUND_UP (bytes, MAX_SHORT_STRING);