src/language/lexer/variable-parser.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #ifndef VARIABLE_PARSER_H
  21 #define VARIABLE_PARSER_H 1
  22
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25
  26 struct pool;
  27 struct dictionary;
  28 struct 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 struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
  38 struct variable *var_set_lookup_var (const struct var_set *vs,
  39                                      const char *name);
  40 bool var_set_lookup_var_idx (const struct var_set *vs, const char *name,
  41                              size_t *idx);
  42 void var_set_destroy (struct var_set *vs);
  43 \f
  44 /* Variable parsers. */
  45
  46 enum
  47   {
  48     PV_NONE = 0,                /* No options. */
  49     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
  50     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
  51     PV_APPEND = 0004,           /* Append to existing list. */
  52     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
  53     PV_NUMERIC = 0020,          /* Vars must be numeric. */
  54     PV_STRING = 0040,           /* Vars must be string. */
  55     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
  56     PV_SAME_WIDTH = 00200,      /* All vars must be the same type and width. */
  57     PV_NO_SCRATCH = 00400       /* Disallow scratch variables. */
  58   };
  59
  60 struct variable *parse_variable (struct lexer *, const struct dictionary *);
  61 bool parse_variables (struct lexer *, const struct dictionary *, struct variable ***, size_t *,
  62                      int opts);
  63 bool parse_variables_pool (struct lexer *, struct pool *, const struct dictionary *,
  64                           struct variable ***, size_t *, int opts);
  65 bool parse_var_set_vars (struct lexer *, const struct var_set *, struct variable ***, size_t *,
  66                         int opts);
  67 bool parse_DATA_LIST_vars (struct lexer *, char ***names, size_t *cnt, int opts);
  68 bool parse_DATA_LIST_vars_pool (struct lexer *, struct pool *,
  69                                char ***names, size_t *cnt, int opts);
  70 bool parse_mixed_vars (struct lexer *, const struct dictionary *dict,
  71                        char ***names, size_t *cnt, int opts);
  72 bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict,
  73                             struct pool *,
  74                            char ***names, size_t *cnt, int opts);
  75
  76 #endif /* variable-parser.h */