1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2011 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #ifndef EXPRESSIONS_PRIVATE_H
18 #define EXPRESSIONS_PRIVATE_H
23 #include "data/format.h"
24 #include "operations.h"
26 #include "libpspp/str.h"
30 /* Most operations produce a missing output value if any
31 input value is missing. Setting this bit indicates that
32 this operation may produce a non-missing result given
33 missing input values (although it is not obliged to do
34 so). Unless this bit is set, the operation's evaluation
35 function will never be passed a missing argument. */
36 OPF_ABSORB_MISS = 004,
38 /* If set, this operation's final operand is an array of one
40 OPF_ARRAY_OPERAND = 001,
42 /* If set, the user can specify the minimum number of array
43 elements that must be non-missing for the function result
44 to be non-missing. The operation must have an array
45 operand and the array must contain `double's. Both
46 OPF_ABSORB_MISS and OPF_ARRAY_OPERAND must also be set. */
49 /* If set, operation is non-optimizable in general. Unless
50 combined with OPF_ABSORB_MISS, missing input values are
51 still assumed to yield missing results. */
52 OPF_NONOPTIMIZABLE = 010,
54 /* If set, this operation is not implemented. */
55 OPF_UNIMPLEMENTED = 020,
57 /* If set, this operation is a PSPP extension. */
60 /* If set, this operation may not occur after TEMPORARY.
61 (Currently this applies only to LAG.) */
64 /* If set, this operation's name may not be abbreviated. */
68 #define EXPR_ARG_MAX 4
72 const char *prototype;
73 enum operation_flags flags;
74 atom_type returns; /* Usually OP_number, OP_string, or OP_boolean. */
76 atom_type args[EXPR_ARG_MAX];
78 int array_granularity;
81 extern const struct operation operations[];
83 /* Expression parse tree. */
87 struct msg_location *location;
95 struct substring string;
98 const struct variable *variable;
104 const struct vector *vector;
107 struct fmt_spec format;
109 /* All the other node types. */
112 size_t n_args; /* Number of arguments. */
113 struct expr_node **args; /* Arguments. */
114 size_t min_valid; /* Min valid array args to get valid result. */
121 operation_type operation;
123 struct substring string;
124 const struct variable *variable;
125 const struct vector *vector;
126 struct fmt_spec *format;
133 struct pool *expr_pool; /* Pool for expression static data. */
134 struct dataset *ds ; /* The dataset */
135 atom_type type; /* Type of expression result. */
137 union operation_data *ops; /* Expression data. */
138 operation_type *op_types; /* ops[] element types (for debugging). */
139 size_t n_ops, allocated_ops; /* Number of ops, amount of allocated space. */
141 double *number_stack; /* Evaluation stack: numerics, Booleans. */
142 struct substring *string_stack; /* Evaluation stack: strings. */
143 struct pool *eval_pool; /* Pool for evaluation temporaries. */
146 struct expression *expr_parse_any (struct lexer *lexer, struct dataset *, bool optimize);
147 void expr_debug_print_postfix (const struct expression *);
149 struct expr_node *expr_optimize (struct expr_node *, struct expression *);
150 void expr_flatten (struct expr_node *, struct expression *);
152 atom_type expr_node_returns (const struct expr_node *);
154 struct expr_node *expr_allocate_nullary (struct expression *e, operation_type);
155 struct expr_node *expr_allocate_unary (struct expression *e,
156 operation_type, struct expr_node *);
157 struct expr_node *expr_allocate_binary (struct expression *e, operation_type,
158 struct expr_node *, struct expr_node *);
159 struct expr_node *expr_allocate_composite (struct expression *e, operation_type,
160 struct expr_node **, size_t);
161 struct expr_node *expr_allocate_number (struct expression *e, double);
162 struct expr_node *expr_allocate_boolean (struct expression *e, double);
163 struct expr_node *expr_allocate_integer (struct expression *e, int);
164 struct expr_node *expr_allocate_pos_int (struct expression *e, int);
165 struct expr_node *expr_allocate_string (struct expression *e, struct substring);
166 struct expr_node *expr_allocate_variable (struct expression *e,
167 const struct variable *);
168 struct expr_node *expr_allocate_format (struct expression *e,
169 const struct fmt_spec *);
170 struct expr_node *expr_allocate_vector (struct expression *e,
171 const struct vector *);
173 #endif /* expressions/private.h */