src/data/variable.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   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.
   9
  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.
  14
  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
  18    02110-1301, USA. */
  19
  20 #include <config.h>
  21 #include "variable.h"
  22 #include "message.h"
  23 #include <stdlib.h>
  24 #include "alloc.h"
  25 #include "compiler.h"
  26 #include "dictionary.h"
  27 #include "hash.h"
  28 #include "identifier.h"
  29 #include "misc.h"
  30 #include "str.h"
  31 #include "value-labels.h"
  32
  33 #include "gettext.h"
  34 #define _(msgid) gettext (msgid)
  35
  36 /* Returns an adjective describing the given variable TYPE,
  37    suitable for use in phrases like "numeric variable". */
  38 const char *
  39 var_type_adj (enum var_type type)
  40 {
  41   return type == NUMERIC ? _("numeric") : _("string");
  42 }
  43
  44 /* Returns a noun describing a value of the given variable TYPE,
  45    suitable for use in phrases like "a number". */
  46 const char *
  47 var_type_noun (enum var_type type)
  48 {
  49   return type == NUMERIC ? _("number") : _("string");
  50 }
  51
  52 /* Assign auxiliary data AUX to variable V, which must not
  53    already have auxiliary data.  Before V's auxiliary data is
  54    cleared, AUX_DTOR(V) will be called. */
  55 void *
  56 var_attach_aux (struct variable *v,
  57                 void *aux, void (*aux_dtor) (struct variable *))
  58 {
  59   assert (v->aux == NULL);
  60   assert (aux != NULL);
  61   v->aux = aux;
  62   v->aux_dtor = aux_dtor;
  63   return aux;
  64 }
  65
  66 /* Remove auxiliary data, if any, from V, and returns it, without
  67    calling any associated destructor. */
  68 void *
  69 var_detach_aux (struct variable *v)
  70 {
  71   void *aux = v->aux;
  72   assert (aux != NULL);
  73   v->aux = NULL;
  74   return aux;
  75 }
  76
  77 /* Clears auxiliary data, if any, from V, and calls any
  78    associated destructor. */
  79 void
  80 var_clear_aux (struct variable *v)
  81 {
  82   assert (v != NULL);
  83   if (v->aux != NULL)
  84     {
  85       if (v->aux_dtor != NULL)
  86         v->aux_dtor (v);
  87       v->aux = NULL;
  88     }
  89 }
  90
  91 /* This function is appropriate for use an auxiliary data
  92    destructor (passed as AUX_DTOR to var_attach_aux()) for the
  93    case where the auxiliary data should be passed to free(). */
  94 void
  95 var_dtor_free (struct variable *v)
  96 {
  97   free (v->aux);
  98 }
  99
 100 /* Compares A and B, which both have the given WIDTH, and returns
 101    a strcmp()-type result. */
 102 int
 103 compare_values (const union value *a, const union value *b, int width)
 104 {
 105   if (width == 0)
 106     return a->f < b->f ? -1 : a->f > b->f;
 107   else
 108     return memcmp (a->s, b->s, min(MAX_SHORT_STRING, width));
 109 }
 110
 111 /* Create a hash of v */
 112 unsigned
 113 hash_value(const union value  *v, int width)
 114 {
 115   unsigned id_hash;
 116
 117   if ( 0 == width )
 118     id_hash = hsh_hash_double (v->f);
 119   else
 120     id_hash = hsh_hash_bytes (v->s, min(MAX_SHORT_STRING, width));
 121
 122   return id_hash;
 123 }
 124
 125
 126
 127 \f
 128 /* Returns true if NAME is an acceptable name for a variable,
 129    false otherwise.  If ISSUE_ERROR is true, issues an
 130    explanatory error message on failure. */
 131 bool
 132 var_is_valid_name (const char *name, bool issue_error)
 133 {
 134   size_t length, i;
 135
 136   assert (name != NULL);
 137
 138   length = strlen (name);
 139   if (length < 1)
 140     {
 141       if (issue_error)
 142         msg (SE, _("Variable name cannot be empty string."));
 143       return false;
 144     }
 145   else if (length > LONG_NAME_LEN)
 146     {
 147       if (issue_error)
 148         msg (SE, _("Variable name %s exceeds %d-character limit."),
 149              name, (int) LONG_NAME_LEN);
 150       return false;
 151     }
 152
 153   for (i = 0; i < length; i++)
 154     if (!lex_is_idn (name[i]))
 155       {
 156         if (issue_error)
 157           msg (SE, _("Character `%c' (in %s) may not appear in "
 158                      "a variable name."),
 159                name[i], name);
 160         return false;
 161       }
 162
 163   if (!lex_is_id1 (name[0]))
 164     {
 165       if (issue_error)
 166         msg (SE, _("Character `%c' (in %s), may not appear "
 167                    "as the first character in a variable name."),
 168              name[0], name);
 169       return false;
 170     }
 171
 172   if (lex_id_to_token (name, strlen (name)) != T_ID)
 173     {
 174       if (issue_error)
 175         msg (SE, _("`%s' may not be used as a variable name because it "
 176                    "is a reserved word."), name);
 177       return false;
 178     }
 179
 180   return true;
 181 }
 182
 183 /* A hsh_compare_func that orders variables A and B by their
 184    names. */
 185 int
 186 compare_var_names (const void *a_, const void *b_, void *foo UNUSED)
 187 {
 188   const struct variable *a = a_;
 189   const struct variable *b = b_;
 190
 191   return strcasecmp (a->name, b->name);
 192 }
 193
 194 /* A hsh_hash_func that hashes variable V based on its name. */
 195 unsigned
 196 hash_var_name (const void *v_, void *foo UNUSED)
 197 {
 198   const struct variable *v = v_;
 199
 200   return hsh_hash_case_string (v->name);
 201 }
 202
 203 /* A hsh_compare_func that orders pointers to variables A and B
 204    by their names. */
 205 int
 206 compare_var_ptr_names (const void *a_, const void *b_, void *foo UNUSED)
 207 {
 208   struct variable *const *a = a_;
 209   struct variable *const *b = b_;
 210
 211   return strcasecmp ((*a)->name, (*b)->name);
 212 }
 213
 214 /* A hsh_hash_func that hashes pointer to variable V based on its
 215    name. */
 216 unsigned
 217 hash_var_ptr_name (const void *v_, void *foo UNUSED)
 218 {
 219   struct variable *const *v = v_;
 220
 221   return hsh_hash_case_string ((*v)->name);
 222 }
 223 \f
 224 /* Sets V's short_name to SHORT_NAME, truncating it to
 225    SHORT_NAME_LEN characters and converting it to uppercase in
 226    the process. */
 227 void
 228 var_set_short_name (struct variable *v, const char *short_name)
 229 {
 230   assert (v != NULL);
 231   assert (short_name[0] == '\0' || var_is_valid_name (short_name, false));
 232
 233   str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
 234   str_uppercase (v->short_name);
 235 }
 236
 237 /* Clears V's short name. */
 238 void
 239 var_clear_short_name (struct variable *v)
 240 {
 241   assert (v != NULL);
 242
 243   v->short_name[0] = '\0';
 244 }
 245
 246 /* Sets V's short name to BASE, followed by a suffix of the form
 247    _A, _B, _C, ..., _AA, _AB, etc. according to the value of
 248    SUFFIX.  Truncates BASE as necessary to fit. */
 249 void
 250 var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
 251 {
 252   char string[SHORT_NAME_LEN + 1];
 253   char *start, *end;
 254   int len, ofs;
 255
 256   assert (v != NULL);
 257   assert (suffix >= 0);
 258   assert (strlen (v->short_name) > 0);
 259
 260   /* Set base name. */
 261   var_set_short_name (v, base);
 262
 263   /* Compose suffix_string. */
 264   start = end = string + sizeof string - 1;
 265   *end = '\0';
 266   do
 267     {
 268       *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
 269       if (start <= string + 1)
 270         msg (SE, _("Variable suffix too large."));
 271       suffix /= 26;
 272     }
 273   while (suffix > 0);
 274   *--start = '_';
 275
 276   /* Append suffix_string to V's short name. */
 277   len = end - start;
 278   if (len + strlen (v->short_name) > SHORT_NAME_LEN)
 279     ofs = SHORT_NAME_LEN - len;
 280   else
 281     ofs = strlen (v->short_name);
 282   strcpy (v->short_name + ofs, start);
 283 }
 284
 285
 286 /* Returns the dictionary class corresponding to a variable named
 287    NAME. */
 288 enum dict_class
 289 dict_class_from_id (const char *name)
 290 {
 291   assert (name != NULL);
 292
 293   switch (name[0])
 294     {
 295     default:
 296       return DC_ORDINARY;
 297     case '$':
 298       return DC_SYSTEM;
 299     case '#':
 300       return DC_SCRATCH;
 301     }
 302 }
 303
 304 /* Returns the name of dictionary class DICT_CLASS. */
 305 const char *
 306 dict_class_to_name (enum dict_class dict_class)
 307 {
 308   switch (dict_class)
 309     {
 310     case DC_ORDINARY:
 311       return _("ordinary");
 312     case DC_SYSTEM:
 313       return _("system");
 314     case DC_SCRATCH:
 315       return _("scratch");
 316     default:
 317       assert (0);
 318       abort ();
 319     }
 320 }