]>
Commit | Line | Data |
---|---|---|
d23c55c2 | 1 | /* The lang_hooks data structure. |
0c20a65f | 2 | Copyright 2001, 2002, 2003 Free Software Foundation, Inc. |
69dcadff | 3 | |
63b025a5 | 4 | This file is part of GCC. |
69dcadff | 5 | |
63b025a5 | 6 | GCC is free software; you can redistribute it and/or modify |
69dcadff AO |
7 | it under the terms of the GNU General Public License as published by |
8 | the Free Software Foundation; either version 2, or (at your option) | |
9 | any later version. | |
10 | ||
63b025a5 | 11 | GCC is distributed in the hope that it will be useful, |
69dcadff AO |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
63b025a5 | 17 | along with GCC; see the file COPYING. If not, write to |
69dcadff AO |
18 | the Free Software Foundation, 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
20 | ||
21 | #ifndef GCC_LANG_HOOKS_H | |
22 | #define GCC_LANG_HOOKS_H | |
23 | ||
c9d892a8 NB |
24 | /* This file should be #include-d after tree.h. */ |
25 | ||
7cb32822 NB |
26 | struct diagnostic_context; |
27 | ||
5d69f816 | 28 | /* A print hook for print_tree (). */ |
0c20a65f | 29 | typedef void (*lang_print_tree_hook) (FILE *, tree, int indent); |
5d69f816 | 30 | |
d23c55c2 NB |
31 | /* The following hooks are documented in langhooks.c. Must not be |
32 | NULL. */ | |
33 | ||
34 | struct lang_hooks_for_tree_inlining | |
35 | { | |
bcda12f4 SB |
36 | tree (*walk_subtrees) (tree *, int *, |
37 | tree (*) (tree *, int *, void *), | |
38 | void *, void *); | |
39 | int (*cannot_inline_tree_fn) (tree *); | |
40 | int (*disregard_inline_limits) (tree); | |
41 | tree (*add_pending_fn_decls) (void *, tree); | |
42 | int (*tree_chain_matters_p) (tree); | |
43 | int (*auto_var_in_fn_p) (tree, tree); | |
44 | tree (*copy_res_decl_for_inlining) (tree, tree, tree, | |
45 | void *, int *, tree); | |
46 | int (*anon_aggr_type_p) (tree); | |
47 | bool (*var_mod_type_p) (tree); | |
48 | int (*start_inlining) (tree); | |
49 | void (*end_inlining) (tree); | |
50 | tree (*convert_parm_for_inlining) (tree, tree, tree); | |
51 | int (*estimate_num_insns) (tree); | |
d23c55c2 NB |
52 | }; |
53 | ||
e72fcfe8 JH |
54 | struct lang_hooks_for_callgraph |
55 | { | |
25c84396 RH |
56 | /* The node passed is a language-specific tree node. If its contents |
57 | are relevant to use of other declarations, mark them. */ | |
58 | tree (*analyze_expr) (tree *, int *, tree); | |
59 | ||
e72fcfe8 | 60 | /* Produce RTL for function passed as argument. */ |
bcda12f4 | 61 | void (*expand_function) (tree); |
e72fcfe8 JH |
62 | }; |
63 | ||
b03e38e1 NB |
64 | /* Lang hooks for management of language-specific data or status |
65 | when entering / leaving functions etc. */ | |
66 | struct lang_hooks_for_functions | |
67 | { | |
68 | /* Called when entering a function. */ | |
0c20a65f | 69 | void (*init) (struct function *); |
b03e38e1 NB |
70 | |
71 | /* Called when leaving a function. */ | |
0c20a65f | 72 | void (*final) (struct function *); |
b03e38e1 NB |
73 | |
74 | /* Called when entering a nested function. */ | |
0c20a65f | 75 | void (*enter_nested) (struct function *); |
b03e38e1 NB |
76 | |
77 | /* Called when leaving a nested function. */ | |
0c20a65f | 78 | void (*leave_nested) (struct function *); |
b03e38e1 NB |
79 | }; |
80 | ||
4985cde3 RH |
81 | /* Lang hooks for rtl code generation. */ |
82 | struct lang_hooks_for_rtl_expansion | |
83 | { | |
84 | /* Called after expand_function_start, but before expanding the body. */ | |
85 | void (*start) (void); | |
86 | ||
87 | /* Called to expand each statement. */ | |
88 | void (*stmt) (tree); | |
89 | ||
90 | /* Called after expanding the body but before expand_function_end. */ | |
91 | void (*end) (void); | |
92 | }; | |
93 | ||
89d684bb BM |
94 | /* The following hooks are used by tree-dump.c. */ |
95 | ||
96 | struct lang_hooks_for_tree_dump | |
97 | { | |
cc2902df | 98 | /* Dump language-specific parts of tree nodes. Returns nonzero if it |
89d684bb | 99 | does not want the usual dumping of the second argument. */ |
0c20a65f | 100 | bool (*dump_tree) (void *, tree); |
89d684bb BM |
101 | |
102 | /* Determine type qualifiers in a language-specific way. */ | |
0c20a65f | 103 | int (*type_quals) (tree); |
89d684bb BM |
104 | }; |
105 | ||
f1e639b1 NB |
106 | /* Hooks related to types. */ |
107 | ||
108 | struct lang_hooks_for_types | |
109 | { | |
b0c48229 NB |
110 | /* Return a new type (with the indicated CODE), doing whatever |
111 | language-specific processing is required. */ | |
0c20a65f | 112 | tree (*make_type) (enum tree_code); |
e11e816e | 113 | |
b0c48229 NB |
114 | /* Given MODE and UNSIGNEDP, return a suitable type-tree with that |
115 | mode. */ | |
0c20a65f | 116 | tree (*type_for_mode) (enum machine_mode, int); |
b0c48229 NB |
117 | |
118 | /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an | |
119 | integer type with at least that precision. */ | |
0c20a65f | 120 | tree (*type_for_size) (unsigned, int); |
ceef8ce4 NB |
121 | |
122 | /* Given an integer type T, return a type like T but unsigned. | |
123 | If T is unsigned, the value is T. */ | |
0c20a65f | 124 | tree (*unsigned_type) (tree); |
ceef8ce4 NB |
125 | |
126 | /* Given an integer type T, return a type like T but signed. | |
127 | If T is signed, the value is T. */ | |
0c20a65f | 128 | tree (*signed_type) (tree); |
ceef8ce4 NB |
129 | |
130 | /* Return a type the same as TYPE except unsigned or signed | |
131 | according to UNSIGNEDP. */ | |
0c20a65f | 132 | tree (*signed_or_unsigned_type) (int, tree); |
7a228918 | 133 | |
ab393bf1 NB |
134 | /* Given a type, apply default promotions to unnamed function |
135 | arguments and return the new type. Return the same type if no | |
136 | change. Required by any language that supports variadic | |
137 | arguments. The default hook aborts. */ | |
0c20a65f | 138 | tree (*type_promotes_to) (tree); |
ab393bf1 | 139 | |
9649812a MM |
140 | /* Register TYPE as a builtin type with the indicated NAME. The |
141 | TYPE is placed in the outermost lexical scope. The semantics | |
142 | should be analogous to: | |
143 | ||
144 | typedef TYPE NAME; | |
145 | ||
146 | in C. The default hook ignores the declaration. */ | |
147 | void (*register_builtin_type) (tree, const char *); | |
148 | ||
7a228918 NB |
149 | /* This routine is called in tree.c to print an error message for |
150 | invalid use of an incomplete type. VALUE is the expression that | |
151 | was used (or 0 if that isn't known) and TYPE is the type that was | |
152 | invalid. */ | |
0c20a65f | 153 | void (*incomplete_type_error) (tree value, tree type); |
f1e639b1 NB |
154 | }; |
155 | ||
43577e6b NB |
156 | /* Language hooks related to decls and the symbol table. */ |
157 | ||
158 | struct lang_hooks_for_decls | |
159 | { | |
160 | /* Enter a new lexical scope. Argument is always zero when called | |
161 | from outside the front end. */ | |
0c20a65f | 162 | void (*pushlevel) (int); |
43577e6b NB |
163 | |
164 | /* Exit a lexical scope and return a BINDING for that scope. | |
165 | Takes three arguments: | |
166 | KEEP -- nonzero if there were declarations in this scope. | |
167 | REVERSE -- reverse the order of decls before returning them. | |
168 | FUNCTIONBODY -- nonzero if this level is the body of a function. */ | |
0c20a65f | 169 | tree (*poplevel) (int, int, int); |
43577e6b | 170 | |
cc2902df | 171 | /* Returns nonzero if we are in the global binding level. Ada |
43577e6b | 172 | returns -1 for an undocumented reason used in stor-layout.c. */ |
0c20a65f | 173 | int (*global_bindings_p) (void); |
43577e6b NB |
174 | |
175 | /* Insert BLOCK at the end of the list of subblocks of the | |
176 | current binding level. This is used when a BIND_EXPR is expanded, | |
177 | to handle the BLOCK node inside the BIND_EXPR. */ | |
0c20a65f | 178 | void (*insert_block) (tree); |
43577e6b NB |
179 | |
180 | /* Set the BLOCK node for the current scope level. */ | |
0c20a65f | 181 | void (*set_block) (tree); |
43577e6b NB |
182 | |
183 | /* Function to add a decl to the current scope level. Takes one | |
184 | argument, a decl to add. Returns that decl, or, if the same | |
185 | symbol is already declared, may return a different decl for that | |
186 | name. */ | |
0c20a65f | 187 | tree (*pushdecl) (tree); |
43577e6b NB |
188 | |
189 | /* Returns the chain of decls so far in the current scope level. */ | |
0c20a65f | 190 | tree (*getdecls) (void); |
ef4f94ac RH |
191 | |
192 | /* Returns true when we should warn for an unused global DECL. | |
193 | We will already have checked that it has static binding. */ | |
0c20a65f | 194 | bool (*warn_unused_global) (tree); |
2b59501b MA |
195 | |
196 | /* Obtain a list of globals and do final output on them at end | |
197 | of compilation */ | |
0c20a65f | 198 | void (*final_write_globals) (void); |
e076f71a | 199 | |
d35543c0 | 200 | /* Do necessary preparations before assemble_variable can proceed. */ |
0c20a65f | 201 | void (*prepare_assemble_variable) (tree); |
d35543c0 | 202 | |
e076f71a | 203 | /* True if this decl may be called via a sibcall. */ |
0c20a65f | 204 | bool (*ok_for_sibcall) (tree); |
43577e6b NB |
205 | }; |
206 | ||
d23c55c2 NB |
207 | /* Language-specific hooks. See langhooks-def.h for defaults. */ |
208 | ||
209 | struct lang_hooks | |
210 | { | |
3ac88239 NB |
211 | /* String identifying the front end. e.g. "GNU C++". */ |
212 | const char *name; | |
213 | ||
214 | /* sizeof (struct lang_identifier), so make_node () creates | |
215 | identifier nodes long enough for the language-specific slots. */ | |
216 | size_t identifier_size; | |
217 | ||
d78e771d ZW |
218 | /* Determines the size of any language-specific 'x' or 'c' nodes. |
219 | Since it is called from make_node, the only information available | |
220 | is the tree code. Expected to abort on unrecognized codes. */ | |
0c20a65f | 221 | size_t (*tree_size) (enum tree_code); |
d78e771d | 222 | |
4d6baafa | 223 | /* The first callback made to the front end, for simple |
2772ef3e NB |
224 | initialization needed before any calls to handle_option. Return |
225 | the language mask to filter the switch array with. */ | |
b86f6cd9 | 226 | unsigned int (*init_options) (unsigned int argc, const char **argv); |
d23c55c2 | 227 | |
21ecc5a7 GDR |
228 | /* Callback used to perform language-specific initialization for the |
229 | global diagnostic context structure. */ | |
230 | void (*initialize_diagnostics) (struct diagnostic_context *); | |
231 | ||
2772ef3e NB |
232 | /* Handle the switch CODE, which has real type enum opt_code from |
233 | options.h. If the switch takes an argument, it is passed in ARG | |
4d6922ee | 234 | which points to permanent storage. The handler is responsible for |
2772ef3e NB |
235 | checking whether ARG is NULL, which indicates that no argument |
236 | was in fact supplied. For -f and -W switches, VALUE is 1 or 0 | |
237 | for the positive and negative forms respectively. | |
238 | ||
239 | Return 1 if the switch is valid, 0 if invalid, and -1 if it's | |
240 | valid and should not be treated as language-independent too. */ | |
241 | int (*handle_option) (size_t code, const char *arg, int value); | |
242 | ||
cb66e385 NB |
243 | /* Return false to use the default complaint about a missing |
244 | argument, otherwise output a complaint and return true. */ | |
245 | bool (*missing_argument) (const char *opt, size_t code); | |
246 | ||
4bfec483 NB |
247 | /* Called when all command line options have been parsed to allow |
248 | further processing and initialization | |
e5f3b786 | 249 | |
4bfec483 NB |
250 | Should return true to indicate that a compiler back-end is |
251 | not required, such as with the -E option. | |
0c20a65f | 252 | |
cc2902df | 253 | If errorcount is nonzero after this call the compiler exits |
e5f3b786 | 254 | immediately and the finish hook is not called. */ |
0c20a65f | 255 | bool (*post_options) (const char **); |
4bfec483 NB |
256 | |
257 | /* Called after post_options to initialize the front end. Return | |
258 | false to indicate that no further compilation be performed, in | |
259 | which case the finish hook is called immediately. */ | |
0c20a65f | 260 | bool (*init) (void); |
4d6baafa NB |
261 | |
262 | /* Called at the end of compilation, as a finalizer. */ | |
0c20a65f | 263 | void (*finish) (void); |
4d6baafa | 264 | |
cc2902df | 265 | /* Parses the entire file. The argument is nonzero to cause bison |
ff45c01e | 266 | parsers to dump debugging information during parsing. */ |
0c20a65f | 267 | void (*parse_file) (int); |
52dabb6c | 268 | |
4d6baafa | 269 | /* Called immediately after parsing to clear the binding stack. */ |
0c20a65f | 270 | void (*clear_binding_stack) (void); |
4d6baafa | 271 | |
d23c55c2 NB |
272 | /* Called to obtain the alias set to be used for an expression or type. |
273 | Returns -1 if the language does nothing special for it. */ | |
0c20a65f | 274 | HOST_WIDE_INT (*get_alias_set) (tree); |
d23c55c2 | 275 | |
ac79cd5a RK |
276 | /* Called with an expression that is to be processed as a constant. |
277 | Returns either the same expression or a language-independent | |
278 | constant equivalent to its input. */ | |
0c20a65f | 279 | tree (*expand_constant) (tree); |
ac79cd5a | 280 | |
c9d892a8 NB |
281 | /* Called by expand_expr for language-specific tree codes. |
282 | Fourth argument is actually an enum expand_modifier. */ | |
0c20a65f | 283 | rtx (*expand_expr) (tree, rtx, enum machine_mode, int); |
c9d892a8 | 284 | |
78ef5b89 NB |
285 | /* Prepare expr to be an argument of a TRUTH_NOT_EXPR or other logical |
286 | operation. | |
287 | ||
288 | This preparation consists of taking the ordinary representation | |
289 | of an expression expr and producing a valid tree boolean | |
290 | expression describing whether expr is nonzero. We could simply | |
291 | always do build_binary_op (NE_EXPR, expr, integer_zero_node, 1), | |
292 | but we optimize comparisons, &&, ||, and !. | |
293 | ||
294 | The result should be an expression of boolean type (if not an | |
295 | error_mark_node). */ | |
0c20a65f | 296 | tree (*truthvalue_conversion) (tree); |
78ef5b89 | 297 | |
ac79cd5a RK |
298 | /* Hook called by safe_from_p for language-specific tree codes. It is |
299 | up to the language front-end to install a hook if it has any such | |
300 | codes that safe_from_p needs to know about. Since same_from_p will | |
301 | recursively explore the TREE_OPERANDs of an expression, this hook | |
302 | should not reexamine those pieces. This routine may recursively | |
303 | call safe_from_p; it should always pass `0' as the TOP_P | |
304 | parameter. */ | |
0c20a65f | 305 | int (*safe_from_p) (rtx, tree); |
ac79cd5a | 306 | |
48a7a235 NB |
307 | /* Function to finish handling an incomplete decl at the end of |
308 | compilation. Default hook is does nothing. */ | |
0c20a65f | 309 | void (*finish_incomplete_decl) (tree); |
48a7a235 NB |
310 | |
311 | /* Function used by unsafe_for_reeval. A non-negative number is | |
312 | returned directly from unsafe_for_reeval, a negative number falls | |
313 | through. The default hook returns a negative number. */ | |
0c20a65f | 314 | int (*unsafe_for_reeval) (tree); |
48a7a235 | 315 | |
dffd7eb6 NB |
316 | /* Mark EXP saying that we need to be able to take the address of |
317 | it; it should not be allocated in a register. Return true if | |
318 | successful. */ | |
0c20a65f | 319 | bool (*mark_addressable) (tree); |
dffd7eb6 | 320 | |
d062a680 | 321 | /* Hook called by staticp for language-specific tree codes. */ |
0c20a65f | 322 | int (*staticp) (tree); |
d062a680 | 323 | |
63e1b1c4 NB |
324 | /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the |
325 | DECL_NODE with a newly GC-allocated copy. */ | |
0c20a65f | 326 | void (*dup_lang_specific_decl) (tree); |
63e1b1c4 | 327 | |
24965e7a NB |
328 | /* Called before its argument, an UNSAVE_EXPR, is to be |
329 | unsaved. Modify it in-place so that all the evaluate only once | |
330 | things are cleared out. */ | |
0c20a65f | 331 | tree (*unsave_expr_now) (tree); |
24965e7a | 332 | |
c88770e9 NB |
333 | /* Called by expand_expr to build and return the cleanup-expression |
334 | for the passed TARGET_EXPR. Return NULL if there is none. */ | |
0c20a65f | 335 | tree (*maybe_build_cleanup) (tree); |
c88770e9 | 336 | |
599bba86 NB |
337 | /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of |
338 | thing that the assembler should talk about, set | |
339 | DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. | |
340 | Otherwise, set it to the ERROR_MARK_NODE to ensure that the | |
341 | assembler does not talk about it. */ | |
0c20a65f | 342 | void (*set_decl_assembler_name) (tree); |
599bba86 | 343 | |
57ce46bb TT |
344 | /* Return nonzero if fold-const is free to use bit-field |
345 | optimizations, for instance in fold_truthop(). */ | |
0c20a65f | 346 | bool (*can_use_bit_fields_p) (void); |
57ce46bb | 347 | |
d23c55c2 NB |
348 | /* Nonzero if TYPE_READONLY and TREE_READONLY should always be honored. */ |
349 | bool honor_readonly; | |
350 | ||
2896d056 ZW |
351 | /* Nonzero if this front end does not generate a dummy BLOCK between |
352 | the outermost scope of the function and the FUNCTION_DECL. See | |
353 | is_body_block in stmt.c, and its callers. */ | |
354 | bool no_body_blocks; | |
355 | ||
5d69f816 NB |
356 | /* The front end can add its own statistics to -fmem-report with |
357 | this hook. It should output to stderr. */ | |
0c20a65f | 358 | void (*print_statistics) (void); |
5d69f816 NB |
359 | |
360 | /* Called by print_tree when there is a tree of class 'x' that it | |
361 | doesn't know how to display. */ | |
362 | lang_print_tree_hook print_xnode; | |
363 | ||
364 | /* Called to print language-dependent parts of a class 'd', class | |
365 | 't', and IDENTIFIER_NODE nodes. */ | |
366 | lang_print_tree_hook print_decl; | |
367 | lang_print_tree_hook print_type; | |
368 | lang_print_tree_hook print_identifier; | |
369 | ||
7afff7cf NB |
370 | /* Computes the name to use to print a declaration. DECL is the |
371 | non-NULL declaration in question. VERBOSITY determines what | |
372 | information will be printed: 0: DECL_NAME, demangled as | |
373 | necessary. 1: and scope information. 2: and any other | |
374 | information that might be interesting, such as function parameter | |
375 | types in C++. */ | |
0c20a65f | 376 | const char *(*decl_printable_name) (tree decl, int verbosity); |
7afff7cf | 377 | |
7cb32822 | 378 | /* Called by report_error_function to print out function name. */ |
0c20a65f | 379 | void (*print_error_function) (struct diagnostic_context *, const char *); |
7cb32822 | 380 | |
a77a9a18 JM |
381 | /* Called from expr_size to calculate the size of the value of an |
382 | expression in a language-dependent way. Returns a tree for the size | |
383 | in bytes. A frontend can call lhd_expr_size to get the default | |
384 | semantics in cases that it doesn't want to handle specially. */ | |
0c20a65f | 385 | tree (*expr_size) (tree); |
a77a9a18 | 386 | |
16b0d23f | 387 | /* Called from uninitialized_vars_warning to find out if a variable is |
2b72593e | 388 | uninitialized based on DECL_INITIAL. */ |
16b0d23f AP |
389 | bool (*decl_uninit) (tree); |
390 | ||
349ae713 NB |
391 | /* Pointers to machine-independent attribute tables, for front ends |
392 | using attribs.c. If one is NULL, it is ignored. Respectively, a | |
393 | table of attributes specific to the language, a table of | |
394 | attributes common to two or more languages (to allow easy | |
395 | sharing), and a table of attributes for checking formats. */ | |
396 | const struct attribute_spec *attribute_table; | |
397 | const struct attribute_spec *common_attribute_table; | |
398 | const struct attribute_spec *format_attribute_table; | |
399 | ||
b03e38e1 NB |
400 | /* Function-related language hooks. */ |
401 | struct lang_hooks_for_functions function; | |
402 | ||
d23c55c2 | 403 | struct lang_hooks_for_tree_inlining tree_inlining; |
e11e816e | 404 | |
e72fcfe8 JH |
405 | struct lang_hooks_for_callgraph callgraph; |
406 | ||
89d684bb | 407 | struct lang_hooks_for_tree_dump tree_dump; |
d23c55c2 | 408 | |
43577e6b NB |
409 | struct lang_hooks_for_decls decls; |
410 | ||
f1e639b1 NB |
411 | struct lang_hooks_for_types types; |
412 | ||
4985cde3 RH |
413 | struct lang_hooks_for_rtl_expansion rtl_expand; |
414 | ||
89d684bb | 415 | /* Whenever you add entries here, make sure you adjust langhooks-def.h |
d23c55c2 NB |
416 | and langhooks.c accordingly. */ |
417 | }; | |
418 | ||
419 | /* Each front end provides its own. */ | |
3ac88239 | 420 | extern const struct lang_hooks lang_hooks; |
69dcadff AO |
421 | |
422 | #endif /* GCC_LANG_HOOKS_H */ |