4f826ab053c19dac2def8ce156575e4ec41f17c3
[gcc.git] / gcc / cp / cp-tree.def
1 /* This file contains the definitions and documentation for the
2 additional tree codes used in the GNU C++ compiler (see tree.def
3 for the standard codes).
4 Copyright (C) 1987, 1988, 1990, 1993, 1997, 1998,
5 1999, 2000 Free Software Foundation, Inc.
6 Hacked by Michael Tiemann (tiemann@cygnus.com)
7
8 This file is part of GNU CC.
9
10 GNU CC is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2, or (at your option)
13 any later version.
14
15 GNU CC is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with GNU CC; see the file COPYING. If not, write to
22 the Free Software Foundation, 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
24
25
26 /* Reference to the contents of an offset
27 (a value whose type is an OFFSET_TYPE).
28 Operand 0 is the object within which the offset is taken.
29 Operand 1 is the offset. The language independent OFFSET_REF
30 just won't work for us. */
31 DEFTREECODE (OFFSET_REF, "offset_ref", 'r', 2)
32
33 /* A pointer-to-member constant. For a pointer-to-member constant
34 `X::Y' The PTRMEM_CST_CLASS is the RECORD_TYPE for `X' and the
35 PTRMEM_CST_MEMBER is the _DECL for `Y'. */
36 DEFTREECODE (PTRMEM_CST, "ptrmem_cst", 'c', 2)
37
38 /* For NEW_EXPR, operand 0 is the placement list.
39 Operand 1 is the new-declarator.
40 Operand 2 is the initializer. */
41 DEFTREECODE (NEW_EXPR, "nw_expr", 'e', 3)
42 DEFTREECODE (VEC_NEW_EXPR, "vec_nw_expr", 'e', 3)
43
44 /* For DELETE_EXPR, operand 0 is the store to be destroyed.
45 Operand 1 is the value to pass to the destroying function
46 saying whether the store should be deallocated as well. */
47 DEFTREECODE (DELETE_EXPR, "dl_expr", 'e', 2)
48 DEFTREECODE (VEC_DELETE_EXPR, "vec_dl_expr", 'e', 2)
49
50 /* Value is reference to particular overloaded class method.
51 Operand 0 is the class name (an IDENTIFIER_NODE);
52 operand 1 is the field (also an IDENTIFIER_NODE).
53 The COMPLEXITY field holds the class level (usually 0). */
54 DEFTREECODE (SCOPE_REF, "scope_ref", 'r', 2)
55
56 /* When composing an object with a member, this is the result.
57 Operand 0 is the object. Operand 1 is the member (usually
58 a dereferenced pointer to member). */
59 DEFTREECODE (MEMBER_REF, "member_ref", 'r', 2)
60
61 /* Type conversion operator in C++. TREE_TYPE is type that this
62 operator converts to. Operand is expression to be converted. */
63 DEFTREECODE (TYPE_EXPR, "type_expr", 'e', 1)
64
65 /* For AGGR_INIT_EXPR, operand 0 is function which performs initialization,
66 operand 1 is argument list to initialization function,
67 and operand 2 is the slot which was allocated for this expression. */
68 DEFTREECODE (AGGR_INIT_EXPR, "aggr_init_expr", 'e', 3)
69
70 /* A throw expression. operand 0 is the expression, if there was one,
71 else it is NULL_TREE. */
72 DEFTREECODE (THROW_EXPR, "throw_expr", 'e', 1)
73
74 /* An empty class object. The TREE_TYPE gives the class type. We use
75 these to avoid actually creating instances of the empty classes. */
76 DEFTREECODE (EMPTY_CLASS_EXPR, "empty_class_expr", 'e', 0)
77
78 /* Template definition. The following fields have the specified uses,
79 although there are other macros in cp-tree.h that should be used for
80 accessing this data.
81 DECL_ARGUMENTS template parm vector
82 DECL_TEMPLATE_INFO template text &c
83 DECL_VINDEX list of instantiations already produced;
84 only done for functions so far
85 For class template:
86 DECL_INITIAL associated templates (methods &c)
87 DECL_RESULT null
88 For non-class templates:
89 TREE_TYPE type of object to be constructed
90 DECL_RESULT decl for object to be created
91 (e.g., FUNCTION_DECL with tmpl parms used)
92 */
93 DEFTREECODE (TEMPLATE_DECL, "template_decl", 'd', 0)
94
95 /* Index into a template parameter list. The TEMPLATE_PARM_IDX gives
96 the index (from 0) of the parameter, while the TEMPLATE_PARM_LEVEL
97 gives the level (from 1) of the parameter.
98
99 Here's an example:
100
101 template <class T> // Index 0, Level 1.
102 struct S
103 {
104 template <class U, // Index 0, Level 2.
105 class V> // Index 1, Level 2.
106 void f();
107 };
108
109 The DESCENDANTS will be a chain of TEMPLATE_PARM_INDEXs descended
110 from this one. The first descendant will have the same IDX, but
111 its LEVEL will be one less. The TREE_CHAIN field is used to chain
112 together the descendants. The TEMPLATE_PARM_DECL is the
113 declaration of this parameter, either a TYPE_DECL or CONST_DECL.
114 The TEMPLATE_PARM_ORIG_LEVEL is the LEVEL of the most distant
115 parent, i.e., the LEVEL that the parameter originally had when it
116 was declared. For example, if we instantiate S<int>, we will have:
117
118 struct S<int>
119 {
120 template <class U, // Index 0, Level 1, Orig Level 2
121 class V> // Index 1, Level 1, Orig Level 2
122 void f();
123 };
124
125 The LEVEL is the level of the parameter when we are worrying about
126 the types of things; the ORIG_LEVEL is the level when we are
127 worrying about instantiating things. */
128 DEFTREECODE (TEMPLATE_PARM_INDEX, "template_parm_index", 'x',
129 /* The addition of (sizeof(tree) - 1) in the next expression
130 is to handle the case when padding pushes us past an even
131 multiple of sizeof(tree). */
132 /* We used to try to calculate this using
133 1+3*sizeof(HOST_WIDE_INT), but that fails if alignment
134 makes it bigger. */
135 ((sizeof (template_parm_index) - sizeof (struct tree_common))
136 + sizeof (tree) - 1)
137 / sizeof (tree))
138
139 /* Index into a template parameter list. This parameter must be a type.
140 The TYPE_FIELDS value will be a TEMPLATE_PARM_INDEX. */
141 DEFTREECODE (TEMPLATE_TYPE_PARM, "template_type_parm", 't', 0)
142
143 /* Index into a template parameter list. This parameter must be a type.
144 If it is used in signature of a template, TEMPLATE_INFO is NULL_TREE.
145 Otherwise it is used to declare a type like TT<int>.
146 The TYPE_FIELDS value will be a TEMPLATE_PARM_INDEX. */
147 DEFTREECODE (TEMPLATE_TEMPLATE_PARM, "template_template_parm", 't', 0)
148
149 /* A type designated by `typename T::t'. TYPE_CONTEXT is `T',
150 TYPE_NAME is an IDENTIFIER_NODE for `t'. If the type was named via
151 template-id, TYPENAME_TYPE_FULLNAME will hold the TEMPLATE_ID_EXPR.
152 If TREE_TYPE is present, this type was generated by the implicit
153 typename extension, and the TREE_TYPE is a _TYPE from a baseclass
154 of `T'. */
155 DEFTREECODE (TYPENAME_TYPE, "typename_type", 't', 0)
156
157 /* A type designated by `__typeof (expr)'. TYPE_FIELDS is the
158 expression in question. */
159 DEFTREECODE (TYPEOF_TYPE, "typeof_type", 't', 0)
160
161 /* A thunk is a stub function.
162
163 A THUNK_DECL is an alternate entry point for an ordinary
164 FUNCTION_DECL. It's job is to adjust the `this' poitner before
165 transferring control to the FUNCTION_DECL.
166
167 A thunk may perform either, or both, of the following operations:
168
169 o Adjust the `this' pointer by a constant offset.
170 o Adjust the `this' pointer by looking up a vcall-offset
171 in the vtable.
172
173 If both operations are performed, then the constant adjument to
174 `this' is performed first.
175
176 The constant adjustment is given by THUNK_DELTA. If the
177 vcall-offset is required, the index into the vtable is given by
178 THUNK_VCALL_OFFSET. */
179 DEFTREECODE (THUNK_DECL, "thunk_decl", 'd', 0)
180
181 /* A using declaration. DECL_INITIAL contains the specified scope.
182 This is not an alias, but is later expanded into multiple aliases. */
183 DEFTREECODE (USING_DECL, "using_decl", 'd', 0)
184
185 /* An un-parsed default argument. Looks like an IDENTIFIER_NODE. */
186 DEFTREECODE (DEFAULT_ARG, "default_arg", 'c', 2)
187
188 /* A template-id, like foo<int>. The first operand is the template.
189 The second is the TREE_LIST or TREE_VEC of explicitly specified
190 arguments. The template will be a FUNCTION_DECL, TEMPLATE_DECL, or
191 an OVERLOAD. If the template-id refers to a member template, the
192 template may be an IDENTIFIER_NODE. */
193 DEFTREECODE (TEMPLATE_ID_EXPR, "template_id_expr", 'e', 2)
194
195 /* An association between name and entity. Parameters are the scope
196 and the (non-type) value. TREE_TYPE indicates the type bound to
197 the name. */
198 DEFTREECODE (CPLUS_BINDING, "binding", 'x', 2)
199
200 /* A list-like node for chaining overloading candidates. TREE_TYPE is
201 the original name, and the parameter is the FUNCTION_DECL. */
202 DEFTREECODE (OVERLOAD, "overload", 'x', 1)
203
204 /* A generic wrapper for something not tree that we want to include in
205 tree structure. */
206 DEFTREECODE (WRAPPER, "wrapper", 'x', 1)
207
208 /* A node to remember a source position. */
209 DEFTREECODE (SRCLOC, "srcloc", 'x', 2)
210
211 /* Used to represent deferred name lookup for dependent names while
212 parsing a template declaration. The first argument is an
213 IDENTIFIER_NODE for the name in question. The TREE_TYPE is
214 unused. */
215 DEFTREECODE (LOOKUP_EXPR, "lookup_expr", 'e', 1)
216
217 /* Used to represent __PRETTY_FUNCTION__ in template bodies. */
218 DEFTREECODE (FUNCTION_NAME, "function_name", 'e', 0)
219
220 /* A whole bunch of tree codes for the initial, superficial parsing of
221 templates. */
222 DEFTREECODE (MODOP_EXPR, "modop_expr", 'e', 3)
223 DEFTREECODE (CAST_EXPR, "cast_expr", '1', 1)
224 DEFTREECODE (REINTERPRET_CAST_EXPR, "reinterpret_cast_expr", '1', 1)
225 DEFTREECODE (CONST_CAST_EXPR, "const_cast_expr", '1', 1)
226 DEFTREECODE (STATIC_CAST_EXPR, "static_cast_expr", '1', 1)
227 DEFTREECODE (DYNAMIC_CAST_EXPR, "dynamic_cast_expr", '1', 1)
228 DEFTREECODE (SIZEOF_EXPR, "sizeof_expr", '1', 1)
229 DEFTREECODE (ALIGNOF_EXPR, "alignof_expr", '1', 1)
230 DEFTREECODE (ARROW_EXPR, "arrow_expr", 'e', 1)
231 DEFTREECODE (DOTSTAR_EXPR, "dotstar_expr", 'e', 2)
232 DEFTREECODE (TYPEID_EXPR, "typeid_expr", 'e', 1)
233 DEFTREECODE (PSEUDO_DTOR_EXPR, "pseudo_dtor_expr", 'e', 3)
234
235 DEFTREECODE (EXPR_STMT, "expr_stmt", 'e', 1)
236 DEFTREECODE (COMPOUND_STMT, "compound_stmt", 'e', 1)
237 DEFTREECODE (DECL_STMT, "decl_stmt", 'e', 1)
238 DEFTREECODE (IF_STMT, "if_stmt", 'e', 3)
239 DEFTREECODE (FOR_STMT, "for_stmt", 'e', 4)
240 DEFTREECODE (WHILE_STMT, "while_stmt", 'e', 2)
241 DEFTREECODE (DO_STMT, "do_stmt", 'e', 2)
242 DEFTREECODE (RETURN_STMT, "return_stmt", 'e', 1)
243 DEFTREECODE (BREAK_STMT, "break_stmt", 'e', 0)
244 DEFTREECODE (CONTINUE_STMT, "continue_stmt", 'e', 0)
245 DEFTREECODE (SWITCH_STMT, "switch_stmt", 'e', 2)
246 DEFTREECODE (GOTO_STMT, "goto_stmt", 'e', 1)
247 DEFTREECODE (LABEL_STMT, "label_stmt", 'e', 1)
248 DEFTREECODE (ASM_STMT, "asm_stmt", 'e', 5)
249 /* A SUBOBJECT statement marks the point at which a sub-object is
250 fully constructed. After this point, the SUBOBJECT_CLEANUP must be
251 run if an exception is thrown before the end of the enclosing
252 function. */
253 DEFTREECODE (SUBOBJECT, "subobject", 'e', 1)
254 /* An CTOR_STMT marks the beginning (if CTOR_BEGIN_P holds) or end of
255 a contstructor (if CTOR_END_P) holds. At the end of a constructor,
256 the cleanups associated with any SUBOBJECT_CLEANUPS need no longer
257 be run. */
258 DEFTREECODE (CTOR_STMT, "ctor_stmt", 'e', 0)
259 /* A CLEANUP_STMT marks the point at which a declaration is fully
260 constructed. If, after this point, the CLEANUP_DECL goes out of
261 scope, the CLEANUP_EXPR must be run. */
262 DEFTREECODE (CLEANUP_STMT, "cleanup_stmt", 'e', 2)
263 /* A START_CATCH_STMT marks the beginning of a catch handler for the
264 the START_CATCH_TYPE. If this is CATCH_ALL_TYPE, then the handler
265 catches all types. */
266 DEFTREECODE (START_CATCH_STMT, "start_catch_stmt", 'e', 0)
267 /* A SCOPE_STMT marks the beginning or end of a scope. If
268 SCOPE_BEGIN_P holds, then this is the start of a scope. If
269 SCOPE_END_P holds, then this is the end of a scope. If
270 SCOPE_NULLIFIED_P holds then there turned out to be no variables in
271 this scope. The SCOPE_STMT_BLOCK is the BLOCK containing the
272 variables declared in this scope. */
273 DEFTREECODE (SCOPE_STMT, "scope_stmt", 'e', 1)
274 DEFTREECODE (CTOR_INITIALIZER, "ctor_initializer", 'e', 2)
275 DEFTREECODE (CASE_LABEL, "case_label", 'e', 2)
276 DEFTREECODE (RETURN_INIT, "return_init", 'e', 2)
277 DEFTREECODE (TRY_BLOCK, "try_block", 'e', 2)
278 DEFTREECODE (HANDLER, "handler", 'e', 2)
279
280 /* A STMT_EXPR represents a statement-expression. The
281 STMT_EXPR_STMT is the statement given by the expression. */
282 DEFTREECODE (STMT_EXPR, "stmt_expr", 'e', 1)
283
284 DEFTREECODE (TAG_DEFN, "tag_defn", 'e', 0)
285
286 /* And some codes for expressing conversions for overload resolution. */
287
288 DEFTREECODE (IDENTITY_CONV, "identity_conv", 'e', 1)
289 DEFTREECODE (LVALUE_CONV, "lvalue_conv", 'e', 1)
290 DEFTREECODE (QUAL_CONV, "qual_conv", 'e', 1)
291 DEFTREECODE (STD_CONV, "std_conv", 'e', 1)
292 DEFTREECODE (PTR_CONV, "ptr_conv", 'e', 1)
293 DEFTREECODE (PMEM_CONV, "pmem_conv", 'e', 1)
294 DEFTREECODE (BASE_CONV, "base_conv", 'e', 1)
295 DEFTREECODE (REF_BIND, "ref_bind", 'e', 1)
296 DEFTREECODE (USER_CONV, "user_conv", 'e', 2)
297 DEFTREECODE (AMBIG_CONV, "ambig_conv", 'e', 1)
298 DEFTREECODE (RVALUE_CONV, "rvalue_conv", 'e', 1)
299
300 /*
301 Local variables:
302 mode:c
303 End:
304 */