Removed extra free
[pspp-builds.git] / src / vars-atr.c
index 0b6877dbf72c1012d6c2d7ffa44a5e3d654689ef..970ce5673f45c0154ae08640b28bcb92171cc99b 100644 (file)
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA. */
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA. */
 
 #include <config.h>
 #include "var.h"
 #include "error.h"
 #include <stdlib.h>
 #include "alloc.h"
-#include "command.h"
-#include "do-ifP.h"
-#include "expr.h"
-#include "file-handle.h"
+#include "dictionary.h"
 #include "hash.h"
+#include "lex-def.h"
 #include "misc.h"
 #include "str.h"
 #include "value-labels.h"
-#include "vfm.h"
 
-#include "debug-print.h"
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
+
+/* Returns an adjective describing the given variable TYPE,
+   suitable for use in phrases like "numeric variable". */
+const char *
+var_type_adj (enum var_type type) 
+{
+  return type == NUMERIC ? _("numeric") : _("string");
+}
+
+/* Returns a noun describing a value of the given variable TYPE,
+   suitable for use in phrases like "a number". */
+const char *
+var_type_noun (enum var_type type) 
+{
+  return type == NUMERIC ? _("number") : _("string");
+}
+
+/* Assign auxiliary data AUX to variable V, which must not
+   already have auxiliary data.  Before V's auxiliary data is
+   cleared, AUX_DTOR(V) will be called. */
+void *
+var_attach_aux (struct variable *v,
+                void *aux, void (*aux_dtor) (struct variable *)) 
+{
+  assert (v->aux == NULL);
+  assert (aux != NULL);
+  v->aux = aux;
+  v->aux_dtor = aux_dtor;
+  return aux;
+}
+
+/* Remove auxiliary data, if any, from V, and returns it, without
+   calling any associated destructor. */
+void *
+var_detach_aux (struct variable *v) 
+{
+  void *aux = v->aux;
+  assert (aux != NULL);
+  v->aux = NULL;
+  return aux;
+}
+
+/* Clears auxiliary data, if any, from V, and calls any
+   associated destructor. */
+void
+var_clear_aux (struct variable *v) 
+{
+  assert (v != NULL);
+  if (v->aux != NULL) 
+    {
+      if (v->aux_dtor != NULL)
+        v->aux_dtor (v);
+      v->aux = NULL;
+    }
+}
+
+/* This function is appropriate for use an auxiliary data
+   destructor (passed as AUX_DTOR to var_attach_aux()) for the
+   case where the auxiliary data should be passed to free(). */
+void
+var_dtor_free (struct variable *v) 
+{
+  free (v->aux);
+}
 
 /* Compares A and B, which both have the given WIDTH, and returns
    a strcmp()-type result. */
@@ -42,7 +104,7 @@ compare_values (const union value *a, const union value *b, int width)
   if (width == 0) 
     return a->f < b->f ? -1 : a->f > b->f;
   else
-    return memcmp (a->s, b->s, width);
+    return memcmp (a->s, b->s, min(MAX_SHORT_STRING, width));
 }
 
 /* Create a hash of v */
@@ -54,159 +116,204 @@ hash_value(const union value  *v, int width)
   if ( 0 == width ) 
     id_hash = hsh_hash_double (v->f);
   else
-    id_hash = hsh_hash_bytes (v->s, width);
+    id_hash = hsh_hash_bytes (v->s, min(MAX_SHORT_STRING, width));
 
   return id_hash;
 }
 
 
 
