OSDN Git Service

2004-07-06 Daniel Berlin <dberlin@dberlin.org>
[pf3gnuchains/gcc-fork.git] / gcc / tree.def
1 /* This file contains the definitions and documentation for the
2    tree codes used in GCC.
3    Copyright (C) 1987, 1988, 1993, 1995, 1997, 1998, 2000, 2001, 2004
4    Free Software Foundation, Inc.
5
6 This file is part of GCC.
7
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
11 version.
12
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING.  If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA.  */
22
23  
24 /* The third argument can be:
25    'x' for an exceptional code (fits no category).
26    't' for a type object code.
27    'c' for codes for constants.
28    'd' for codes for declarations (also serving as variable refs).
29    'r' for codes for references to storage.
30    '<' for codes for comparison expressions.
31    '1' for codes for unary arithmetic expressions.
32    '2' for codes for binary arithmetic expressions.
33    's' for codes for "statement" expressions, which have side-effects,
34        but usually no interesting value.
35    'e' for codes for other kinds of expressions.  */
36
37 /* For `r', `e', `<', `1', `2', and `s' nodes, which use struct
38    tree_exp, the 4th element is the number of argument slots to
39    allocate.  This determines the size of the tree node object.
40    Other nodes use different structures, and the size is determined
41    by the tree_union member structure; the 4th element should be
42    zero.  Languages that define language-specific 'x' or 'c' codes
43    must define the tree_size langhook to say how big they are.  */
44
45 /* Any erroneous construct is parsed into a node of this type.
46    This type of node is accepted without complaint in all contexts
47    by later parsing activities, to avoid multiple error messages
48    for one error.
49    No fields in these nodes are used except the TREE_CODE.  */
50 DEFTREECODE (ERROR_MARK, "error_mark", 'x', 0)
51
52 /* Used to represent a name (such as, in the DECL_NAME of a decl node).
53    Internally it looks like a STRING_CST node.
54    There is only one IDENTIFIER_NODE ever made for any particular name.
55    Use `get_identifier' to get it (or create it, the first time).  */
56 DEFTREECODE (IDENTIFIER_NODE, "identifier_node", 'x', 0)
57
58 /* Has the TREE_VALUE and TREE_PURPOSE fields.  */
59 /* These nodes are made into lists by chaining through the
60    TREE_CHAIN field.  The elements of the list live in the
61    TREE_VALUE fields, while TREE_PURPOSE fields are occasionally
62    used as well to get the effect of Lisp association lists.  */
63 DEFTREECODE (TREE_LIST, "tree_list", 'x', 0)
64
65 /* These nodes contain an array of tree nodes.  */
66 DEFTREECODE (TREE_VEC, "tree_vec", 'x', 0)
67
68 /* A symbol binding block.  These are arranged in a tree,
69    where the BLOCK_SUBBLOCKS field contains a chain of subblocks
70    chained through the BLOCK_CHAIN field.
71    BLOCK_SUPERCONTEXT points to the parent block.
72      For a block which represents the outermost scope of a function, it
73      points to the FUNCTION_DECL node.
74    BLOCK_VARS points to a chain of decl nodes.
75    BLOCK_TYPE_TAGS points to a chain of types which have their own names.
76    BLOCK_CHAIN points to the next BLOCK at the same level.
77    BLOCK_ABSTRACT_ORIGIN points to the original (abstract) tree node which
78    this block is an instance of, or else is NULL to indicate that this
79    block is not an instance of anything else.  When non-NULL, the value
80    could either point to another BLOCK node or it could point to a
81    FUNCTION_DECL node (e.g. in the case of a block representing the
82    outermost scope of a particular inlining of a function).
83    BLOCK_ABSTRACT is nonzero if the block represents an abstract
84    instance of a block (i.e. one which is nested within an abstract
85    instance of an inline function). 
86    TREE_ASM_WRITTEN is nonzero if the block was actually referenced
87    in the generated assembly.  */
88 DEFTREECODE (BLOCK, "block", 'x', 0)
89 \f
90 /* Each data type is represented by a tree node whose code is one of
91    the following:  */
92 /* Each node that represents a data type has a component TYPE_SIZE
93    containing a tree that is an expression for the size in bits.
94    The TYPE_MODE contains the machine mode for values of this type.
95    The TYPE_POINTER_TO field contains a type for a pointer to this type,
96      or zero if no such has been created yet.
97    The TYPE_NEXT_VARIANT field is used to chain together types
98      that are variants made by type modifiers such as "const" and "volatile".
99    The TYPE_MAIN_VARIANT field, in any member of such a chain,
100      points to the start of the chain.
101    The TYPE_NONCOPIED_PARTS field is a list specifying which parts
102      of an object of this type should *not* be copied by assignment.
103      The TREE_VALUE of each is a FIELD_DECL that should not be
104      copied.  The TREE_PURPOSE is an initial value for that field when
105      an object of this type is initialized via an INIT_EXPR.  It may
106      be NULL if no special value is required.  Even the things in this
107      list are copied if the right-hand side of an assignment is known
108      to be a complete object (rather than being, perhaps, a subobject
109      of some other object.)  The determination of what constitutes a
110      complete object is done by fixed_type_p.
111    The TYPE_NAME field contains info on the name used in the program
112      for this type (for GDB symbol table output).  It is either a
113      TYPE_DECL node, for types that are typedefs, or an IDENTIFIER_NODE
114      in the case of structs, unions or enums that are known with a tag,
115      or zero for types that have no special name.
116    The TYPE_CONTEXT for any sort of type which could have a name or
117     which could have named members (e.g. tagged types in C/C++) will
118     point to the node which represents the scope of the given type, or
119     will be NULL_TREE if the type has "file scope".  For most types, this
120     will point to a BLOCK node or a FUNCTION_DECL node, but it could also
121     point to a FUNCTION_TYPE node (for types whose scope is limited to the
122     formal parameter list of some function type specification) or it
123     could point to a RECORD_TYPE, UNION_TYPE or QUAL_UNION_TYPE node
124     (for C++ "member" types).
125     For non-tagged-types, TYPE_CONTEXT need not be set to anything in
126     particular, since any type which is of some type category  (e.g.
127     an array type or a function type) which cannot either have a name
128     itself or have named members doesn't really have a "scope" per se.
129   The TREE_CHAIN field is used as a forward-references to names for
130     ENUMERAL_TYPE, RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE nodes;
131     see below.  */
132
133 DEFTREECODE (VOID_TYPE, "void_type", 't', 0)    /* The void type in C */
134
135 /* Integer types in all languages, including char in C.
136    Also used for sub-ranges of other discrete types.
137    Has components TYPE_MIN_VALUE, TYPE_MAX_VALUE (expressions, inclusive)
138    and TYPE_PRECISION (number of bits used by this type).
139    In the case of a subrange type in Pascal, the TREE_TYPE
140    of this will point at the supertype (another INTEGER_TYPE,
141    or an ENUMERAL_TYPE, CHAR_TYPE, or BOOLEAN_TYPE).
142    Otherwise, the TREE_TYPE is zero.  */
143 DEFTREECODE (INTEGER_TYPE, "integer_type", 't', 0)
144
145 /* C's float and double.  Different floating types are distinguished
146    by machine mode and by the TYPE_SIZE and the TYPE_PRECISION.  */
147 DEFTREECODE (REAL_TYPE, "real_type", 't', 0)
148
149 /* Complex number types.  The TREE_TYPE field is the data type
150    of the real and imaginary parts.  */
151 DEFTREECODE (COMPLEX_TYPE, "complex_type", 't', 0)
152
153 /* Vector types.  The TREE_TYPE field is the data type of the vector
154    elements.  */
155 DEFTREECODE (VECTOR_TYPE, "vector_type", 't', 0)
156
157 /* C enums.  The type node looks just like an INTEGER_TYPE node.
158    The symbols for the values of the enum type are defined by
159    CONST_DECL nodes, but the type does not point to them;
160    however, the TYPE_VALUES is a list in which each element's TREE_PURPOSE
161    is a name and the TREE_VALUE is the value (an INTEGER_CST node).  */
162 /* A forward reference `enum foo' when no enum named foo is defined yet
163    has zero (a null pointer) in its TYPE_SIZE.  The tag name is in
164    the TYPE_NAME field.  If the type is later defined, the normal
165    fields are filled in.
166    RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE forward refs are
167    treated similarly.  */
168 DEFTREECODE (ENUMERAL_TYPE, "enumeral_type", 't', 0)
169
170 /* Pascal's boolean type (true or false are the only values);
171    no special fields needed.  */
172 DEFTREECODE (BOOLEAN_TYPE, "boolean_type", 't', 0)
173
174 /* CHAR in Pascal; not used in C.
175    No special fields needed.  */
176 DEFTREECODE (CHAR_TYPE, "char_type", 't', 0)
177
178 /* All pointer-to-x types have code POINTER_TYPE.
179    The TREE_TYPE points to the node for the type pointed to.  */
180 DEFTREECODE (POINTER_TYPE, "pointer_type", 't', 0)
181
182 /* An offset is a pointer relative to an object.
183    The TREE_TYPE field is the type of the object at the offset.
184    The TYPE_OFFSET_BASETYPE points to the node for the type of object
185    that the offset is relative to.  */
186 DEFTREECODE (OFFSET_TYPE, "offset_type", 't', 0)
187
188 /* A reference is like a pointer except that it is coerced
189    automatically to the value it points to.  Used in C++.  */
190 DEFTREECODE (REFERENCE_TYPE, "reference_type", 't', 0)
191
192 /* METHOD_TYPE is the type of a function which takes an extra first
193    argument for "self", which is not present in the declared argument list.
194    The TREE_TYPE is the return type of the method.  The TYPE_METHOD_BASETYPE
195    is the type of "self".  TYPE_ARG_TYPES is the real argument list, which
196    includes the hidden argument for "self".  */
197 DEFTREECODE (METHOD_TYPE, "method_type", 't', 0)
198
199 /* Used for Pascal; details not determined right now.  */
200 DEFTREECODE (FILE_TYPE, "file_type", 't', 0)
201
202 /* Types of arrays.  Special fields:
203    TREE_TYPE              Type of an array element.
204    TYPE_DOMAIN            Type to index by.
205                             Its range of values specifies the array length.
206  The field TYPE_POINTER_TO (TREE_TYPE (array_type)) is always nonzero
207  and holds the type to coerce a value of that array type to in C.
208  TYPE_STRING_FLAG indicates a string (in contrast to an array of chars)
209  in languages (such as Chill) that make a distinction.  */
210 /* Array types in C or Pascal */
211 DEFTREECODE (ARRAY_TYPE, "array_type", 't', 0)
212
213 /* Types of sets for Pascal.  Special fields are the same as
214    in an array type.  The target type is always a boolean type.
215    Used for both bitstrings and powersets in Chill;
216    TYPE_STRING_FLAG indicates a bitstring.  */
217 DEFTREECODE (SET_TYPE, "set_type", 't', 0)
218
219 /* Struct in C, or record in Pascal.  */
220 /* Special fields:
221    TYPE_FIELDS  chain of FIELD_DECLs for the fields of the struct,
222      and VAR_DECLs, TYPE_DECLs and CONST_DECLs for record-scope variables,
223      types and enumerators.
224    A few may need to be added for Pascal.  */
225 /* See the comment above, before ENUMERAL_TYPE, for how
226    forward references to struct tags are handled in C.  */
227 DEFTREECODE (RECORD_TYPE, "record_type", 't', 0)
228
229 /* Union in C.  Like a struct, except that the offsets of the fields
230    will all be zero.  */
231 /* See the comment above, before ENUMERAL_TYPE, for how
232    forward references to union tags are handled in C.  */
233 DEFTREECODE (UNION_TYPE, "union_type", 't', 0)  /* C union type */
234
235 /* Similar to UNION_TYPE, except that the expressions in DECL_QUALIFIER
236    in each FIELD_DECL determine what the union contains.  The first
237    field whose DECL_QUALIFIER expression is true is deemed to occupy
238    the union.  */
239 DEFTREECODE (QUAL_UNION_TYPE, "qual_union_type", 't', 0)
240
241 /* Type of functions.  Special fields:
242    TREE_TYPE                type of value returned.
243    TYPE_ARG_TYPES      list of types of arguments expected.
244         this list is made of TREE_LIST nodes.
245    Types of "Procedures" in languages where they are different from functions
246    have code FUNCTION_TYPE also, but then TREE_TYPE is zero or void type.  */
247 DEFTREECODE (FUNCTION_TYPE, "function_type", 't', 0)
248
249 /* This is a language-specific kind of type.
250    Its meaning is defined by the language front end.
251    layout_type does not know how to lay this out,
252    so the front-end must do so manually.  */
253 DEFTREECODE (LANG_TYPE, "lang_type", 't', 0)
254 \f
255 /* Expressions */
256
257 /* First, the constants.  */
258
259 /* Contents are in TREE_INT_CST_LOW and TREE_INT_CST_HIGH fields,
260    32 bits each, giving us a 64 bit constant capability.
261    Note: constants of type char in Pascal are INTEGER_CST,
262    and so are pointer constants such as nil in Pascal or NULL in C.
263    `(int *) 1' in C also results in an INTEGER_CST.  */
264 DEFTREECODE (INTEGER_CST, "integer_cst", 'c', 0)
265
266 /* Contents are in TREE_REAL_CST field.  */
267 DEFTREECODE (REAL_CST, "real_cst", 'c', 0)
268
269 /* Contents are in TREE_REALPART and TREE_IMAGPART fields,
270    whose contents are other constant nodes.  */
271 DEFTREECODE (COMPLEX_CST, "complex_cst", 'c', 0)
272
273 /* Contents are in TREE_VECTOR_CST_ELTS field.  */
274 DEFTREECODE (VECTOR_CST, "vector_cst", 'c', 0)     
275
276 /* Contents are TREE_STRING_LENGTH and TREE_STRING_POINTER fields.  */
277 DEFTREECODE (STRING_CST, "string_cst", 'c', 0)
278
279 /* Declarations.  All references to names are represented as ..._DECL
280    nodes.  The decls in one binding context are chained through the
281    TREE_CHAIN field.  Each DECL has a DECL_NAME field which contains
282    an IDENTIFIER_NODE.  (Some decls, most often labels, may have zero
283    as the DECL_NAME).  DECL_CONTEXT points to the node representing
284    the context in which this declaration has its scope.  For
285    FIELD_DECLs, this is the RECORD_TYPE, UNION_TYPE, or
286    QUAL_UNION_TYPE node that the field is a member of.  For VAR_DECL,
287    PARM_DECL, FUNCTION_DECL, LABEL_DECL, and CONST_DECL nodes, this
288    points to either the FUNCTION_DECL for the containing function, the
289    RECORD_TYPE or UNION_TYPE for the containing type, or NULL_TREE or
290    a TRANSLATION_UNIT_DECL if the given decl has "file scope".
291    DECL_ABSTRACT_ORIGIN, if non-NULL, points to the original (abstract)
292     ..._DECL node of which this decl is an (inlined or template expanded)
293     instance.
294    The TREE_TYPE field holds the data type of the object, when relevant.
295     LABEL_DECLs have no data type.  For TYPE_DECL, the TREE_TYPE field
296     contents are the type whose name is being declared.
297    The DECL_ALIGN, DECL_SIZE,
298     and DECL_MODE fields exist in decl nodes just as in type nodes.
299     They are unused in LABEL_DECL, TYPE_DECL and CONST_DECL nodes.
300
301    DECL_FIELD_BIT_OFFSET holds an integer number of bits offset for
302    the location.  DECL_VOFFSET holds an expression for a variable
303    offset; it is to be multiplied by DECL_VOFFSET_UNIT (an integer).
304    These fields are relevant only in FIELD_DECLs and PARM_DECLs.
305
306    DECL_INITIAL holds the value to initialize a variable to,
307    or the value of a constant.  For a function, it holds the body
308    (a node of type BLOCK representing the function's binding contour
309    and whose body contains the function's statements.)  For a LABEL_DECL
310    in C, it is a flag, nonzero if the label's definition has been seen.
311
312    PARM_DECLs use a special field:
313    DECL_ARG_TYPE is the type in which the argument is actually
314     passed, which may be different from its type within the function.
315
316    FUNCTION_DECLs use four special fields:
317    DECL_ARGUMENTS holds a chain of PARM_DECL nodes for the arguments.
318    DECL_RESULT holds a RESULT_DECL node for the value of a function,
319     or it is 0 for a function that returns no value.
320     (C functions returning void have zero here.)
321     The TREE_TYPE field is the type in which the result is actually
322     returned.  This is usually the same as the return type of the
323     FUNCTION_DECL, but it may be a wider integer type because of
324     promotion.
325    DECL_FUNCTION_CODE is a code number that is nonzero for
326     built-in functions.  Its value is an enum built_in_function
327     that says which built-in function it is.
328
329    DECL_SOURCE_FILE holds a filename string and DECL_SOURCE_LINE
330    holds a line number.  In some cases these can be the location of
331    a reference, if no definition has been seen.
332
333    DECL_ABSTRACT is nonzero if the decl represents an abstract instance
334    of a decl (i.e. one which is nested within an abstract instance of a
335    inline function.  */
336
337 DEFTREECODE (FUNCTION_DECL, "function_decl", 'd', 0)
338 DEFTREECODE (LABEL_DECL, "label_decl", 'd', 0)
339 DEFTREECODE (CONST_DECL, "const_decl", 'd', 0)
340 DEFTREECODE (TYPE_DECL, "type_decl", 'd', 0)
341 DEFTREECODE (VAR_DECL, "var_decl", 'd', 0)
342 DEFTREECODE (PARM_DECL, "parm_decl", 'd', 0)
343 DEFTREECODE (RESULT_DECL, "result_decl", 'd', 0)
344 DEFTREECODE (FIELD_DECL, "field_decl", 'd', 0)
345
346 /* A namespace declaration.  Namespaces appear in DECL_CONTEXT of other
347    _DECLs, providing a hierarchy of names.  */
348 DEFTREECODE (NAMESPACE_DECL, "namespace_decl", 'd', 0)
349
350 /* A translation unit.  This is not technically a declaration, since it
351    can't be looked up, but it's close enough.  */
352 DEFTREECODE (TRANSLATION_UNIT_DECL, "translation_unit_decl", 'd', 0)
353 \f
354 /* References to storage.  */
355
356 /* Value is structure or union component.
357    Operand 0 is the structure or union (an expression).
358    Operand 1 is the field (a node of type FIELD_DECL).
359    Operand 2, if present, is the value of DECL_FIELD_OFFSET, measured
360    in units of DECL_OFFSET_ALIGN / BITS_PER_UNIT.  */
361 DEFTREECODE (COMPONENT_REF, "component_ref", 'r', 3)
362
363 /* Reference to a group of bits within an object.  Similar to COMPONENT_REF
364    except the position is given explicitly rather than via a FIELD_DECL.
365    Operand 0 is the structure or union expression;
366    operand 1 is a tree giving the number of bits being referenced;
367    operand 2 is a tree giving the position of the first referenced bit.
368    The field can be either a signed or unsigned field;
369    BIT_FIELD_REF_UNSIGNED says which.  */
370 DEFTREECODE (BIT_FIELD_REF, "bit_field_ref", 'r', 3)
371    
372 /* C unary `*' or Pascal `^'.  One operand, an expression for a pointer.  */
373 DEFTREECODE (INDIRECT_REF, "indirect_ref", 'r', 1)
374
375 /* Pascal `^` on a file.  One operand, an expression for the file.  */
376 DEFTREECODE (BUFFER_REF, "buffer_ref", 'r', 1)
377
378 /* Array indexing.
379    Operand 0 is the array; operand 1 is a (single) array index.
380    Operand 2, if present, is a copy of TYPE_MIN_VALUE of the index.
381    Operand 3, if present, is the element size, measured in units of
382    the alignment of the element type.  */
383 DEFTREECODE (ARRAY_REF, "array_ref", 'r', 4)
384
385 /* Likewise, except that the result is a range ("slice") of the array.  The
386    starting index of the resulting array is taken from operand 1 and the size
387    of the range is taken from the type of the expression.  */
388 DEFTREECODE (ARRAY_RANGE_REF, "array_range_ref", 'r', 4)
389
390 /* Used to represent lookup of runtime type dependent data.  Often this is
391    a reference to a vtable, but it needn't be.  Operands are:
392    OBJ_TYPE_REF_EXPR: An expression that evaluates the value to use.
393    OBJ_TYPE_REF_OBJECT: Is the object on whose behalf the lookup is
394    being performed.  Through this the optimizers may be able to statically
395    determine the dynamic type of the object.
396    OBJ_TYPE_REF_TOKEN: Something front-end specific used to resolve the
397    reference to something simpler, usually to the address of a DECL.
398    Never touched by the middle-end.  Good choices would be either an
399    identifier or a vtable index.  */
400 DEFTREECODE (OBJ_TYPE_REF, "obj_type_ref", 'e', 3)
401
402 /* The exception object from the runtime.  */
403 DEFTREECODE (EXC_PTR_EXPR, "exc_ptr_expr", 'e', 0)
404
405 /* The filter object from the runtime.  */
406 DEFTREECODE (FILTER_EXPR, "filter_expr", 'e', 0)
407
408 /* Constructor: return an aggregate value made from specified components.
409    In C, this is used only for structure and array initializers.
410    Also used for SET_TYPE in Chill (and potentially Pascal).
411    The operand is a list of component values made out of a chain of
412    TREE_LIST nodes.
413
414    For ARRAY_TYPE:
415    The TREE_PURPOSE of each node is the corresponding index.
416    If the TREE_PURPOSE is a RANGE_EXPR, it is a short-hand for many nodes,
417    one for each index in the range.  (If the corresponding TREE_VALUE
418    has side-effects, they are evaluated once for each element.  Wrap the
419    value in a SAVE_EXPR if you want to evaluate side effects only once.)
420
421    For RECORD_TYPE, UNION_TYPE, or QUAL_UNION_TYPE:
422    The TREE_PURPOSE of each node is a FIELD_DECL.
423
424    For SET_TYPE:
425    The TREE_VALUE specifies a value (index) in the set that is true.
426    If TREE_PURPOSE is non-NULL, it specifies the lower limit of a
427    range of true values.  Elements not listed are false (not in the set).  */
428 DEFTREECODE (CONSTRUCTOR, "constructor", 'e', 1)
429
430 /* The expression types are mostly straightforward, with the fourth argument
431    of DEFTREECODE saying how many operands there are.
432    Unless otherwise specified, the operands are expressions and the
433    types of all the operands and the expression must all be the same.  */
434
435 /* Contains two expressions to compute, one followed by the other.
436    the first value is ignored.  The second one's value is used.  The
437    type of the first expression need not agree with the other types.  */
438 DEFTREECODE (COMPOUND_EXPR, "compound_expr", 'e', 2)
439
440 /* Assignment expression.  Operand 0 is the what to set; 1, the new value.  */
441 DEFTREECODE (MODIFY_EXPR, "modify_expr", 'e', 2)
442
443 /* Initialization expression.  Operand 0 is the variable to initialize;
444    Operand 1 is the initializer.  */
445 DEFTREECODE (INIT_EXPR, "init_expr", 'e', 2)
446
447 /* For TARGET_EXPR, operand 0 is the target of an initialization,
448    operand 1 is the initializer for the target, which may be void
449      if simply expanding it initializes the target.
450    operand 2 is the cleanup for this node, if any.
451    operand 3 is the saved initializer after this node has been
452    expanded once; this is so we can re-expand the tree later.  */
453 DEFTREECODE (TARGET_EXPR, "target_expr", 'e', 4)
454
455 /* Conditional expression ( ... ? ... : ...  in C).
456    Operand 0 is the condition.
457    Operand 1 is the then-value.
458    Operand 2 is the else-value.
459    Operand 0 may be of any type.
460    Operand 1 must have the same type as the entire expression, unless
461    it unconditionally throws an exception, in which case it should
462    have VOID_TYPE.  The same constraints apply to operand 2.  */
463 DEFTREECODE (COND_EXPR, "cond_expr", 'e', 3)
464
465 /* Declare local variables, including making RTL and allocating space.
466    BIND_EXPR_VARS is a chain of VAR_DECL nodes for the variables.
467    BIND_EXPR_BODY is the body, the expression to be computed using 
468    the variables.  The value of operand 1 becomes that of the BIND_EXPR.
469    BIND_EXPR_BLOCK is the BLOCK that corresponds to these bindings
470    for debugging purposes.  If this BIND_EXPR is actually expanded,
471    that sets the TREE_USED flag in the BLOCK.
472
473    The BIND_EXPR is not responsible for informing parsers
474    about these variables.  If the body is coming from the input file,
475    then the code that creates the BIND_EXPR is also responsible for 
476    informing the parser of the variables.
477
478    If the BIND_EXPR is ever expanded, its TREE_USED flag is set.
479    This tells the code for debugging symbol tables not to ignore the BIND_EXPR.
480    If the BIND_EXPR should be output for debugging but will not be expanded, 
481    set the TREE_USED flag by hand.
482
483    In order for the BIND_EXPR to be known at all, the code that creates it
484    must also install it as a subblock in the tree of BLOCK
485    nodes for the function.  */
486 DEFTREECODE (BIND_EXPR, "bind_expr", 'e', 3)
487
488 /* A labeled block. Operand 0 is the label that will be generated to
489    mark the end of the block.
490    Operand 1 is the labeled block body.  */
491 DEFTREECODE (LABELED_BLOCK_EXPR, "labeled_block_expr", 'e', 2)
492
493 /* Function call.  Operand 0 is the function.
494    Operand 1 is the argument list, a list of expressions
495    made out of a chain of TREE_LIST nodes.
496    Operand 2 is the static chain argument, or NULL.  */
497 DEFTREECODE (CALL_EXPR, "call_expr", 'e', 3)
498
499 /* Specify a value to compute along with its corresponding cleanup.
500    Operand 0 argument is an expression whose value needs a cleanup.
501    Operand 1 is the cleanup expression for the object.
502    Operand 2 is unused.
503    The cleanup is executed by the first enclosing CLEANUP_POINT_EXPR, if
504    it exists, otherwise it is the responsibility of the caller to manually
505    call expand_start_target_temps/expand_end_target_temps, as needed.
506
507    This differs from TRY_CATCH_EXPR in that operand 2 is always
508    evaluated when an exception isn't thrown when cleanups are run.  */
509 DEFTREECODE (WITH_CLEANUP_EXPR, "with_cleanup_expr", 'e', 3)
510
511 /* Specify a cleanup point.
512    Operand 0 is an expression that may have cleanups.  If it does, those
513    cleanups are executed after the expression is expanded.
514
515    Note that if the expression is a reference to storage, it is forced out
516    of memory before the cleanups are run.  This is necessary to handle
517    cases where the cleanups modify the storage referenced; in the
518    expression 't.i', if 't' is a struct with an integer member 'i' and a
519    cleanup which modifies 'i', the value of the expression depends on
520    whether the cleanup is run before or after 't.i' is evaluated.  When
521    expand_expr is run on 't.i', it returns a MEM.  This is not good enough;
522    the value of 't.i' must be forced out of memory.
523
524    As a consequence, the operand of a CLEANUP_POINT_EXPR must not have
525    BLKmode, because it will not be forced out of memory.  */
526 DEFTREECODE (CLEANUP_POINT_EXPR, "cleanup_point_expr", 'e', 1)
527
528 /* The following two codes are used in languages that have types where
529    some field in an object of the type contains a value that is used in
530    the computation of another field's offset or size and/or the size of
531    the type.  The positions and/or sizes of fields can vary from object
532    to object of the same type or even for one and the same object within
533    its scope.
534
535    Record types with discriminants in Ada or schema types in Pascal are
536    examples of such types.  This mechanism is also used to create "fat
537    pointers" for unconstrained array types in Ada; the fat pointer is a
538    structure one of whose fields is a pointer to the actual array type
539    and the other field is a pointer to a template, which is a structure
540    containing the bounds of the array.  The bounds in the type pointed
541    to by the first field in the fat pointer refer to the values in the
542    template.
543
544    When you wish to construct such a type you need "self-references"
545    that allow you to reference the object having this type from the
546    TYPE node, i.e. without having a variable instantiating this type.
547
548    Such a "self-references" is done using a PLACEHOLDER_EXPR.  This is
549    a node that will later be replaced with the object being referenced.
550    Its type is that of the object and selects which object to use from
551    a chain of references (see below).  No other slots are used in the
552    PLACEHOLDER_EXPR.
553
554    For example, if your type FOO is a RECORD_TYPE with a field BAR,
555    and you need the value of <variable>.BAR to calculate TYPE_SIZE
556    (FOO), just substitute <variable> above with a PLACEHOLDER_EXPR
557    whose TREE_TYPE is FOO.  Then construct your COMPONENT_REF with
558    the PLACEHOLDER_EXPR as the first operand (which has the correct
559    type).  Later, when the size is needed in the program, the back-end
560    will find this PLACEHOLDER_EXPR and generate code to calculate the
561    actual size at run-time.  In the following, we describe how this
562    calculation is done.
563
564    When we wish to evaluate a size or offset, we check whether it contains a
565    PLACEHOLDER_EXPR.  If it does, we call substitute_placeholder_in_expr
566    passing both that tree and an expression within which the object may be
567    found.  The latter expression is the object itself in the simple case of
568    an Ada record with discriminant, but it can be the array in the case of an
569    unconstrained array.
570
571    In the latter case, we need the fat pointer, because the bounds of
572    the array can only be accessed from it.  However, we rely here on the
573    fact that the expression for the array contains the dereference of
574    the fat pointer that obtained the array pointer.  */
575
576 /* Denotes a record to later be substituted before evaluating this expression.
577    The type of this expression is used to find the record to replace it.  */
578 DEFTREECODE (PLACEHOLDER_EXPR, "placeholder_expr", 'x', 0)
579
580 /* Simple arithmetic.  */
581 DEFTREECODE (PLUS_EXPR, "plus_expr", '2', 2)
582 DEFTREECODE (MINUS_EXPR, "minus_expr", '2', 2)
583 DEFTREECODE (MULT_EXPR, "mult_expr", '2', 2)
584
585 /* Division for integer result that rounds the quotient toward zero.  */
586 DEFTREECODE (TRUNC_DIV_EXPR, "trunc_div_expr", '2', 2)
587
588 /* Division for integer result that rounds the quotient toward infinity.  */
589 DEFTREECODE (CEIL_DIV_EXPR, "ceil_div_expr", '2', 2)
590
591 /* Division for integer result that rounds toward minus infinity.  */
592 DEFTREECODE (FLOOR_DIV_EXPR, "floor_div_expr", '2', 2)
593
594 /* Division for integer result that rounds toward nearest integer.  */
595 DEFTREECODE (ROUND_DIV_EXPR, "round_div_expr", '2', 2)
596
597 /* Four kinds of remainder that go with the four kinds of division.  */
598 DEFTREECODE (TRUNC_MOD_EXPR, "trunc_mod_expr", '2', 2)
599 DEFTREECODE (CEIL_MOD_EXPR, "ceil_mod_expr", '2', 2)
600 DEFTREECODE (FLOOR_MOD_EXPR, "floor_mod_expr", '2', 2)
601 DEFTREECODE (ROUND_MOD_EXPR, "round_mod_expr", '2', 2)
602
603 /* Division for real result.  */
604 DEFTREECODE (RDIV_EXPR, "rdiv_expr", '2', 2)
605
606 /* Division which is not supposed to need rounding.
607    Used for pointer subtraction in C.  */
608 DEFTREECODE (EXACT_DIV_EXPR, "exact_div_expr", '2', 2)
609
610 /* Conversion of real to fixed point: four ways to round,
611    like the four ways to divide.
612    CONVERT_EXPR can also be used to convert a real to an integer,
613    and that is what is used in languages that do not have ways of
614    specifying which of these is wanted.  Maybe these are not needed.  */
615 DEFTREECODE (FIX_TRUNC_EXPR, "fix_trunc_expr", '1', 1)
616 DEFTREECODE (FIX_CEIL_EXPR, "fix_ceil_expr", '1', 1)
617 DEFTREECODE (FIX_FLOOR_EXPR, "fix_floor_expr", '1', 1)
618 DEFTREECODE (FIX_ROUND_EXPR, "fix_round_expr", '1', 1)
619
620 /* Conversion of an integer to a real.  */
621 DEFTREECODE (FLOAT_EXPR, "float_expr", '1', 1)
622
623 /* Unary negation.  */
624 DEFTREECODE (NEGATE_EXPR, "negate_expr", '1', 1)
625
626 DEFTREECODE (MIN_EXPR, "min_expr", '2', 2)
627 DEFTREECODE (MAX_EXPR, "max_expr", '2', 2)
628
629 /* Represents the absolute value of the operand.
630
631    An ABS_EXPR must have either an INTEGER_TYPE or a REAL_TYPE.  The
632    operand of the ABS_EXPR must have the same type.  */
633 DEFTREECODE (ABS_EXPR, "abs_expr", '1', 1)
634
635 /* Shift operations for shift and rotate.
636    Shift means logical shift if done on an
637    unsigned type, arithmetic shift if done on a signed type.
638    The second operand is the number of bits to
639    shift by; it need not be the same type as the first operand and result.
640    Note that the result is undefined if the second operand is larger
641    than the first operand's type size.  */
642 DEFTREECODE (LSHIFT_EXPR, "lshift_expr", '2', 2)
643 DEFTREECODE (RSHIFT_EXPR, "rshift_expr", '2', 2)
644 DEFTREECODE (LROTATE_EXPR, "lrotate_expr", '2', 2)
645 DEFTREECODE (RROTATE_EXPR, "rrotate_expr", '2', 2)
646
647 /* Bitwise operations.  Operands have same mode as result.  */
648 DEFTREECODE (BIT_IOR_EXPR, "bit_ior_expr", '2', 2)
649 DEFTREECODE (BIT_XOR_EXPR, "bit_xor_expr", '2', 2)
650 DEFTREECODE (BIT_AND_EXPR, "bit_and_expr", '2', 2)
651 DEFTREECODE (BIT_NOT_EXPR, "bit_not_expr", '1', 1)
652
653 /* ANDIF and ORIF allow the second operand not to be computed if the
654    value of the expression is determined from the first operand.  AND,
655    OR, and XOR always compute the second operand whether its value is
656    needed or not (for side effects).  The operand may have
657    BOOLEAN_TYPE or INTEGER_TYPE.  In either case, the argument will be
658    either zero or one.  For example, a TRUTH_NOT_EXPR will never have
659    an INTEGER_TYPE VAR_DECL as its argument; instead, a NE_EXPR will be
660    used to compare the VAR_DECL to zero, thereby obtaining a node with
661    value zero or one.  */
662 DEFTREECODE (TRUTH_ANDIF_EXPR, "truth_andif_expr", 'e', 2)
663 DEFTREECODE (TRUTH_ORIF_EXPR, "truth_orif_expr", 'e', 2)
664 DEFTREECODE (TRUTH_AND_EXPR, "truth_and_expr", 'e', 2)
665 DEFTREECODE (TRUTH_OR_EXPR, "truth_or_expr", 'e', 2)
666 DEFTREECODE (TRUTH_XOR_EXPR, "truth_xor_expr", 'e', 2)
667 DEFTREECODE (TRUTH_NOT_EXPR, "truth_not_expr", 'e', 1)
668
669 /* Relational operators.
670    `EQ_EXPR' and `NE_EXPR' are allowed for any types.
671    The others are allowed only for integer (or pointer or enumeral)
672    or real types.
673    In all cases the operands will have the same type,
674    and the value is always the type used by the language for booleans.  */
675 DEFTREECODE (LT_EXPR, "lt_expr", '<', 2)
676 DEFTREECODE (LE_EXPR, "le_expr", '<', 2)
677 DEFTREECODE (GT_EXPR, "gt_expr", '<', 2)
678 DEFTREECODE (GE_EXPR, "ge_expr", '<', 2)
679 DEFTREECODE (EQ_EXPR, "eq_expr", '<', 2)
680 DEFTREECODE (NE_EXPR, "ne_expr", '<', 2)
681
682 /* Additional relational operators for floating point unordered.  */
683 DEFTREECODE (UNORDERED_EXPR, "unordered_expr", '<', 2)
684 DEFTREECODE (ORDERED_EXPR, "ordered_expr", '<', 2)
685
686 /* These are equivalent to unordered or ...  */
687 DEFTREECODE (UNLT_EXPR, "unlt_expr", '<', 2)
688 DEFTREECODE (UNLE_EXPR, "unle_expr", '<', 2)
689 DEFTREECODE (UNGT_EXPR, "ungt_expr", '<', 2)
690 DEFTREECODE (UNGE_EXPR, "unge_expr", '<', 2)
691 DEFTREECODE (UNEQ_EXPR, "uneq_expr", '<', 2)
692
693 /* This is the reverse of uneq_expr.  */
694 DEFTREECODE (LTGT_EXPR, "ltgt_expr", '<', 2)
695
696 /* Operations for Pascal sets.  Not used now.  */
697 DEFTREECODE (IN_EXPR, "in_expr", '2', 2)
698 DEFTREECODE (SET_LE_EXPR, "set_le_expr", '<', 2)
699 DEFTREECODE (CARD_EXPR, "card_expr", '1', 1)
700 DEFTREECODE (RANGE_EXPR, "range_expr", '2', 2)
701
702 /* Represents a conversion of type of a value.
703    All conversions, including implicit ones, must be
704    represented by CONVERT_EXPR or NOP_EXPR nodes.  */
705 DEFTREECODE (CONVERT_EXPR, "convert_expr", '1', 1)
706
707 /* Represents a conversion expected to require no code to be generated.  */
708 DEFTREECODE (NOP_EXPR, "nop_expr", '1', 1)
709
710 /* Value is same as argument, but guaranteed not an lvalue.  */
711 DEFTREECODE (NON_LVALUE_EXPR, "non_lvalue_expr", '1', 1)
712
713 /* Represents viewing something of one type as being of a second type.
714    This corresponds to an "Unchecked Conversion" in Ada and roughly to
715    the idiom *(type2 *)&X in C.  The only operand is the value to be
716    viewed as being of another type.  It is undefined if the type of the
717    input and of the expression have different sizes.
718
719    This code may also be used within the LHS of a MODIFY_EXPR, in which
720    case no actual data motion may occur.  TREE_ADDRESSABLE will be set in
721    this case and GCC must abort if it could not do the operation without
722    generating insns.  */
723 DEFTREECODE (VIEW_CONVERT_EXPR, "view_convert_expr", '1', 1)
724
725 /* Represents something we computed once and will use multiple times.
726    First operand is that expression.  After it is evaluated once, it
727    will be replaced by the temporary variable that holds the value.  */
728 DEFTREECODE (SAVE_EXPR, "save_expr", 'e', 1)
729
730 /* For a UNSAVE_EXPR, operand 0 is the value to unsave.  By unsave, we
731    mean that all _EXPRs such as TARGET_EXPRs, SAVE_EXPRs, CALL_EXPRs,
732    that are protected from being evaluated more than once should be
733    reset so that a new expand_expr call of this expr will cause those
734    to be re-evaluated.  This is useful when we want to reuse a tree in
735    different places, but where we must re-expand.  */
736 DEFTREECODE (UNSAVE_EXPR, "unsave_expr", 'e', 1)
737
738 /* & in C.  Value is the address at which the operand's value resides.
739    Operand may have any mode.  Result mode is Pmode.  */
740 DEFTREECODE (ADDR_EXPR, "addr_expr", 'e', 1)
741
742 /* Operand is a function constant; result is a function variable value
743    of type EPmode.  Used only for languages that need static chains.  */
744 DEFTREECODE (ENTRY_VALUE_EXPR, "entry_value_expr", 'e', 1)
745
746 /* Operand0 is a function constant; result is part N of a function 
747    descriptor of type ptr_mode.  */
748 DEFTREECODE (FDESC_EXPR, "fdesc_expr", 'e', 2)
749
750 /* Given two real or integer operands of the same type,
751    returns a complex value of the corresponding complex type.  */
752 DEFTREECODE (COMPLEX_EXPR, "complex_expr", '2', 2)
753
754 /* Complex conjugate of operand.  Used only on complex types.  */
755 DEFTREECODE (CONJ_EXPR, "conj_expr", '1', 1)
756
757 /* Used only on an operand of complex type, these return
758    a value of the corresponding component type.  */
759 DEFTREECODE (REALPART_EXPR, "realpart_expr", 'r', 1)
760 DEFTREECODE (IMAGPART_EXPR, "imagpart_expr", 'r', 1)
761
762 /* Nodes for ++ and -- in C.
763    The second arg is how much to increment or decrement by.
764    For a pointer, it would be the size of the object pointed to.  */
765 DEFTREECODE (PREDECREMENT_EXPR, "predecrement_expr", 'e', 2)
766 DEFTREECODE (PREINCREMENT_EXPR, "preincrement_expr", 'e', 2)
767 DEFTREECODE (POSTDECREMENT_EXPR, "postdecrement_expr", 'e', 2)
768 DEFTREECODE (POSTINCREMENT_EXPR, "postincrement_expr", 'e', 2)
769
770 /* Used to implement `va_arg'.  */
771 DEFTREECODE (VA_ARG_EXPR, "va_arg_expr", 'e', 1)
772
773 /* Evaluate operand 1.  If and only if an exception is thrown during
774    the evaluation of operand 1, evaluate operand 2.
775
776    This differs from TRY_FINALLY_EXPR in that operand 2 is not evaluated
777    on a normal or jump exit, only on an exception.  */
778 DEFTREECODE (TRY_CATCH_EXPR, "try_catch_expr", 's', 2)
779
780 /* Evaluate the first operand.
781    The second operand is a cleanup expression which is evaluated
782    on any exit (normal, exception, or jump out) from this expression.  */
783 DEFTREECODE (TRY_FINALLY_EXPR, "try_finally", 's', 2)
784 \f
785 /* These types of expressions have no useful value,
786    and always have side effects.  */
787
788 /* Used to represent a local declaration. The operand is DECL_EXPR_DECL.  */
789 DEFTREECODE (DECL_EXPR, "decl_expr", 's', 1)
790
791 /* A label definition, encapsulated as a statement.
792    Operand 0 is the LABEL_DECL node for the label that appears here.
793    The type should be void and the value should be ignored.  */
794 DEFTREECODE (LABEL_EXPR, "label_expr", 's', 1)
795
796 /* GOTO.  Operand 0 is a LABEL_DECL node or an expression.
797    The type should be void and the value should be ignored.  */
798 DEFTREECODE (GOTO_EXPR, "goto_expr", 's', 1)
799
800 /* Used internally for cleanups in the implementation of TRY_FINALLY_EXPR.
801    (Specifically, it is created by expand_expr, not front-ends.)
802    Operand 0 is the rtx for the start of the subroutine we need to call.
803    Operand 1 is the rtx for a variable in which to store the address
804    of where the subroutine should return to.  */
805 DEFTREECODE (GOTO_SUBROUTINE_EXPR, "goto_subroutine", 's', 2)
806
807 /* RETURN.  Evaluates operand 0, then returns from the current function.
808    Presumably that operand is an assignment that stores into the
809    RESULT_DECL that hold the value to be returned.
810    The operand may be null.
811    The type should be void and the value should be ignored.  */
812 DEFTREECODE (RETURN_EXPR, "return_expr", 's', 1)
813
814 /* Exit the inner most loop conditionally.  Operand 0 is the condition.
815    The type should be void and the value should be ignored.  */
816 DEFTREECODE (EXIT_EXPR, "exit_expr", 's', 1)
817
818 /* A loop.  Operand 0 is the body of the loop.
819    It must contain an EXIT_EXPR or is an infinite loop.
820    The type should be void and the value should be ignored.  */
821 DEFTREECODE (LOOP_EXPR, "loop_expr", 's', 1)
822
823 /* Exit a labeled block, possibly returning a value.  Operand 0 is a
824    LABELED_BLOCK_EXPR to exit.  Operand 1 is the value to return. It
825    may be left null.  */
826 DEFTREECODE (EXIT_BLOCK_EXPR, "exit_block_expr", 's', 2)
827
828 /* Switch expression.
829
830    TREE_TYPE is the original type of the condition, before any
831    language required type conversions.  It may be NULL, in which case
832    the original type and final types are assumed to be the same.
833
834    Operand 0 is the expression used to perform the branch,
835    Operand 1 is the body of the switch, which probably contains
836      CASE_LABEL_EXPRs.  It may also be NULL, in which case operand 2
837      must not be NULL.
838    Operand 2 is either NULL_TREE or a TREE_VEC of the CASE_LABEL_EXPRs
839      of all the cases.  */
840 DEFTREECODE (SWITCH_EXPR, "switch_expr", 's', 3)
841
842 /* Used to represent a case label. The operands are CASE_LOW and
843    CASE_HIGH, respectively. If CASE_LOW is NULL_TREE, the label is a
844    'default' label. If CASE_HIGH is NULL_TREE, the label is a normal case
845    label.  CASE_LABEL is the corresponding LABEL_DECL.  */
846 DEFTREECODE (CASE_LABEL_EXPR, "case_label_expr", 's', 3)
847
848 /* RESX.  Resume execution after an exception.  Operand 0 is a 
849    number indicating the exception region that is being left.  */
850 DEFTREECODE (RESX_EXPR, "resx_expr", 's', 1)
851
852 /* Used to represent an inline assembly statement.  ASM_STRING returns a
853    STRING_CST for the instruction (e.g., "mov x, y"). ASM_OUTPUTS,
854    ASM_INPUTS, and ASM_CLOBBERS represent the outputs, inputs, and clobbers
855    for the statement.  */
856 DEFTREECODE (ASM_EXPR, "asm_expr", 's', 4)
857
858 /* Variable references for SSA analysis.  New SSA names are created every
859    time a variable is assigned a new value.  The SSA builder uses SSA_NAME
860    nodes to implement SSA versioning.  */
861 DEFTREECODE (SSA_NAME, "ssa_name", 'x', 0)
862
863 /* SSA PHI operator.  PHI_RESULT is the new SSA_NAME node created by
864    the PHI node.  PHI_ARG_LENGTH is the number of arguments.
865    PHI_ARG_ELT returns the Ith tuple <ssa_name, edge> from the
866    argument list.  Each tuple contains the incoming reaching
867    definition (SSA_NAME node) and the edge via which that definition
868    is coming through.   */
869 DEFTREECODE (PHI_NODE, "phi_node", 'x', 0)
870
871 /* Used to represent a typed exception handler.  CATCH_TYPES is the type (or
872    list of types) handled, and CATCH_BODY is the code for the handler.  */
873 DEFTREECODE (CATCH_EXPR, "catch_expr", 's', 2)
874
875 /* Used to represent an exception specification.  EH_FILTER_TYPES is a list
876    of allowed types, and EH_FILTER_FAILURE is an expression to evaluate on
877    failure.  EH_FILTER_MUST_NOT_THROW controls which range type to use when
878    expanding.  */
879 DEFTREECODE (EH_FILTER_EXPR, "eh_filter_expr", 's', 2)
880
881 /* Node used for describing a property that is known at compile
882    time.  */
883 DEFTREECODE (SCEV_KNOWN, "scev_known", 'e', 0)
884
885 /* Node used for describing a property that is not known at compile
886    time.  */
887 DEFTREECODE (SCEV_NOT_KNOWN, "scev_not_known", 'e', 0)
888
889 /* Polynomial chains of recurrences.
890    Under the form: cr = {CHREC_LEFT (cr), +, CHREC_RIGHT (cr)}.  */
891 DEFTREECODE (POLYNOMIAL_CHREC, "polynomial_chrec", 'e', 3)
892
893 /* Used to chain children of container statements together.
894    Use the interface in tree-iterator.h to access this node.  */
895 DEFTREECODE (STATEMENT_LIST, "statement_list", 'x', 0)
896
897 /* Value handles.  Artificial nodes to represent expressions in
898    partial redundancy elimination (tree-ssa-pre.c).  These nodes are
899    used for expression canonicalization.  If two expressions compute
900    the same value, they will be assigned the same value handle.  */
901 DEFTREECODE (VALUE_HANDLE, "value_handle", 'x', 0)
902
903 /* Base class information. Holds information about a class as a
904    baseclass of itself or another class.  */
905 DEFTREECODE (TREE_BINFO, "tree_binfo", 'x', 0)
906
907 /*
908 Local variables:
909 mode:c
910 End:
911 */