]>
Commit | Line | Data |
---|---|---|
d23c55c2 | 1 | /* The lang_hooks data structure. |
a4de48bc | 2 | Copyright 2001, 2002, 2003, 2004, 2005 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 *), | |
0c58f841 | 38 | void *, struct pointer_set_t*); |
bcda12f4 SB |
39 | int (*cannot_inline_tree_fn) (tree *); |
40 | int (*disregard_inline_limits) (tree); | |
41 | tree (*add_pending_fn_decls) (void *, tree); | |
bcda12f4 | 42 | int (*auto_var_in_fn_p) (tree, tree); |
bcda12f4 | 43 | int (*anon_aggr_type_p) (tree); |
5377d5ba | 44 | bool (*var_mod_type_p) (tree, tree); |
bcda12f4 SB |
45 | int (*start_inlining) (tree); |
46 | void (*end_inlining) (tree); | |
d5123bae | 47 | tree (*convert_parm_for_inlining) (tree, tree, tree, int); |
d23c55c2 NB |
48 | }; |
49 | ||
e72fcfe8 JH |
50 | struct lang_hooks_for_callgraph |
51 | { | |
25c84396 RH |
52 | /* The node passed is a language-specific tree node. If its contents |
53 | are relevant to use of other declarations, mark them. */ | |
54 | tree (*analyze_expr) (tree *, int *, tree); | |
55 | ||
e72fcfe8 | 56 | /* Produce RTL for function passed as argument. */ |
bcda12f4 | 57 | void (*expand_function) (tree); |
e72fcfe8 JH |
58 | }; |
59 | ||
b03e38e1 NB |
60 | /* Lang hooks for management of language-specific data or status |
61 | when entering / leaving functions etc. */ | |
62 | struct lang_hooks_for_functions | |
63 | { | |
64 | /* Called when entering a function. */ | |
0c20a65f | 65 | void (*init) (struct function *); |
b03e38e1 NB |
66 | |
67 | /* Called when leaving a function. */ | |
0c20a65f | 68 | void (*final) (struct function *); |
b03e38e1 NB |
69 | |
70 | /* Called when entering a nested function. */ | |
0c20a65f | 71 | void (*enter_nested) (struct function *); |
b03e38e1 NB |
72 | |
73 | /* Called when leaving a nested function. */ | |
0c20a65f | 74 | void (*leave_nested) (struct function *); |
4985cde3 | 75 | |
6de9cd9a DN |
76 | /* Determines if it's ok for a function to have no noreturn attribute. */ |
77 | bool (*missing_noreturn_ok_p) (tree); | |
4985cde3 RH |
78 | }; |
79 | ||
89d684bb BM |
80 | /* The following hooks are used by tree-dump.c. */ |
81 | ||
82 | struct lang_hooks_for_tree_dump | |
83 | { | |
cc2902df | 84 | /* Dump language-specific parts of tree nodes. Returns nonzero if it |
89d684bb | 85 | does not want the usual dumping of the second argument. */ |
0c20a65f | 86 | bool (*dump_tree) (void *, tree); |
89d684bb BM |
87 | |
88 | /* Determine type qualifiers in a language-specific way. */ | |
0c20a65f | 89 | int (*type_quals) (tree); |
89d684bb BM |
90 | }; |
91 | ||
f1e639b1 NB |
92 | /* Hooks related to types. */ |
93 | ||
94 | struct lang_hooks_for_types | |
95 | { | |
b0c48229 NB |
96 | /* Return a new type (with the indicated CODE), doing whatever |
97 | language-specific processing is required. */ | |
0c20a65f | 98 | tree (*make_type) (enum tree_code); |
e11e816e | 99 | |
b0c48229 NB |
100 | /* Given MODE and UNSIGNEDP, return a suitable type-tree with that |
101 | mode. */ | |
0c20a65f | 102 | tree (*type_for_mode) (enum machine_mode, int); |
b0c48229 NB |
103 | |
104 | /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an | |
105 | integer type with at least that precision. */ | |
0c20a65f | 106 | tree (*type_for_size) (unsigned, int); |
ceef8ce4 NB |
107 | |
108 | /* Given an integer type T, return a type like T but unsigned. | |
109 | If T is unsigned, the value is T. */ | |
0c20a65f | 110 | tree (*unsigned_type) (tree); |
ceef8ce4 NB |
111 | |
112 | /* Given an integer type T, return a type like T but signed. | |
113 | If T is signed, the value is T. */ | |
0c20a65f | 114 | tree (*signed_type) (tree); |
ceef8ce4 NB |
115 | |
116 | /* Return a type the same as TYPE except unsigned or signed | |
117 | according to UNSIGNEDP. */ | |
0c20a65f | 118 | tree (*signed_or_unsigned_type) (int, tree); |
7a228918 | 119 | |
ab393bf1 NB |
120 | /* Given a type, apply default promotions to unnamed function |
121 | arguments and return the new type. Return the same type if no | |
122 | change. Required by any language that supports variadic | |
0e61db61 | 123 | arguments. The default hook dies. */ |
0c20a65f | 124 | tree (*type_promotes_to) (tree); |
ab393bf1 | 125 | |
9649812a MM |
126 | /* Register TYPE as a builtin type with the indicated NAME. The |
127 | TYPE is placed in the outermost lexical scope. The semantics | |
128 | should be analogous to: | |
129 | ||
130 | typedef TYPE NAME; | |
131 | ||
132 | in C. The default hook ignores the declaration. */ | |
133 | void (*register_builtin_type) (tree, const char *); | |
134 | ||
7a228918 NB |
135 | /* This routine is called in tree.c to print an error message for |
136 | invalid use of an incomplete type. VALUE is the expression that | |
137 | was used (or 0 if that isn't known) and TYPE is the type that was | |
138 | invalid. */ | |
0c20a65f | 139 | void (*incomplete_type_error) (tree value, tree type); |
7548281d | 140 | |
8963a517 RK |
141 | /* Called from assign_temp to return the maximum size, if there is one, |
142 | for a type. */ | |
143 | tree (*max_size) (tree); | |
144 | ||
7548281d RK |
145 | /* Nonzero if types that are identical are to be hashed so that only |
146 | one copy is kept. If a language requires unique types for each | |
147 | user-specified type, such as Ada, this should be set to TRUE. */ | |
148 | bool hash_types; | |
f1e639b1 NB |
149 | }; |
150 | ||
43577e6b NB |
151 | /* Language hooks related to decls and the symbol table. */ |
152 | ||
153 | struct lang_hooks_for_decls | |
154 | { | |
cc2902df | 155 | /* Returns nonzero if we are in the global binding level. Ada |
43577e6b | 156 | returns -1 for an undocumented reason used in stor-layout.c. */ |
0c20a65f | 157 | int (*global_bindings_p) (void); |
43577e6b NB |
158 | |
159 | /* Insert BLOCK at the end of the list of subblocks of the | |
160 | current binding level. This is used when a BIND_EXPR is expanded, | |
161 | to handle the BLOCK node inside the BIND_EXPR. */ | |
0c20a65f | 162 | void (*insert_block) (tree); |
43577e6b | 163 | |
43577e6b NB |
164 | /* Function to add a decl to the current scope level. Takes one |
165 | argument, a decl to add. Returns that decl, or, if the same | |
166 | symbol is already declared, may return a different decl for that | |
167 | name. */ | |
0c20a65f | 168 | tree (*pushdecl) (tree); |
43577e6b NB |
169 | |
170 | /* Returns the chain of decls so far in the current scope level. */ | |
0c20a65f | 171 | tree (*getdecls) (void); |
ef4f94ac RH |
172 | |
173 | /* Returns true when we should warn for an unused global DECL. | |
174 | We will already have checked that it has static binding. */ | |
0c20a65f | 175 | bool (*warn_unused_global) (tree); |
2b59501b MA |
176 | |
177 | /* Obtain a list of globals and do final output on them at end | |
178 | of compilation */ | |
0c20a65f | 179 | void (*final_write_globals) (void); |
e076f71a | 180 | |
d35543c0 | 181 | /* Do necessary preparations before assemble_variable can proceed. */ |
0c20a65f | 182 | void (*prepare_assemble_variable) (tree); |
d35543c0 | 183 | |
e076f71a | 184 | /* True if this decl may be called via a sibcall. */ |
0c20a65f | 185 | bool (*ok_for_sibcall) (tree); |
c18a5b6c MM |
186 | |
187 | /* Return the COMDAT group into which this DECL should be placed. | |
188 | It is known that the DECL belongs in *some* COMDAT group when | |
189 | this hook is called. The return value will be used immediately, | |
190 | but not explicitly deallocated, so implementations should not use | |
191 | xmalloc to allocate the string returned. (Typically, the return | |
192 | value will be the string already stored in an | |
193 | IDENTIFIER_NODE.) */ | |
194 | const char * (*comdat_group) (tree); | |
43577e6b NB |
195 | }; |
196 | ||
d23c55c2 NB |
197 | /* Language-specific hooks. See langhooks-def.h for defaults. */ |
198 | ||
199 | struct lang_hooks | |
200 | { | |
3ac88239 NB |
201 | /* String identifying the front end. e.g. "GNU C++". */ |
202 | const char *name; | |
203 | ||
204 | /* sizeof (struct lang_identifier), so make_node () creates | |
205 | identifier nodes long enough for the language-specific slots. */ | |
206 | size_t identifier_size; | |
207 | ||
6615c446 JO |
208 | /* Determines the size of any language-specific tcc_constant or |
209 | tcc_exceptional nodes. Since it is called from make_node, the | |
0e61db61 | 210 | only information available is the tree code. Expected to die |
6615c446 | 211 | on unrecognized codes. */ |
0c20a65f | 212 | size_t (*tree_size) (enum tree_code); |
d78e771d | 213 | |
4d6baafa | 214 | /* The first callback made to the front end, for simple |
2772ef3e NB |
215 | initialization needed before any calls to handle_option. Return |
216 | the language mask to filter the switch array with. */ | |
b86f6cd9 | 217 | unsigned int (*init_options) (unsigned int argc, const char **argv); |
d23c55c2 | 218 | |
21ecc5a7 GDR |
219 | /* Callback used to perform language-specific initialization for the |
220 | global diagnostic context structure. */ | |
221 | void (*initialize_diagnostics) (struct diagnostic_context *); | |
222 | ||
2772ef3e NB |
223 | /* Handle the switch CODE, which has real type enum opt_code from |
224 | options.h. If the switch takes an argument, it is passed in ARG | |
4d6922ee | 225 | which points to permanent storage. The handler is responsible for |
2772ef3e NB |
226 | checking whether ARG is NULL, which indicates that no argument |
227 | was in fact supplied. For -f and -W switches, VALUE is 1 or 0 | |
228 | for the positive and negative forms respectively. | |
229 | ||
230 | Return 1 if the switch is valid, 0 if invalid, and -1 if it's | |
231 | valid and should not be treated as language-independent too. */ | |
232 | int (*handle_option) (size_t code, const char *arg, int value); | |
233 | ||
cb66e385 NB |
234 | /* Return false to use the default complaint about a missing |
235 | argument, otherwise output a complaint and return true. */ | |
236 | bool (*missing_argument) (const char *opt, size_t code); | |
237 | ||
4bfec483 NB |
238 | /* Called when all command line options have been parsed to allow |
239 | further processing and initialization | |
e5f3b786 | 240 | |
4bfec483 NB |
241 | Should return true to indicate that a compiler back-end is |
242 | not required, such as with the -E option. | |
0c20a65f | 243 | |
cc2902df | 244 | If errorcount is nonzero after this call the compiler exits |
e5f3b786 | 245 | immediately and the finish hook is not called. */ |
0c20a65f | 246 | bool (*post_options) (const char **); |
4bfec483 NB |
247 | |
248 | /* Called after post_options to initialize the front end. Return | |
249 | false to indicate that no further compilation be performed, in | |
250 | which case the finish hook is called immediately. */ | |
0c20a65f | 251 | bool (*init) (void); |
4d6baafa NB |
252 | |
253 | /* Called at the end of compilation, as a finalizer. */ | |
0c20a65f | 254 | void (*finish) (void); |
4d6baafa | 255 | |
cc2902df | 256 | /* Parses the entire file. The argument is nonzero to cause bison |
ff45c01e | 257 | parsers to dump debugging information during parsing. */ |
0c20a65f | 258 | void (*parse_file) (int); |
52dabb6c | 259 | |
4d6baafa | 260 | /* Called immediately after parsing to clear the binding stack. */ |
0c20a65f | 261 | void (*clear_binding_stack) (void); |
4d6baafa | 262 | |
d23c55c2 NB |
263 | /* Called to obtain the alias set to be used for an expression or type. |
264 | Returns -1 if the language does nothing special for it. */ | |
0c20a65f | 265 | HOST_WIDE_INT (*get_alias_set) (tree); |
d23c55c2 | 266 | |
ac79cd5a RK |
267 | /* Called with an expression that is to be processed as a constant. |
268 | Returns either the same expression or a language-independent | |
269 | constant equivalent to its input. */ | |
0c20a65f | 270 | tree (*expand_constant) (tree); |
ac79cd5a | 271 | |
c9d892a8 NB |
272 | /* Called by expand_expr for language-specific tree codes. |
273 | Fourth argument is actually an enum expand_modifier. */ | |
0fab64a3 | 274 | rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *); |
c9d892a8 | 275 | |
6de9cd9a DN |
276 | /* Called by expand_expr to generate the definition of a decl. Returns |
277 | 1 if handled, 0 otherwise. */ | |
278 | int (*expand_decl) (tree); | |
279 | ||
ac79cd5a RK |
280 | /* Hook called by safe_from_p for language-specific tree codes. It is |
281 | up to the language front-end to install a hook if it has any such | |
282 | codes that safe_from_p needs to know about. Since same_from_p will | |
283 | recursively explore the TREE_OPERANDs of an expression, this hook | |
284 | should not reexamine those pieces. This routine may recursively | |
285 | call safe_from_p; it should always pass `0' as the TOP_P | |
286 | parameter. */ | |
0c20a65f | 287 | int (*safe_from_p) (rtx, tree); |
ac79cd5a | 288 | |
48a7a235 NB |
289 | /* Function to finish handling an incomplete decl at the end of |
290 | compilation. Default hook is does nothing. */ | |
0c20a65f | 291 | void (*finish_incomplete_decl) (tree); |
48a7a235 | 292 | |
dffd7eb6 NB |
293 | /* Mark EXP saying that we need to be able to take the address of |
294 | it; it should not be allocated in a register. Return true if | |
295 | successful. */ | |
0c20a65f | 296 | bool (*mark_addressable) (tree); |
dffd7eb6 | 297 | |
d062a680 | 298 | /* Hook called by staticp for language-specific tree codes. */ |
525c6bf5 | 299 | tree (*staticp) (tree); |
d062a680 | 300 | |
63e1b1c4 NB |
301 | /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the |
302 | DECL_NODE with a newly GC-allocated copy. */ | |
0c20a65f | 303 | void (*dup_lang_specific_decl) (tree); |
63e1b1c4 | 304 | |
599bba86 NB |
305 | /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of |
306 | thing that the assembler should talk about, set | |
307 | DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. | |
308 | Otherwise, set it to the ERROR_MARK_NODE to ensure that the | |
309 | assembler does not talk about it. */ | |
0c20a65f | 310 | void (*set_decl_assembler_name) (tree); |
599bba86 | 311 | |
57ce46bb TT |
312 | /* Return nonzero if fold-const is free to use bit-field |
313 | optimizations, for instance in fold_truthop(). */ | |
0c20a65f | 314 | bool (*can_use_bit_fields_p) (void); |
57ce46bb | 315 | |
bc15d0ef JM |
316 | /* Nonzero if operations on types narrower than their mode should |
317 | have their results reduced to the precision of the type. */ | |
318 | bool reduce_bit_field_operations; | |
319 | ||
2896d056 ZW |
320 | /* Nonzero if this front end does not generate a dummy BLOCK between |
321 | the outermost scope of the function and the FUNCTION_DECL. See | |
322 | is_body_block in stmt.c, and its callers. */ | |
323 | bool no_body_blocks; | |
324 | ||
5d69f816 NB |
325 | /* The front end can add its own statistics to -fmem-report with |
326 | this hook. It should output to stderr. */ | |
0c20a65f | 327 | void (*print_statistics) (void); |
5d69f816 | 328 | |
6615c446 JO |
329 | /* Called by print_tree when there is a tree of class tcc_exceptional |
330 | that it doesn't know how to display. */ | |
5d69f816 NB |
331 | lang_print_tree_hook print_xnode; |
332 | ||
6615c446 JO |
333 | /* Called to print language-dependent parts of tcc_decl, tcc_type, |
334 | and IDENTIFIER_NODE nodes. */ | |
5d69f816 NB |
335 | lang_print_tree_hook print_decl; |
336 | lang_print_tree_hook print_type; | |
337 | lang_print_tree_hook print_identifier; | |
338 | ||
7afff7cf NB |
339 | /* Computes the name to use to print a declaration. DECL is the |
340 | non-NULL declaration in question. VERBOSITY determines what | |
341 | information will be printed: 0: DECL_NAME, demangled as | |
342 | necessary. 1: and scope information. 2: and any other | |
343 | information that might be interesting, such as function parameter | |
344 | types in C++. */ | |
0c20a65f | 345 | const char *(*decl_printable_name) (tree decl, int verbosity); |
7afff7cf | 346 | |
6de9cd9a DN |
347 | /* This compares two types for equivalence ("compatible" in C-based languages). |
348 | This routine should only return 1 if it is sure. It should not be used | |
349 | in contexts where erroneously returning 0 causes problems. */ | |
350 | int (*types_compatible_p) (tree x, tree y); | |
351 | ||
83d865c5 AH |
352 | /* Given a CALL_EXPR, return a function decl that is its target. */ |
353 | tree (*lang_get_callee_fndecl) (tree); | |
354 | ||
7cb32822 | 355 | /* Called by report_error_function to print out function name. */ |
0c20a65f | 356 | void (*print_error_function) (struct diagnostic_context *, const char *); |
7cb32822 | 357 | |
a77a9a18 JM |
358 | /* Called from expr_size to calculate the size of the value of an |
359 | expression in a language-dependent way. Returns a tree for the size | |
360 | in bytes. A frontend can call lhd_expr_size to get the default | |
361 | semantics in cases that it doesn't want to handle specially. */ | |
0c20a65f | 362 | tree (*expr_size) (tree); |
a77a9a18 | 363 | |
c5ff069d ZW |
364 | /* Convert a character from the host's to the target's character |
365 | set. The character should be in what C calls the "basic source | |
366 | character set" (roughly, the set of characters defined by plain | |
367 | old ASCII). The default is to return the character unchanged, | |
368 | which is correct in most circumstances. Note that both argument | |
369 | and result should be sign-extended under -fsigned-char, | |
370 | zero-extended under -fno-signed-char. */ | |
371 | HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT); | |
372 | ||
349ae713 NB |
373 | /* Pointers to machine-independent attribute tables, for front ends |
374 | using attribs.c. If one is NULL, it is ignored. Respectively, a | |
375 | table of attributes specific to the language, a table of | |
376 | attributes common to two or more languages (to allow easy | |
377 | sharing), and a table of attributes for checking formats. */ | |
378 | const struct attribute_spec *attribute_table; | |
379 | const struct attribute_spec *common_attribute_table; | |
380 | const struct attribute_spec *format_attribute_table; | |
381 | ||
b03e38e1 NB |
382 | /* Function-related language hooks. */ |
383 | struct lang_hooks_for_functions function; | |
384 | ||
d23c55c2 | 385 | struct lang_hooks_for_tree_inlining tree_inlining; |
e11e816e | 386 | |
e72fcfe8 JH |
387 | struct lang_hooks_for_callgraph callgraph; |
388 | ||
89d684bb | 389 | struct lang_hooks_for_tree_dump tree_dump; |
d23c55c2 | 390 | |
43577e6b NB |
391 | struct lang_hooks_for_decls decls; |
392 | ||
f1e639b1 NB |
393 | struct lang_hooks_for_types types; |
394 | ||
6de9cd9a DN |
395 | /* Perform language-specific gimplification on the argument. Returns an |
396 | enum gimplify_status, though we can't see that type here. */ | |
397 | int (*gimplify_expr) (tree *, tree *, tree *); | |
398 | ||
0f59171d RH |
399 | /* Fold an OBJ_TYPE_REF expression to the address of a function. |
400 | KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */ | |
401 | tree (*fold_obj_type_ref) (tree, tree); | |
402 | ||
6e34d3a3 JM |
403 | /* Return a definition for a builtin function named NAME and whose data type |
404 | is TYPE. TYPE should be a function type with argument types. | |
405 | FUNCTION_CODE tells later passes how to compile calls to this function. | |
406 | See tree.h for its possible values. | |
407 | ||
408 | If LIBRARY_NAME is nonzero, use that for DECL_ASSEMBLER_NAME, | |
409 | the name to be called if we can't opencode the function. If | |
410 | ATTRS is nonzero, use that for the function's attribute list. */ | |
411 | tree (*builtin_function) (const char *name, tree type, int function_code, | |
b1e8c0fd | 412 | enum built_in_class bt_class, |
6e34d3a3 JM |
413 | const char *library_name, tree attrs); |
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 */ |