1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2019, Free Software Foundation, Inc. --
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. --
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. --
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/>. --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
30 ------------------------------------------------------------------------------
32 -- This package contains global flags set by the initialization routine from
33 -- the command line and referenced throughout the compiler, the binder, or
34 -- other GNAT tools. The comments indicate which options are used by which
35 -- programs (GNAT, GNATBIND, GNATLINK, GNATMAKE, etc).
37 -- Some flags are labelled "PROJECT MANAGER". These are used by tools that
38 -- use the Project Manager. These tools include gnatmake, gnatname, the gnat
39 -- driver, gnatclean, gprbuild and gprclean.
41 with Hostparm; use Hostparm;
42 with Types; use Types;
44 pragma Warnings (Off);
45 -- This package is used also by gnatcoll
46 with System.Strings; use System.Strings;
47 with System.WCh_Con; use System.WCh_Con;
52 ----------------------
53 -- Checksum Control --
54 ----------------------
56 -- Checksums are computed for sources to check for sources being the same
57 -- from a compilation point of view (e.g. spelling of identifiers and
58 -- white space layout do not count in this computation).
60 -- The way the checksum is computed has evolved across the various versions
61 -- of GNAT. When gprbuild is called with -m, the checksums must be computed
62 -- the same way in gprbuild as it was in the GNAT version of the compiler.
63 -- The different ways are
65 -- Version 6.4 and later:
67 -- The Accumulate_Token_Checksum procedure is called after each numeric
68 -- literal and each identifier/keyword. For keywords, Tok_Identifier is
69 -- used in the call to Accumulate_Token_Checksum.
71 -- Versions 5.04 to 6.3:
73 -- For keywords, the token value were used in the call to procedure
74 -- Accumulate_Token_Checksum. Type Token_Type did not include Tok_Some.
78 -- For keywords, the token value were used in the call to
79 -- Accumulate_Token_Checksum. Type Token_Type did not include
80 -- Tok_Interface, Tok_Overriding, Tok_Synchronized and Tok_Some.
82 -- Versions 5.02 and before:
84 -- No calls to procedure Accumulate_Token_Checksum (the checksum
85 -- mechanism was introduced in version 5.03).
87 -- To signal to the scanner whether Accumulate_Token_Checksum needs to be
88 -- called and what versions to call, the following Boolean flags are used:
90 Checksum_Accumulate_Token_Checksum : Boolean := True;
92 -- Set to False by gprbuild when the version of GNAT is 5.02 or before. If
93 -- this switch is False, then we do not call Accumulate_Token_Checksum, so
94 -- the setting of the following two flags is irrelevant.
96 Checksum_GNAT_6_3 : Boolean := False;
98 -- Set to True by gprbuild when the version of GNAT is 6.3 or before.
100 Checksum_GNAT_5_03 : Boolean := False;
102 -- Set to True by gprbuild when the version of GNAT is 5.03 or before.
104 Checksum_Accumulate_Limited_Checksum : Boolean := False;
105 -- Used to control the computation of the limited view of a package.
106 -- (Not currently used, possible optimization for ALI files of units
107 -- in limited with_clauses).
109 ----------------------------------------------
110 -- Settings of Modes for Current Processing --
111 ----------------------------------------------
113 -- The following mode values represent the current state of processing.
114 -- The values set here are the default values. Unless otherwise noted,
115 -- the value may be reset in Switch-? with an appropriate switch. In
116 -- some cases, the values can also be modified by pragmas, and in the
117 -- case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
118 -- the default values.
120 Latest_Ada_Only : Boolean := False;
121 -- If True, the only value valid for Ada_Version is Ada_Version_Type'Last,
122 -- trying to specify other values will be ignored (in case of pragma
123 -- Ada_xxx) or generate an error (in case of -gnat83/95/xx switches).
125 type Ada_Version_Type is (Ada_83, Ada_95, Ada_2005, Ada_2012, Ada_2020);
126 pragma Ordered (Ada_Version_Type);
127 -- Versions of Ada for Ada_Version below. Note that these are ordered,
128 -- so that tests like Ada_Version >= Ada_95 are legitimate and useful.
129 -- Think twice before using "="; Ada_Version >= Ada_2012 is more likely
130 -- what you want, because it will apply to future versions of the language.
132 Ada_Version_Default : constant Ada_Version_Type := Ada_2012;
133 pragma Warnings (Off, Ada_Version_Default);
135 -- Default Ada version if no switch given. The Warnings off is to kill
136 -- constant condition warnings.
138 Ada_Version : Ada_Version_Type := Ada_Version_Default;
140 -- Current Ada version for compiler, as set by configuration pragmas,
141 -- compiler switches, or implicitly (to Ada_Version_Runtime) when a
142 -- predefined or internal file is compiled.
144 Ada_Version_Pragma : Node_Id := Empty;
145 -- Reflects the Ada_xxx pragma that resulted in setting Ada_Version. Used
146 -- to specialize error messages complaining about the Ada version in use.
148 Ada_Version_Explicit : Ada_Version_Type := Ada_Version_Default;
150 -- Like Ada_Version, but does not get set implicitly for predefined or
151 -- internal units, so it reflects the Ada version explicitly set using
152 -- configuration pragmas or compiler switches (or if neither appears, it
153 -- remains set to Ada_Version_Default). This is used in the rare cases
154 -- (notably pragma Obsolescent) where we want the explicit version set.
156 Ada_Version_Runtime : Ada_Version_Type := Ada_2012;
158 -- Ada version used to compile the runtime. Used to set Ada_Version (but
159 -- not Ada_Version_Explicit) when compiling predefined or internal units.
161 Ada_Final_Suffix : constant String := "final";
162 Ada_Final_Name : String_Ptr := new String'("ada" & Ada_Final_Suffix);
164 -- The name of the procedure that performs the finalization at the end of
165 -- execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
167 Ada_Init_Suffix : constant String := "init";
168 Ada_Init_Name : String_Ptr := new String'("ada" & Ada_Init_Suffix);
170 -- The name of the procedure that performs initialization at the start
171 -- of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
173 Ada_Main_Name_Suffix : constant String := "main";
175 -- The suffix for Ada_Main_Name. Defined as a constant here so that it
176 -- can be referenced in a uniform manner to create either the default
177 -- value of Ada_Main_Name (declared below), or the non-default name
178 -- set by Gnatbind.Scan_Bind_Arg.
180 Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
182 -- The name of the Ada package generated by the binder (when in Ada mode).
183 -- This variable may be modified by Gnatbind.Scan_Bind_Arg.
185 Address_Clause_Overlay_Warnings : Boolean := True;
187 -- Set False to disable address clause warnings. Modified by use of
190 Address_Is_Private : Boolean := False;
192 -- Set True if package System has the line "type Address is private;"
194 Aggregate_Individually_Assign : Boolean := False;
196 -- Set True if record aggregates are to be always converted into assignment
197 -- statements. Set through the corresponding pragma.
199 All_Errors_Mode : Boolean := False;
201 -- Flag set to force display of multiple errors on a single line and
202 -- also repeated error messages for references to undefined identifiers
203 -- and certain other repeated error messages. Set by use of -gnatf.
205 Allow_Integer_Address : Boolean := False;
207 -- Allow use of integer expression in a context requiring System.Address.
208 -- Set by the use of configuration pragma Allow_Integer_Address Also set
209 -- in relaxed semantics mode for use by CodePeer or when -gnatd.M is used.
211 All_Sources : Boolean := False;
213 -- Set to True to require all source files to be present. This flag is
214 -- directly modified by gnatmake to affect the shared binder routines.
216 Alternate_Main_Name : String_Ptr := null;
218 -- Set to non-null when Bind_Alternate_Main_Name is True. This value
219 -- is modified as needed by Gnatbind.Scan_Bind_Arg.
221 ASIS_GNSA_Mode : Boolean := False;
223 -- Enable GNSA back-end processing assuming ASIS_Mode is already set to
224 -- True. ASIS_GNSA mode suppresses the call to gigi.
226 ASIS_Mode : Boolean := False;
228 -- Enable semantic checks and tree transformations that are important
229 -- for ASIS but that are usually skipped if Operating_Mode is set to
230 -- Check_Semantics. This flag does not have the corresponding option to set
231 -- it ON. It is set ON when Tree_Output is set ON, it can also be set ON
232 -- from the code of GNSA-based tool (a client may need to set ON the
233 -- Back_Annotate_Rep_Info flag in this case. At the moment this does not
234 -- make very much sense, because GNSA cannot do back annotation).
236 Assertions_Enabled : Boolean := False;
238 -- Indicates default policy (True = Check, False = Ignore) to be applied
239 -- to all assertion aspects and pragmas, and to pragma Debug, if there is
240 -- no overriding Assertion_Policy, Check_Policy, or Debug_Policy pragma.
241 -- Set True by use of -gnata.
243 Assume_No_Invalid_Values : Boolean := False;
244 -- GNAT Normally, in accordance with (RM 13.9.1 (9-11)) the front end
245 -- assumes that values could have invalid representations, unless it can
246 -- clearly prove that the values are valid. If this switch is set (by
247 -- pragma Assume_No_Invalid_Values (On)), then the compiler assumes values
248 -- are valid and in range of their representations. This feature is now
249 -- fully enabled in the compiler.
251 Back_Annotate_Rep_Info : Boolean := False;
253 -- If set True, enables back annotation of representation information
254 -- by gigi, even in -gnatc mode. This is set True by the use of -gnatR
255 -- (list representation information) or -gnatt (generate tree). It is
256 -- also set true if certain Unchecked_Conversion instantiations require
257 -- checking based on annotated values.
259 Back_End_Handles_Limited_Types : Boolean;
260 -- This flag is set true if the back end can properly handle limited or
261 -- other by reference types, and avoid copies. If this flag is False, then
262 -- the front end does special expansion for if/case expressions to make
263 -- sure that no copy occurs. If the flag is True, then the expansion for
264 -- if and case expressions relies on the back end properly handling things.
265 -- Currently the default is False for all cases (set in gnat1drv). The
266 -- default can be modified using -gnatd.L (sets the flag True). This is
267 -- used to test the possibility of having the backend handle this.
269 Back_End_Inlining : Boolean := False;
271 -- Set True to activate inlining by back-end expansion. This is the normal
272 -- default mode for gcc targets, so it is True on such targets unless the
273 -- switches -gnatN or -gnatd.z are used. See circuitry in gnat1drv for the
274 -- exact conditions for setting this switch.
276 Bind_Alternate_Main_Name : Boolean := False;
278 -- True if main should be called Alternate_Main_Name.all.
279 -- This variable may be set to True by Gnatbind.Scan_Bind_Arg.
281 Bind_Main_Program : Boolean := True;
283 -- Set to False if not binding main Ada program
285 Bind_For_Library : Boolean := False;
287 -- Set to True if the binder needs to generate a file designed for building
288 -- a library. May be set to True by Gnatbind.Scan_Bind_Arg.
290 Bind_Only : Boolean := False;
291 -- GNATMAKE, GPRBUILD
292 -- Set to True to skip compile and link steps
293 -- (except when Compile_Only and/or Link_Only are True).
295 Blank_Deleted_Lines : Boolean := False;
297 -- Output empty lines for each line of preprocessed input that is deleted
298 -- in the output, including preprocessor lines starting with a '#'.
300 Brief_Output : Boolean := False;
302 -- Force brief error messages to standard error, even if verbose mode is
303 -- set (so that main error messages go to standard output).
305 Build_Bind_And_Link_Full_Project : Boolean := False;
307 -- Set to True to build, bind and link all the sources of a project file
310 Check_Aliasing_Of_Parameters : Boolean := False;
312 -- Set to True to detect whether subprogram parameters and function results
313 -- alias the same object(s).
315 Check_Float_Overflow : Boolean := False;
317 -- Set to True to check that operations on predefined unconstrained float
318 -- types (e.g. Float, Long_Float) do not overflow and generate infinities
319 -- or invalid values. Set by the Check_Float_Overflow pragma, or by use
320 -- of the -gnateF switch.
322 Check_Object_Consistency : Boolean := False;
323 -- GNATBIND, GNATMAKE
324 -- Set to True to check whether every object file is consistent with its
325 -- corresponding ada library information (ALI) file. An object file is
326 -- inconsistent with the corresponding ALI file if the object file does
327 -- not exist or if it has an older time stamp than the ALI file. Default
328 -- above is for GNATBIND. GNATMAKE overrides this default to True (see
329 -- Make.Initialize) since we normally do need to check source consistencies
332 Check_Only : Boolean := False;
334 -- Set to True to do checks only, no output of binder file
336 Check_Policy_List : Node_Id := Empty;
338 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
339 -- that are linked through the Next_Pragma fields, with the list being
340 -- terminated by Empty. The order is most recently processed first. Note
341 -- that Push_Scope and Pop_Scope in Sem_Ch8 save and restore the value
342 -- of this variable, implementing the required scope control for pragmas
343 -- appearing in a declarative part.
345 Check_Readonly_Files : Boolean := False;
347 -- Set to True to check readonly files during the make process
349 Check_Source_Files : Boolean := True;
350 -- GNATBIND, GNATMAKE
351 -- Set to True to enable consistency checking for any source files that
352 -- are present (i.e. date must match the date in the library info file).
353 -- Set to False for object file consistency check only. This flag is
354 -- directly modified by gnatmake, to affect the shared binder routines.
356 Check_Switches : Boolean := False;
358 -- Set to True to check compiler options during the make process
360 Check_Unreferenced : Boolean := False;
362 -- Set to True to enable checking for unreferenced entities other
363 -- than formal parameters (for which see Check_Unreferenced_Formals)
364 -- Modified by use of -gnatwu/U.
366 Check_Unreferenced_Formals : Boolean := False;
368 -- Set to True to check for unreferenced formals. This is turned on by
369 -- -gnatwa/wf/wu and turned off by -gnatwA/wF/wU.
371 Check_Validity_Of_Parameters : Boolean := False;
373 -- Set to True to check for proper scalar initialization of subprogram
374 -- parameters on both entry and exit. This is turned on by -gnateV.
376 Check_Withs : Boolean := False;
378 -- Set to True to enable checking for unused withs, and also the case
379 -- of withing a package and using none of the entities in the package.
380 -- Modified by use of -gnatwu/U.
382 CodePeer_Mode : Boolean := False;
383 -- GNAT, GNATBIND, GPRBUILD
384 -- Enable full CodePeer mode (SCIL generation, disable switches that
385 -- interact badly with it, etc...). This is turned on by -gnatC.
387 Commands_To_Stdout : Boolean := False;
389 -- True if echoed commands to be written to stdout instead of stderr
391 Comment_Deleted_Lines : Boolean := False;
393 -- True if source lines removed by the preprocessor should be commented
394 -- in the output file.
396 Compilation_Time : String (1 .. 19);
398 -- Compilation date and time in form YYYY-MM-DD HH:MM:SS
400 Compile_Only : Boolean := False;
401 -- GNATMAKE, GNATCLEAN, GPBUILD, GPRCLEAN
402 -- GNATMAKE, GPRBUILD:
403 -- set True to skip bind and link steps (except when Bind_Only is True)
404 -- GNATCLEAN, GPRCLEAN:
405 -- set True to delete only the files produced by the compiler but not the
406 -- library files or the executable files.
408 Compiler_Unit : Boolean := False;
410 -- Set True by an occurrence of pragma Compiler_Unit_Warning (or of the
411 -- obsolete pragma Compiler_Unit) in the main unit. Once set True, stays
412 -- True, since any units that are with'ed directly or indirectly by
413 -- a Compiler_Unit_Warning main unit are subject to the same restrictions.
414 -- Such units really should have their own pragmas, but we do not bother to
415 -- check for that, so this transitivity provides extra checking.
417 Config_File : Boolean := True;
419 -- Set to False to inhibit reading and processing of gnat.adc file
421 Config_File_Names : String_List_Access := null;
423 -- Names of configuration pragmas files (given by switches -gnatec)
425 Configurable_Run_Time_Mode : Boolean := False;
427 -- Set True if the compiler is operating in configurable run-time mode.
428 -- This happens if the flag Targparm.Configurable_Run_TimeMode_On_Target
429 -- is set True, or if pragma No_Run_Time is used. See the spec of Rtsfind
430 -- for details on the handling of the latter pragma.
432 Constant_Condition_Warnings : Boolean := False;
434 -- Set to True to activate warnings on constant conditions. Modified by
437 Create_Mapping_File : Boolean := False;
439 -- Set to True (-C switch) to indicate that the compiler will be invoked
440 -- with a mapping file (-gnatem compiler switch).
442 subtype Debug_Level_Value is Nat range 0 .. 3;
443 Debugger_Level : Debug_Level_Value := 0;
445 -- The value given to the -g parameter. The default value for -g with
446 -- no value is 2. If no -g is specified, defaults to 0.
447 -- Note that the generated code should never depend on this variable,
448 -- since we want debug info to be nonintrusive on the generate code.
450 Default_Exit_Status : Int := 0;
452 -- Set the default exit status value. Set by the -Xnnn switch for the
455 Debug_Generated_Code : Boolean := False;
457 -- Set True (-gnatD switch) to debug generated expanded code instead
458 -- of the original source code. Causes debugging information to be
459 -- written with respect to the generated code file that is written.
461 Default_Pool : Node_Id := Empty;
463 -- Used to record the storage pool name (or null literal) that is the
464 -- argument of an applicable pragma Default_Storage_Pool.
465 -- Empty: No pragma Default_Storage_Pool applies.
466 -- N_Null node: "pragma Default_Storage_Pool (null);" applies.
467 -- otherwise: "pragma Default_Storage_Pool (X);" applies, and
468 -- this points to the name X.
469 -- Push_Scope and Pop_Scope in Sem_Ch8 save and restore this value.
471 No_Stack_Size : constant := -1;
473 Default_Stack_Size : Int := No_Stack_Size;
475 -- Set to default primary stack size in units of bytes. Set by the -dnnn
476 -- switch for the binder. A value of No_Stack_Size indicates that
477 -- no default was set by the binder.
479 Default_Sec_Stack_Size : Int := No_Stack_Size;
481 -- Set to default secondary stack size in units of bytes. Set by the -Dnnn
482 -- switch for the binder. A value of No_Stack_Size indicates that no
483 -- default was set by the binder and the run-time value should be used
486 Default_SSO : Character := ' ';
488 -- Set if a pragma Default_Scalar_Storage_Order has been given. The value
489 -- of ' ' indicates that no default has been set, otherwise the value is
490 -- either 'H' for High_Order_First or 'L' for Lower_Order_First.
492 Detect_Blocking : Boolean := False;
494 -- Set True to force the run time to raise Program_Error if calls to
495 -- potentially blocking operations are detected from protected actions.
497 Directories_Must_Exist_In_Projects : Boolean := True;
499 -- Set to False with switch -f of gnatclean and gprclean
501 Display_Compilation_Progress : Boolean := False;
502 -- GNATMAKE, GPRBUILD
503 -- Set True (-d switch) to display information on progress while compiling
504 -- files. Internal flag to be used in conjunction with an IDE (e.g GPS).
506 type Distribution_Stub_Mode_Type is
509 -- Normal mode, no generation of distribution stubs
511 Generate_Receiver_Stub_Body,
512 -- The unit being compiled is the RCI body, and the compiler will
513 -- generate the body for the receiver stubs and compile it.
515 Generate_Caller_Stub_Body);
516 -- The unit being compiled is the RCI spec, and the compiler will
517 -- generate the body for the caller stubs and compile it.
519 Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
521 -- This enumeration variable indicates the three states of distribution
522 -- annex stub generation.
524 Do_Not_Execute : Boolean := False;
526 -- Set to True if no actual compilations should be undertaken
528 Dump_Source_Text : Boolean := False;
530 -- Set to True (by -gnatL) to dump source text intermingled with generated
531 -- code. Effective only if either of Debug/Print_Generated_Code is true.
533 Dynamic_Elaboration_Checks : Boolean := False;
535 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
536 -- switch or by the use of pragma Elaboration_Checks (Dynamic).
538 Dynamic_Stack_Measurement : Boolean := False;
540 -- Set True to enable dynamic stack measurement (-u flag for gnatbind)
542 Dynamic_Stack_Measurement_Array_Size : Nat := 100;
544 -- Number of measurements we want to store during dynamic stack analysis.
545 -- When the buffer is full, non-storable results will be output on the fly.
546 -- The value is relevant only if Dynamic_Stack_Measurement is set. Set
547 -- by processing of -u flag for gnatbind.
549 Elab_Dependency_Output : Boolean := False;
551 -- Set to True to output complete list of elaboration constraints
553 Elab_Order_Output : Boolean := False;
555 -- Set to True to output chosen elaboration order
557 Elab_Info_Messages : Boolean := False;
559 -- Set to True to output info messages for static elabmodel (-gnatel)
561 Elab_Warnings : Boolean := True;
563 -- Set to True to generate elaboration warnings (-gnatwl). The warnings are
564 -- enabled by default because they carry the same importance as errors. The
565 -- compiler cannot emit actual errors because elaboration diagnostics need
566 -- dataflow analysis, which is not available. This behavior parallels that
567 -- of the old ABE mechanism.
569 Error_Msg_Line_Length : Nat := 0;
571 -- Records the error message line length limit. If this is set to zero,
572 -- then we get the old style behavior, in which each call to the error
573 -- message routines generates one line of output as a separate message.
574 -- If it is set to a non-zero value, then continuation lines are folded
575 -- to make a single long message, and then this message is split up into
576 -- multiple lines not exceeding the specified length. Set by -gnatj=nn.
578 Error_To_Warning : Boolean := False;
580 -- If True, then certain error messages (e.g. parameter overlap messages
581 -- for procedure calls in Ada 2012 mode) are treated as warnings instead
582 -- of errors. Set by debug flag -gnatd.E. A search for Error_To_Warning
583 -- will identify affected messages.
585 Exception_Handler_Encountered : Boolean := False;
587 -- This flag is set true if the parser encounters an exception handler.
588 -- It is used to set Warn_On_Exception_Propagation True if the restriction
589 -- No_Exception_Propagation is set.
591 Exception_Extra_Info : Boolean := False;
593 -- True when switch -gnateE is used. When True, generate extra information
594 -- associated with exception messages (in particular range and index
597 Exception_Locations_Suppressed : Boolean := False;
599 -- Set to True if a Suppress_Exception_Locations configuration pragma is
602 type Exception_Mechanism_Type is
603 -- Determines the kind of mechanism used to handle exceptions
606 -- Exceptions use setjmp/longjmp generated explicitly by the front end
607 -- (this includes gigi or other equivalent parts of the code generator).
608 -- AT END handlers are converted into exception handlers by the front
612 -- Exceptions are handled by the back end. The front end simply
613 -- generates the handlers as they appear in the source, and AT END
614 -- handlers are left untouched (they are not converted into exception
615 -- handlers when operating in this mode). Propagation is performed
616 -- using a frame unwinding scheme and requires no particular setup code
617 -- at handler sites on regular execution paths.
620 -- Similar to Back_End_ZCX with respect to the front-end processing
621 -- of regular and AT-END handlers. A setjmp/longjmp scheme is used to
622 -- propagate and setup handler contexts on regular execution paths.
624 pragma Convention (C, Exception_Mechanism_Type);
626 Exception_Mechanism : Exception_Mechanism_Type := Front_End_SJLJ;
628 -- Set to the appropriate value depending on the flags in system.ads
629 -- (Frontend_Exceptions + ZCX_By_Default). The C convention is there to
630 -- allow access by gigi.
632 function Back_End_Exceptions return Boolean;
633 function Front_End_Exceptions return Boolean;
634 function ZCX_Exceptions return Boolean;
635 function SJLJ_Exceptions return Boolean;
637 -- Various properties of the active Exception_Mechanism
639 Exception_Tracebacks : Boolean := False;
641 -- Set to True to store tracebacks in exception occurrences (-Ea or -E)
643 Exception_Tracebacks_Symbolic : Boolean := False;
645 -- Set to True to store tracebacks in exception occurrences and enable
646 -- symbolic tracebacks (-Es).
648 Expand_Nonbinary_Modular_Ops : Boolean := False;
649 -- Set to True to convert nonbinary modular additions into code
650 -- that relies on the front-end expansion of operator Mod.
652 Extensions_Allowed : Boolean := False;
654 -- Set to True by switch -gnatX if GNAT specific language extensions
655 -- are allowed. Currently there are no such defined extensions.
657 type External_Casing_Type is (
658 As_Is, -- External names cased as they appear in the Ada source
659 Uppercase, -- External names forced to all uppercase letters
660 Lowercase); -- External names forced to all lowercase letters
662 External_Name_Imp_Casing : External_Casing_Type := Lowercase;
664 -- The setting of this flag determines the casing of external names
665 -- when the name is implicitly derived from an entity name (i.e. either
666 -- no explicit External_Name or Link_Name argument is used, or, in the
667 -- case of extended DEC pragmas, the external name is given using an
668 -- identifier. The As_Is setting is not permitted here (since this would
669 -- create Ada source programs that were case sensitive).
671 External_Name_Exp_Casing : External_Casing_Type := As_Is;
673 -- The setting of this flag determines the casing of an external name
674 -- specified explicitly with a string literal. As_Is means the string
675 -- literal is used as given with no modification to the casing. If
676 -- Lowercase or Uppercase is set, then the string is forced to all
677 -- lowercase or all uppercase letters as appropriate. Note that this
678 -- setting has no effect if the external name is given using an identifier
679 -- in the case of extended DEC import/export pragmas (in this case the
680 -- casing is controlled by External_Name_Imp_Casing), and also has no
681 -- effect if an explicit Link_Name is supplied (a link name is always
682 -- used exactly as given).
684 External_Unit_Compilation_Allowed : Boolean := False;
686 -- When True (set by gnatmake switch -x), allow compilation of sources
687 -- that are not part of any project file.
689 Fast_Math : Boolean := False;
691 -- Indicates the current setting of Fast_Math mode, as set by the use
692 -- of a Fast_Math pragma (set True by Fast_Math (On)).
694 Force_ALI_Tree_File : Boolean := False;
696 -- Force generation of ALI file even if errors are encountered. Also forces
697 -- generation of tree file if -gnatt is also set. Set on by use of -gnatQ.
699 Disable_ALI_File : Boolean := False;
701 -- Disable generation of ALI file
703 Follow_Links_For_Files : Boolean := False;
705 -- Set to True (-eL) to process the project files in trusted mode. If
706 -- Follow_Links is False, it is assumed that the project doesn't contain
707 -- any file duplicated through symbolic links (although the latter are
708 -- still valid if they point to a file which is outside of the project),
709 -- and that no directory has a name which is a valid source name.
711 Follow_Links_For_Dirs : Boolean := False;
713 -- Set to True if directories can be links in this project, and therefore
714 -- additional system calls must be performed to ensure that we always see
715 -- the same full name for each directory.
717 Force_Checking_Of_Elaboration_Flags : Boolean := False;
719 -- True if binding with forced checking of the elaboration flags
722 Force_Compilations : Boolean := False;
723 -- GNATMAKE, GPRBUILD
724 -- Set to force recompilations even when the objects are up-to-date.
726 Force_Elab_Order_File : String_Ptr := null;
728 -- File name specified for -f switch (the forced elaboration order file)
730 Front_End_Inlining : Boolean := False;
732 -- Set True to activate inlining by front-end expansion (even on GCC
733 -- targets, where inlining is normally handled by the back end). Set by
734 -- the flag -gnatN (which is now considered obsolescent, since the GCC
735 -- back end can do a better job of inlining than the front end these days).
737 Full_Path_Name_For_Brief_Errors : Boolean := False;
739 -- When True, in Brief_Output mode, each error message line will start with
740 -- the full path name of the source. When False, only the file name without
741 -- directory information is used.
743 Full_List : Boolean := False;
745 -- Set True to generate full source listing with embedded errors
747 Full_List_File_Name : String_Ptr := null;
749 -- Set to file name to generate full source listing to named file (or if
750 -- the name is of the form .xxx, then to name.xxx where name is the source
751 -- file name with extension stripped.
753 Generate_C_Code : Boolean := False;
755 -- If True, the Cprint circuitry to generate C code output is activated.
756 -- Set True by use of -gnateg or -gnatd.V for GNAT, and -G for GNATBIND.
758 Generate_CodePeer_Messages : Boolean := False;
760 -- Generate CodePeer messages. Ignored if CodePeer_Mode is false. This is
761 -- turned on by -gnateC.
763 Generate_Processed_File : Boolean := False;
765 -- True when switch -gnateG is used. When True, create in a file
766 -- <source>.prep, if the source is preprocessed.
768 Generate_SCIL : Boolean := False;
770 -- Set True to activate SCIL code generation.
772 Generate_SCO : Boolean := False;
774 -- True when switch -fdump-scos (or -gnateS) is used. When True, Source
775 -- Coverage Obligation (SCO) information is generated and output in the ALI
776 -- file. See unit Par_SCO for full details.
778 Generate_SCO_Instance_Table : Boolean := False;
780 -- True when switch -fdump-scos is used. When True, a table of instances is
783 Generating_Code : Boolean := False;
785 -- True if the frontend finished its work and has called the backend to
786 -- process the tree and generate the object file.
788 type Ghost_Mode_Type is (None, Check, Ignore);
789 -- Possible legal modes that can be set by aspect/pragma Ghost as well as
790 -- value None, which indicates that no such aspect/pragma applies.
792 Ghost_Mode : Ghost_Mode_Type := None;
794 -- The current Ghost mode in effect
796 Global_Discard_Names : Boolean := False;
798 -- True if a pragma Discard_Names appeared as a configuration pragma for
799 -- the current compilation unit.
801 GNAT_Encodings : Int;
802 pragma Import (C, GNAT_Encodings, "gnat_encodings");
803 -- Constant controlling the balance between GNAT encodings and standard
804 -- DWARF to emit in the debug information. It accepts the following values.
806 DWARF_GNAT_Encodings_All : constant Int := 0;
807 DWARF_GNAT_Encodings_GDB : constant Int := 1;
808 DWARF_GNAT_Encodings_Minimal : constant Int := 2;
810 Identifier_Character_Set : Character;
812 -- This variable indicates the character set to be used for identifiers.
813 -- The possible settings are:
814 -- '1' Latin-1 (ISO-8859-1)
815 -- '2' Latin-2 (ISO-8859-2)
816 -- '3' Latin-3 (ISO-8859-3)
817 -- '4' Latin-4 (ISO-8859-4)
818 -- '5' Latin-Cyrillic (ISO-8859-5)
819 -- '9' Latin-9 (ISO-8859-15)
820 -- 'p' PC (US, IBM page 437)
821 -- '8' PC (European, IBM page 850)
822 -- 'f' Full upper set (all distinct)
823 -- 'n' No upper characters (Ada 83 rules)
824 -- 'w' Latin-1 plus wide characters allowed in identifiers
826 -- The setting affects the set of letters allowed in identifiers and the
827 -- upper/lower case equivalences. It does not affect the interpretation of
828 -- character and string literals, which are always stored using the actual
829 -- coding in the source program. This variable is initialized to the
830 -- default value appropriate to the system (in Osint.Initialize), and then
831 -- reset if a command line switch is used to change the setting.
833 Ignore_Rep_Clauses : Boolean := False;
835 -- Set True to ignore all representation clauses. Useful when compiling
836 -- code from foreign compilers for checking or ASIS purposes. Can be
837 -- set True by use of -gnatI.
839 Ignore_SPARK_Mode_Pragmas_In_Instance : Boolean := False;
841 -- Set True to ignore the semantics and effects of pragma SPARK_Mode when
842 -- the pragma appears inside an instance whose enclosing context is subject
843 -- to SPARK_Mode "off". This property applies to nested instances.
845 Ignore_Style_Checks_Pragmas : Boolean := False;
847 -- Set True to ignore all Style_Checks pragmas. Can be set True by use
850 Ignore_Unrecognized_VWY_Switches : Boolean := False;
852 -- Set True to ignore unrecognized y, V, w switches. Can be set True by
853 -- use of -gnateu, causing subsequent unrecognized switches to result in
854 -- a warning rather than an error.
856 Ignored_Ghost_Region : Node_Id := Empty;
858 -- The start of the current ignored Ghost region. This value must always
859 -- reflect the starting node of the outermost ignored Ghost region. If a
860 -- nested ignored Ghost region is entered, the value must remain unchanged.
862 Implementation_Unit_Warnings : Boolean := True;
864 -- Set True to active warnings for use of implementation internal units.
865 -- Modified by use of -gnatwi/-gnatwI.
867 Implicit_Packing : Boolean := False;
869 -- If set True, then a Size attribute clause on an array is allowed to
870 -- cause implicit packing instead of generating an error message. Set by
871 -- use of pragma Implicit_Packing.
873 Include_Subprogram_In_Messages : Boolean := False;
875 -- Set True to include the enclosing subprogram in compiler messages.
877 Ineffective_Inline_Warnings : Boolean := False;
879 -- Set True to activate warnings if front-end inlining (-gnatN) is not able
880 -- to actually inline a particular call (or all calls). Can be controlled
881 -- by use of -gnatwp/-gnatwP. Also set True to activate warnings if
882 -- frontend inlining is not able to inline a subprogram expected to
883 -- be inlined in GNATprove mode.
885 Init_Or_Norm_Scalars : Boolean := False;
887 -- Set True if a pragma Initialize_Scalars applies to the current unit.
888 -- Also set True if a pragma Restriction (Normalize_Scalars) applies.
890 Initialize_Scalars : Boolean := False;
892 -- Set True if a pragma Initialize_Scalars applies to the current unit.
893 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
895 Initialize_Scalars_Mode1 : Character := 'I';
896 Initialize_Scalars_Mode2 : Character := 'N';
898 -- Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
899 -- is IN (invalid values), used if no -S switch is used.
901 Inline_Active : Boolean := False;
903 -- Set True to activate pragma Inline processing across modules. Default
904 -- for now is not to inline across module boundaries.
906 Inline_Level : Nat := 0;
908 -- Set to indicate the inlining level: 0 means that an appropriate value is
909 -- to be computed by the compiler based on the optimization level (-gnatn),
910 -- 1 is for moderate inlining across modules (-gnatn1) and 2 for full
911 -- inlining across modules (-gnatn2).
913 Interface_Library_Unit : Boolean := False;
915 -- Set to True to indicate that at least one ALI file is an interface ALI:
916 -- then elaboration flag checks are to be generated in the binder
919 Invalid_Value_Used : Boolean := False;
921 -- Set True if a valid Invalid_Value attribute is encountered
923 Inline_Processing_Required : Boolean := False;
925 -- Set True if inline processing is required. Inline processing is required
926 -- if an active Inline pragma is processed. The flag is set for a pragma
927 -- Inline or Inline_Always that is actually active.
929 In_Place_Mode : Boolean := False;
931 -- Set True to store ALI and object files in place i.e. in the object
932 -- directory if these files already exist or in the source directory
935 Keep_Going : Boolean := False;
936 -- GNATMAKE, GPRBUILD
937 -- When True signals to ignore compilation errors and keep processing
938 -- sources until there is no more work.
940 Keep_Temporary_Files : Boolean := False;
941 -- GNATCMD, GNATMAKE, GPRBUILD
942 -- When True the temporary files are not deleted. Set by switches -dn or
943 -- --keep-temp-files.
945 Leap_Seconds_Support : Boolean := False;
947 -- Set to True to enable leap seconds support in Ada.Calendar and its
950 Legacy_Elaboration_Checks : Boolean := False;
952 -- Set to True when the pre-18.x access-before-elaboration model is to be
953 -- used. Modified by use of -gnatH.
955 Legacy_Elaboration_Order : Boolean := False;
957 -- Set to True when the pre-20.x elaboration-order model is to be used.
958 -- Modified by use of -H.
960 Link_Only : Boolean := False;
961 -- GNATMAKE, GPRBUILD
962 -- Set to True to skip compile and bind steps (except when Bind_Only is
965 List_Body_Required_Info : Boolean := False;
967 -- List info messages about why a package requires a body. Modified by use
970 List_Inherited_Aspects : Boolean := False;
972 -- List inherited invariants, preconditions, and postconditions from
973 -- Invariant'Class, Pre'Class, and Post'Class aspects. Also list inherited
974 -- subtype predicates. Modified by use of -gnatw.l/.L.
976 List_Restrictions : Boolean := False;
978 -- Set to True to list restrictions pragmas that could apply to partition
980 List_Units : Boolean := False;
982 -- List units in the active library for a compilation (-gnatu switch)
984 List_Closure : Boolean := False;
986 -- List all sources in the closure of a main (-R or -Ra gnatbind switch)
988 List_Closure_All : Boolean := False;
990 -- List all sources in closure of main including run-time units (-Ra
993 List_Dependencies : Boolean := False;
995 -- When True gnatmake verifies that the objects are up to date and outputs
996 -- the list of object dependencies (-M switch). Output depends if -a switch
997 -- is used or not. This list can be used directly in a Makefile.
999 List_Representation_Info : Int range 0 .. 4 := 0;
1001 -- Set non-zero by -gnatR switch to list representation information.
1002 -- The settings are as follows:
1004 -- 0 = no listing of representation information (default as above)
1005 -- 1 = list rep info for user-defined record and array types
1006 -- 2 = list rep info for all user-defined types and objects
1007 -- 3 = like 2, but variable fields are decoded symbolically
1008 -- 4 = like 3, but list rep info for relevant compiler-generated types
1010 List_Representation_Info_To_File : Boolean := False;
1012 -- Set true by -gnatRs switch. Causes information from -gnatR[1-4]m to be
1013 -- written to file.rep (where file is the name of the source file) instead
1014 -- of stdout. For example, if file x.adb is compiled using -gnatR2s then
1015 -- representation info is written to x.adb.ref.
1017 List_Representation_Info_To_JSON : Boolean := False;
1019 -- Set true by -gnatRj switch. Causes information from -gnatR[1-4]m to be
1020 -- output in the JSON data interchange format.
1022 List_Representation_Info_Mechanisms : Boolean := False;
1024 -- Set true by -gnatRm switch. Causes information on mechanisms to be
1025 -- included in the representation output information.
1027 List_Representation_Info_Extended : Boolean := False;
1029 -- Set true by -gnatRe switch. Causes extended information for record types
1030 -- to be included in the representation output information.
1032 List_Preprocessing_Symbols : Boolean := False;
1034 -- Set to True if symbols for preprocessing a source are to be listed
1035 -- before preprocessing occurs. Set to True by switch -s of gnatprep or
1036 -- -s in preprocessing data file for the compiler.
1038 type Create_Repinfo_File_Proc is access procedure (Src : String);
1039 type Write_Repinfo_Line_Proc is access procedure (Info : String);
1040 type Close_Repinfo_File_Proc is access procedure;
1041 -- Types used for procedure addresses below
1043 Create_Repinfo_File_Access : Create_Repinfo_File_Proc := null;
1044 Write_Repinfo_Line_Access : Write_Repinfo_Line_Proc := null;
1045 Close_Repinfo_File_Access : Close_Repinfo_File_Proc := null;
1047 -- These three locations are left null when operating in non-compiler (e.g.
1048 -- ASIS mode), but when operating in compiler mode, they are set to point
1049 -- to the three corresponding procedures in Osint-C. The reason for this
1050 -- slightly strange interface is to stop Repinfo from dragging in Osint in
1051 -- ASIS mode, which would include lots of unwanted units in the ASIS build.
1053 type Create_List_File_Proc is access procedure (S : String);
1054 type Write_List_Info_Proc is access procedure (S : String);
1055 type Close_List_File_Proc is access procedure;
1056 -- Types used for procedure addresses below
1058 Create_List_File_Access : Create_List_File_Proc := null;
1059 Write_List_Info_Access : Write_List_Info_Proc := null;
1060 Close_List_File_Access : Close_List_File_Proc := null;
1062 -- These three locations are left null when operating in non-compiler
1063 -- (e.g. from the binder), but when operating in compiler mode, they are
1064 -- set to point to the three corresponding procedures in Osint-C. The
1065 -- reason for this slightly strange interface is to prevent Repinfo
1066 -- from dragging in Osint-C in the binder, which would include unwanted
1067 -- units in the binder.
1069 Locking_Policy : Character := ' ';
1072 -- Set to ' ' for the default case (no locking policy specified). Otherwise
1073 -- set based on the pragma Locking_Policy:
1074 -- Ceiling_Locking: 'C'
1075 -- Concurrent_Readers_Locking: 'R'
1076 -- Inheritance_Locking: 'I'
1078 Locking_Policy_Sloc : Source_Ptr := No_Location;
1080 -- Remember location of previous Locking_Policy pragma. This is used for
1081 -- inconsistency error messages. A value of System_Location is used if the
1082 -- policy is set in package System.
1084 Look_In_Primary_Dir : Boolean := True;
1085 -- GNAT, GNATBIND, GNATMAKE, GNATCLEAN
1086 -- Set to False if a -I- was present on the command line. When True we are
1087 -- allowed to look in the primary directory to locate other source or
1090 Make_Steps : Boolean := False;
1092 -- Set to True when either Compile_Only, Bind_Only or Link_Only is
1095 Main_Index : Int := 0;
1097 -- This is set to non-zero by gnatmake switch -eInnn to indicate that
1098 -- the main program is the nnn unit in a multi-unit source file.
1100 Mapping_File_Name : String_Ptr := null;
1102 -- File name of mapping between unit names, file names and path names.
1103 -- (given by switch -gnatem)
1105 Maximum_Messages : Int := 9999;
1107 -- Maximum default number of errors before compilation is terminated, or in
1108 -- the case of GNAT, maximum number of warnings before further warnings are
1109 -- suppressed. Can be overridden by -gnatm (GNAT) or -m (GNATBIND) switch.
1111 Maximum_File_Name_Length : Int;
1113 -- Maximum number of characters allowed in a file name, not counting the
1114 -- extension, as set by the appropriate switch. If no switch is given,
1115 -- then this value is initialized by Osint to the appropriate value.
1117 Maximum_Instantiations : Int := 8000;
1119 -- Maximum number of instantiations permitted (to stop runaway cases
1120 -- of nested instantiations). These situations probably only occur in
1121 -- specially concocted test cases. Can be modified by -gnateinn switch.
1123 Maximum_Processes : Positive := 1;
1124 -- GNATMAKE, GPRBUILD
1125 -- Maximum number of processes that should be spawned to carry out
1128 Minimal_Binder : Boolean := False;
1130 -- Set to True to suppress the generation of objects by the binder that
1131 -- are not strictly required for a program to run. Intended for ZFP
1132 -- applications that have tight memory constraints.
1134 Minimal_Recompilation : Boolean := False;
1136 -- Set to True if minimal recompilation mode requested
1138 Minimize_Expression_With_Actions : Boolean := False;
1140 -- If True, minimize the use of N_Expression_With_Actions node.
1141 -- This can be used in particular on some back-ends where this node is
1142 -- difficult to support.
1144 Modify_Tree_For_C : Boolean := False;
1146 -- If this switch is set True (currently it is set only by -gnatd.V), then
1147 -- certain meaning-preserving transformations are applied to the tree to
1148 -- make it easier to interface with back ends that implement C semantics.
1149 -- There is a section in Sinfo which describes the transformations made.
1151 Multiple_Unit_Index : Int := 0;
1153 -- This is set non-zero if the current unit is being compiled in multiple
1154 -- unit per file mode, meaning that the current unit is selected from the
1155 -- sequence of units in the current source file, using the value stored
1156 -- in this variable (e.g. 2 = select second unit in file). A value of
1157 -- zero indicates that we are in normal (one unit per file) mode.
1159 No_Backup : Boolean := False;
1161 -- Do not create backup copies of project files. Set by switch --no-backup.
1163 No_Component_Reordering : Boolean := False;
1165 -- Set True if pragma No_Component_Reordering with no parameter encountered
1167 No_Deletion : Boolean := False;
1169 -- Set by preprocessor switch -a. Do not eliminate any source text. Implies
1170 -- Undefined_Symbols_Are_False. Useful to perform a syntax check on all
1171 -- branches of #if constructs.
1173 No_Elab_Code_All_Pragma : Node_Id := Empty;
1174 -- Set to point to a No_Elaboration_Code_All pragma or aspect encountered
1175 -- in the spec of the extended main unit. Used to determine if we need to
1176 -- do special tests for violation of this aspect.
1178 No_Heap_Finalization_Pragma : Node_Id := Empty;
1180 -- Set to point to a No_Heap_Finalization pragma defined in a configuration
1183 No_Main_Subprogram : Boolean := False;
1184 -- GNATMAKE, GNATBIND
1185 -- Set to True if compilation/binding of a program without main
1186 -- subprogram requested.
1188 No_Run_Time_Mode : Boolean := False;
1190 -- This flag is set True if a No_Run_Time pragma is encountered. See spec
1191 -- of Rtsfind for a full description of handling of this pragma.
1193 No_Split_Units : Boolean := False;
1195 -- Set to True with switch --no-split-units. When True, unit sources, spec,
1196 -- body and subunits, must all be in the same project. This is checked
1197 -- after each compilation.
1199 No_Stdinc : Boolean := False;
1200 -- GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
1201 -- Set to True if no default source search dirs added to search list.
1203 No_Stdlib : Boolean := False;
1204 -- GNATMAKE, GNATBIND, GNATFIND, GNATXREF
1205 -- Set to True if no default library search dirs added to search list.
1207 No_Strict_Aliasing : Boolean := False;
1209 -- Set True if pragma No_Strict_Aliasing with no parameters encountered.
1211 No_Tagged_Streams : Node_Id := Empty;
1213 -- If a pragma No_Tagged_Streams is active for the current scope, this
1214 -- points to the corresponding pragma.
1216 Normalize_Scalars : Boolean := False;
1218 -- Set True if a pragma Normalize_Scalars applies to the current unit.
1219 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
1221 Object_Directory_Present : Boolean := False;
1223 -- Set to True when an object directory is specified with option -D
1225 Object_Path_File_Name : String_Ptr := null;
1227 -- Path of the temporary file that contains a list of object directories
1228 -- passed by -gnateO=<obj_path_file>.
1230 One_Compilation_Per_Obj_Dir : Boolean := False;
1231 -- GNATMAKE, GPRBUILD
1232 -- Set to True with switch --single-compile-per-obj-dir. When True, there
1233 -- cannot be simultaneous compilations with the object files in the same
1234 -- object directory, if project files are used.
1236 OpenAcc_Enabled : Boolean := False;
1238 -- Indicates whether OpenAcc pragmas should be taken into account. Set to
1239 -- True by the use of -fopenacc.
1241 type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
1242 pragma Ordered (Operating_Mode_Type);
1243 Operating_Mode : Operating_Mode_Type := Generate_Code;
1245 -- Indicates the operating mode of the compiler. The default is generate
1246 -- code, which runs the parser, semantics and backend. Switches can be
1247 -- used to set syntax checking only mode, or syntax and semantics checking
1248 -- only mode. Operating_Mode can also be modified as a result of detecting
1249 -- errors during the compilation process. In particular if any serious
1250 -- error is detected then this flag is reset from Generate_Code to
1251 -- Check_Semantics after generating an error message. This is an ordered
1252 -- type with the semantics that each value does more than the previous one.
1254 Optimize_Alignment : Character := 'O';
1256 -- Setting of Optimize_Alignment, set to T/S/O for time/space/off. Can
1257 -- be modified by use of pragma Optimize_Alignment.
1259 Optimize_Alignment_Local : Boolean := False;
1261 -- Set True if Optimize_Alignment mode is set by a local configuration
1262 -- pragma that overrides the gnat.adc (or other configuration file) default
1263 -- so that the unit is not dependent on the default setting. Also always
1264 -- set True for internal units, since these always have a default setting
1265 -- of Optimize_Alignment (Off) that is enforced (essentially equivalent to
1266 -- them all having such an explicit pragma in each unit).
1268 Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
1270 -- Indicates the original operating mode of the compiler as set by compiler
1271 -- options. This is identical to Operating_Mode except that this is not
1272 -- affected by errors.
1274 Optimization_Level : Int;
1275 pragma Import (C, Optimization_Level, "optimize");
1277 -- Constant reflecting the optimization level (0,1,2,3 for -O0,-O1,-O2,-O3)
1279 Optimize_Size : Int;
1280 pragma Import (C, Optimize_Size, "optimize_size");
1282 -- Constant reflecting setting of -Os (optimize for size). Set to nonzero
1283 -- in -Os mode and set to zero otherwise.
1285 Output_File_Name_Present : Boolean := False;
1286 -- GNATBIND, GNAT, GNATMAKE
1287 -- Set to True when the output C file name is given with option -o for
1288 -- GNATBIND, when the object file name is given with option -gnatO for GNAT
1289 -- or when the executable is given with option -o for GNATMAKE.
1291 Output_Linker_Option_List : Boolean := False;
1293 -- True if output of list of linker options is requested (-K switch set)
1295 Output_ALI_List : Boolean := False;
1296 ALI_List_Filename : String_Ptr;
1298 -- True if output of list of ALIs is requested (-A switch set). List is
1299 -- output under the given filename, or standard output if not specified.
1301 Output_Object_List : Boolean := False;
1302 Object_List_Filename : String_Ptr;
1304 -- True if output of list of objects is requested (-O switch set). List is
1305 -- output under the given filename, or standard output if not specified.
1307 Partition_Elaboration_Policy : Character := ' ';
1309 -- Set to ' ' for the default case (no elaboration policy specified). Reset
1310 -- to first character (uppercase) of locking policy name if a valid pragma
1311 -- Partition_Elaboration_Policy is encountered.
1313 Partition_Elaboration_Policy_Sloc : Source_Ptr := No_Location;
1315 -- Remember location of previous Partition_Elaboration_Policy pragma. This
1316 -- is used for inconsistency error messages. A value of System_Location is
1317 -- used if the policy is set in package System.
1319 Persistent_BSS_Mode : Boolean := False;
1321 -- True if a Persistent_BSS configuration pragma is in effect, causing
1322 -- potentially persistent data to be placed in the persistent_bss section.
1324 Pessimistic_Elab_Order : Boolean := False;
1326 -- True if pessimistic elaboration order is to be chosen (-p switch set)
1328 Polling_Required : Boolean := False;
1330 -- Set to True if polling for asynchronous abort is enabled by using
1331 -- the -gnatP option for GNAT.
1333 Prefix_Exception_Messages : Boolean := False;
1335 -- Set True to prefix exception messages with entity-name:
1337 Preprocessing_Data_File : String_Ptr := null;
1339 -- Set by switch -gnatep=. The file name of the preprocessing data file.
1341 Preprocessing_Symbol_Defs : String_List_Access := new String_List (1 .. 4);
1342 -- An extensible array to temporarily stores symbol definitions specified
1343 -- on the command line with -gnateD switches. The value 4 is an arbitrary
1344 -- starting point, if more space is needed it is allocated as required.
1346 Preprocessing_Symbol_Last : Natural := 0;
1347 -- Index of last symbol definition in array Symbol_Definitions
1349 Print_Generated_Code : Boolean := False;
1351 -- Set to True to enable output of generated code in source form. This
1352 -- flag is set by the -gnatG switch.
1354 Print_Standard : Boolean := False;
1356 -- Set to true to enable printing of package standard in source form.
1357 -- This flag is set by the -gnatS switch
1359 type Usage is (Unknown, Not_In_Use, In_Use);
1360 Project_File_In_Use : Usage := Unknown;
1362 -- Indicates if a project file is used or not. Set to In_Use by the first
1365 Quantity_Of_Default_Size_Sec_Stacks : Int := -1;
1367 -- The number of default sized secondary stacks that the binder should
1368 -- generate. Allows ZFP users to have the binder generate extra stacks if
1369 -- needed to support multithreaded applications. A value of -1 indicates
1370 -- that no size was set by the binder.
1372 Queuing_Policy : Character := ' ';
1374 -- Set to ' ' for the default case (no queuing policy specified). Reset to
1375 -- first character (uppercase) of locking policy name if a valid
1376 -- Queuing_Policy pragma is encountered.
1378 Queuing_Policy_Sloc : Source_Ptr := No_Location;
1380 -- Remember location of previous Queuing_Policy pragma. This is used for
1381 -- inconsistency error messages. A value of System_Location is used if the
1382 -- policy is set in package System.
1384 Quiet_Output : Boolean := False;
1385 -- GNATMAKE, GNATCLEAN, GPRBUILD, GPRCLEAN
1386 -- Set to True if the tool should not have any output if there are no
1387 -- errors or warnings.
1389 Overriding_Renamings : Boolean := False;
1391 -- Set to True to enable compatibility mode with Rational compiler, and
1392 -- to accept renamings of implicit operations in their own scope.
1394 Relaxed_Elaboration_Checks : Boolean := False;
1396 -- Set to True to ignore certain elaboration scenarios, thus making the
1397 -- current ABE mechanism more permissive. This behavior is applicable to
1398 -- both the default and the legacy ABE models. Modified by use of -gnatJ.
1400 Relaxed_RM_Semantics : Boolean := False;
1402 -- Set to True to ignore some Ada semantic error to help parse legacy Ada
1403 -- code for use in e.g. static analysis (such as CodePeer). This deals
1404 -- with cases where other compilers allow illegal constructs. Tools such as
1405 -- CodePeer are interested in analyzing code rather than enforcing legality
1406 -- rules, so as long as these illegal constructs end up with code that can
1407 -- be handled by the tool in question, there is no reason to reject the
1408 -- code that is considered correct by the other compiler.
1410 Replace_In_Comments : Boolean := False;
1412 -- Set to True if -C switch used.
1414 RTS_Lib_Path_Name : String_Ptr := null;
1415 RTS_Src_Path_Name : String_Ptr := null;
1417 -- Set to the "adalib" and "adainclude" directories of the run time
1418 -- specified by --RTS=.
1420 RTS_Switch : Boolean := False;
1421 -- GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
1422 -- Set to True when the --RTS switch is set
1424 Run_Path_Option : Boolean := True;
1425 -- GNATMAKE, GNATLINK
1426 -- Set to False when no run_path_option should be issued to the linker
1428 Search_Directory_Present : Boolean := False;
1430 -- Set to True when argument is -I. Reset to False when next argument, a
1431 -- search directory path is taken into account. Note that this is quite
1432 -- different from other switches in this section in that it is only set in
1433 -- a transitory manner as a result of scanning a -I switch with no file
1434 -- name, and if set, is an indication that the next argument is to be
1435 -- treated as a file name.
1437 Sec_Stack_Used : Boolean := False;
1439 -- Set True if generated code uses the System.Secondary_Stack package. For
1440 -- the binder, set if any unit uses the secondary stack package.
1442 Setup_Projects : Boolean := False;
1444 -- Set to True for GNAT SETUP: the Project Manager creates nonexistent
1445 -- object, library, and exec directories.
1447 Shared_Libgnat : Boolean;
1449 -- Set to True if a shared libgnat is requested by using the -shared option
1450 -- for GNATBIND and to False when using the -static option. The value of
1451 -- this flag is set by Gnatbind.Scan_Bind_Arg.
1453 Short_Circuit_And_Or : Boolean := False;
1455 -- Set True if a pragma Short_Circuit_And_Or applies to the current unit.
1457 type SPARK_Mode_Type is (None, Off, On);
1458 -- Possible legal modes that can be set by aspect/pragma SPARK_Mode, as
1459 -- well as the value None, which indicates no such pragma/aspect applies.
1461 SPARK_Mode : SPARK_Mode_Type := None;
1463 -- Current SPARK mode setting.
1465 SPARK_Mode_Pragma : Node_Id := Empty;
1467 -- If the current SPARK_Mode (above) was set by a pragma, this records
1468 -- the pragma that set this mode.
1470 SPARK_Switches_File_Name : String_Ptr := null;
1472 -- Set to non-null file name by use of the -gnates switch to specify
1473 -- SPARK (gnat2why) specific switches in the given file name.
1475 Special_Exception_Package_Used : Boolean := False;
1477 -- Set to True if either of the unit GNAT.Most_Recent_Exception or
1478 -- GNAT.Exception_Traces is with'ed. Used to inhibit transformation of
1479 -- local raise statements into gotos in the presence of either package.
1481 Sprint_Line_Limit : Nat := 72;
1483 -- Limit values for chopping long lines in Cprint/Sprint output, can be
1484 -- reset by use of NNN parameter with -gnatG or -gnatD switches.
1486 Stack_Checking_Enabled : Boolean := False;
1488 -- Set to indicate if stack checking is enabled for the compilation. This
1489 -- is set directly from the value in the gcc back end in the body of the
1490 -- gcc version of back_end.adb.
1492 Style_Check : Boolean := False;
1494 -- Set True to perform style checks. Activates checks carried out in
1495 -- package Style (see body of this package for details of checks). This
1496 -- flag is set True by use of either the -gnatg or -gnaty switches, or
1497 -- by the Style_Check pragma.
1499 Style_Check_Main : Boolean := False;
1501 -- Set True if Style_Check was set for the main unit. This is used to
1502 -- enable style checks for units in the main extended source that get
1503 -- with'ed indirectly. It is set True by use of either the -gnatg or
1504 -- -gnaty switches, but not by use of the Style_Checks pragma.
1506 Disable_FE_Inline : Boolean := False;
1507 Disable_FE_Inline_Always : Boolean := False;
1509 -- Request to disable front end inlining from pragma Inline or pragma
1510 -- Inline_Always out of the presence of the -fno-inline back end flag
1511 -- on the command line, regardless of any other switches that are set.
1512 -- It remains the back end's reponsibility to honor -fno-inline at the
1515 Suppress_Control_Flow_Optimizations : Boolean := False;
1517 -- Set by -fpreserve-control-flow. Suppresses control flow optimizations
1518 -- that interfere with coverage analysis based on the object code.
1520 System_Extend_Pragma_Arg : Node_Id := Empty;
1522 -- Set non-empty if and only if a correct Extend_System pragma was present
1523 -- in which case it points to the argument of the pragma, and the name can
1524 -- be located as Chars (Expression (System_Extend_Pragma_Arg)).
1526 System_Extend_Unit : Node_Id := Empty;
1528 -- This is set to Empty if GNAT_Mode is set, since pragma Extend_System
1529 -- is never appropriate in GNAT_Mode (and causes troubles, including
1530 -- bogus circularities, if we try to compile the run-time library with
1531 -- a System extension). If GNAT_Mode is not set, then System_Extend_Unit
1532 -- is a copy of the value set in System_Extend_Pragma_Arg.
1534 Subunits_Missing : Boolean := False;
1536 -- This flag is set true if missing subunits are detected with code
1537 -- generation active. This causes code generation to be skipped.
1539 Suppress_Checks : Boolean := False;
1541 -- Set to True if -gnatp (suppress all checks) switch present.
1543 Suppress_Options : Suppress_Record;
1545 -- Indicates outer level setting of check suppression. This initializes
1546 -- the settings of the outer scope level in any unit compiled. This is
1547 -- initialized by Osint.Initialize, and further initialized by the
1548 -- Adjust_Global_Switches flag in Gnat1drv.
1550 Table_Factor : Int := 1;
1552 -- Factor by which all initial table sizes set in Alloc are multiplied.
1553 -- Used in Table to calculate initial table sizes (the initial table size
1554 -- is the value in Alloc, used as the Table_Initial parameter value,
1555 -- multiplied by the factor given here. The default value is used if no
1556 -- -gnatT switch appears.
1558 Tagged_Type_Expansion : Boolean := True;
1560 -- Set True if tagged types and interfaces should be expanded by the
1561 -- front-end. If False, the original tree is left unexpanded for tagged
1562 -- types and dispatching calls, assuming the underlying target supports it.
1564 Target_Dependent_Info_Read_Name : String_Ptr := null;
1566 -- Set non-null to override the normal processing in Get_Targ and set the
1567 -- necessary information by reading the target dependent information file
1568 -- whose name is given here (see packages Get_Targ and Set_Targ for full
1569 -- details). Set to non-null file name by use of the -gnateT switch.
1571 Target_Dependent_Info_Write_Name : String_Ptr := null;
1573 -- Set non-null to enable a call to Set_Targ.Write_Target_Dependent_Info
1574 -- which writes a target independent information file (see packages
1575 -- Get_Targ and Set_Targ for full details) using the name given by
1576 -- this switch. Set to non-null file name by use of the -gnatet switch.
1578 type Origin_Of_Target is (Unknown, Default, Specified);
1580 Target_Origin : Origin_Of_Target := Unknown;
1582 -- Indicates the origin of attribute Target in project files
1584 Target_Value : String_Access := null;
1586 -- Indicates the value of attribute Target in project files
1588 Task_Dispatching_Policy : Character := ' ';
1590 -- Set to ' ' for the default case (no task dispatching policy specified).
1591 -- Reset to first character (uppercase) of task dispatching policy name
1592 -- if a valid Task_Dispatching_Policy pragma is encountered.
1594 Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
1596 -- Remember location of previous Task_Dispatching_Policy pragma. This is
1597 -- used for inconsistency error messages. A value of System_Location is
1598 -- used if the policy is set in package System.
1600 Tasking_Used : Boolean := False;
1601 -- Set True if any tasking construct is encountered. Used to activate the
1602 -- output of the Q, L and T lines in ALI files.
1604 Time_Slice_Set : Boolean := False;
1606 -- Set True if a pragma Time_Slice is processed in the main unit, or
1607 -- if the -gnatTnn switch is present to set a time slice value.
1609 Time_Slice_Value : Nat;
1611 -- Time slice value. Valid only if Time_Slice_Set is True, i.e. if
1612 -- Time_Slice pragma has been processed. Set to the time slice value in
1613 -- microseconds. Negative values are stored as zero, and the value is not
1614 -- larger than 1_000_000_000 (1000 seconds). Values larger than this are
1615 -- reset to this maximum. This can also be set with the -gnatTnn switch.
1617 Tolerate_Consistency_Errors : Boolean := False;
1619 -- Tolerate time stamp and other consistency errors. If this flag is set to
1620 -- True (-t), then inconsistencies result in warnings rather than errors.
1622 Treat_Categorization_Errors_As_Warnings : Boolean := False;
1623 -- Normally categorization errors are true illegalities. If this switch
1624 -- is set, then such errors result in warning messages rather than error
1625 -- messages. Set True by -gnateP (P for Pure/Preelaborate). Also set in
1626 -- Relaxed_RM_Semantics mode since some old Ada 83 compilers treated
1627 -- pragma Preelaborate differently.
1629 Treat_Restrictions_As_Warnings : Boolean := False;
1631 -- Set True to treat pragma Restrictions as Restriction_Warnings. Set by
1634 Tree_Output : Boolean := False;
1636 -- Set to True (-gnatt) to generate output tree file
1638 Try_Semantics : Boolean := False;
1640 -- Flag set to force attempt at semantic analysis, even if parser errors
1641 -- occur. This will probably cause blowups at this stage in the game. On
1642 -- the other hand, most such blowups will be caught cleanly and simply
1643 -- say compilation abandoned. This flag is set True by -gnatq or -gnatQ.
1645 Unchecked_Shared_Lib_Imports : Boolean := False;
1647 -- Set to True when shared library projects are allowed to import projects
1648 -- that are not shared library projects. Set on by use of the switch
1649 -- --unchecked-shared-lib-imports.
1651 Undefined_Symbols_Are_False : Boolean := False;
1653 -- Set to True by switch -u of gnatprep or -u in the preprocessing data
1654 -- file for the compiler. Indicates that while preprocessing sources,
1655 -- symbols that are not defined have the value FALSE.
1657 Uneval_Old : Character := 'E';
1659 -- Set to 'E'/'W'/'A' for use of Error/Warn/Allow in a valid pragma
1660 -- Unevaluated_Use_Of_Old. Default in the absence of the pragma is 'E'
1661 -- for the RM default behavior of giving an error.
1663 Unique_Error_Tag : Boolean := Tag_Errors;
1665 -- Indicates if error messages are to be prefixed by the string error:
1666 -- Initialized from Tag_Errors, can be forced on with the -gnatU switch.
1668 Unnest_Subprogram_Mode : Boolean := False;
1669 -- If true, activates the circuitry for unnesting subprograms (see the spec
1670 -- of Exp_Unst for full details). Currently set only by use of -gnatd.1.
1672 Unreserve_All_Interrupts : Boolean := False;
1674 -- Normally set False, set True if a valid Unreserve_All_Interrupts pragma
1675 -- appears anywhere in the main unit for GNAT, or if any ALI file has the
1676 -- corresponding attribute set in GNATBIND.
1678 Upper_Half_Encoding : Boolean := False;
1680 -- Normally set False, indicating that upper half ISO 8859-1 characters are
1681 -- used in the normal way to represent themselves. If the wide character
1682 -- encoding method uses the upper bit for this encoding, then this flag is
1683 -- set True, and upper half characters in the source indicate the start of
1684 -- a wide character sequence. Set by -gnatW or -W switches.
1686 Use_Include_Path_File : Boolean := False;
1687 -- GNATMAKE, GPRBUILD
1688 -- When True, create a source search path file, even when a mapping file
1691 Usage_Requested : Boolean := False;
1692 -- GNAT, GNATBIND, GNATMAKE
1693 -- Set to True if -h (-gnath for the compiler) switch encountered
1694 -- requesting usage information
1696 Use_Pragma_Linker_Constructor : Boolean := False;
1698 -- True if pragma Linker_Constructor applies to adainit
1700 Use_VADS_Size : Boolean := False;
1702 -- Set to True if a valid pragma Use_VADS_Size is processed
1704 Validity_Checks_On : Boolean := True;
1706 -- This flag determines if validity checking is on or off. The initial
1707 -- state is on, and the required default validity checks are active. The
1708 -- actual set of checks that is performed if Validity_Checks_On is set is
1709 -- defined by the switches in package Validsw. The Validity_Checks_On flag
1710 -- is controlled by pragma Validity_Checks (On | Off), and also some
1711 -- generated compiler code (typically code that has to do with validity
1712 -- check generation) is compiled with this flag set to False. This flag is
1713 -- set to False by the -gnatp switch.
1715 Verbose_Mode : Boolean := False;
1716 -- GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATNAME, GNATCLEAN,
1717 -- GPRBUILD, GPRCLEAN
1718 -- Set to True to get verbose mode (full error message text and location
1719 -- information sent to standard output, also header, copyright and summary)
1721 type Verbosity_Level_Type is (None, Low, Medium, High);
1722 pragma Ordered (Verbosity_Level_Type);
1723 Verbosity_Level : Verbosity_Level_Type := High;
1725 -- Modified by gnatmake switches -v, -vl, -vm, -vh. Indicates
1726 -- the level of verbosity of informational messages:
1728 -- In Low Verbosity, the reasons why a source is recompiled, the name
1729 -- of the executable and the reason it must be rebuilt is output.
1731 -- In Medium Verbosity, additional lines are output for each ALI file
1734 -- In High Verbosity, additional lines are output when the ALI file
1735 -- is part of an Ada library, is read-only or is part of the runtime.
1737 Warn_On_Ada_2005_Compatibility : Boolean := True;
1739 -- Set to True to generate all warnings on Ada 2005 compatibility issues,
1740 -- including warnings on Ada 2005 obsolescent features used in Ada 2005
1741 -- mode. Set by default, modified by use of -gnatwy/Y.
1743 Warn_On_Ada_2012_Compatibility : Boolean := True;
1745 -- Set to True to generate all warnings on Ada 2012 compatibility issues,
1746 -- including warnings on Ada 2012 obsolescent features used in Ada 2012
1747 -- mode. Modified by use of -gnatwy/Y.
1749 Warn_On_All_Unread_Out_Parameters : Boolean := False;
1751 -- Set to True to generate warnings in all cases where a variable is
1752 -- modified by being passed as to an OUT formal, but the resulting value is
1753 -- never read. The default is that this warning is suppressed. Modified
1754 -- by use of gnatw.o/.O.
1756 Warn_On_Assertion_Failure : Boolean := True;
1758 -- Set to True to activate warnings on assertions that can be determined
1759 -- at compile time will always fail. Modified by use of -gnatw.a/.A.
1761 Warn_On_Assumed_Low_Bound : Boolean := True;
1763 -- Set to True to activate warnings for string parameters that are indexed
1764 -- with literals or S'Length, presumably assuming a lower bound of one.
1765 -- Modified by use of -gnatww/W.
1767 Warn_On_Atomic_Synchronization : Boolean := False;
1769 -- Set to True to generate information messages for atomic synchronization.
1770 -- Modified by use of -gnatw.n/.N.
1772 Warn_On_Bad_Fixed_Value : Boolean := False;
1774 -- Set to True to generate warnings for static fixed-point expression
1775 -- values that are not an exact multiple of the small value of the type.
1776 -- Odd by default, modified by use of -gnatwb/B.
1778 Warn_On_Biased_Representation : Boolean := True;
1780 -- Set to True to generate warnings for size clauses, component clauses
1781 -- and component_size clauses that force biased representation. Modified
1782 -- by use of -gnatw.b/.B.
1784 Warn_On_Constant : Boolean := False;
1786 -- Set to True to generate warnings for variables that could be declared
1787 -- as constants. Modified by use of -gnatwk/K.
1789 Warn_On_Deleted_Code : Boolean := False;
1791 -- Set to True to generate warnings for code deleted by the front end
1792 -- for conditional statements whose outcome is known at compile time.
1793 -- Modified by use of -gnatwt/T.
1795 Warn_On_Dereference : Boolean := False;
1797 -- Set to True to generate warnings for implicit dereferences for array
1798 -- indexing and record component access. Modified by use of -gnatwd/D.
1800 Warn_On_Export_Import : Boolean := True;
1802 -- Set to True to generate warnings for suspicious use of export or
1803 -- import pragmas. Modified by use of -gnatwx/X.
1805 Warn_On_Elab_Access : Boolean := False;
1807 -- Set to True to generate warnings for P'Access in the case where
1808 -- subprogram P is in the same package as the P'Access, and the P'Access is
1809 -- evaluated at package elaboration time, and occurs before the body of P
1810 -- has been elaborated.
1812 Warn_On_Hiding : Boolean := False;
1814 -- Set to True to generate warnings if a declared entity hides another
1815 -- entity. The default is that this warning is suppressed. Modified by
1816 -- use of -gnatwh/H.
1818 Warn_On_Modified_Unread : Boolean := False;
1820 -- Set to True to generate warnings if a variable is assigned but is never
1821 -- read. Also controls warnings for similar cases involving out parameters,
1822 -- but only if there is only one out parameter for the procedure involved.
1823 -- The default is that this warning is suppressed, modified by use of
1826 Warn_On_No_Value_Assigned : Boolean := True;
1828 -- Set to True to generate warnings if no value is ever assigned to a
1829 -- variable that is at least partially uninitialized. Set to false to
1830 -- suppress such warnings. The default is that such warnings are enabled.
1831 -- Modified by use of -gnatwv/V.
1833 Warn_On_Non_Local_Exception : Boolean := False;
1835 -- Set to True to generate warnings for non-local exception raises and also
1836 -- handlers that can never handle a local raise. This warning is only ever
1837 -- generated if pragma Restrictions (No_Exception_Propagation) is set. The
1838 -- default is not to generate the warnings except that if the source has
1839 -- at least one exception handler, and this restriction is set, and the
1840 -- warning was not explicitly turned off, then it is turned on by default.
1841 -- Modified by use of -gnatw.x/.X.
1843 No_Warn_On_Non_Local_Exception : Boolean := False;
1845 -- This is set to True if the above warning is explicitly suppressed. We
1846 -- use this to avoid turning it on by default when No_Exception_Propagation
1847 -- restriction is set and an exception handler is present.
1849 Warn_On_Object_Renames_Function : Boolean := False;
1851 -- Set to True to generate warnings when a function result is renamed as
1852 -- an object. The default is that this warning is disabled. Modified by
1853 -- use of -gnatw.r/.R.
1855 Warn_On_Obsolescent_Feature : Boolean := False;
1857 -- Set to True to generate warnings on use of any feature in Annex or if a
1858 -- subprogram is called for which a pragma Obsolescent applies. Modified
1859 -- by use of -gnatwj/J.
1861 Warn_On_Overlap : Boolean := False;
1863 -- Set to True to generate warnings when a writable actual overlaps with
1864 -- another actual in a subprogram call. This applies only in modes before
1865 -- Ada 2012. Starting with Ada 2012, such overlaps are illegal.
1866 -- Modified by use of -gnatw.i/.I.
1868 Warn_On_Questionable_Missing_Parens : Boolean := True;
1870 -- Set to True to generate warnings for cases where parentheses are missing
1871 -- and the usage is questionable, because the intent is unclear. On by
1872 -- default, modified by use of -gnatwq/Q.
1874 Warn_On_Parameter_Order : Boolean := False;
1876 -- Set to True to generate warnings for cases where the argument list for
1877 -- a call is a sequence of identifiers that match the formal identifiers,
1878 -- but are in the wrong order.
1880 Warn_On_Redundant_Constructs : Boolean := False;
1882 -- Set to True to generate warnings for redundant constructs (e.g. useless
1883 -- assignments/conversions). The default is that this warning is disabled.
1884 -- Modified by use of -gnatwr/R.
1886 Warn_On_Reverse_Bit_Order : Boolean := True;
1888 -- Set to True to generate warning (informational) messages for component
1889 -- clauses that are affected by non-standard bit-order. The default is
1890 -- that this warning is enabled. Modified by -gnatw.v/.V.
1892 Warn_On_Suspicious_Contract : Boolean := True;
1894 -- Set to True to generate warnings for suspicious contracts expressed as
1895 -- pragmas or aspects precondition and postcondition, as well as other
1896 -- suspicious cases of expressions typically found in contracts like
1897 -- quantified expressions and uses of Update attribute. The default is that
1898 -- this warning is enabled. Modified by use of -gnatw.t/.T.
1900 Warn_On_Suspicious_Modulus_Value : Boolean := True;
1902 -- Set to True to generate warnings for suspicious modulus values. The
1903 -- default is that this warning is enabled. Modified by -gnatw.m/.M.
1905 Warn_On_Unchecked_Conversion : Boolean := True;
1907 -- Set to True to generate warnings for unchecked conversions that may have
1908 -- non-portable semantics (e.g. because sizes of types differ). Modified
1909 -- by use of -gnatwz/Z.
1911 Warn_On_Unordered_Enumeration_Type : Boolean := False;
1913 -- Set to True to generate warnings for inappropriate uses (comparisons
1914 -- and explicit ranges) on unordered enumeration types (which includes
1915 -- all enumeration types for which pragma Ordered is not given). The
1916 -- default is that this warning is disabled. Modified by -gnat.u/.U.
1918 Warn_On_Unrecognized_Pragma : Boolean := True;
1920 -- Set to True to generate warnings for unrecognized pragmas. The default
1921 -- is that this warning is enabled. Modified by use of -gnatwg/G.
1923 Warn_On_Unrepped_Components : Boolean := False;
1925 -- Set to True to generate warnings for the case of components of record
1926 -- which have a record representation clause but this component does not
1927 -- have a component clause. Modified by use of -gnatw.c/.C.
1929 Warn_On_Warnings_Off : Boolean := False;
1931 -- Set to True to generate warnings for use of Pragma Warnings (Off, ent),
1932 -- where either the pragma is never used, or it could be replaced by a
1933 -- pragma Unmodified or Unreferenced. Also generates warnings for pragma
1934 -- Warning (Off, string) which either has no matching pragma Warning On,
1935 -- or where no warning has been suppressed by the use of the pragma.
1936 -- Modified by use of -gnatw.w/.W.
1938 type Warning_Mode_Type is
1939 (Suppress, Normal, Treat_As_Error, Treat_Run_Time_Warnings_As_Errors);
1940 Warning_Mode : Warning_Mode_Type := Normal;
1942 -- Controls treatment of warning messages. If set to Suppress, warning
1943 -- messages are not generated at all. In Normal mode, they are generated
1944 -- but do not count as errors. In Treat_As_Error mode, warning messages are
1945 -- generated and treated as errors. In Treat_Run_Time_Warnings_As_Errors,
1946 -- warning messages regarding errors raised at run time are treated as
1947 -- errors. Note that Warning_Mode = Suppress causes pragma Warnings to be
1948 -- ignored (except for legality checks), unless we are in GNATprove_Mode,
1949 -- which requires pragma Warnings to be stored for the formal verification
1952 Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1954 -- Method used for encoding wide characters in the source program. See
1955 -- description of type in unit System.WCh_Con for a list of the methods
1956 -- that are currently supported. Note that brackets notation is always
1957 -- recognized in source programs regardless of the setting of this
1958 -- variable. The default setting causes only the brackets notation to be
1959 -- recognized. If this is the main unit, this setting also controls the
1960 -- output of the W=? parameter in the ALI file, which is used to provide
1961 -- the default for encoding [Wide_[Wide_]]Text_IO files. For the binder,
1962 -- the value set here overrides this main unit default.
1964 Wide_Character_Encoding_Method_Specified : Boolean := False;
1966 -- Set True if the value in Wide_Character_Encoding_Method was set as
1967 -- a result of an explicit -gnatW? or -W? switch. False otherwise.
1969 Xref_Active : Boolean := True;
1971 -- Set if cross-referencing is enabled (i.e. xref info in ALI files)
1973 Zero_Formatting : Boolean := False;
1975 -- Do no formatting (no title, no leading spaces, no empty lines) in
1976 -- auxiliary outputs (-e, -K, -l, -R).
1978 ----------------------------
1979 -- Configuration Settings --
1980 ----------------------------
1982 -- These are settings that are used to establish the mode at the start of
1983 -- each unit. The values defined below can be affected either by command
1984 -- line switches, or by the use of appropriate configuration pragmas in a
1985 -- configuration pragma file (but NOT by a local use of a configuration
1986 -- pragma in a single file).
1988 Ada_Version_Config : Ada_Version_Type;
1990 -- This is the value of the configuration switch for the Ada 83 mode, as
1991 -- set by the command line switches -gnat83/95/2005/2012, and possibly
1992 -- modified by the use of configuration pragmas Ada_*. This switch is used
1993 -- to set the initial value for Ada_Version mode at the start of analysis
1994 -- of a unit. Note however that the setting of this flag is ignored for
1995 -- internal and predefined units (which are always compiled in the most up
1996 -- to date version of Ada).
1998 Ada_Version_Pragma_Config : Node_Id;
1999 -- This will be set nonempty if it is set by a configuration pragma
2001 Ada_Version_Explicit_Config : Ada_Version_Type;
2003 -- This is set in the same manner as Ada_Version_Config. The difference is
2004 -- that the setting of this flag is not ignored for internal and predefined
2005 -- units, which for some purposes do indeed access this value, regardless
2006 -- of the fact that they are compiled the most up to date ada version).
2008 Assertions_Enabled_Config : Boolean;
2010 -- This is the value of the configuration switch for assertions enabled
2011 -- mode, as possibly set by the command line switch -gnata, and possibly
2012 -- modified by the use of the configuration pragma Assertion_Policy.
2014 Assume_No_Invalid_Values_Config : Boolean;
2016 -- This is the value of the configuration switch for assuming "no invalid
2017 -- values enabled" mode, as possibly set by the command line switch
2018 -- -gnatB, and possibly modified by the use of the configuration pragma
2019 -- Assume_No_Invalid_Values.
2021 Check_Float_Overflow_Config : Boolean;
2023 -- Set to True to check that operations on predefined unconstrained float
2024 -- types (e.g. Float, Long_Float) do not overflow and generate infinities
2025 -- or invalid values. Set by the Check_Float_Overflow pragma, or by use
2026 -- of the -gnateF switch.
2028 Check_Policy_List_Config : Node_Id;
2030 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
2031 -- that are linked through the Next_Pragma fields, with the list being
2032 -- terminated by Empty. The order is most recently processed first. This
2033 -- list includes only those pragmas in configuration pragma files.
2035 Default_Pool_Config : Node_Id := Empty;
2037 -- Same as Default_Pool above, except this is only for Default_Storage_Pool
2038 -- pragmas that are configuration pragmas.
2040 Default_SSO_Config : Character := ' ';
2042 -- Set if a pragma Default_Scalar_Storage_Order appears as a configuration
2043 -- pragma. A value of ' ' means that no pragma was given, otherwise the
2044 -- value is 'H' for High_Order_First or 'L' for Low_Order_First.
2046 Dynamic_Elaboration_Checks_Config : Boolean := False;
2048 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
2049 -- switch or by the use of pragma Elaboration_Checking (Dynamic).
2051 Exception_Locations_Suppressed_Config : Boolean := False;
2053 -- Set True by use of the configuration pragma Suppress_Exception_Messages
2055 Extensions_Allowed_Config : Boolean;
2057 -- This is the flag that indicates whether extensions are allowed. It can
2058 -- be set True either by use of the -gnatX switch, or by use of the
2059 -- configuration pragma Extensions_Allowed (On). It is always set to True
2060 -- for internal GNAT units, since extensions are always permitted in such
2063 External_Name_Exp_Casing_Config : External_Casing_Type;
2065 -- This is the value of the configuration switch that controls casing of
2066 -- external symbols for which an explicit external name is given. It can be
2067 -- set to Uppercase by the command line switch -gnatF, and further modified
2068 -- by the use of the configuration pragma External_Name_Casing in the
2069 -- gnat.adc file. This flag is used to set the initial value for
2070 -- External_Name_Exp_Casing at the start of analyzing each unit. Note
2071 -- however that the setting of this flag is ignored for internal and
2072 -- predefined units (which are always compiled with As_Is mode).
2074 External_Name_Imp_Casing_Config : External_Casing_Type;
2076 -- This is the value of the configuration switch that controls casing of
2077 -- external symbols where the external name is implicitly given. It can be
2078 -- set to Uppercase by the command line switch -gnatF, and further modified
2079 -- by the use of the configuration pragma External_Name_Casing in the
2080 -- gnat.adc file. This flag is used to set the initial value for
2081 -- External_Name_Imp_Casing at the start of analyzing each unit. Note
2082 -- however that the setting of this flag is ignored for internal and
2083 -- predefined units (which are always compiled with Lowercase mode).
2085 Fast_Math_Config : Boolean;
2087 -- This is the value of the configuration switch that controls Fast_Math
2088 -- mode, as set by a Fast_Math pragma in configuration pragmas. It is
2089 -- used to set the initial value of Fast_Math at the start of each new
2090 -- compilation unit.
2092 Initialize_Scalars_Config : Boolean;
2094 -- This is the value of the configuration switch that is set by the
2095 -- pragma Initialize_Scalars when it appears in the gnat.adc file.
2096 -- This switch is not set when the pragma appears ahead of a given
2097 -- unit, so it does not affect the compilation of other units.
2099 No_Component_Reordering_Config : Boolean;
2101 -- This is the value of the configuration switch that is set by the
2102 -- pragma No_Component_Reordering when it appears in the gnat.adc file.
2103 -- This flag is used to set the initial value of No_Component_Reordering
2104 -- at the start of each compilation unit, except that it is always set
2105 -- False for predefined units.
2107 No_Exit_Message : Boolean := False;
2108 -- GNATMAKE, GPRBUILD
2109 -- Set with switch --no-exit-message. When True, if there are compilation
2110 -- failures, the builder does not issue an exit error message.
2112 Optimize_Alignment_Config : Character;
2114 -- This is the value of the configuration switch that controls the
2115 -- alignment optimization mode, as set by an Optimize_Alignment pragma.
2116 -- It is used to set the initial value of Optimize_Alignment at the start
2117 -- of each new compilation unit, except that it is always set to 'O' (off)
2118 -- for internal units.
2120 Persistent_BSS_Mode_Config : Boolean;
2122 -- This is the value of the configuration switch that controls whether
2123 -- potentially persistent data is to be placed in the persistent_bss
2124 -- section. It can be set True by use of the pragma Persistent_BSS.
2125 -- This flag is used to set the initial value of Persistent_BSS_Mode
2126 -- at the start of each compilation unit, except that it is always
2127 -- set False for predefined units.
2129 Polling_Required_Config : Boolean;
2131 -- This is the value of the configuration switch that controls polling
2132 -- mode. It can be set True by the command line switch -gnatP, and then
2133 -- further modified by the use of pragma Polling in the gnat.adc file. This
2134 -- flag is used to set the initial value for Polling_Required at the start
2135 -- of analyzing each unit.
2137 Prefix_Exception_Messages_Config : Boolean;
2138 -- The setting of Prefix_Exception_Messages from configuration pragmas
2140 SPARK_Mode_Config : SPARK_Mode_Type := None;
2142 -- The setting of SPARK_Mode from configuration pragmas
2144 SPARK_Mode_Pragma_Config : Node_Id := Empty;
2145 -- If a SPARK_Mode pragma appeared in the configuration pragmas (setting
2146 -- SPARK_Mode_Config appropriately), then this points to the N_Pragma node.
2148 Uneval_Old_Config : Character;
2150 -- The setting of Uneval_Old from configuration pragmas
2152 Use_VADS_Size_Config : Boolean;
2154 -- This is the value of the configuration switch that controls the use of
2155 -- VADS_Size instead of Size wherever the attribute Size is used. It can
2156 -- be set True by the use of the pragma Use_VADS_Size in the gnat.adc file.
2157 -- This flag is used to set the initial value for Use_VADS_Size at the
2158 -- start of analyzing each unit. Note however that the setting of this flag
2159 -- is ignored for internal and predefined units (which are always compiled
2160 -- with the standard Size semantics).
2162 type Config_Switches_Type is private;
2163 -- Type used to save values of the switches set from Config values
2165 procedure Register_Config_Switches;
2166 -- This procedure is called after processing the gnat.adc file and other
2167 -- configuration pragma files to record the values of the Config switches,
2168 -- as possibly modified by the use of command line switches and pragmas
2169 -- appearing in these files.
2171 procedure Restore_Config_Switches (Save : Config_Switches_Type);
2172 -- This procedure restores a set of switch values previously saved by a
2173 -- call to Save_Config_Switches.
2175 function Save_Config_Switches return Config_Switches_Type;
2176 -- Return the current state of all configuration-related attributes
2178 procedure Set_Config_Switches
2179 (Internal_Unit : Boolean;
2180 Main_Unit : Boolean);
2181 -- This procedure sets the switches to the appropriate initial values. The
2182 -- parameter Internal_Unit is True for an internal or predefined unit, and
2183 -- affects the way the switches are set (see above). Main_Unit is true if
2184 -- switches are being set for the main unit or for the spec of the main
2185 -- unit. This affects setting of the assert/debug pragma switches, which
2186 -- are normally set false by default for an internal unit, except when the
2187 -- internal unit is the main unit, in which case we use the command line
2190 ------------------------
2191 -- Other Global Flags --
2192 ------------------------
2194 Building_Static_Dispatch_Tables : Boolean := True;
2195 -- This flag indicates if the backend supports generation of statically
2196 -- allocated dispatch tables. If it is True, then the front end will
2197 -- generate static aggregates for dispatch tables that contain forward
2198 -- references to addresses of subprograms not seen yet, and the back end
2199 -- must be prepared to handle this case. If it is False, then the front
2200 -- end generates assignments to initialize the dispatch table, and there
2201 -- are no such forward references. By default we build statically allocated
2202 -- dispatch tables for all library level tagged types in all platforms.This
2203 -- behavior can be disabled using switch -gnatd.t which will set this flag
2204 -- to False and revert to the previous dynamic behavior.
2206 Expander_Active : Boolean := False;
2207 -- A flag that indicates if expansion is active (True) or deactivated
2208 -- (False). When expansion is deactivated all calls to expander routines
2209 -- have no effect. Note that the initial setting of False is merely to
2210 -- prevent saving of an undefined value for an initial call to the
2211 -- Expander_Mode_Save_And_Set procedure. For more information on the use of
2212 -- this flag, see package Expander. Indeed this flag might more logically
2213 -- be in the spec of Expander, but it is referenced by Errout, and it
2214 -- really seems wrong for Errout to depend on Expander.
2216 -----------------------
2217 -- Tree I/O Routines --
2218 -----------------------
2220 procedure Tree_Read;
2221 -- Reads switch settings from current tree file using Tree_Read
2223 procedure Tree_Write;
2224 -- Writes out switch settings to current tree file using Tree_Write
2226 --------------------------
2227 -- ASIS Version Control --
2228 --------------------------
2230 -- These two variables (Tree_Version_String and Tree_ASIS_Version_Number)
2231 -- are supposed to be used in the GNAT/ASIS version check performed in
2232 -- the ASIS code (this package is also a part of the ASIS implementation).
2233 -- They are set by Tree_Read procedure, so they represent the version
2234 -- number (and the version string) of the compiler which has created the
2235 -- tree, and they are supposed to be compared with the corresponding values
2236 -- from the Tree_IO and Gnatvsn packages which also are a part of ASIS
2239 Tree_Version_String : String_Access;
2240 -- Used to store the compiler version string read from a tree file to check
2241 -- if it is from the same date as stored in the version string in Gnatvsn.
2242 -- We require that ASIS Pro can be used only with GNAT Pro, but we allow
2243 -- non-Pro ASIS and ASIS-based tools to be used with any version of the
2244 -- GNAT compiler. Therefore, we need the possibility to compare the dates
2245 -- of the corresponding source sets, using version strings that may be
2246 -- of different lengths.
2248 Tree_ASIS_Version_Number : Int;
2249 -- Used to store the ASIS version number read from a tree file to check if
2250 -- it is the same as stored in the ASIS version number in Tree_IO.
2252 -----------------------------------
2253 -- Modes for Formal Verification --
2254 -----------------------------------
2256 GNATprove_Mode : Boolean := False;
2257 -- Specific compiling mode targeting formal verification for those parts
2258 -- of the input code that belong to the SPARK 2014 subset of Ada. Set True
2259 -- by the gnat2why executable or by use of the -gnatd.F debug switch. Note
2260 -- that this is completely separate from the SPARK restriction defined in
2261 -- GNAT to detect violations of a subset of SPARK 2005 rules.
2263 ---------------------------
2264 -- Error/Warning Control --
2265 ---------------------------
2267 -- The following array would more reasonably be located in Err_Vars or
2268 -- Errout, but we put them here to deal with licensing issues (we need
2269 -- this to have the GPL exception licensing, since these variables and
2270 -- subprograms are accessed from units with this licensing).
2272 Warnings_As_Errors : array (1 .. 10_000) of String_Ptr;
2273 -- Table for recording Warning_As_Error pragmas as they are processed. It
2274 -- would be nicer to use Table, but there are circular elaboration problems
2275 -- if we try to do this, and an attempt to find some other appropriately
2276 -- licensed unit to declare this as a Table failed with various elaboration
2279 Warnings_As_Errors_Count : Natural;
2281 -- Number of entries stored in Warnings_As_Errors table
2283 Warnings_As_Errors_Count_Config : Natural;
2285 -- Count of pattern strings stored from Warning_As_Error pragmas
2291 GNAT_Mode : Boolean := False;
2293 -- True if compiling in GNAT system mode (-gnatg switch)
2295 GNAT_Mode_Config : Boolean := False;
2297 -- True if -gnatg switch is present. GNAT_Mode may be temporary set to
2298 -- True during the analysis of a system unit, but GNAT_Mode_Config must
2299 -- not change once scanned and set.
2301 -- Setting GNAT mode has the following effects on the language that is
2302 -- accepted. Note that several of the following have the effect of changing
2303 -- an error to a warning. But warnings are usually treated as fatal errors
2304 -- in -gnatg mode, so to actually take advantage of such a change, it is
2305 -- necessary to add an explicit pragma Warnings (Off) in the source and
2306 -- this requires clear documentation of why this is necessary.
2308 -- The identifier character set is set to 'n' (7-bit ASCII)
2310 -- Pragma Extend_System is ignored
2312 -- Warning_Mode is set to Treat_As_Error (-gnatwe)
2314 -- Standard style checks are set (See Set_GNAT_Style_Check_Options)
2316 -- Standard warnings are turned on (see Set_GNAT_Mode_Warnings)
2318 -- The Ada version is set to Ada 2012
2320 -- Task priorities are always allowed to be in the range Any_Priority
2322 -- Overflow checks are suppressed, overflow checking set to strict mode
2324 -- ALI files are always generated for predefined generic packages
2326 -- Obsolescent feature warnings are suppressed
2328 -- Recompilation of children of GNAT, System, Ada, Interfaces is allowed
2330 -- The Scalar_Storage_Order attribute applies to generic types
2332 -- Categorization errors are treated as warnings rather than errors
2334 -- Statements in preelaborated units give warnings rather than errors
2336 -- Private objects are allowed in preelaborated units
2338 -- Non-static constants in preelaborated units give warnings not errors
2340 -- The warning about component size being ignored is suppressed
2342 -- The warning about size clauses being ignored is suppressed
2344 -- Initializing limited types gives a warning rather than an error
2346 -- Copying of limited objects is allowed
2348 -- Returning objects of limited types is allowed
2350 -- Non-static call in preelaborated unit give a warning, not an error
2352 -- Warnings on possible elaboration errors are suppressed
2354 -- Warnings about packing being ignored are suppressed
2356 -- Warnings in internal units are not suppressed (they normally are)
2358 -- The only special comment sequence allowed is --!
2360 --------------------------
2361 -- Private Declarations --
2362 --------------------------
2365 -- The following type is used to save and restore settings of switches in
2366 -- Opt that represent the configuration (i.e. result of config pragmas).
2368 -- Note that Ada_Version_Explicit is not included, since this is a sticky
2369 -- flag that once set does not get reset, since the whole idea of this flag
2370 -- is to record the setting for the main unit.
2372 type Config_Switches_Type is record
2373 Ada_Version : Ada_Version_Type;
2374 Ada_Version_Explicit : Ada_Version_Type;
2375 Ada_Version_Pragma : Node_Id;
2376 Assertions_Enabled : Boolean;
2377 Assume_No_Invalid_Values : Boolean;
2378 Check_Float_Overflow : Boolean;
2379 Check_Policy_List : Node_Id;
2380 Default_Pool : Node_Id;
2381 Default_SSO : Character;
2382 Dynamic_Elaboration_Checks : Boolean;
2383 Exception_Locations_Suppressed : Boolean;
2384 Extensions_Allowed : Boolean;
2385 External_Name_Exp_Casing : External_Casing_Type;
2386 External_Name_Imp_Casing : External_Casing_Type;
2387 Fast_Math : Boolean;
2388 Initialize_Scalars : Boolean;
2389 No_Component_Reordering : Boolean;
2390 Normalize_Scalars : Boolean;
2391 Optimize_Alignment : Character;
2392 Optimize_Alignment_Local : Boolean;
2393 Persistent_BSS_Mode : Boolean;
2394 Polling_Required : Boolean;
2395 Prefix_Exception_Messages : Boolean;
2396 SPARK_Mode : SPARK_Mode_Type;
2397 SPARK_Mode_Pragma : Node_Id;
2398 Uneval_Old : Character;
2399 Use_VADS_Size : Boolean;
2400 Warnings_As_Errors_Count : Natural;
2403 -- The following declarations are for GCC version dependent flags. We do
2404 -- not let client code in the compiler test GCC_Version directly, but
2405 -- instead use deferred constants for relevant feature tags.
2407 -- Note: there currently are no such constants defined in this section,
2408 -- since the compiler front end is currently entirely independent of the
2409 -- GCC version, which is a desirable state of affairs.
2411 function get_gcc_version return Int;
2412 pragma Import (C, get_gcc_version, "get_gcc_version");
2414 GCC_Version : constant Nat := get_gcc_version;
2416 -- Indicates which version of gcc is in use (3 = 3.x, 4 = 4.x). Note that
2417 -- gcc 2.8.1 (which used to be a value of 2) is no longer supported.
git://gcc.gnu.org / gcc.git / blob