annotate lwlink/expr.h @ 420:7366deedfa85 3.0-beta2

Branched for 3.0-beta2 release
author lost@l-w.ca
date Sun, 19 Sep 2010 01:12:26 -0600
parents 1c31e9005ff7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
339
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
1 /*
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
2 expr.h
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
3 Copyright © 2009 William Astle
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
4
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
5 This file is part of LWLINK.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
6
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
7 LWLINK is free software: you can redistribute it and/or modify it under the
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
8 terms of the GNU General Public License as published by the Free Software
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
9 Foundation, either version 3 of the License, or (at your option) any later
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
10 version.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
11
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
12 This program is distributed in the hope that it will be useful, but WITHOUT
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
15 more details.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
16
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
17 You should have received a copy of the GNU General Public License along with
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
18 this program. If not, see <http://www.gnu.org/licenses/>.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
19 */
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
20
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
21 /*
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
22 Definitions for expression evaluator
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
23 */
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
24
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
25 #ifndef __expr_h_seen__
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
26 #define __expr_h_seen__
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
27
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
28 #ifndef __expr_c_seen__
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
29 #define __expr_E__ extern
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
30 #else
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
31 #define __expr_E__
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
32 #endif
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
33
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
34 // term types
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
35 #define LW_TERM_NONE 0
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
36 #define LW_TERM_OPER 1 // an operator
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
37 #define LW_TERM_INT 2 // 32 bit signed integer
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
38 #define LW_TERM_SYM 3 // symbol reference
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
39
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
40 // operator types
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
41 #define LW_OPER_NONE 0
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
42 #define LW_OPER_PLUS 1 // +
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
43 #define LW_OPER_MINUS 2 // -
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
44 #define LW_OPER_TIMES 3 // *
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
45 #define LW_OPER_DIVIDE 4 // /
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
46 #define LW_OPER_MOD 5 // %
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
47 #define LW_OPER_INTDIV 6 // \ (don't end line with \)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
48 #define LW_OPER_BWAND 7 // bitwise AND
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
49 #define LW_OPER_BWOR 8 // bitwise OR
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
50 #define LW_OPER_BWXOR 9 // bitwise XOR
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
51 #define LW_OPER_AND 10 // boolean AND
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
52 #define LW_OPER_OR 11 // boolean OR
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
53 #define LW_OPER_NEG 12 // - unary negation (2's complement)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
54 #define LW_OPER_COM 13 // ^ unary 1's complement
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
55
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
56
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
57 // term structure
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
58 typedef struct lw_expr_term_s
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
59 {
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
60 int term_type; // type of term (see above)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
61 char *symbol; // name of a symbol
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
62 int value; // value of the term (int) or operator number (OPER)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
63 } lw_expr_term_t;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
64
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
65 // type for an expression evaluation stack
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
66 typedef struct lw_expr_stack_node_s lw_expr_stack_node_t;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
67 struct lw_expr_stack_node_s
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
68 {
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
69 lw_expr_term_t *term;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
70 lw_expr_stack_node_t *prev;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
71 lw_expr_stack_node_t *next;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
72 };
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
73
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
74 typedef struct lw_expr_stack_s
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
75 {
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
76 lw_expr_stack_node_t *head;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
77 lw_expr_stack_node_t *tail;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
78 } lw_expr_stack_t;
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
79
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
80 __expr_E__ void lw_expr_term_free(lw_expr_term_t *t);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
81 __expr_E__ lw_expr_term_t *lw_expr_term_create_oper(int oper);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
82 __expr_E__ lw_expr_term_t *lw_expr_term_create_sym(char *sym, int symtype);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
83 __expr_E__ lw_expr_term_t *lw_expr_term_create_int(int val);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
84 __expr_E__ lw_expr_term_t *lw_expr_term_dup(lw_expr_term_t *t);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
85
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
86 __expr_E__ void lw_expr_stack_free(lw_expr_stack_t *s);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
87 __expr_E__ lw_expr_stack_t *lw_expr_stack_create(void);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
88 __expr_E__ lw_expr_stack_t *lw_expr_stack_dup(lw_expr_stack_t *s);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
89
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
90 __expr_E__ void lw_expr_stack_push(lw_expr_stack_t *s, lw_expr_term_t *t);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
91 __expr_E__ lw_expr_term_t *lw_expr_stack_pop(lw_expr_stack_t *s);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
92
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
93 // simplify expression
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
94 __expr_E__ int lw_expr_reval(lw_expr_stack_t *s, lw_expr_stack_t *(*sfunc)(char *sym, int symtype, void *state), void *state);
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
95
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
96 // useful macros
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
97 // is the expression "simple" (one term)?
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
98 #define lw_expr_is_simple(s) ((s) -> head == (s) -> tail)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
99
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
100 // is the expression constant?
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
101 #define lw_expr_is_constant(s) (lw_expr_is_simple(s) && (!((s) -> head) || (s) -> head -> term -> term_type == LW_TERM_INT))
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
102
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
103 // get the constant value of an expression or 0 if not constant
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
104 #define lw_expr_get_value(s) (lw_expr_is_constant(s) ? ((s) -> head ? (s) -> head -> term -> value : 0) : 0)
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
105
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
106 #undef __expr_E__
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
107
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
108 #endif // __expr_h_seen__