Change license from GPLv2+ to GPLv3+.
[pspp] / src / language / lexer / variable-parser.c
index 44be48b9dd6459297ab1b904e20ea8f4f125ba89..f019b533a59d3f36e74aa0f43afd3d8968d3768e 100644 (file)
@@ -1,21 +1,18 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    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., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
 
@@ -30,6 +27,7 @@
 #include <data/procedure.h>
 #include <data/variable.h>
 #include <libpspp/alloc.h>
+#include <libpspp/assertion.h>
 #include <libpspp/bit-vector.h>
 #include <libpspp/hash.h>
 #include <libpspp/message.h>
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
+static struct variable * var_set_get_var (const struct var_set *, size_t );
+
+static struct variable *var_set_lookup_var (const struct var_set *,
+                                           const char *);
+
+static bool var_set_lookup_var_idx (const struct var_set *, const char *,
+                                   size_t *);
+
+
+
 /* Parses a name as a variable within VS.  Sets *IDX to the
    variable's index and returns true if successful.  On failure
    emits an error message and returns false. */
 static bool
-parse_vs_variable_idx (struct lexer *lexer, const struct var_set *vs, 
+parse_vs_variable_idx (struct lexer *lexer, const struct var_set *vs,
                size_t *idx)
 {
   assert (idx != NULL);
-  
+
   if (lex_token (lexer) != T_ID)
     {
       lex_error (lexer, _("expecting variable name"));
       return false;
     }
-  else if (var_set_lookup_var_idx (vs, lex_tokid (lexer), idx)) 
+  else if (var_set_lookup_var_idx (vs, lex_tokid (lexer), idx))
     {
       lex_get (lexer);
       return true;
     }
-  else 
+  else
     {
       msg (SE, _("%s is not a variable name."), lex_tokid (lexer));
       return false;
@@ -80,7 +88,7 @@ parse_vs_variable (struct lexer *lexer, const struct var_set *vs)
    variable if successful.  On failure emits an error message and
    returns a null pointer. */
 struct variable *
-parse_variable (struct lexer *lexer, const struct dictionary *d) 
+parse_variable (struct lexer *lexer, const struct dictionary *d)
 {
   struct var_set *vs = var_set_create_from_dict (d);
   struct variable *var = parse_vs_variable (lexer, vs);
@@ -93,9 +101,9 @@ parse_variable (struct lexer *lexer, const struct dictionary *d)
    number of variables into *CNT.  Returns true only if
    successful. */
 bool
-parse_variables (struct lexer *lexer, const struct dictionary *d, 
+parse_variables (struct lexer *lexer, const struct dictionary *d,
                        struct variable ***var,
-                       size_t *cnt, int opts) 
+                       size_t *cnt, int opts)
 {
   struct var_set *vs;
   int success;
@@ -106,8 +114,6 @@ parse_variables (struct lexer *lexer, const struct dictionary *d,
 
   vs = var_set_create_from_dict (d);
   success = parse_var_set_vars (lexer, vs, var, cnt, opts);
-  if ( success == 0 )
-     free ( *var ) ;
   var_set_destroy (vs);
   return success;
 }
@@ -118,9 +124,9 @@ parse_variables (struct lexer *lexer, const struct dictionary *d,
    successful.  Same behavior as parse_variables, except that all
    allocations are taken from the given POOL. */
 bool
-parse_variables_pool (struct lexer *lexer, struct pool *pool, 
+parse_variables_pool (struct lexer *lexer, struct pool *pool,
                const struct dictionary *dict,
-               struct variable ***vars, size_t *var_cnt, int opts) 
+               struct variable ***vars, size_t *var_cnt, int opts)
 {
   int retval;
 
@@ -129,7 +135,7 @@ parse_variables_pool (struct lexer *lexer, struct pool *pool,
      already in the pool, which would attempt to re-free it
      later. */
   assert (!(opts & PV_APPEND));
-  
+
   retval = parse_variables (lexer, dict, vars, var_cnt, opts);
   if (retval)
     pool_register (pool, free, *vars);
@@ -141,14 +147,14 @@ parse_variables_pool (struct lexer *lexer, struct pool *pool,
    dictionary class, and returns true.  Returns false on
    failure. */
 static bool
-parse_var_idx_class (struct lexer *lexer, const struct var_set *vs, 
+parse_var_idx_class (struct lexer *lexer, const struct var_set *vs,
                        size_t *idx,
                        enum dict_class *class)
 {
   if (!parse_vs_variable_idx (lexer, vs, idx))
     return false;
 
-  *class = dict_class_from_id (var_set_get_var (vs, *idx)->name);
+  *class = dict_class_from_id (var_get_name (var_set_get_var (vs, *idx)));
   return true;
 }
 
@@ -163,24 +169,32 @@ add_variable (struct variable ***v, size_t *nv, size_t *mv,
               const struct var_set *vs, size_t idx)
 {
   struct variable *add = var_set_get_var (vs, idx);
+  const char *add_name = var_get_name (add);
 
-  if ((pv_opts & PV_NUMERIC) && add->type != NUMERIC) 
+  if ((pv_opts & PV_NUMERIC) && !var_is_numeric (add))
     msg (SW, _("%s is not a numeric variable.  It will not be "
-               "included in the variable list."), add->name);
-  else if ((pv_opts & PV_STRING) && add->type != ALPHA) 
+               "included in the variable list."), add_name);
+  else if ((pv_opts & PV_STRING) && !var_is_alpha (add))
     msg (SE, _("%s is not a string variable.  It will not be "
-               "included in the variable list."), add->name);
+               "included in the variable list."), add_name);
   else if ((pv_opts & PV_NO_SCRATCH)
-           && dict_class_from_id (add->name) == DC_SCRATCH)
+           && dict_class_from_id (add_name) == DC_SCRATCH)
     msg (SE, _("Scratch variables (such as %s) are not allowed "
-               "here."), add->name);
-  else if ((pv_opts & PV_SAME_TYPE) && *nv && add->type != (*v)[0]->type) 
+               "here."), add_name);
+  else if ((pv_opts & (PV_SAME_TYPE | PV_SAME_WIDTH)) && *nv
+           && var_get_type (add) != var_get_type ((*v)[0]))
     msg (SE, _("%s and %s are not the same type.  All variables in "
                "this variable list must be of the same type.  %s "
-               "will be omitted from list."),
-         (*v)[0]->name, add->name, add->name);
-  else if ((pv_opts & PV_NO_DUPLICATE) && included[idx]) 
-    msg (SE, _("Variable %s appears twice in variable list."), add->name);
+               "will be omitted from the list."),
+         var_get_name ((*v)[0]), add_name, add_name);
+  else if ((pv_opts & PV_SAME_WIDTH) && *nv
+           && var_get_width (add) != var_get_width ((*v)[0]))
+    msg (SE, _("%s and %s are string variables with different widths.  "
+               "All variables in this variable list must have the "
+               "same width.  %s will be omttied from the list."),
+         var_get_name ((*v)[0]), add_name, add_name);
+  else if ((pv_opts & PV_NO_DUPLICATE) && included[idx])
+    msg (SE, _("Variable %s appears twice in variable list."), add_name);
   else if ((pv_opts & PV_DUPLICATE) || !included[idx])
     {
       if (*nv >= *mv)
@@ -203,12 +217,12 @@ static void
 add_variables (struct variable ***v, size_t *nv, size_t *mv, char *included,
                int pv_opts,
                const struct var_set *vs, int first_idx, int last_idx,
-               enum dict_class class) 
+               enum dict_class class)
 {
   size_t i;
-  
+
   for (i = first_idx; i <= last_idx; i++)
-    if (dict_class_from_id (var_set_get_var (vs, i)->name) == class)
+    if (dict_class_from_id (var_get_name (var_set_get_var (vs, i))) == class)
       add_variable (v, nv, mv, included, pv_opts, vs, i);
 }
 
@@ -216,7 +230,7 @@ add_variables (struct variable ***v, size_t *nv, size_t *mv, char *included,
    Conversely, if parse_variables() returns true, then *nv is
    nonzero and *v is non-NULL. */
 bool
-parse_var_set_vars (struct lexer *lexer, const struct var_set *vs, 
+parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
                     struct variable ***v, size_t *nv,
                     int pv_opts)
 {
@@ -227,11 +241,12 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
   assert (v != NULL);
   assert (nv != NULL);
 
-  /* At most one of PV_NUMERIC, PV_STRING, PV_SAME_TYPE may be
-     specified. */
-  assert ((((pv_opts & PV_NUMERIC) != 0)
-           + ((pv_opts & PV_STRING) != 0)
-           + ((pv_opts & PV_SAME_TYPE) != 0)) <= 1);
+  /* At most one of PV_NUMERIC, PV_STRING, PV_SAME_TYPE,
+     PV_SAME_WIDTH may be specified. */
+  assert (((pv_opts & PV_NUMERIC) != 0)
+          + ((pv_opts & PV_STRING) != 0)
+          + ((pv_opts & PV_SAME_TYPE) != 0)
+          + ((pv_opts & PV_SAME_WIDTH) != 0) <= 1);
 
   /* PV_DUPLICATE and PV_NO_DUPLICATE are incompatible. */
   assert (!(pv_opts & PV_DUPLICATE) || !(pv_opts & PV_NO_DUPLICATE));
@@ -248,10 +263,15 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
   if (!(pv_opts & PV_DUPLICATE))
     {
       size_t i;
-      
+
       included = xcalloc (var_set_get_cnt (vs), sizeof *included);
       for (i = 0; i < *nv; i++)
-        included[(*v)[i]->index] = 1;
+        {
+          size_t index;
+          if (!var_set_lookup_var_idx (vs, var_get_name ((*v)[i]), &index))
+            NOT_REACHED ();
+          included[index] = 1;
+        }
     }
   else
     included = NULL;
@@ -261,7 +281,7 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
       if (lex_match (lexer, T_ALL))
         add_variables (v, nv, &mv, included, pv_opts,
                        vs, 0, var_set_get_cnt (vs) - 1, DC_ORDINARY);
-      else 
+      else
         {
           enum dict_class class;
           size_t first_idx;
@@ -271,7 +291,7 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
 
           if (!lex_match (lexer, T_TO))
             add_variable (v, nv, &mv, included, pv_opts, vs, first_idx);
-          else 
+          else
             {
               size_t last_idx;
               enum dict_class last_class;
@@ -285,10 +305,11 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
 
               if (last_idx < first_idx)
                 {
+                  const char *first_name = var_get_name (first_var);
+                  const char *last_name = var_get_name (last_var);
                   msg (SE, _("%s TO %s is not valid syntax since %s "
                              "precedes %s in the dictionary."),
-                       first_var->name, last_var->name,
-                       first_var->name, last_var->name);
+                       first_name, last_name, first_name, last_name);
                   goto fail;
                 }
 
@@ -299,14 +320,15 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
                              "the same variable dictionaries, of either "
                              "ordinary, scratch, or system variables.  "
                              "%s is a %s variable, whereas %s is %s."),
-                       first_var->name, dict_class_to_name (class),
-                       last_var->name, dict_class_to_name (last_class));
+                       var_get_name (first_var), dict_class_to_name (class),
+                       var_get_name (last_var),
+                       dict_class_to_name (last_class));
                   goto fail;
                 }
 
               add_variables (v, nv, &mv, included, pv_opts,
                              vs, first_idx, last_idx, class);
-            } 
+            }
         }
 
       if (pv_opts & PV_SINGLE)