-/* Discards all the current state in preparation for a data-input
-   command like DATA LIST or GET. */
-void
-discard_variables (void)
+\f
+/* Returns true if NAME is an acceptable name for a variable,
+   false otherwise.  If ISSUE_ERROR is true, issues an
+   explanatory error message on failure. */
+bool
+var_is_valid_name (const char *name, bool issue_error) 
 {
-  dict_clear (default_dict);
-  default_handle = inline_file;
-
-  n_lag = 0;
+  size_t length, i;
   
-  if (vfm_source != NULL)
+  assert (name != NULL);
+
+  length = strlen (name);
+  if (length < 1) 
+    {
+      if (issue_error)
+        msg (SE, _("Variable name cannot be empty string."));
+      return false;
+    }
+  else if (length > LONG_NAME_LEN) 
     {
-      free_case_source (vfm_source);
-      vfm_source = NULL;
+      if (issue_error)
+        msg (SE, _("Variable name %s exceeds %d-character limit."),
+             name, (int) LONG_NAME_LEN);
+      return false;
     }
 
-  cancel_transformations ();
+  for (i = 0; i < length; i++)
+    if (!CHAR_IS_IDN (name[i])) 
+      {
+        if (issue_error)
+          msg (SE, _("Character `%c' (in %s) may not appear in "
+                     "a variable name."),
+               name[i], name);
+        return false;
+      }
+        
+  if (!CHAR_IS_ID1 (name[0]))
+    {
+      if (issue_error)
+        msg (SE, _("Character `%c' (in %s), may not appear "
+                   "as the first character in a variable name."),
+             name[0], name);
+      return false;
+    }
 
-  ctl_stack = NULL;
+  if (lex_id_to_token (name, strlen (name)) != T_ID) 
+    {
+      if (issue_error)
+        msg (SE, _("`%s' may not be used as a variable name because it "
+                   "is a reserved word."), name);
+      return false;
+    }
 
-  expr_free (process_if_expr);
-  process_if_expr = NULL;
+  return true;
+}
 
-  cancel_temporary ();
+/* A hsh_compare_func that orders variables A and B by their
+   names. */
+int
+compare_var_names (const void *a_, const void *b_, void *foo UNUSED) 
+{
+  const struct variable *a = a_;
+  const struct variable *b = b_;
 
-  pgm_state = STATE_INIT;
+  return strcasecmp (a->name, b->name);
 }
 
-/* Return nonzero only if X is a user-missing value for numeric
-   variable V. */
-inline int
-is_num_user_missing (double x, const struct variable *v)
+/* A hsh_hash_func that hashes variable V based on its name. */
+unsigned
+hash_var_name (const void *v_, void *foo UNUSED) 
 {
-  switch (v->miss_type)
-    {
-    case MISSING_NONE:
-      return 0;
-    case MISSING_1:
-      return x == v->missing[0].f;
-    case MISSING_2:
-      return x == v->missing[0].f || x == v->missing[1].f;
-    case MISSING_3:
-      return (x == v->missing[0].f || x == v->missing[1].f
-              || x == v->missing[2].f);
-    case MISSING_RANGE:
-      return x >= v->missing[0].f && x <= v->missing[1].f;
-    case MISSING_LOW:
-      return x <= v->missing[0].f;
-    case MISSING_HIGH:
-      return x >= v->missing[0].f;
-    case MISSING_RANGE_1:
-      return ((x >= v->missing[0].f && x <= v->missing[1].f)
-             || x == v->missing[2].f);
-    case MISSING_LOW_1:
-      return x <= v->missing[0].f || x == v->missing[1].f;
-    case MISSING_HIGH_1:
-      return x >= v->missing[0].f || x == v->missing[1].f;
-    default:
-      assert (0);
-    }
-  abort ();
+  const struct variable *v = v_;
+
+  return hsh_hash_case_string (v->name);
+}
+
+/* A hsh_compare_func that orders pointers to variables A and B
+   by their names. */
+int
+compare_var_ptr_names (const void *a_, const void *b_, void *foo UNUSED) 
+{
+  struct variable *const *a = a_;
+  struct variable *const *b = b_;
+
+  return strcasecmp ((*a)->name, (*b)->name);
 }
 
-/* Return nonzero only if string S is a user-missing variable for
-   string variable V. */
-inline int
-is_str_user_missing (const unsigned char s[], const struct variable *v)
+/* A hsh_hash_func that hashes pointer to variable V based on its
+   name. */
+unsigned
+hash_var_ptr_name (const void *v_, void *foo UNUSED) 
 {
-  switch (v->miss_type)
-    {
-    case MISSING_NONE:
-      return 0;
-    case MISSING_1:
-      return !strncmp (s, v->missing[0].s, v->width);
-    case MISSING_2:
-      return (!strncmp (s, v->missing[0].s, v->width)
-             || !strncmp (s, v->missing[1].s, v->width));
-    case MISSING_3:
-      return (!strncmp (s, v->missing[0].s, v->width)
-             || !strncmp (s, v->missing[1].s, v->width)
-             || !strncmp (s, v->missing[2].s, v->width));
-    default:
-      assert (0);
-    }
-  abort ();
+  struct variable *const *v = v_;
+
+  return hsh_hash_case_string ((*v)->name);
+}
+\f
+/* Sets V's short_name to SHORT_NAME, truncating it to
+   SHORT_NAME_LEN characters and converting it to uppercase in
+   the process. */
+void
+var_set_short_name (struct variable *v, const char *short_name) 
+{
+  assert (v != NULL);
+  assert (short_name[0] == '\0' || var_is_valid_name (short_name, false));
+  
+  str_copy_trunc (v->short_name, sizeof v->short_name, short_name);
+  str_uppercase (v->short_name);
 }
 
