For typo in documentation wrt. C_PTRDIFF_T constant
[official-gcc.git] / gcc / langhooks-def.h
blobe4c0ffb799d4859d4d4de49fb018999b37bcdc75
1 /* Default macros to initialize the lang_hooks data structure.
2 Copyright (C) 2001-2016 Free Software Foundation, Inc.
3 Contributed by Alexandre Oliva <aoliva@redhat.com>
5 This file is part of GCC.
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.
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.
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/>. */
21 #ifndef GCC_LANG_HOOKS_DEF_H
22 #define GCC_LANG_HOOKS_DEF_H
24 #include "hooks.h"
26 struct diagnostic_info;
27 class substring_loc;
29 /* Note to creators of new hooks:
31 The macros in this file should NOT be surrounded by a
32 #ifdef...#endif pair, since this file declares the defaults. Each
33 front end overrides any hooks it wishes to, in the file containing
34 its struct lang_hooks, AFTER including this file. */
36 /* See langhooks.h for the definition and documentation of each hook. */
38 extern void lhd_do_nothing (void);
39 extern void lhd_do_nothing_t (tree);
40 extern void lhd_do_nothing_f (struct function *);
41 extern tree lhd_pass_through_t (tree);
42 extern bool lhd_post_options (const char **);
43 extern alias_set_type lhd_get_alias_set (tree);
44 extern tree lhd_return_null_tree (tree);
45 extern tree lhd_return_null_const_tree (const_tree);
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);
51 extern void lhd_print_error_function (diagnostic_context *,
52 const char *, struct diagnostic_info *);
53 extern void lhd_set_decl_assembler_name (tree);
54 extern bool lhd_warn_unused_global_decl (const_tree);
55 extern void lhd_incomplete_type_error (location_t, const_tree, const_tree);
56 extern tree lhd_type_promotes_to (tree);
57 extern void lhd_register_builtin_type (tree, const char *);
58 extern bool lhd_decl_ok_for_sibcall (const_tree);
59 extern size_t lhd_tree_size (enum tree_code);
60 extern HOST_WIDE_INT lhd_to_target_charset (HOST_WIDE_INT);
61 extern tree lhd_expr_to_decl (tree, bool *, bool *);
62 extern tree lhd_builtin_function (tree);
63 extern tree lhd_enum_underlying_base_type (const_tree);
65 /* Declarations of default tree inlining hooks. */
66 extern void lhd_initialize_diagnostics (diagnostic_context *);
67 extern void lhd_init_options (unsigned int,
68 struct cl_decoded_option *);
69 extern bool lhd_complain_wrong_lang_p (const struct cl_option *);
70 extern bool lhd_handle_option (size_t, const char *, int, int, location_t,
71 const struct cl_option_handlers *);
74 /* Declarations for tree gimplification hooks. */
75 extern int lhd_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
76 extern enum omp_clause_default_kind lhd_omp_predetermined_sharing (tree);
77 extern tree lhd_omp_assignment (tree, tree, tree);
78 extern void lhd_omp_finish_clause (tree, gimple_seq *);
79 struct gimplify_omp_ctx;
80 extern void lhd_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *,
81 tree);
82 extern bool lhd_omp_mappable_type (tree);
83 extern bool lhd_omp_scalar_p (tree);
85 extern const char *lhd_get_substring_location (const substring_loc &,
86 location_t *out_loc);
87 extern int lhd_decl_dwarf_attribute (const_tree, int);
88 extern int lhd_type_dwarf_attribute (const_tree, int);
90 #define LANG_HOOKS_NAME "GNU unknown"
91 #define LANG_HOOKS_IDENTIFIER_SIZE sizeof (struct lang_identifier)
92 #define LANG_HOOKS_INIT hook_bool_void_false
93 #define LANG_HOOKS_FINISH lhd_do_nothing
94 #define LANG_HOOKS_PARSE_FILE lhd_do_nothing
95 #define LANG_HOOKS_OPTION_LANG_MASK hook_uint_void_0
96 #define LANG_HOOKS_INIT_OPTIONS_STRUCT hook_void_gcc_optionsp
97 #define LANG_HOOKS_INIT_OPTIONS lhd_init_options
98 #define LANG_HOOKS_INITIALIZE_DIAGNOSTICS lhd_initialize_diagnostics
99 #define LANG_HOOKS_COMPLAIN_WRONG_LANG_P lhd_complain_wrong_lang_p
100 #define LANG_HOOKS_HANDLE_OPTION lhd_handle_option
101 #define LANG_HOOKS_POST_OPTIONS lhd_post_options
102 #define LANG_HOOKS_MISSING_NORETURN_OK_P hook_bool_tree_true
103 #define LANG_HOOKS_GET_ALIAS_SET lhd_get_alias_set
104 #define LANG_HOOKS_FINISH_INCOMPLETE_DECL lhd_do_nothing_t
105 #define LANG_HOOKS_DUP_LANG_SPECIFIC_DECL lhd_do_nothing_t
106 #define LANG_HOOKS_SET_DECL_ASSEMBLER_NAME lhd_set_decl_assembler_name
107 #define LANG_HOOKS_PRINT_STATISTICS lhd_do_nothing
108 #define LANG_HOOKS_PRINT_XNODE lhd_print_tree_nothing
109 #define LANG_HOOKS_PRINT_DECL lhd_print_tree_nothing
110 #define LANG_HOOKS_PRINT_TYPE lhd_print_tree_nothing
111 #define LANG_HOOKS_PRINT_IDENTIFIER lhd_print_tree_nothing
112 #define LANG_HOOKS_PRINT_ERROR_FUNCTION lhd_print_error_function
113 #define LANG_HOOKS_DECL_PRINTABLE_NAME lhd_decl_printable_name
114 #define LANG_HOOKS_DWARF_NAME lhd_dwarf_name
115 #define LANG_HOOKS_FREE_LANG_DATA lhd_do_nothing_t
116 #define LANG_HOOKS_TREE_SIZE lhd_tree_size
117 #define LANG_HOOKS_TYPES_COMPATIBLE_P lhd_types_compatible_p
118 #define LANG_HOOKS_BUILTIN_FUNCTION lhd_builtin_function
119 #define LANG_HOOKS_BUILTIN_FUNCTION_EXT_SCOPE LANG_HOOKS_BUILTIN_FUNCTION
120 #define LANG_HOOKS_EXPR_TO_DECL lhd_expr_to_decl
121 #define LANG_HOOKS_TO_TARGET_CHARSET lhd_to_target_charset
122 #define LANG_HOOKS_INIT_TS lhd_do_nothing
123 #define LANG_HOOKS_EH_PERSONALITY lhd_gcc_personality
124 #define LANG_HOOKS_EH_RUNTIME_TYPE lhd_pass_through_t
125 #define LANG_HOOKS_EH_PROTECT_CLEANUP_ACTIONS NULL
126 #define LANG_HOOKS_BLOCK_MAY_FALLTHRU hook_bool_const_tree_true
127 #define LANG_HOOKS_EH_USE_CXA_END_CLEANUP false
128 #define LANG_HOOKS_DEEP_UNSHARING false
129 #define LANG_HOOKS_CUSTOM_FUNCTION_DESCRIPTORS false
130 #define LANG_HOOKS_RUN_LANG_SELFTESTS lhd_do_nothing
131 #define LANG_HOOKS_GET_SUBSTRING_LOCATION lhd_get_substring_location
133 /* Attribute hooks. */
134 #define LANG_HOOKS_ATTRIBUTE_TABLE NULL
135 #define LANG_HOOKS_COMMON_ATTRIBUTE_TABLE NULL
136 #define LANG_HOOKS_FORMAT_ATTRIBUTE_TABLE NULL
138 /* Tree inlining hooks. */
139 #define LANG_HOOKS_TREE_INLINING_VAR_MOD_TYPE_P \
140 hook_bool_tree_tree_false
142 #define LANG_HOOKS_TREE_INLINING_INITIALIZER { \
143 LANG_HOOKS_TREE_INLINING_VAR_MOD_TYPE_P, \
146 /* Hooks for tree gimplification. */
147 #define LANG_HOOKS_GIMPLIFY_EXPR lhd_gimplify_expr
149 /* Tree dump hooks. */
150 extern bool lhd_tree_dump_dump_tree (void *, tree);
151 extern int lhd_tree_dump_type_quals (const_tree);
152 extern tree lhd_make_node (enum tree_code);
154 #define LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN lhd_tree_dump_dump_tree
155 #define LANG_HOOKS_TREE_DUMP_TYPE_QUALS_FN lhd_tree_dump_type_quals
157 #define LANG_HOOKS_TREE_DUMP_INITIALIZER { \
158 LANG_HOOKS_TREE_DUMP_DUMP_TREE_FN, \
159 LANG_HOOKS_TREE_DUMP_TYPE_QUALS_FN \
162 /* Types hooks. There are no reasonable defaults for most of them,
163 so we create a compile-time error instead. */
164 #define LANG_HOOKS_MAKE_TYPE lhd_make_node
165 #define LANG_HOOKS_CLASSIFY_RECORD NULL
166 #define LANG_HOOKS_INCOMPLETE_TYPE_ERROR lhd_incomplete_type_error
167 #define LANG_HOOKS_GENERIC_TYPE_P hook_bool_const_tree_false
168 #define LANG_HOOKS_GET_INNERMOST_GENERIC_PARMS hook_tree_const_tree_null
169 #define LANG_HOOKS_GET_INNERMOST_GENERIC_ARGS hook_tree_const_tree_null
170 #define LANG_HOOKS_FUNCTION_PARAMETER_PACK_P hook_bool_const_tree_false
171 #define LANG_HOOKS_GET_ARGUMENT_PACK_ELEMS hook_tree_const_tree_null
172 #define LANG_HOOKS_GENERIC_GENERIC_PARAMETER_DECL_P hook_bool_const_tree_false
173 #define LANG_HOOKS_FUNCTION_PARM_EXPANDED_FROM_PACK_P \
174 hook_bool_tree_tree_false
175 #define LANG_HOOKS_GET_GENERIC_FUNCTION_DECL hook_tree_const_tree_null
176 #define LANG_HOOKS_TYPE_PROMOTES_TO lhd_type_promotes_to
177 #define LANG_HOOKS_REGISTER_BUILTIN_TYPE lhd_register_builtin_type
178 #define LANG_HOOKS_TYPE_MAX_SIZE lhd_return_null_const_tree
179 #define LANG_HOOKS_OMP_FIRSTPRIVATIZE_TYPE_SIZES \
180 lhd_omp_firstprivatize_type_sizes
181 #define LANG_HOOKS_OMP_MAPPABLE_TYPE lhd_omp_mappable_type
182 #define LANG_HOOKS_TYPE_HASH_EQ NULL
183 #define LANG_HOOKS_GET_ARRAY_DESCR_INFO NULL
184 #define LANG_HOOKS_GET_SUBRANGE_BOUNDS NULL
185 #define LANG_HOOKS_GET_TYPE_BIAS NULL
186 #define LANG_HOOKS_DESCRIPTIVE_TYPE NULL
187 #define LANG_HOOKS_RECONSTRUCT_COMPLEX_TYPE reconstruct_complex_type
188 #define LANG_HOOKS_ENUM_UNDERLYING_BASE_TYPE lhd_enum_underlying_base_type
189 #define LANG_HOOKS_GET_DEBUG_TYPE NULL
190 #define LANG_HOOKS_GET_FIXED_POINT_TYPE_INFO NULL
191 #define LANG_HOOKS_TYPE_DWARF_ATTRIBUTE lhd_type_dwarf_attribute
193 #define LANG_HOOKS_FOR_TYPES_INITIALIZER { \
194 LANG_HOOKS_MAKE_TYPE, \
195 LANG_HOOKS_CLASSIFY_RECORD, \
196 LANG_HOOKS_TYPE_FOR_MODE, \
197 LANG_HOOKS_TYPE_FOR_SIZE, \
198 LANG_HOOKS_GENERIC_TYPE_P, \
199 LANG_HOOKS_GET_ARGUMENT_PACK_ELEMS, \
200 LANG_HOOKS_TYPE_PROMOTES_TO, \
201 LANG_HOOKS_REGISTER_BUILTIN_TYPE, \
202 LANG_HOOKS_INCOMPLETE_TYPE_ERROR, \
203 LANG_HOOKS_TYPE_MAX_SIZE, \
204 LANG_HOOKS_OMP_FIRSTPRIVATIZE_TYPE_SIZES, \
205 LANG_HOOKS_OMP_MAPPABLE_TYPE, \
206 LANG_HOOKS_TYPE_HASH_EQ, \
207 LANG_HOOKS_GET_ARRAY_DESCR_INFO, \
208 LANG_HOOKS_GET_SUBRANGE_BOUNDS, \
209 LANG_HOOKS_GET_TYPE_BIAS, \
210 LANG_HOOKS_DESCRIPTIVE_TYPE, \
211 LANG_HOOKS_RECONSTRUCT_COMPLEX_TYPE, \
212 LANG_HOOKS_ENUM_UNDERLYING_BASE_TYPE, \
213 LANG_HOOKS_GET_DEBUG_TYPE, \
214 LANG_HOOKS_GET_FIXED_POINT_TYPE_INFO, \
215 LANG_HOOKS_TYPE_DWARF_ATTRIBUTE \
218 /* Declaration hooks. */
219 #define LANG_HOOKS_GLOBAL_BINDINGS_P global_bindings_p
220 #define LANG_HOOKS_PUSHDECL pushdecl
221 #define LANG_HOOKS_GETDECLS getdecls
222 #define LANG_HOOKS_DECL_DWARF_ATTRIBUTE lhd_decl_dwarf_attribute
223 #define LANG_HOOKS_WARN_UNUSED_GLOBAL_DECL lhd_warn_unused_global_decl
224 #define LANG_HOOKS_POST_COMPILATION_PARSING_CLEANUPS NULL
225 #define LANG_HOOKS_DECL_OK_FOR_SIBCALL lhd_decl_ok_for_sibcall
226 #define LANG_HOOKS_OMP_PRIVATIZE_BY_REFERENCE hook_bool_const_tree_false
227 #define LANG_HOOKS_OMP_PREDETERMINED_SHARING lhd_omp_predetermined_sharing
228 #define LANG_HOOKS_OMP_REPORT_DECL lhd_pass_through_t
229 #define LANG_HOOKS_OMP_DISREGARD_VALUE_EXPR hook_bool_tree_bool_false
230 #define LANG_HOOKS_OMP_PRIVATE_DEBUG_CLAUSE hook_bool_tree_bool_false
231 #define LANG_HOOKS_OMP_PRIVATE_OUTER_REF hook_bool_tree_false
232 #define LANG_HOOKS_OMP_CLAUSE_DEFAULT_CTOR hook_tree_tree_tree_tree_null
233 #define LANG_HOOKS_OMP_CLAUSE_COPY_CTOR lhd_omp_assignment
234 #define LANG_HOOKS_OMP_CLAUSE_ASSIGN_OP lhd_omp_assignment
235 #define LANG_HOOKS_OMP_CLAUSE_LINEAR_CTOR NULL
236 #define LANG_HOOKS_OMP_CLAUSE_DTOR hook_tree_tree_tree_null
237 #define LANG_HOOKS_OMP_FINISH_CLAUSE lhd_omp_finish_clause
238 #define LANG_HOOKS_OMP_SCALAR_P lhd_omp_scalar_p
240 #define LANG_HOOKS_DECLS { \
241 LANG_HOOKS_GLOBAL_BINDINGS_P, \
242 LANG_HOOKS_PUSHDECL, \
243 LANG_HOOKS_GETDECLS, \
244 LANG_HOOKS_DECL_DWARF_ATTRIBUTE, \
245 LANG_HOOKS_GENERIC_GENERIC_PARAMETER_DECL_P, \
246 LANG_HOOKS_FUNCTION_PARM_EXPANDED_FROM_PACK_P, \
247 LANG_HOOKS_GET_GENERIC_FUNCTION_DECL, \
248 LANG_HOOKS_WARN_UNUSED_GLOBAL_DECL, \
249 LANG_HOOKS_POST_COMPILATION_PARSING_CLEANUPS, \
250 LANG_HOOKS_DECL_OK_FOR_SIBCALL, \
251 LANG_HOOKS_OMP_PRIVATIZE_BY_REFERENCE, \
252 LANG_HOOKS_OMP_PREDETERMINED_SHARING, \
253 LANG_HOOKS_OMP_REPORT_DECL, \
254 LANG_HOOKS_OMP_DISREGARD_VALUE_EXPR, \
255 LANG_HOOKS_OMP_PRIVATE_DEBUG_CLAUSE, \
256 LANG_HOOKS_OMP_PRIVATE_OUTER_REF, \
257 LANG_HOOKS_OMP_CLAUSE_DEFAULT_CTOR, \
258 LANG_HOOKS_OMP_CLAUSE_COPY_CTOR, \
259 LANG_HOOKS_OMP_CLAUSE_ASSIGN_OP, \
260 LANG_HOOKS_OMP_CLAUSE_LINEAR_CTOR, \
261 LANG_HOOKS_OMP_CLAUSE_DTOR, \
262 LANG_HOOKS_OMP_FINISH_CLAUSE, \
263 LANG_HOOKS_OMP_SCALAR_P \
266 /* LTO hooks. */
267 extern void lhd_begin_section (const char *);
268 extern void lhd_append_data (const void *, size_t, void *);
269 extern void lhd_end_section (void);
271 #define LANG_HOOKS_BEGIN_SECTION lhd_begin_section
272 #define LANG_HOOKS_APPEND_DATA lhd_append_data
273 #define LANG_HOOKS_END_SECTION lhd_end_section
275 #define LANG_HOOKS_LTO { \
276 LANG_HOOKS_BEGIN_SECTION, \
277 LANG_HOOKS_APPEND_DATA, \
278 LANG_HOOKS_END_SECTION \
281 /* The whole thing. The structure is defined in langhooks.h. */
282 #define LANG_HOOKS_INITIALIZER { \
283 LANG_HOOKS_NAME, \
284 LANG_HOOKS_IDENTIFIER_SIZE, \
285 LANG_HOOKS_FREE_LANG_DATA, \
286 LANG_HOOKS_TREE_SIZE, \
287 LANG_HOOKS_OPTION_LANG_MASK, \
288 LANG_HOOKS_INIT_OPTIONS_STRUCT, \
289 LANG_HOOKS_INIT_OPTIONS, \
290 LANG_HOOKS_INITIALIZE_DIAGNOSTICS, \
291 LANG_HOOKS_COMPLAIN_WRONG_LANG_P, \
292 LANG_HOOKS_HANDLE_OPTION, \
293 LANG_HOOKS_POST_OPTIONS, \
294 LANG_HOOKS_INIT, \
295 LANG_HOOKS_FINISH, \
296 LANG_HOOKS_PARSE_FILE, \
297 LANG_HOOKS_MISSING_NORETURN_OK_P, \
298 LANG_HOOKS_GET_ALIAS_SET, \
299 LANG_HOOKS_FINISH_INCOMPLETE_DECL, \
300 LANG_HOOKS_DUP_LANG_SPECIFIC_DECL, \
301 LANG_HOOKS_SET_DECL_ASSEMBLER_NAME, \
302 LANG_HOOKS_PRINT_STATISTICS, \
303 LANG_HOOKS_PRINT_XNODE, \
304 LANG_HOOKS_PRINT_DECL, \
305 LANG_HOOKS_PRINT_TYPE, \
306 LANG_HOOKS_PRINT_IDENTIFIER, \
307 LANG_HOOKS_DECL_PRINTABLE_NAME, \
308 LANG_HOOKS_DWARF_NAME, \
309 LANG_HOOKS_TYPES_COMPATIBLE_P, \
310 LANG_HOOKS_PRINT_ERROR_FUNCTION, \
311 LANG_HOOKS_TO_TARGET_CHARSET, \
312 LANG_HOOKS_ATTRIBUTE_TABLE, \
313 LANG_HOOKS_COMMON_ATTRIBUTE_TABLE, \
314 LANG_HOOKS_FORMAT_ATTRIBUTE_TABLE, \
315 LANG_HOOKS_TREE_INLINING_INITIALIZER, \
316 LANG_HOOKS_TREE_DUMP_INITIALIZER, \
317 LANG_HOOKS_DECLS, \
318 LANG_HOOKS_FOR_TYPES_INITIALIZER, \
319 LANG_HOOKS_LTO, \
320 LANG_HOOKS_GET_INNERMOST_GENERIC_PARMS, \
321 LANG_HOOKS_GET_INNERMOST_GENERIC_ARGS, \
322 LANG_HOOKS_FUNCTION_PARAMETER_PACK_P, \
323 LANG_HOOKS_GIMPLIFY_EXPR, \
324 LANG_HOOKS_BUILTIN_FUNCTION, \
325 LANG_HOOKS_BUILTIN_FUNCTION_EXT_SCOPE, \
326 LANG_HOOKS_INIT_TS, \
327 LANG_HOOKS_EXPR_TO_DECL, \
328 LANG_HOOKS_EH_PERSONALITY, \
329 LANG_HOOKS_EH_RUNTIME_TYPE, \
330 LANG_HOOKS_EH_PROTECT_CLEANUP_ACTIONS, \
331 LANG_HOOKS_BLOCK_MAY_FALLTHRU, \
332 LANG_HOOKS_EH_USE_CXA_END_CLEANUP, \
333 LANG_HOOKS_DEEP_UNSHARING, \
334 LANG_HOOKS_CUSTOM_FUNCTION_DESCRIPTORS, \
335 LANG_HOOKS_RUN_LANG_SELFTESTS, \
336 LANG_HOOKS_GET_SUBSTRING_LOCATION \
339 #endif /* GCC_LANG_HOOKS_DEF_H */