src/language/lexer/variable-parser.h

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