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