MATCH: Improve `A CMP 0 ? A : -A` set of patterns to use bitwise_equal_p.
[official-gcc.git] / gcc / ada / opt.ads
blob59a24be83a4163168dc424f86f1129496d23d28c
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- O P T --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2023, 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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 -- This package contains global flags set by the initialization routine from
27 -- the command line and referenced throughout the compiler, the binder, or
28 -- other GNAT tools. The comments indicate which options are used by which
29 -- programs (GNAT, GNATBIND, GNATLINK, GNATMAKE, etc).
31 -- Some flags are labelled "PROJECT MANAGER". These are used by tools that
32 -- use the Project Manager. These tools include gnatmake, gnatname, the gnat
33 -- driver, gnatclean, gprbuild and gprclean.
35 with Hostparm; use Hostparm;
36 with Types; use Types;
38 pragma Warnings (Off);
39 -- This package is used also by gnatcoll
40 with System.Strings; use System.Strings;
41 with System.WCh_Con; use System.WCh_Con;
42 pragma Warnings (On);
44 package Opt is
46 ----------------------
47 -- Checksum Control --
48 ----------------------
50 -- Checksums are computed for sources to check for sources being the same
51 -- from a compilation point of view (e.g. spelling of identifiers and
52 -- white space layout do not count in this computation).
54 Checksum_Accumulate_Limited_Checksum : Boolean := False;
55 -- Used to control the computation of the limited view of a package.
56 -- (Not currently used, possible optimization for ALI files of units
57 -- in limited with_clauses).
59 ----------------------------------------------
60 -- Settings of Modes for Current Processing --
61 ----------------------------------------------
63 -- The following mode values represent the current state of processing.
64 -- The values set here are the default values. Unless otherwise noted,
65 -- the value may be reset in Switch-? with an appropriate switch. In
66 -- some cases, the values can also be modified by pragmas, and in the
67 -- case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
68 -- the default values.
70 Latest_Ada_Only : Boolean := False;
71 -- If True, the only value valid for Ada_Version is Ada_2012 or later.
72 -- Trying to specify other values will be ignored (in case of pragma
73 -- Ada_xxx) or generate an error (in case of -gnat83/95/xx switches).
75 type Ada_Version_Type is
76 (Ada_83, Ada_95, Ada_2005, Ada_2012, Ada_2022,
77 Ada_With_Core_Extensions, Ada_With_All_Extensions);
78 pragma Ordered (Ada_Version_Type);
79 pragma Convention (C, Ada_Version_Type);
80 -- Versions of Ada for Ada_Version below. Note that these are ordered,
81 -- so that tests like Ada_Version >= Ada_95 are legitimate and useful.
82 -- Think twice before using "="; Ada_Version >= Ada_2012 is more likely
83 -- what you want, because it will apply to future versions of the language.
85 -- Note that Ada_With_All_Extensions should always be last since it should
86 -- always be a superset of the other Ada versions. Likewise, the
87 -- penultimate one should be Ada_With_Core_Extensions.
89 -- Use the ..._Extensions_Allowed functions below instead of referring
90 -- directly to Ada_With_..._Extensions.
92 -- WARNING: There is a matching C declaration of this type in fe.h
94 Ada_Version_Default : constant Ada_Version_Type := Ada_2012;
95 pragma Warnings (Off, Ada_Version_Default);
96 -- GNAT
97 -- Default Ada version if no switch given. The Warnings off is to kill
98 -- constant condition warnings.
100 Ada_Version : Ada_Version_Type := Ada_Version_Default;
101 -- GNAT
102 -- Current Ada version for compiler, as set by configuration pragmas,
103 -- compiler switches, or implicitly (to Ada_Version_Runtime) when a
104 -- predefined or internal file is compiled.
106 -- WARNING: There is a matching C declaration of this variable in fe.h
108 function All_Extensions_Allowed return Boolean is
109 (Ada_Version = Ada_With_All_Extensions);
110 -- True if GNAT specific language extensions are allowed. See GNAT RM for
111 -- details.
113 function Core_Extensions_Allowed return Boolean is
114 (Ada_Version >= Ada_With_Core_Extensions);
115 -- True if some but not all GNAT specific language extensions are allowed.
116 -- See GNAT RM for details.
118 Ada_Version_Pragma : Node_Id := Empty;
119 -- Reflects the Ada_xxx pragma that resulted in setting Ada_Version. Used
120 -- to specialize error messages complaining about the Ada version in use.
122 Ada_Version_Explicit : Ada_Version_Type := Ada_Version_Default;
123 -- GNAT
124 -- Like Ada_Version, but does not get set implicitly for predefined or
125 -- internal units, so it reflects the Ada version explicitly set using
126 -- configuration pragmas or compiler switches (or if neither appears, it
127 -- remains set to Ada_Version_Default). This is used in the rare cases
128 -- (notably pragma Obsolescent) where we want the explicit version set.
130 Ada_Version_Runtime : Ada_Version_Type := Ada_With_All_Extensions;
131 -- GNAT
132 -- Ada version used to compile the runtime. Used to set Ada_Version (but
133 -- not Ada_Version_Explicit) when compiling predefined or internal units.
135 Ada_Final_Suffix : constant String := "final";
136 Ada_Final_Name : String_Ptr := new String'("ada" & Ada_Final_Suffix);
137 -- GNATBIND
138 -- The name of the procedure that performs the finalization at the end of
139 -- execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
141 Ada_Init_Suffix : constant String := "init";
142 Ada_Init_Name : String_Ptr := new String'("ada" & Ada_Init_Suffix);
143 -- GNATBIND
144 -- The name of the procedure that performs initialization at the start
145 -- of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
147 Ada_Main_Name_Suffix : constant String := "main";
148 -- GNATBIND
149 -- The suffix for Ada_Main_Name. Defined as a constant here so that it
150 -- can be referenced in a uniform manner to create either the default
151 -- value of Ada_Main_Name (declared below), or the non-default name
152 -- set by Gnatbind.Scan_Bind_Arg.
154 Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
155 -- GNATBIND
156 -- The name of the Ada package generated by the binder (when in Ada mode).
157 -- This variable may be modified by Gnatbind.Scan_Bind_Arg.
159 Address_Is_Private : Boolean := False;
160 -- GNAT, GNATBIND
161 -- Set True if package System has the line "type Address is private;"
163 Aggregate_Individually_Assign : Boolean := False;
164 -- GNAT
165 -- Set True if record aggregates are to be always converted into assignment
166 -- statements. Set through the corresponding pragma.
168 All_Errors_Mode : Boolean := False;
169 -- GNAT
170 -- Flag set to force display of multiple errors on a single line and
171 -- also repeated error messages for references to undefined identifiers
172 -- and certain other repeated error messages. Set by use of -gnatf.
174 Allow_Integer_Address : Boolean := False;
175 -- GNAT
176 -- Allow use of integer expression in a context requiring System.Address.
177 -- Set by the use of configuration pragma Allow_Integer_Address. Also set
178 -- in relaxed semantics mode for use by CodePeer or when -gnatd.M is used.
180 All_Sources : Boolean := False;
181 -- GNATBIND
182 -- Set to True to require all source files to be present. This flag is
183 -- directly modified by gnatmake to affect the shared binder routines.
185 Alternate_Main_Name : String_Ptr := null;
186 -- GNATBIND
187 -- Set to non-null when Bind_Alternate_Main_Name is True. This value
188 -- is modified as needed by Gnatbind.Scan_Bind_Arg.
190 Assertions_Enabled : Boolean := False;
191 -- GNAT
192 -- Indicates default policy (True = Check, False = Ignore) to be applied
193 -- to all assertion aspects and pragmas, and to pragma Debug, if there is
194 -- no overriding Assertion_Policy, Check_Policy, or Debug_Policy pragma.
195 -- Set True by use of -gnata.
197 Assume_No_Invalid_Values : Boolean := False;
198 -- GNAT Normally, in accordance with (RM 13.9.1 (9-11)) the front end
199 -- assumes that values could have invalid representations, unless it can
200 -- prove that the values are valid. If this switch is set (by -gnatB or
201 -- pragma Assume_No_Invalid_Values (On)), then the compiler assumes values
202 -- are valid and in range of their representations.
204 Back_Annotate_Rep_Info : Boolean := False;
205 -- GNAT
206 -- If set True, enables back annotation of representation information
207 -- by gigi, even in -gnatc mode. This is set True by the use of -gnatR
208 -- (list representation information). It is also set true if certain
209 -- Unchecked_Conversion instantiations require checking based on annotated
210 -- values.
212 Back_End_Inlining : Boolean := False;
213 -- GNAT
214 -- Set True to activate inlining by back-end expansion. This is the normal
215 -- default mode for GCC targets, so it is True on such targets unless the
216 -- switches -gnatN or -gnatd.z are used. See circuitry in gnat1drv for the
217 -- exact conditions for setting this switch.
219 -- WARNING: There is a matching C declaration of this variable in fe.h
221 Back_End_Return_Slot : Boolean := True;
222 -- GNAT
223 -- This flag is set True if the return slot of the back end for functions
224 -- returning a by-reference type can be accessed by means of an intrinsic
225 -- function callable in the body of these functions. This is the normal
226 -- default mode for GCC targets, so it is True on such targets unless the
227 -- switch -gnatd_r is used.
229 Bind_Alternate_Main_Name : Boolean := False;
230 -- GNATBIND
231 -- True if main should be called Alternate_Main_Name.all.
232 -- This variable may be set to True by Gnatbind.Scan_Bind_Arg.
234 Bind_Main_Program : Boolean := True;
235 -- GNATBIND
236 -- Set to False if not binding main Ada program
238 Bind_For_Library : Boolean := False;
239 -- GNATBIND
240 -- Set to True if the binder needs to generate a file designed for building
241 -- a library. May be set to True by Gnatbind.Scan_Bind_Arg.
243 Bind_Only : Boolean := False;
244 -- GNATMAKE, GPRBUILD
245 -- Set to True to skip compile and link steps
246 -- (except when Compile_Only and/or Link_Only are True).
248 Blank_Deleted_Lines : Boolean := False;
249 -- GNAT, GNATPREP
250 -- Output empty lines for each line of preprocessed input that is deleted
251 -- in the output, including preprocessor lines starting with a '#'.
253 Brief_Output : Boolean := False;
254 -- GNAT, GNATBIND
255 -- Force brief error messages to standard error, even if verbose mode is
256 -- set (so that main error messages go to standard output).
258 Build_Bind_And_Link_Full_Project : Boolean := False;
259 -- GNATMAKE
260 -- Set to True to build, bind and link all the sources of a project file
261 -- (switch -B)
263 CCG_Mode : Boolean := False;
264 -- Set to True when running as CCG (either via -gnatceg or via -emit-c)
266 Check_Aliasing_Of_Parameters : Boolean := False;
267 -- GNAT
268 -- Set to True to detect whether subprogram parameters and function results
269 -- alias the same object(s).
271 Check_Elaboration_Flags : Boolean := True;
272 -- GNATBIND
273 -- Set to False if switch -k is set.
275 Check_Float_Overflow : Boolean := False;
276 -- GNAT
277 -- Set to True to check that operations on predefined unconstrained float
278 -- types (e.g. Float, Long_Float) do not overflow and generate infinities
279 -- or invalid values. Set by the Check_Float_Overflow pragma, or by use
280 -- of the -gnateF switch.
282 Check_Object_Consistency : Boolean := False;
283 -- GNATBIND, GNATMAKE
284 -- Set to True to check whether every object file is consistent with its
285 -- corresponding ada library information (ALI) file. An object file is
286 -- inconsistent with the corresponding ALI file if the object file does
287 -- not exist or if it has an older time stamp than the ALI file. Default
288 -- above is for GNATBIND. GNATMAKE overrides this default to True (see
289 -- Make.Initialize) since we normally do need to check source consistencies
290 -- in gnatmake.
292 Check_Only : Boolean := False;
293 -- GNATBIND
294 -- Set to True to do checks only, no output of binder file
296 Check_Policy_List : Node_Id := Empty;
297 -- GNAT
298 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
299 -- that are linked through the Next_Pragma fields, with the list being
300 -- terminated by Empty. The order is most recently processed first. Note
301 -- that Push_Scope and Pop_Scope in Sem_Ch8 save and restore the value
302 -- of this variable, implementing the required scope control for pragmas
303 -- appearing in a declarative part.
305 Check_Readonly_Files : Boolean := False;
306 -- GNATMAKE
307 -- Set to True to check readonly files during the make process
309 Check_Source_Files : Boolean := True;
310 -- GNATBIND, GNATMAKE
311 -- Set to True to enable consistency checking for any source files that
312 -- are present (i.e. date must match the date in the library info file).
313 -- Set to False for object file consistency check only. This flag is
314 -- directly modified by gnatmake, to affect the shared binder routines.
316 Check_Switches : Boolean := False;
317 -- GNATMAKE, GPBUILD
318 -- Set to True to check compiler options during the make process
320 Check_Validity_Of_Parameters : Boolean := False;
321 -- GNAT
322 -- Set to True to check for proper scalar initialization of subprogram
323 -- parameters on both entry and exit. This is turned on by -gnateV.
325 CodePeer_Mode : Boolean := False;
326 -- GNAT, GNATBIND, GPRBUILD
327 -- Enable full CodePeer mode (SCIL generation, disable switches that
328 -- interact badly with it, etc...). This is turned on by -gnatC.
330 Commands_To_Stdout : Boolean := False;
331 -- GNATMAKE
332 -- True if echoed commands to be written to stdout instead of stderr
334 Comment_Deleted_Lines : Boolean := False;
335 -- GNATPREP
336 -- True if source lines removed by the preprocessor should be commented
337 -- in the output file.
339 Compilation_Time : String (1 .. 19);
340 -- GNAT
341 -- Compilation date and time in form YYYY-MM-DD HH:MM:SS
343 Compile_Only : Boolean := False;
344 -- GNATMAKE, GNATCLEAN, GPBUILD, GPRCLEAN
345 -- GNATMAKE, GPRBUILD:
346 -- set True to skip bind and link steps (except when Bind_Only is True)
347 -- GNATCLEAN, GPRCLEAN:
348 -- set True to delete only the files produced by the compiler but not the
349 -- library files or the executable files.
351 Config_File : Boolean := True;
352 -- GNAT
353 -- Set to False to inhibit reading and processing of gnat.adc file
355 Config_File_Names : String_List_Access := null;
356 -- GNAT
357 -- Names of configuration pragmas files (given by switches -gnatec)
359 Config_Files_Store_Basename : Boolean := False;
360 -- GNAT
361 -- Set True for -gnateb. Tells GNAT that config files should be referred to
362 -- by their basename and their checksums computed in ALI files.
364 Configurable_Run_Time_Mode : Boolean := False;
365 -- GNAT, GNATBIND
366 -- Set True if the compiler is operating in configurable run-time mode.
367 -- This happens if the flag Targparm.Configurable_Run_Time_On_Target is
368 -- True, or if pragma No_Run_Time is used. See the spec of Rtsfind for
369 -- details on the handling of the latter pragma.
371 Create_Mapping_File : Boolean := False;
372 -- GNATMAKE
373 -- Set to True (-C switch) to indicate that the compiler will be invoked
374 -- with a mapping file (-gnatem compiler switch).
376 CUDA_Device_Library_Name : String_Ptr := null;
377 -- GNATBIND
378 -- Non-null only if Enable_CUDA_Expansion is True.
380 subtype Debug_Level_Value is Nat range 0 .. 3;
381 Debugger_Level : Debug_Level_Value := 0;
382 -- GNAT, GNATBIND
383 -- The value given to the -g parameter. The default value for -g with
384 -- no value is 2. If no -g is specified, defaults to 0.
385 -- Note that the generated code should never depend on this variable,
386 -- since we want debug info to be nonintrusive on the generate code.
388 Default_Exit_Status : Int := 0;
389 -- GNATBIND
390 -- Set the default exit status value. Set by the -Xnnn switch for the
391 -- binder.
393 Debug_Generated_Code : Boolean := False;
394 -- GNAT
395 -- Set True (-gnatD switch) to debug generated expanded code instead
396 -- of the original source code. Causes debugging information to be
397 -- written with respect to the generated code file that is written.
399 -- WARNING: There is a matching C declaration of this variable in fe.h
401 Default_Pool : Node_Id := Empty;
402 -- GNAT
403 -- Used to record the storage pool name (or null literal) that is the
404 -- argument of an applicable pragma Default_Storage_Pool.
405 -- Empty: No pragma Default_Storage_Pool applies.
406 -- N_Null node: "pragma Default_Storage_Pool (null);" applies.
407 -- otherwise: "pragma Default_Storage_Pool (X);" applies, and
408 -- this points to the name X.
409 -- Push_Scope and Pop_Scope in Sem_Ch8 save and restore this value.
411 No_Stack_Size : constant := -1;
413 Default_Stack_Size : Int := No_Stack_Size;
414 -- GNATBIND
415 -- Set to default primary stack size in units of bytes. Set by the -dnnn
416 -- switch for the binder. A value of No_Stack_Size indicates that
417 -- no default was set by the binder.
419 Default_Sec_Stack_Size : Int := No_Stack_Size;
420 -- GNATBIND
421 -- Set to default secondary stack size in units of bytes. Set by the -Dnnn
422 -- switch for the binder. A value of No_Stack_Size indicates that no
423 -- default was set by the binder and the run-time value should be used
424 -- instead.
426 Default_SSO : Character := ' ';
427 -- GNAT
428 -- Set if a pragma Default_Scalar_Storage_Order has been given. The value
429 -- of ' ' indicates that no default has been set, otherwise the value is
430 -- either 'H' for High_Order_First or 'L' for Lower_Order_First.
432 Detect_Blocking : Boolean := False;
433 -- GNAT
434 -- Set True to force the run time to raise Program_Error if calls to
435 -- potentially blocking operations are detected from protected actions.
437 Directories_Must_Exist_In_Projects : Boolean := True;
438 -- PROJECT MANAGER
439 -- Set to False with switch -f of gnatclean and gprclean
441 Disable_FE_Inline : Boolean := False;
442 -- GNAT
443 -- Request to disable front end inlining from pragma Inline in the
444 -- presence of the -fno-inline back end flag on the command line,
445 -- regardless of any other switches that are set.
446 -- It remains the back end's reponsibility to honor -fno-inline at the
447 -- back end level.
449 Display_Compilation_Progress : Boolean := False;
450 -- GNATMAKE, GPRBUILD
451 -- Set True (-d switch) to display information on progress while compiling
452 -- files. Internal flag to be used in conjunction with an IDE
453 -- (e.g GNAT Studio).
455 type Distribution_Stub_Mode_Type is
456 -- GNAT
457 (No_Stubs,
458 -- Normal mode, no generation of distribution stubs
460 Generate_Receiver_Stub_Body,
461 -- The unit being compiled is the RCI body, and the compiler will
462 -- generate the body for the receiver stubs and compile it.
464 Generate_Caller_Stub_Body);
465 -- The unit being compiled is the RCI spec, and the compiler will
466 -- generate the body for the caller stubs and compile it.
468 Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
469 -- GNAT
470 -- This enumeration variable indicates the three states of distribution
471 -- annex stub generation.
473 Do_Not_Execute : Boolean := False;
474 -- GNATMAKE
475 -- Set to True if no actual compilations should be undertaken
477 Dump_Source_Text : Boolean := False;
478 -- GNAT
479 -- Set to True (by -gnatL) to dump source text intermingled with generated
480 -- code. Effective only if either of Debug/Print_Generated_Code is true.
482 Dynamic_Elaboration_Checks : Boolean := False;
483 -- GNAT
484 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
485 -- switch or by the use of pragma Elaboration_Checks (Dynamic).
487 Dynamic_Stack_Measurement : Boolean := False;
488 -- GNATBIND
489 -- Set True to enable dynamic stack measurement (-u flag for gnatbind)
491 Dynamic_Stack_Measurement_Array_Size : Nat := 100;
492 -- GNATBIND
493 -- Number of measurements we want to store during dynamic stack analysis.
494 -- When the buffer is full, non-storable results will be output on the fly.
495 -- The value is relevant only if Dynamic_Stack_Measurement is set. Set
496 -- by processing of -u flag for gnatbind.
498 Elab_Dependency_Output : Boolean := False;
499 -- GNATBIND
500 -- Set to True to output complete list of elaboration constraints
502 Elab_Order_Output : Boolean := False;
503 -- GNATBIND
504 -- Set to True to output chosen elaboration order
506 Enable_128bit_Types : Boolean := False;
507 -- GNAT
508 -- Set to True to enable the support for 128-bit types in the compiler.
509 -- The prerequisite is a 64-bit target that supports 128-bit computation.
511 -- WARNING: There is a matching C declaration of this variable in fe.h
513 Enable_CUDA_Expansion : Boolean := False;
514 -- GNAT, GNATBIND
515 -- Set to True to enable CUDA host expansion:
516 -- - Removal of CUDA_Global and CUDA_Device symbols
517 -- - Generation of kernel registration code in packages
518 -- - Binder invokes device elaboration/finalization code
520 Enable_CUDA_Device_Expansion : Boolean := False;
521 -- GNATBIND
522 -- Set to True to enable CUDA device (as opposed to host) expansion.
524 Error_Msg_Line_Length : Nat := 0;
525 -- GNAT
526 -- Records the error message line length limit. If this is set to zero,
527 -- then we get the old style behavior, in which each call to the error
528 -- message routines generates one line of output as a separate message.
529 -- If it is set to a non-zero value, then continuation lines are folded
530 -- to make a single long message, and then this message is split up into
531 -- multiple lines not exceeding the specified length. Set by -gnatj=nn.
533 Error_To_Warning : Boolean := False;
534 -- GNAT
535 -- If True, then certain error messages (e.g. parameter overlap messages
536 -- for procedure calls in Ada 2012 mode) are treated as warnings instead
537 -- of errors. Set by debug flag -gnatd.E. A search for Error_To_Warning
538 -- will identify affected messages.
540 Exception_Handler_Encountered : Boolean := False;
541 -- GNAT
542 -- This flag is set true if the parser encounters an exception handler.
543 -- It is used to set Warn_On_Exception_Propagation True if the restriction
544 -- No_Exception_Propagation is set.
546 Exception_Extra_Info : Boolean := False;
547 -- GNAT
548 -- True when switch -gnateE is used. When True, generate extra information
549 -- associated with exception messages (in particular range and index
550 -- checks).
552 -- WARNING: There is a matching C declaration of this variable in fe.h
554 Exception_Locations_Suppressed : Boolean := False;
555 -- GNAT
556 -- Set to True if a Suppress_Exception_Locations configuration pragma is
557 -- currently active.
559 -- WARNING: There is a matching C declaration of this variable in fe.h
561 type Exception_Mechanism_Type is
562 -- Determines the kind of mechanism used to handle exceptions
564 (Back_End_ZCX,
565 -- Exceptions are handled by the back end. The front end simply
566 -- generates the handlers as they appear in the source, and AT END
567 -- handlers are left untouched (they are not converted into exception
568 -- handlers when operating in this mode). Propagation is performed
569 -- using a frame unwinding scheme and requires no particular setup code
570 -- at handler sites on regular execution paths.
572 Back_End_SJLJ);
573 -- Similar to Back_End_ZCX with respect to the front-end processing
574 -- of regular and AT-END handlers. A setjmp/longjmp scheme is used to
575 -- propagate and setup handler contexts on regular execution paths.
577 Exception_Mechanism : Exception_Mechanism_Type := Back_End_SJLJ;
578 -- GNAT
579 -- Set to the appropriate value depending on the flags in system.ads
580 -- (ZCX_By_Default).
582 function ZCX_Exceptions return Boolean;
583 function SJLJ_Exceptions return Boolean;
584 -- GNAT
585 -- Various properties of the active Exception_Mechanism
587 -- WARNING: There is a matching C declaration of these subprograms in fe.h
589 Exception_Tracebacks : Boolean := False;
590 -- GNATBIND
591 -- Set to True to store tracebacks in exception occurrences (-Ea or -E)
593 Exception_Tracebacks_Symbolic : Boolean := False;
594 -- GNATBIND
595 -- Set to True to store tracebacks in exception occurrences and enable
596 -- symbolic tracebacks (-Es).
598 Expand_Nonbinary_Modular_Ops : Boolean := False;
599 -- Set to True to convert nonbinary modular additions into code
600 -- that relies on the front-end expansion of operator Mod.
602 type External_Casing_Type is (
603 As_Is, -- External names cased as they appear in the Ada source
604 Uppercase, -- External names forced to all uppercase letters
605 Lowercase); -- External names forced to all lowercase letters
607 External_Name_Imp_Casing : External_Casing_Type := Lowercase;
608 -- GNAT
609 -- The setting of this flag determines the casing of external names
610 -- when the name is implicitly derived from an entity name (i.e. either
611 -- no explicit External_Name or Link_Name argument is used, or, in the
612 -- case of extended DEC pragmas, the external name is given using an
613 -- identifier. The As_Is setting is not permitted here (since this would
614 -- create Ada source programs that were case sensitive).
616 External_Name_Exp_Casing : External_Casing_Type := As_Is;
617 -- GNAT
618 -- The setting of this flag determines the casing of an external name
619 -- specified explicitly with a string literal. As_Is means the string
620 -- literal is used as given with no modification to the casing. If
621 -- Lowercase or Uppercase is set, then the string is forced to all
622 -- lowercase or all uppercase letters as appropriate. Note that this
623 -- setting has no effect if the external name is given using an identifier
624 -- in the case of extended DEC import/export pragmas (in this case the
625 -- casing is controlled by External_Name_Imp_Casing), and also has no
626 -- effect if an explicit Link_Name is supplied (a link name is always
627 -- used exactly as given).
629 External_Unit_Compilation_Allowed : Boolean := False;
630 -- GNATMAKE
631 -- When True (set by gnatmake switch -x), allow compilation of sources
632 -- that are not part of any project file.
634 Fast_Math : Boolean := False;
635 -- GNAT
636 -- Indicates the current setting of Fast_Math mode, as set by the use
637 -- of a Fast_Math pragma (set True by Fast_Math (On)).
639 Force_ALI_File : Boolean := False;
640 -- GNAT
641 -- Force generation of ALI file even if errors are encountered.
642 -- Set on by use of -gnatQ.
644 Disable_ALI_File : Boolean := False;
645 -- GNAT
646 -- Disable generation of ALI file
648 Follow_Links_For_Files : Boolean := False;
649 -- PROJECT MANAGER
650 -- Set to True (-eL) to process the project files in trusted mode. If
651 -- Follow_Links is False, it is assumed that the project doesn't contain
652 -- any file duplicated through symbolic links (although the latter are
653 -- still valid if they point to a file which is outside of the project),
654 -- and that no directory has a name which is a valid source name.
656 Follow_Links_For_Dirs : Boolean := False;
657 -- PROJECT MANAGER
658 -- Set to True if directories can be links in this project, and therefore
659 -- additional system calls must be performed to ensure that we always see
660 -- the same full name for each directory.
662 Force_Checking_Of_Elaboration_Flags : Boolean := False;
663 -- GNATBIND
664 -- True if binding with forced checking of the elaboration flags
665 -- (-F switch set).
667 Force_Compilations : Boolean := False;
668 -- GNATMAKE, GPRBUILD
669 -- Set to force recompilations even when the objects are up-to-date.
671 Force_Elab_Order_File : String_Ptr := null;
672 -- GNATBIND
673 -- File name specified for -f switch (the forced elaboration order file)
675 Front_End_Inlining : Boolean := False;
676 -- GNAT
677 -- Set True to activate inlining by front-end expansion (even on GCC
678 -- targets, where inlining is normally handled by the back end). Set by
679 -- the flag -gnatN (which is now considered obsolescent, since the GCC
680 -- back end can do a better job of inlining than the front end these days).
682 Full_Path_Name_For_Brief_Errors : Boolean := False;
683 -- PROJECT MANAGER
684 -- When True, in Brief_Output mode, each error message line will start with
685 -- the full path name of the source. When False, only the file name without
686 -- directory information is used.
688 Full_List : Boolean := False;
689 -- GNAT
690 -- Set True to generate full source listing with embedded errors
692 Full_List_File_Name : String_Ptr := null;
693 -- GNAT
694 -- Set to file name to generate full source listing to named file (or if
695 -- the name is of the form .xxx, then to name.xxx where name is the source
696 -- file name with extension stripped.
698 Generate_Asm : Boolean := False;
699 -- GNAT
700 -- True if generating assembly instead of an object file, via the -S switch
702 Generate_C_Code : Boolean := False;
703 -- GNAT, GNATBIND
704 -- If True, the Cprint circuitry to generate C code output is activated.
705 -- Set True by use of -gnateg or -gnatd.V for GNAT, and -G for GNATBIND.
707 Generate_CodePeer_Messages : Boolean := False;
708 -- GNAT
709 -- Generate CodePeer messages. Ignored if CodePeer_Mode is false. This is
710 -- turned on by -gnateC.
712 Generate_Processed_File : Boolean := False;
713 -- GNAT
714 -- True when switch -gnateG is used. When True, create in a file
715 -- <source>.prep, if the source is preprocessed.
717 Generate_SCIL : Boolean := False;
718 -- GNAT
719 -- Set True to activate SCIL code generation.
721 Generate_SCO : Boolean := False;
722 -- GNAT
723 -- True when switch -fdump-scos (or -gnateS) is used. When True, Source
724 -- Coverage Obligation (SCO) information is generated and output in the ALI
725 -- file. See unit Par_SCO for full details.
727 Generate_SCO_Instance_Table : Boolean := False;
728 -- GNAT
729 -- True when switch -fdump-scos is used. When True, a table of instances is
730 -- included in SCOs.
732 -- WARNING: There is a matching C declaration of this variable in fe.h
734 Generating_Code : Boolean := False;
735 -- GNAT
736 -- True if the frontend finished its work and has called the backend to
737 -- process the tree and generate the object file.
739 type Ghost_Mode_Type is (None, Check, Ignore);
740 -- Possible legal modes that can be set by aspect/pragma Ghost as well as
741 -- value None, which indicates that no such aspect/pragma applies.
743 Ghost_Mode : Ghost_Mode_Type := None;
744 -- GNAT
745 -- The current Ghost mode in effect
747 Global_Discard_Names : Boolean := False;
748 -- GNAT, GNATBIND
749 -- True if a pragma Discard_Names appeared as a configuration pragma for
750 -- the current compilation unit.
752 GNAT_Encodings : Int;
753 pragma Import (C, GNAT_Encodings, "gnat_encodings");
754 -- Constant controlling the balance between GNAT encodings and standard
755 -- DWARF to emit in the debug information. It accepts the following values.
757 DWARF_GNAT_Encodings_All : constant Int := 0;
758 DWARF_GNAT_Encodings_GDB : constant Int := 1;
759 DWARF_GNAT_Encodings_Minimal : constant Int := 2;
761 Identifier_Character_Set : Character;
762 -- GNAT
763 -- This variable indicates the character set to be used for identifiers.
764 -- The possible settings are:
765 -- '1' Latin-1 (ISO-8859-1)
766 -- '2' Latin-2 (ISO-8859-2)
767 -- '3' Latin-3 (ISO-8859-3)
768 -- '4' Latin-4 (ISO-8859-4)
769 -- '5' Latin-Cyrillic (ISO-8859-5)
770 -- '9' Latin-9 (ISO-8859-15)
771 -- 'p' PC (US, IBM page 437)
772 -- '8' PC (European, IBM page 850)
773 -- 'f' Full upper set (all distinct)
774 -- 'n' No upper characters (Ada 83 rules)
775 -- 'w' Latin-1 plus wide characters allowed in identifiers
777 -- The setting affects the set of letters allowed in identifiers and the
778 -- upper/lower case equivalences. It does not affect the interpretation of
779 -- character and string literals, which are always stored using the actual
780 -- coding in the source program. This variable is initialized to the
781 -- default value appropriate to the system (in Osint.Initialize), and then
782 -- reset if a command line switch is used to change the setting.
784 Ignore_Rep_Clauses : Boolean := False;
785 -- GNAT
786 -- Set True to ignore all representation clauses. Useful when compiling
787 -- code from foreign compilers for checking purposes. Can be
788 -- set True by use of -gnatI.
790 Ignore_SPARK_Mode_Pragmas_In_Instance : Boolean := False;
791 -- GNAT
792 -- Set True to ignore the semantics and effects of pragma SPARK_Mode when
793 -- the pragma appears inside an instance whose enclosing context is subject
794 -- to SPARK_Mode "off". This property applies to nested instances.
796 Ignore_Style_Checks_Pragmas : Boolean := False;
797 -- GNAT
798 -- Set True to ignore all Style_Checks pragmas. Can be set True by use
799 -- of -gnateY.
801 Ignore_Unrecognized_VWY_Switches : Boolean := False;
802 -- GNAT
803 -- Set True to ignore unrecognized y, V, w switches. Can be set True by
804 -- use of -gnateu, causing subsequent unrecognized switches to result in
805 -- a warning rather than an error.
807 Ignored_Ghost_Region : Node_Id := Empty;
808 -- GNAT
809 -- The start of the current ignored Ghost region. This value must always
810 -- reflect the starting node of the outermost ignored Ghost region. If a
811 -- nested ignored Ghost region is entered, the value must remain unchanged.
813 Implicit_Packing : Boolean := False;
814 -- GNAT
815 -- If set True, then a Size attribute clause on an array is allowed to
816 -- cause implicit packing instead of generating an error message. Set by
817 -- use of pragma Implicit_Packing.
819 Include_Subprogram_In_Messages : Boolean := False;
820 -- GNAT
821 -- Set True to include the enclosing subprogram in compiler messages.
823 Init_Or_Norm_Scalars : Boolean := False;
824 -- GNAT, GNATBIND
825 -- Set True if a pragma Initialize_Scalars applies to the current unit.
826 -- Also set True if a pragma Restriction (Normalize_Scalars) applies.
828 Initialize_Scalars : Boolean := False;
829 -- GNAT
830 -- Set True if a pragma Initialize_Scalars applies to the current unit.
831 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
833 Initialize_Scalars_Mode1 : Character := 'I';
834 Initialize_Scalars_Mode2 : Character := 'N';
835 -- GNATBIND
836 -- Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
837 -- is IN (invalid values), used if no -S switch is used.
839 Inline_Active : Boolean := False;
840 -- GNAT
841 -- Set True to activate pragma Inline processing across modules. Default
842 -- for now is not to inline across module boundaries.
844 Inline_Level : Nat := 0;
845 -- GNAT
846 -- Set to indicate the inlining level: 0 means that an appropriate value is
847 -- to be computed by the compiler based on the optimization level (-gnatn),
848 -- 1 is for moderate inlining across modules (-gnatn1) and 2 for full
849 -- inlining across modules (-gnatn2).
851 Interface_Library_Unit : Boolean := False;
852 -- GNATBIND
853 -- Set to True to indicate that at least one ALI file is an interface ALI:
854 -- then elaboration flag checks are to be generated in the binder
855 -- generated file.
857 Invalid_Value_Used : Boolean := False;
858 -- GNAT
859 -- Set True if a valid Invalid_Value attribute is encountered
861 Inline_Processing_Required : Boolean := False;
862 -- GNAT
863 -- Set True if inline processing is required. Inline processing is required
864 -- if an active Inline pragma is processed. The flag is set for a pragma
865 -- Inline or Inline_Always that is actually active.
867 In_Place_Mode : Boolean := False;
868 -- GNATMAKE
869 -- Set True to store ALI and object files in place i.e. in the object
870 -- directory if these files already exist or in the source directory
871 -- if not.
873 JSON_Output : Boolean := False;
874 -- GNAT
875 -- Output error and warning messages in JSON format. Set to true when the
876 -- backend option "-fdiagnostics-format=json" is found on the command line.
878 Keep_Going : Boolean := False;
879 -- GNATMAKE, GPRBUILD
880 -- When True signals to ignore compilation errors and keep processing
881 -- sources until there is no more work.
883 Keep_Temporary_Files : Boolean := False;
884 -- GNATCMD, GNATMAKE, GPRBUILD
885 -- When True the temporary files are not deleted. Set by switches -dn or
886 -- --keep-temp-files.
888 Leap_Seconds_Support : Boolean := False;
889 -- GNATBIND
890 -- Set to True to enable leap seconds support in Ada.Calendar and its
891 -- children. Set by -y.
893 Legacy_Elaboration_Checks : Boolean := False;
894 -- GNAT
895 -- Set to True when the pre-18.x access-before-elaboration model is to be
896 -- used. Modified by use of -gnatH.
898 Legacy_Elaboration_Order : Boolean := False;
899 -- GNATBIND
900 -- Set to True when the pre-20.x elaboration-order model is to be used.
901 -- Modified by use of -H.
903 Link_Only : Boolean := False;
904 -- GNATMAKE, GPRBUILD
905 -- Set to True to skip compile and bind steps (except when Bind_Only is
906 -- set to True).
908 List_Restrictions : Boolean := False;
909 -- GNATBIND
910 -- Set to True to list restrictions pragmas that could apply to partition
912 List_Units : Boolean := False;
913 -- GNAT
914 -- List units in the active library for a compilation (-gnatu switch)
916 List_Closure : Boolean := False;
917 -- GNATBIND
918 -- List all sources in the closure of a main (-R or -Ra gnatbind switch)
920 List_Closure_All : Boolean := False;
921 -- GNATBIND
922 -- List all sources in closure of main including run-time units (-Ra
923 -- gnatbind switch).
925 List_Dependencies : Boolean := False;
926 -- GNATMAKE
927 -- When True gnatmake verifies that the objects are up to date and outputs
928 -- the list of object dependencies (-M switch). Output depends if -a switch
929 -- is used or not. This list can be used directly in a Makefile.
931 List_Representation_Info : Int range 0 .. 4 := 0;
932 -- GNAT
933 -- Set non-zero by -gnatR switch to list representation information.
934 -- The settings are as follows:
936 -- 0 = no listing of representation information (default as above)
937 -- 1 = list rep info for user-defined record and array types
938 -- 2 = list rep info for all user-defined types and objects
939 -- 3 = like 2, but variable fields are decoded symbolically
940 -- 4 = like 3, but list rep info for relevant compiler-generated types
942 -- WARNING: There is a matching C declaration of this variable in fe.h
944 List_Representation_Info_To_File : Boolean := False;
945 -- GNAT
946 -- Set true by -gnatRs switch. Causes information from -gnatR[1-4]m to be
947 -- written to file.rep (where file is the name of the source file) instead
948 -- of stdout. For example, if file x.adb is compiled using -gnatR2s then
949 -- representation info is written to x.adb.ref.
951 List_Representation_Info_To_JSON : Boolean := False;
952 -- GNAT
953 -- Set true by -gnatRj switch. Causes information from -gnatR[1-4]m to be
954 -- output in the JSON data interchange format.
956 List_Representation_Info_Mechanisms : Boolean := False;
957 -- GNAT
958 -- Set true by -gnatRm switch. Causes information on mechanisms to be
959 -- included in the representation output information.
961 List_Representation_Info_Extended : Boolean := False;
962 -- GNAT
963 -- Set true by -gnatRe switch. Causes extended information for record types
964 -- to be included in the representation output information.
966 List_Preprocessing_Symbols : Boolean := False;
967 -- GNAT, GNATPREP
968 -- Set to True if symbols for preprocessing a source are to be listed
969 -- before preprocessing occurs. Set to True by switch -s of gnatprep or
970 -- -s in preprocessing data file for the compiler.
972 XDR_Stream : Boolean := False;
973 -- GNATBIND
974 -- Set to True to enable XDR in s-stratt.adb. Set by -xdr.
976 type Create_List_File_Proc is access procedure (S : String);
977 type Write_List_Info_Proc is access procedure (S : String);
978 type Close_List_File_Proc is access procedure;
979 -- Types used for procedure addresses below
981 Create_List_File_Access : Create_List_File_Proc := null;
982 Write_List_Info_Access : Write_List_Info_Proc := null;
983 Close_List_File_Access : Close_List_File_Proc := null;
984 -- GNAT
985 -- These three locations are left null when operating in non-compiler
986 -- (e.g. from the binder), but when operating in compiler mode, they are
987 -- set to point to the three corresponding procedures in Osint-C. The
988 -- reason for this slightly strange interface is to prevent Repinfo
989 -- from dragging in Osint-C in the binder, which would include unwanted
990 -- units in the binder.
992 Locking_Policy : Character := ' ';
993 -- GNAT, GNATBIND
995 -- Set to ' ' for the default case (no locking policy specified). Otherwise
996 -- set based on the pragma Locking_Policy:
997 -- Ceiling_Locking: 'C'
998 -- Concurrent_Readers_Locking: 'R'
999 -- Inheritance_Locking: 'I'
1001 Locking_Policy_Sloc : Source_Ptr := No_Location;
1002 -- GNAT, GNATBIND
1003 -- Remember location of previous Locking_Policy pragma. This is used for
1004 -- inconsistency error messages. A value of System_Location is used if the
1005 -- policy is set in package System.
1007 Look_In_Primary_Dir : Boolean := True;
1008 -- GNAT, GNATBIND, GNATMAKE, GNATCLEAN
1009 -- Set to False if a -I- was present on the command line. When True we are
1010 -- allowed to look in the primary directory to locate other source or
1011 -- library files.
1013 Make_Steps : Boolean := False;
1014 -- GNATMAKE
1015 -- Set to True when either Compile_Only, Bind_Only or Link_Only is
1016 -- set to True.
1018 Main_Index : Int := 0;
1019 -- GNATMAKE
1020 -- This is set to non-zero by gnatmake switch -eInnn to indicate that
1021 -- the main program is the nnn unit in a multi-unit source file.
1023 Mapping_File_Name : String_Ptr := null;
1024 -- GNAT
1025 -- File name of mapping between unit names, file names and path names.
1026 -- (given by switch -gnatem)
1028 Maximum_Messages : Int := 9999;
1029 -- GNAT, GNATBIND
1030 -- Maximum default number of errors before compilation is terminated, or in
1031 -- the case of GNAT, maximum number of warnings before further warnings are
1032 -- suppressed. Can be overridden by -gnatm (GNAT) or -m (GNATBIND) switch.
1034 Maximum_File_Name_Length : Int;
1035 -- GNAT, GNATBIND
1036 -- Maximum number of characters allowed in a file name, not counting the
1037 -- extension, as set by the appropriate switch. If no switch is given,
1038 -- then this value is initialized by Osint to the appropriate value.
1040 Maximum_Instantiations : Int := 8000;
1041 -- GNAT
1042 -- Maximum number of instantiations permitted (to stop runaway cases
1043 -- of nested instantiations). These situations probably only occur in
1044 -- specially concocted test cases. Can be modified by -gnateinn switch.
1046 Maximum_Processes : Positive := 1;
1047 -- GNATMAKE, GPRBUILD
1048 -- Maximum number of processes that should be spawned to carry out
1049 -- compilations.
1051 Minimal_Binder : Boolean := False;
1052 -- GNATBIND
1053 -- Set to True to suppress the generation of objects by the binder that
1054 -- are not strictly required for a program to run. Intended for ZFP
1055 -- applications that have tight memory constraints.
1057 Minimal_Recompilation : Boolean := False;
1058 -- GNATMAKE
1059 -- Set to True if minimal recompilation mode requested
1061 Minimize_Expression_With_Actions : Boolean := False;
1062 -- GNAT
1063 -- If True, minimize the use of N_Expression_With_Actions node.
1064 -- This can be used in particular on some back-ends where this node is
1065 -- difficult to support.
1067 Modify_Tree_For_C : Boolean := False;
1068 -- GNAT
1069 -- If this switch is set True (currently it is set only by -gnatd.V), then
1070 -- certain meaning-preserving transformations are applied to the tree to
1071 -- make it easier to interface with back ends that implement C semantics.
1072 -- There is a section in Sinfo which describes the transformations made.
1074 Multiple_Unit_Index : Nat := 0;
1075 -- GNAT
1076 -- This is set non-zero if the current unit is being compiled in multiple
1077 -- unit per file mode, meaning that the current unit is selected from the
1078 -- sequence of units in the current source file, using the value stored
1079 -- in this variable (e.g. 2 = select second unit in file). A value of
1080 -- zero indicates that we are in normal (one unit per file) mode.
1082 No_Backup : Boolean := False;
1083 -- GNATNAME
1084 -- Do not create backup copies of project files. Set by switch --no-backup.
1086 No_Component_Reordering : Boolean := False;
1087 -- GNAT
1088 -- Set True if pragma No_Component_Reordering with no parameter encountered
1090 No_Deletion : Boolean := False;
1091 -- GNATPREP
1092 -- Set by preprocessor switch -a. Do not eliminate any source text. Implies
1093 -- Undefined_Symbols_Are_False. Useful to perform a syntax check on all
1094 -- branches of #if constructs.
1096 No_Elab_Code_All_Pragma : Node_Id := Empty;
1097 -- Set to point to a No_Elaboration_Code_All pragma or aspect encountered
1098 -- in the spec of the extended main unit. Used to determine if we need to
1099 -- do special tests for violation of this aspect.
1101 No_Heap_Finalization_Pragma : Node_Id := Empty;
1102 -- GNAT
1103 -- Set to point to a No_Heap_Finalization pragma defined in a configuration
1104 -- file.
1106 No_Main_Subprogram : Boolean := False;
1107 -- GNATMAKE, GNATBIND
1108 -- Set to True if compilation/binding of a program without main
1109 -- subprogram requested.
1111 No_Run_Time_Mode : Boolean := False;
1112 -- GNAT, GNATBIND
1113 -- This flag is set True if a No_Run_Time pragma is encountered. See spec
1114 -- of Rtsfind for a full description of handling of this pragma.
1116 No_Split_Units : Boolean := False;
1117 -- GPRBUILD
1118 -- Set to True with switch --no-split-units. When True, unit sources, spec,
1119 -- body and subunits, must all be in the same project. This is checked
1120 -- after each compilation.
1122 No_Stdinc : Boolean := False;
1123 -- GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
1124 -- Set to True if no default source search dirs added to search list.
1126 No_Stdlib : Boolean := False;
1127 -- GNATMAKE, GNATBIND, GNATFIND, GNATXREF
1128 -- Set to True if no default library search dirs added to search list.
1130 No_Strict_Aliasing : Boolean := False;
1131 -- GNAT
1132 -- Set True if pragma No_Strict_Aliasing with no parameters encountered.
1134 -- WARNING: There is a matching C declaration of this variable in fe.h
1136 No_Tagged_Streams : Node_Id := Empty;
1137 -- GNAT
1138 -- If a pragma No_Tagged_Streams is active for the current scope, this
1139 -- points to the corresponding pragma.
1141 Nodes_Size_In_Meg : Nat := 0;
1142 -- GNAT
1143 -- Amount of memory to allocate for all nodes, in units of 2**20 bytes.
1144 -- Set by the -gnaten switch; 0 means -gnaten was not given, and a default
1145 -- value should be used.
1147 Normalize_Scalars : Boolean := False;
1148 -- GNAT, GNATBIND
1149 -- Set True if a pragma Normalize_Scalars applies to the current unit.
1150 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
1152 Object_Directory_Present : Boolean := False;
1153 -- GNATMAKE
1154 -- Set to True when an object directory is specified with option -D
1156 Object_Path_File_Name : String_Ptr := null;
1157 -- GNAT2WHY
1158 -- Path of the temporary file that contains a list of object directories
1159 -- passed by -gnateO=<obj_path_file>.
1161 One_Compilation_Per_Obj_Dir : Boolean := False;
1162 -- GNATMAKE, GPRBUILD
1163 -- Set to True with switch --single-compile-per-obj-dir. When True, there
1164 -- cannot be simultaneous compilations with the object files in the same
1165 -- object directory, if project files are used.
1167 type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
1168 pragma Ordered (Operating_Mode_Type);
1169 Operating_Mode : Operating_Mode_Type := Generate_Code;
1170 -- GNAT
1171 -- Indicates the operating mode of the compiler. The default is generate
1172 -- code, which runs the parser, semantics and backend. Switches can be
1173 -- used to set syntax checking only mode, or syntax and semantics checking
1174 -- only mode. Operating_Mode can also be modified as a result of detecting
1175 -- errors during the compilation process. In particular if any serious
1176 -- error is detected then this flag is reset from Generate_Code to
1177 -- Check_Semantics after generating an error message. This is an ordered
1178 -- type with the semantics that each value does more than the previous one.
1180 Optimize_Alignment : Character := 'O';
1181 -- GNAT
1182 -- Setting of Optimize_Alignment, set to T/S/O for time/space/off. Can
1183 -- be modified by use of pragma Optimize_Alignment.
1185 Optimize_Alignment_Local : Boolean := False;
1186 -- GNAT
1187 -- Set True if Optimize_Alignment mode is set by a local configuration
1188 -- pragma that overrides the gnat.adc (or other configuration file) default
1189 -- so that the unit is not dependent on the default setting. Also always
1190 -- set True for internal units, since these always have a default setting
1191 -- of Optimize_Alignment (Off) that is enforced (essentially equivalent to
1192 -- them all having such an explicit pragma in each unit).
1194 Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
1195 -- GNAT
1196 -- Indicates the original operating mode of the compiler as set by compiler
1197 -- options. This is identical to Operating_Mode except that this is not
1198 -- affected by errors.
1200 Optimization_Level : Int;
1201 pragma Import (C, Optimization_Level, "optimize");
1202 -- GNAT
1203 -- Constant reflecting the optimization level (0,1,2,3 for -O0,-O1,-O2,-O3)
1205 Optimize_Size : Int;
1206 pragma Import (C, Optimize_Size, "optimize_size");
1207 -- GNAT
1208 -- Constant reflecting setting of -Os (optimize for size). Set to nonzero
1209 -- in -Os mode and set to zero otherwise.
1211 Output_File_Name_Present : Boolean := False;
1212 -- GNATBIND, GNAT, GNATMAKE
1213 -- Set to True when the output C file name is given with option -o for
1214 -- GNATBIND, when the object file name is given with option -gnatO for GNAT
1215 -- or when the executable is given with option -o for GNATMAKE.
1217 Output_Linker_Option_List : Boolean := False;
1218 -- GNATBIND
1219 -- True if output of list of linker options is requested (-K switch set)
1221 Output_ALI_List : Boolean := False;
1222 ALI_List_Filename : String_Ptr;
1223 -- GNATBIND
1224 -- True if output of list of ALIs is requested (-A switch set). List is
1225 -- output under the given filename, or standard output if not specified.
1227 Output_Object_List : Boolean := False;
1228 Object_List_Filename : String_Ptr;
1229 -- GNATBIND
1230 -- True if output of list of objects is requested (-O switch set). List is
1231 -- output under the given filename, or standard output if not specified.
1233 Partition_Elaboration_Policy : Character := ' ';
1234 -- GNAT, GNATBIND
1235 -- Set to ' ' for the default case (no elaboration policy specified). Reset
1236 -- to first character (uppercase) of locking policy name if a valid pragma
1237 -- Partition_Elaboration_Policy is encountered.
1239 Partition_Elaboration_Policy_Sloc : Source_Ptr := No_Location;
1240 -- GNAT, GNATBIND
1241 -- Remember location of previous Partition_Elaboration_Policy pragma. This
1242 -- is used for inconsistency error messages. A value of System_Location is
1243 -- used if the policy is set in package System.
1245 Persistent_BSS_Mode : Boolean := False;
1246 -- GNAT
1247 -- True if a Persistent_BSS configuration pragma is in effect, causing
1248 -- potentially persistent data to be placed in the persistent_bss section.
1250 Pessimistic_Elab_Order : Boolean := False;
1251 -- GNATBIND
1252 -- True if pessimistic elaboration order is to be chosen (-p switch set)
1254 Prefix_Exception_Messages : Boolean := False;
1255 -- GNAT
1256 -- Set True to prefix exception messages with entity-name:
1258 Preprocessing_Data_File : String_Ptr := null;
1259 -- GNAT
1260 -- Set by switch -gnatep=. The file name of the preprocessing data file.
1262 Preprocessing_Symbol_Defs : String_List_Access := new String_List (1 .. 4);
1263 -- An extensible array to temporarily stores symbol definitions specified
1264 -- on the command line with -gnateD switches. The value 4 is an arbitrary
1265 -- starting point, if more space is needed it is allocated as required.
1267 Preprocessing_Symbol_Last : Natural := 0;
1268 -- Index of last symbol definition in array Symbol_Definitions
1270 Print_Generated_Code : Boolean := False;
1271 -- GNAT
1272 -- Set to True to enable output of generated code in source form. This
1273 -- flag is set by the -gnatG switch.
1275 Print_Standard : Boolean := False;
1276 -- GNAT
1277 -- Set to true to enable printing of package standard in source form.
1278 -- This flag is set by the -gnatS switch
1280 type Usage is (Unknown, Not_In_Use, In_Use);
1281 Project_File_In_Use : Usage := Unknown;
1282 -- GNAT
1283 -- Indicates if a project file is used or not. Set to In_Use by the first
1284 -- SFNP pragma.
1286 Quantity_Of_Default_Size_Sec_Stacks : Int := -1;
1287 -- GNATBIND
1288 -- The number of default sized secondary stacks that the binder should
1289 -- generate. Allows ZFP users to have the binder generate extra stacks if
1290 -- needed to support multithreaded applications. A value of -1 indicates
1291 -- that no size was set by the binder.
1293 Queuing_Policy : Character := ' ';
1294 -- GNAT, GNATBIND
1295 -- Set to ' ' for the default case (no queuing policy specified). Reset to
1296 -- first character (uppercase) of locking policy name if a valid
1297 -- Queuing_Policy pragma is encountered.
1299 Queuing_Policy_Sloc : Source_Ptr := No_Location;
1300 -- GNAT, GNATBIND
1301 -- Remember location of previous Queuing_Policy pragma. This is used for
1302 -- inconsistency error messages. A value of System_Location is used if the
1303 -- policy is set in package System.
1305 Quiet_Output : Boolean := False;
1306 -- GNATMAKE, GNATCLEAN, GPRBUILD, GPRCLEAN
1307 -- Set to True if the tool should not have any output if there are no
1308 -- errors or warnings.
1310 Overriding_Renamings : Boolean := False;
1311 -- GNAT
1312 -- Set to True to enable compatibility mode with Rational compiler, and
1313 -- to accept renamings of implicit operations in their own scope.
1315 Relaxed_Elaboration_Checks : Boolean := False;
1316 -- GNAT
1317 -- Set to True to ignore certain elaboration scenarios, thus making the
1318 -- current ABE mechanism more permissive. This behavior is applicable to
1319 -- both the default and the legacy ABE models. Modified by use of -gnatJ.
1321 Relaxed_RM_Semantics : Boolean := False;
1322 -- GNAT
1323 -- Set to True to ignore some Ada semantic error to help parse legacy Ada
1324 -- code for use in e.g. static analysis (such as CodePeer). This deals
1325 -- with cases where other compilers allow illegal constructs. Tools such as
1326 -- CodePeer are interested in analyzing code rather than enforcing legality
1327 -- rules, so as long as these illegal constructs end up with code that can
1328 -- be handled by the tool in question, there is no reason to reject the
1329 -- code that is considered correct by the other compiler.
1331 Replace_In_Comments : Boolean := False;
1332 -- GNATPREP
1333 -- Set to True if -C switch used.
1335 Reverse_Bit_Order_Threshold : Int := -1;
1336 -- GNAT
1337 -- Set to the threshold from which the RM 13.5.1(13.3/2) clause applies,
1338 -- or -1 if the size of the largest machine scalar is to be used.
1340 RTS_Lib_Path_Name : String_Ptr := null;
1341 RTS_Src_Path_Name : String_Ptr := null;
1342 -- GNAT
1343 -- Set to the "adalib" and "adainclude" directories of the run time
1344 -- specified by --RTS=.
1346 RTS_Switch : Boolean := False;
1347 -- GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
1348 -- Set to True when the --RTS switch is set
1350 Run_Path_Option : Boolean := True;
1351 -- GNATMAKE, GNATLINK
1352 -- Set to False when no run_path_option should be issued to the linker
1354 Search_Directory_Present : Boolean := False;
1355 -- GNAT
1356 -- Set to True when argument is -I. Reset to False when next argument, a
1357 -- search directory path is taken into account. Note that this is quite
1358 -- different from other switches in this section in that it is only set in
1359 -- a transitory manner as a result of scanning a -I switch with no file
1360 -- name, and if set, is an indication that the next argument is to be
1361 -- treated as a file name.
1363 Sec_Stack_Used : Boolean := False;
1364 -- GNAT, GBATBIND
1365 -- Set True if generated code uses the System.Secondary_Stack package. For
1366 -- the binder, set if any unit uses the secondary stack package.
1368 Setup_Projects : Boolean := False;
1369 -- GNAT DRIVER
1370 -- Set to True for GNAT SETUP: the Project Manager creates nonexistent
1371 -- object, library, and exec directories.
1373 Shared_Libgnat : Boolean;
1374 -- GNATBIND
1375 -- Set to True if a shared libgnat is requested by using the -shared option
1376 -- for GNATBIND and to False when using the -static option. The value of
1377 -- this flag is set by Gnatbind.Scan_Bind_Arg.
1379 Short_Circuit_And_Or : Boolean := False;
1380 -- GNAT
1381 -- Set True if a pragma Short_Circuit_And_Or applies to the current unit.
1383 type SPARK_Mode_Type is (None, Off, On);
1384 -- Possible legal modes that can be set by aspect/pragma SPARK_Mode, as
1385 -- well as the value None, which indicates no such pragma/aspect applies.
1387 SPARK_Mode : SPARK_Mode_Type := None;
1388 -- GNAT
1389 -- Current SPARK mode setting.
1391 SPARK_Mode_Pragma : Node_Id := Empty;
1392 -- GNAT
1393 -- If the current SPARK_Mode (above) was set by a pragma, this records
1394 -- the pragma that set this mode.
1396 SPARK_Switches_File_Name : String_Ptr := null;
1397 -- GNAT
1398 -- Set to non-null file name by use of the -gnates switch to specify
1399 -- SPARK (gnat2why) specific switches in the given file name.
1401 Special_Exception_Package_Used : Boolean := False;
1402 -- GNAT
1403 -- Set to True if either of the unit GNAT.Most_Recent_Exception or
1404 -- GNAT.Exception_Traces is with'ed. Used to inhibit transformation of
1405 -- local raise statements into gotos in the presence of either package.
1407 Sprint_Line_Limit : Nat := 72;
1408 -- GNAT
1409 -- Limit values for chopping long lines in Cprint/Sprint output, can be
1410 -- reset by use of NNN parameter with -gnatG or -gnatD switches.
1412 Stack_Checking_Enabled : Boolean := False;
1413 -- GNAT
1414 -- Set to indicate if stack checking is enabled for the compilation. This
1415 -- is set directly from the value in the gcc back end in the body of the
1416 -- gcc version of back_end.adb.
1418 Style_Check : Boolean := False;
1419 -- GNAT
1420 -- Set True to perform style checks. Activates checks carried out in
1421 -- package Style (see body of this package for details of checks). This
1422 -- flag is set True by use of either the -gnatg or -gnaty switches, or
1423 -- by the Style_Check pragma.
1425 Style_Check_Main : Boolean := False;
1426 -- GNAT
1427 -- Set True if Style_Check was set for the main unit. This is used to
1428 -- enable style checks for units in the main extended source that get
1429 -- with'ed indirectly. It is set True by use of either the -gnatg or
1430 -- -gnaty switches, but not by use of the Style_Checks pragma.
1432 Suppress_Control_Flow_Optimizations : Boolean := False;
1433 -- GNAT
1434 -- Set by -fpreserve-control-flow. Suppresses control flow optimizations
1435 -- that interfere with coverage analysis based on the object code.
1437 System_Extend_Pragma_Arg : Node_Id := Empty;
1438 -- GNAT
1439 -- Set non-empty if and only if a correct Extend_System pragma was present
1440 -- in which case it points to the argument of the pragma, and the name can
1441 -- be located as Chars (Expression (System_Extend_Pragma_Arg)).
1443 System_Extend_Unit : Node_Id := Empty;
1444 -- GNAT
1445 -- This is set to Empty if GNAT_Mode is set, since pragma Extend_System
1446 -- is never appropriate in GNAT_Mode (and causes troubles, including
1447 -- bogus circularities, if we try to compile the run-time library with
1448 -- a System extension). If GNAT_Mode is not set, then System_Extend_Unit
1449 -- is a copy of the value set in System_Extend_Pragma_Arg.
1451 Subunits_Missing : Boolean := False;
1452 -- GNAT
1453 -- This flag is set true if missing subunits are detected with code
1454 -- generation active. This causes code generation to be skipped.
1456 Suppress_Checks : Boolean := False;
1457 -- GNAT
1458 -- Set to True if -gnatp (suppress all checks) switch present.
1460 -- WARNING: There is a matching C declaration of this variable in fe.h
1462 Suppress_Options : Suppress_Record;
1463 -- GNAT
1464 -- Indicates outer level setting of check suppression. This initializes
1465 -- the settings of the outer scope level in any unit compiled. This is
1466 -- initialized by Osint.Initialize, and further initialized by the
1467 -- Adjust_Global_Switches flag in Gnat1drv.
1469 Table_Factor : Int := 1;
1470 -- GNAT
1471 -- Factor by which all initial table sizes set in Alloc are multiplied.
1472 -- Used in Table to calculate initial table sizes. The initial table size
1473 -- is the value in Alloc, used as the Table_Initial parameter value,
1474 -- multiplied by the factor given here. The default value is used if no
1475 -- -gnatT switch appears.
1477 Tagged_Type_Expansion : Boolean := True;
1478 -- GNAT
1479 -- Set True if tagged types and interfaces should be expanded by the
1480 -- front-end. If False, the original tree is left unexpanded for tagged
1481 -- types and dispatching calls, assuming the underlying target supports it.
1483 Target_Dependent_Info_Read_Name : String_Ptr := null;
1484 -- GNAT
1485 -- Set non-null to override the normal processing in Get_Targ and set the
1486 -- necessary information by reading the target dependent information file
1487 -- whose name is given here (see packages Get_Targ and Set_Targ for full
1488 -- details). Set to non-null file name by use of the -gnateT switch.
1490 Target_Dependent_Info_Write_Name : String_Ptr := null;
1491 -- GNAT
1492 -- Set non-null to enable a call to Set_Targ.Write_Target_Dependent_Info
1493 -- which writes a target independent information file (see packages
1494 -- Get_Targ and Set_Targ for full details) using the name given by
1495 -- this switch. Set to non-null file name by use of the -gnatet switch.
1497 type Origin_Of_Target is (Unknown, Default, Specified);
1499 Target_Origin : Origin_Of_Target := Unknown;
1500 -- GPRBUILD
1501 -- Indicates the origin of attribute Target in project files
1503 Target_Value : String_Access := null;
1504 -- GPRBUILD
1505 -- Indicates the value of attribute Target in project files
1507 Task_Dispatching_Policy : Character := ' ';
1508 -- GNAT, GNATBIND
1509 -- Set to ' ' for the default case (no task dispatching policy specified).
1510 -- Reset to first character (uppercase) of task dispatching policy name
1511 -- if a valid Task_Dispatching_Policy pragma is encountered.
1513 Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
1514 -- GNAT, GNATBIND
1515 -- Remember location of previous Task_Dispatching_Policy pragma. This is
1516 -- used for inconsistency error messages. A value of System_Location is
1517 -- used if the policy is set in package System.
1519 Tasking_Used : Boolean := False;
1520 -- Set True if any tasking construct is encountered. Used to activate the
1521 -- output of the Q, L and T lines in ALI files.
1523 Time_Slice_Set : Boolean := False;
1524 -- GNATBIND
1525 -- Set True if a pragma Time_Slice is processed in the main unit, or
1526 -- if the -gnatTnn switch is present to set a time slice value.
1528 Time_Slice_Value : Nat;
1529 -- GNATBIND
1530 -- Time slice value. Valid only if Time_Slice_Set is True, i.e. if
1531 -- Time_Slice pragma has been processed. Set to the time slice value in
1532 -- microseconds. Negative values are stored as zero, and the value is not
1533 -- larger than 1_000_000_000 (1000 seconds). Values larger than this are
1534 -- reset to this maximum. This can also be set with the -gnatTnn switch.
1536 Tolerate_Consistency_Errors : Boolean := False;
1537 -- GNATBIND
1538 -- Tolerate time stamp and other consistency errors. If this flag is set to
1539 -- True (-t), then inconsistencies result in warnings rather than errors.
1541 Transform_Function_Array : Boolean := False;
1542 -- GNAT
1543 -- If this switch is set True, then functions returning constrained arrays
1544 -- are transformed into a procedure with an out parameter, and all calls
1545 -- are updated accordingly.
1547 Treat_Categorization_Errors_As_Warnings : Boolean := False;
1548 -- Normally categorization errors are true illegalities. If this switch
1549 -- is set, then such errors result in warning messages rather than error
1550 -- messages. Set True by -gnateP (P for Pure/Preelaborate). Also set in
1551 -- Relaxed_RM_Semantics mode since some old Ada 83 compilers treated
1552 -- pragma Preelaborate differently.
1554 Treat_Restrictions_As_Warnings : Boolean := False;
1555 -- GNAT
1556 -- Set True to treat pragma Restrictions as Restriction_Warnings. Set by
1557 -- -gnatr switch.
1559 Try_Semantics : Boolean := False;
1560 -- GNAT
1561 -- Flag set to force attempt at semantic analysis, even if parser errors
1562 -- occur. This will probably cause blowups at this stage in the game. On
1563 -- the other hand, most such blowups will be caught cleanly and simply
1564 -- say compilation abandoned. This flag is set True by -gnatq or -gnatQ.
1566 Unchecked_Shared_Lib_Imports : Boolean := False;
1567 -- GPRBUILD
1568 -- Set to True when shared library projects are allowed to import projects
1569 -- that are not shared library projects. Set on by use of the switch
1570 -- --unchecked-shared-lib-imports.
1572 Undefined_Symbols_Are_False : Boolean := False;
1573 -- GNAT, GNATPREP
1574 -- Set to True by switch -u of gnatprep or -u in the preprocessing data
1575 -- file for the compiler. Indicates that while preprocessing sources,
1576 -- symbols that are not defined have the value FALSE.
1578 Uneval_Old : Character := 'E';
1579 -- GNAT
1580 -- Set to 'E'/'W'/'A' for use of Error/Warn/Allow in a valid pragma
1581 -- Unevaluated_Use_Of_Old. Default in the absence of the pragma is 'E'
1582 -- for the RM default behavior of giving an error.
1584 Unique_Error_Tag : Boolean := Tag_Errors;
1585 -- GNAT
1586 -- Indicates if error messages are to be prefixed by the string error:
1587 -- Initialized from Tag_Errors, can be forced on with the -gnatU switch and
1588 -- disabled with -gnatd_U.
1590 Unnest_Subprogram_Mode : Boolean := False;
1591 -- If true, activates the circuitry for unnesting subprograms (see the spec
1592 -- of Exp_Unst for full details). Currently set only by use of -gnatd.1.
1594 Unreserve_All_Interrupts : Boolean := False;
1595 -- GNAT, GNATBIND
1596 -- Normally set False, set True if a valid Unreserve_All_Interrupts pragma
1597 -- appears anywhere in the main unit for GNAT, or if any ALI file has the
1598 -- corresponding attribute set in GNATBIND.
1600 Upper_Half_Encoding : Boolean := False;
1601 -- GNAT, GNATBIND
1602 -- Normally set False, indicating that upper half ISO 8859-1 characters are
1603 -- used in the normal way to represent themselves. If the wide character
1604 -- encoding method uses the upper bit for this encoding, then this flag is
1605 -- set True, and upper half characters in the source indicate the start of
1606 -- a wide character sequence. Set by -gnatW or -W switches.
1608 Use_Include_Path_File : Boolean := False;
1609 -- GNATMAKE, GPRBUILD
1610 -- When True, create a source search path file, even when a mapping file
1611 -- is used.
1613 Usage_Requested : Boolean := False;
1614 -- GNAT, GNATBIND, GNATMAKE
1615 -- Set to True if -h (-gnath for the compiler) switch encountered
1616 -- requesting usage information
1618 Use_Pragma_Linker_Constructor : Boolean := False;
1619 -- GNATBIND
1620 -- True if pragma Linker_Constructor applies to adainit
1622 Use_VADS_Size : Boolean := False;
1623 -- GNAT
1624 -- Set to True if a valid pragma Use_VADS_Size is processed
1626 Validity_Checks_On : Boolean := True;
1627 -- GNAT
1628 -- This flag determines if validity checking is on or off. The initial
1629 -- state is on, and the required default validity checks are active. The
1630 -- actual set of checks that is performed if Validity_Checks_On is set is
1631 -- defined by the switches in package Validsw. The Validity_Checks_On flag
1632 -- is controlled by pragma Validity_Checks (On | Off), and also some
1633 -- generated compiler code (typically code that has to do with validity
1634 -- check generation) is compiled with this flag set to False. This flag is
1635 -- set to False by the -gnatp switch.
1637 Verbose_Mode : Boolean := False;
1638 -- GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATNAME, GNATCLEAN,
1639 -- GPRBUILD, GPRCLEAN
1640 -- Set to True to get verbose mode (full error message text and location
1641 -- information sent to standard output, also header, copyright and summary)
1643 type Verbosity_Level_Type is (None, Low, Medium, High);
1644 pragma Ordered (Verbosity_Level_Type);
1645 Verbosity_Level : Verbosity_Level_Type := High;
1646 -- GNATMAKE
1647 -- Modified by gnatmake switches -v, -vl, -vm, -vh. Indicates
1648 -- the level of verbosity of informational messages:
1650 -- In Low Verbosity, the reasons why a source is recompiled, the name
1651 -- of the executable and the reason it must be rebuilt is output.
1653 -- In Medium Verbosity, additional lines are output for each ALI file
1654 -- that is checked.
1656 -- In High Verbosity, additional lines are output when the ALI file
1657 -- is part of an Ada library, is read-only or is part of the runtime.
1659 type Warning_Mode_Type is
1660 (Suppress, Normal, Treat_As_Error, Treat_Run_Time_Warnings_As_Errors);
1661 Warning_Mode : Warning_Mode_Type := Normal;
1662 -- GNAT, GNATBIND
1663 -- Controls treatment of warning messages. If set to Suppress, warning
1664 -- messages are not generated at all. In Normal mode, they are generated
1665 -- but do not count as errors. In Treat_As_Error mode, warning messages are
1666 -- generated and treated as errors, except for warnings emitted by the
1667 -- Compile_Time_Warning pragma. In Treat_Run_Time_Warnings_As_Errors,
1668 -- warning messages regarding errors raised at run time are treated as
1669 -- errors. Note that Warning_Mode = Suppress causes pragma Warnings to be
1670 -- ignored (except for legality checks), unless we are in GNATprove_Mode,
1671 -- which requires pragma Warnings to be stored for the formal verification
1672 -- backend.
1674 Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1675 -- GNAT, GNATBIND
1676 -- Method used for encoding wide characters in the source program. See
1677 -- description of type in unit System.WCh_Con for a list of the methods
1678 -- that are currently supported. Note that brackets notation is always
1679 -- recognized in source programs regardless of the setting of this
1680 -- variable. The default setting causes only the brackets notation to be
1681 -- recognized. If this is the main unit, this setting also controls the
1682 -- output of the W=? parameter in the ALI file, which is used to provide
1683 -- the default for encoding [Wide_[Wide_]]Text_IO files. For the binder,
1684 -- the value set here overrides this main unit default.
1686 Wide_Character_Encoding_Method_Specified : Boolean := False;
1687 -- GNAT, GNATBIND
1688 -- Set True if the value in Wide_Character_Encoding_Method was set as
1689 -- a result of an explicit -gnatW? or -W? switch. False otherwise.
1691 Xref_Active : Boolean := True;
1692 -- GNAT
1693 -- Set if cross-referencing is enabled (i.e. xref info in ALI files)
1695 Zero_Formatting : Boolean := False;
1696 -- GNATBIND
1697 -- Do no formatting (no title, no leading spaces, no empty lines) in
1698 -- auxiliary outputs (-e, -K, -l, -R).
1700 ----------------------------
1701 -- Configuration Settings --
1702 ----------------------------
1704 -- These are settings that are used to establish the mode at the start of
1705 -- each unit. The values defined below can be affected either by command
1706 -- line switches, or by the use of appropriate configuration pragmas in a
1707 -- configuration pragma file (but NOT by a local use of a configuration
1708 -- pragma in a single file).
1710 Ada_Version_Config : Ada_Version_Type;
1711 -- GNAT
1712 -- This is the value of the configuration switch for the Ada 83 mode, as
1713 -- set by the command line switches -gnat83/95/2005/2012, and possibly
1714 -- modified by the use of configuration pragmas Ada_*. This switch is used
1715 -- to set the initial value for Ada_Version mode at the start of analysis
1716 -- of a unit. Note however that the setting of this flag is ignored for
1717 -- internal and predefined units (which are always compiled in the most up
1718 -- to date version of Ada).
1720 Ada_Version_Pragma_Config : Node_Id;
1721 -- This will be set nonempty if it is set by a configuration pragma
1723 Ada_Version_Explicit_Config : Ada_Version_Type;
1724 -- GNAT
1725 -- This is set in the same manner as Ada_Version_Config. The difference is
1726 -- that the setting of this flag is not ignored for internal and predefined
1727 -- units, which for some purposes do indeed access this value, regardless
1728 -- of the fact that they are compiled the most up to date ada version).
1730 Assertions_Enabled_Config : Boolean;
1731 -- GNAT
1732 -- This is the value of the configuration switch for assertions enabled
1733 -- mode, as possibly set by the command line switch -gnata, and possibly
1734 -- modified by the use of the configuration pragma Assertion_Policy.
1736 Assume_No_Invalid_Values_Config : Boolean;
1737 -- GNAT
1738 -- This is the value of the configuration switch for assuming "no invalid
1739 -- values enabled" mode, as possibly set by the command line switch
1740 -- -gnatB, and possibly modified by the use of the configuration pragma
1741 -- Assume_No_Invalid_Values.
1743 Check_Float_Overflow_Config : Boolean;
1744 -- GNAT
1745 -- Set to True to check that operations on predefined unconstrained float
1746 -- types (e.g. Float, Long_Float) do not overflow and generate infinities
1747 -- or invalid values. Set by the Check_Float_Overflow pragma, or by use
1748 -- of the -gnateF switch.
1750 Check_Policy_List_Config : Node_Id;
1751 -- GNAT
1752 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
1753 -- that are linked through the Next_Pragma fields, with the list being
1754 -- terminated by Empty. The order is most recently processed first. This
1755 -- list includes only those pragmas in configuration pragma files.
1757 Default_Pool_Config : Node_Id := Empty;
1758 -- GNAT
1759 -- Same as Default_Pool above, except this is only for Default_Storage_Pool
1760 -- pragmas that are configuration pragmas.
1762 Default_SSO_Config : Character := ' ';
1763 -- GNAT
1764 -- Set if a pragma Default_Scalar_Storage_Order appears as a configuration
1765 -- pragma. A value of ' ' means that no pragma was given, otherwise the
1766 -- value is 'H' for High_Order_First or 'L' for Low_Order_First.
1768 Dynamic_Elaboration_Checks_Config : Boolean := False;
1769 -- GNAT
1770 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
1771 -- switch or by the use of pragma Elaboration_Checking (Dynamic).
1773 Exception_Locations_Suppressed_Config : Boolean := False;
1774 -- GNAT
1775 -- Set True by use of the configuration pragma Suppress_Exception_Messages
1777 External_Name_Exp_Casing_Config : External_Casing_Type;
1778 -- GNAT
1779 -- This is the value of the configuration switch that controls casing of
1780 -- external symbols for which an explicit external name is given. It can be
1781 -- set to Uppercase by the command line switch -gnatF, and further modified
1782 -- by the use of the configuration pragma External_Name_Casing in the
1783 -- gnat.adc file. This flag is used to set the initial value for
1784 -- External_Name_Exp_Casing at the start of analyzing each unit. Note
1785 -- however that the setting of this flag is ignored for internal and
1786 -- predefined units (which are always compiled with As_Is mode).
1788 External_Name_Imp_Casing_Config : External_Casing_Type;
1789 -- GNAT
1790 -- This is the value of the configuration switch that controls casing of
1791 -- external symbols where the external name is implicitly given. It can be
1792 -- set to Uppercase by the command line switch -gnatF, and further modified
1793 -- by the use of the configuration pragma External_Name_Casing in the
1794 -- gnat.adc file. This flag is used to set the initial value for
1795 -- External_Name_Imp_Casing at the start of analyzing each unit. Note
1796 -- however that the setting of this flag is ignored for internal and
1797 -- predefined units (which are always compiled with Lowercase mode).
1799 Fast_Math_Config : Boolean;
1800 -- GNAT
1801 -- This is the value of the configuration switch that controls Fast_Math
1802 -- mode, as set by a Fast_Math pragma in configuration pragmas. It is
1803 -- used to set the initial value of Fast_Math at the start of each new
1804 -- compilation unit.
1806 Initialize_Scalars_Config : Boolean;
1807 -- GNAT
1808 -- This is the value of the configuration switch that is set by the
1809 -- pragma Initialize_Scalars when it appears in the gnat.adc file.
1810 -- This switch is not set when the pragma appears ahead of a given
1811 -- unit, so it does not affect the compilation of other units.
1813 No_Component_Reordering_Config : Boolean;
1814 -- GNAT
1815 -- This is the value of the configuration switch that is set by the
1816 -- pragma No_Component_Reordering when it appears in the gnat.adc file.
1817 -- This flag is used to set the initial value of No_Component_Reordering
1818 -- at the start of each compilation unit, except that it is always set
1819 -- False for predefined units.
1821 No_Exit_Message : Boolean := False;
1822 -- GNATMAKE, GPRBUILD
1823 -- Set with switch --no-exit-message. When True, if there are compilation
1824 -- failures, the builder does not issue an exit error message.
1826 Optimize_Alignment_Config : Character;
1827 -- GNAT
1828 -- This is the value of the configuration switch that controls the
1829 -- alignment optimization mode, as set by an Optimize_Alignment pragma.
1830 -- It is used to set the initial value of Optimize_Alignment at the start
1831 -- of each new compilation unit, except that it is always set to 'O' (off)
1832 -- for internal units.
1834 Persistent_BSS_Mode_Config : Boolean;
1835 -- GNAT
1836 -- This is the value of the configuration switch that controls whether
1837 -- potentially persistent data is to be placed in the persistent_bss
1838 -- section. It can be set True by use of the pragma Persistent_BSS.
1839 -- This flag is used to set the initial value of Persistent_BSS_Mode
1840 -- at the start of each compilation unit, except that it is always
1841 -- set False for predefined units.
1843 Prefix_Exception_Messages_Config : Boolean;
1844 -- The setting of Prefix_Exception_Messages from configuration pragmas
1846 SPARK_Mode_Config : SPARK_Mode_Type := None;
1847 -- GNAT
1848 -- The setting of SPARK_Mode from configuration pragmas
1850 SPARK_Mode_Pragma_Config : Node_Id := Empty;
1851 -- If a SPARK_Mode pragma appeared in the configuration pragmas (setting
1852 -- SPARK_Mode_Config appropriately), then this points to the N_Pragma node.
1854 Uneval_Old_Config : Character;
1855 -- GNAT
1856 -- The setting of Uneval_Old from configuration pragmas
1858 Use_VADS_Size_Config : Boolean;
1859 -- GNAT
1860 -- This is the value of the configuration switch that controls the use of
1861 -- VADS_Size instead of Size wherever the attribute Size is used. It can
1862 -- be set True by the use of the pragma Use_VADS_Size in the gnat.adc file.
1863 -- This flag is used to set the initial value for Use_VADS_Size at the
1864 -- start of analyzing each unit. Note however that the setting of this flag
1865 -- is ignored for internal and predefined units (which are always compiled
1866 -- with the standard Size semantics).
1868 type Config_Switches_Type is private;
1869 -- Type used to save values of the switches set from Config values
1871 procedure Register_Config_Switches;
1872 -- This procedure is called after processing the gnat.adc file and other
1873 -- configuration pragma files to record the values of the Config switches,
1874 -- as possibly modified by the use of command line switches and pragmas
1875 -- appearing in these files.
1877 procedure Restore_Config_Switches (Save : Config_Switches_Type);
1878 -- This procedure restores a set of switch values previously saved by a
1879 -- call to Save_Config_Switches.
1881 function Save_Config_Switches return Config_Switches_Type;
1882 -- Return the current state of all configuration-related attributes
1884 procedure Set_Config_Switches
1885 (Internal_Unit : Boolean;
1886 Main_Unit : Boolean);
1887 -- This procedure sets the switches to the appropriate initial values. The
1888 -- parameter Internal_Unit is True for an internal or predefined unit, and
1889 -- affects the way the switches are set (see above). Main_Unit is true if
1890 -- switches are being set for the main unit or for the spec of the main
1891 -- unit. This affects setting of the assert/debug pragma switches, which
1892 -- are normally set false by default for an internal unit, except when the
1893 -- internal unit is the main unit, in which case we use the command line
1894 -- settings.
1896 ------------------------
1897 -- Other Global Flags --
1898 ------------------------
1900 Building_Static_Dispatch_Tables : Boolean := True;
1901 -- This flag indicates if the backend supports generation of statically
1902 -- allocated dispatch tables. If it is True, then the front end will
1903 -- generate static aggregates for dispatch tables that contain forward
1904 -- references to addresses of subprograms not seen yet, and the back end
1905 -- must be prepared to handle this case. If it is False, then the front end
1906 -- generates assignments to initialize the dispatch table, and there are
1907 -- no such forward references. By default we build statically allocated
1908 -- dispatch tables for all library-level tagged types in all platforms.
1909 -- This behavior can be disabled using switch -gnatd.t which will set
1910 -- this flag to False and revert to the previous dynamic behavior.
1912 Expander_Active : Boolean := False;
1913 -- A flag that indicates if expansion is active (True) or deactivated
1914 -- (False). When expansion is deactivated all calls to expander routines
1915 -- have no effect. Note that the initial setting of False is merely to
1916 -- prevent saving of an undefined value for an initial call to the
1917 -- Expander_Mode_Save_And_Set procedure. For more information on the use of
1918 -- this flag, see package Expander. Indeed this flag might more logically
1919 -- be in the spec of Expander, but it is referenced by Errout, and it
1920 -- really seems wrong for Errout to depend on Expander.
1922 Tagged_Seen : Boolean := False;
1923 -- Set True by the parser if the "tagged" reserved word is seen. This is
1924 -- needed in Exp_Put_Image (see that package for documentation).
1926 -----------------------------------
1927 -- Modes for Formal Verification --
1928 -----------------------------------
1930 GNATprove_Mode : Boolean := False;
1931 -- Specific compiling mode targeting formal verification for those parts
1932 -- of the input code that belong to the SPARK 2014 subset of Ada. Set True
1933 -- by the gnat2why executable or by use of the -gnatd.F debug switch. Note
1934 -- that this is completely separate from the SPARK restriction defined in
1935 -- GNAT to detect violations of a subset of SPARK 2005 rules.
1937 ---------------------------
1938 -- Error/Warning Control --
1939 ---------------------------
1941 -- The following array would more reasonably be located in Err_Vars or
1942 -- Errout, but we put them here to deal with licensing issues (we need
1943 -- this to have the GPL exception licensing, since these variables and
1944 -- subprograms are accessed from units with this licensing).
1946 Warnings_As_Errors : array (1 .. 10_000) of String_Ptr;
1947 -- Table for recording Warning_As_Error pragmas as they are processed. It
1948 -- would be nicer to use Table, but there are circular elaboration problems
1949 -- if we try to do this, and an attempt to find some other appropriately
1950 -- licensed unit to declare this as a Table failed with various elaboration
1951 -- circularities.
1953 Warnings_As_Errors_Count : Natural;
1954 -- GNAT
1955 -- Number of entries stored in Warnings_As_Errors table
1957 Warnings_As_Errors_Count_Config : Natural;
1958 -- GNAT
1959 -- Count of pattern strings stored from Warning_As_Error pragmas
1961 ---------------
1962 -- GNAT_Mode --
1963 ---------------
1965 GNAT_Mode : Boolean := False;
1966 -- GNAT
1967 -- True if compiling in GNAT system mode (-gnatg switch)
1969 -- WARNING: There is a matching C declaration of this variable in fe.h
1971 GNAT_Mode_Config : Boolean := False;
1972 -- GNAT
1973 -- True if -gnatg switch is present. GNAT_Mode may be temporary set to
1974 -- True during the analysis of a system unit, but GNAT_Mode_Config must
1975 -- not change once scanned and set.
1977 -- Setting GNAT mode has the following effects on the language that is
1978 -- accepted. Note that several of the following have the effect of changing
1979 -- an error to a warning. But warnings are usually treated as fatal errors
1980 -- in -gnatg mode, so to actually take advantage of such a change, it is
1981 -- necessary to add an explicit pragma Warnings (Off) in the source and
1982 -- this requires clear documentation of why this is necessary.
1984 -- The identifier character set is set to 'n' (7-bit ASCII)
1986 -- Pragma Extend_System is ignored
1988 -- Warning_Mode is set to Treat_As_Error (-gnatwe)
1990 -- Standard style checks are set (See Set_GNAT_Style_Check_Options)
1992 -- Standard warnings are turned on (see Set_GNAT_Mode_Warnings)
1994 -- The Ada version is set to Ada 2012
1996 -- Task priorities are always allowed to be in the range Any_Priority
1998 -- Overflow checks are suppressed, overflow checking set to strict mode
2000 -- ALI files are always generated for predefined generic packages
2002 -- Obsolescent feature warnings are suppressed
2004 -- Recompilation of children of GNAT, System, Ada, Interfaces is allowed
2006 -- The Scalar_Storage_Order attribute applies to generic types
2008 -- Categorization errors are treated as warnings rather than errors
2010 -- Statements in preelaborated units give warnings rather than errors
2012 -- Private objects are allowed in preelaborated units
2014 -- Non-static constants in preelaborated units give warnings not errors
2016 -- The warning about component size being ignored is suppressed
2018 -- The warning about size clauses being ignored is suppressed
2020 -- Initializing limited types gives a warning rather than an error
2022 -- Copying of limited objects is allowed
2024 -- Returning objects of limited types is allowed
2026 -- Non-static call in preelaborated unit give a warning, not an error
2028 -- Warnings on possible elaboration errors are suppressed
2030 -- Warnings about packing being ignored are suppressed
2032 -- Warnings in internal units are not suppressed (they normally are)
2034 -- The only special comment sequence allowed is --!
2036 --------------------------
2037 -- Private Declarations --
2038 --------------------------
2040 private
2041 -- The following type is used to save and restore settings of switches in
2042 -- Opt that represent the configuration (i.e. result of config pragmas).
2044 -- Note that Ada_Version_Explicit is not included, since this is a sticky
2045 -- flag that once set does not get reset, since the whole idea of this flag
2046 -- is to record the setting for the main unit.
2048 type Config_Switches_Type is record
2049 Ada_Version : Ada_Version_Type;
2050 Ada_Version_Explicit : Ada_Version_Type;
2051 Ada_Version_Pragma : Node_Id;
2052 Assertions_Enabled : Boolean;
2053 Assume_No_Invalid_Values : Boolean;
2054 Check_Float_Overflow : Boolean;
2055 Check_Policy_List : Node_Id;
2056 Default_Pool : Node_Id;
2057 Default_SSO : Character;
2058 Dynamic_Elaboration_Checks : Boolean;
2059 Exception_Locations_Suppressed : Boolean;
2060 External_Name_Exp_Casing : External_Casing_Type;
2061 External_Name_Imp_Casing : External_Casing_Type;
2062 Fast_Math : Boolean;
2063 Initialize_Scalars : Boolean;
2064 No_Component_Reordering : Boolean;
2065 Normalize_Scalars : Boolean;
2066 Optimize_Alignment : Character;
2067 Optimize_Alignment_Local : Boolean;
2068 Persistent_BSS_Mode : Boolean;
2069 Prefix_Exception_Messages : Boolean;
2070 SPARK_Mode : SPARK_Mode_Type;
2071 SPARK_Mode_Pragma : Node_Id;
2072 Uneval_Old : Character;
2073 Use_VADS_Size : Boolean;
2074 Warnings_As_Errors_Count : Natural;
2075 end record;
2077 -- The following declarations are for GCC version dependent flags. We do
2078 -- not let client code in the compiler test GCC_Version directly, but
2079 -- instead use deferred constants for relevant feature tags.
2081 -- Note: there currently are no such constants defined in this section,
2082 -- since the compiler front end is currently entirely independent of the
2083 -- GCC version, which is a desirable state of affairs.
2085 function get_gcc_version return Int;
2086 pragma Import (C, get_gcc_version, "get_gcc_version");
2088 GCC_Version : constant Nat := get_gcc_version;
2089 -- GNATMAKE
2090 -- Indicates which version of gcc is in use (3 = 3.x, 4 = 4.x). Note that
2091 -- gcc 2.8.1 (which used to be a value of 2) is no longer supported.
2093 end Opt;