-/* Return nonzero only if value VAL is system-missing for variable
-   V. */
-int
-is_system_missing (const union value *val, const struct variable *v)
+/* Clears V's short name. */
+void
+var_clear_short_name (struct variable *v) 
 {
-  return v->type == NUMERIC && val->f == SYSMIS;
+  assert (v != NULL);
+
+  v->short_name[0] = '\0';
 }
 
-/* Return nonzero only if value VAL is system- or user-missing for
-   variable V. */
-int
-is_missing (const union value *val, const struct variable *v)
+/* Sets V's short name to BASE, followed by a suffix of the form
+   _A, _B, _C, ..., _AA, _AB, etc. according to the value of
+   SUFFIX.  Truncates BASE as necessary to fit. */
+void
+var_set_short_name_suffix (struct variable *v, const char *base, int suffix)
 {
-  switch (v->type)
+  char string[SHORT_NAME_LEN + 1];
+  char *start, *end;
+  int len, ofs;
+
+  assert (v != NULL);
+  assert (suffix >= 0);
+  assert (strlen (v->short_name) > 0);
+
+  /* Set base name. */
+  var_set_short_name (v, base);
+
+  /* Compose suffix_string. */
+  start = end = string + sizeof string - 1;
+  *end = '\0';
+  do 
     {
-    case NUMERIC:
-      if (val->f == SYSMIS)
-       return 1;
-      return is_num_user_missing (val->f, v);
-    case ALPHA:
-      return is_str_user_missing (val->s, v);
-    default:
-      assert (0);
+      *--start = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"[suffix % 26];
+      if (start <= string + 1)
+        msg (SE, _("Variable suffix too large."));
+      suffix /= 26;
     }
-  abort ();
+  while (suffix > 0);
+  *--start = '_';
+
+  /* Append suffix_string to V's short name. */
+  len = end - start;
+  if (len + strlen (v->short_name) > SHORT_NAME_LEN)
+    ofs = SHORT_NAME_LEN - len;
+  else
+    ofs = strlen (v->short_name);
+  strcpy (v->short_name + ofs, start);
 }
 
-/* Return nonzero only if value VAL is user-missing for variable V. */
-int
-is_user_missing (const union value *val, const struct variable *v)
+
+/* Returns the dictionary class corresponding to a variable named
+   NAME. */
+enum dict_class
+dict_class_from_id (const char *name) 
 {
-  switch (v->type)
+  assert (name != NULL);
+
+  switch (name[0]) 
     {
-    case NUMERIC:
-      return is_num_user_missing (val->f, v);
-    case ALPHA:
-      return is_str_user_missing (val->s, v);
     default:
-      assert (0);
+      return DC_ORDINARY;
+    case '$':
+      return DC_SYSTEM;
+    case '#':
+      return DC_SCRATCH;
     }
-  abort ();
-}
-\f
-/* A hsh_compare_func that orders variables A and B by their
-   names. */
-int
-compare_variables (const void *a_, const void *b_, void *foo UNUSED) 
-{
-  const struct variable *a = a_;
-  const struct variable *b = b_;
-
-  return strcmp (a->name, b->name);
 }
 
-/* A hsh_hash_func that hashes variable V based on its name. */
-unsigned
-hash_variable (const void *v_, void *foo UNUSED
+/* Returns the name of dictionary class DICT_CLASS. */
+const char *
+dict_class_to_name (enum dict_class dict_class
 {
-  const struct variable *v = v_;
-
-  return hsh_hash_string (v->name);
+  switch (dict_class) 
+    {
+    case DC_ORDINARY:
+      return _("ordinary");
+    case DC_SYSTEM:
+      return _("system");
+    case DC_SCRATCH:
+      return _("scratch");
+    default:
+      assert (0);
+      abort ();
+    }
 }