1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2010, 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, GPRMAKE, 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 with System.Strings; use System.Strings;
45 with System.WCh_Con; use System.WCh_Con;
49 ----------------------------------------------
50 -- Settings of Modes for Current Processing --
51 ----------------------------------------------
53 -- The following mode values represent the current state of processing.
54 -- The values set here are the default values. Unless otherwise noted,
55 -- the value may be reset in Switch-? with an appropriate switch. In
56 -- some cases, the values can also be modified by pragmas, and in the
57 -- case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
58 -- the default values.
60 Ada_Bind_File : Boolean := True;
62 -- Set True if binder file to be generated in Ada rather than C
64 type Ada_Version_Type is (Ada_83, Ada_95, Ada_05);
65 pragma Warnings (Off, Ada_Version_Type);
66 -- Versions of Ada for Ada_Version below. Note that these are ordered,
67 -- so that tests like Ada_Version >= Ada_95 are legitimate and useful.
68 -- The Warnings_Off pragma stops warnings for Ada_Version >= Ada_05,
69 -- which we want to allow, so that things work OK when Ada_15 is added!
70 -- This warning is now removed, so this pragma can be removed some time???
72 Ada_Version_Default : Ada_Version_Type := Ada_05;
74 -- Default Ada version if no switch given
76 Ada_Version : Ada_Version_Type := Ada_Version_Default;
78 -- Current Ada version for compiler, as set by configuration pragmas,
79 -- compiler switches, or implicitly (to Ada_Version_Runtime) when a
80 -- predefined or internal file is compiled.
82 Ada_Version_Explicit : Ada_Version_Type := Ada_Version_Default;
84 -- Like Ada_Version, but does not get set implicitly for predefined
85 -- or internal units, so it reflects the Ada version explicitly set
86 -- using configuration pragmas or compiler switches (or if neither
87 -- appears, it remains set to Ada_Version_Default). This is used in
88 -- the rare cases (notably for pragmas Preelaborate_05 and Pure_05)
89 -- where in the run-time we want the explicit version set.
91 Ada_Version_Runtime : Ada_Version_Type := Ada_05;
93 -- Ada version used to compile the runtime. Used to set Ada_Version (but
94 -- not Ada_Version_Explicit) when compiling predefined or internal units.
96 Ada_Final_Suffix : constant String := "final";
97 Ada_Final_Name : String_Ptr := new String'("ada" & Ada_Final_Suffix);
99 -- The name of the procedure that performs the finalization at the end of
100 -- execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
102 Ada_Init_Suffix : constant String := "init";
103 Ada_Init_Name : String_Ptr := new String'("ada" & Ada_Init_Suffix);
105 -- The name of the procedure that performs initialization at the start
106 -- of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
108 Ada_Main_Name_Suffix : constant String := "main";
110 -- The suffix for Ada_Main_Name. Defined as a constant here so that it
111 -- can be referenced in a uniform manner to create either the default
112 -- value of Ada_Main_Name (declared below), or the non-default name
113 -- set by Gnatbind.Scan_Bind_Arg.
115 Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
117 -- The name of the Ada package generated by the binder (when in Ada mode).
118 -- This variable may be modified by Gnatbind.Scan_Bind_Arg.
120 Address_Clause_Overlay_Warnings : Boolean := True;
122 -- Set False to disable address clause warnings
124 Address_Is_Private : Boolean := False;
126 -- Set True if package System has the line "type Address is private;"
128 All_Errors_Mode : Boolean := False;
130 -- Flag set to force display of multiple errors on a single line and
131 -- also repeated error messages for references to undefined identifiers
132 -- and certain other repeated error messages. Set by use of -gnatf.
134 All_Sources : Boolean := False;
136 -- Set to True to require all source files to be present. This flag is
137 -- directly modified by gnatmake to affect the shared binder routines.
139 Alternate_Main_Name : String_Ptr := null;
141 -- Set to non null when Bind_Alternate_Main_Name is True. This value
142 -- is modified as needed by Gnatbind.Scan_Bind_Arg.
144 ASIS_Mode : Boolean := False;
146 -- Enable semantic checks and tree transformations that are important
147 -- for ASIS but that are usually skipped if Operating_Mode is set to
148 -- Check_Semantics. This flag does not have the corresponding option to set
149 -- it ON. It is set ON when Tree_Output is set ON, it can also be set ON
150 -- from the code of GNSA-based tool (a client may need to set ON the
151 -- Back_Annotate_Rep_Info flag in this case. At the moment this does not
152 -- make very much sense, because GNSA cannot do back annotation).
154 Assertions_Enabled : Boolean := False;
156 -- Enable assertions made using pragma Assert
158 Assume_No_Invalid_Values : Boolean := False;
160 -- Normally, in accordance with (RM 13.9.1 (9-11)) the front end assumes
161 -- that values could have invalid representations, unless it can clearly
162 -- prove that the values are valid. If this switch is set (by -gnatB or by
163 -- pragma Assume_No_Invalid_Values (Off)), then the compiler assumes values
164 -- are valid and in range of their representations. This feature is now
165 -- fully enabled in the compiler.
167 Back_Annotate_Rep_Info : Boolean := False;
169 -- If set True, enables back annotation of representation information
170 -- by gigi, even in -gnatc mode. This is set True by the use of -gnatR
171 -- (list representation information) or -gnatt (generate tree). It is
172 -- also set true if certain Unchecked_Conversion instantiations require
173 -- checking based on annotated values.
175 Back_End_Handles_Limited_Types : Boolean;
176 -- This flag is set true if the back end can properly handle limited or
177 -- other by reference types, and avoid copies. If this flag is False, then
178 -- the front end does special expansion for conditional expressions to make
179 -- sure that no copy occurs. If the flag is True, then the expansion for
180 -- conditional expressions relies on the back end properly handling things.
181 -- Currently the default is False for all cases (set in gnat1drv). The
182 -- default can be modified using -gnatd.L (sets the flag True).
184 Bind_Alternate_Main_Name : Boolean := False;
186 -- True if main should be called Alternate_Main_Name.all.
187 -- This variable may be set to True by Gnatbind.Scan_Bind_Arg.
189 Bind_Main_Program : Boolean := True;
191 -- Set to False if not binding main Ada program
193 Bind_For_Library : Boolean := False;
195 -- Set to True if the binder needs to generate a file designed for building
196 -- a library. May be set to True by Gnatbind.Scan_Bind_Arg.
198 Bind_Only : Boolean := False;
199 -- GNATMAKE, GPRMAKE, GPRBUILD
200 -- Set to True to skip compile and link steps
201 -- (except when Compile_Only and/or Link_Only are True).
203 Blank_Deleted_Lines : Boolean := False;
205 -- Output empty lines for each line of preprocessed input that is deleted
206 -- in the output, including preprocessor lines starting with a '#'.
208 Brief_Output : Boolean := False;
210 -- Force brief error messages to standard error, even if verbose mode is
211 -- set (so that main error messages go to standard output).
213 Build_Bind_And_Link_Full_Project : Boolean := False;
215 -- Set to True to build, bind and link all the sources of a project file
218 Check_Object_Consistency : Boolean := False;
219 -- GNATBIND, GNATMAKE
220 -- Set to True to check whether every object file is consistent with
221 -- its corresponding ada library information (ALI) file. An object
222 -- file is inconsistent with the corresponding ALI file if the object
223 -- file does not exist or if it has an older time stamp than the ALI file.
224 -- Default above is for GNATBIND. GNATMAKE overrides this default to
225 -- True (see Make.Initialize) since we normally do need to check source
226 -- consistencies in gnatmake.
228 Check_Only : Boolean := False;
230 -- Set to True to do checks only, no output of binder file
232 Check_Policy_List : Node_Id := Empty;
234 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
235 -- that are linked through the Next_Pragma fields, with the list being
236 -- terminated by Empty. The order is most recently processed first. Note
237 -- that Push_Scope and Pop_Scope in Sem_Ch8 save and restore the value
238 -- of this variable, implementing the required scope control for pragmas
239 -- appearing a declarative part.
241 Check_Readonly_Files : Boolean := False;
243 -- Set to True to check readonly files during the make process
245 Check_Source_Files : Boolean := True;
246 -- GNATBIND, GNATMAKE
247 -- Set to True to enable consistency checking for any source files that
248 -- are present (i.e. date must match the date in the library info file).
249 -- Set to False for object file consistency check only. This flag is
250 -- directly modified by gnatmake, to affect the shared binder routines.
252 Check_Switches : Boolean := False;
253 -- GNATMAKE, GPRMAKE, GPBUILD
254 -- Set to True to check compiler options during the make process
256 Check_Unreferenced : Boolean := False;
258 -- Set to True to enable checking for unreferenced entities other
259 -- than formal parameters (for which see Check_Unreferenced_Formals)
261 Check_Unreferenced_Formals : Boolean := False;
263 -- Set True to check for unreferenced formals. This is turned on by
264 -- -gnatwa/wf/wu and turned off by -gnatwA/wF/wU.
266 Check_Withs : Boolean := False;
268 -- Set to True to enable checking for unused withs, and also the case
269 -- of withing a package and using none of the entities in the package.
271 CodePeer_Mode : Boolean := False;
273 -- Enable full CodePeer mode (SCIL generation, disable switches that
274 -- interact badly with it, etc...).
276 Commands_To_Stdout : Boolean := False;
278 -- True if echoed commands to be written to stdout instead of stderr
280 Comment_Deleted_Lines : Boolean := False;
282 -- True if source lines removed by the preprocessor should be commented
283 -- in the output file.
285 Compile_Only : Boolean := False;
286 -- GNATMAKE, GNATCLEAN, GPRMAKE, GPBUILD, GPRCLEAN
287 -- GNATMAKE, GPRMAKE, GPRMAKE:
288 -- set to True to skip bind and link steps (except when Bind_Only is
290 -- GNATCLEAN, GPRCLEAN:
291 -- set to True to delete only the files produced by the compiler but not
292 -- the library files or the executable files.
294 Config_File : Boolean := True;
296 -- Set to False to inhibit reading and processing of gnat.adc file
298 Config_File_Names : String_List_Access := null;
300 -- Names of configuration pragmas files (given by switches -gnatec)
302 Configurable_Run_Time_Mode : Boolean := False;
304 -- Set True if the compiler is operating in configurable run-time mode.
305 -- This happens if the flag Targparm.Configurable_Run_TimeMode_On_Target
306 -- is set True, or if pragma No_Run_Time is used. See the spec of Rtsfind
307 -- for details on the handling of the latter pragma.
309 Constant_Condition_Warnings : Boolean := False;
311 -- Set to True to activate warnings on constant conditions
313 Create_Mapping_File : Boolean := False;
315 -- Set to True (-C switch) to indicate that the compiler will be invoked
316 -- with a mapping file (-gnatem compiler switch).
318 Debug_Pragmas_Enabled : Boolean := False;
320 -- Enable debug statements from pragma Debug
322 subtype Debug_Level_Value is Nat range 0 .. 3;
323 Debugger_Level : Debug_Level_Value := 0;
325 -- The value given to the -g parameter. The default value for -g with
326 -- no value is 2. This is usually ignored by GNATBIND, except in the
327 -- VMS version where it is passed as an argument to __gnat_initialize
328 -- to trigger the activation of the remote debugging interface.
329 -- Is this still true ???
331 Debug_Generated_Code : Boolean := False;
333 -- Set True (-gnatD switch) to debug generated expanded code instead
334 -- of the original source code. Causes debugging information to be
335 -- written with respect to the generated code file that is written.
337 Default_Exit_Status : Int := 0;
339 -- Set the default exit status value. Set by the -Xnnn switch for the
342 Default_Stack_Size : Int := -1;
344 -- Set to default primary stack size in units of bytes. Set by
345 -- the -dnnn switch for the binder. A value of -1 indicates that no
346 -- default was set by the binder.
348 Default_Sec_Stack_Size : Int := -1;
350 -- Set to default secondary stack size in units of bytes. Set by
351 -- the -Dnnn switch for the binder. A value of -1 indicates that no
352 -- default was set by the binder, and that the default should be the
353 -- initial value of System.Secondary_Stack.Default_Secondary_Stack_Size.
355 Detect_Blocking : Boolean := False;
357 -- Set True to force the run time to raise Program_Error if calls to
358 -- potentially blocking operations are detected from protected actions.
360 Display_Compilation_Progress : Boolean := False;
361 -- GNATMAKE, GPRMAKE, GPRBUILD
362 -- Set True (-d switch) to display information on progress while compiling
363 -- files. Internal flag to be used in conjunction with an IDE (e.g GPS).
365 type Distribution_Stub_Mode_Type is
368 -- Normal mode, no generation/compilation of distribution stubs
370 Generate_Receiver_Stub_Body,
371 -- The unit being compiled is the RCI body, and the compiler will
372 -- generate the body for the receiver stubs and compile it.
374 Generate_Caller_Stub_Body);
375 -- The unit being compiled is the RCI spec, and the compiler will
376 -- generate the body for the caller stubs and compile it.
378 Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
380 -- This enumeration variable indicates the five states of distribution
381 -- annex stub generation/compilation.
383 Do_Not_Execute : Boolean := False;
385 -- Set to True if no actual compilations should be undertaken.
387 Dump_Source_Text : Boolean := False;
389 -- Set to True (by -gnatL) to dump source text intermingled with generated
390 -- code. Effective only if either of Debug/Print_Generated_Code is true.
392 Dynamic_Elaboration_Checks : Boolean := False;
394 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
395 -- switch or by the use of pragma Elaboration_Checks (Dynamic).
397 Dynamic_Stack_Measurement : Boolean := False;
399 -- Set True to enable dynamic stack measurement (-u flag for gnatbind)
401 Dynamic_Stack_Measurement_Array_Size : Nat := 100;
403 -- Number of measurements we want to store during dynamic stack analysis.
404 -- When the buffer is full, non-storable results will be output on the fly.
405 -- The value is relevant only if Dynamic_Stack_Measurement is set. Set
406 -- by processing of -u flag for gnatbind.
408 Elab_Dependency_Output : Boolean := False;
410 -- Set to True to output complete list of elaboration constraints
412 Elab_Order_Output : Boolean := False;
414 -- Set to True to output chosen elaboration order
416 Elab_Warnings : Boolean := False;
418 -- Set to True to generate full elaboration warnings (-gnatwl)
420 Enable_Overflow_Checks : Boolean := False;
422 -- Set to True if -gnato (enable overflow checks) switch is set,
425 Error_Msg_Line_Length : Nat := 0;
427 -- Records the error message line length limit. If this is set to zero,
428 -- then we get the old style behavior, in which each call to the error
429 -- message routines generates one line of output as a separate message.
430 -- If it is set to a non-zero value, then continuation lines are folded
431 -- to make a single long message, and then this message is split up into
432 -- multiple lines not exceeding the specified length. Set by -gnatj=nn.
434 Exception_Handler_Encountered : Boolean := False;
436 -- This flag is set true if the parser encounters an exception handler.
437 -- It is used to set Warn_On_Exception_Propagation True if the restriction
438 -- No_Exception_Propagation is set.
440 Exception_Locations_Suppressed : Boolean := False;
442 -- This flag is set True if a Suppress_Exception_Locations configuration
443 -- pragma is currently active.
445 type Exception_Mechanism_Type is
446 -- Determines the handling of exceptions. See Exp_Ch11 for details
448 (Front_End_Setjmp_Longjmp_Exceptions,
449 -- Exceptions use setjmp/longjmp generated explicitly by the
450 -- front end (this includes gigi or other equivalent parts of
451 -- the code generator). AT END handlers are converted into
452 -- exception handlers by the front end in this mode.
454 Back_End_Exceptions);
455 -- Exceptions are handled by the back end. The front end simply
456 -- generates the handlers as they appear in the source, and AT
457 -- END handlers are left untouched (they are not converted into
458 -- exception handlers when operating in this mode.
459 pragma Convention (C, Exception_Mechanism_Type);
461 Exception_Mechanism : Exception_Mechanism_Type :=
462 Front_End_Setjmp_Longjmp_Exceptions;
464 -- Set to the appropriate value depending on the default as given in
465 -- system.ads (ZCX_By_Default, GCC_ZCX_Support). The C convention is there
466 -- to make this variable accessible to gigi.
468 Exception_Tracebacks : Boolean := False;
470 -- Set to True to store tracebacks in exception occurrences (-E)
472 Extensions_Allowed : Boolean := False;
474 -- Set to True by switch -gnatX if GNAT specific language extensions
475 -- are allowed. For example, the use of 'Constrained with objects of
476 -- generic types is a GNAT extension.
478 type External_Casing_Type is (
479 As_Is, -- External names cased as they appear in the Ada source
480 Uppercase, -- External names forced to all uppercase letters
481 Lowercase); -- External names forced to all lowercase letters
483 External_Name_Imp_Casing : External_Casing_Type := Lowercase;
485 -- The setting of this flag determines the casing of external names
486 -- when the name is implicitly derived from an entity name (i.e. either
487 -- no explicit External_Name or Link_Name argument is used, or, in the
488 -- case of extended DEC pragmas, the external name is given using an
489 -- identifier. The As_Is setting is not permitted here (since this would
490 -- create Ada source programs that were case sensitive).
492 External_Name_Exp_Casing : External_Casing_Type := As_Is;
494 -- The setting of this flag determines the casing of an external name
495 -- specified explicitly with a string literal. As_Is means the string
496 -- literal is used as given with no modification to the casing. If
497 -- Lowercase or Uppercase is set, then the string is forced to all
498 -- lowercase or all uppercase letters as appropriate. Note that this
499 -- setting has no effect if the external name is given using an identifier
500 -- in the case of extended DEC import/export pragmas (in this case the
501 -- casing is controlled by External_Name_Imp_Casing), and also has no
502 -- effect if an explicit Link_Name is supplied (a link name is always
503 -- used exactly as given).
505 External_Unit_Compilation_Allowed : Boolean := False;
507 -- When True (set by gnatmake switch -x), allow compilation of sources
508 -- that are not part of any project file.
510 Fast_Math : Boolean := False;
512 -- Indicates the current setting of Fast_Math mode, as set by the use
513 -- of a Fast_Math pragma (set on by Fast_Math (On)).
515 Float_Format : Character := ' ';
517 -- A non-blank value indicates that a Float_Format pragma has been
518 -- processed, in which case this variable is set to 'I' for IEEE or
519 -- to 'V' for VAX. The setting of 'V' is only possible on OpenVMS
522 Float_Format_Long : Character := ' ';
524 -- A non-blank value indicates that a Long_Float pragma has been
525 -- processed (this pragma is recognized only in OpenVMS versions
526 -- of GNAT), in which case this variable is set to D or G for
527 -- D_Float or G_Float.
529 Force_ALI_Tree_File : Boolean := False;
531 -- Force generation of ALI file even if errors are encountered.
532 -- Also forces generation of tree file if -gnatt is also set.
534 Force_Checking_Of_Elaboration_Flags : Boolean := False;
536 -- True if binding with forced checking of the elaboration flags
539 Force_Compilations : Boolean := False;
540 -- GNATMAKE, GPRMAKE, GPRBUILD
541 -- Set to force recompilations even when the objects are up-to-date.
543 Full_Path_Name_For_Brief_Errors : Boolean := False;
545 -- When True, in Brief_Output mode, each error message line
546 -- will start with the full path name of the source.
547 -- When False, only the file name without directory information
550 Full_List : Boolean := False;
552 -- Set True to generate full source listing with embedded errors
554 Full_List_File_Name : String_Ptr := null;
556 -- Set to file name to generate full source listing to named file (or if
557 -- the name is of the form .xxx, then to name.xxx where name is the source
558 -- file name with extension stripped.
560 Generate_Processed_File : Boolean := False;
562 -- True when switch -gnateG is used. When True, create in a file
563 -- <source>.prep, if the source is preprocessed.
565 Generate_SCO : Boolean := False;
567 -- True when switch -gnateS is used. When True, Source Coverage Obligation
568 -- (SCO) information is generated and output in the ALI file. See unit
569 -- Par_SCO for full details.
571 Generating_Code : Boolean := False;
573 -- True if the frontend finished its work and has called the backend to
574 -- process the tree and generate the object file.
576 Global_Discard_Names : Boolean := False;
578 -- True if a pragma Discard_Names appeared as a configuration pragma for
579 -- the current compilation unit.
581 GNAT_Mode : Boolean := False;
583 -- True if compiling in GNAT system mode (-gnatg switch)
585 HLO_Active : Boolean := False;
587 -- True if High Level Optimizer is activated (-gnatH switch)
589 Identifier_Character_Set : Character;
591 -- This variable indicates the character set to be used for identifiers.
592 -- The possible settings are:
593 -- '1' Latin-5 (ISO-8859-1)
594 -- '2' Latin-5 (ISO-8859-2)
595 -- '3' Latin-5 (ISO-8859-3)
596 -- '4' Latin-5 (ISO-8859-4)
597 -- '5' Latin-5 (ISO-8859-5, Cyrillic)
598 -- '9' Latin-5 (ISO-8859-9)
599 -- 'p' PC (US, IBM page 437)
600 -- '8' PC (European, IBM page 850)
601 -- 'f' Full upper set (all distinct)
602 -- 'n' No upper characters (Ada 83 rules)
603 -- 'w' Latin-1 plus wide characters allowed in identifiers
605 -- The setting affects the set of letters allowed in identifiers and the
606 -- upper/lower case equivalences. It does not affect the interpretation of
607 -- character and string literals, which are always stored using the actual
608 -- coding in the source program. This variable is initialized to the
609 -- default value appropriate to the system (in Osint.Initialize), and then
610 -- reset if a command line switch is used to change the setting.
612 Ignore_Rep_Clauses : Boolean := False;
614 -- Set True to ignore all representation clauses. Useful when compiling
615 -- code from foreign compilers for checking or ASIS purposes. Can be
616 -- set True by use of -gnatI.
618 Implementation_Unit_Warnings : Boolean := True;
620 -- Set True to active warnings for use of implementation internal units.
621 -- Can be controlled by use of -gnatwi/-gnatwI.
623 Implicit_Packing : Boolean := False;
625 -- If set True, then a Size attribute clause on an array is allowed to
626 -- cause implicit packing instead of generating an error message. Set by
627 -- use of pragma Implicit_Packing.
629 Ineffective_Inline_Warnings : Boolean := False;
631 -- Set True to activate warnings if front-end inlining (-gnatN) is not
632 -- able to actually inline a particular call (or all calls). Can be
633 -- controlled by use of -gnatwp/-gnatwP.
635 Init_Or_Norm_Scalars : Boolean := False;
637 -- Set True if a pragma Initialize_Scalars applies to the current unit.
638 -- Also set True if a pragma Normalize_Scalars applies.
640 Initialize_Scalars : Boolean := False;
642 -- Set True if a pragma Initialize_Scalars applies to the current unit.
643 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
645 Initialize_Scalars_Mode1 : Character := 'I';
646 Initialize_Scalars_Mode2 : Character := 'N';
648 -- Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
649 -- is IN (invalid values), used if no -S switch is used.
651 Inline_Active : Boolean := False;
653 -- Set True to activate pragma Inline processing across modules. Default
654 -- for now is not to inline across module boundaries.
656 Interface_Library_Unit : Boolean := False;
658 -- Set to True to indicate that at least one ALI file is an interface ALI:
659 -- then elaboration flag checks are to be generated in the binder
662 Generate_SCIL : Boolean := False;
664 -- Set True to activate SCIL code generation.
666 Invalid_Value_Used : Boolean := False;
668 -- Set True if a valid Invalid_Value attribute is encountered
670 Follow_Links_For_Files : Boolean := False;
672 -- Set to True (-eL) to process the project files in trusted mode. If
673 -- Follow_Links is False, it is assumed that the project doesn't contain
674 -- any file duplicated through symbolic links (although the latter are
675 -- still valid if they point to a file which is outside of the project),
676 -- and that no directory has a name which is a valid source name.
678 Follow_Links_For_Dirs : Boolean := False;
680 -- Set to True if directories can be links in this project, and therefore
681 -- additional system calls must be performed to ensure that we always see
682 -- the same full name for each directory.
684 Front_End_Inlining : Boolean := False;
686 -- Set True to activate inlining by front-end expansion
688 Inline_Processing_Required : Boolean := False;
690 -- Set True if inline processing is required. Inline processing is required
691 -- if an active Inline pragma is processed. The flag is set for a pragma
692 -- Inline or Inline_Always that is actually active.
694 In_Place_Mode : Boolean := False;
696 -- Set True to store ALI and object files in place i.e. in the object
697 -- directory if these files already exist or in the source directory
700 Keep_Going : Boolean := False;
701 -- GNATMAKE, GPRMAKE, GPRBUILD
702 -- When True signals to ignore compilation errors and keep processing
703 -- sources until there is no more work.
705 Keep_Temporary_Files : Boolean := False;
707 -- When True the temporary files created by the GNAT driver are not
708 -- deleted. Set by switch -dn or qualifier /KEEP_TEMPORARY_FILES.
710 Leap_Seconds_Support : Boolean := False;
712 -- Set to True to enable leap seconds support in Ada.Calendar and its
715 Link_Only : Boolean := False;
716 -- GNATMAKE, GPRMAKE, GPRBUILD
717 -- Set to True to skip compile and bind steps (except when Bind_Only is
720 List_Restrictions : Boolean := False;
722 -- Set to True to list restrictions pragmas that could apply to partition
724 List_Units : Boolean := False;
726 -- List units in the active library for a compilation (-gnatu switch)
728 List_Closure : Boolean := False;
730 -- List all sources in the closure of a main (-R gnatbind switch)
732 List_Dependencies : Boolean := False;
734 -- When True gnatmake verifies that the objects are up to date and
735 -- outputs the list of object dependencies (-M switch).
736 -- Output depends if -a switch is used or not.
737 -- This list can be used directly in a Makefile.
739 List_Representation_Info : Int range 0 .. 3 := 0;
741 -- Set non-zero by -gnatR switch to list representation information.
742 -- The settings are as follows:
744 -- 0 = no listing of representation information (default as above)
745 -- 1 = list rep info for user defined record and array types
746 -- 2 = list rep info for all user defined types and objects
747 -- 3 = like 2, but variable fields are decoded symbolically
749 List_Representation_Info_To_File : Boolean := False;
751 -- Set true by -gnatRs switch. Causes information from -gnatR/1/2/3 to be
752 -- written to file.rep (where file is the name of the source file) instead
753 -- of stdout. For example, if file x.adb is compiled using -gnatR2s then
754 -- representation info is written to x.adb.ref.
756 List_Representation_Info_Mechanisms : Boolean := False;
758 -- Set true by -gnatRm switch. Causes information on mechanisms to be
759 -- included in the representation output information.
761 List_Preprocessing_Symbols : Boolean := False;
763 -- Set to True if symbols for preprocessing a source are to be listed
764 -- before preprocessing occurs. Set to True by switch -s of gnatprep or
765 -- -s in preprocessing data file for the compiler.
767 type Create_Repinfo_File_Proc is access procedure (Src : String);
768 type Write_Repinfo_Line_Proc is access procedure (Info : String);
769 type Close_Repinfo_File_Proc is access procedure;
770 -- Types used for procedure addresses below
772 Create_Repinfo_File_Access : Create_Repinfo_File_Proc := null;
773 Write_Repinfo_Line_Access : Write_Repinfo_Line_Proc := null;
774 Close_Repinfo_File_Access : Close_Repinfo_File_Proc := null;
776 -- These three locations are left null when operating in non-compiler (e.g.
777 -- ASIS mode), but when operating in compiler mode, they are set to point
778 -- to the three corresponding procedures in Osint-C. The reason for this
779 -- slightly strange interface is to stop Repinfo from dragging in Osint in
780 -- ASIS mode, which would include lots of unwanted units in the ASIS build.
782 type Create_List_File_Proc is access procedure (S : String);
783 type Write_List_Info_Proc is access procedure (S : String);
784 type Close_List_File_Proc is access procedure;
785 -- Types used for procedure addresses below
787 Create_List_File_Access : Create_List_File_Proc := null;
788 Write_List_Info_Access : Write_List_Info_Proc := null;
789 Close_List_File_Access : Close_List_File_Proc := null;
791 -- These three locations are left null when operating in non-compiler
792 -- (e.g. from the binder), but when operating in compiler mode, they are
793 -- set to point to the three corresponding procedures in Osint-C. The
794 -- reason for this slightly strange interface is to prevent Repinfo
795 -- from dragging in Osint-C in the binder, which would include unwanted
796 -- units in the binder.
798 Locking_Policy : Character := ' ';
800 -- Set to ' ' for the default case (no locking policy specified). Reset to
801 -- first character (uppercase) of locking policy name if a valid pragma
802 -- Locking_Policy is encountered.
804 Locking_Policy_Sloc : Source_Ptr := No_Location;
806 -- Remember location of previous Locking_Policy pragma. This is used for
807 -- inconsistency error messages. A value of System_Location is used if the
808 -- policy is set in package System.
810 Look_In_Primary_Dir : Boolean := True;
811 -- GNAT, GNATBIND, GNATMAKE, GNATCLEAN
812 -- Set to False if a -I- was present on the command line. When True we are
813 -- allowed to look in the primary directory to locate other source or
816 Make_Steps : Boolean := False;
818 -- Set to True when either Compile_Only, Bind_Only or Link_Only is
821 Main_Index : Int := 0;
823 -- This is set to non-zero by gnatmake switch -eInnn to indicate that
824 -- the main program is the nnn unit in a multi-unit source file.
826 Mapping_File_Name : String_Ptr := null;
828 -- File name of mapping between unit names, file names and path names.
829 -- (given by switch -gnatem)
831 Maximum_Messages : Int := 9999;
833 -- Maximum default number of errors before compilation is terminated, or in
834 -- the case of GNAT, maximum number of warnings before further warnings are
835 -- suppressed. Can be overridden by -gnatm (GNAT) or -m (GNATBIND) switch.
837 Maximum_File_Name_Length : Int;
839 -- Maximum number of characters allowed in a file name, not counting the
840 -- extension, as set by the appropriate switch. If no switch is given,
841 -- then this value is initialized by Osint to the appropriate value.
843 Maximum_Processes : Positive := 1;
844 -- GNATMAKE, GPRMAKE, GPRBUILD
845 -- Maximum number of processes that should be spawned to carry out
848 Minimal_Recompilation : Boolean := False;
850 -- Set to True if minimal recompilation mode requested
852 Special_Exception_Package_Used : Boolean := False;
854 -- Set to True if either of the unit GNAT.Most_Recent_Exception or
855 -- GNAT.Exception_Traces is with'ed. Used to inhibit transformation of
856 -- local raise statements into gotos in the presence of either package.
858 Multiple_Unit_Index : Int;
860 -- This is set non-zero if the current unit is being compiled in multiple
861 -- unit per file mode, meaning that the current unit is selected from the
862 -- sequence of units in the current source file, using the value stored
863 -- in this variable (e.g. 2 = select second unit in file). A value of
864 -- zero indicates that we are in normal (one unit per file) mode.
866 No_Main_Subprogram : Boolean := False;
867 -- GNATMAKE, GNATBIND
868 -- Set to True if compilation/binding of a program without main
869 -- subprogram requested.
871 No_Run_Time_Mode : Boolean := False;
873 -- This flag is set True if a No_Run_Time pragma is encountered. See
874 -- spec of Rtsfind for a full description of handling of this pragma.
876 No_Split_Units : Boolean := False;
878 -- Set to True with switch --no-split-units. When True, unit sources, spec,
879 -- body and subunits, must all be in the same project.This is checked after
882 No_Stdinc : Boolean := False;
883 -- GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
884 -- Set to True if no default source search dirs added to search list
886 No_Stdlib : Boolean := False;
887 -- GNATMAKE, GNATBIND, GNATFIND, GNATXREF
888 -- Set to True if no default library search dirs added to search list
890 No_Strict_Aliasing : Boolean := False;
892 -- Set True if pragma No_Strict_Aliasing with no parameters encountered
894 Normalize_Scalars : Boolean := False;
896 -- Set True if a pragma Normalize_Scalars applies to the current unit.
897 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
899 Object_Directory_Present : Boolean := False;
901 -- Set to True when an object directory is specified with option -D
903 type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
904 Operating_Mode : Operating_Mode_Type := Generate_Code;
906 -- Indicates the operating mode of the compiler. The default is generate
907 -- code, which runs the parser, semantics and backend. Switches can be
908 -- used to set syntax checking only mode, or syntax and semantics checking
909 -- only mode. Operating_Mode can also be modified as a result of detecting
910 -- errors during the compilation process. In particular if any serious
911 -- error is detected then this flag is reset from Generate_Code to
912 -- Check_Semantics after generating an error message.
914 Optimize_Alignment : Character := 'O';
915 -- Setting of Optimize_Alignment, set to T/S/O for time/space/off. Can
916 -- be modified by use of pragma Optimize_Alignment.
918 Optimize_Alignment_Local : Boolean := False;
919 -- Set True if Optimize_Alignment mode is set by a local configuration
920 -- pragma that overrides the gnat.adc (or other configuration file) default
921 -- so that the unit is not dependent on the default setting. Also always
922 -- set True for internal units, since these always have a default setting
923 -- of Optimize_Alignment (Off) that is enforced (essentially equivalent to
924 -- them all having such an explicit pragma in each unit).
926 Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
928 -- Indicates the original operating mode of the compiler as set by compiler
929 -- options. This is identical to Operating_Mode except that this is not
930 -- affected by errors.
932 Optimization_Level : Int;
933 pragma Import (C, Optimization_Level, "optimize");
934 -- Constant reflecting the optimization level (0,1,2,3 for -O0,-O1,-O2,-O3)
935 -- See jmissing.c and aamissing.c for definitions for dotnet/jgnat and
939 pragma Import (C, Optimize_Size, "optimize_size");
940 -- Constant reflecting setting of -Os (optimize for size). Set to nonzero
941 -- in -Os mode and set to zero otherwise. See jmissing.c and aamissing.c
942 -- for definitions of "optimize_size" for dotnet/jgnat and GNAAMP backends
944 Output_File_Name_Present : Boolean := False;
945 -- GNATBIND, GNAT, GNATMAKE, GPRMAKE
946 -- Set to True when the output C file name is given with option -o for
947 -- GNATBIND, when the object file name is given with option -gnatO for GNAT
948 -- or when the executable is given with option -o for GNATMAKE or GPRMAKE.
950 Output_Linker_Option_List : Boolean := False;
952 -- True if output of list of linker options is requested (-K switch set)
954 Output_ALI_List : Boolean := False;
955 ALI_List_Filename : String_Ptr;
957 -- True if output of list of ALIs is requested (-A switch set). List is
958 -- output under the given filename, or standard output if not specified.
960 Output_Object_List : Boolean := False;
961 Object_List_Filename : String_Ptr;
963 -- True if output of list of objects is requested (-O switch set). List is
964 -- output under the given filename, or standard output if not specified.
966 Overflow_Checks_Unsuppressed : Boolean := False;
968 -- Set to True if at least one occurrence of pragma Unsuppress
969 -- (All_Checks|Overflow_Checks) has been processed.
971 Persistent_BSS_Mode : Boolean := False;
973 -- True if a Persistent_BSS configuration pragma is in effect, causing
974 -- potentially persistent data to be placed in the persistent_bss section.
976 Pessimistic_Elab_Order : Boolean := False;
978 -- True if pessimistic elaboration order is to be chosen (-p switch set)
980 Polling_Required : Boolean := False;
982 -- Set to True if polling for asynchronous abort is enabled by using
983 -- the -gnatP option for GNAT.
985 Preprocessing_Data_File : String_Ptr := null;
987 -- Set by switch -gnatep=. The file name of the preprocessing data file.
989 Print_Generated_Code : Boolean := False;
991 -- Set to True to enable output of generated code in source form. This
992 -- flag is set by the -gnatG switch.
994 Print_Standard : Boolean := False;
996 -- Set to true to enable printing of package standard in source form.
997 -- This flag is set by the -gnatS switch
999 Propagate_Exceptions : Boolean := False;
1001 -- Indicates if subprogram descriptor exception tables should be
1002 -- built for imported subprograms. Set True if a Propagate_Exceptions
1003 -- pragma applies to the extended main unit.
1005 type Usage is (Unknown, Not_In_Use, In_Use);
1006 Project_File_In_Use : Usage := Unknown;
1008 -- Indicates if a project file is used or not. Set to In_Use by the first
1011 Queuing_Policy : Character := ' ';
1013 -- Set to ' ' for the default case (no queuing policy specified). Reset to
1014 -- first character (uppercase) of locking policy name if a valid
1015 -- Queuing_Policy pragma is encountered.
1017 Queuing_Policy_Sloc : Source_Ptr := No_Location;
1019 -- Remember location of previous Queuing_Policy pragma. This is used for
1020 -- inconsistency error messages. A value of System_Location is used if the
1021 -- policy is set in package System.
1023 Quiet_Output : Boolean := False;
1024 -- GNATMAKE, GNATCLEAN, GPRMAKE, GPRBUILD, GPRCLEAN
1025 -- Set to True if the tool should not have any output if there are no
1026 -- errors or warnings.
1028 Replace_In_Comments : Boolean := False;
1030 -- Set to True if -C switch used
1032 RTS_Lib_Path_Name : String_Ptr := null;
1033 RTS_Src_Path_Name : String_Ptr := null;
1035 -- Set to the "adalib" and "adainclude" directories of the run time
1036 -- specified by --RTS=.
1038 RTS_Switch : Boolean := False;
1039 -- GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
1040 -- Set to True when the --RTS switch is set
1042 Run_Path_Option : Boolean := True;
1043 -- GNATMAKE, GNATLINK
1044 -- Set to False when no run_path_option should be issued to the linker
1046 Search_Directory_Present : Boolean := False;
1048 -- Set to True when argument is -I. Reset to False when next argument, a
1049 -- search directory path is taken into account. Note that this is quite
1050 -- different from other switches in this section in that it is only set in
1051 -- a transitory manner as a result of scanning a -I switch with no file
1052 -- name, and if set, is an indication that the next argument is to be
1053 -- treated as a file name.
1055 Sec_Stack_Used : Boolean := False;
1057 -- Set True if generated code uses the System.Secondary_Stack package. For
1058 -- the binder, set if any unit uses the secondary stack package.
1060 Setup_Projects : Boolean := False;
1062 -- Set to True for GNAT SETUP: the Project Manager creates non existing
1063 -- object, library and exec directories.
1065 Shared_Libgnat : Boolean;
1067 -- Set to True if a shared libgnat is requested by using the -shared option
1068 -- for GNATBIND and to False when using the -static option. The value of
1069 -- this flag is set by Gnatbind.Scan_Bind_Arg.
1071 Short_Circuit_And_Or : Boolean := False;
1073 -- Set True if a pragma Short_Circuit_And_Or applies to the current unit.
1075 Sprint_Line_Limit : Nat := 72;
1076 -- Limit values for chopping long lines in Sprint output, can be reset
1077 -- by use of NNN parameter with -gnatG or -gnatD switches.
1079 Stack_Checking_Enabled : Boolean;
1081 -- Set to indicate if -fstack-check switch is set for the compilation. True
1082 -- means that the switch is set, so that stack checking is enabled. False
1083 -- means that the switch is not set (no stack checking). This value is
1084 -- obtained from the external imported value flag_stack_check in the gcc
1085 -- backend (see Frontend) and may be referenced throughout the compilation
1088 Style_Check : Boolean := False;
1090 -- Set True to perform style checks. Activates checks carried out in
1091 -- package Style (see body of this package for details of checks) This
1092 -- flag is set True by either the -gnatg or -gnaty switches.
1094 Suppress_All_Inlining : Boolean := False;
1096 -- Set by -fno-inline. Suppresses all inlining, both front end and back end
1097 -- regardless of any other switches that are set.
1099 Suppress_Control_Flow_Optimizations : Boolean := False;
1101 -- Set by -fpreserve-control-flow. Suppresses control flow optimizations
1102 -- that interfere with coverage analysis based on the object code.
1104 System_Extend_Pragma_Arg : Node_Id := Empty;
1106 -- Set non-empty if and only if a correct Extend_System pragma was present
1107 -- in which case it points to the argument of the pragma, and the name can
1108 -- be located as Chars (Expression (System_Extend_Pragma_Arg)).
1110 System_Extend_Unit : Node_Id := Empty;
1112 -- This is set to Empty if GNAT_Mode is set, since pragma Extend_System
1113 -- is never appropriate in GNAT_Mode (and causes troubles, including
1114 -- bogus circularities, if we try to compile the run-time library with
1115 -- a System extension). If GNAT_Mode is not set, then System_Extend_Unit
1116 -- is a copy of the value set in System_Extend_Pragma_Arg.
1118 Subunits_Missing : Boolean := False;
1120 -- This flag is set true if missing subunits are detected with code
1121 -- generation active. This causes code generation to be skipped.
1123 Suppress_Checks : Boolean := False;
1125 -- Set to True if -gnatp (suppress all checks) switch present.
1127 Suppress_Options : Suppress_Array;
1129 -- Flags set True to suppress corresponding check, i.e. add an implicit
1130 -- pragma Suppress at the outer level of each unit compiled. Note that
1131 -- these suppress actions can be overridden by the use of the Unsuppress
1132 -- pragma. This variable is initialized by Osint.Initialize.
1134 Suppress_Back_Annotation : Boolean := False;
1136 -- This flag is set True if back annotation of representation information
1137 -- is to be suppressed. This is set if neither -gnatt or -gnatR0-3 is set.
1138 -- This avoids unnecessary time being spent on back annotation.
1140 Table_Factor : Int := 1;
1142 -- Factor by which all initial table sizes set in Alloc are multiplied.
1143 -- Used in Table to calculate initial table sizes (the initial table size
1144 -- is the value in Alloc, used as the Table_Initial parameter value,
1145 -- multiplied by the factor given here. The default value is used if no
1146 -- -gnatT switch appears.
1148 Tagged_Type_Expansion : Boolean := True;
1150 -- Set True if tagged types and interfaces should be expanded by the
1151 -- front-end. If False, the original tree is left unexpanded for tagged
1152 -- types and dispatching calls, assuming the underlying target supports
1153 -- it (e.g. in the JVM case).
1155 Task_Dispatching_Policy : Character := ' ';
1157 -- Set to ' ' for the default case (no task dispatching policy specified).
1158 -- Reset to first character (uppercase) of task dispatching policy name
1159 -- if a valid Task_Dispatching_Policy pragma is encountered.
1161 Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
1163 -- Remember location of previous Task_Dispatching_Policy pragma. This is
1164 -- used for inconsistency error messages. A value of System_Location is
1165 -- used if the policy is set in package System.
1167 Tasking_Used : Boolean := False;
1168 -- Set True if any tasking construct is encountered. Used to activate the
1169 -- output of the Q, L and T lines in ALI files.
1171 Time_Slice_Set : Boolean := False;
1173 -- Set True if a pragma Time_Slice is processed in the main unit, or
1174 -- if the -gnatTnn switch is present to set a time slice value.
1176 Time_Slice_Value : Nat;
1178 -- Time slice value. Valid only if Time_Slice_Set is True, i.e. if
1179 -- Time_Slice pragma has been processed. Set to the time slice value in
1180 -- microseconds. Negative values are stored as zero, and the value is not
1181 -- larger than 1_000_000_000 (1000 seconds). Values larger than this are
1182 -- reset to this maximum. This can also be set with the -gnatTnn switch.
1184 Tolerate_Consistency_Errors : Boolean := False;
1186 -- Tolerate time stamp and other consistency errors. If this flag is set to
1187 -- True (-t), then inconsistencies result in warnings rather than errors.
1189 Treat_Restrictions_As_Warnings : Boolean := False;
1191 -- Set True to treat pragma Restrictions as Restriction_Warnings. Set by
1194 Tree_Output : Boolean := False;
1196 -- Set to True (-gnatt) to generate output tree file
1198 True_VMS_Target : Boolean := False;
1199 -- Set True if we are on a VMS target. The setting of this flag reflects
1200 -- the true state of the compile, unlike Targparm.OpenVMS_On_Target which
1201 -- can also be true when debug flag m is set (-gnatdm). This is used in the
1202 -- few cases where we do NOT want -gnatdm to trigger the VMS behavior.
1204 Try_Semantics : Boolean := False;
1206 -- Flag set to force attempt at semantic analysis, even if parser errors
1207 -- occur. This will probably cause blowups at this stage in the game. On
1208 -- the other hand, most such blowups will be caught cleanly and simply
1209 -- say compilation abandoned. This flag is set to True by -gnatq or -gnatQ.
1211 Unchecked_Shared_Lib_Imports : Boolean := False;
1213 -- Set to True when shared library projects are allowed to import projects
1214 -- that are not shared library projects. Set by switch
1215 -- --unchecked-shared-lib-imports.
1217 Undefined_Symbols_Are_False : Boolean := False;
1219 -- Set to True by switch -u of gnatprep or -u in the preprocessing data
1220 -- file for the compiler. Indicates that while preprocessing sources,
1221 -- symbols that are not defined have the value FALSE.
1223 Unique_Error_Tag : Boolean := Tag_Errors;
1225 -- Indicates if error messages are to be prefixed by the string error:
1226 -- Initialized from Tag_Errors, can be forced on with the -gnatU switch.
1228 Universal_Addressing_On_AAMP : Boolean := False;
1230 -- Indicates if library-level objects should be accessed and updated using
1231 -- universal addressing instructions on the AAMP architecture. This flag is
1232 -- set to True when pragma Universal_Data is given as a configuration
1235 Unreserve_All_Interrupts : Boolean := False;
1237 -- Normally set False, set True if a valid Unreserve_All_Interrupts pragma
1238 -- appears anywhere in the main unit for GNAT, or if any ALI file has the
1239 -- corresponding attribute set in GNATBIND.
1241 Upper_Half_Encoding : Boolean := False;
1243 -- Normally set False, indicating that upper half ISO 8859-1 characters are
1244 -- used in the normal way to represent themselves. If the wide character
1245 -- encoding method uses the upper bit for this encoding, then this flag is
1246 -- set True, and upper half characters in the source indicate the start of
1247 -- a wide character sequence. Set by -gnatW or -W switches.
1249 Use_Include_Path_File : Boolean := False;
1250 -- GNATMAKE, GPRBUILD
1251 -- When True, create a source search path file, even when a mapping file
1254 Usage_Requested : Boolean := False;
1255 -- GNAT, GNATBIND, GNATMAKE
1256 -- Set to True if -h (-gnath for the compiler) switch encountered
1257 -- requesting usage information
1259 Use_Expression_With_Actions : Boolean;
1260 -- The N_Expression_With_Actions node has been introduced relatively
1261 -- recently, and not all back ends are prepared to handle it yet. So
1262 -- we use this flag to suppress its use during a transitional period.
1263 -- Currently the default is False for all cases (set in gnat1drv).
1264 -- The default can be modified using -gnatd.X/-gnatd.Y.
1266 Use_Pragma_Linker_Constructor : Boolean := False;
1268 -- True if pragma Linker_Constructor applies to adainit
1270 Use_VADS_Size : Boolean := False;
1272 -- Set to True if a valid pragma Use_VADS_Size is processed
1274 Validity_Checks_On : Boolean := True;
1276 -- This flag determines if validity checking is on or off. The initial
1277 -- state is on, and the required default validity checks are active. The
1278 -- actual set of checks that is performed if Validity_Checks_On is set is
1279 -- defined by the switches in package Validsw. The Validity_Checks_On flag
1280 -- is controlled by pragma Validity_Checks (On | Off), and also some
1281 -- generated compiler code (typically code that has to do with validity
1282 -- check generation) is compiled with this flag set to False. This flag is
1283 -- set to False by the -gnatp switch.
1285 Verbose_Mode : Boolean := False;
1286 -- GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATNAME, GNATCLEAN,
1287 -- GPRMAKE, GPRBUILD, GPRCLEAN
1288 -- Set to True to get verbose mode (full error message text and location
1289 -- information sent to standard output, also header, copyright and summary)
1291 type Verbosity_Level_Type is (None, Low, Medium, High);
1292 Verbosity_Level : Verbosity_Level_Type := High;
1293 -- GNATMAKE, GPRMAKE
1294 -- Modified by gnatmake or gprmake switches -v, -vl, -vm, -vh. Indicates
1295 -- the level of verbosity of informational messages:
1297 -- In Low Verbosity, the reasons why a source is recompiled, the name
1298 -- of the executable and the reason it must be rebuilt is output.
1300 -- In Medium Verbosity, additional lines are output for each ALI file
1303 -- In High Verbosity, additional lines are output when the ALI file
1304 -- is part of an Ada library, is read-only or is part of the runtime.
1306 Warn_On_Ada_2005_Compatibility : Boolean := True;
1308 -- Set to True to generate all warnings on Ada 2005 compatibility issues,
1309 -- including warnings on Ada 2005 obsolescent features used in Ada 2005
1310 -- mode. Set False by -gnatwY.
1312 Warn_On_Parameter_Order : Boolean := False;
1314 -- Set to True to generate warnings for cases where the argument list for
1315 -- a call is a sequence of identifiers that match the formal identifiers,
1316 -- but are in the wrong order.
1318 Warn_On_Assertion_Failure : Boolean := True;
1320 -- Set to True to activate warnings on assertions that can be determined
1321 -- at compile time will always fail. Set false by -gnatw.A.
1323 Warn_On_Assumed_Low_Bound : Boolean := True;
1325 -- Set to True to activate warnings for string parameters that are indexed
1326 -- with literals or S'Length, presumably assuming a lower bound of one. Set
1327 -- False by -gnatwW.
1329 Warn_On_Bad_Fixed_Value : Boolean := False;
1331 -- Set to True to generate warnings for static fixed-point expression
1332 -- values that are not an exact multiple of the small value of the type.
1334 Warn_On_Biased_Representation : Boolean := True;
1336 -- Set to True to generate warnings for size clauses, component clauses
1337 -- and component_size clauses that force biased representation. Set False
1340 Warn_On_Constant : Boolean := False;
1342 -- Set to True to generate warnings for variables that could be declared
1343 -- as constants. Modified by use of -gnatwk/K.
1345 Warn_On_Deleted_Code : Boolean := False;
1347 -- Set to True to generate warnings for code deleted by the front end
1348 -- for conditional statements whose outcome is known at compile time.
1349 -- Modified by use of -gnatwt/T.
1351 Warn_On_Dereference : Boolean := False;
1353 -- Set to True to generate warnings for implicit dereferences for array
1354 -- indexing and record component access. Modified by use of -gnatwd/D.
1356 Warn_On_Export_Import : Boolean := True;
1358 -- Set to True to generate warnings for suspicious use of export or
1359 -- import pragmas. Modified by use of -gnatwx/X.
1361 Warn_On_Hiding : Boolean := False;
1363 -- Set to True to generate warnings if a declared entity hides another
1364 -- entity. The default is that this warning is suppressed.
1366 Warn_On_Modified_Unread : Boolean := False;
1368 -- Set to True to generate warnings if a variable is assigned but is never
1369 -- read. Also controls warnings for similar cases involving out parameters,
1370 -- but only if there is only one out parameter for the procedure involved.
1371 -- The default is that this warning is suppressed.
1373 Warn_On_All_Unread_Out_Parameters : Boolean := False;
1375 -- Set to True to generate warnings in all cases where a variable is
1376 -- modified by being passed as to an OUT formal, but the resulting value is
1377 -- never read. The default is that this warning is suppressed, except in
1380 Warn_On_No_Value_Assigned : Boolean := True;
1382 -- Set to True to generate warnings if no value is ever assigned to a
1383 -- variable that is at least partially uninitialized. Set to false to
1384 -- suppress such warnings. The default is that such warnings are enabled.
1386 Warn_On_Non_Local_Exception : Boolean := False;
1388 -- Set to True to generate warnings for non-local exception raises and also
1389 -- handlers that can never handle a local raise. This warning is only ever
1390 -- generated if pragma Restrictions (No_Exception_Propagation) is set. The
1391 -- default is not to generate the warnings except that if the source has
1392 -- at least one exception handler, and this restriction is set, and the
1393 -- warning was not explicitly turned off, then it is turned on by default.
1395 No_Warn_On_Non_Local_Exception : Boolean := False;
1397 -- This is set to True if the above warning is explicitly suppressed. We
1398 -- use this to avoid turning it on by default when No_Exception_Propagation
1399 -- restriction is set and an exception handler is present.
1401 Warn_On_Obsolescent_Feature : Boolean := False;
1403 -- Set to True to generate warnings on use of any feature in Annex or if a
1404 -- subprogram is called for which a pragma Obsolescent applies.
1406 Warn_On_Overlap : Boolean := False;
1408 -- Set to True to generate warnings when a writable actual which is not
1409 -- a by-copy type overlaps with another actual in a subprogram call.
1411 Warn_On_Questionable_Missing_Parens : Boolean := True;
1413 -- Set to True to generate warnings for cases where parentheses are missing
1414 -- and the usage is questionable, because the intent is unclear.
1416 Warn_On_Redundant_Constructs : Boolean := False;
1418 -- Set to True to generate warnings for redundant constructs (e.g. useless
1419 -- assignments/conversions). The default is that this warning is disabled.
1421 Warn_On_Object_Renames_Function : Boolean := False;
1423 -- Set to True to generate warnings when a function result is renamed as
1424 -- an object. The default is that this warning is disabled.
1426 Warn_On_Reverse_Bit_Order : Boolean := True;
1428 -- Set to True to generate warning (informational) messages for component
1429 -- clauses that are affected by non-standard bit-order. The default is
1430 -- that this warning is enabled.
1432 Warn_On_Suspicious_Modulus_Value : Boolean := True;
1434 -- Set to True to generate warnings for suspicious modulus values. The
1435 -- default is that this warning is enabled.
1437 Warn_On_Unchecked_Conversion : Boolean := True;
1439 -- Set to True to generate warnings for unchecked conversions that may have
1440 -- non-portable semantics (e.g. because sizes of types differ). The default
1441 -- is that this warning is enabled.
1443 Warn_On_Unrecognized_Pragma : Boolean := True;
1445 -- Set to True to generate warnings for unrecognized pragmas. The default
1446 -- is that this warning is enabled.
1448 Warn_On_Unrepped_Components : Boolean := False;
1450 -- Set to True to generate warnings for the case of components of record
1451 -- which have a record representation clause but this component does not
1452 -- have a component clause. The default is that this warning is disabled.
1454 Warn_On_Warnings_Off : Boolean := False;
1456 -- Set to True to generate warnings for use of Pragma Warnings (Off, ent),
1457 -- where either the pragma is never used, or it could be replaced by a
1458 -- pragma Unmodified or Unreferenced.
1460 type Warning_Mode_Type is (Suppress, Normal, Treat_As_Error);
1461 Warning_Mode : Warning_Mode_Type := Normal;
1463 -- Controls treatment of warning messages. If set to Suppress, warning
1464 -- messages are not generated at all. In Normal mode, they are generated
1465 -- but do not count as errors. In Treat_As_Error mode, warning messages
1466 -- are generated and are treated as errors.
1468 Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1470 -- Method used for encoding wide characters in the source program. See
1471 -- description of type in unit System.WCh_Con for a list of the methods
1472 -- that are currently supported. Note that brackets notation is always
1473 -- recognized in source programs regardless of the setting of this
1474 -- variable. The default setting causes only the brackets notation to be
1475 -- recognized. If this is the main unit, this setting also controls the
1476 -- output of the W=? parameter in the ALI file, which is used to provide
1477 -- the default for encoding [Wide_[Wide_]]Text_IO files. For the binder,
1478 -- the value set here overrides this main unit default.
1480 Wide_Character_Encoding_Method_Specified : Boolean := False;
1482 -- Set True if the value in Wide_Character_Encoding_Method was set as
1483 -- a result of an explicit -gnatW? or -W? switch. False otherwise.
1485 Xref_Active : Boolean := True;
1487 -- Set if cross-referencing is enabled (i.e. xref info in ALI files)
1489 Zero_Formatting : Boolean := False;
1491 -- Do no formatting (no title, no leading spaces, no empty lines) in
1492 -- auxiliary outputs (-e, -K, -l, -R).
1494 ----------------------------
1495 -- Configuration Settings --
1496 ----------------------------
1498 -- These are settings that are used to establish the mode at the start of
1499 -- each unit. The values defined below can be affected either by command
1500 -- line switches, or by the use of appropriate configuration pragmas in a
1501 -- configuration pragma file.
1503 Ada_Version_Config : Ada_Version_Type;
1505 -- This is the value of the configuration switch for the Ada 83 mode, as
1506 -- set by the command line switches -gnat83/95/05, and possibly modified by
1507 -- the use of configuration pragmas Ada_83/Ada95/Ada05. This switch is used
1508 -- to set the initial value for Ada_Version mode at the start of analysis
1509 -- of a unit. Note however, that the setting of this flag is ignored for
1510 -- internal and predefined units (which are always compiled in the most up
1511 -- to date version of Ada).
1513 Ada_Version_Explicit_Config : Ada_Version_Type;
1515 -- This is set in the same manner as Ada_Version_Config. The difference is
1516 -- that the setting of this flag is not ignored for internal and predefined
1517 -- units, which for some purposes do indeed access this value, regardless
1518 -- of the fact that they are compiled the most up to date ada version).
1520 Assertions_Enabled_Config : Boolean;
1522 -- This is the value of the configuration switch for assertions enabled
1523 -- mode, as possibly set by the command line switch -gnata, and possibly
1524 -- modified by the use of the configuration pragma Assertion_Policy.
1526 Assume_No_Invalid_Values_Config : Boolean;
1528 -- This is the value of the configuration switch for assuming "no invalid
1529 -- values enabled" mode, as possibly set by the command line switch
1530 -- -gnatB, and possibly modified by the use of the configuration pragma
1531 -- Assume_No_Invalid_Values.
1533 Check_Policy_List_Config : Node_Id;
1535 -- This points to the list of N_Pragma nodes for Check_Policy pragmas
1536 -- that are linked through the Next_Pragma fields, with the list being
1537 -- terminated by Empty. The order is most recently processed first. This
1538 -- list includes only those pragmas in configuration pragma files.
1540 Debug_Pragmas_Enabled_Config : Boolean;
1542 -- This is the value of the configuration switch for debug pragmas enabled
1543 -- mode, as possibly set by the command line switch -gnata and possibly
1544 -- modified by the use of the configuration pragma Debug_Policy.
1546 Dynamic_Elaboration_Checks_Config : Boolean := False;
1548 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
1549 -- switch or by the use of pragma Elaboration_Checking (Dynamic).
1551 Exception_Locations_Suppressed_Config : Boolean := False;
1553 -- Set True by use of the configuration pragma Suppress_Exception_Messages
1555 Extensions_Allowed_Config : Boolean;
1557 -- This is the flag that indicates whether extensions are allowed. It can
1558 -- be set True either by use of the -gnatX switch, or by use of the
1559 -- configuration pragma Extensions_Allowed (On). It is always set to True
1560 -- for internal GNAT units, since extensions are always permitted in such
1563 External_Name_Exp_Casing_Config : External_Casing_Type;
1565 -- This is the value of the configuration switch that controls casing of
1566 -- external symbols for which an explicit external name is given. It can be
1567 -- set to Uppercase by the command line switch -gnatF, and further modified
1568 -- by the use of the configuration pragma External_Name_Casing in the
1569 -- gnat.adc file. This flag is used to set the initial value for
1570 -- External_Name_Exp_Casing at the start of analyzing each unit. Note
1571 -- however that the setting of this flag is ignored for internal and
1572 -- predefined units (which are always compiled with As_Is mode).
1574 External_Name_Imp_Casing_Config : External_Casing_Type;
1576 -- This is the value of the configuration switch that controls casing of
1577 -- external symbols where the external name is implicitly given. It can be
1578 -- set to Uppercase by the command line switch -gnatF, and further modified
1579 -- by the use of the configuration pragma External_Name_Casing in the
1580 -- gnat.adc file. This flag is used to set the initial value for
1581 -- External_Name_Imp_Casing at the start of analyzing each unit. Note
1582 -- however that the setting of this flag is ignored for internal and
1583 -- predefined units (which are always compiled with Lowercase mode).
1585 Fast_Math_Config : Boolean;
1587 -- This is the value of the configuration switch that controls Fast_Math
1588 -- mode, as set by a Fast_Math pragma in configuration pragmas. It is
1589 -- used to set the initial value of Fast_Math at the start of each new
1590 -- compilation unit.
1592 Init_Or_Norm_Scalars_Config : Boolean;
1594 -- This is the value of the configuration switch that is set by one
1595 -- of the pragmas Initialize_Scalars or Normalize_Scalars.
1597 Initialize_Scalars_Config : Boolean;
1599 -- This is the value of the configuration switch that is set by the
1600 -- pragma Initialize_Scalars when it appears in the gnat.adc file.
1601 -- This switch is not set when the pragma appears ahead of a given
1602 -- unit, so it does not affect the compilation of other units.
1604 Optimize_Alignment_Config : Character;
1606 -- This is the value of the configuration switch that controls the
1607 -- alignment optimization mode, as set by an Optimize_Alignment pragma.
1608 -- It is used to set the initial value of Optimize_Alignment at the start
1609 -- of each new compilation unit, except that it is always set to 'O' (off)
1610 -- for internal units.
1612 Persistent_BSS_Mode_Config : Boolean;
1614 -- This is the value of the configuration switch that controls whether
1615 -- potentially persistent data is to be placed in the persistent_bss
1616 -- section. It can be set True by use of the pragma Persistent_BSS.
1617 -- This flag is used to set the initial value of Persistent_BSS_Mode
1618 -- at the start of each compilation unit, except that it is always
1619 -- set False for predefined units.
1621 Polling_Required_Config : Boolean;
1623 -- This is the value of the configuration switch that controls polling
1624 -- mode. It can be set True by the command line switch -gnatP, and then
1625 -- further modified by the use of pragma Polling in the gnat.adc file. This
1626 -- flag is used to set the initial value for Polling_Required at the start
1627 -- of analyzing each unit.
1629 Use_VADS_Size_Config : Boolean;
1631 -- This is the value of the configuration switch that controls the use of
1632 -- VADS_Size instead of Size wherever the attribute Size is used. It can
1633 -- be set True by the use of the pragma Use_VADS_Size in the gnat.adc file.
1634 -- This flag is used to set the initial value for Use_VADS_Size at the
1635 -- start of analyzing each unit. Note however that the setting of this flag
1636 -- is ignored for internal and predefined units (which are always compiled
1637 -- with the standard Size semantics).
1639 type Config_Switches_Type is private;
1640 -- Type used to save values of the switches set from Config values
1642 procedure Save_Opt_Config_Switches (Save : out Config_Switches_Type);
1643 -- This procedure saves the current values of the switches which are
1644 -- initialized from the above Config values, and then resets these switches
1645 -- according to the Config value settings.
1647 procedure Set_Opt_Config_Switches
1648 (Internal_Unit : Boolean;
1649 Main_Unit : Boolean);
1650 -- This procedure sets the switches to the appropriate initial values. The
1651 -- parameter Internal_Unit is True for an internal or predefined unit, and
1652 -- affects the way the switches are set (see above). Main_Unit is true if
1653 -- switches are being set for the main unit (this affects setting of the
1654 -- assert/debug pragma switches, which are normally set false by default
1655 -- for an internal unit, except when the internal unit is the main unit,
1656 -- in which case we use the command line settings).
1658 procedure Restore_Opt_Config_Switches (Save : Config_Switches_Type);
1659 -- This procedure restores a set of switch values previously saved by a
1660 -- call to Save_Opt_Switches.
1662 procedure Register_Opt_Config_Switches;
1663 -- This procedure is called after processing the gnat.adc file and other
1664 -- configuration pragma files to record the values of the Config switches,
1665 -- as possibly modified by the use of command line switches and pragmas
1666 -- appearing in these files.
1668 ------------------------
1669 -- Other Global Flags --
1670 ------------------------
1672 Expander_Active : Boolean := False;
1673 -- A flag that indicates if expansion is active (True) or deactivated
1674 -- (False). When expansion is deactivated all calls to expander routines
1675 -- have no effect. Note that the initial setting of False is merely to
1676 -- prevent saving of an undefined value for an initial call to the
1677 -- Expander_Mode_Save_And_Set procedure. For more information on the use of
1678 -- this flag, see package Expander. Indeed this flag might more logically
1679 -- be in the spec of Expander, but it is referenced by Errout, and it
1680 -- really seems wrong for Errout to depend on Expander.
1682 Static_Dispatch_Tables : Boolean := True;
1683 -- This flag indicates if the backend supports generation of statically
1684 -- allocated dispatch tables. If it is True, then the front end will
1685 -- generate static aggregates for dispatch tables that contain forward
1686 -- references to addresses of subprograms not seen yet, and the back end
1687 -- must be prepared to handle this case. If it is False, then the front
1688 -- end generates assignments to initialize the dispatch table, and there
1689 -- are no such forward references. By default we build statically allocated
1690 -- dispatch tables for all library level tagged types in all platforms.This
1691 -- behavior can be disabled using switch -gnatd.t which will set this flag
1692 -- to False and revert to the previous dynamic behavior.
1694 -----------------------
1695 -- Tree I/O Routines --
1696 -----------------------
1698 procedure Tree_Read;
1699 -- Reads switch settings from current tree file using Tree_Read
1701 procedure Tree_Write;
1702 -- Writes out switch settings to current tree file using Tree_Write
1704 --------------------------
1705 -- ASIS Version Control --
1706 --------------------------
1708 -- These two variables (Tree_Version_String and Tree_ASIS_Version_Number)
1709 -- are supposed to be used in the GNAT/ASIS version check performed in
1710 -- the ASIS code (this package is also a part of the ASIS implementation).
1711 -- They are set by Tree_Read procedure, so they represent the version
1712 -- number (and the version string) of the compiler which has created the
1713 -- tree, and they are supposed to be compared with the corresponding values
1714 -- from the Tree_IO and Gnatvsn packages which also are a part of ASIS
1717 Tree_Version_String : String_Access;
1718 -- Used to store the compiler version string read from a tree file to check
1719 -- if it is from the same date as stored in the version string in Gnatvsn.
1720 -- We require that ASIS Pro can be used only with GNAT Pro, but we allow
1721 -- non-Pro ASIS and ASIS-based tools to be used with any version of the
1722 -- GNAT compiler. Therefore, we need the possibility to compare the dates
1723 -- of the corresponding source sets, using version strings that may be
1724 -- of different lengths.
1726 Tree_ASIS_Version_Number : Int;
1727 -- Used to store the ASIS version number read from a tree file to check if
1728 -- it is the same as stored in the ASIS version number in Tree_IO.
1732 -- The following type is used to save and restore settings of switches in
1733 -- Opt that represent the configuration (i.e. result of config pragmas).
1735 -- Note that Ada_Version_Explicit is not included, since this is a sticky
1736 -- flag that once set does not get reset, since the whole idea of this flag
1737 -- is to record the setting for the main unit.
1739 type Config_Switches_Type is record
1740 Ada_Version : Ada_Version_Type;
1741 Ada_Version_Explicit : Ada_Version_Type;
1742 Assertions_Enabled : Boolean;
1743 Assume_No_Invalid_Values : Boolean;
1744 Check_Policy_List : Node_Id;
1745 Debug_Pragmas_Enabled : Boolean;
1746 Dynamic_Elaboration_Checks : Boolean;
1747 Exception_Locations_Suppressed : Boolean;
1748 Extensions_Allowed : Boolean;
1749 External_Name_Exp_Casing : External_Casing_Type;
1750 External_Name_Imp_Casing : External_Casing_Type;
1751 Fast_Math : Boolean;
1752 Init_Or_Norm_Scalars : Boolean;
1753 Initialize_Scalars : Boolean;
1754 Optimize_Alignment : Character;
1755 Optimize_Alignment_Local : Boolean;
1756 Persistent_BSS_Mode : Boolean;
1757 Polling_Required : Boolean;
1758 Use_VADS_Size : Boolean;
1761 -- The following declarations are for GCC version dependent flags. We do
1762 -- not let client code in the compiler test GCC_Version directly, but
1763 -- instead use deferred constants for relevant feature tags.
1765 -- Note: there currently are no such constants defined in this section,
1766 -- since the compiler front end is currently entirely independent of the
1767 -- GCC version, which is a desirable state of affairs.
1769 function get_gcc_version return Int;
1770 pragma Import (C, get_gcc_version, "get_gcc_version");
1772 GCC_Version : constant Nat := get_gcc_version;
1774 -- Indicates which version of gcc is in use (3 = 3.x, 4 = 4.x). Note that
1775 -- gcc 2.8.1 (which used to be a value of 2) is no longer supported.