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