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