src/exprP.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !exprP_h
  21 #define exprP_h 1
  22
  23 #undef DEBUGGING
  24 /*#define DEBUGGING 1*/
  25 #include "debug-print.h"
  26
  27 void debug_print_op (short int *);
  28
  29
  30 /* Expression operators. */
  31 #define DEFINE_OPERATOR(NAME, STACK_DELTA, FLAGS, ARGS) \
  32         OP_##NAME,
  33 enum
  34   {
  35 #include "expr.def"
  36     OP_SENTINEL
  37   };
  38
  39 #define IS_TERMINAL(OPERATOR) (ops[OPERATOR].height > 0)
  40 #define IS_NONTERMINAL(OPERATOR) !IS_TERMINAL (OPERATOR)
  41
  42 /* Flags that describe operators. */
  43 enum
  44   {
  45     OP_NO_FLAGS = 0,            /* No flags. */
  46     OP_VAR_ARGS = 001,          /* 1=Variable number of args. */
  47     OP_MIN_ARGS = 002,          /* 1=Can specific min args with .X. */
  48     OP_FMT_SPEC = 004,          /* 1=Includes a format specifier. */
  49     OP_ABSORB_MISS = 010,       /* 1=May return other than SYSMIS if
  50                                    given a SYSMIS argument. */
  51   };
  52
  53 /* Describes an operator. */
  54 struct op_desc
  55   {
  56     const char *name;           /* Operator name. */
  57     signed char height;         /* Effect on stack height. */
  58     unsigned char flags;        /* Flags. */
  59     unsigned char skip;         /* Number of operator item arguments. */
  60   };
  61
  62 extern struct op_desc ops[];
  63
  64 /* Tree structured expressions. */
  65
  66 /* Numeric constant. */
  67 struct num_con_node
  68   {
  69     int type;                   /* Always OP_NUM_CON. */
  70     double value;               /* Numeric value. */
  71   };
  72
  73 /* String literal. */
  74 struct str_con_node
  75   {
  76     int type;                   /* Always OP_STR_CON. */
  77     int len;                    /* Length of string. */
  78     char s[1];                  /* String value. */
  79   };
  80
  81 /* Variable or test for missing values or cancellation of
  82    user-missing. */
  83 struct var_node
  84   {
  85     int type;                   /* OP_NUM_VAR, OP_NUM_SYS, OP_NUM_VAL,
  86                                    or OP_STR_VAR. */
  87     struct variable *v;         /* Variable. */
  88   };
  89
  90 /* Variable from an earlier case. */
  91 struct lag_node
  92   {
  93     int type;                   /* Always OP_NUM_LAG. */
  94     struct variable *v;         /* Relevant variable. */
  95     int lag;                    /* Number of cases to lag. */
  96   };
  97
  98 /* $CASENUM. */
  99 struct casenum_node
 100   {
 101     int type;                   /* Always OP_CASENUM. */
 102   };
 103
 104 /* Any nonterminal node. */
 105 struct nonterm_node
 106   {
 107     int type;                   /* Always greater than OP_TERMINAL. */
 108     int n;                      /* Number of arguments. */
 109     union any_node *arg[1];     /* Arguments. */
 110   };
 111
 112 /* Any node. */
 113 union any_node
 114   {
 115     int type;
 116     struct nonterm_node nonterm;
 117     struct num_con_node num_con;
 118     struct str_con_node str_con;
 119     struct var_node var;
 120     struct lag_node lag;
 121     struct casenum_node casenum;
 122   };
 123
 124 /* An expression. */
 125 struct expression
 126   {
 127     enum expr_type type;        /* Type of expression result. */
 128     unsigned char *op;          /* Operators. */
 129     struct variable **var;      /* Variables. */
 130     double *num;                /* Numeric operands. */
 131     unsigned char *str;         /* String operands. */
 132     union value *stack;         /* Evaluation stack. */
 133     struct pool *pool;          /* Pool for evaluation temporaries. */
 134   };
 135
 136 void optimize_expression (union any_node **);
 137 void dump_expression (union any_node *, struct expression *);
 138 void free_node (union any_node *);
 139
 140 double yrmoda (double year, double month, double day);
 141
 142 #endif /* exprP.h */