Match: Only allow single use of MIN_EXPR for SAT_TRUNC form 2 [PR115863]
[official-gcc.git] / gcc / ada / fe.h
blobb4c1aea5c8b24df0f25581bb890f4769a7f3539a
1 /****************************************************************************
2 * *
3 * GNAT COMPILER COMPONENTS *
4 * *
5 * FE *
6 * *
7 * C Header File *
8 * *
9 * Copyright (C) 1992-2024, Free Software Foundation, Inc. *
10 * *
11 * GNAT is free software; you can redistribute it and/or modify it under *
12 * terms of the GNU General Public License as published by the Free Soft- *
13 * ware Foundation; either version 3, or (at your option) any later ver- *
14 * sion. GNAT is distributed in the hope that it will be useful, but WITH- *
15 * OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
16 * or FITNESS FOR A PARTICULAR PURPOSE. *
17 * *
18 * As a special exception under Section 7 of GPL version 3, you are granted *
19 * additional permissions described in the GCC Runtime Library Exception, *
20 * version 3.1, as published by the Free Software Foundation. *
21 * *
22 * You should have received a copy of the GNU General Public License and *
23 * a copy of the GCC Runtime Library Exception along with this program; *
24 * see the files COPYING3 and COPYING.RUNTIME respectively. If not, see *
25 * <http://www.gnu.org/licenses/>. *
26 * *
27 * GNAT was originally developed by the GNAT team at New York University. *
28 * Extensive contributions were provided by Ada Core Technologies Inc. *
29 * *
30 ****************************************************************************/
32 /* This is the C header that contains the declarations of Ada subprograms and
33 variables used by gigi and not declared in other C header files. It was
34 created manually from Ada specifications. The original Ada declarations
35 in these specifications must be marked with:
37 "WARNING: There is a matching C declaration of this <entity_kind> in fe.h"
39 where <entity_kind> is either "subprogram" or "variable" or "type".
41 WARNING: functions taking String_Pointer parameters must abide by the rule
42 documented alongside the definition of String_Pointer in types.h. */
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
48 /* atree: */
50 #define Serious_Errors_Detected atree__serious_errors_detected
52 extern Nat Serious_Errors_Detected;
54 /* comperr: */
56 #define Compiler_Abort comperr__compiler_abort
58 extern void Compiler_Abort (String_Pointer, String_Pointer, Boolean) ATTRIBUTE_NORETURN;
60 /* debug: */
62 #define Debug_Flag_Dot_KK debug__debug_flag_dot_kk
63 #define Debug_Flag_Dot_R debug__debug_flag_dot_r
64 #define Debug_Flag_Dot_8 debug__debug_flag_dot_8
65 #define Debug_Flag_NN debug__debug_flag_nn
67 extern Boolean Debug_Flag_Dot_KK;
68 extern Boolean Debug_Flag_Dot_R;
69 extern Boolean Debug_Flag_Dot_8;
70 extern Boolean Debug_Flag_NN;
72 /* einfo: */
74 /* Valid_Uint is used to preserve the old behavior of Esize and
75 friends, where Uint_0 was the default. All calls to this
76 are questionable. */
77 INLINE Valid_Uint
78 No_Uint_To_0 (Uint X)
80 return X == No_Uint ? Uint_0 : X;
83 #define Set_Alignment einfo__entities__set_alignment
84 #define Set_Component_Bit_Offset einfo__entities__set_component_bit_offset
85 #define Set_Component_Size einfo__entities__set_component_size
86 #define Set_Esize einfo__entities__set_esize
87 #define Set_Mechanism einfo__entities__set_mechanism
88 #define Set_Normalized_First_Bit einfo__entities__set_normalized_first_bit
89 #define Set_Normalized_Position einfo__entities__set_normalized_position
90 #define Set_RM_Size einfo__entities__set_rm_size
92 extern void Set_Alignment (Entity_Id, Uint);
93 extern void Set_Component_Bit_Offset (Entity_Id, Uint);
94 extern void Set_Component_Size (Entity_Id, Uint);
95 extern void Set_Esize (Entity_Id, Uint);
96 extern void Set_Mechanism (Entity_Id, Mechanism_Type);
97 extern void Set_Normalized_First_Bit (Entity_Id, Uint);
98 extern void Set_Normalized_Position (Entity_Id, Uint);
99 extern void Set_RM_Size (Entity_Id, Uint);
101 #define Is_Base_Type einfo__utils__is_base_type
102 #define Is_Entity_Name einfo__utils__is_entity_name
104 extern Boolean Is_Base_Type (Entity_Id);
105 extern Boolean Is_Entity_Name (Node_Id);
107 #define Get_Attribute_Definition_Clause einfo__utils__get_attribute_definition_clause
109 extern Node_Id Get_Attribute_Definition_Clause (Entity_Id, unsigned char);
111 /* errout: */
113 #define Error_Msg_N errout__error_msg_n
114 #define Error_Msg_NE errout__error_msg_ne
115 #define Set_Identifier_Casing errout__set_identifier_casing
117 extern void Error_Msg_N (String_Pointer, Node_Id);
118 extern void Error_Msg_NE (String_Pointer, Node_Id, Entity_Id);
119 extern void Set_Identifier_Casing (void *, const void *);
121 /* err_vars: */
123 #define Error_Msg_Uint_1 err_vars__error_msg_uint_1
124 #define Error_Msg_Uint_2 err_vars__error_msg_uint_2
126 extern Uint Error_Msg_Uint_1;
127 extern Uint Error_Msg_Uint_2;
129 /* exp_ch11: */
131 #define Get_Local_Raise_Call_Entity exp_ch11__get_local_raise_call_entity
132 #define Get_RT_Exception_Entity exp_ch11__get_rt_exception_entity
133 #define Get_RT_Exception_Name exp_ch11__get_rt_exception_name
134 #define Warn_If_No_Local_Raise exp_ch11__warn_if_no_local_raise
136 extern Entity_Id Get_Local_Raise_Call_Entity (void);
137 extern Entity_Id Get_RT_Exception_Entity (int);
138 extern void Get_RT_Exception_Name (enum RT_Exception_Code);
139 extern void Warn_If_No_Local_Raise (int);
141 /* exp_code: */
143 #define Asm_Input_Constraint exp_code__asm_input_constraint
144 #define Asm_Input_Value exp_code__asm_input_value
145 #define Asm_Output_Constraint exp_code__asm_output_constraint
146 #define Asm_Output_Variable exp_code__asm_output_variable
147 #define Asm_Template exp_code__asm_template
148 #define Clobber_Get_Next exp_code__clobber_get_next
149 #define Clobber_Setup exp_code__clobber_setup
150 #define Is_Asm_Volatile exp_code__is_asm_volatile
151 #define Next_Asm_Input exp_code__next_asm_input
152 #define Next_Asm_Output exp_code__next_asm_output
153 #define Setup_Asm_Inputs exp_code__setup_asm_inputs
154 #define Setup_Asm_Outputs exp_code__setup_asm_outputs
156 extern Node_Id Asm_Input_Constraint (void);
157 extern Node_Id Asm_Input_Value (void);
158 extern Node_Id Asm_Output_Constraint (void);
159 extern Node_Id Asm_Output_Variable (void);
160 extern Node_Id Asm_Template (Node_Id);
161 extern void *Clobber_Get_Next (void);
162 extern void Clobber_Setup (Node_Id);
163 extern Boolean Is_Asm_Volatile (Node_Id);
164 extern void Next_Asm_Input (void);
165 extern void Next_Asm_Output (void);
166 extern void Setup_Asm_Inputs (Node_Id);
167 extern void Setup_Asm_Outputs (Node_Id);
169 /* exp_dbug: */
171 #define Get_Encoded_Name exp_dbug__get_encoded_name
172 #define Get_External_Name exp_dbug__get_external_name
173 #define Get_Variant_Encoding exp_dbug__get_variant_encoding
175 extern void Get_Encoded_Name (Entity_Id);
176 extern void Get_External_Name (Entity_Id, Boolean, String_Pointer);
177 extern void Get_Variant_Encoding (Entity_Id);
179 /* exp_tss: */
181 #define Is_Init_Proc exp_tss__is_init_proc
183 extern Boolean Is_Init_Proc (Entity_Id);
185 /* exp_util: */
187 #define Find_Interface_Tag exp_util__find_interface_tag
188 #define Is_Fully_Repped_Tagged_Type exp_util__is_fully_repped_tagged_type
189 #define Is_Related_To_Func_Return exp_util__is_related_to_func_return
190 #define Is_Secondary_Stack_Thunk exp_util__is_secondary_stack_thunk
191 #define Thunk_Target exp_util__thunk_target
193 extern Entity_Id Find_Interface_Tag (Entity_Id, Entity_Id);
194 extern Boolean Is_Fully_Repped_Tagged_Type (Entity_Id);
195 extern Boolean Is_Related_To_Func_Return (Entity_Id);
196 extern Boolean Is_Secondary_Stack_Thunk (Entity_Id);
197 extern Entity_Id Thunk_Target (Entity_Id);
199 /* lib: */
201 #define Cunit lib__cunit
202 #define Ident_String lib__ident_string
203 #define In_Extended_Main_Code_Unit lib__in_extended_main_code_unit
205 extern Node_Id Cunit (Unit_Number_Type);
206 extern Node_Id Ident_String (Unit_Number_Type);
207 extern Boolean In_Extended_Main_Code_Unit (Entity_Id);
209 /* opt: */
211 #define Ada_Version opt__ada_version
212 #define Back_End_Inlining opt__back_end_inlining
213 #define Debug_Generated_Code opt__debug_generated_code
214 #define Enable_128bit_Types opt__enable_128bit_types
215 #define Exception_Extra_Info opt__exception_extra_info
216 #define Exception_Locations_Suppressed opt__exception_locations_suppressed
217 #define Generate_SCO_Instance_Table opt__generate_sco_instance_table
218 #define GNAT_Mode opt__gnat_mode
219 #define List_Representation_Info opt__list_representation_info
220 #define No_Strict_Aliasing_CP opt__no_strict_aliasing
221 #define Suppress_Checks opt__suppress_checks
222 #define Unnest_Subprogram_Mode opt__unnest_subprogram_mode
224 typedef enum {
225 Ada_83, Ada_95, Ada_2005, Ada_2012, Ada_2022
226 } Ada_Version_Type;
227 // Ada_With_Core_Extensions and Ada_With_All_Extensions (see opt.ads) are not
228 // used on the C side for now. If we decide to use them, we should import
229 // All_Extensions_Allowed and Core_Extensions_Allowed functions.
231 extern Ada_Version_Type Ada_Version;
232 extern Boolean Back_End_Inlining;
233 extern Boolean Debug_Generated_Code;
234 extern Boolean Enable_128bit_Types;
235 extern Boolean Exception_Extra_Info;
236 extern Boolean Exception_Locations_Suppressed;
237 extern Boolean Generate_SCO_Instance_Table;
238 extern Boolean GNAT_Mode;
239 extern Int List_Representation_Info;
240 extern Boolean No_Strict_Aliasing_CP;
241 extern Boolean Suppress_Checks;
242 extern Boolean Unnest_Subprogram_Mode;
244 #define ZCX_Exceptions opt__zcx_exceptions
245 #define SJLJ_Exceptions opt__sjlj_exceptions
247 extern Boolean ZCX_Exceptions (void);
248 extern Boolean SJLJ_Exceptions (void);
250 /* restrict: */
252 #define Check_Elaboration_Code_Allowed \
253 restrict__check_elaboration_code_allowed
254 #define Check_Implicit_Dynamic_Code_Allowed \
255 restrict__check_implicit_dynamic_code_allowed
256 #define Check_No_Implicit_Heap_Alloc \
257 restrict__check_no_implicit_heap_alloc
258 #define Check_No_Implicit_Protected_Alloc \
259 restrict__check_no_implicit_protected_alloc
260 #define Check_No_Implicit_Task_Alloc \
261 restrict__check_no_implicit_task_alloc
262 #define Check_Restriction_No_Dependence_On_System \
263 restrict__check_restriction_no_dependence_on_system
264 #define No_Exception_Handlers_Set \
265 restrict__no_exception_handlers_set
266 #define No_Exception_Propagation_Active \
267 restrict__no_exception_propagation_active
269 extern void Check_Elaboration_Code_Allowed (Node_Id);
270 extern void Check_Implicit_Dynamic_Code_Allowed (Node_Id);
271 extern void Check_No_Implicit_Heap_Alloc (Node_Id);
272 extern void Check_No_Implicit_Protected_Alloc (Node_Id);
273 extern void Check_No_Implicit_Task_Alloc (Node_Id);
274 extern void Check_Restriction_No_Dependence_On_System (Name_Id, Node_Id);
275 extern Boolean No_Exception_Handlers_Set (void);
276 extern Boolean No_Exception_Propagation_Active (void);
278 /* sem_aggr: */
280 #define Is_Single_Aggregate sem_aggr__is_single_aggregate
282 extern Boolean Is_Single_Aggregate (Node_Id);
284 /* sem_aux: */
286 #define Ancestor_Subtype sem_aux__ancestor_subtype
287 #define Constant_Value sem_aux__constant_value
288 #define First_Discriminant sem_aux__first_discriminant
289 #define First_Stored_Discriminant sem_aux__first_stored_discriminant
290 #define First_Subtype sem_aux__first_subtype
291 #define Is_By_Reference_Type sem_aux__is_by_reference_type
292 #define Is_Derived_Type sem_aux__is_derived_type
294 extern Entity_Id Ancestor_Subtype (Entity_Id);
295 extern Node_Id Constant_Value (Entity_Id);
296 extern Entity_Id First_Discriminant (Entity_Id);
297 extern Entity_Id First_Stored_Discriminant (Entity_Id);
298 extern Entity_Id First_Subtype (Entity_Id);
299 extern Boolean Is_By_Reference_Type (Entity_Id);
300 extern Boolean Is_Derived_Type (Entity_Id);
302 /* sem_eval: */
304 #define Compile_Time_Known_Value sem_eval__compile_time_known_value
305 #define Is_Null_Range sem_eval__is_null_range
307 extern Boolean Compile_Time_Known_Value (Node_Id);
308 extern Boolean Is_Null_Range (Node_Id, Node_Id);
310 /* sem_util: */
312 #define Defining_Entity sem_util__defining_entity
313 #define First_Actual sem_util__first_actual
314 #define Has_Storage_Model_Type_Aspect sem_util__storage_model_support__has_storage_model_type_aspect
315 #define Has_Designated_Storage_Model_Aspect sem_util__storage_model_support__has_designated_storage_model_aspect
316 #define Is_Expression_Function sem_util__is_expression_function
317 #define Is_Variable_Size_Record sem_util__is_variable_size_record
318 #define Needs_Secondary_Stack sem_util__needs_secondary_stack
319 #define Next_Actual sem_util__next_actual
320 #define Storage_Model_Object sem_util__storage_model_support__storage_model_object
321 #define Storage_Model_Copy_From sem_util__storage_model_support__storage_model_copy_from
322 #define Storage_Model_Copy_To sem_util__storage_model_support__storage_model_copy_to
324 extern Entity_Id Defining_Entity (Node_Id);
325 extern Node_Id First_Actual (Node_Id);
326 extern Boolean Has_Storage_Model_Type_Aspect (Entity_Id);
327 extern Boolean Has_Designated_Storage_Model_Aspect (Entity_Id);
328 extern Boolean Is_Expression_Function (Entity_Id);
329 extern Boolean Is_Variable_Size_Record (Entity_Id);
330 extern Boolean Needs_Secondary_Stack (Entity_Id);
331 extern Node_Id Next_Actual (Node_Id);
332 extern Entity_Id Storage_Model_Object (Entity_Id);
333 extern Entity_Id Storage_Model_Copy_From (Entity_Id);
334 extern Entity_Id Storage_Model_Copy_To (Entity_Id);
336 /* sinfo: */
338 #define End_Location sinfo__utils__end_location
339 #define Set_Has_No_Elaboration_Code sinfo__nodes__set_has_no_elaboration_code
340 #define Set_Present_Expr sinfo__nodes__set_present_expr
342 extern Source_Ptr End_Location (Node_Id);
343 extern void Set_Has_No_Elaboration_Code (Node_Id, Boolean);
344 extern void Set_Present_Expr (Node_Id, Uint);
346 /* sinput: */
348 #define Debug_Source_Name sinput__debug_source_name
349 #define Get_Column_Number sinput__get_column_number
350 #define Get_Logical_Line_Number sinput__get_logical_line_number
351 #define Get_Source_File_Index sinput__get_source_file_index
353 extern File_Name_Type Debug_Source_Name (Source_File_Index);
354 extern Column_Number_Type Get_Column_Number (Source_Ptr);
355 extern Line_Number_Type Get_Logical_Line_Number (Source_Ptr);
356 extern Source_File_Index Get_Source_File_Index (Source_Ptr);
358 /* targparm: */
360 #define Machine_Overflows_On_Target \
361 targparm__machine_overflows_on_target
362 #define Signed_Zeros_On_Target \
363 targparm__signed_zeros_on_target
364 #define Stack_Check_Limits_On_Target \
365 targparm__stack_check_limits_on_target
366 #define Stack_Check_Probes_On_Target \
367 targparm__stack_check_probes_on_target
369 extern Boolean Machine_Overflows_On_Target;
370 extern Boolean Signed_Zeros_On_Target;
371 extern Boolean Stack_Check_Limits_On_Target;
372 extern Boolean Stack_Check_Probes_On_Target;
374 /* warnsw: */
376 #define Get_Warn_On_Questionable_Layout warnsw__get_warn_on_questionable_layout
378 extern Boolean Get_Warn_On_Questionable_Layout (void);
380 // The following corresponds to Ada code in Einfo.Utils.
382 typedef Boolean B;
383 typedef Entity_Id E;
384 typedef Node_Id N;
386 #define Address_Clause einfo__utils__address_clause
387 extern N Address_Clause (E Id);
389 #define Alignment_Clause einfo__utils__alignment_clause
390 extern N Alignment_Clause (E Id);
392 #define Base_Type einfo__utils__base_type
393 extern E Base_Type (E Id);
395 #define Declaration_Node einfo__utils__declaration_node
396 extern N Declaration_Node (E Id);
398 #define Designated_Type einfo__utils__designated_type
399 extern E Designated_Type (E Id);
401 #define First_Formal einfo__utils__first_formal
402 extern E First_Formal (E Id);
404 #define First_Formal_With_Extras einfo__utils__first_formal_with_extras
405 extern E First_Formal_With_Extras (E Id);
407 #define Has_Foreign_Convention einfo__utils__has_foreign_convention
408 extern B Has_Foreign_Convention (E Id);
410 #define Implementation_Base_Type einfo__utils__implementation_base_type
411 extern E Implementation_Base_Type (E Id);
413 #define Is_Boolean_Type einfo__utils__is_boolean_type
414 extern B Is_Boolean_Type (E Id);
416 #define Next_Discriminant einfo__utils__next_discriminant
417 extern E Next_Discriminant (E Id);
419 #define Next_Formal einfo__utils__next_formal
420 extern E Next_Formal (E Id);
422 #define Next_Formal_With_Extras einfo__utils__next_formal_with_extras
423 extern E Next_Formal_With_Extras (E Id);
425 #define Number_Dimensions einfo__utils__number_dimensions
426 extern Pos Number_Dimensions (E Id);
428 #define Object_Size_Clause einfo__utils__object_size_clause
429 extern N Object_Size_Clause (E Id);
431 #define Root_Type einfo__utils__root_type
432 extern E Root_Type (E Id);
434 #define Size_Clause einfo__utils__size_clause
435 extern N Size_Clause (E Id);
437 #define Type_High_Bound einfo__utils__type_high_bound
438 extern N Type_High_Bound (E Id);
440 #define Type_Low_Bound einfo__utils__type_low_bound
441 extern N Type_Low_Bound (E Id);
443 #define Underlying_Type einfo__utils__underlying_type
444 extern E Underlying_Type (E Id);
446 #define Known_Alignment einfo__utils__known_alignment
447 extern B Known_Alignment (Entity_Id E);
449 #define Known_Component_Size einfo__utils__known_component_size
450 extern B Known_Component_Size (Entity_Id E);
452 #define Known_Esize einfo__utils__known_esize
453 extern B Known_Esize (Entity_Id E);
455 #define Known_Normalized_Position einfo__utils__known_normalized_position
456 extern B Known_Normalized_Position (Entity_Id E);
458 #define Known_RM_Size einfo__utils__known_rm_size
459 extern B Known_RM_Size (Entity_Id E);
461 #define Copy_Alignment einfo__utils__copy_alignment
462 extern B Copy_Alignment(Entity_Id To, Entity_Id From);
464 #define Copy_Esize einfo__utils__copy_esize
465 extern B Copy_Esize(Entity_Id To, Entity_Id From);
467 #define Copy_RM_Size einfo__utils__copy_rm_size
468 extern B Copy_RM_Size(Entity_Id To, Entity_Id From);
470 #define Is_Discrete_Or_Fixed_Point_Type einfo__utils__is_discrete_or_fixed_point_type
471 extern B Is_Discrete_Or_Fixed_Point_Type (E Id);
473 #define Is_Floating_Point_Type einfo__utils__is_floating_point_type
474 extern B Is_Floating_Point_Type (E Id);
476 #define Is_Record_Type einfo__utils__is_record_type
477 extern B Is_Record_Type (E Id);
479 #define Is_Full_Access einfo__utils__is_full_access
480 extern B Is_Full_Access (E Id);
482 #define Next_Index einfo__utils__next_index
483 extern Node_Id Next_Index (Node_Id Id);
485 #define Next_Literal einfo__utils__next_literal
486 extern E Next_Literal (E Id);
488 #define Next_Stored_Discriminant einfo__utils__next_stored_discriminant
489 extern E Next_Stored_Discriminant (E Id);
491 // The following is needed because Convention in Sem_Util is a renaming
492 // of Basic_Convention.
494 static inline Convention_Id
495 Convention (N Node)
497 extern Byte einfo__entities__basic_convention (N Node);
498 return (Convention_Id) einfo__entities__basic_convention (Node);
501 // See comments regarding Entity_Or_Associated_Node in Sinfo.Utils.
503 #define Entity sinfo__nodes__entity_or_associated_node
504 extern Entity_Id Entity (N Node);
506 // See comments regarding Renamed_Or_Alias in Einfo.Utils
508 #define Alias einfo__entities__renamed_or_alias
509 extern Node_Id Alias (N Node);
511 #define Renamed_Entity einfo__entities__renamed_or_alias
512 extern Node_Id Renamed_Entity (N Node);
514 #define Renamed_Object einfo__entities__renamed_or_alias
515 extern Node_Id Renamed_Object (N Node);
517 #ifdef __cplusplus
519 #endif