GCC Middle and Back End API Reference
langhooks-def.h
Go to the documentation of this file.
1 /* Default macros to initialize the lang_hooks data structure.
2  Copyright (C) 2001-2013 Free Software Foundation, Inc.
3  Contributed by Alexandre Oliva <aoliva@redhat.com>
4 
5 This file is part of GCC.
6 
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
11 
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
20 
21 #ifndef GCC_LANG_HOOKS_DEF_H
22 #define GCC_LANG_HOOKS_DEF_H
23 
24 #include "hooks.h"
25 
26 struct diagnostic_info;
27 
28 /* Note to creators of new hooks:
29 
30  The macros in this file should NOT be surrounded by a
31  #ifdef...#endif pair, since this file declares the defaults. Each
32  front end overrides any hooks it wishes to, in the file containing
33  its struct lang_hooks, AFTER including this file. */
34 
35 /* See langhooks.h for the definition and documentation of each hook. */
36 
37 extern void lhd_do_nothing (void);
38 extern void lhd_do_nothing_t (tree);
39 extern void lhd_do_nothing_f (struct function *);
41 extern bool lhd_post_options (const char **);
43 extern tree lhd_return_null_tree_v (void);
46 extern tree lhd_do_nothing_iii_return_null_tree (int, int, int);
47 extern void lhd_print_tree_nothing (FILE *, tree, int);
48 extern const char *lhd_decl_printable_name (tree, int);
49 extern const char *lhd_dwarf_name (tree, int);
50 extern int lhd_types_compatible_p (tree, tree);
52  const char *, struct diagnostic_info *);
53 extern void lhd_set_decl_assembler_name (tree);
57 extern void lhd_register_builtin_type (tree, const char *);
59 extern size_t lhd_tree_size (enum tree_code);
61 extern tree lhd_expr_to_decl (tree, bool *, bool *);
63 
64 /* Declarations of default tree inlining hooks. */
66 extern void lhd_init_options (unsigned int,
67  struct cl_decoded_option *);
68 extern bool lhd_complain_wrong_lang_p (const struct cl_option *);
69 extern bool lhd_handle_option (size_t, const char *, int, int, location_t,
70  const struct cl_option_handlers *);
71 
72 
73 /* Declarations for tree gimplification hooks. */
74 extern int lhd_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
77 struct gimplify_omp_ctx;
79  tree);
80 
81 #define LANG_HOOKS_NAME "GNU unknown"
82 #define LANG_HOOKS_IDENTIFIER_SIZE sizeof (struct lang_identifier)
83 #define LANG_HOOKS_INIT hook_bool_void_false
84 #define LANG_HOOKS_FINISH lhd_do_nothing
85 #define LANG_HOOKS_PARSE_FILE lhd_do_nothing
86 #define LANG_HOOKS_OPTION_LANG_MASK hook_uint_void_0
87 #define LANG_HOOKS_INIT_OPTIONS_STRUCT hook_void_gcc_optionsp
88 #define LANG_HOOKS_INIT_OPTIONS lhd_init_options
89 #define LANG_HOOKS_INITIALIZE_DIAGNOSTICS lhd_initialize_diagnostics
90 #define LANG_HOOKS_COMPLAIN_WRONG_LANG_P lhd_complain_wrong_lang_p
91 #define LANG_HOOKS_HANDLE_OPTION lhd_handle_option
92 #define LANG_HOOKS_POST_OPTIONS lhd_post_options
93 #define LANG_HOOKS_MISSING_NORETURN_OK_P hook_bool_tree_true
94 #define LANG_HOOKS_GET_ALIAS_SET lhd_get_alias_set
95 #define LANG_HOOKS_FINISH_INCOMPLETE_DECL lhd_do_nothing_t
96 #define LANG_HOOKS_DUP_LANG_SPECIFIC_DECL lhd_do_nothing_t
97 #define LANG_HOOKS_SET_DECL_ASSEMBLER_NAME lhd_set_decl_assembler_name
98 #define LANG_HOOKS_PRINT_STATISTICS lhd_do_nothing
99 #define LANG_HOOKS_PRINT_XNODE lhd_print_tree_nothing
100 #define LANG_HOOKS_PRINT_DECL lhd_print_tree_nothing
101 #define LANG_HOOKS_PRINT_TYPE lhd_print_tree_nothing
102 #define LANG_HOOKS_PRINT_IDENTIFIER lhd_print_tree_nothing
103 #define LANG_HOOKS_PRINT_ERROR_FUNCTION lhd_print_error_function
104 #define LANG_HOOKS_DECL_PRINTABLE_NAME lhd_decl_printable_name
105 #define LANG_HOOKS_DWARF_NAME lhd_dwarf_name
106 #define LANG_HOOKS_FREE_LANG_DATA lhd_do_nothing_t
107 #define LANG_HOOKS_TREE_SIZE lhd_tree_size
108 #define LANG_HOOKS_TYPES_COMPATIBLE_P lhd_types_compatible_p
109 #define LANG_HOOKS_BUILTIN_FUNCTION lhd_builtin_function
110 #define LANG_HOOKS_BUILTIN_FUNCTION_EXT_SCOPE LANG_HOOKS_BUILTIN_FUNCTION
111 #define LANG_HOOKS_EXPR_TO_DECL lhd_expr_to_decl
112 #define LANG_HOOKS_TO_TARGET_CHARSET lhd_to_target_charset
113 #define LANG_HOOKS_INIT_TS lhd_do_nothing
114 #define LANG_HOOKS_EH_PERSONALITY lhd_gcc_personality
115 #define LANG_HOOKS_EH_RUNTIME_TYPE lhd_pass_through_t
116 #define LANG_HOOKS_EH_PROTECT_CLEANUP_ACTIONS NULL
117 #define LANG_HOOKS_BLOCK_MAY_FALLTHRU hook_bool_const_tree_true
118 #define LANG_HOOKS_EH_USE_CXA_END_CLEANUP false
119 #define LANG_HOOKS_DEEP_UNSHARING false
120 
121 /* Attribute hooks. */
122 #define LANG_HOOKS_ATTRIBUTE_TABLE NULL
123 #define LANG_HOOKS_COMMON_ATTRIBUTE_TABLE NULL
124 #define LANG_HOOKS_FORMAT_ATTRIBUTE_TABLE NULL
125 
126 /* Tree inlining hooks. */
127 #define LANG_HOOKS_TREE_INLINING_VAR_MOD_TYPE_P \
128  hook_bool_tree_tree_false
129 
130 #define LANG_HOOKS_TREE_INLINING_INITIALIZER { \
131  LANG_HOOKS_TREE_INLINING_VAR_MOD_TYPE_P, \
132 }
133 
134 /* Hooks for tree gimplification. */
135 #define LANG_HOOKS_GIMPLIFY_EXPR lhd_gimplify_expr
136 
137 /* Tree dump hooks. */
138 extern bool lhd_tree_dump_dump_tree (void *, tree);
140 extern tree lhd_make_node (enum tree_code);
141 
142 #define LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN lhd_tree_dump_dump_tree
143 #define LANG_HOOKS_TREE_DUMP_TYPE_QUALS_FN lhd_tree_dump_type_quals
144 
145 #define LANG_HOOKS_TREE_DUMP_INITIALIZER { \
146  LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN, \
147  LANG_HOOKS_TREE_DUMP_TYPE_QUALS_FN \
148 }
149 
150 /* Types hooks. There are no reasonable defaults for most of them,
151  so we create a compile-time error instead. */
152 #define LANG_HOOKS_MAKE_TYPE lhd_make_node
153 #define LANG_HOOKS_CLASSIFY_RECORD NULL
154 #define LANG_HOOKS_INCOMPLETE_TYPE_ERROR lhd_incomplete_type_error
155 #define LANG_HOOKS_GENERIC_TYPE_P hook_bool_const_tree_false
156 #define LANG_HOOKS_GET_INNERMOST_GENERIC_PARMS hook_tree_const_tree_null
157 #define LANG_HOOKS_GET_INNERMOST_GENERIC_ARGS hook_tree_const_tree_null
158 #define LANG_HOOKS_FUNCTION_PARAMETER_PACK_P hook_bool_const_tree_false
159 #define LANG_HOOKS_GET_ARGUMENT_PACK_ELEMS hook_tree_const_tree_null
160 #define LANG_HOOKS_GENERIC_GENERIC_PARAMETER_DECL_P hook_bool_const_tree_false
161 #define LANG_HOOKS_FUNCTION_PARM_EXPANDED_FROM_PACK_P \
162  hook_bool_tree_tree_false
163 #define LANG_HOOKS_GET_GENERIC_FUNCTION_DECL hook_tree_const_tree_null
164 #define LANG_HOOKS_TYPE_PROMOTES_TO lhd_type_promotes_to
165 #define LANG_HOOKS_REGISTER_BUILTIN_TYPE lhd_register_builtin_type
166 #define LANG_HOOKS_TYPE_MAX_SIZE lhd_return_null_const_tree
167 #define LANG_HOOKS_OMP_FIRSTPRIVATIZE_TYPE_SIZES \
168  lhd_omp_firstprivatize_type_sizes
169 #define LANG_HOOKS_TYPE_HASH_EQ NULL
170 #define LANG_HOOKS_GET_ARRAY_DESCR_INFO NULL
171 #define LANG_HOOKS_GET_SUBRANGE_BOUNDS NULL
172 #define LANG_HOOKS_DESCRIPTIVE_TYPE NULL
173 #define LANG_HOOKS_RECONSTRUCT_COMPLEX_TYPE reconstruct_complex_type
174 
175 #define LANG_HOOKS_FOR_TYPES_INITIALIZER { \
176  LANG_HOOKS_MAKE_TYPE, \
177  LANG_HOOKS_CLASSIFY_RECORD, \
178  LANG_HOOKS_TYPE_FOR_MODE, \
179  LANG_HOOKS_TYPE_FOR_SIZE, \
180  LANG_HOOKS_GENERIC_TYPE_P, \
181  LANG_HOOKS_GET_ARGUMENT_PACK_ELEMS, \
182  LANG_HOOKS_TYPE_PROMOTES_TO, \
183  LANG_HOOKS_REGISTER_BUILTIN_TYPE, \
184  LANG_HOOKS_INCOMPLETE_TYPE_ERROR, \
185  LANG_HOOKS_TYPE_MAX_SIZE, \
186  LANG_HOOKS_OMP_FIRSTPRIVATIZE_TYPE_SIZES, \
187  LANG_HOOKS_TYPE_HASH_EQ, \
188  LANG_HOOKS_GET_ARRAY_DESCR_INFO, \
189  LANG_HOOKS_GET_SUBRANGE_BOUNDS, \
190  LANG_HOOKS_DESCRIPTIVE_TYPE, \
191  LANG_HOOKS_RECONSTRUCT_COMPLEX_TYPE \
192 }
193 
194 /* Declaration hooks. */
195 #define LANG_HOOKS_GLOBAL_BINDINGS_P global_bindings_p
196 #define LANG_HOOKS_PUSHDECL pushdecl
197 #define LANG_HOOKS_GETDECLS getdecls
198 #define LANG_HOOKS_FUNCTION_DECL_EXPLICIT_P hook_bool_tree_false
199 #define LANG_HOOKS_WARN_UNUSED_GLOBAL_DECL lhd_warn_unused_global_decl
200 #define LANG_HOOKS_WRITE_GLOBALS write_global_declarations
201 #define LANG_HOOKS_DECL_OK_FOR_SIBCALL lhd_decl_ok_for_sibcall
202 #define LANG_HOOKS_OMP_PRIVATIZE_BY_REFERENCE hook_bool_const_tree_false
203 #define LANG_HOOKS_OMP_PREDETERMINED_SHARING lhd_omp_predetermined_sharing
204 #define LANG_HOOKS_OMP_REPORT_DECL lhd_pass_through_t
205 #define LANG_HOOKS_OMP_DISREGARD_VALUE_EXPR hook_bool_tree_bool_false
206 #define LANG_HOOKS_OMP_PRIVATE_DEBUG_CLAUSE hook_bool_tree_bool_false
207 #define LANG_HOOKS_OMP_PRIVATE_OUTER_REF hook_bool_tree_false
208 #define LANG_HOOKS_OMP_CLAUSE_DEFAULT_CTOR hook_tree_tree_tree_tree_null
209 #define LANG_HOOKS_OMP_CLAUSE_COPY_CTOR lhd_omp_assignment
210 #define LANG_HOOKS_OMP_CLAUSE_ASSIGN_OP lhd_omp_assignment
211 #define LANG_HOOKS_OMP_CLAUSE_DTOR hook_tree_tree_tree_null
212 #define LANG_HOOKS_OMP_FINISH_CLAUSE hook_void_tree
213 
214 #define LANG_HOOKS_DECLS { \
215  LANG_HOOKS_GLOBAL_BINDINGS_P, \
216  LANG_HOOKS_PUSHDECL, \
217  LANG_HOOKS_GETDECLS, \
218  LANG_HOOKS_FUNCTION_DECL_EXPLICIT_P, \
219  LANG_HOOKS_GENERIC_GENERIC_PARAMETER_DECL_P, \
220  LANG_HOOKS_FUNCTION_PARM_EXPANDED_FROM_PACK_P, \
221  LANG_HOOKS_GET_GENERIC_FUNCTION_DECL, \
222  LANG_HOOKS_WARN_UNUSED_GLOBAL_DECL, \
223  LANG_HOOKS_WRITE_GLOBALS, \
224  LANG_HOOKS_DECL_OK_FOR_SIBCALL, \
225  LANG_HOOKS_OMP_PRIVATIZE_BY_REFERENCE, \
226  LANG_HOOKS_OMP_PREDETERMINED_SHARING, \
227  LANG_HOOKS_OMP_REPORT_DECL, \
228  LANG_HOOKS_OMP_DISREGARD_VALUE_EXPR, \
229  LANG_HOOKS_OMP_PRIVATE_DEBUG_CLAUSE, \
230  LANG_HOOKS_OMP_PRIVATE_OUTER_REF, \
231  LANG_HOOKS_OMP_CLAUSE_DEFAULT_CTOR, \
232  LANG_HOOKS_OMP_CLAUSE_COPY_CTOR, \
233  LANG_HOOKS_OMP_CLAUSE_ASSIGN_OP, \
234  LANG_HOOKS_OMP_CLAUSE_DTOR, \
235  LANG_HOOKS_OMP_FINISH_CLAUSE \
236 }
237 
238 /* LTO hooks. */
239 extern void lhd_begin_section (const char *);
240 extern void lhd_append_data (const void *, size_t, void *);
241 extern void lhd_end_section (void);
242 
243 #define LANG_HOOKS_BEGIN_SECTION lhd_begin_section
244 #define LANG_HOOKS_APPEND_DATA lhd_append_data
245 #define LANG_HOOKS_END_SECTION lhd_end_section
246 
247 #define LANG_HOOKS_LTO { \
248  LANG_HOOKS_BEGIN_SECTION, \
249  LANG_HOOKS_APPEND_DATA, \
250  LANG_HOOKS_END_SECTION \
251 }
252 
253 /* The whole thing. The structure is defined in langhooks.h. */
254 #define LANG_HOOKS_INITIALIZER { \
255  LANG_HOOKS_NAME, \
256  LANG_HOOKS_IDENTIFIER_SIZE, \
257  LANG_HOOKS_FREE_LANG_DATA, \
258  LANG_HOOKS_TREE_SIZE, \
259  LANG_HOOKS_OPTION_LANG_MASK, \
260  LANG_HOOKS_INIT_OPTIONS_STRUCT, \
261  LANG_HOOKS_INIT_OPTIONS, \
262  LANG_HOOKS_INITIALIZE_DIAGNOSTICS, \
263  LANG_HOOKS_COMPLAIN_WRONG_LANG_P, \
264  LANG_HOOKS_HANDLE_OPTION, \
265  LANG_HOOKS_POST_OPTIONS, \
266  LANG_HOOKS_INIT, \
267  LANG_HOOKS_FINISH, \
268  LANG_HOOKS_PARSE_FILE, \
269  LANG_HOOKS_MISSING_NORETURN_OK_P, \
270  LANG_HOOKS_GET_ALIAS_SET, \
271  LANG_HOOKS_FINISH_INCOMPLETE_DECL, \
272  LANG_HOOKS_DUP_LANG_SPECIFIC_DECL, \
273  LANG_HOOKS_SET_DECL_ASSEMBLER_NAME, \
274  LANG_HOOKS_PRINT_STATISTICS, \
275  LANG_HOOKS_PRINT_XNODE, \
276  LANG_HOOKS_PRINT_DECL, \
277  LANG_HOOKS_PRINT_TYPE, \
278  LANG_HOOKS_PRINT_IDENTIFIER, \
279  LANG_HOOKS_DECL_PRINTABLE_NAME, \
280  LANG_HOOKS_DWARF_NAME, \
281  LANG_HOOKS_TYPES_COMPATIBLE_P, \
282  LANG_HOOKS_PRINT_ERROR_FUNCTION, \
283  LANG_HOOKS_TO_TARGET_CHARSET, \
284  LANG_HOOKS_ATTRIBUTE_TABLE, \
285  LANG_HOOKS_COMMON_ATTRIBUTE_TABLE, \
286  LANG_HOOKS_FORMAT_ATTRIBUTE_TABLE, \
287  LANG_HOOKS_TREE_INLINING_INITIALIZER, \
288  LANG_HOOKS_TREE_DUMP_INITIALIZER, \
289  LANG_HOOKS_DECLS, \
290  LANG_HOOKS_FOR_TYPES_INITIALIZER, \
291  LANG_HOOKS_LTO, \
292  LANG_HOOKS_GET_INNERMOST_GENERIC_PARMS, \
293  LANG_HOOKS_GET_INNERMOST_GENERIC_ARGS, \
294  LANG_HOOKS_FUNCTION_PARAMETER_PACK_P, \
295  LANG_HOOKS_GIMPLIFY_EXPR, \
296  LANG_HOOKS_BUILTIN_FUNCTION, \
297  LANG_HOOKS_BUILTIN_FUNCTION_EXT_SCOPE, \
298  LANG_HOOKS_INIT_TS, \
299  LANG_HOOKS_EXPR_TO_DECL, \
300  LANG_HOOKS_EH_PERSONALITY, \
301  LANG_HOOKS_EH_RUNTIME_TYPE, \
302  LANG_HOOKS_EH_PROTECT_CLEANUP_ACTIONS, \
303  LANG_HOOKS_BLOCK_MAY_FALLTHRU, \
304  LANG_HOOKS_EH_USE_CXA_END_CLEANUP, \
305  LANG_HOOKS_DEEP_UNSHARING \
306 }
307 
308 #endif /* GCC_LANG_HOOKS_DEF_H */