OSDN Git Service

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