pintos-os.org Git - pspp/blob - src/language/lexer/variable-parser.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2007, 2010 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_n (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 = 1 << 0,         /* Restrict to a single name or TO use. */
  45     PV_DUPLICATE = 1 << 1,      /* Don't merge duplicates. */
  46     PV_APPEND = 1 << 2,         /* Append to existing list. */
  47     PV_NO_DUPLICATE = 1 << 3,   /* Error on duplicates. */
  48     PV_NUMERIC = 1 << 4,        /* Vars must be numeric. */
  49     PV_STRING = 1 << 5,         /* Vars must be string. */
  50     PV_SAME_TYPE = 1 << 6,      /* All vars must be the same type. */
  51     PV_SAME_WIDTH = 1 << 7,     /* All vars must be the same type and width. */
  52     PV_NO_SCRATCH = 1 << 8,     /* 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
  63 char *parse_DATA_LIST_var (struct lexer *, const struct dictionary *);
  64 bool parse_DATA_LIST_vars (struct lexer *, const struct dictionary *,
  65                            char ***names, size_t *n, int opts);
  66 bool parse_DATA_LIST_vars_pool (struct lexer *, const struct dictionary *,
  67                                 struct pool *,
  68                                 char ***names, size_t *n, int opts);
  69 bool parse_mixed_vars (struct lexer *, const struct dictionary *dict,
  70                        char ***names, size_t *n, int opts);
  71 bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict,
  72                             struct pool *,
  73                            char ***names, size_t *n, int opts);
  74 \f
  75 /* This variable parser supports the unusual situation where set of variables
  76    has to be parsed before the associated dictionary is available.  Thus,
  77    parsing proceeds in two phases: first, the variables are parsed in a vector
  78    of "struct var_syntax"; second, when the dictionary becomes available, the
  79    structs are turned into "struct variable"s. */
  80
  81 struct var_syntax
  82   {
  83     char *first;                /* Always nonnull. */
  84     char *last;                 /* Nonnull for var ranges (e.g. "a TO b"). */
  85
  86     /* For error reporting.
  87
  88       This only works if var_syntax_parse() and var_syntax_evaluate() are
  89       called while we're parsing the same source file.  That matches the
  90       current use case in MATRIX; if that changes, then this will need to
  91       switch to use struct msg_location instead. */
  92     int first_ofs;
  93     int last_ofs;
  94   };
  95 void var_syntax_destroy (struct var_syntax *, size_t n);
  96
  97 bool var_syntax_parse (struct lexer *, struct var_syntax **, size_t *);
  98 bool var_syntax_evaluate (struct lexer *, const struct var_syntax *, size_t,
  99                           const struct dictionary *,
 100                           struct variable ***, size_t *, int opts);
 101
 102 /* Const wrappers */
 103
 104 static inline const struct variable *
 105 parse_variable_const (struct lexer *l, const struct dictionary *d)
 106 {
 107   return parse_variable (l, d);
 108 }
 109
 110 static inline bool
 111 parse_variables_const (struct lexer *l, const struct dictionary *d,
 112                        const struct variable ***v, size_t *s,
 113                        int opts)
 114 {
 115   return parse_variables (l, d, (struct variable ***) v, s, opts);
 116 }
 117
 118 static inline bool
 119 parse_variables_const_pool (struct lexer *l, struct pool *p,
 120                             const struct dictionary *d,
 121                             const struct variable ***v, size_t *s, int opts)
 122 {
 123   return parse_variables_pool (l, p, d, (struct variable ***) v, s, opts);
 124 }
 125
 126
 127
 128 static inline struct const_var_set *
 129 const_var_set_create_from_dict (const struct dictionary *d)
 130 {
 131   return (struct const_var_set *) var_set_create_from_dict (d);
 132 }
 133
 134 static inline struct const_var_set *
 135 const_var_set_create_from_array (const struct variable *const *var,
 136                                  size_t s)
 137 {
 138   return (struct const_var_set *) var_set_create_from_array ((struct variable *const *) var, s);
 139 }
 140
 141
 142 static inline bool
 143 parse_const_var_set_vars (struct lexer *l, const struct const_var_set *vs,
 144                           const struct variable ***v, size_t *s, int opts)
 145 {
 146   return parse_var_set_vars (l, (const struct var_set *) vs,
 147                              (struct variable ***) v, s, opts);
 148 }
 149
 150 static inline void
 151 const_var_set_destroy (struct const_var_set *vs)
 152 {
 153   var_set_destroy ((struct var_set *) vs);
 154 }
 155
 156 /* Match a variable.
 157    If the match succeeds, the variable will be placed in VAR.
 158    Returns true if successful */
 159 bool
 160 lex_match_variable (struct lexer *lexer, const struct dictionary *dict, const struct variable **var);
 161
 162 struct interaction;
 163
 164 /* Parse an interaction.
 165    If not successful return false.
 166    Otherwise, a newly created interaction will be placed in IACT.
 167    It is the caller's responsibility to destroy this interaction.
 168  */
 169 bool
 170 parse_design_interaction (struct lexer *lexer, const struct dictionary *dict, struct interaction **iact);
 171
 172
 173
 174 #endif /* variable-parser.h */