OSDN Git Service

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