src/language/lexer/variable-parser.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000, 2006 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 variable;
  29 struct lexer ;
  30
  31 struct var_set *var_set_create_from_dict (const struct dictionary *d);
  32 struct var_set *var_set_create_from_array (struct variable *const *var,
  33                                            size_t);
  34
  35 size_t var_set_get_cnt (const struct var_set *vs);
  36 struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
  37 struct variable *var_set_lookup_var (const struct var_set *vs,
  38                                      const char *name);
  39 bool var_set_lookup_var_idx (const struct var_set *vs, const char *name,
  40                              size_t *idx);
  41 void var_set_destroy (struct var_set *vs);
  42 \f
  43 /* Variable parsers. */
  44
  45 enum
  46   {
  47     PV_NONE = 0,                /* No options. */
  48     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
  49     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
  50     PV_APPEND = 0004,           /* Append to existing list. */
  51     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
  52     PV_NUMERIC = 0020,          /* Vars must be numeric. */
  53     PV_STRING = 0040,           /* Vars must be string. */
  54     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
  55     PV_SAME_WIDTH = 00200,      /* All vars must be the same type and width. */
  56     PV_NO_SCRATCH = 00400       /* Disallow scratch variables. */
  57   };
  58
  59 struct variable *parse_variable (struct lexer *, const struct dictionary *);
  60 bool parse_variables (struct lexer *, const struct dictionary *, struct variable ***, size_t *,
  61                      int opts);
  62 bool parse_variables_pool (struct lexer *, struct pool *, const struct dictionary *,
  63                           struct variable ***, size_t *, int opts);
  64 bool parse_var_set_vars (struct lexer *, const struct var_set *, struct variable ***, size_t *,
  65                         int opts);
  66 bool parse_DATA_LIST_vars (struct lexer *, char ***names, size_t *cnt, int opts);
  67 bool parse_DATA_LIST_vars_pool (struct lexer *, struct pool *,
  68                                char ***names, size_t *cnt, int opts);
  69 bool parse_mixed_vars (struct lexer *, const struct dictionary *dict,
  70                        char ***names, size_t *cnt, int opts);
  71 bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict,
  72                             struct pool *,
  73                            char ***names, size_t *cnt, int opts);
  74
  75 #endif /* variable-parser.h */