f0cbfaf69423251ae407bc4f7da32295aa589f7e
[fw/sdcc] / src / SDCCast.h
1 /*-------------------------------------------------------------------------
2   SDCCast.h - header file for parser support & all ast related routines
3
4              Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
5
6    This program is free software; you can redistribute it and/or modify it
7    under the terms of the GNU General Public License as published by the
8    Free Software Foundation; either version 2, or (at your option) any
9    later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19    
20    In other words, you are welcome to use, share and improve this program.
21    You are forbidden to forbid anyone else to use, share and improve
22    what you give them.   Help stamp out software-hoarding!  
23 -------------------------------------------------------------------------*/
24
25 #ifndef SDCCEXPR_H
26 #define SDCCEXPR_H
27
28 #include "SDCCglobl.h"
29 #include "SDCCsymt.h"
30 #include "SDCCval.h"
31 #include "SDCCset.h"
32 #include "SDCCmem.h"
33
34 #define  EX_OP       0
35 #define  EX_VALUE    1
36 #define  EX_LINK     2
37 #define  EX_STMNT    3
38 #define  EX_OPERAND  4
39
40 /* expression tree   */
41 typedef struct ast
42   {
43
44     unsigned type:3;
45     unsigned decorated:1;
46     unsigned hasVargs:1;
47     unsigned isError:1;
48     unsigned funcName:1;
49     unsigned rvalue:1;
50     unsigned lvalue:1;
51     unsigned initMode:1;
52     int level;                  /* level for expr */
53     int block;                  /* block number   */
54     /* union of values expression can have */
55     union
56       {
57         value *val;             /* value if type = EX_VALUE */
58         sym_link *lnk;          /* sym_link * if type= EX_LINK  */
59         struct operand *oprnd;  /* used only for side effecting function calls */
60         unsigned stmnt;         /* statement if type=EX_STMNT */
61         unsigned op;            /* operator if type= EX_OP  */
62       }
63     opval;
64
65     /* union for special processing */
66     union
67       {
68         char *inlineasm;        /* pointer to inline assembler code */
69         literalList *constlist; /* init list for array initializer. */
70         symbol *sym;            /* if block then -> symbols */
71         value *args;            /* if function then args    */
72         /* if switch then switch values */
73         struct
74           {
75             value *swVals;      /* switch comparison values */
76             int swDefault;      /* default if present       */
77             int swNum;          /* switch number            */
78           }
79         switchVals;
80         /* if for then for values */
81         struct
82           {
83             struct ast *initExpr;       /* init portion */
84             struct ast *condExpr;       /* conditional portion */
85             struct ast *loopExpr;       /* iteration portion   */
86             symbol *trueLabel;  /* entry point into body */
87             symbol *falseLabel; /* exit point */
88             symbol *continueLabel;      /* conditional check   */
89             symbol *condLabel;  /* conditional label   */
90           }
91         forVals;
92         unsigned literalFromCast;       /* true if this is an EX_VALUE of LITERAL 
93                                          * type resulting from a typecast.
94                                          */
95       }
96     values;
97
98     int lineno;                 /* source file line number     */
99     char *filename;             /* filename of the source file */
100
101     sym_link *ftype;            /* start of type chain for this subtree */
102     sym_link *etype;            /* end of type chain for this subtree   */
103
104     symbol *argSym;             /* argument symbols            */
105     value *args;                /* args of a function          */
106     struct ast *left;           /* pointer to left tree        */
107     struct ast *right;          /* pointer to right tree       */
108     symbol *trueLabel;          /* if statement trueLabel */
109     symbol *falseLabel;         /* if statement falseLabel */
110   }
111 ast;
112
113
114 /* easy access macros   */
115 #define  IS_AST_OP(x)                   (x && x->type == EX_OP)
116 #define IS_CALLOP(x)   (IS_AST_OP(x) && x->opval.op == CALL)
117 #define IS_BITOR(x) (IS_AST_OP(x) && x->opval.op == '|')
118 #define IS_BITAND(x) (IS_AST_OP(x) && x->opval.op == '&' && \
119                       x->left && x->right )
120 #define IS_FOR_STMT(x) (IS_AST_OP(x) && x->opval.op == FOR)
121 #define IS_LEFT_OP(x) (IS_AST_OP(x) && x->opval.op == LEFT_OP)
122 #define IS_RIGHT_OP(x) (IS_AST_OP(x) && x->opval.op == RIGHT_OP)
123 #define  IS_AST_VALUE(x)        (x && x->type == EX_VALUE && x->opval.val)
124 #define  IS_AST_LINK(x)         (x->type == EX_LINK)
125 #define  IS_AST_NOT_OPER(x)     (x && IS_AST_OP(x) && x->opval.op == '!')
126 #define  IS_ARRAY_OP(x) (IS_AST_OP(x) && x->opval.op == '[')
127 #define  IS_COMPARE_OP(x)       (IS_AST_OP(x)           &&              \
128                                   (x->opval.op == '>'   ||              \
129                                    x->opval.op == '<'   ||              \
130                                    x->opval.op == LE_OP ||              \
131                                    x->opval.op == GE_OP ||              \
132                                    x->opval.op == EQ_OP ||              \
133                                    x->opval.op == NE_OP ))
134 #define IS_CAST_OP(x) (IS_AST_OP(x) && x->opval.op == CAST)
135 #define IS_TERNARY_OP(x) (IS_AST_OP(x) && x->opval.op == '?')
136 #define IS_COLON_OP(x) (IS_AST_OP(x) && x->opval.op == ':')
137 #define IS_ADDRESS_OF_OP(x)    (IS_AST_OP(x)            &&              \
138                                 x->opval.op == '&'      &&              \
139                                 x->right == NULL )
140 #define IS_AST_LIT_VALUE(x) (IS_AST_VALUE(x) && \
141                              IS_LITERAL(x->opval.val->etype))
142 #define IS_AST_SYM_VALUE(x)     (IS_AST_VALUE(x) && x->opval.val->sym)
143 #define AST_LIT_VALUE(x)        (floatFromVal(x->opval.val))
144 #define AST_SYMBOL(x)           (x->opval.val->sym)
145 #define AST_VALUE(x)            (x->opval.val)
146 #define AST_VALUES(x,y) (x->values.y)
147 #define AST_FOR(x,y) x->values.forVals.y
148 #define  IS_AST_PARAM(x)        (IS_AST_OP(x) && x->opval.op == PARAM)
149
150 #define  CAN_EVAL(x)    (     x ==  '[' || x == '.' || x == PTR_OP ||   \
151               x ==  '&' || x == '|' || x == '^'    || x == '*' || \
152               x ==  '-' || x == '+' || x == '~'    ||   \
153               x ==  '!' || x == LEFT_OP || x == RIGHT_OP ||       \
154               x ==  '/' || x == '%' || x == '>' || x == '<'    || \
155               x == LE_OP || x == GE_OP || x == EQ_OP || x == NE_OP || \
156               x == AND_OP || x == OR_OP || x == '='  )
157
158 #define  LEFT_FIRST(x) ( x  ==  AND_OP  ||      x       ==      OR_OP   )
159
160 #define SIDE_EFFECTS_CHECK(op,rVal)  if (!sideEffects)  {               \
161                                          werror(W_NO_SIDE_EFFECTS,op);  \
162                                          return rVal    ;               \
163                                      }
164 #define IS_MODIFYING_OP(x) ( x == INC_OP || x == DEC_OP || x == '=' ||  \
165                         x == AND_ASSIGN || x== OR_ASSIGN || x == XOR_ASSIGN )
166
167 #define IS_ASSIGN_OP(x) ( x == '=' || x == ADD_ASSIGN || x == SUB_ASSIGN ||\
168                           x == MUL_ASSIGN || x == DIV_ASSIGN || x == XOR_ASSIGN ||\
169                           x == AND_ASSIGN || x == OR_ASSIGN || x == INC_OP || x == DEC_OP)
170 #define IS_DEREF_OP(x) (( x->opval.op == '*' && x->right == NULL) || x->opval.op == '.')
171
172 /* forward declarations for global variables */
173 extern ast *staticAutos;
174 extern FILE *codeOutFile;
175 extern struct memmap *GcurMemmap;
176
177 /* forward definitions for functions   */
178 ast *newAst_VALUE (value * val);
179 ast *newAst_OP (unsigned op);
180 ast *newAst_LINK (sym_link * val);
181 ast *newAst_STMNT (unsigned val);
182
183 void initAst ();
184 ast *newNode (long, ast *, ast *);
185 ast *copyAst (ast *);
186 value *sizeofOp (sym_link *);
187 value *evalStmnt (ast *);
188 ast *createFunction (symbol *, ast *);
189 ast *createBlock (symbol *, ast *);
190 ast *createLabel (symbol *, ast *);
191 ast *createCase (ast *, ast *, ast *);
192 ast *createDefault (ast *, ast *);
193 ast *optimizeCompare (ast *);
194 ast *forLoopOptForm (ast *);
195 ast *argAst (ast *);
196 ast *resolveSymbols (ast *);
197 ast *decorateType (ast *);
198 ast *createWhile (symbol *, symbol *, symbol *, ast *, ast *);
199 ast *createIf (ast *, ast *, ast *);
200 ast *createDo (symbol *, symbol *, symbol *, ast *, ast *);
201 ast *createFor (symbol *, symbol *, symbol *, symbol *, ast *, ast *, ast *, ast *);
202 void eval2icode (ast *);
203 value *constExprValue (ast *, int);
204 symbol *funcOfType (char *, sym_link *, sym_link *, int, int);
205 ast *initAggregates (symbol *, initList *, ast *);
206 bool hasSEFcalls (ast *);
207 void addSymToBlock (symbol *, ast *);
208
209 // exported variables 
210 extern set *operKeyReset;
211 extern int noAlloc;
212 extern int inInitMode;
213
214 #endif