c-decl.c: Fix typos in several comments.
[platform/upstream/gcc.git] / gcc / c-tree.h
1 /* Definitions for C parsing and type checking.
2    Copyright (C) 1987, 1993, 1994, 1995, 1997, 1998,
3    1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
21
22 #ifndef GCC_C_TREE_H
23 #define GCC_C_TREE_H
24
25 #include "c-common.h"
26
27 /* Language-dependent contents of an identifier.  */
28
29 /* The limbo_value is used for block level extern declarations, which need
30    to be type checked against subsequent extern declarations.  They can't
31    be referenced after they fall out of scope, so they can't be global.
32
33    The rid_code field is used for keywords.  It is in all
34    lang_identifier nodes, because some keywords are only special in a
35    particular context.  */
36
37 struct lang_identifier GTY(())
38 {
39   struct c_common_identifier common_id;
40   tree symbol_value;
41   tree tag_value;
42   tree label_value;
43 };
44
45 /* The resulting tree type.  */
46
47 union lang_tree_node 
48   GTY((desc ("TREE_CODE (&%h.generic) == IDENTIFIER_NODE"),
49        chain_next ("TREE_CODE (&%h.generic) == INTEGER_TYPE ? (union lang_tree_node *)TYPE_NEXT_VARIANT (&%h.generic) : (union lang_tree_node *)TREE_CHAIN (&%h.generic)")))
50 {
51   union tree_node GTY ((tag ("0"), 
52                         desc ("tree_node_structure (&%h)"))) 
53     generic;
54   struct lang_identifier GTY ((tag ("1"))) identifier;
55 };
56
57 /* Language-specific declaration information.  */
58
59 struct lang_decl GTY(())
60 {
61   struct c_lang_decl base;
62   /* The return types and parameter types may have variable size.
63      This is a list of any SAVE_EXPRs that need to be evaluated to
64      compute those sizes.  */
65   tree pending_sizes;
66 };
67
68 /* Macros for access to language-specific slots in an identifier.  */
69 /* Each of these slots contains a DECL node or null.  */
70
71 /* The value of the identifier in the namespace of "ordinary identifiers"
72    (data objects, enum constants, functions, typedefs).  */
73 #define IDENTIFIER_SYMBOL_VALUE(NODE)   \
74   (((struct lang_identifier *) (NODE))->symbol_value)
75 /* The value of the identifier in the namespace of struct, union,
76    and enum tags.  */
77 #define IDENTIFIER_TAG_VALUE(NODE)      \
78   (((struct lang_identifier *) (NODE))->tag_value)
79 /* The value of the identifier in the namespace of labels.  */
80 #define IDENTIFIER_LABEL_VALUE(NODE)    \
81   (((struct lang_identifier *) (NODE))->label_value)
82
83 /* In identifiers, C uses the following fields in a special way:
84    TREE_PUBLIC        to record that there was a previous local extern decl.
85    TREE_USED          to record that such a decl was used.
86    TREE_ADDRESSABLE   to record that the address of such a decl was used.  */
87
88 /* In a RECORD_TYPE or UNION_TYPE, nonzero if any component is read-only.  */
89 #define C_TYPE_FIELDS_READONLY(TYPE) TREE_LANG_FLAG_1 (TYPE)
90
91 /* In a RECORD_TYPE or UNION_TYPE, nonzero if any component is volatile.  */
92 #define C_TYPE_FIELDS_VOLATILE(TYPE) TREE_LANG_FLAG_2 (TYPE)
93
94 /* In a RECORD_TYPE or UNION_TYPE or ENUMERAL_TYPE
95    nonzero if the definition of the type has already started.  */
96 #define C_TYPE_BEING_DEFINED(TYPE) TYPE_LANG_FLAG_0 (TYPE)
97
98 /* In an IDENTIFIER_NODE, nonzero if this identifier is actually a
99    keyword.  C_RID_CODE (node) is then the RID_* value of the keyword,
100    and C_RID_YYCODE is the token number wanted by Yacc.  */
101 #define C_IS_RESERVED_WORD(ID) TREE_LANG_FLAG_0 (ID)
102
103 /* This function was declared inline.  This flag controls the linkage
104    semantics of 'inline'; whether or not the function is inlined is
105    controlled by DECL_INLINE.  */
106 #define DECL_DECLARED_INLINE_P(NODE) \
107   (DECL_LANG_SPECIFIC (NODE)->base.declared_inline)
108
109 /* In a RECORD_TYPE, a sorted array of the fields of the type.  */
110 struct lang_type GTY(())
111 {
112   struct sorted_fields_type * GTY ((reorder ("resort_sorted_fields"))) s; 
113 };
114
115 /* Record whether a type or decl was written with nonconstant size.
116    Note that TYPE_SIZE may have simplified to a constant.  */
117 #define C_TYPE_VARIABLE_SIZE(TYPE) TYPE_LANG_FLAG_1 (TYPE)
118 #define C_DECL_VARIABLE_SIZE(TYPE) DECL_LANG_FLAG_0 (TYPE)
119
120 /* Store a value in that field.  */
121 #define C_SET_EXP_ORIGINAL_CODE(EXP, CODE) \
122   (TREE_COMPLEXITY (EXP) = (int) (CODE))
123
124 /* Record whether a typedef for type `int' was actually `signed int'.  */
125 #define C_TYPEDEF_EXPLICITLY_SIGNED(EXP) DECL_LANG_FLAG_1 (EXP)
126
127 /* For a FUNCTION_DECL, nonzero if it was defined without an explicit
128    return type.  */
129 #define C_FUNCTION_IMPLICIT_INT(EXP) DECL_LANG_FLAG_1 (EXP)
130
131 /* For a FUNCTION_DECL, nonzero if it was an implicit declaration.  */
132 #define C_DECL_IMPLICIT(EXP) DECL_LANG_FLAG_2 (EXP)
133
134 /* Nonzero for a declaration of an external object which is not
135    currently in scope.  This is either a built-in declaration of
136    a library function, before a real declaration has been seen,
137    or a declaration that appeared in an inner scope that has ended.  */
138 #define C_DECL_INVISIBLE(EXP) DECL_LANG_FLAG_3 (EXP)
139
140 /* Nonzero for a decl which either doesn't exist or isn't a prototype.
141    N.B. Could be simplified if all built-in decls had complete prototypes
142    (but this is presently difficult because some of them need FILE*).  */
143 #define C_DECL_ISNT_PROTOTYPE(EXP)                      \
144        (EXP == 0                                        \
145         || (TYPE_ARG_TYPES (TREE_TYPE (EXP)) == 0       \
146             && !DECL_BUILT_IN (EXP)))
147
148 /* Nonzero for a decl which is at file scope.  */
149 #define C_DECL_FILE_SCOPE(EXP)                                  \
150   (! DECL_CONTEXT (EXP)                                         \
151    || TREE_CODE (DECL_CONTEXT (EXP)) == TRANSLATION_UNIT_DECL)
152
153 /* For FUNCTION_TYPE, a hidden list of types of arguments.  The same as
154    TYPE_ARG_TYPES for functions with prototypes, but created for functions
155    without prototypes.  */
156 #define TYPE_ACTUAL_ARG_TYPES(NODE) TYPE_BINFO (NODE)
157
158 \f
159 /* in c-lang.c and objc-act.c */
160 extern tree lookup_interface (tree);
161 extern tree is_class_name (tree);
162 extern tree objc_is_id (tree);
163 extern void objc_check_decl (tree);
164 extern int objc_comptypes (tree, tree, int);
165 extern tree objc_message_selector (void);
166 extern tree lookup_objc_ivar (tree);
167 extern void c_expand_body (tree);
168
169 \f
170 /* in c-parse.in */
171 extern void c_parse_init (void);
172
173 /* in c-aux-info.c */
174 extern void gen_aux_info_record (tree, int, int, int);
175
176 /* in c-decl.c */
177 extern int global_bindings_p (void);
178 extern int kept_level_p (void);
179 extern tree getdecls (void);
180 extern void pushlevel (int);
181 extern void insert_block (tree);
182 extern void set_block (tree);
183 extern tree pushdecl (tree);
184
185 extern void c_insert_default_attributes (tree);
186 extern void c_init_decl_processing (void);
187 extern void c_dup_lang_specific_decl (tree);
188 extern void c_print_identifier (FILE *, tree, int);
189 extern tree build_array_declarator (tree, tree, int, int);
190 extern tree build_enumerator (tree, tree);
191 extern void check_for_loop_decls (void);
192 extern void clear_parm_order (void);
193 extern int  complete_array_type (tree, tree, int);
194 extern void declare_parm_level (void);
195 extern tree define_label (location_t, tree);
196 extern void finish_decl (tree, tree, tree);
197 extern tree finish_enum (tree, tree, tree);
198 extern void finish_function (int, int);
199 extern tree finish_struct (tree, tree, tree);
200 extern tree get_parm_info (int);
201 extern tree grokfield (tree, tree, tree);
202 extern tree groktypename (tree);
203 extern tree groktypename_in_parm_context (tree);
204 extern tree implicitly_declare (tree);
205 extern int  in_parm_level_p (void);
206 extern void keep_next_level (void);
207 extern tree lookup_name (tree);
208 extern void parmlist_tags_warning (void);
209 extern void pending_xref_error (void);
210 extern void c_push_function_context (struct function *);
211 extern void c_pop_function_context (struct function *);
212 extern void pop_label_level (void);
213 extern void push_label_level (void);
214 extern void push_parm_decl (tree);
215 extern tree pushdecl_top_level (tree);
216 extern tree pushdecl_function_level (tree, tree);
217 extern void pushtag (tree, tree);
218 extern tree set_array_declarator_type (tree, tree, int);
219 extern tree shadow_label (tree);
220 extern void shadow_tag (tree);
221 extern void shadow_tag_warned (tree, int);
222 extern tree start_enum (tree);
223 extern int  start_function (tree, tree, tree);
224 extern tree start_decl (tree, tree, int, tree);
225 extern tree start_struct (enum tree_code, tree);
226 extern void store_parm_decls (void);
227 extern tree xref_tag (enum tree_code, tree);
228 extern tree c_begin_compound_stmt (void);
229 extern void c_expand_deferred_function (tree);
230 extern void c_expand_decl_stmt (tree);
231 extern tree make_pointer_declarator (tree, tree);
232 extern void merge_translation_unit_decls (void);
233
234 /* in c-objc-common.c */
235 extern int c_disregard_inline_limits (tree);
236 extern int c_cannot_inline_tree_fn (tree *);
237 extern bool c_objc_common_init (void);
238 extern int c_missing_noreturn_ok_p (tree);
239 extern void c_objc_common_finish_file (void);
240 extern int defer_fn (tree);
241 extern bool c_warn_unused_global_decl (tree);
242
243 #define c_build_type_variant(TYPE, CONST_P, VOLATILE_P)           \
244   c_build_qualified_type ((TYPE),                                 \
245                           ((CONST_P) ? TYPE_QUAL_CONST : 0) |     \
246                           ((VOLATILE_P) ? TYPE_QUAL_VOLATILE : 0))
247
248 #define c_sizeof_nowarn(T)  c_sizeof_or_alignof_type (T, SIZEOF_EXPR, 0)
249
250 /* in c-typeck.c */
251
252 /* For use with comptypes.  */
253 enum {
254   COMPARE_STRICT = 0,
255   COMPARE_DIFFERENT_TU = 1
256 };
257
258 extern tree require_complete_type (tree);
259 extern int comptypes (tree, tree, int);
260 extern tree c_size_in_bytes (tree);
261 extern bool c_mark_addressable (tree);
262 extern void c_incomplete_type_error (tree, tree);
263 extern tree c_type_promotes_to (tree);
264 extern tree build_component_ref (tree, tree);
265 extern tree build_indirect_ref (tree, const char *);
266 extern tree build_array_ref (tree, tree);
267 extern tree build_external_ref (tree, int);
268 extern tree parser_build_binary_op (enum tree_code, tree, tree);
269 extern int c_tree_expr_nonnegative_p (tree);
270 extern void readonly_warning (tree, const char *);
271 extern tree build_conditional_expr (tree, tree, tree);
272 extern tree build_compound_expr (tree);
273 extern tree c_cast_expr (tree, tree);
274 extern tree build_c_cast (tree, tree);
275 extern tree build_modify_expr (tree, enum tree_code, tree);
276 extern void store_init_value (tree, tree);
277 extern void error_init (const char *);
278 extern void pedwarn_init (const char *);
279 extern void start_init (tree, tree, int);
280 extern void finish_init (void);
281 extern void really_start_incremental_init (tree);
282 extern void push_init_level (int);
283 extern tree pop_init_level (int);
284 extern void set_init_index (tree, tree);
285 extern void set_init_label (tree);
286 extern void process_init_element (tree);
287 extern tree build_compound_literal (tree, tree);
288 extern void pedwarn_c99 (const char *, ...) ATTRIBUTE_PRINTF_1;
289 extern tree c_start_case (tree);
290 extern void c_finish_case (void);
291 extern tree simple_asm_stmt (tree);
292 extern tree build_asm_stmt (tree, tree, tree, tree, tree);
293 extern tree c_convert_parm_for_inlining (tree, tree, tree);
294
295 /* Set to 0 at beginning of a function definition, set to 1 if
296    a return statement that specifies a return value is seen.  */
297
298 extern int current_function_returns_value;
299
300 /* Set to 0 at beginning of a function definition, set to 1 if
301    a return statement with no argument is seen.  */
302
303 extern int current_function_returns_null;
304
305 /* Set to 0 at beginning of a function definition, set to 1 if
306    a call to a noreturn function is seen.  */
307
308 extern int current_function_returns_abnormally;
309
310 /* Nonzero means we are reading code that came from a system header file.  */
311
312 extern int system_header_p;
313
314 /* In c-decl.c */
315 extern void c_finish_incomplete_decl (tree);
316 extern void c_write_global_declarations (void);
317
318 extern GTY(()) tree static_ctors;
319 extern GTY(()) tree static_dtors;
320
321 /* In order for the format checking to accept the C frontend
322    diagnostic framework extensions, you must include this file before
323    toplev.h, not after.  */
324 #define GCC_DIAG_STYLE __gcc_cdiag__
325
326 #endif /* ! GCC_C_TREE_H */