lexer/variable-parser.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #ifndef VARIABLE_PARSER_H
  18 #define VARIABLE_PARSER_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22
  23 struct pool;
  24 struct dictionary;
  25 struct var_set;
  26 struct const_var_set;
  27 struct variable;
  28 struct lexer ;
  29
  30 struct var_set *var_set_create_from_dict (const struct dictionary *d);
  31 struct var_set *var_set_create_from_array (struct variable *const *var,
  32                                            size_t);
  33
  34 size_t var_set_get_cnt (const struct var_set *vs);
  35
  36 void var_set_destroy (struct var_set *vs);
  37
  38 \f
  39 /* Variable parsers. */
  40
  41 enum
  42   {
  43     PV_NONE = 0,                /* No options. */
  44     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
  45     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
  46     PV_APPEND = 0004,           /* Append to existing list. */
  47     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
  48     PV_NUMERIC = 0020,          /* Vars must be numeric. */
  49     PV_STRING = 0040,           /* Vars must be string. */
  50     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
  51     PV_SAME_WIDTH = 00200,      /* All vars must be the same type and width. */
  52     PV_NO_SCRATCH = 00400       /* Disallow scratch variables. */
  53   };
  54
  55 struct variable *parse_variable (struct lexer *, const struct dictionary *);
  56 bool parse_variables (struct lexer *, const struct dictionary *, struct variable ***, size_t *,
  57                      int opts);
  58 bool parse_variables_pool (struct lexer *, struct pool *, const struct dictionary *,
  59                           struct variable ***, size_t *, int opts);
  60 bool parse_var_set_vars (struct lexer *, const struct var_set *, struct variable ***, size_t *,
  61                         int opts);
  62 bool parse_DATA_LIST_vars (struct lexer *, char ***names, size_t *cnt, int opts);
  63 bool parse_DATA_LIST_vars_pool (struct lexer *, struct pool *,
  64                                char ***names, size_t *cnt, int opts);
  65 bool parse_mixed_vars (struct lexer *, const struct dictionary *dict,
  66                        char ***names, size_t *cnt, int opts);
  67 bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict,
  68                             struct pool *,
  69                            char ***names, size_t *cnt, int opts);
  70
  71
  72 /* Const wrappers */
  73
  74 static inline const struct variable *
  75 parse_variable_const (struct lexer *l, const struct dictionary *d)
  76 {
  77   return parse_variable (l, d);
  78 }
  79
  80 static inline bool
  81 parse_variables_const (struct lexer *l, const struct dictionary *d,
  82                        const struct variable ***v, size_t *s,
  83                        int opts)
  84 {
  85   return parse_variables (l, d, (struct variable ***) v, s, opts);
  86 }
  87
  88 static inline bool
  89 parse_variables_const_pool (struct lexer *l, struct pool *p,
  90                             const struct dictionary *d,
  91                             const struct variable ***v, size_t *s, int opts)
  92 {
  93   return parse_variables_pool (l, p, d, (struct variable ***) v, s, opts);
  94 }
  95
  96
  97
  98 static inline struct const_var_set *
  99 const_var_set_create_from_dict (const struct dictionary *d)
 100 {
 101   return (struct const_var_set *) var_set_create_from_dict (d);
 102 }
 103
 104 static inline struct const_var_set *
 105 const_var_set_create_from_array (const struct variable *const *var,
 106                                  size_t s)
 107 {
 108   return (struct const_var_set *) var_set_create_from_array ((struct variable *const *) var, s);
 109 }
 110
 111
 112 static inline bool
 113 parse_const_var_set_vars (struct lexer *l, const struct const_var_set *vs,
 114                           const struct variable ***v, size_t *s, int opts)
 115 {
 116   return parse_var_set_vars (l, (const struct var_set *) vs,
 117                              (struct variable ***) v, s, opts);
 118 }
 119
 120 static inline void
 121 const_var_set_destroy (struct const_var_set *vs)
 122 {
 123   var_set_destroy ( (struct var_set *) vs);
 124 }
 125
 126
 127 #endif /* variable-parser.h */