@@ -315,7 +337,7 @@ parse_var_set_vars (struct lexer *lexer, const struct var_set *vs,
     }
   while (lex_token (lexer) == T_ALL
          || (lex_token (lexer) == T_ID && var_set_lookup_var (vs, lex_tokid (lexer)) != NULL));
-  
+
   if (*nv == 0)
     goto fail;
 
@@ -516,7 +538,7 @@ parse_DATA_LIST_vars_pool (struct lexer *lexer, struct pool *pool,
      presumably already in the pool, which would attempt to
      re-free it later. */
   assert (!(pv_opts & PV_APPEND));
-  
+
   retval = parse_DATA_LIST_vars (lexer, names, nnames, pv_opts);
   if (retval)
     register_vars_pool (pool, *names, *nnames);
@@ -527,7 +549,7 @@ parse_DATA_LIST_vars_pool (struct lexer *lexer, struct pool *pool,
    existing and the rest are to be created.  Same args as
    parse_DATA_LIST_vars(). */
 bool
-parse_mixed_vars (struct lexer *lexer, const struct dictionary *dict, 
+parse_mixed_vars (struct lexer *lexer, const struct dictionary *dict,
                  char ***names, size_t *nnames, int pv_opts)
 {
   size_t i;
@@ -552,7 +574,7 @@ parse_mixed_vars (struct lexer *lexer, const struct dictionary *dict,
            goto fail;
          *names = xnrealloc (*names, *nnames + nv, sizeof **names);
          for (i = 0; i < nv; i++)
-           (*names)[*nnames + i] = xstrdup (v[i]->name);
+           (*names)[*nnames + i] = xstrdup (var_get_name (v[i]));
          free (v);
          *nnames += nv;
        }
@@ -593,7 +615,7 @@ parse_mixed_vars_pool (struct lexer *lexer, const struct dictionary *dict, struc
 }
 \f
 /* A set of variables. */
-struct var_set 
+struct var_set
   {
     size_t (*get_cnt) (const struct var_set *);
     struct variable *(*get_var) (const struct var_set *, size_t idx);
@@ -604,7 +626,7 @@ struct var_set
 
 /* Returns the number of variables in VS. */
 size_t
-var_set_get_cnt (const struct var_set *vs) 
+var_set_get_cnt (const struct var_set *vs)
 {
   assert (vs != NULL);
 
@@ -613,8 +635,8 @@ var_set_get_cnt (const struct var_set *vs)
 
 /* Return variable with index IDX in VS.
    IDX must be less than the number of variables in VS. */
-struct variable *
-var_set_get_var (const struct var_set *vs, size_t idx) 
+static struct variable *
+var_set_get_var (const struct var_set *vs, size_t idx)
 {
   assert (vs != NULL);
   assert (idx < var_set_get_cnt (vs));
@@ -625,7 +647,7 @@ var_set_get_var (const struct var_set *vs, size_t idx)
 /* Returns the variable in VS named NAME, or a null pointer if VS
    contains no variable with that name. */
 struct variable *
-var_set_lookup_var (const struct var_set *vs, const char *name) 
+var_set_lookup_var (const struct var_set *vs, const char *name)
 {
   size_t idx;
   return (var_set_lookup_var_idx (vs, name, &idx)
@@ -648,7 +670,7 @@ var_set_lookup_var_idx (const struct var_set *vs, const char *name,
 
 /* Destroys VS. */
 void
-var_set_destroy (struct var_set *vs) 
+var_set_destroy (struct var_set *vs)
 {
   if (vs != NULL)
     vs->destroy (vs);
@@ -656,7 +678,7 @@ var_set_destroy (struct var_set *vs)
 \f
 /* Returns the number of variables in VS. */
 static size_t
-dict_var_set_get_cnt (const struct var_set *vs) 
+dict_var_set_get_cnt (const struct var_set *vs)
 {
   struct dictionary *d = vs->aux;
 
@@ -666,7 +688,7 @@ dict_var_set_get_cnt (const struct var_set *vs)
 /* Return variable with index IDX in VS.
    IDX must be less than the number of variables in VS. */
 static struct variable *
-dict_var_set_get_var (const struct var_set *vs, size_t idx) 
+dict_var_set_get_var (const struct var_set *vs, size_t idx)
 {
   struct dictionary *d = vs->aux;
 
@@ -677,13 +699,13 @@ dict_var_set_get_var (const struct var_set *vs, size_t idx)
    and returns true.  Otherwise, returns false. */
 static bool
 dict_var_set_lookup_var_idx (const struct var_set *vs, const char *name,
-                             size_t *idx) 
+                             size_t *idx)
 {
   struct dictionary *d = vs->aux;
   struct variable *v = dict_lookup_var (d, name);
-  if (v != NULL) 
+  if (v != NULL)
     {
-      *idx = v->index;
+      *idx = var_get_dict_index (v);
       return true;
     }
   else
@@ -692,14 +714,14 @@ dict_var_set_lookup_var_idx (const struct var_set *vs, const char *name,
 
 /* Destroys VS. */
 static void
-dict_var_set_destroy (struct var_set *vs) 
+dict_var_set_destroy (struct var_set *vs)
 {
   free (vs);
 }
 
 /* Returns a variable set based on D. */
 struct var_set *
-var_set_create_from_dict (const struct dictionary *d) 
+var_set_create_from_dict (const struct dictionary *d)
 {
   struct var_set *vs = xmalloc (sizeof *vs);
   vs->get_cnt = dict_var_set_get_cnt;
@@ -711,7 +733,7 @@ var_set_create_from_dict (const struct dictionary *d)
 }
 \f
 /* A variable set based on an array. */
-struct array_var_set 
+struct array_var_set
   {
     struct variable *const *var;/* Array of variables. */
     size_t var_cnt;             /* Number of elements in var. */
@@ -720,7 +742,7 @@ struct array_var_set
 
 /* Returns the number of variables in VS. */
 static size_t
-array_var_set_get_cnt (const struct var_set *vs) 
+array_var_set_get_cnt (const struct var_set *vs)
 {
   struct array_var_set *avs = vs->aux;
 
@@ -730,7 +752,7 @@ array_var_set_get_cnt (const struct var_set *vs)
 /* Return variable with index IDX in VS.
    IDX must be less than the number of variables in VS. */
 static struct variable *
-array_var_set_get_var (const struct var_set *vs, size_t idx) 
+array_var_set_get_var (const struct var_set *vs, size_t idx)
 {
   struct array_var_set *avs = vs->aux;
 
@@ -741,15 +763,16 @@ array_var_set_get_var (const struct var_set *vs, size_t idx)
    and returns true.  Otherwise, returns false. */
 static bool
 array_var_set_lookup_var_idx (const struct var_set *vs, const char *name,
-                              size_t *idx) 
+                              size_t *idx)
 {
   struct array_var_set *avs = vs->aux;
-  struct variable v, *vp, *const *vpp;
+  struct variable *v, *const *vpp;
+
+  v = var_create (name, 0);
+  vpp = hsh_find (avs->name_tab, &v);
+  var_destroy (v);
 
-  strcpy (v.name, name);
-  vp = &v;
-  vpp = hsh_find (avs->name_tab, &vp);
-  if (vpp != NULL) 
+  if (vpp != NULL)
     {
       *idx = vpp - avs->var;
       return true;
@@ -760,7 +783,7 @@ array_var_set_lookup_var_idx (const struct var_set *vs, const char *name,
 
 /* Destroys VS. */
 static void
-array_var_set_destroy (struct var_set *vs) 
+array_var_set_destroy (struct var_set *vs)
 {
   struct array_var_set *avs = vs->aux;
 
@@ -772,7 +795,7 @@ array_var_set_destroy (struct var_set *vs)
 /* Returns a variable set based on the VAR_CNT variables in
    VAR. */
 struct var_set *
-var_set_create_from_array (struct variable *const *var, size_t var_cnt) 
+var_set_create_from_array (struct variable *const *var, size_t var_cnt)
 {
   struct var_set *vs;
   struct array_var_set *avs;
@@ -787,14 +810,15 @@ var_set_create_from_array (struct variable *const *var, size_t var_cnt)
   avs->var = var;
   avs->var_cnt = var_cnt;
   avs->name_tab = hsh_create (2 * var_cnt,
-                              compare_var_ptr_names, hash_var_ptr_name, NULL,
-                              NULL);
+                              compare_var_ptrs_by_name, hash_var_ptr_by_name,
+                              NULL, NULL);
   for (i = 0; i < var_cnt; i++)
-    if (hsh_insert (avs->name_tab, (void *) &var[i]) != NULL) 
+    if (hsh_insert (avs->name_tab, (void *) &var[i]) != NULL)
       {
         var_set_destroy (vs);
         return NULL;
       }
-  
+
   return vs;
 }
+