1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                                  O P T                                   --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 1992-2015, Free Software Foundation, Inc.         --
10--                                                                          --
11-- GNAT is free software;  you can  redistribute it  and/or modify it under --
12-- terms of the  GNU General Public License as published  by the Free Soft- --
13-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- GNAT was originally developed  by the GNAT team at  New York University. --
28-- Extensive contributions were provided by Ada Core Technologies Inc.      --
29--                                                                          --
30------------------------------------------------------------------------------
31
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).
36
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.
40
41with Hostparm; use Hostparm;
42with Types;    use Types;
43
44pragma Warnings (Off);
45--  This package is used also by gnatcoll
46with System.Strings; use System.Strings;
47with System.WCh_Con; use System.WCh_Con;
48pragma Warnings (On);
49
50package Opt is
51
52   ----------------------
53   -- Checksum Control --
54   ----------------------
55
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).
59
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
64
65   --    Version 6.4 and later:
66
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.
70
71   --    Versions 5.04 to 6.3:
72
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.
75
76   --    Versions 5.03:
77
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.
81
82   --    Versions 5.02 and before:
83
84   --      No calls to procedure Accumulate_Token_Checksum (the checksum
85   --      mechanism was introduced in version 5.03).
86
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:
89
90   Checksum_Accumulate_Token_Checksum : Boolean := True;
91   --  GPRBUILD
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.
95
96   Checksum_GNAT_6_3 : Boolean := False;
97   --  GPRBUILD
98   --  Set to True by gprbuild when the version of GNAT is 6.3 or before.
99
100   Checksum_GNAT_5_03 : Boolean := False;
101   --  GPRBUILD
102   --  Set to True by gprbuild when the version of GNAT is 5.03 or before.
103
104   ----------------------------------------------
105   -- Settings of Modes for Current Processing --
106   ----------------------------------------------
107
108   --  The following mode values represent the current state of processing.
109   --  The values set here are the default values. Unless otherwise noted,
110   --  the value may be reset in Switch-? with an appropriate switch. In
111   --  some cases, the values can also be modified by pragmas, and in the
112   --  case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
113   --  the default values.
114
115   type Ada_Version_Type is (Ada_83, Ada_95, Ada_2005, Ada_2012);
116   pragma Ordered (Ada_Version_Type);
117   --  Versions of Ada for Ada_Version below. Note that these are ordered,
118   --  so that tests like Ada_Version >= Ada_95 are legitimate and useful.
119   --  Think twice before using "="; Ada_Version >= Ada_2012 is more likely
120   --  what you want, because it will apply to future versions of the language.
121
122   Ada_Version_Default : constant Ada_Version_Type := Ada_2012;
123   pragma Warnings (Off, Ada_Version_Default);
124   --  GNAT
125   --  Default Ada version if no switch given. The Warnings off is to kill
126   --  constant condition warnings.
127
128   Ada_Version : Ada_Version_Type := Ada_Version_Default;
129   --  GNAT
130   --  Current Ada version for compiler, as set by configuration pragmas,
131   --  compiler switches, or implicitly (to Ada_Version_Runtime) when a
132   --  predefined or internal file is compiled.
133
134   Ada_Version_Pragma : Node_Id := Empty;
135   --  Reflects the Ada_xxx pragma that resulted in setting Ada_Version. Used
136   --  to specialize error messages complaining about the Ada version in use.
137
138   Ada_Version_Explicit : Ada_Version_Type := Ada_Version_Default;
139   --  GNAT
140   --  Like Ada_Version, but does not get set implicitly for predefined or
141   --  internal units, so it reflects the Ada version explicitly set using
142   --  configuration pragmas or compiler switches (or if neither appears, it
143   --  remains set to Ada_Version_Default). This is used in the rare cases
144   --  (notably pragma Obsolescent) where we want the explicit version set.
145
146   Ada_Version_Runtime : Ada_Version_Type := Ada_2012;
147   --  GNAT
148   --  Ada version used to compile the runtime. Used to set Ada_Version (but
149   --  not Ada_Version_Explicit) when compiling predefined or internal units.
150
151   Ada_Final_Suffix : constant String := "final";
152   Ada_Final_Name   : String_Ptr := new String'("ada" & Ada_Final_Suffix);
153   --  GNATBIND
154   --  The name of the procedure that performs the finalization at the end of
155   --  execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
156
157   Ada_Init_Suffix : constant String := "init";
158   Ada_Init_Name   : String_Ptr := new String'("ada" & Ada_Init_Suffix);
159   --  GNATBIND
160   --  The name of the procedure that performs initialization at the start
161   --  of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
162
163   Ada_Main_Name_Suffix : constant String := "main";
164   --  GNATBIND
165   --  The suffix for Ada_Main_Name. Defined as a constant here so that it
166   --  can be referenced in a uniform manner to create either the default
167   --  value of Ada_Main_Name (declared below), or the non-default name
168   --  set by Gnatbind.Scan_Bind_Arg.
169
170   Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
171   --  GNATBIND
172   --  The name of the Ada package generated by the binder (when in Ada mode).
173   --  This variable may be modified by Gnatbind.Scan_Bind_Arg.
174
175   Address_Clause_Overlay_Warnings : Boolean := True;
176   --  GNAT
177   --  Set False to disable address clause warnings. Modified by use of
178   --  -gnatwo/O.
179
180   Address_Is_Private : Boolean := False;
181   --  GNAT, GNATBIND
182   --  Set True if package System has the line "type Address is private;"
183
184   All_Errors_Mode : Boolean := False;
185   --  GNAT
186   --  Flag set to force display of multiple errors on a single line and
187   --  also repeated error messages for references to undefined identifiers
188   --  and certain other repeated error messages. Set by use of -gnatf.
189
190   Allow_Integer_Address : Boolean := False;
191   --  GNAT
192   --  Allow use of integer expression in a context requiring System.Address.
193   --  Set by the use of configuration pragma Allow_Integer_Address Also set
194   --  in relaxed semantics mode for use by CodePeer or when -gnatd.M is used.
195
196   All_Sources : Boolean := False;
197   --  GNATBIND
198   --  Set to True to require all source files to be present. This flag is
199   --  directly modified by gnatmake to affect the shared binder routines.
200
201   Alternate_Main_Name : String_Ptr := null;
202   --  GNATBIND
203   --  Set to non null when Bind_Alternate_Main_Name is True. This value
204   --  is modified as needed by Gnatbind.Scan_Bind_Arg.
205
206   ASIS_Mode : Boolean := False;
207   --  GNAT
208   --  Enable semantic checks and tree transformations that are important
209   --  for ASIS but that are usually skipped if Operating_Mode is set to
210   --  Check_Semantics. This flag does not have the corresponding option to set
211   --  it ON. It is set ON when Tree_Output is set ON, it can also be set ON
212   --  from the code of GNSA-based tool (a client may need to set ON the
213   --  Back_Annotate_Rep_Info flag in this case. At the moment this does not
214   --  make very much sense, because GNSA cannot do back annotation).
215
216   Assertions_Enabled : Boolean := False;
217   --  GNAT
218   --  Indicates default policy (True = Check, False = Ignore) to be applied
219   --  to all assertion aspects and pragmas, and to pragma Debug, if there is
220   --  no overriding Assertion_Policy, Check_Policy, or Debug_Policy pragma.
221   --  Set True by use of -gnata.
222
223   Assume_No_Invalid_Values : Boolean := False;
224   --  GNAT Normally, in accordance with (RM 13.9.1 (9-11)) the front end
225   --  assumes that values could have invalid representations, unless it can
226   --  clearly prove that the values are valid. If this switch is set (by
227   --  pragma Assume_No_Invalid_Values (On)), then the compiler assumes values
228   --  are valid and in range of their representations. This feature is now
229   --  fully enabled in the compiler.
230
231   Back_Annotate_Rep_Info : Boolean := False;
232   --  GNAT
233   --  If set True, enables back annotation of representation information
234   --  by gigi, even in -gnatc mode. This is set True by the use of -gnatR
235   --  (list representation information) or -gnatt (generate tree). It is
236   --  also set true if certain Unchecked_Conversion instantiations require
237   --  checking based on annotated values.
238
239   Back_End_Handles_Limited_Types : Boolean;
240   --  This flag is set true if the back end can properly handle limited or
241   --  other by reference types, and avoid copies. If this flag is False, then
242   --  the front end does special expansion for if/case expressions to make
243   --  sure that no copy occurs. If the flag is True, then the expansion for
244   --  if and case expressions relies on the back end properly handling things.
245   --  Currently the default is False for all cases (set in gnat1drv). The
246   --  default can be modified using -gnatd.L (sets the flag True). This is
247   --  used to test the possibility of having the backend handle this.
248
249   Back_End_Inlining : Boolean := False;
250   --  GNAT
251   --  Set True to activate inlining by back-end expansion. This is the normal
252   --  default mode for gcc targets, so it is True on such targets unless the
253   --  switches -gnatN or -gnatd.z are used. See circuitry in gnat1drv for the
254   --  exact conditions for setting this switch.
255
256   Bind_Alternate_Main_Name : Boolean := False;
257   --  GNATBIND
258   --  True if main should be called Alternate_Main_Name.all.
259   --  This variable may be set to True by Gnatbind.Scan_Bind_Arg.
260
261   Bind_Main_Program : Boolean := True;
262   --  GNATBIND
263   --  Set to False if not binding main Ada program
264
265   Bind_For_Library : Boolean := False;
266   --  GNATBIND
267   --  Set to True if the binder needs to generate a file designed for building
268   --  a library. May be set to True by Gnatbind.Scan_Bind_Arg.
269
270   Bind_Only : Boolean := False;
271   --  GNATMAKE, GPRBUILD
272   --  Set to True to skip compile and link steps
273   --  (except when Compile_Only and/or Link_Only are True).
274
275   Blank_Deleted_Lines : Boolean := False;
276   --  GNAT, GNATPREP
277   --  Output empty lines for each line of preprocessed input that is deleted
278   --  in the output, including preprocessor lines starting with a '#'.
279
280   Brief_Output : Boolean := False;
281   --  GNAT, GNATBIND
282   --  Force brief error messages to standard error, even if verbose mode is
283   --  set (so that main error messages go to standard output).
284
285   Build_Bind_And_Link_Full_Project : Boolean := False;
286   --  GNATMAKE
287   --  Set to True to build, bind and link all the sources of a project file
288   --  (switch -B)
289
290   Check_Aliasing_Of_Parameters : Boolean := False;
291   --  GNAT
292   --  Set to True to detect whether subprogram parameters and function results
293   --  alias the same object(s).
294
295   Check_Float_Overflow : Boolean := False;
296   --  GNAT
297   --  Set to True to check that operations on predefined unconstrained float
298   --  types (e.g. Float, Long_Float) do not overflow and generate infinities
299   --  or invalid values. Set by the Check_Float_Overflow pragma, or by use
300   --  of the -gnateF switch.
301
302   Check_Object_Consistency : Boolean := False;
303   --  GNATBIND, GNATMAKE
304   --  Set to True to check whether every object file is consistent with its
305   --  corresponding ada library information (ALI) file. An object file is
306   --  inconsistent with the corresponding ALI file if the object file does
307   --  not exist or if it has an older time stamp than the ALI file. Default
308   --  above is for GNATBIND. GNATMAKE overrides this default to True (see
309   --  Make.Initialize) since we normally do need to check source consistencies
310   --  in gnatmake.
311
312   Check_Only : Boolean := False;
313   --  GNATBIND
314   --  Set to True to do checks only, no output of binder file
315
316   Check_Policy_List : Node_Id := Empty;
317   --  GNAT
318   --  This points to the list of N_Pragma nodes for Check_Policy pragmas
319   --  that are linked through the Next_Pragma fields, with the list being
320   --  terminated by Empty. The order is most recently processed first. Note
321   --  that Push_Scope and Pop_Scope in Sem_Ch8 save and restore the value
322   --  of this variable, implementing the required scope control for pragmas
323   --  appearing in a declarative part.
324
325   Check_Readonly_Files : Boolean := False;
326   --  GNATMAKE
327   --  Set to True to check readonly files during the make process
328
329   Check_Source_Files : Boolean := True;
330   --  GNATBIND, GNATMAKE
331   --  Set to True to enable consistency checking for any source files that
332   --  are present (i.e. date must match the date in the library info file).
333   --  Set to False for object file consistency check only. This flag is
334   --  directly modified by gnatmake, to affect the shared binder routines.
335
336   Check_Switches : Boolean := False;
337   --  GNATMAKE, GPBUILD
338   --  Set to True to check compiler options during the make process
339
340   Check_Unreferenced : Boolean := False;
341   --  GNAT
342   --  Set to True to enable checking for unreferenced entities other
343   --  than formal parameters (for which see Check_Unreferenced_Formals)
344   --  Modified by use of -gnatwu/U.
345
346   Check_Unreferenced_Formals : Boolean := False;
347   --  GNAT
348   --  Set to True to check for unreferenced formals. This is turned on by
349   --  -gnatwa/wf/wu and turned off by -gnatwA/wF/wU.
350
351   Check_Validity_Of_Parameters : Boolean := False;
352   --  GNAT
353   --  Set to True to check for proper scalar initialization of subprogram
354   --  parameters on both entry and exit. Turned on by??? turned off by???
355
356   Check_Withs : Boolean := False;
357   --  GNAT
358   --  Set to True to enable checking for unused withs, and also the case
359   --  of withing a package and using none of the entities in the package.
360   --  Modified by use of -gnatwu/U.
361
362   CodePeer_Mode : Boolean := False;
363   --  GNAT, GNATBIND, GPRBUILD
364   --  Enable full CodePeer mode (SCIL generation, disable switches that
365   --  interact badly with it, etc...). This is turned on by -gnatC.
366
367   Commands_To_Stdout : Boolean := False;
368   --  GNATMAKE
369   --  True if echoed commands to be written to stdout instead of stderr
370
371   Comment_Deleted_Lines : Boolean := False;
372   --  GNATPREP
373   --  True if source lines removed by the preprocessor should be commented
374   --  in the output file.
375
376   Compilation_Time : String (1 .. 19);
377   --  GNAT
378   --  Compilation date and time in form YYYY-MM-DD HH:MM:SS
379
380   Compile_Only : Boolean := False;
381   --  GNATMAKE, GNATCLEAN, GPBUILD, GPRCLEAN
382   --  GNATMAKE, GPRBUILD:
383   --    set True to skip bind and link steps (except when Bind_Only is True)
384   --  GNATCLEAN, GPRCLEAN:
385   --    set True to delete only the files produced by the compiler but not the
386   --    library files or the executable files.
387
388   Compiler_Unit : Boolean := False;
389   --  GNAT1
390   --  Set True by an occurrence of pragma Compiler_Unit_Warning (or of the
391   --  obsolete pragma Compiler_Unit) in the main unit. Once set True, stays
392   --  True, since any units that are with'ed directly or indirectly by
393   --  a Compiler_Unit_Warning main unit are subject to the same restrictions.
394   --  Such units really should have their own pragmas, but we do not bother to
395   --  check for that, so this transitivity provides extra checking.
396
397   Config_File : Boolean := True;
398   --  GNAT
399   --  Set to False to inhibit reading and processing of gnat.adc file
400
401   Config_File_Names : String_List_Access := null;
402   --  GNAT
403   --  Names of configuration pragmas files (given by switches -gnatec)
404
405   Configurable_Run_Time_Mode : Boolean := False;
406   --  GNAT, GNATBIND
407   --  Set True if the compiler is operating in configurable run-time mode.
408   --  This happens if the flag Targparm.Configurable_Run_TimeMode_On_Target
409   --  is set True, or if pragma No_Run_Time is used. See the spec of Rtsfind
410   --  for details on the handling of the latter pragma.
411
412   Constant_Condition_Warnings : Boolean := False;
413   --  GNAT
414   --  Set to True to activate warnings on constant conditions. Modified by
415   --  use of -gnatwc/C.
416
417   Create_Mapping_File : Boolean := False;
418   --  GNATMAKE
419   --  Set to True (-C switch) to indicate that the compiler will be invoked
420   --  with a mapping file (-gnatem compiler switch).
421
422   subtype Debug_Level_Value is Nat range 0 .. 3;
423   Debugger_Level : Debug_Level_Value := 0;
424   --  The value given to the -g parameter. The default value for -g with
425   --  no value is 2. This is not currently used but is retained for possible
426   --  future use.
427
428   Default_Exit_Status : Int := 0;
429   --  GNATBIND
430   --  Set the default exit status value. Set by the -Xnnn switch for the
431   --  binder.
432
433   Debug_Generated_Code : Boolean := False;
434   --  GNAT
435   --  Set True (-gnatD switch) to debug generated expanded code instead
436   --  of the original source code. Causes debugging information to be
437   --  written with respect to the generated code file that is written.
438
439   Default_Pool : Node_Id := Empty;
440   --  GNAT
441   --  Used to record the storage pool name (or null literal) that is the
442   --  argument of an applicable pragma Default_Storage_Pool.
443   --    Empty:       No pragma Default_Storage_Pool applies.
444   --    N_Null node: "pragma Default_Storage_Pool (null);" applies.
445   --    otherwise:   "pragma Default_Storage_Pool (X);" applies, and
446   --                 this points to the name X.
447   --  Push_Scope and Pop_Scope in Sem_Ch8 save and restore this value.
448   Default_Stack_Size : Int := -1;
449   --  GNATBIND
450   --  Set to default primary stack size in units of bytes. Set by
451   --  the -dnnn switch for the binder. A value of -1 indicates that no
452   --  default was set by the binder.
453
454   Default_Sec_Stack_Size : Int := -1;
455   --  GNATBIND
456   --  Set to default secondary stack size in units of bytes. Set by
457   --  the -Dnnn switch for the binder. A value of -1 indicates that no
458   --  default was set by the binder, and that the default should be the
459   --  initial value of System.Secondary_Stack.Default_Secondary_Stack_Size.
460
461   Default_SSO : Character := ' ';
462   --  GNAT
463   --  Set if a pragma Default_Scalar_Storage_Order has been given. The value
464   --  of ' ' indicates that no default has been set, otherwise the value is
465   --  either 'H' for High_Order_First or 'L' for Lower_Order_First.
466
467   Detect_Blocking : Boolean := False;
468   --  GNAT
469   --  Set True to force the run time to raise Program_Error if calls to
470   --  potentially blocking operations are detected from protected actions.
471
472   Directories_Must_Exist_In_Projects : Boolean := True;
473   --  PROJECT MANAGER
474   --  Set to False with switch -f of gnatclean and gprclean
475
476   Display_Compilation_Progress : Boolean := False;
477   --  GNATMAKE, GPRBUILD
478   --  Set True (-d switch) to display information on progress while compiling
479   --  files. Internal flag to be used in conjunction with an IDE (e.g GPS).
480
481   type Distribution_Stub_Mode_Type is
482   --  GNAT
483     (No_Stubs,
484      --  Normal mode, no generation/compilation of distribution stubs
485
486      Generate_Receiver_Stub_Body,
487      --  The unit being compiled is the RCI body, and the compiler will
488      --  generate the body for the receiver stubs and compile it.
489
490      Generate_Caller_Stub_Body);
491      --  The unit being compiled is the RCI spec, and the compiler will
492      --  generate the body for the caller stubs and compile it.
493
494   Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
495   --  GNAT
496   --  This enumeration variable indicates the five states of distribution
497   --  annex stub generation/compilation.
498
499   Do_Not_Execute : Boolean := False;
500   --  GNATMAKE
501   --  Set to True if no actual compilations should be undertaken
502
503   Dump_Source_Text : Boolean := False;
504   --  GNAT
505   --  Set to True (by -gnatL) to dump source text intermingled with generated
506   --  code. Effective only if either of Debug/Print_Generated_Code is true.
507
508   Dynamic_Elaboration_Checks : Boolean := False;
509   --  GNAT
510   --  Set True for dynamic elaboration checking mode, as set by the -gnatE
511   --  switch or by the use of pragma Elaboration_Checks (Dynamic).
512
513   Dynamic_Stack_Measurement : Boolean := False;
514   --  GNATBIND
515   --  Set True to enable dynamic stack measurement (-u flag for gnatbind)
516
517   Dynamic_Stack_Measurement_Array_Size : Nat := 100;
518   --  GNATBIND
519   --  Number of measurements we want to store during dynamic stack analysis.
520   --  When the buffer is full, non-storable results will be output on the fly.
521   --  The value is relevant only if Dynamic_Stack_Measurement is set. Set
522   --  by processing of -u flag for gnatbind.
523
524   Elab_Dependency_Output : Boolean := False;
525   --  GNATBIND
526   --  Set to True to output complete list of elaboration constraints
527
528   Elab_Order_Output : Boolean := False;
529   --  GNATBIND
530   --  Set to True to output chosen elaboration order
531
532   Elab_Info_Messages : Boolean := False;
533   --  GNAT
534   --  Set to True to output info messages for static elabmodel (-gnatel)
535
536   Elab_Warnings : Boolean := False;
537   --  GNAT
538   --  Set to True to generate elaboration warnings (-gnatwl)
539
540   Error_Msg_Line_Length : Nat := 0;
541   --  GNAT
542   --  Records the error message line length limit. If this is set to zero,
543   --  then we get the old style behavior, in which each call to the error
544   --  message routines generates one line of output as a separate message.
545   --  If it is set to a non-zero value, then continuation lines are folded
546   --  to make a single long message, and then this message is split up into
547   --  multiple lines not exceeding the specified length. Set by -gnatj=nn.
548
549   Error_To_Warning : Boolean := False;
550   --  GNAT
551   --  If True, then certain error messages (e.g. parameter overlap messages
552   --  for procedure calls in Ada 2012 mode) are treated as warnings instead
553   --  of errors. Set by debug flag -gnatd.E. A search for Error_To_Warning
554   --  will identify affected messages.
555
556   Exception_Handler_Encountered : Boolean := False;
557   --  GNAT
558   --  This flag is set true if the parser encounters an exception handler.
559   --  It is used to set Warn_On_Exception_Propagation True if the restriction
560   --  No_Exception_Propagation is set.
561
562   Exception_Extra_Info : Boolean := False;
563   --  GNAT
564   --  True when switch -gnateE is used. When True, generate extra information
565   --  associated with exception messages (in particular range and index
566   --  checks).
567
568   Exception_Locations_Suppressed : Boolean := False;
569   --  GNAT
570   --  Set to True if a Suppress_Exception_Locations configuration pragma is
571   --  currently active.
572
573   type Exception_Mechanism_Type is
574   --  Determines the handling of exceptions. See Exp_Ch11 for details
575   --
576     (Front_End_Setjmp_Longjmp_Exceptions,
577      --  Exceptions use setjmp/longjmp generated explicitly by the front end
578      --  (this includes gigi or other equivalent parts of the code generator).
579      --  AT END handlers are converted into exception handlers by the front
580      --  end in this mode.
581
582      Back_End_Exceptions);
583      --  Exceptions are handled by the back end. The front end simply
584      --  generates the handlers as they appear in the source, and AT END
585      --  handlers are left untouched (they are not converted into exception
586      --  handlers when operating in this mode.
587   pragma Convention (C, Exception_Mechanism_Type);
588
589   Exception_Mechanism : Exception_Mechanism_Type :=
590                           Front_End_Setjmp_Longjmp_Exceptions;
591   --  GNAT
592   --  Set to the appropriate value depending on the default as given in
593   --  system.ads (ZCX_By_Default). The C convention is there to make this
594   --  variable accessible to gigi.
595
596   Exception_Tracebacks : Boolean := False;
597   --  GNATBIND
598   --  Set to True to store tracebacks in exception occurrences (-E)
599
600   Extensions_Allowed : Boolean := False;
601   --  GNAT
602   --  Set to True by switch -gnatX if GNAT specific language extensions
603   --  are allowed. Currently there are no such defined extensions.
604
605   type External_Casing_Type is (
606     As_Is,       -- External names cased as they appear in the Ada source
607     Uppercase,   -- External names forced to all uppercase letters
608     Lowercase);  -- External names forced to all lowercase letters
609
610   External_Name_Imp_Casing : External_Casing_Type := Lowercase;
611   --  GNAT
612   --  The setting of this flag determines the casing of external names
613   --  when the name is implicitly derived from an entity name (i.e. either
614   --  no explicit External_Name or Link_Name argument is used, or, in the
615   --  case of extended DEC pragmas, the external name is given using an
616   --  identifier. The As_Is setting is not permitted here (since this would
617   --  create Ada source programs that were case sensitive).
618
619   External_Name_Exp_Casing : External_Casing_Type := As_Is;
620   --  GNAT
621   --  The setting of this flag determines the casing of an external name
622   --  specified explicitly with a string literal. As_Is means the string
623   --  literal is used as given with no modification to the casing. If
624   --  Lowercase or Uppercase is set, then the string is forced to all
625   --  lowercase or all uppercase letters as appropriate. Note that this
626   --  setting has no effect if the external name is given using an identifier
627   --  in the case of extended DEC import/export pragmas (in this case the
628   --  casing is controlled by External_Name_Imp_Casing), and also has no
629   --  effect if an explicit Link_Name is supplied (a link name is always
630   --  used exactly as given).
631
632   External_Unit_Compilation_Allowed : Boolean := False;
633   --  GNATMAKE
634   --  When True (set by gnatmake switch -x), allow compilation of sources
635   --  that are not part of any project file.
636
637   Fast_Math : Boolean := False;
638   --  GNAT
639   --  Indicates the current setting of Fast_Math mode, as set by the use
640   --  of a Fast_Math pragma (set True by Fast_Math (On)).
641
642   Force_ALI_Tree_File : Boolean := False;
643   --  GNAT
644   --  Force generation of ALI file even if errors are encountered. Also forces
645   --  generation of tree file if -gnatt is also set. Set on by use of -gnatQ.
646
647   Disable_ALI_File : Boolean := False;
648   --  GNAT
649   --  Disable generation of ALI file
650
651   Follow_Links_For_Files : Boolean := False;
652   --  PROJECT MANAGER
653   --  Set to True (-eL) to process the project files in trusted mode. If
654   --  Follow_Links is False, it is assumed that the project doesn't contain
655   --  any file duplicated through symbolic links (although the latter are
656   --  still valid if they point to a file which is outside of the project),
657   --  and that no directory has a name which is a valid source name.
658
659   Follow_Links_For_Dirs : Boolean := False;
660   --  PROJECT MANAGER
661   --  Set to True if directories can be links in this project, and therefore
662   --  additional system calls must be performed to ensure that we always see
663   --  the same full name for each directory.
664
665   Force_Checking_Of_Elaboration_Flags : Boolean := False;
666   --  GNATBIND
667   --  True if binding with forced checking of the elaboration flags
668   --  (-F switch set).
669
670   Force_Compilations : Boolean := False;
671   --  GNATMAKE, GPRBUILD
672   --  Set to force recompilations even when the objects are up-to-date.
673
674   Front_End_Inlining : Boolean := False;
675   --  GNAT
676   --  Set True to activate inlining by front-end expansion (even on GCC
677   --  targets, where inlining is normally handled by the back end). Set by
678   --  the flag -gnatN (which is now considered obsolescent, since the GCC
679   --  back end can do a better job of inlining than the front end these days.
680
681   Full_Path_Name_For_Brief_Errors : Boolean := False;
682   --  PROJECT MANAGER
683   --  When True, in Brief_Output mode, each error message line will start with
684   --  the full path name of the source. When False, only the file name without
685   --  directory information is used.
686
687   Full_List : Boolean := False;
688   --  GNAT
689   --  Set True to generate full source listing with embedded errors
690
691   Full_List_File_Name : String_Ptr := null;
692   --  GNAT
693   --  Set to file name to generate full source listing to named file (or if
694   --  the name is of the form .xxx, then to name.xxx where name is the source
695   --  file name with extension stripped.
696
697   Generate_CodePeer_Messages : Boolean := False;
698   --  GNAT
699   --  Generate CodePeer messages. Ignored if CodePeer_Mode is false. This is
700   --  turned on by -gnateC.
701
702   Generate_Processed_File : Boolean := False;
703   --  GNAT
704   --  True when switch -gnateG is used. When True, create in a file
705   --  <source>.prep, if the source is preprocessed.
706
707   Generate_SCIL : Boolean := False;
708   --  GNAT
709   --  Set True to activate SCIL code generation.
710
711   Generate_SCO : Boolean := False;
712   --  GNAT
713   --  True when switch -fdump-scos (or -gnateS) is used. When True, Source
714   --  Coverage Obligation (SCO) information is generated and output in the ALI
715   --  file. See unit Par_SCO for full details.
716
717   Generate_SCO_Instance_Table : Boolean := False;
718   --  GNAT
719   --  True when switch -fdump-scos is used. When True, a table of instances is
720   --  included in SCOs.
721
722   Generating_Code : Boolean := False;
723   --  GNAT
724   --  True if the frontend finished its work and has called the backend to
725   --  process the tree and generate the object file.
726
727   type Ghost_Mode_Type is (None, Check, Ignore);
728   --  Possible legal modes that can be set by aspect/pragma Ghost as well as
729   --  value None, which indicates that no such aspect/pragma applies.
730
731   Ghost_Mode : Ghost_Mode_Type := None;
732   --  GNAT
733   --  Current Ghost mode setting
734
735   Global_Discard_Names : Boolean := False;
736   --  GNAT, GNATBIND
737   --  True if a pragma Discard_Names appeared as a configuration pragma for
738   --  the current compilation unit.
739
740   GNAT_Encodings : Int;
741   pragma Import (C, GNAT_Encodings, "gnat_encodings");
742   --  Constant controlling the balance between GNAT encodings and standard
743   --  DWARF to emit in the debug information. See jmissing.c and aamissing.c
744   --  for definitions for dotnet/jgnat and GNAAMP back ends. It accepts the
745   --  following values.
746
747   DWARF_GNAT_Encodings_All     : constant Int := 0;
748   DWARF_GNAT_Encodings_GDB     : constant Int := 1;
749   DWARF_GNAT_Encodings_Minimal : constant Int := 2;
750
751   Identifier_Character_Set : Character;
752   --  GNAT
753   --  This variable indicates the character set to be used for identifiers.
754   --  The possible settings are:
755   --    '1'  Latin-1 (ISO-8859-1)
756   --    '2'  Latin-2 (ISO-8859-2)
757   --    '3'  Latin-3 (ISO-8859-3)
758   --    '4'  Latin-4 (ISO-8859-4)
759   --    '5'  Latin-Cyrillic (ISO-8859-5)
760   --    '9'  Latin-9 (ISO-8859-15)
761   --    'p'  PC (US, IBM page 437)
762   --    '8'  PC (European, IBM page 850)
763   --    'f'  Full upper set (all distinct)
764   --    'n'  No upper characters (Ada 83 rules)
765   --    'w'  Latin-1 plus wide characters allowed in identifiers
766   --
767   --  The setting affects the set of letters allowed in identifiers and the
768   --  upper/lower case equivalences. It does not affect the interpretation of
769   --  character and string literals, which are always stored using the actual
770   --  coding in the source program. This variable is initialized to the
771   --  default value appropriate to the system (in Osint.Initialize), and then
772   --  reset if a command line switch is used to change the setting.
773
774   Ignore_Pragma_SPARK_Mode : Boolean := False;
775   --  GNAT
776   --  Set True to ignore the semantics and effects of pragma SPARK_Mode when
777   --  the pragma appears inside an instance whose enclosing context is subject
778   --  to SPARK_Mode "off".
779
780   Ignore_Rep_Clauses : Boolean := False;
781   --  GNAT
782   --  Set True to ignore all representation clauses. Useful when compiling
783   --  code from foreign compilers for checking or ASIS purposes. Can be
784   --  set True by use of -gnatI.
785
786   Ignore_Style_Checks_Pragmas : Boolean := False;
787   --  GNAT
788   --  Set True to ignore all Style_Checks pragmas. Can be set True by use
789   --  of -gnateY.
790
791   Ignore_Unrecognized_VWY_Switches : Boolean := False;
792   --  GNAT
793   --  Set True to ignore unrecognized y, V, w switches. Can be set True
794   --  by use of -gnateu, causing subsequent unrecognized switches to result
795   --  in a warning rather than an error.
796
797   Implementation_Unit_Warnings : Boolean := True;
798   --  GNAT
799   --  Set True to active warnings for use of implementation internal units.
800   --  Modified by use of -gnatwi/-gnatwI.
801
802   Implicit_Packing : Boolean := False;
803   --  GNAT
804   --  If set True, then a Size attribute clause on an array is allowed to
805   --  cause implicit packing instead of generating an error message. Set by
806   --  use of pragma Implicit_Packing.
807
808   Ineffective_Inline_Warnings : Boolean := False;
809   --  GNAT
810   --  Set True to activate warnings if front-end inlining (-gnatN) is not able
811   --  to actually inline a particular call (or all calls). Can be controlled
812   --  by use of -gnatwp/-gnatwP. Also set True to activate warnings if
813   --  frontend inlining is not able to inline a subprogram expected to
814   --  be inlined in GNATprove mode.
815
816   Init_Or_Norm_Scalars : Boolean := False;
817   --  GNAT, GANTBIND
818   --  Set True if a pragma Initialize_Scalars applies to the current unit.
819   --  Also set True if a pragma Restriction (Normalize_Scalars) applies.
820
821   Initialize_Scalars : Boolean := False;
822   --  GNAT
823   --  Set True if a pragma Initialize_Scalars applies to the current unit.
824   --  Note that Init_Or_Norm_Scalars is also set to True if this is True.
825
826   Initialize_Scalars_Mode1 : Character := 'I';
827   Initialize_Scalars_Mode2 : Character := 'N';
828   --  GNATBIND
829   --  Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
830   --  is IN (invalid values), used if no -S switch is used.
831
832   Inline_Active : Boolean := False;
833   --  GNAT
834   --  Set True to activate pragma Inline processing across modules. Default
835   --  for now is not to inline across module boundaries.
836
837   Inline_Level : Nat := 0;
838   --  GNAT
839   --  Set to indicate the inlining level: 0 means that an appropriate value is
840   --  to be computed by the compiler based on the optimization level (-gnatn),
841   --  1 is for moderate inlining across modules (-gnatn1) and 2 for full
842   --  inlining across modules (-gnatn2).
843
844   Interface_Library_Unit : Boolean := False;
845   --  GNATBIND
846   --  Set to True to indicate that at least one ALI file is an interface ALI:
847   --  then elaboration flag checks are to be generated in the binder
848   --  generated file.
849
850   Invalid_Value_Used : Boolean := False;
851   --  GNAT
852   --  Set True if a valid Invalid_Value attribute is encountered
853
854   Inline_Processing_Required : Boolean := False;
855   --  GNAT
856   --  Set True if inline processing is required. Inline processing is required
857   --  if an active Inline pragma is processed. The flag is set for a pragma
858   --  Inline or Inline_Always that is actually active.
859
860   In_Place_Mode : Boolean := False;
861   --  GNATMAKE
862   --  Set True to store ALI and object files in place i.e. in the object
863   --  directory if these files already exist or in the source directory
864   --  if not.
865
866   Keep_Going : Boolean := False;
867   --  GNATMAKE, GPRBUILD
868   --  When True signals to ignore compilation errors and keep processing
869   --  sources until there is no more work.
870
871   Keep_Temporary_Files : Boolean := False;
872   --  GNATCMD, GNATMAKE, GPRBUILD
873   --  When True the temporary files are not deleted. Set by switches -dn or
874   --  --keep-temp-files.
875
876   Leap_Seconds_Support : Boolean := False;
877   --  GNATBIND
878   --  Set to True to enable leap seconds support in Ada.Calendar and its
879   --  children.
880
881   Link_Only : Boolean := False;
882   --  GNATMAKE, GPRBUILD
883   --  Set to True to skip compile and bind steps (except when Bind_Only is
884   --  set to True).
885
886   List_Body_Required_Info : Boolean := False;
887   --  GNATMAKE
888   --  List info messages about why a package requires a body. Modified by use
889   --  of -gnatw.y/.Y.
890
891   List_Inherited_Aspects : Boolean := False;
892   --  GNAT
893   --  List inherited invariants, preconditions, and postconditions from
894   --  Invariant'Class, Pre'Class, and Post'Class aspects. Also list inherited
895   --  subtype predicates. Modified by use of -gnatw.l/.L.
896
897   List_Restrictions : Boolean := False;
898   --  GNATBIND
899   --  Set to True to list restrictions pragmas that could apply to partition
900
901   List_Units : Boolean := False;
902   --  GNAT
903   --  List units in the active library for a compilation (-gnatu switch)
904
905   List_Closure : Boolean := False;
906   --  GNATBIND
907   --  List all sources in the closure of a main (-R or -Ra gnatbind switch)
908
909   List_Closure_All : Boolean := False;
910   --  GNATBIND
911   --  List all sources in closure of main including run-time units (-Ra
912   --  gnatbind switch).
913
914   List_Dependencies : Boolean := False;
915   --  GNATMAKE
916   --  When True gnatmake verifies that the objects are up to date and outputs
917   --  the list of object dependencies (-M switch). Output depends if -a switch
918   --  is used or not. This list can be used directly in a Makefile.
919
920   List_Representation_Info : Int range 0 .. 3 := 0;
921   --  GNAT
922   --  Set non-zero by -gnatR switch to list representation information.
923   --  The settings are as follows:
924   --
925   --    0 = no listing of representation information (default as above)
926   --    1 = list rep info for user defined record and array types
927   --    2 = list rep info for all user defined types and objects
928   --    3 = like 2, but variable fields are decoded symbolically
929
930   List_Representation_Info_To_File : Boolean := False;
931   --  GNAT
932   --  Set true by -gnatRs switch. Causes information from -gnatR/1/2/3/m to be
933   --  written to file.rep (where file is the name of the source file) instead
934   --  of stdout. For example, if file x.adb is compiled using -gnatR2s then
935   --  representation info is written to x.adb.ref.
936
937   List_Representation_Info_Mechanisms : Boolean := False;
938   --  GNAT
939   --  Set true by -gnatRm switch. Causes information on mechanisms to be
940   --  included in the representation output information.
941
942   List_Preprocessing_Symbols : Boolean := False;
943   --  GNAT, GNATPREP
944   --  Set to True if symbols for preprocessing a source are to be listed
945   --  before preprocessing occurs. Set to True by switch -s of gnatprep or
946   --  -s in preprocessing data file for the compiler.
947
948   type Create_Repinfo_File_Proc is access procedure (Src  : String);
949   type Write_Repinfo_Line_Proc  is access procedure (Info : String);
950   type Close_Repinfo_File_Proc  is access procedure;
951   --  Types used for procedure addresses below
952
953   Create_Repinfo_File_Access : Create_Repinfo_File_Proc := null;
954   Write_Repinfo_Line_Access  : Write_Repinfo_Line_Proc  := null;
955   Close_Repinfo_File_Access  : Close_Repinfo_File_Proc  := null;
956   --  GNAT
957   --  These three locations are left null when operating in non-compiler (e.g.
958   --  ASIS mode), but when operating in compiler mode, they are set to point
959   --  to the three corresponding procedures in Osint-C. The reason for this
960   --  slightly strange interface is to stop Repinfo from dragging in Osint in
961   --  ASIS mode, which would include lots of unwanted units in the ASIS build.
962
963   type Create_List_File_Proc is access procedure (S : String);
964   type Write_List_Info_Proc  is access procedure (S : String);
965   type Close_List_File_Proc  is access procedure;
966   --  Types used for procedure addresses below
967
968   Create_List_File_Access : Create_List_File_Proc := null;
969   Write_List_Info_Access  : Write_List_Info_Proc  := null;
970   Close_List_File_Access  : Close_List_File_Proc  := null;
971   --  GNAT
972   --  These three locations are left null when operating in non-compiler
973   --  (e.g. from the binder), but when operating in compiler mode, they are
974   --  set to point to the three corresponding procedures in Osint-C. The
975   --  reason for this slightly strange interface is to prevent Repinfo
976   --  from dragging in Osint-C in the binder, which would include unwanted
977   --  units in the binder.
978
979   Locking_Policy : Character := ' ';
980   --  GNAT, GNATBIND
981   --  Set to ' ' for the default case (no locking policy specified). Reset to
982   --  first character (uppercase) of locking policy name if a valid pragma
983   --  Locking_Policy is encountered.
984
985   Locking_Policy_Sloc : Source_Ptr := No_Location;
986   --  GNAT, GNATBIND
987   --  Remember location of previous Locking_Policy pragma. This is used for
988   --  inconsistency error messages. A value of System_Location is used if the
989   --  policy is set in package System.
990
991   Look_In_Primary_Dir : Boolean := True;
992   --  GNAT, GNATBIND, GNATMAKE, GNATCLEAN
993   --  Set to False if a -I- was present on the command line. When True we are
994   --  allowed to look in the primary directory to locate other source or
995   --  library files.
996
997   Make_Steps : Boolean := False;
998   --  GNATMAKE
999   --  Set to True when either Compile_Only, Bind_Only or Link_Only is
1000   --  set to True.
1001
1002   Main_Index : Int := 0;
1003   --  GNATMAKE
1004   --  This is set to non-zero by gnatmake switch -eInnn to indicate that
1005   --  the main program is the nnn unit in a multi-unit source file.
1006
1007   Mapping_File_Name : String_Ptr := null;
1008   --  GNAT
1009   --  File name of mapping between unit names, file names and path names.
1010   --  (given by switch -gnatem)
1011
1012   Maximum_Messages : Int := 9999;
1013   --  GNAT, GNATBIND
1014   --  Maximum default number of errors before compilation is terminated, or in
1015   --  the case of GNAT, maximum number of warnings before further warnings are
1016   --  suppressed. Can be overridden by -gnatm (GNAT) or -m (GNATBIND) switch.
1017
1018   Maximum_File_Name_Length : Int;
1019   --  GNAT, GNATBIND
1020   --  Maximum number of characters allowed in a file name, not counting the
1021   --  extension, as set by the appropriate switch. If no switch is given,
1022   --  then this value is initialized by Osint to the appropriate value.
1023
1024   Maximum_Instantiations : Int := 8000;
1025   --  GNAT
1026   --  Maximum number of instantiations permitted (to stop runaway cases
1027   --  of nested instantiations). These situations probably only occur in
1028   --  specially concocted test cases. Can be modified by -gnateinn switch.
1029
1030   Maximum_Processes : Positive := 1;
1031   --  GNATMAKE, GPRBUILD
1032   --  Maximum number of processes that should be spawned to carry out
1033   --  compilations.
1034
1035   Minimal_Recompilation : Boolean := False;
1036   --  GNATMAKE
1037   --  Set to True if minimal recompilation mode requested
1038
1039   Modify_Tree_For_C : Boolean := False;
1040   --  GNAT
1041   --  If this switch is set True (currently it is set only by -gnatd.V), then
1042   --  certain meaning-preserving transformations are applied to the tree to
1043   --  make it easier to interface with back ends that implement C semantics.
1044   --  There is a section in Sinfo which describes the transformations made.
1045
1046   Multiple_Unit_Index : Int := 0;
1047   --  GNAT
1048   --  This is set non-zero if the current unit is being compiled in multiple
1049   --  unit per file mode, meaning that the current unit is selected from the
1050   --  sequence of units in the current source file, using the value stored
1051   --  in this variable (e.g. 2 = select second unit in file). A value of
1052   --  zero indicates that we are in normal (one unit per file) mode.
1053
1054   No_Backup : Boolean := False;
1055   --  GNATNAME
1056   --  Do not create backup copies of project files. Set by switch --no-backup.
1057
1058   No_Deletion : Boolean := False;
1059   --  GNATPREP
1060   --  Set by preprocessor switch -a. Do not eliminate any source text. Implies
1061   --  Undefined_Symbols_Are_False. Useful to perform a syntax check on all
1062   --  branches of #if constructs.
1063
1064   No_Elab_Code_All_Pragma : Node_Id := Empty;
1065   --  Set to point to a No_Elaboration_Code_All pragma or aspect encountered
1066   --  in the spec of the extended main unit. Used to determine if we need to
1067   --  do special tests for violation of this aspect.
1068
1069   No_Main_Subprogram : Boolean := False;
1070   --  GNATMAKE, GNATBIND
1071   --  Set to True if compilation/binding of a program without main
1072   --  subprogram requested.
1073
1074   No_Run_Time_Mode : Boolean := False;
1075   --  GNAT, GNATBIND
1076   --  This flag is set True if a No_Run_Time pragma is encountered. See spec
1077   --  of Rtsfind for a full description of handling of this pragma.
1078
1079   No_Split_Units : Boolean := False;
1080   --  GPRBUILD
1081   --  Set to True with switch --no-split-units. When True, unit sources, spec,
1082   --  body and subunits, must all be in the same project. This is checked
1083   --  after each compilation.
1084
1085   No_Stdinc : Boolean := False;
1086   --  GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
1087   --  Set to True if no default source search dirs added to search list.
1088
1089   No_Stdlib : Boolean := False;
1090   --  GNATMAKE, GNATBIND, GNATFIND, GNATXREF
1091   --  Set to True if no default library search dirs added to search list.
1092
1093   No_Strict_Aliasing : Boolean := False;
1094   --  GNAT
1095   --  Set True if pragma No_Strict_Aliasing with no parameters encountered.
1096
1097   No_Tagged_Streams : Node_Id := Empty;
1098   --  GNAT
1099   --  If a pragma No_Tagged_Streams is active for the current scope, this
1100   --  points to the corresponding pragma.
1101
1102   Normalize_Scalars : Boolean := False;
1103   --  GNAT, GNATBIND
1104   --  Set True if a pragma Normalize_Scalars applies to the current unit.
1105   --  Note that Init_Or_Norm_Scalars is also set to True if this is True.
1106
1107   Object_Directory_Present : Boolean := False;
1108   --  GNATMAKE
1109   --  Set to True when an object directory is specified with option -D
1110
1111   Object_Path_File_Name : String_Ptr := null;
1112   --  GNAT2WHY
1113   --  Path of the temporary file that contains a list of object directories
1114   --  passed by -gnateO=<obj_path_file>.
1115
1116   One_Compilation_Per_Obj_Dir : Boolean := False;
1117   --  GNATMAKE, GPRBUILD
1118   --  Set to True with switch --single-compile-per-obj-dir. When True, there
1119   --  cannot be simultaneous compilations with the object files in the same
1120   --  object directory, if project files are used.
1121
1122   type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
1123   pragma Ordered (Operating_Mode_Type);
1124   Operating_Mode : Operating_Mode_Type := Generate_Code;
1125   --  GNAT
1126   --  Indicates the operating mode of the compiler. The default is generate
1127   --  code, which runs the parser, semantics and backend. Switches can be
1128   --  used to set syntax checking only mode, or syntax and semantics checking
1129   --  only mode. Operating_Mode can also be modified as a result of detecting
1130   --  errors during the compilation process. In particular if any serious
1131   --  error is detected then this flag is reset from Generate_Code to
1132   --  Check_Semantics after generating an error message. This is an ordered
1133   --  type with the semantics that each value does more than the previous one.
1134
1135   Optimize_Alignment : Character := 'O';
1136   --  Setting of Optimize_Alignment, set to T/S/O for time/space/off. Can
1137   --  be modified by use of pragma Optimize_Alignment.
1138
1139   Optimize_Alignment_Local : Boolean := False;
1140   --  Set True if Optimize_Alignment mode is set by a local configuration
1141   --  pragma that overrides the gnat.adc (or other configuration file) default
1142   --  so that the unit is not dependent on the default setting. Also always
1143   --  set True for internal units, since these always have a default setting
1144   --  of Optimize_Alignment (Off) that is enforced (essentially equivalent to
1145   --  them all having such an explicit pragma in each unit).
1146
1147   Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
1148   --  GNAT
1149   --  Indicates the original operating mode of the compiler as set by compiler
1150   --  options. This is identical to Operating_Mode except that this is not
1151   --  affected by errors.
1152
1153   Optimization_Level : Int;
1154   pragma Import (C, Optimization_Level, "optimize");
1155   --  Constant reflecting the optimization level (0,1,2,3 for -O0,-O1,-O2,-O3)
1156   --  See jmissing.c and aamissing.c for definitions for dotnet/jgnat and
1157   --  GNAAMP back ends.
1158
1159   Optimize_Size : Int;
1160   pragma Import (C, Optimize_Size, "optimize_size");
1161   --  Constant reflecting setting of -Os (optimize for size). Set to nonzero
1162   --  in -Os mode and set to zero otherwise. See jmissing.c and aamissing.c
1163   --  for definitions of "optimize_size" for dotnet/jgnat and GNAAMP backends
1164
1165   Output_File_Name_Present : Boolean := False;
1166   --  GNATBIND, GNAT, GNATMAKE
1167   --  Set to True when the output C file name is given with option -o for
1168   --  GNATBIND, when the object file name is given with option -gnatO for GNAT
1169   --  or when the executable is given with option -o for GNATMAKE.
1170
1171   Output_Linker_Option_List : Boolean := False;
1172   --  GNATBIND
1173   --  True if output of list of linker options is requested (-K switch set)
1174
1175   Output_ALI_List   : Boolean := False;
1176   ALI_List_Filename : String_Ptr;
1177   --  GNATBIND
1178   --  True if output of list of ALIs is requested (-A switch set). List is
1179   --  output under the given filename, or standard output if not specified.
1180
1181   Output_Object_List   : Boolean := False;
1182   Object_List_Filename : String_Ptr;
1183   --  GNATBIND
1184   --  True if output of list of objects is requested (-O switch set). List is
1185   --  output under the given filename, or standard output if not specified.
1186
1187   Partition_Elaboration_Policy : Character := ' ';
1188   --  GNAT, GNATBIND
1189   --  Set to ' ' for the default case (no elaboration policy specified). Reset
1190   --  to first character (uppercase) of locking policy name if a valid pragma
1191   --  Partition_Elaboration_Policy is encountered.
1192
1193   Partition_Elaboration_Policy_Sloc : Source_Ptr := No_Location;
1194   --  GNAT, GNATBIND
1195   --  Remember location of previous Partition_Elaboration_Policy pragma. This
1196   --  is used for inconsistency error messages. A value of System_Location is
1197   --  used if the policy is set in package System.
1198
1199   Persistent_BSS_Mode : Boolean := False;
1200   --  GNAT
1201   --  True if a Persistent_BSS configuration pragma is in effect, causing
1202   --  potentially persistent data to be placed in the persistent_bss section.
1203
1204   Pessimistic_Elab_Order : Boolean := False;
1205   --  GNATBIND
1206   --  True if pessimistic elaboration order is to be chosen (-p switch set)
1207
1208   Polling_Required : Boolean := False;
1209   --  GNAT
1210   --  Set to True if polling for asynchronous abort is enabled by using
1211   --  the -gnatP option for GNAT.
1212
1213   Prefix_Exception_Messages : Boolean := False;
1214   --  GNAT
1215   --  Set True to prefix exception messages with entity-name:
1216
1217   Preprocessing_Data_File : String_Ptr := null;
1218   --  GNAT
1219   --  Set by switch -gnatep=. The file name of the preprocessing data file.
1220
1221   Preprocessing_Symbol_Defs : String_List_Access := new String_List (1 .. 4);
1222   --  An extensible array to temporarily stores symbol definitions specified
1223   --  on the command line with -gnateD switches. The value 4 is an arbitrary
1224   --  starting point, if more space is needed it is allocated as required.
1225
1226   Preprocessing_Symbol_Last : Natural := 0;
1227   --  Index of last symbol definition in array Symbol_Definitions
1228
1229   Print_Generated_Code : Boolean := False;
1230   --  GNAT
1231   --  Set to True to enable output of generated code in source form. This
1232   --  flag is set by the -gnatG switch.
1233
1234   Print_Standard : Boolean := False;
1235   --  GNAT
1236   --  Set to true to enable printing of package standard in source form.
1237   --  This flag is set by the -gnatS switch
1238
1239   type Usage is (Unknown, Not_In_Use, In_Use);
1240   Project_File_In_Use : Usage := Unknown;
1241   --  GNAT
1242   --  Indicates if a project file is used or not. Set to In_Use by the first
1243   --  SFNP pragma.
1244
1245   Queuing_Policy : Character := ' ';
1246   --  GNAT, GNATBIND
1247   --  Set to ' ' for the default case (no queuing policy specified). Reset to
1248   --  first character (uppercase) of locking policy name if a valid
1249   --  Queuing_Policy pragma is encountered.
1250
1251   Queuing_Policy_Sloc : Source_Ptr := No_Location;
1252   --  GNAT, GNATBIND
1253   --  Remember location of previous Queuing_Policy pragma. This is used for
1254   --  inconsistency error messages. A value of System_Location is used if the
1255   --  policy is set in package System.
1256
1257   Quiet_Output : Boolean := False;
1258   --  GNATMAKE, GNATCLEAN, GPRBUILD, GPRCLEAN
1259   --  Set to True if the tool should not have any output if there are no
1260   --  errors or warnings.
1261
1262   Overriding_Renamings : Boolean := False;
1263   --  GNAT
1264   --  Set to True to enable compatibility mode with Rational compiler, and
1265   --  to accept renamings of implicit operations in their own scope.
1266
1267   Relaxed_RM_Semantics : Boolean := False;
1268   --  GNAT
1269   --  Set to True to ignore some Ada semantic error to help parse legacy Ada
1270   --  code for use in e.g. static analysis (such as CodePeer). This deals
1271   --  with cases where other compilers allow illegal constructs. Tools such as
1272   --  CodePeer are interested in analyzing code rather than enforcing legality
1273   --  rules, so as long as these illegal constructs end up with code that can
1274   --  be handled by the tool in question, there is no reason to reject the
1275   --  code that is considered correct by the other compiler.
1276
1277   Replace_In_Comments : Boolean := False;
1278   --  GNATPREP
1279   --  Set to True if -C switch used.
1280
1281   RTS_Lib_Path_Name : String_Ptr := null;
1282   RTS_Src_Path_Name : String_Ptr := null;
1283   --  GNAT
1284   --  Set to the "adalib" and "adainclude" directories of the run time
1285   --  specified by --RTS=.
1286
1287   RTS_Switch : Boolean := False;
1288   --  GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
1289   --  Set to True when the --RTS switch is set
1290
1291   Run_Path_Option : Boolean := True;
1292   --  GNATMAKE, GNATLINK
1293   --  Set to False when no run_path_option should be issued to the linker
1294
1295   Search_Directory_Present : Boolean := False;
1296   --  GNAT
1297   --  Set to True when argument is -I. Reset to False when next argument, a
1298   --  search directory path is taken into account. Note that this is quite
1299   --  different from other switches in this section in that it is only set in
1300   --  a transitory manner as a result of scanning a -I switch with no file
1301   --  name, and if set, is an indication that the next argument is to be
1302   --  treated as a file name.
1303
1304   Sec_Stack_Used : Boolean := False;
1305   --  GNAT, GBATBIND
1306   --  Set True if generated code uses the System.Secondary_Stack package. For
1307   --  the binder, set if any unit uses the secondary stack package.
1308
1309   Setup_Projects : Boolean := False;
1310   --  GNAT DRIVER
1311   --  Set to True for GNAT SETUP: the Project Manager creates non existing
1312   --  object, library and exec directories.
1313
1314   Shared_Libgnat : Boolean;
1315   --  GNATBIND
1316   --  Set to True if a shared libgnat is requested by using the -shared option
1317   --  for GNATBIND and to False when using the -static option. The value of
1318   --  this flag is set by Gnatbind.Scan_Bind_Arg.
1319
1320   Short_Circuit_And_Or : Boolean := False;
1321   --  GNAT
1322   --  Set True if a pragma Short_Circuit_And_Or applies to the current unit.
1323
1324   type SPARK_Mode_Type is (None, Off, On);
1325   --  Possible legal modes that can be set by aspect/pragma SPARK_Mode, as
1326   --  well as the value None, which indicates no such pragma/aspect applies.
1327
1328   SPARK_Mode : SPARK_Mode_Type := None;
1329   --  GNAT
1330   --  Current SPARK mode setting.
1331
1332   SPARK_Mode_Pragma : Node_Id := Empty;
1333   --  GNAT
1334   --  If the current SPARK_Mode (above) was set by a pragma, this records
1335   --  the pragma that set this mode.
1336
1337   SPARK_Switches_File_Name : String_Ptr := null;
1338   --  GNAT
1339   --  Set to non-null file name by use of the -gnates switch to specify
1340   --  SPARK (gnat2why) specific switches in the given file name.
1341
1342   Special_Exception_Package_Used : Boolean := False;
1343   --  GNAT
1344   --  Set to True if either of the unit GNAT.Most_Recent_Exception or
1345   --  GNAT.Exception_Traces is with'ed. Used to inhibit transformation of
1346   --  local raise statements into gotos in the presence of either package.
1347
1348   Sprint_Line_Limit : Nat := 72;
1349   --  GNAT
1350   --  Limit values for chopping long lines in Cprint/Sprint output, can be
1351   --  reset by use of NNN parameter with -gnatG or -gnatD switches.
1352
1353   Stack_Checking_Enabled : Boolean := False;
1354   --  GNAT
1355   --  Set to indicate if stack checking is enabled for the compilation. This
1356   --  is set directly from the value in the gcc back end in the body of the
1357   --  gcc version of back_end.adb.
1358
1359   Style_Check : Boolean := False;
1360   --  GNAT
1361   --  Set True to perform style checks. Activates checks carried out in
1362   --  package Style (see body of this package for details of checks). This
1363   --  flag is set True by use of either the -gnatg or -gnaty switches, or
1364   --  by the Style_Check pragma.
1365
1366   Style_Check_Main : Boolean := False;
1367   --  GNAT
1368   --  Set True if Style_Check was set for the main unit. This is used to
1369   --  renable style checks for units in the mail extended source that get
1370   --  with'ed indirectly. It is set True by use of either the -gnatg or
1371   --  -gnaty switches, but not by use of the Style_Checks pragma.
1372
1373   Disable_FE_Inline        : Boolean := False;
1374   Disable_FE_Inline_Always : Boolean := False;
1375   --  GNAT
1376   --  Request to disable front end inlining from pragma Inline or pragma
1377   --  Inline_Always out of the presence of the -fno-inline back end flag
1378   --  on the command line, regardless of any other switches that are set.
1379   --  It remains the back end's reponsibility to honor -fno-inline at the
1380   --  back end level.
1381
1382   Suppress_Control_Flow_Optimizations : Boolean := False;
1383   --  GNAT
1384   --  Set by -fpreserve-control-flow. Suppresses control flow optimizations
1385   --  that interfere with coverage analysis based on the object code.
1386
1387   System_Extend_Pragma_Arg : Node_Id := Empty;
1388   --  GNAT
1389   --  Set non-empty if and only if a correct Extend_System pragma was present
1390   --  in which case it points to the argument of the pragma, and the name can
1391   --  be located as Chars (Expression (System_Extend_Pragma_Arg)).
1392
1393   System_Extend_Unit : Node_Id := Empty;
1394   --  GNAT
1395   --  This is set to Empty if GNAT_Mode is set, since pragma Extend_System
1396   --  is never appropriate in GNAT_Mode (and causes troubles, including
1397   --  bogus circularities, if we try to compile the run-time library with
1398   --  a System extension). If GNAT_Mode is not set, then System_Extend_Unit
1399   --  is a copy of the value set in System_Extend_Pragma_Arg.
1400
1401   Subunits_Missing : Boolean := False;
1402   --  GNAT
1403   --  This flag is set true if missing subunits are detected with code
1404   --  generation active. This causes code generation to be skipped.
1405
1406   Suppress_Checks : Boolean := False;
1407   --  GNAT
1408   --  Set to True if -gnatp (suppress all checks) switch present.
1409
1410   Suppress_Options : Suppress_Record;
1411   --  GNAT
1412   --  Indicates outer level setting of check suppression. This initializes
1413   --  the settings of the outer scope level in any unit compiled. This is
1414   --  initialized by Osint.Initialize, and further initialized by the
1415   --  Adjust_Global_Switches flag in Gnat1drv.
1416
1417   Table_Factor : Int := 1;
1418   --  GNAT
1419   --  Factor by which all initial table sizes set in Alloc are multiplied.
1420   --  Used in Table to calculate initial table sizes (the initial table size
1421   --  is the value in Alloc, used as the Table_Initial parameter value,
1422   --  multiplied by the factor given here. The default value is used if no
1423   --  -gnatT switch appears.
1424
1425   Tagged_Type_Expansion : Boolean := True;
1426   --  GNAT
1427   --  Set True if tagged types and interfaces should be expanded by the
1428   --  front-end. If False, the original tree is left unexpanded for tagged
1429   --  types and dispatching calls, assuming the underlying target supports
1430   --  it (e.g. in the JVM case).
1431
1432   Target_Dependent_Info_Read_Name : String_Ptr := null;
1433   --  GNAT
1434   --  Set non-null to override the normal processing in Get_Targ and set the
1435   --  necessary information by reading the target dependent information file
1436   --  whose name is given here (see packages Get_Targ and Set_Targ for full
1437   --  details). Set to non-null file name by use of the -gnateT switch.
1438
1439   Target_Dependent_Info_Write_Name : String_Ptr := null;
1440   --  GNAT
1441   --  Set non-null to enable a call to Set_Targ.Write_Target_Dependent_Info
1442   --  which writes a target independent information file (see packages
1443   --  Get_Targ and Set_Targ for full details) using the name given by
1444   --  this switch. Set to non-null file name by use of the -gnatet switch.
1445
1446   type Origin_Of_Target is (Unknown, Default, Specified);
1447
1448   Target_Origin : Origin_Of_Target := Unknown;
1449   --  GPRBUILD
1450   --  Indicates the origin of attribute Target in project files
1451
1452   Target_Value : String_Access := null;
1453   --  GPRBUILD
1454   --  Indicates the value of attribute Target in project files
1455
1456   Task_Dispatching_Policy : Character := ' ';
1457   --  GNAT, GNATBIND
1458   --  Set to ' ' for the default case (no task dispatching policy specified).
1459   --  Reset to first character (uppercase) of task dispatching policy name
1460   --  if a valid Task_Dispatching_Policy pragma is encountered.
1461
1462   Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
1463   --  GNAT, GNATBIND
1464   --  Remember location of previous Task_Dispatching_Policy pragma. This is
1465   --  used for inconsistency error messages. A value of System_Location is
1466   --  used if the policy is set in package System.
1467
1468   Tasking_Used : Boolean := False;
1469   --  Set True if any tasking construct is encountered. Used to activate the
1470   --  output of the Q, L and T lines in ALI files.
1471
1472   Time_Slice_Set : Boolean := False;
1473   --  GNATBIND
1474   --  Set True if a pragma Time_Slice is processed in the main unit, or
1475   --  if the -gnatTnn switch is present to set a time slice value.
1476
1477   Time_Slice_Value : Nat;
1478   --  GNATBIND
1479   --  Time slice value. Valid only if Time_Slice_Set is True, i.e. if
1480   --  Time_Slice pragma has been processed. Set to the time slice value in
1481   --  microseconds. Negative values are stored as zero, and the value is not
1482   --  larger than 1_000_000_000 (1000 seconds). Values larger than this are
1483   --  reset to this maximum. This can also be set with the -gnatTnn switch.
1484
1485   Tolerate_Consistency_Errors : Boolean := False;
1486   --  GNATBIND
1487   --  Tolerate time stamp and other consistency errors. If this flag is set to
1488   --  True (-t), then inconsistencies result in warnings rather than errors.
1489
1490   Treat_Categorization_Errors_As_Warnings : Boolean := False;
1491   --  Normally categorization errors are true illegalities. If this switch
1492   --  is set, then such errors result in warning messages rather than error
1493   --  messages. Set True by -gnateP (P for Pure/Preelaborate). Also set in
1494   --  Relaxed_RM_Semantics mode since some old Ada 83 compilers treated
1495   --  pragma Preelaborate differently.
1496
1497   Treat_Restrictions_As_Warnings : Boolean := False;
1498   --  GNAT
1499   --  Set True to treat pragma Restrictions as Restriction_Warnings. Set by
1500   --  -gnatr switch.
1501
1502   Tree_Output : Boolean := False;
1503   --  GNAT
1504   --  Set to True (-gnatt) to generate output tree file
1505
1506   Try_Semantics : Boolean := False;
1507   --  GNAT
1508   --  Flag set to force attempt at semantic analysis, even if parser errors
1509   --  occur. This will probably cause blowups at this stage in the game. On
1510   --  the other hand, most such blowups will be caught cleanly and simply
1511   --  say compilation abandoned. This flag is set True by -gnatq or -gnatQ.
1512
1513   Unchecked_Shared_Lib_Imports : Boolean := False;
1514   --  GPRBUILD
1515   --  Set to True when shared library projects are allowed to import projects
1516   --  that are not shared library projects. Set on by use of the switch
1517   --  --unchecked-shared-lib-imports.
1518
1519   Undefined_Symbols_Are_False : Boolean := False;
1520   --  GNAT, GNATPREP
1521   --  Set to True by switch -u of gnatprep or -u in the preprocessing data
1522   --  file for the compiler. Indicates that while preprocessing sources,
1523   --  symbols that are not defined have the value FALSE.
1524
1525   Uneval_Old : Character := 'E';
1526   --  GNAT
1527   --  Set to 'E'/'W'/'A' for use of Error/Warn/Allow in a valid pragma
1528   --  Unevaluated_Use_Of_Old. Default in the absence of the pragma is 'E'
1529   --  for the RM default behavior of giving an error.
1530
1531   Unique_Error_Tag : Boolean := Tag_Errors;
1532   --  GNAT
1533   --  Indicates if error messages are to be prefixed by the string error:
1534   --  Initialized from Tag_Errors, can be forced on with the -gnatU switch.
1535
1536   Unnest_Subprogram_Mode : Boolean := False;
1537   --  If true, activates the circuitry for unnesting subprograms (see the spec
1538   --  of Exp_Unst for full details). Currently set only by use of -gnatd.1.
1539
1540   Universal_Addressing_On_AAMP : Boolean := False;
1541   --  GNAAMP
1542   --  Indicates if library-level objects should be accessed and updated using
1543   --  universal addressing instructions on the AAMP architecture. This flag is
1544   --  set to True when pragma Universal_Data is given as a configuration
1545   --  pragma.
1546
1547   Unreserve_All_Interrupts : Boolean := False;
1548   --  GNAT, GNATBIND
1549   --  Normally set False, set True if a valid Unreserve_All_Interrupts pragma
1550   --  appears anywhere in the main unit for GNAT, or if any ALI file has the
1551   --  corresponding attribute set in GNATBIND.
1552
1553   Upper_Half_Encoding : Boolean := False;
1554   --  GNAT, GNATBIND
1555   --  Normally set False, indicating that upper half ISO 8859-1 characters are
1556   --  used in the normal way to represent themselves. If the wide character
1557   --  encoding method uses the upper bit for this encoding, then this flag is
1558   --  set True, and upper half characters in the source indicate the start of
1559   --  a wide character sequence. Set by -gnatW or -W switches.
1560
1561   Use_Include_Path_File : Boolean := False;
1562   --  GNATMAKE, GPRBUILD
1563   --  When True, create a source search path file, even when a mapping file
1564   --  is used.
1565
1566   Usage_Requested : Boolean := False;
1567   --  GNAT, GNATBIND, GNATMAKE
1568   --  Set to True if -h (-gnath for the compiler) switch encountered
1569   --  requesting usage information
1570
1571   Use_Pragma_Linker_Constructor : Boolean := False;
1572   --  GNATBIND
1573   --  True if pragma Linker_Constructor applies to adainit
1574
1575   Use_VADS_Size : Boolean := False;
1576   --  GNAT
1577   --  Set to True if a valid pragma Use_VADS_Size is processed
1578
1579   Validity_Checks_On  : Boolean := True;
1580   --  GNAT
1581   --  This flag determines if validity checking is on or off. The initial
1582   --  state is on, and the required default validity checks are active. The
1583   --  actual set of checks that is performed if Validity_Checks_On is set is
1584   --  defined by the switches in package Validsw. The Validity_Checks_On flag
1585   --  is controlled by pragma Validity_Checks (On | Off), and also some
1586   --  generated compiler code (typically code that has to do with validity
1587   --  check generation) is compiled with this flag set to False. This flag is
1588   --  set to False by the -gnatp switch.
1589
1590   Verbose_Mode : Boolean := False;
1591   --  GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATNAME, GNATCLEAN,
1592   --  GPRBUILD, GPRCLEAN
1593   --  Set to True to get verbose mode (full error message text and location
1594   --  information sent to standard output, also header, copyright and summary)
1595
1596   type Verbosity_Level_Type is (None, Low, Medium, High);
1597   pragma Ordered (Verbosity_Level_Type);
1598   Verbosity_Level : Verbosity_Level_Type := High;
1599   --  GNATMAKE
1600   --  Modified by gnatmake switches -v, -vl, -vm, -vh. Indicates
1601   --  the level of verbosity of informational messages:
1602   --
1603   --  In Low Verbosity, the reasons why a source is recompiled, the name
1604   --  of the executable and the reason it must be rebuilt is output.
1605   --
1606   --  In Medium Verbosity, additional lines are output for each ALI file
1607   --  that is checked.
1608   --
1609   --  In High Verbosity, additional lines are output when the ALI file
1610   --  is part of an Ada library, is read-only or is part of the runtime.
1611
1612   Warn_On_Ada_2005_Compatibility : Boolean := True;
1613   --  GNAT
1614   --  Set to True to generate all warnings on Ada 2005 compatibility issues,
1615   --  including warnings on Ada 2005 obsolescent features used in Ada 2005
1616   --  mode. Set by default, modified by use of -gnatwy/Y.
1617
1618   Warn_On_Ada_2012_Compatibility : Boolean := True;
1619   --  GNAT
1620   --  Set to True to generate all warnings on Ada 2012 compatibility issues,
1621   --  including warnings on Ada 2012 obsolescent features used in Ada 2012
1622   --  mode. Modified by use of -gnatwy/Y.
1623
1624   Warn_On_All_Unread_Out_Parameters : Boolean := False;
1625   --  GNAT
1626   --  Set to True to generate warnings in all cases where a variable is
1627   --  modified by being passed as to an OUT formal, but the resulting value is
1628   --  never read. The default is that this warning is suppressed. Modified
1629   --  by use of gnatw.o/.O.
1630
1631   Warn_On_Assertion_Failure : Boolean := True;
1632   --  GNAT
1633   --  Set to True to activate warnings on assertions that can be determined
1634   --  at compile time will always fail. Modified by use of -gnatw.a/.A.
1635
1636   Warn_On_Assumed_Low_Bound : Boolean := True;
1637   --  GNAT
1638   --  Set to True to activate warnings for string parameters that are indexed
1639   --  with literals or S'Length, presumably assuming a lower bound of one.
1640   --  Modified by use of -gnatww/W.
1641
1642   Warn_On_Atomic_Synchronization : Boolean := False;
1643   --  GNAT
1644   --  Set to True to generate information messages for atomic synchronization.
1645   --  Modified by use of -gnatw.n/.N.
1646
1647   Warn_On_Bad_Fixed_Value : Boolean := False;
1648   --  GNAT
1649   --  Set to True to generate warnings for static fixed-point expression
1650   --  values that are not an exact multiple of the small value of the type.
1651   --  Odd by default, modified by use of -gnatwb/B.
1652
1653   Warn_On_Biased_Representation : Boolean := True;
1654   --  GNAT
1655   --  Set to True to generate warnings for size clauses, component clauses
1656   --  and component_size clauses that force biased representation. Modified
1657   --  by use of -gnatw.b/.B.
1658
1659   Warn_On_Constant : Boolean := False;
1660   --  GNAT
1661   --  Set to True to generate warnings for variables that could be declared
1662   --  as constants. Modified by use of -gnatwk/K.
1663
1664   Warn_On_Deleted_Code : Boolean := False;
1665   --  GNAT
1666   --  Set to True to generate warnings for code deleted by the front end
1667   --  for conditional statements whose outcome is known at compile time.
1668   --  Modified by use of -gnatwt/T.
1669
1670   Warn_On_Dereference : Boolean := False;
1671   --  GNAT
1672   --  Set to True to generate warnings for implicit dereferences for array
1673   --  indexing and record component access. Modified by use of -gnatwd/D.
1674
1675   Warn_On_Export_Import : Boolean := True;
1676   --  GNAT
1677   --  Set to True to generate warnings for suspicious use of export or
1678   --  import pragmas. Modified by use of -gnatwx/X.
1679
1680   Warn_On_Elab_Access : Boolean := False;
1681   --  GNAT
1682   --  Set to True to generate warnings for P'Access in the case where
1683   --  subprogram P is in the same package as the P'Access, and the P'Access is
1684   --  evaluated at package elaboration time, and occurs before the body of P
1685   --  has been elaborated.
1686
1687   Warn_On_Hiding : Boolean := False;
1688   --  GNAT
1689   --  Set to True to generate warnings if a declared entity hides another
1690   --  entity. The default is that this warning is suppressed. Modified by
1691   --  use of -gnatwh/H.
1692
1693   Warn_On_Modified_Unread : Boolean := False;
1694   --  GNAT
1695   --  Set to True to generate warnings if a variable is assigned but is never
1696   --  read. Also controls warnings for similar cases involving out parameters,
1697   --  but only if there is only one out parameter for the procedure involved.
1698   --  The default is that this warning is suppressed, modified by use of
1699   --  -gnatwm/M.
1700
1701   Warn_On_No_Value_Assigned : Boolean := True;
1702   --  GNAT
1703   --  Set to True to generate warnings if no value is ever assigned to a
1704   --  variable that is at least partially uninitialized. Set to false to
1705   --  suppress such warnings. The default is that such warnings are enabled.
1706   --  Modified by use of -gnatwv/V.
1707
1708   Warn_On_Non_Local_Exception : Boolean := False;
1709   --  GNAT
1710   --  Set to True to generate warnings for non-local exception raises and also
1711   --  handlers that can never handle a local raise. This warning is only ever
1712   --  generated if pragma Restrictions (No_Exception_Propagation) is set. The
1713   --  default is not to generate the warnings except that if the source has
1714   --  at least one exception handler, and this restriction is set, and the
1715   --  warning was not explicitly turned off, then it is turned on by default.
1716   --  Modified by use of -gnatw.x/.X.
1717
1718   No_Warn_On_Non_Local_Exception : Boolean := False;
1719   --  GNAT
1720   --  This is set to True if the above warning is explicitly suppressed. We
1721   --  use this to avoid turning it on by default when No_Exception_Propagation
1722   --  restriction is set and an exception handler is present.
1723
1724   Warn_On_Object_Renames_Function : Boolean := False;
1725   --  GNAT
1726   --  Set to True to generate warnings when a function result is renamed as
1727   --  an object. The default is that this warning is disabled. Modified by
1728   --  use of -gnatw.r/.R.
1729
1730   Warn_On_Obsolescent_Feature : Boolean := False;
1731   --  GNAT
1732   --  Set to True to generate warnings on use of any feature in Annex or if a
1733   --  subprogram is called for which a pragma Obsolescent applies. Modified
1734   --  by use of -gnatwj/J.
1735
1736   Warn_On_Overlap : Boolean := False;
1737   --  GNAT
1738   --  Set to True to generate warnings when a writable actual overlaps with
1739   --  another actual in a subprogram call. This applies only in modes before
1740   --  Ada 2012. Starting with Ada 2012, such overlaps are illegal.
1741   --  Modified by use of -gnatw.i/.I.
1742
1743   Warn_On_Questionable_Missing_Parens : Boolean := True;
1744   --  GNAT
1745   --  Set to True to generate warnings for cases where parentheses are missing
1746   --  and the usage is questionable, because the intent is unclear. On by
1747   --  default, modified by use of -gnatwq/Q.
1748
1749   Warn_On_Parameter_Order : Boolean := False;
1750   --  GNAT
1751   --  Set to True to generate warnings for cases where the argument list for
1752   --  a call is a sequence of identifiers that match the formal identifiers,
1753   --  but are in the wrong order.
1754
1755   Warn_On_Redundant_Constructs : Boolean := False;
1756   --  GNAT
1757   --  Set to True to generate warnings for redundant constructs (e.g. useless
1758   --  assignments/conversions). The default is that this warning is disabled.
1759   --  Modified by use of -gnatwr/R.
1760
1761   Warn_On_Reverse_Bit_Order : Boolean := True;
1762   --  GNAT
1763   --  Set to True to generate warning (informational) messages for component
1764   --  clauses that are affected by non-standard bit-order. The default is
1765   --  that this warning is enabled. Modified by -gnatw.v/.V.
1766
1767   Warn_On_Suspicious_Contract : Boolean := True;
1768   --  GNAT
1769   --  Set to True to generate warnings for suspicious contracts expressed as
1770   --  pragmas or aspects precondition and postcondition, as well as other
1771   --  suspicious cases of expressions typically found in contracts like
1772   --  quantified expressions and uses of Update attribute. The default is that
1773   --  this warning is enabled. Modified by use of -gnatw.t/.T.
1774
1775   Warn_On_Suspicious_Modulus_Value : Boolean := True;
1776   --  GNAT
1777   --  Set to True to generate warnings for suspicious modulus values. The
1778   --  default is that this warning is enabled. Modified by -gnatw.m/.M.
1779
1780   Warn_On_Unchecked_Conversion : Boolean := True;
1781   --  GNAT
1782   --  Set to True to generate warnings for unchecked conversions that may have
1783   --  non-portable semantics (e.g. because sizes of types differ). Modified
1784   --  by use of -gnatwz/Z.
1785
1786   Warn_On_Unordered_Enumeration_Type : Boolean := False;
1787   --  GNAT
1788   --  Set to True to generate warnings for inappropriate uses (comparisons
1789   --  and explicit ranges) on unordered enumeration types (which includes
1790   --  all enumeration types for which pragma Ordered is not given). The
1791   --  default is that this warning is disabled. Modified by -gnat.u/.U.
1792
1793   Warn_On_Unrecognized_Pragma : Boolean := True;
1794   --  GNAT
1795   --  Set to True to generate warnings for unrecognized pragmas. The default
1796   --  is that this warning is enabled. Modified by use of -gnatwg/G.
1797
1798   Warn_On_Unrepped_Components : Boolean := False;
1799   --  GNAT
1800   --  Set to True to generate warnings for the case of components of record
1801   --  which have a record representation clause but this component does not
1802   --  have a component clause. Modified by use of -gnatw.c/.C.
1803
1804   Warn_On_Warnings_Off : Boolean := False;
1805   --  GNAT
1806   --  Set to True to generate warnings for use of Pragma Warnings (Off, ent),
1807   --  where either the pragma is never used, or it could be replaced by a
1808   --  pragma Unmodified or Unreferenced. Also generates warnings for pragma
1809   --  Warning (Off, string) which either has no matching pragma Warning On,
1810   --  or where no warning has been suppressed by the use of the pragma.
1811   --  Modified by use of -gnatw.w/.W.
1812
1813   type Warning_Mode_Type is (Suppress, Normal, Treat_As_Error);
1814   Warning_Mode : Warning_Mode_Type := Normal;
1815   --  GNAT, GNATBIND
1816   --  Controls treatment of warning messages. If set to Suppress, warning
1817   --  messages are not generated at all. In Normal mode, they are generated
1818   --  but do not count as errors. In Treat_As_Error mode, warning messages are
1819   --  generated and are treated as errors. Note that Warning_Mode = Suppress
1820   --  causes pragma Warnings to be ignored (except for legality checks),
1821   --  unless we are in GNATprove_Mode, which requires pragma Warnings to
1822   --  be stored for the formal verification backend.
1823
1824   Warnings_As_Errors_Count : Natural;
1825   --  GNAT
1826   --  Number of entries stored in Warnings_As_Errors table
1827
1828   Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1829   --  GNAT, GNATBIND
1830   --  Method used for encoding wide characters in the source program. See
1831   --  description of type in unit System.WCh_Con for a list of the methods
1832   --  that are currently supported. Note that brackets notation is always
1833   --  recognized in source programs regardless of the setting of this
1834   --  variable. The default setting causes only the brackets notation to be
1835   --  recognized. If this is the main unit, this setting also controls the
1836   --  output of the W=? parameter in the ALI file, which is used to provide
1837   --  the default for encoding [Wide_[Wide_]]Text_IO files. For the binder,
1838   --  the value set here overrides this main unit default.
1839
1840   Wide_Character_Encoding_Method_Specified : Boolean := False;
1841   --  GNAT, GNATBIND
1842   --  Set True if the value in Wide_Character_Encoding_Method was set as
1843   --  a result of an explicit -gnatW? or -W? switch. False otherwise.
1844
1845   Xref_Active : Boolean := True;
1846   --  GNAT
1847   --  Set if cross-referencing is enabled (i.e. xref info in ALI files)
1848
1849   Zero_Formatting : Boolean := False;
1850   --  GNATBIND
1851   --  Do no formatting (no title, no leading spaces, no empty lines) in
1852   --  auxiliary outputs (-e, -K, -l, -R).
1853
1854   ----------------------------
1855   -- Configuration Settings --
1856   ----------------------------
1857
1858   --  These are settings that are used to establish the mode at the start of
1859   --  each unit. The values defined below can be affected either by command
1860   --  line switches, or by the use of appropriate configuration pragmas in a
1861   --  configuration pragma file (but NOT by a local use of a configuration
1862   --  pragma in a single file).
1863
1864   Ada_Version_Config : Ada_Version_Type;
1865   --  GNAT
1866   --  This is the value of the configuration switch for the Ada 83 mode, as
1867   --  set by the command line switches -gnat83/95/2005/2012, and possibly
1868   --  modified by the use of configuration pragmas Ada_*. This switch is used
1869   --  to set the initial value for Ada_Version mode at the start of analysis
1870   --  of a unit.  Note however that the setting of this flag is ignored for
1871   --  internal and predefined units (which are always compiled in the most up
1872   --  to date version of Ada).
1873
1874   Ada_Version_Pragma_Config : Node_Id;
1875   --  This will be set non empty if it is set by a configuration pragma
1876
1877   Ada_Version_Explicit_Config : Ada_Version_Type;
1878   --  GNAT
1879   --  This is set in the same manner as Ada_Version_Config. The difference is
1880   --  that the setting of this flag is not ignored for internal and predefined
1881   --  units, which for some purposes do indeed access this value, regardless
1882   --  of the fact that they are compiled the most up to date ada version).
1883
1884   Assertions_Enabled_Config : Boolean;
1885   --  GNAT
1886   --  This is the value of the configuration switch for assertions enabled
1887   --  mode, as possibly set by the command line switch -gnata, and possibly
1888   --  modified by the use of the configuration pragma Assertion_Policy.
1889
1890   Assume_No_Invalid_Values_Config : Boolean;
1891   --  GNAT
1892   --  This is the value of the configuration switch for assuming "no invalid
1893   --  values enabled" mode, as possibly set by the command line switch
1894   --  -gnatB, and possibly modified by the use of the configuration pragma
1895   --  Assume_No_Invalid_Values.
1896
1897   Check_Float_Overflow_Config : Boolean;
1898   --  GNAT
1899   --  Set to True to check that operations on predefined unconstrained float
1900   --  types (e.g. Float, Long_Float) do not overflow and generate infinities
1901   --  or invalid values. Set by the Check_Float_Overflow pragma, or by use
1902   --  of the -gnateF switch.
1903
1904   Check_Policy_List_Config : Node_Id;
1905   --  GNAT
1906   --  This points to the list of N_Pragma nodes for Check_Policy pragmas
1907   --  that are linked through the Next_Pragma fields, with the list being
1908   --  terminated by Empty. The order is most recently processed first. This
1909   --  list includes only those pragmas in configuration pragma files.
1910
1911   Default_Pool_Config : Node_Id := Empty;
1912   --  GNAT
1913   --  Same as Default_Pool above, except this is only for Default_Storage_Pool
1914   --  pragmas that are configuration pragmas.
1915
1916   Default_SSO_Config : Character := ' ';
1917   --  GNAT
1918   --  Set if a pragma Default_Scalar_Storage_Order appears as a configuration
1919   --  pragma. A value of ' ' means that no pragma was given, otherwise the
1920   --  value is 'H' for High_Order_First or 'L' for Low_Order_First.
1921
1922   Dynamic_Elaboration_Checks_Config : Boolean := False;
1923   --  GNAT
1924   --  Set True for dynamic elaboration checking mode, as set by the -gnatE
1925   --  switch or by the use of pragma Elaboration_Checking (Dynamic).
1926
1927   Exception_Locations_Suppressed_Config : Boolean := False;
1928   --  GNAT
1929   --  Set True by use of the configuration pragma Suppress_Exception_Messages
1930
1931   Extensions_Allowed_Config : Boolean;
1932   --  GNAT
1933   --  This is the flag that indicates whether extensions are allowed. It can
1934   --  be set True either by use of the -gnatX switch, or by use of the
1935   --  configuration pragma Extensions_Allowed (On). It is always set to True
1936   --  for internal GNAT units, since extensions are always permitted in such
1937   --  units.
1938
1939   External_Name_Exp_Casing_Config : External_Casing_Type;
1940   --  GNAT
1941   --  This is the value of the configuration switch that controls casing of
1942   --  external symbols for which an explicit external name is given. It can be
1943   --  set to Uppercase by the command line switch -gnatF, and further modified
1944   --  by the use of the configuration pragma External_Name_Casing in the
1945   --  gnat.adc file. This flag is used to set the initial value for
1946   --  External_Name_Exp_Casing at the start of analyzing each unit. Note
1947   --  however that the setting of this flag is ignored for internal and
1948   --  predefined units (which are always compiled with As_Is mode).
1949
1950   External_Name_Imp_Casing_Config : External_Casing_Type;
1951   --  GNAT
1952   --  This is the value of the configuration switch that controls casing of
1953   --  external symbols where the external name is implicitly given. It can be
1954   --  set to Uppercase by the command line switch -gnatF, and further modified
1955   --  by the use of the configuration pragma External_Name_Casing in the
1956   --  gnat.adc file. This flag is used to set the initial value for
1957   --  External_Name_Imp_Casing at the start of analyzing each unit. Note
1958   --  however that the setting of this flag is ignored for internal and
1959   --  predefined units (which are always compiled with Lowercase mode).
1960
1961   Fast_Math_Config : Boolean;
1962   --  GNAT
1963   --  This is the value of the configuration switch that controls Fast_Math
1964   --  mode, as set by a Fast_Math pragma in configuration pragmas. It is
1965   --  used to set the initial value of Fast_Math at the start of each new
1966   --  compilation unit.
1967
1968   Initialize_Scalars_Config : Boolean;
1969   --  GNAT
1970   --  This is the value of the configuration switch that is set by the
1971   --  pragma Initialize_Scalars when it appears in the gnat.adc file.
1972   --  This switch is not set when the pragma appears ahead of a given
1973   --  unit, so it does not affect the compilation of other units.
1974
1975   No_Exit_Message : Boolean := False;
1976   --  GNATMAKE, GPRBUILD
1977   --  Set with switch --no-exit-message. When True, if there are compilation
1978   --  failures, the builder does not issue an exit error message.
1979
1980   Optimize_Alignment_Config : Character;
1981   --  GNAT
1982   --  This is the value of the configuration switch that controls the
1983   --  alignment optimization mode, as set by an Optimize_Alignment pragma.
1984   --  It is used to set the initial value of Optimize_Alignment at the start
1985   --  of each new compilation unit, except that it is always set to 'O' (off)
1986   --  for internal units.
1987
1988   Persistent_BSS_Mode_Config : Boolean;
1989   --  GNAT
1990   --  This is the value of the configuration switch that controls whether
1991   --  potentially persistent data is to be placed in the persistent_bss
1992   --  section. It can be set True by use of the pragma Persistent_BSS.
1993   --  This flag is used to set the initial value of Persistent_BSS_Mode
1994   --  at the start of each compilation unit, except that it is always
1995   --  set False for predefined units.
1996
1997   Polling_Required_Config : Boolean;
1998   --  GNAT
1999   --  This is the value of the configuration switch that controls polling
2000   --  mode. It can be set True by the command line switch -gnatP, and then
2001   --  further modified by the use of pragma Polling in the gnat.adc file. This
2002   --  flag is used to set the initial value for Polling_Required at the start
2003   --  of analyzing each unit.
2004
2005   Prefix_Exception_Messages_Config : Boolean;
2006   --  The setting of Prefix_Exception_Messages from configuration pragmas
2007
2008   SPARK_Mode_Config : SPARK_Mode_Type := None;
2009   --  GNAT
2010   --  The setting of SPARK_Mode from configuration pragmas
2011
2012   SPARK_Mode_Pragma_Config : Node_Id := Empty;
2013   --  If a SPARK_Mode pragma appeared in the configuration pragmas (setting
2014   --  SPARK_Mode_Config appropriately), then this points to the N_Pragma node.
2015
2016   Uneval_Old_Config : Character;
2017   --  GNAT
2018   --  The setting of Uneval_Old from configuration pragmas
2019
2020   Use_VADS_Size_Config : Boolean;
2021   --  GNAT
2022   --  This is the value of the configuration switch that controls the use of
2023   --  VADS_Size instead of Size wherever the attribute Size is used. It can
2024   --  be set True by the use of the pragma Use_VADS_Size in the gnat.adc file.
2025   --  This flag is used to set the initial value for Use_VADS_Size at the
2026   --  start of analyzing each unit. Note however that the setting of this flag
2027   --  is ignored for internal and predefined units (which are always compiled
2028   --  with the standard Size semantics).
2029
2030   Warnings_As_Errors_Count_Config : Natural;
2031   --  GNAT
2032   --  Count of pattern strings stored from Warning_As_Error pragmas
2033
2034   type Config_Switches_Type is private;
2035   --  Type used to save values of the switches set from Config values
2036
2037   procedure Save_Opt_Config_Switches (Save : out Config_Switches_Type);
2038   --  This procedure saves the current values of the switches which are
2039   --  initialized from the above Config values, and then resets these switches
2040   --  according to the Config value settings.
2041
2042   procedure Set_Opt_Config_Switches
2043     (Internal_Unit : Boolean;
2044      Main_Unit     : Boolean);
2045   --  This procedure sets the switches to the appropriate initial values. The
2046   --  parameter Internal_Unit is True for an internal or predefined unit, and
2047   --  affects the way the switches are set (see above). Main_Unit is true if
2048   --  switches are being set for the main unit or for the spec of the main
2049   --  unit. This affects setting of the assert/debug pragma switches, which
2050   --  are normally set false by default for an internal unit, except when the
2051   --  internal unit is the main unit, in which case we use the command line
2052   --  settings).
2053
2054   procedure Restore_Opt_Config_Switches (Save : Config_Switches_Type);
2055   --  This procedure restores a set of switch values previously saved by a
2056   --  call to Save_Opt_Config_Switches (Save).
2057
2058   procedure Register_Opt_Config_Switches;
2059   --  This procedure is called after processing the gnat.adc file and other
2060   --  configuration pragma files to record the values of the Config switches,
2061   --  as possibly modified by the use of command line switches and pragmas
2062   --  appearing in these files.
2063
2064   ------------------------
2065   -- Other Global Flags --
2066   ------------------------
2067
2068   Expander_Active : Boolean := False;
2069   --  A flag that indicates if expansion is active (True) or deactivated
2070   --  (False). When expansion is deactivated all calls to expander routines
2071   --  have no effect. Note that the initial setting of False is merely to
2072   --  prevent saving of an undefined value for an initial call to the
2073   --  Expander_Mode_Save_And_Set procedure. For more information on the use of
2074   --  this flag, see package Expander. Indeed this flag might more logically
2075   --  be in the spec of Expander, but it is referenced by Errout, and it
2076   --  really seems wrong for Errout to depend on Expander.
2077
2078   Static_Dispatch_Tables : Boolean := True;
2079   --  This flag indicates if the backend supports generation of statically
2080   --  allocated dispatch tables. If it is True, then the front end will
2081   --  generate static aggregates for dispatch tables that contain forward
2082   --  references to addresses of subprograms not seen yet, and the back end
2083   --  must be prepared to handle this case. If it is False, then the front
2084   --  end generates assignments to initialize the dispatch table, and there
2085   --  are no such forward references. By default we build statically allocated
2086   --  dispatch tables for all library level tagged types in all platforms.This
2087   --  behavior can be disabled using switch -gnatd.t which will set this flag
2088   --  to False and revert to the previous dynamic behavior.
2089
2090   -----------------------
2091   -- Tree I/O Routines --
2092   -----------------------
2093
2094   procedure Tree_Read;
2095   --  Reads switch settings from current tree file using Tree_Read
2096
2097   procedure Tree_Write;
2098   --  Writes out switch settings to current tree file using Tree_Write
2099
2100   --------------------------
2101   -- ASIS Version Control --
2102   --------------------------
2103
2104   --  These two variables (Tree_Version_String and Tree_ASIS_Version_Number)
2105   --  are supposed to be used in the GNAT/ASIS version check performed in
2106   --  the ASIS code (this package is also a part of the ASIS implementation).
2107   --  They are set by Tree_Read procedure, so they represent the version
2108   --  number (and the version string) of the compiler which has created the
2109   --  tree, and they are supposed to be compared with the corresponding values
2110   --  from the Tree_IO and Gnatvsn packages which also are a part of ASIS
2111   --  implementation.
2112
2113   Tree_Version_String : String_Access;
2114   --  Used to store the compiler version string read from a tree file to check
2115   --  if it is from the same date as stored in the version string in Gnatvsn.
2116   --  We require that ASIS Pro can be used only with GNAT Pro, but we allow
2117   --  non-Pro ASIS and ASIS-based tools to be used with any version of the
2118   --  GNAT compiler. Therefore, we need the possibility to compare the dates
2119   --  of the corresponding source sets, using version strings that may be
2120   --  of different lengths.
2121
2122   Tree_ASIS_Version_Number : Int;
2123   --  Used to store the ASIS version number read from a tree file to check if
2124   --  it is the same as stored in the ASIS version number in Tree_IO.
2125
2126   -----------------------------------
2127   -- Modes for Formal Verification --
2128   -----------------------------------
2129
2130   GNATprove_Mode : Boolean := False;
2131   --  Specific compiling mode targeting formal verification for those parts
2132   --  of the input code that belong to the SPARK 2014 subset of Ada. Set True
2133   --  by the gnat2why executable or by use of the -gnatd.F debug switch. Note
2134   --  that this is completely separate from the SPARK restriction defined in
2135   --  GNAT to detect violations of a subset of SPARK 2005 rules.
2136
2137   ---------------------------
2138   -- Error/Warning Control --
2139   ---------------------------
2140
2141   --  The following array would more reasonably be located in Err_Vars or
2142   --  Errour, but but we put them here to deal with licensing issues (we need
2143   --  this to have the GPL exception licensing, since these variables and
2144   --  subprograms are accessed from units with this licensing).
2145
2146   Warnings_As_Errors : array (1 .. 10_000) of String_Ptr;
2147   --  Table for recording Warning_As_Error pragmas as they are processed.
2148   --  It would be nicer to use Table, but there are circular elaboration
2149   --  problems if we try to do this, and an attempt to find some other
2150   --  appropriately licensed unit to declare this as a Table failed with
2151   --  various elaboration circularities. Memory is getting cheap these days!
2152
2153   ---------------
2154   -- GNAT_Mode --
2155   ---------------
2156
2157   GNAT_Mode : Boolean := False;
2158   --  GNAT
2159   --  True if compiling in GNAT system mode (-gnatg switch)
2160
2161   GNAT_Mode_Config : Boolean := False;
2162   --  GNAT
2163   --  True if -gnatg switch is present. GNAT_Mode may be temporary set to
2164   --  True during the analysis of a system unit, but GNAT_Mode_Config must
2165   --  not change once scanned and set.
2166
2167   --  Setting GNAT mode has the following effects on the language that is
2168   --  accepted. Note that several of the following have the effect of changing
2169   --  an error to a warning. But warnings are usually treated as fatal errors
2170   --  in -gnatg mode, so to actually take advantage of such a change, it is
2171   --  necessary to add an explicit pragma Warnings (Off) in the source and
2172   --  this requires clear documentation of why this is necessary.
2173
2174   --    The identifier character set is set to 'n' (7-bit ASCII)
2175
2176   --    Pragma Extend_System is ignored
2177
2178   --    Warning_Mode is set to Treat_As_Error (-gnatwe)
2179
2180   --    Standard style checks are set (See Set_GNAT_Style_Check_Options)
2181
2182   --    Standard warnings are turned on (see Set_GNAT_Mode_Warnings)
2183
2184   --    The Ada version is set to Ada 2012
2185
2186   --    Task priorities are always allowed to be in the range Any_Priority
2187
2188   --    Overflow checks are suppressed, overflow checking set to strict mode
2189
2190   --    ALI files are always generated for predefined generic packages
2191
2192   --    Obsolescent feature warnings are suppressed
2193
2194   --    Recompilation of children of GNAT, System, Ada, Interfaces is allowed
2195
2196   --    The Scalar_Storage_Order attribute applies to generic types
2197
2198   --    Categorization errors are treated as warnings rather than errors
2199
2200   --    Statements in preelaborated units give warnings rather than errors
2201
2202   --    Private objects are allowed in preelaborated units
2203
2204   --    Non-static constants in preelaborated units give warnings not errors
2205
2206   --    The warning about component size being ignored is suppressed
2207
2208   --    The warning about size clauses being ignored is suppressed
2209
2210   --    Initializing limited types gives a warning rather than an error
2211
2212   --    Copying of limited objects is allowed
2213
2214   --    Returning objects of limited types is allowed
2215
2216   --    Non-static call in preelaborated unit give a warning, not an error
2217
2218   --    Warnings on possible elaboration errors are suppressed
2219
2220   --    Warnings about packing being ignored are suppressed
2221
2222   --    Warnings in internal units are not suppressed (they normally are)
2223
2224   --    The only special comment sequence allowed is --!
2225
2226   --------------------------
2227   -- Private Declarations --
2228   --------------------------
2229
2230private
2231
2232   --  The following type is used to save and restore settings of switches in
2233   --  Opt that represent the configuration (i.e. result of config pragmas).
2234
2235   --  Note that Ada_Version_Explicit is not included, since this is a sticky
2236   --  flag that once set does not get reset, since the whole idea of this flag
2237   --  is to record the setting for the main unit.
2238
2239   type Config_Switches_Type is record
2240      Ada_Version                    : Ada_Version_Type;
2241      Ada_Version_Explicit           : Ada_Version_Type;
2242      Ada_Version_Pragma             : Node_Id;
2243      Assertions_Enabled             : Boolean;
2244      Assume_No_Invalid_Values       : Boolean;
2245      Check_Float_Overflow           : Boolean;
2246      Check_Policy_List              : Node_Id;
2247      Default_Pool                   : Node_Id;
2248      Default_SSO                    : Character;
2249      Dynamic_Elaboration_Checks     : Boolean;
2250      Exception_Locations_Suppressed : Boolean;
2251      Extensions_Allowed             : Boolean;
2252      External_Name_Exp_Casing       : External_Casing_Type;
2253      External_Name_Imp_Casing       : External_Casing_Type;
2254      Fast_Math                      : Boolean;
2255      Initialize_Scalars             : Boolean;
2256      Normalize_Scalars              : Boolean;
2257      Optimize_Alignment             : Character;
2258      Optimize_Alignment_Local       : Boolean;
2259      Persistent_BSS_Mode            : Boolean;
2260      Polling_Required               : Boolean;
2261      Prefix_Exception_Messages      : Boolean;
2262      SPARK_Mode                     : SPARK_Mode_Type;
2263      SPARK_Mode_Pragma              : Node_Id;
2264      Uneval_Old                     : Character;
2265      Use_VADS_Size                  : Boolean;
2266      Warnings_As_Errors_Count       : Natural;
2267   end record;
2268
2269   --  The following declarations are for GCC version dependent flags. We do
2270   --  not let client code in the compiler test GCC_Version directly, but
2271   --  instead use deferred constants for relevant feature tags.
2272
2273   --  Note: there currently are no such constants defined in this section,
2274   --  since the compiler front end is currently entirely independent of the
2275   --  GCC version, which is a desirable state of affairs.
2276
2277   function get_gcc_version return Int;
2278   pragma Import (C, get_gcc_version, "get_gcc_version");
2279
2280   GCC_Version : constant Nat := get_gcc_version;
2281   --  GNATMAKE
2282   --  Indicates which version of gcc is in use (3 = 3.x, 4 = 4.x). Note that
2283   --  gcc 2.8.1 (which used to be a value of 2) is no longer supported.
2284
2285end Opt;
2286