src/language/expressions/private.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2011 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 EXPRESSIONS_PRIVATE_H
  18 #define EXPRESSIONS_PRIVATE_H
  19
  20 #include <assert.h>
  21 #include <stddef.h>
  22
  23 #include "data/format.h"
  24 #include "language/expressions/operations.h"
  25 #include "language/expressions/public.h"
  26 #include "libpspp/str.h"
  27
  28 enum operation_flags
  29   {
  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,
  37
  38     /* If set, this operation's final operand is an array of one
  39        or more elements. */
  40     OPF_ARRAY_OPERAND = 001,
  41
  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. */
  47     OPF_MIN_VALID = 002,
  48
  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,
  53
  54     /* If set, this operation is not implemented. */
  55     OPF_UNIMPLEMENTED = 020,
  56
  57     /* If set, this operation is a PSPP extension. */
  58     OPF_EXTENSION = 040,
  59
  60     /* If set, this operation may not occur after TEMPORARY.
  61        (Currently this applies only to LAG.) */
  62     OPF_PERM_ONLY = 0100,
  63
  64     /* If set, this operation's name may not be abbreviated. */
  65     OPF_NO_ABBREV = 0200
  66   };
  67
  68 #define EXPR_ARG_MAX 4
  69 struct operation
  70   {
  71     const char *name;
  72     const char *prototype;
  73     enum operation_flags flags;
  74     atom_type returns;
  75     int arg_cnt;
  76     atom_type args[EXPR_ARG_MAX];
  77     int array_min_elems;
  78     int array_granularity;
  79   };
  80
  81 extern const struct operation operations[];
  82
  83 /* Tree structured expressions. */
  84
  85 /* Atoms. */
  86 struct number_node
  87   {
  88     operation_type type;   /* OP_number. */
  89     double n;
  90   };
  91
  92 struct string_node
  93   {
  94     operation_type type;   /* OP_string. */
  95     struct substring s;
  96   };
  97
  98 struct variable_node
  99   {
 100     operation_type type;   /* OP_variable. */
 101     const struct variable *v;
 102   };
 103
 104 struct integer_node
 105   {
 106     operation_type type;   /* OP_integer. */
 107     int i;
 108   };
 109
 110 struct vector_node
 111   {
 112     operation_type type;   /* OP_vector. */
 113     const struct vector *v;
 114   };
 115
 116 struct format_node
 117   {
 118     operation_type type;   /* OP_format. */
 119     struct fmt_spec f;
 120   };
 121
 122 /* Any composite node. */
 123 struct composite_node
 124   {
 125     operation_type type;   /* One of OP_*. */
 126     size_t arg_cnt;             /* Number of arguments. */
 127     union any_node **args;      /* Arguments. */
 128     size_t min_valid;           /* Min valid array args to get valid result. */
 129   };
 130
 131 /* Any node. */
 132 union any_node
 133   {
 134     operation_type type;
 135     struct number_node number;
 136     struct string_node string;
 137     struct variable_node variable;
 138     struct integer_node integer;
 139     struct vector_node vector;
 140     struct format_node format;
 141     struct composite_node composite;
 142   };
 143
 144 union operation_data
 145   {
 146     operation_type operation;
 147     double number;
 148     struct substring string;
 149     const struct variable *variable;
 150     const struct vector *vector;
 151     struct fmt_spec *format;
 152     int integer;
 153   };
 154
 155 /* An expression. */
 156 struct expression
 157   {
 158     struct pool *expr_pool;     /* Pool for expression static data. */
 159     struct dataset *ds ;        /* The dataset */
 160     atom_type type;             /* Type of expression result. */
 161
 162     union operation_data *ops;  /* Expression data. */
 163     operation_type *op_types;   /* ops[] element types (for debugging). */
 164     size_t op_cnt, op_cap;      /* Number of ops, amount of allocated space. */
 165
 166     double *number_stack;       /* Evaluation stack: numerics, Booleans. */
 167     struct substring *string_stack; /* Evaluation stack: strings. */
 168     struct pool *eval_pool;     /* Pool for evaluation temporaries. */
 169   };
 170
 171 struct expression *expr_parse_any (struct lexer *lexer, struct dataset *,  bool optimize);
 172 void expr_debug_print_postfix (const struct expression *);
 173
 174 union any_node *expr_optimize (union any_node *, struct expression *);
 175 void expr_flatten (union any_node *, struct expression *);
 176
 177 atom_type expr_node_returns (const union any_node *);
 178
 179 union any_node *expr_allocate_nullary (struct expression *e, operation_type);
 180 union any_node *expr_allocate_unary (struct expression *e,
 181                                      operation_type, union any_node *);
 182 union any_node *expr_allocate_binary (struct expression *e, operation_type,
 183                                  union any_node *, union any_node *);
 184 union any_node *expr_allocate_composite (struct expression *e, operation_type,
 185                                          union any_node **, size_t);
 186 union any_node *expr_allocate_number (struct expression *e, double);
 187 union any_node *expr_allocate_boolean (struct expression *e, double);
 188 union any_node *expr_allocate_integer (struct expression *e, int);
 189 union any_node *expr_allocate_pos_int (struct expression *e, int);
 190 union any_node *expr_allocate_string (struct expression *e, struct substring);
 191 union any_node *expr_allocate_variable (struct expression *e,
 192                                         const struct variable *);
 193 union any_node *expr_allocate_format (struct expression *e,
 194                                  const struct fmt_spec *);
 195 union any_node *expr_allocate_vector (struct expression *e,
 196                                       const struct vector *);
 197
 198 #endif /* expressions/private.h */