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_cnt (const struct var_set *vs);
35
36 void var_set_destroy (struct var_set *vs);
37
38
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
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 *cnt, int opts);
66 bool parse_DATA_LIST_vars_pool (struct lexer *, const struct dictionary *,
67 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
76 /* Const wrappers */
77
78 static inline const struct variable *
parse_variable_const(struct lexer * l,const struct dictionary * d)79 parse_variable_const (struct lexer *l, const struct dictionary *d)
80 {
81 return parse_variable (l, d);
82 }
83
84 static inline bool
parse_variables_const(struct lexer * l,const struct dictionary * d,const struct variable *** v,size_t * s,int opts)85 parse_variables_const (struct lexer *l, const struct dictionary *d,
86 const struct variable ***v, size_t *s,
87 int opts)
88 {
89 return parse_variables (l, d, (struct variable ***) v, s, opts);
90 }
91
92 static inline bool
parse_variables_const_pool(struct lexer * l,struct pool * p,const struct dictionary * d,const struct variable *** v,size_t * s,int opts)93 parse_variables_const_pool (struct lexer *l, struct pool *p,
94 const struct dictionary *d,
95 const struct variable ***v, size_t *s, int opts)
96 {
97 return parse_variables_pool (l, p, d, (struct variable ***) v, s, opts);
98 }
99
100
101
102 static inline struct const_var_set *
const_var_set_create_from_dict(const struct dictionary * d)103 const_var_set_create_from_dict (const struct dictionary *d)
104 {
105 return (struct const_var_set *) var_set_create_from_dict (d);
106 }
107
108 static inline struct const_var_set *
const_var_set_create_from_array(const struct variable * const * var,size_t s)109 const_var_set_create_from_array (const struct variable *const *var,
110 size_t s)
111 {
112 return (struct const_var_set *) var_set_create_from_array ((struct variable *const *) var, s);
113 }
114
115
116 static inline bool
parse_const_var_set_vars(struct lexer * l,const struct const_var_set * vs,const struct variable *** v,size_t * s,int opts)117 parse_const_var_set_vars (struct lexer *l, const struct const_var_set *vs,
118 const struct variable ***v, size_t *s, int opts)
119 {
120 return parse_var_set_vars (l, (const struct var_set *) vs,
121 (struct variable ***) v, s, opts);
122 }
123
124 static inline void
const_var_set_destroy(struct const_var_set * vs)125 const_var_set_destroy (struct const_var_set *vs)
126 {
127 var_set_destroy ((struct var_set *) vs);
128 }
129
130 /* Match a variable.
131 If the match succeeds, the variable will be placed in VAR.
132 Returns true if successful */
133 bool
134 lex_match_variable (struct lexer *lexer, const struct dictionary *dict, const struct variable **var);
135
136 struct interaction;
137
138 /* Parse an interaction.
139 If not successful return false.
140 Otherwise, a newly created interaction will be placed in IACT.
141 It is the caller's responsibility to destroy this interaction.
142 */
143 bool
144 parse_design_interaction (struct lexer *lexer, const struct dictionary *dict, struct interaction **iact);
145
146
147
148 #endif /* variable-parser.h */
149