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"
37 #define _(msgid) gettext (msgid)
39 /* Returns an adjective describing the given variable TYPE,
40 suitable for use in phrases like "numeric variable". */
42 var_type_adj (enum var_type type)
44 return type == NUMERIC ? _("numeric") : _("string");
47 /* Returns a noun describing a value of the given variable TYPE,
48 suitable for use in phrases like "a number". */
50 var_type_noun (enum var_type type)
52 return type == NUMERIC ? _("number") : _("string");
55 /* Assign auxiliary data AUX to variable V, which must not
56 already have auxiliary data. Before V's auxiliary data is
57 cleared, AUX_DTOR(V) will be called. */
59 var_attach_aux (struct variable *v,
60 void *aux, void (*aux_dtor) (struct variable *))
62 assert (v->aux == NULL);
65 v->aux_dtor = aux_dtor;
69 /* Remove auxiliary data, if any, from V, and returns it, without
70 calling any associated destructor. */
72 var_detach_aux (struct variable *v)
80 /* Clears auxiliary data, if any, from V, and calls any
81 associated destructor. */
83 var_clear_aux (struct variable *v)
88 if (v->aux_dtor != NULL)
94 /* This function is appropriate for use an auxiliary data
95 destructor (passed as AUX_DTOR to var_attach_aux()) for the
96 case where the auxiliary data should be passed to free(). */
98 var_dtor_free (struct variable *v)
103 /* Compares A and B, which both have the given WIDTH, and returns
104 a strcmp()-type result. */
106 compare_values (const union value *a, const union value *b, int width)
109 return a->f < b->f ? -1 : a->f > b->f;
111 return memcmp (a->s, b->s, MIN(MAX_SHORT_STRING, width));
114 /* Create a hash of v */
116 hash_value(const union value *v, int width)
121 id_hash = hsh_hash_double (v->f);
123 id_hash = hsh_hash_bytes (v->s, MIN(MAX_SHORT_STRING, width));
131 /* Returns true if NAME is an acceptable name for a variable,
132 false otherwise. If ISSUE_ERROR is true, issues an
133 explanatory error message on failure. */
135 var_is_valid_name (const char *name, bool issue_error)
140 assert (name != NULL);
142 /* Note that strlen returns number of BYTES, not the number of
144 length = strlen (name);
146 plausible = var_is_plausible_name(name, issue_error);
152 if (!lex_is_id1 (name[0]))
155 msg (SE, _("Character `%c' (in %s), may not appear "
156 "as the first character in a variable name."),
162 for (i = 0; i < length; i++)
164 if (!lex_is_idn (name[i]))
167 msg (SE, _("Character `%c' (in %s) may not appear in "
178 Returns true if NAME is an plausible name for a variable,
179 false otherwise. If ISSUE_ERROR is true, issues an
180 explanatory error message on failure.
181 This function makes no use of LC_CTYPE.
184 var_is_plausible_name (const char *name, bool issue_error)
188 assert (name != NULL);
190 /* Note that strlen returns number of BYTES, not the number of
192 length = strlen (name);
196 msg (SE, _("Variable name cannot be empty string."));
199 else if (length > LONG_NAME_LEN)
202 msg (SE, _("Variable name %s exceeds %d-character limit."),
203 name, (int) LONG_NAME_LEN);
207 if (lex_id_to_token (name, strlen (name)) != T_ID)
210 msg (SE, _("`%s' may not be used as a variable name because it "
211 "is a reserved word."), name);
218 /* A hsh_compare_func that orders variables A and B by their
221 compare_var_names (const void *a_, const void *b_, const void *aux UNUSED)
223 const struct variable *a = a_;
224 const struct variable *b = b_;
226 return strcasecmp (a->name, b->name);
229 /* A hsh_hash_func that hashes variable V based on its name. */
231 hash_var_name (const void *v_, const void *aux UNUSED)
233 const struct variable *v = v_;
235 return hsh_hash_case_string (v->name);
238 /* A hsh_compare_func that orders pointers to variables A and B
241 compare_var_ptr_names (const void *a_, const void *b_, const void *aux UNUSED)
243 struct variable *const *a = a_;
244 struct variable *const *b = b_;
246 return strcasecmp ((*a)->name, (*b)->name);
249 /* A hsh_hash_func that hashes pointer to variable V based on its
252 hash_var_ptr_name (const void *v_, const void *aux UNUSED)
254 struct variable *const *v = v_;
256 return hsh_hash_case_string ((*v)->name);
259 /* Sets V's short_name to SHORT_NAME, truncating it to
260 SHORT_NAME_LEN characters and converting it to uppercase in
263 var_set_short_name (struct variable *v, const char *short_name)
266 assert (short_name[0] == '\0' || var_is_plausible_name (short_name, false));
268 str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
269 str_uppercase (v->short_name);
272 /* Clears V's short name. */
274 var_clear_short_name (struct variable *v)
278 v->short_name[0] = '\0';
281 /* Sets V's short name to BASE, followed by a suffix of the form
282 _A, _B, _C, ..., _AA, _AB, etc. according to the value of
283 SUFFIX. Truncates BASE as necessary to fit. */
285 var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
287 char string[SHORT_NAME_LEN + 1];
292 assert (suffix >= 0);
293 assert (strlen (v->short_name) > 0);
296 var_set_short_name (v, base);
298 /* Compose suffix_string. */
299 start = end = string + sizeof string - 1;
303 *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
304 if (start <= string + 1)
305 msg (SE, _("Variable suffix too large."));
311 /* Append suffix_string to V's short name. */
313 if (len + strlen (v->short_name) > SHORT_NAME_LEN)
314 ofs = SHORT_NAME_LEN - len;
316 ofs = strlen (v->short_name);
317 strcpy (v->short_name + ofs, start);
321 /* Returns the dictionary class corresponding to a variable named
324 dict_class_from_id (const char *name)
326 assert (name != NULL);
339 /* Returns the name of dictionary class DICT_CLASS. */
341 dict_class_to_name (enum dict_class dict_class)
346 return _("ordinary");
356 /* Return the number of bytes used when writing case_data for a variable
359 width_to_bytes(int width)
364 return MAX_SHORT_STRING ;
365 else if (width <= MAX_LONG_STRING)
366 return ROUND_UP (width, MAX_SHORT_STRING);
369 int chunks = width / EFFECTIVE_LONG_STRING_LENGTH ;
370 int remainder = width % EFFECTIVE_LONG_STRING_LENGTH ;
371 int bytes = remainder + (chunks * (MAX_LONG_STRING + 1) );
372 return ROUND_UP (bytes, MAX_SHORT_STRING);