OSDN Git Service

PR 33870
[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-2007, 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 2,  or (at your option) any later ver- --
14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
20 -- Boston, MA 02110-1301, USA.                                              --
21 --                                                                          --
22 -- As a special exception,  if other files  instantiate  generics from this --
23 -- unit, or you link  this unit with other files  to produce an executable, --
24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
25 -- covered  by the  GNU  General  Public  License.  This exception does not --
26 -- however invalidate  any other reasons why  the executable file  might be --
27 -- covered by the  GNU Public License.                                      --
28 --                                                                          --
29 -- GNAT was originally developed  by the GNAT team at  New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
31 --                                                                          --
32 ------------------------------------------------------------------------------
33
34 --  This package contains global flags set by the initialization routine from
35 --  the command line and referenced throughout the compiler, the binder, or
36 --  other GNAT tools. The comments indicate which options are used by which
37 --  programs (GNAT, GNATBIND, GNATLINK, GNATMAKE, GPRMAKE, etc).
38
39 with Debug;
40 with Hostparm; use Hostparm;
41 with Types;    use Types;
42
43 with System.Strings; use System.Strings;
44 with System.WCh_Con; use System.WCh_Con;
45
46 package Opt is
47
48    ----------------------------------------------
49    -- Settings of Modes for Current Processing --
50    ----------------------------------------------
51
52    --  The following mode values represent the current state of processing.
53    --  The values set here are the default values. Unless otherwise noted,
54    --  the value may be reset in Switch-? with an appropropiate switch. In
55    --  some cases, the values can also be modified by pragmas, and in the
56    --  case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
57    --  the default values.
58
59    Ada_Bind_File : Boolean := True;
60    --  GNATBIND, GNATLINK
61    --  Set True if binder file to be generated in Ada rather than C
62
63    type Ada_Version_Type is (Ada_83, Ada_95, Ada_05);
64    pragma Warnings (Off, Ada_Version_Type);
65    --  Versions of Ada for Ada_Version below. Note that these are ordered,
66    --  so that tests like Ada_Version >= Ada_95 are legitimate and useful.
67    --  The Warnings_Off pragma stops warnings for Ada_Version >= Ada_05,
68    --  which we want to allow, so that things work OK when Ada_15 is added!
69    --  This warning is now removed, so this pragma can be removed some time???
70
71    Ada_Version_Default : Ada_Version_Type := Ada_05;
72    --  GNAT
73    --  Default Ada version if no switch given
74
75    Ada_Version : Ada_Version_Type := Ada_Version_Default;
76    --  GNAT
77    --  Current Ada version for compiler, as set by configuration pragmas,
78    --  compiler switches, or implicitly (to Ada_Version_Runtime) when a
79    --  predefined or internal file is compiled.
80
81    Ada_Version_Explicit : Ada_Version_Type := Ada_Version_Default;
82    --  GNAT
83    --  Like Ada_Version, but does not get set implicitly for predefined
84    --  or internal units, so it reflects the Ada version explicitly set
85    --  using configuration pragmas or compiler switches (or if neither
86    --  appears, it remains set to Ada_Version_Default). This is used in
87    --  the rare cases (notably for pragmas Preelaborate_05 and Pure_05)
88    --  where in the run-time we want the explicit version set.
89
90    Ada_Version_Runtime : Ada_Version_Type := Ada_05;
91    --  GNAT
92    --  Ada version used to compile the runtime. Used to set Ada_Version (but
93    --  not Ada_Version_Explicit) when compiling predefined or internal units.
94
95    Ada_Final_Suffix : constant String := "final";
96    Ada_Final_Name   : String_Ptr := new String'("ada" & Ada_Final_Suffix);
97    --  GNATBIND
98    --  The name of the procedure that performs the finalization at the end of
99    --  execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
100
101    Ada_Init_Suffix : constant String := "init";
102    Ada_Init_Name   : String_Ptr := new String'("ada" & Ada_Init_Suffix);
103    --  GNATBIND
104    --  The name of the procedure that performs initialization at the start
105    --  of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
106
107    Ada_Main_Name_Suffix : constant String := "main";
108    --  GNATBIND
109    --  The suffix for Ada_Main_Name. Defined as a constant here so that it
110    --  can be referenced in a uniform manner to create either the default
111    --  value of Ada_Main_Name (declared below), or the non-default name
112    --  set by Gnatbind.Scan_Bind_Arg.
113
114    Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
115    --  GNATBIND
116    --  The name of the Ada package generated by the binder (when in Ada mode).
117    --  This variable may be modified by Gnatbind.Scan_Bind_Arg.
118
119    Address_Clause_Overlay_Warnings : Boolean := True;
120    --  GNAT
121    --  Set False to disable address clause warnings
122
123    Address_Is_Private : Boolean := False;
124    --  GNAT, GNATBIND
125    --  Set True if package System has the line "type Address is private;"
126
127    All_Errors_Mode : Boolean := False;
128    --  GNAT
129    --  Flag set to force display of multiple errors on a single line and
130    --  also repeated error messages for references to undefined identifiers
131    --  and certain other repeated error messages. Set by use of -gnatf.
132
133    All_Sources : Boolean := False;
134    --  GNATBIND
135    --  Set to True to require all source files to be present. This flag is
136    --  directly modified by gnatmake to affect the shared binder routines.
137
138    Alternate_Main_Name : String_Ptr := null;
139    --  GNATBIND
140    --  Set to non null when Bind_Alternate_Main_Name is True. This value
141    --  is modified as needed by Gnatbind.Scan_Bind_Arg.
142
143    Assertions_Enabled : Boolean := False;
144    --  GNAT
145    --  Enable assertions made using pragma Assert
146
147    ASIS_Mode : Boolean := False;
148    --  GNAT
149    --  Enable semantic checks and tree transformations that are important
150    --  for ASIS but that are usually skipped if Operating_Mode is set to
151    --  Check_Semantics. This flag does not have the corresponding option to set
152    --  it ON. It is set ON when Tree_Output is set ON, it can also be set ON
153    --  from the code of GNSA-based tool (a client may need to set ON the
154    --  Back_Annotate_Rep_Info flag in this case. At the moment this does not
155    --  make very much sense, because GNSA cannot do back annotation).
156
157    Back_Annotate_Rep_Info : Boolean := False;
158    --  GNAT
159    --  If set True, enables back annotation of representation information
160    --  by gigi, even in -gnatc mode. This is set True by the use of -gnatR
161    --  (list representation information) or -gnatt (generate tree). It is
162    --  also set true if certain Unchecked_Conversion instantiations require
163    --  checking based on annotated values.
164
165    Bind_Alternate_Main_Name : Boolean := False;
166    --  GNATBIND
167    --  True if main should be called Alternate_Main_Name.all.
168    --  This variable may be set to True by Gnatbind.Scan_Bind_Arg.
169
170    Bind_Main_Program : Boolean := True;
171    --  GNATBIND
172    --  Set to False if not binding main Ada program
173
174    Bind_For_Library : Boolean := False;
175    --  GNATBIND
176    --  Set to True if the binder needs to generate a file designed for
177    --  building a library. May be set to True by Gnatbind.Scan_Bind_Arg.
178
179    Bind_Only : Boolean := False;
180    --  GNATMAKE, GPRMAKE
181    --  Set to True to skip compile and link steps
182    --  (except when Compile_Only and/or Link_Only are True).
183
184    Blank_Deleted_Lines : Boolean := False;
185    --  GNAT, GNATPREP
186    --  Output empty lines for each line of preprocessed input that is deleted
187    --  in the output, including preprocessor lines starting with a '#'.
188
189    Brief_Output : Boolean := False;
190    --  GNAT, GNATBIND
191    --  Force brief error messages to standard error, even if verbose mode is
192    --  set (so that main error messages go to standard output).
193
194    Build_Bind_And_Link_Full_Project : Boolean := False;
195    --  GNATMAKE
196    --  Set to True to build, bind and link all the sources of a project file
197    --  (switch -B)
198
199    Check_Object_Consistency : Boolean := False;
200    --  GNATBIND, GNATMAKE
201    --  Set to True to check whether every object file is consistent with
202    --  its corresponding ada library information (ALI) file. An object
203    --  file is inconsistent with the corresponding ALI file if the object
204    --  file does not exist or if it has an older time stamp than the ALI file.
205    --  Default above is for GNATBIND. GNATMAKE overrides this default to
206    --  True (see Make.Initialize) since we normally do need to check source
207    --  consistencies in gnatmake.
208
209    Check_Only : Boolean := False;
210    --  GNATBIND
211    --  Set to True to do checks only, no output of binder file
212
213    Check_Readonly_Files : Boolean := False;
214    --  GNATMAKE
215    --  Set to True to check readonly files during the make process
216
217    Check_Source_Files : Boolean := True;
218    --  GNATBIND, GNATMAKE
219    --  Set to True to enable consistency checking for any source files that
220    --  are present (i.e. date must match the date in the library info file).
221    --  Set to False for object file consistency check only. This flag is
222    --  directly modified by gnatmake, to affect the shared binder routines.
223
224    Check_Switches : Boolean := False;
225    --  GNATMAKE, GPRMAKE
226    --  Set to True to check compiler options during the make process
227
228    Check_Unreferenced : Boolean := False;
229    --  GNAT
230    --  Set to True to enable checking for unreferenced entities other
231    --  than formal parameters (for which see Check_Unreferenced_Formals)
232
233    Check_Unreferenced_Formals : Boolean := False;
234    --  GNAT
235    --  Set True to check for unreferenced formals. This is turned on by
236    --  -gnatwa/wf/wu and turned off by -gnatwA/wF/wU.
237
238    Check_Withs : Boolean := False;
239    --  GNAT
240    --  Set to True to enable checking for unused withs, and also the case
241    --  of withing a package and using none of the entities in the package.
242
243    Commands_To_Stdout : Boolean := False;
244    --  GNATMAKE
245    --  True if echoed commands to be written to stdout instead of stderr
246
247    Comment_Deleted_Lines : Boolean := False;
248    --  GNATPREP
249    --  True if source lines removed by the preprocessor should be commented
250    --  in the output file.
251
252    Compile_Only : Boolean := False;
253    --  GNATMAKE, GNATCLEAN, GPRMAKE
254    --  GNATMAKE, GPRMAKE: set to True to skip bind and link steps (except when
255    --                     Bind_Only is True).
256    --  GNATCLEAN: set to True to delete only the files produced by the compiler
257    --             but not the library files or the executable files.
258
259    Config_File : Boolean := True;
260    --  GNAT
261    --  Set to False to inhibit reading and processing of gnat.adc file
262
263    Config_File_Names : String_List_Access := null;
264    --  GNAT
265    --  Names of configuration pragmas files (given by switches -gnatec)
266
267    Configurable_Run_Time_Mode : Boolean := False;
268    --  GNAT, GNATBIND
269    --  Set True if the compiler is operating in configurable run-time mode.
270    --  This happens if the flag Targparm.Configurable_Run_TimeMode_On_Target
271    --  is set True, or if pragma No_Run_Time is used. See the spec of Rtsfind
272    --  for details on the handling of the latter pragma.
273
274    Constant_Condition_Warnings : Boolean := False;
275    --  GNAT
276    --  Set to True to activate warnings on constant conditions
277
278    Create_Mapping_File : Boolean := False;
279    --  GNATMAKE, GPRMAKE
280    --  Set to True (-C switch) to indicate that the compiler will be invoked
281    --  with a mapping file (-gnatem compiler switch).
282
283    Debug_Pragmas_Enabled : Boolean := False;
284    --  GNAT
285    --  Enable debug statements from pragma Debug
286
287    subtype Debug_Level_Value is Nat range 0 .. 3;
288    Debugger_Level : Debug_Level_Value := 0;
289    --  GNATBIND
290    --  The value given to the -g parameter. The default value for -g with
291    --  no value is 2. This is usually ignored by GNATBIND, except in the
292    --  VMS version where it is passed as an argument to __gnat_initialize
293    --  to trigger the activation of the remote debugging interface.
294    --  Is this still true ???
295
296    Debug_Generated_Code : Boolean := False;
297    --  GNAT
298    --  Set True (-gnatD switch) to debug generated expanded code instead
299    --  of the original source code. Causes debugging information to be
300    --  written with respect to the generated code file that is written.
301
302    Default_Exit_Status : Int := 0;
303    --  GNATBIND
304    --  Set the default exit status value. Set by the -Xnnn switch for the
305    --  binder.
306
307    Default_Stack_Size : Int := -1;
308    --  GNATBIND
309    --  Set to default primary stack size in units of bytes. Set by
310    --  the -dnnn switch for the binder. A value of -1 indicates that no
311    --  default was set by the binder.
312
313    Default_Sec_Stack_Size : Int := -1;
314    --  GNATBIND
315    --  Set to default secondary stack size in units of bytes. Set by
316    --  the -Dnnn switch for the binder. A value of -1 indicates that no
317    --  default was set by the binder, and that the default should be the
318    --  initial value of System.Secondary_Stack.Default_Secondary_Stack_Size.
319
320    Detect_Blocking : Boolean := False;
321    --  GNAT
322    --  Set True to force the run time to raise Program_Error if calls to
323    --  potentially blocking operations are detected from protected actions.
324
325    Display_Compilation_Progress : Boolean := False;
326    --  GNATMAKE, GPRMAKE
327    --  Set True (-d switch) to display information on progress while compiling
328    --  files. Internal flag to be used in conjunction with an IDE (e.g GPS).
329
330    type Distribution_Stub_Mode_Type is
331    --  GNAT
332      (No_Stubs,
333       --  Normal mode, no generation/compilation of distribution stubs
334
335       Generate_Receiver_Stub_Body,
336       --  The unit being compiled is the RCI body, and the compiler will
337       --  generate the body for the receiver stubs and compile it.
338
339       Generate_Caller_Stub_Body);
340       --  The unit being compiled is the RCI spec, and the compiler will
341       --  generate the body for the caller stubs and compile it.
342
343    Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
344    --  GNAT
345    --  This enumeration variable indicates the five states of distribution
346    --  annex stub generation/compilation.
347
348    Do_Not_Execute : Boolean := False;
349    --  GNATMAKE
350    --  Set to True if no actual compilations should be undertaken.
351
352    Dump_Source_Text : Boolean := False;
353    --  GNAT
354    --  Set to True (by -gnatL) to dump source text intermingled with generated
355    --  code. Effective only if either of Debug/Print_Generated_Code is true.
356
357    Dynamic_Elaboration_Checks : Boolean := False;
358    --  GNAT
359    --  Set True for dynamic elaboration checking mode, as set by the -gnatE
360    --  switch or by the use of pragma Elaboration_Checks (Dynamic).
361
362    Dynamic_Stack_Measurement : Boolean := False;
363    --  GNATBIND
364    --  Set True to enable dynamic stack measurement (-u flag for gnatbind)
365
366    Dynamic_Stack_Measurement_Array_Size : Nat := 100;
367    --  GNATBIND
368    --  Number of measurements we want to store during dynamic stack analysis.
369    --  When the buffer is full, non-storable results will be output on the fly.
370    --  The value is relevant only if Dynamic_Stack_Measurement is set. Set
371    --  by processing of -u flag for gnatbind.
372
373    Elab_Dependency_Output : Boolean := False;
374    --  GNATBIND
375    --  Set to True to output complete list of elaboration constraints
376
377    Elab_Order_Output : Boolean := False;
378    --  GNATBIND
379    --  Set to True to output chosen elaboration order
380
381    Elab_Warnings : Boolean := False;
382    --  GNAT
383    --  Set to True to generate full elaboration warnings (-gnatwl)
384
385    Enable_Overflow_Checks : Boolean := False;
386    --  GNAT
387    --  Set to True if -gnato (enable overflow checks) switch is set,
388    --  but not -gnatp.
389
390    Error_Msg_Line_Length : Nat := 0;
391    --  GNAT
392    --  Records the error message line length limit. If this is set to zero,
393    --  then we get the old style behavior, in which each call to the error
394    --  message routines generates one line of output as a separate message.
395    --  If it is set to a non-zero value, then continuation lines are folded
396    --  to make a single long message, and then this message is split up into
397    --  multiple lines not exceeding the specified length. Set by -gnatLnnn.
398
399    Exception_Locations_Suppressed : Boolean := False;
400    --  GNAT
401    --  This flag is set True if a Suppress_Exception_Locations configuration
402    --  pragma is currently active.
403
404    type Exception_Mechanism_Type is
405    --  Determines the handling of exceptions. See Exp_Ch11 for details
406    --
407      (Front_End_Setjmp_Longjmp_Exceptions,
408       --  Exceptions use setjmp/longjmp generated explicitly by the
409       --  front end (this includes gigi or other equivalent parts of
410       --  the code generator). AT END handlers are converted into
411       --  exception handlers by the front end in this mode.
412
413       Back_End_Exceptions);
414       --  Exceptions are handled by the back end. The front end simply
415       --  generates the handlers as they appear in the source, and AT
416       --  END handlers are left untouched (they are not converted into
417       --  exception handlers when operating in this mode.
418    pragma Convention (C, Exception_Mechanism_Type);
419
420    Exception_Mechanism : Exception_Mechanism_Type :=
421                            Front_End_Setjmp_Longjmp_Exceptions;
422    --  GNAT
423    --  Set to the appropriate value depending on the default as given in
424    --  system.ads (ZCX_By_Default, GCC_ZCX_Support).
425    --  The C convention is there to make this variable accessible to gigi.
426
427    Exception_Tracebacks : Boolean := False;
428    --  GNATBIND
429    --  Set to True to store tracebacks in exception occurrences (-E)
430
431    Extensions_Allowed : Boolean := False;
432    --  GNAT
433    --  Set to True by switch -gnatX if GNAT specific language extensions
434    --  are allowed. For example, the use of 'Constrained with objects of
435    --  generic types is a GNAT extension.
436
437    type External_Casing_Type is (
438      As_Is,       -- External names cased as they appear in the Ada source
439      Uppercase,   -- External names forced to all uppercase letters
440      Lowercase);  -- External names forced to all lowercase letters
441
442    External_Name_Imp_Casing : External_Casing_Type := Lowercase;
443    --  GNAT
444    --  The setting of this flag determines the casing of external names
445    --  when the name is implicitly derived from an entity name (i.e. either
446    --  no explicit External_Name or Link_Name argument is used, or, in the
447    --  case of extended DEC pragmas, the external name is given using an
448    --  identifier. The As_Is setting is not permitted here (since this would
449    --  create Ada source programs that were case sensitive).
450
451    External_Name_Exp_Casing : External_Casing_Type := As_Is;
452    --  GNAT
453    --  The setting of this flag determines the casing of an external name
454    --  specified explicitly with a string literal. As_Is means the string
455    --  literal is used as given with no modification to the casing. If
456    --  Lowercase or Uppercase is set, then the string is forced to all
457    --  lowercase or all uppercase letters as appropriate. Note that this
458    --  setting has no effect if the external name is given using an identifier
459    --  in the case of extended DEC import/export pragmas (in this case the
460    --  casing is controlled by External_Name_Imp_Casing), and also has no
461    --  effect if an explicit Link_Name is supplied (a link name is always
462    --  used exactly as given).
463
464    External_Unit_Compilation_Allowed : Boolean := False;
465    --  GNATMAKE
466    --  When True (set by gnatmake switch -x), allow compilation of sources
467    --  that are not part of any project file.
468
469    Float_Format : Character := ' ';
470    --  GNAT
471    --  A non-blank value indicates that a Float_Format pragma has been
472    --  processed, in which case this variable is set to 'I' for IEEE or
473    --  to 'V' for VAX. The setting of 'V' is only possible on OpenVMS
474    --  versions of GNAT.
475
476    Float_Format_Long : Character := ' ';
477    --  GNAT
478    --  A non-blank value indicates that a Long_Float pragma has been
479    --  processed (this pragma is recognized only in OpenVMS versions
480    --  of GNAT), in which case this variable is set to D or G for
481    --  D_Float or G_Float.
482
483    Force_ALI_Tree_File : Boolean := False;
484    --  GNAT
485    --  Force generation of ALI file even if errors are encountered.
486    --  Also forces generation of tree file if -gnatt is also set.
487
488    Force_Checking_Of_Elaboration_Flags : Boolean := False;
489    --  GNATBIND
490    --  True if binding with forced checking of the elaboration flags
491    --  (-F switch set).
492
493    Force_Compilations : Boolean := False;
494    --  GNATMAKE, GPRMAKE
495    --  Set to force recompilations even when the objects are up-to-date.
496
497    Full_Path_Name_For_Brief_Errors : Boolean := False;
498    --  GNAT, GNATMAKE, GNATCLEAN, GPRMAKE
499    --  When True, in Brief_Output mode, each error message line
500    --  will start with the full path name of the source.
501    --  When False, only the file name without directory information
502    --  is used.
503
504    Full_List : Boolean := False;
505    --  GNAT
506    --  Set True to generate full source listing with embedded errors
507
508    Full_List_File_Name : String_Ptr := null;
509    --  GNAT
510    --  Set to file name to generate full source listing to named file (or if
511    --  the name is of the form .xxx, then to name.xxx where name is the source
512    --  file name with extension stripped.
513
514    Generating_Code : Boolean := False;
515    --  GNAT
516    --  True if the frontend finished its work and has called the backend to
517    --  processs the tree and generate the object file.
518
519    Global_Discard_Names : Boolean := False;
520    --  GNAT, GNATBIND
521    --  True if a pragma Discard_Names appeared as a configuration pragma for
522    --  the current compilation unit.
523
524    GNAT_Mode : Boolean := False;
525    --  GNAT
526    --  True if compiling in GNAT system mode (-gnatg switch)
527
528    HLO_Active : Boolean := False;
529    --  GNAT
530    --  True if High Level Optimizer is activated (-gnatH switch)
531
532    Identifier_Character_Set : Character;
533    --  GNAT
534    --  This variable indicates the character set to be used for identifiers.
535    --  The possible settings are:
536    --    '1'  Latin-5 (ISO-8859-1)
537    --    '2'  Latin-5 (ISO-8859-2)
538    --    '3'  Latin-5 (ISO-8859-3)
539    --    '4'  Latin-5 (ISO-8859-4)
540    --    '5'  Latin-5 (ISO-8859-5, Cyrillic)
541    --    '9'  Latin-5 (ISO-8859-9)
542    --    'p'  PC (US, IBM page 437)
543    --    '8'  PC (European, IBM page 850)
544    --    'f'  Full upper set (all distinct)
545    --    'n'  No upper characters (Ada 83 rules)
546    --    'w'  Latin-1 plus wide characters allowed in identifiers
547    --
548    --  The setting affects the set of letters allowed in identifiers and the
549    --  upper/lower case equivalences. It does not affect the interpretation of
550    --  character and string literals, which are always stored using the actual
551    --  coding in the source program. This variable is initialized to the
552    --  default value appropriate to the system (in Osint.Initialize), and then
553    --  reset if a command line switch is used to change the setting.
554
555    Ignore_Rep_Clauses : Boolean := False;
556    --  GNAT
557    --  Set True to ignore all representation clauses. Useful when compiling
558    --  code from foreign compilers for checking or ASIS purposes. Can be
559    --  set True by use of -gnatI.
560
561    Implementation_Unit_Warnings : Boolean := True;
562    --  GNAT
563    --  Set True to active warnings for use of implementation internal units.
564    --  Can be controlled by use of -gnatwi/-gnatwI.
565
566    Implicit_Packing : Boolean := False;
567    --  GNAT
568    --  If set True, then a Size attribute clause on an array is allowed to
569    --  cause implicit packing instead of generating an error message. Set by
570    --  use of pragma Implicit_Packing.
571
572    Ineffective_Inline_Warnings : Boolean := False;
573    --  GNAT
574    --  Set True to activate warnings if front-end inlining (-gnatN) is not
575    --  able to actually inline a particular call (or all calls). Can be
576    --  controlled by use of -gnatwp/-gnatwP.
577
578    Init_Or_Norm_Scalars : Boolean := False;
579    --  GNAT, GANTBIND
580    --  Set True if a pragma Initialize_Scalars applies to the current unit.
581    --  Also set True if a pragma Normalize_Scalars applies.
582
583    Initialize_Scalars : Boolean := False;
584    --  GNAT
585    --  Set True if a pragma Initialize_Scalars applies to the current unit.
586    --  Note that Init_Or_Norm_Scalars is also set to True if this is True.
587
588    Initialize_Scalars_Mode1 : Character := 'I';
589    Initialize_Scalars_Mode2 : Character := 'N';
590    --  GNATBIND
591    --  Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
592    --  is IN (invalid values), used if no -S switch is used.
593
594    Inline_Active : Boolean := False;
595    --  GNAT
596    --  Set True to activate pragma Inline processing across modules. Default
597    --  for now is not to inline across module boundaries.
598
599    Interface_Library_Unit : Boolean := False;
600    --  GNATBIND
601    --  Set to True to indicate that at least one ALI file is an interface ALI:
602    --  then elaboration flag checks are to be generated in the binder
603    --  generated file.
604
605    Inspector_Mode : Boolean renames Debug.Debug_Flag_Dot_II;
606    --  GNAT
607    --  True if compiling in inspector mode (-gnatd.I switch).
608    --  Only relevant when VM_Target /= None. The compiler will attempt to
609    --  generate code even in case of unsupported construct, so that the byte
610    --  code can be used by static analysis tools.
611
612    Follow_Links : Boolean := False;
613    --  GNATMAKE
614    --  Set to True (-eL) to process the project files in trusted mode
615
616    Front_End_Inlining : Boolean := False;
617    --  GNAT
618    --  Set True to activate inlining by front-end expansion
619
620    Inline_Processing_Required : Boolean := False;
621    --  GNAT
622    --  Set True if inline processing is required. Inline processing is
623    --  required if an active Inline pragma is processed. The flag is set
624    --  for a pragma Inline or Inline_Always that is actually active.
625
626    In_Place_Mode : Boolean := False;
627    --  GNATMAKE
628    --  Set True to store ALI and object files in place ie in the object
629    --  directory if these files already exist or in the source directory
630    --  if not.
631
632    Keep_Going : Boolean := False;
633    --  GNATMAKE, GPRMAKE
634    --  When True signals to ignore compilation errors and keep
635    --  processing sources until there is no more work.
636
637    Keep_Temporary_Files : Boolean := False;
638    --  GNATCMD
639    --  When True the temporary files created by the GNAT driver are not
640    --  deleted. Set by switch -dn or qualifier /KEEP_TEMPORARY_FILES.
641
642    Leap_Seconds_Support : Boolean := False;
643    --  GNATBIND
644    --  Set to True to enable leap seconds support in Ada.Calendar and its
645    --  children.
646
647    Link_Only : Boolean := False;
648    --  GNATMAKE, GPRMAKE
649    --  Set to True to skip compile and bind steps
650    --  (except when Bind_Only is set to True).
651
652    List_Restrictions : Boolean := False;
653    --  GNATBIND
654    --  Set to True to list restrictions pragmas that could apply to partition
655
656    List_Units : Boolean := False;
657    --  GNAT
658    --  List units in the active library for a compilation (-gnatu switch)
659
660    List_Closure : Boolean := False;
661    --  GNATBIND
662    --  List all sources in the closure of a main (-R gnatbind switch)
663
664    List_Dependencies : Boolean := False;
665    --  GNATMAKE
666    --  When True gnatmake verifies that the objects are up to date and
667    --  outputs the list of object dependencies (-M switch).
668    --  Output depends if -a switch is used or not.
669    --  This list can be used directly in a Makefile.
670
671    List_Representation_Info : Int range 0 .. 3 := 0;
672    --  GNAT
673    --  Set non-zero by -gnatR switch to list representation information.
674    --  The settings are as follows:
675    --
676    --    0 = no listing of representation information (default as above)
677    --    1 = list rep info for user defined record and array types
678    --    2 = list rep info for all user defined types and objects
679    --    3 = like 2, but variable fields are decoded symbolically
680
681    List_Representation_Info_To_File : Boolean := False;
682    --  GNAT
683    --  Set true by -gnatRs switch. Causes information from -gnatR/1/2/3
684    --  to be written to file.rep (where file is the name of the source
685    --  file) instead of stdout. For example, if file x.adb is compiled
686    --  using -gnatR2s then representation info is written to x.adb.ref.
687
688    List_Representation_Info_Mechanisms : Boolean := False;
689    --  GNAT
690    --  Set true by -gnatRm switch. Causes information on mechanisms to
691    --  be included in the representation output information.
692
693    List_Preprocessing_Symbols : Boolean := False;
694    --  GNAT, GNATPREP
695    --  Set to True if symbols for preprocessing a source are to be listed
696    --  before preprocessing occurs. Set to True by switch -s of gnatprep
697    --  or -s in preprocessing data file for the compiler.
698
699    type Create_Repinfo_File_Proc is access procedure (Src  : String);
700    type Write_Repinfo_Line_Proc  is access procedure (Info : String);
701    type Close_Repinfo_File_Proc  is access procedure;
702    --  Types used for procedure addresses below
703
704    Create_Repinfo_File_Access : Create_Repinfo_File_Proc := null;
705    Write_Repinfo_Line_Access  : Write_Repinfo_Line_Proc  := null;
706    Close_Repinfo_File_Access  : Close_Repinfo_File_Proc  := null;
707    --  GNAT
708    --  These three locations are left null when operating in non-compiler
709    --  (e.g. ASIS mode), but when operating in compiler mode, they are
710    --  set to point to the three corresponding procedures in Osint-C. The
711    --  reason for this slightly strange interface is to prevent Repinfo
712    --  from dragging in Osint in ASIS mode, which would include a lot of
713    --  unwanted units in the ASIS build.
714
715    type Create_List_File_Proc is access procedure (S : String);
716    type Write_List_Info_Proc  is access procedure (S : String);
717    type Close_List_File_Proc  is access procedure;
718    --  Types used for procedure addresses below
719
720    Create_List_File_Access : Create_List_File_Proc := null;
721    Write_List_Info_Access  : Write_List_Info_Proc  := null;
722    Close_List_File_Access  : Close_List_File_Proc  := null;
723    --  GNAT
724    --  These three locations are left null when operating in non-compiler
725    --  (e.g. from the binder), but when operating in compiler mode, they are
726    --  set to point to the three corresponding procedures in Osint-C. The
727    --  reason for this slightly strange interface is to prevent Repinfo
728    --  from dragging in Osint-C in the binder, which would include unwanted
729    --  units in the  binder.
730
731    Locking_Policy : Character := ' ';
732    --  GNAT, GNATBIND
733    --  Set to ' ' for the default case (no locking policy specified).
734    --  Reset to first character (uppercase) of locking policy name if a
735    --  valid pragma Locking_Policy is encountered.
736
737    Locking_Policy_Sloc : Source_Ptr := No_Location;
738    --  GNAT, GNATBIND
739    --  Remember location of previous Locking_Policy pragma. This is used
740    --  for inconsistency error messages. A value of System_Location is
741    --  used if the policy is set in package System.
742
743    Look_In_Primary_Dir : Boolean := True;
744    --  GNAT, GNATBIND, GNATMAKE, GNATCLEAN
745    --  Set to False if a -I- was present on the command line.
746    --  When True we are allowed to look in the primary directory to locate
747    --  other source or library files.
748
749    Make_Steps : Boolean := False;
750    --  GNATMAKE
751    --  Set to True when either Compile_Only, Bind_Only or Link_Only is
752    --  set to True.
753
754    Main_Index : Int := 0;
755    --  GNATMAKE
756    --  This is set to non-zero by gnatmake switch -eInnn to indicate that
757    --  the main program is the nnn unit in a multi-unit source file.
758
759    Mapping_File_Name : String_Ptr := null;
760    --  GNAT
761    --  File name of mapping between unit names, file names and path names.
762    --  (given by switch -gnatem)
763
764    Maximum_Errors : Int := 9999;
765    --  GNAT, GNATBIND
766    --  Maximum default number of errors before compilation is terminated.
767    --  Can be overridden using -gnatm (GNAT) or -m (GNATBIND) switch.
768
769    Maximum_File_Name_Length : Int;
770    --  GNAT, GNATBIND
771    --  Maximum number of characters allowed in a file name, not counting the
772    --  extension, as set by the appropriate switch. If no switch is given,
773    --  then this value is initialized by Osint to the appropriate value.
774
775    Maximum_Processes : Positive := 1;
776    --  GNATMAKE, GPRMAKE
777    --  Maximum number of processes that should be spawned to carry out
778    --  compilations.
779
780    Minimal_Recompilation : Boolean := False;
781    --  GNATMAKE
782    --  Set to True if minimal recompilation mode requested
783
784    Special_Exception_Package_Used : Boolean := False;
785    --  GNAT
786    --  Set to True if either of the unit GNAT.Most_Recent_Exception or
787    --  GNAT.Exception_Traces is with'ed. Used to inhibit transformation of
788    --  local raise statements into gotos in the presence of either package.
789
790    Multiple_Unit_Index : Int;
791    --  GNAT
792    --  This is set non-zero if the current unit is being compiled in multiple
793    --  unit per file mode, meaning that the current unit is selected from the
794    --  sequence of units in the current source file, using the value stored
795    --  in this variable (e.g. 2 = select second unit in file). A value of
796    --  zero indicates that we are in normal (one unit per file) mode.
797
798    No_Main_Subprogram : Boolean := False;
799    --  GNATMAKE, GNATBIND
800    --  Set to True if compilation/binding of a program without main
801    --  subprogram requested.
802
803    No_Run_Time_Mode : Boolean := False;
804    --  GNAT, GNATBIND
805    --  This flag is set True if a No_Run_Time pragma is encountered. See
806    --  spec of Rtsfind for a full description of handling of this pragma.
807
808    No_Stdinc : Boolean := False;
809    --  GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
810    --  Set to True if no default source search dirs added to search list
811
812    No_Stdlib : Boolean := False;
813    --  GNATMAKE, GNATBIND, GNATFIND, GNATXREF
814    --  Set to True if no default library search dirs added to search list
815
816    No_Strict_Aliasing : Boolean := False;
817    --  GNAT
818    --  Set True if pragma No_Strict_Aliasing with no parameters encountered
819
820    Normalize_Scalars : Boolean := False;
821    --  GNAT, GNATBIND
822    --  Set True if a pragma Normalize_Scalars applies to the current unit.
823    --  Note that Init_Or_Norm_Scalars is also set to True if this is True.
824
825    Object_Directory_Present : Boolean := False;
826    --  GNATMAKE
827    --  Set to True when an object directory is specified with option -D
828
829    type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
830    Operating_Mode : Operating_Mode_Type := Generate_Code;
831    --  GNAT
832    --  Indicates the operating mode of the compiler. The default is generate
833    --  code, which runs the parser, semantics and backend. Switches can be
834    --  used to set syntax checking only mode, or syntax and semantics checking
835    --  only mode. Operating_Mode can also be modified as a result of detecting
836    --  errors during the compilation process. In particular if any serious
837    --  error is detected then this flag is reset from Generate_Code to
838    --  Check_Semantics after generating an error message.
839
840    Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
841    --  GNAT
842    --  Indicates the original operating mode of the compiler as set by
843    --  compiler options. This is identical to Operating_Mode except that
844    --  this is not affected by errors.
845
846    Optimization_Level : Int;
847    pragma Import (C, Optimization_Level, "optimize");
848    --  This constant reflects the optimization level (0,1,2 for -O0,-O1,-O2)
849
850    Output_File_Name_Present : Boolean := False;
851    --  GNATBIND, GNAT, GNATMAKE, GPRMAKE
852    --  Set to True when the output C file name is given with option -o
853    --  for GNATBIND, when the object file name is given with option
854    --  -gnatO for GNAT or when the executable is given with option -o
855    --  for GNATMAKE or GPRMAKE.
856
857    Output_Linker_Option_List : Boolean := False;
858    --  GNATBIND
859    --  True if output of list of linker options is requested (-K switch set)
860
861    Output_Object_List : Boolean := False;
862    --  GNATBIND
863    --  True if output of list of objects is requested (-O switch set)
864
865    Overflow_Checks_Unsuppressed : Boolean := False;
866    --  GNAT
867    --  Set to True if at least one pragma Unsuppress
868    --  (All_Checks|Overflow_Checks) has been processed.
869
870    Persistent_BSS_Mode : Boolean := False;
871    --  GNAT
872    --  True if a Persistent_BSS configuration pragma is in effect, causing
873    --  potentially persistent data to be placed in the persistent_bss section.
874
875    Pessimistic_Elab_Order : Boolean := False;
876    --  GNATBIND
877    --  True if pessimistic elaboration order is to be chosen (-p switch set)
878
879    Polling_Required : Boolean := False;
880    --  GNAT
881    --  Set to True if polling for asynchronous abort is enabled by using
882    --  the -gnatP option for GNAT.
883
884    Preprocessing_Data_File : String_Ptr := null;
885    --  GNAT
886    --  Set by switch -gnatep=. The file name of the prepocessing data file.
887
888    Print_Generated_Code : Boolean := False;
889    --  GNAT
890    --  Set to True to enable output of generated code in source form. This
891    --  flag is set by the -gnatG switch.
892
893    Print_Standard : Boolean := False;
894    --  GNAT
895    --  Set to true to enable printing of package standard in source form.
896    --  This flag is set by the -gnatS switch
897
898    Propagate_Exceptions : Boolean := False;
899    --  GNAT
900    --  Indicates if subprogram descriptor exception tables should be
901    --  built for imported subprograms. Set True if a Propagate_Exceptions
902    --  pragma applies to the extended main unit.
903
904    type Usage is (Unknown, Not_In_Use, In_Use);
905    Project_File_In_Use : Usage := Unknown;
906    --  GNAT
907    --  Indicates if a project file is used or not.
908    --  Set to In_Use by the first SFNP pragma.
909
910    Queuing_Policy : Character := ' ';
911    --  GNAT, GNATBIND
912    --  Set to ' ' for the default case (no queuing policy specified).
913    --  Reset to first character (uppercase) of locking policy name if a valid
914    --  Queuing_Policy pragma is encountered.
915
916    Queuing_Policy_Sloc : Source_Ptr := No_Location;
917    --  GNAT, GNATBIND
918    --  Remember location of previous Queuing_Policy pragma. This is used
919    --  for inconsistency error messages. A value of System_Location is
920    --  used if the policy is set in package System.
921
922    Quiet_Output : Boolean := False;
923    --  GNATMAKE, GNATCLEAN, GPRMAKE
924    --  Set to True if the tool should not have any output if there are no
925    --  errors or warnings.
926
927    Replace_In_Comments : Boolean := False;
928    --  GNATPREP
929    --  Set to True if -C switch used
930
931    RTS_Lib_Path_Name : String_Ptr := null;
932    RTS_Src_Path_Name : String_Ptr := null;
933    --  GNAT
934    --  Set to the "adalib" and "adainclude" directories of the run time
935    --  specified by --RTS=.
936
937    RTS_Switch : Boolean := False;
938    --  GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
939    --  Set to True when the --RTS switch is set
940
941    Run_Path_Option : Boolean := True;
942    --  GNATMAKE, GNATLINK
943    --  Set to False when no run_path_option should be issued to the linker
944
945    Search_Directory_Present : Boolean := False;
946    --  GNAT
947    --  Set to True when argument is -I. Reset to False when next argument,
948    --  a search directory path is taken into account. Note that this is
949    --  quite different from other switches in this section in that it is
950    --  only set in a transitory manner as a result of scanning a -I switch
951    --  with no file name, and if set, is an indication that the next argument
952    --  is to be treated as a file name.
953
954    Sec_Stack_Used : Boolean := False;
955    --  GNAT, GBATBIND
956    --  Set True if generated code uses the System.Secondary_Stack package.
957    --  For the binder, set if any unit uses the secondary stack package.
958
959    Setup_Projects : Boolean := False;
960    --  GNAT DRIVER
961    --  Set to True for GNAT SETUP: the Project Manager creates non existing
962    --  object, library and exec directories.
963
964    Shared_Libgnat : Boolean;
965    --  GNATBIND
966    --  Set to True if a shared libgnat is requested by using the -shared
967    --  option for GNATBIND and to False when using the -static option. The
968    --  value of this flag is set by Gnatbind.Scan_Bind_Arg.
969
970    Stack_Checking_Enabled : Boolean;
971    --  GNAT
972    --  Set to indicate if -fstack-check switch is set for the compilation. True
973    --  means that the switch is set, so that stack checking is enabled. False
974    --  means that the switch is not set (no stack checking). This value is
975    --  obtained from the external imported value flag_stack_check in the gcc
976    --  backend (see Frontend) and may be referenced throughout the compilation
977    --  phases.
978
979    Style_Check : Boolean := False;
980    --  GNAT
981    --  Set True to perform style checks. Activates checks carried out
982    --  in package Style (see body of this package for details of checks)
983    --  This flag is set True by either the -gnatg or -gnaty switches.
984
985    System_Extend_Pragma_Arg : Node_Id := Empty;
986    --  GNAT
987    --  Set non-empty if and only if a correct Extend_System pragma was present
988    --  in which case it points to the argument of the pragma, and the name can
989    --  be located as Chars (Expression (System_Extend_Pragma_Arg)).
990
991    System_Extend_Unit : Node_Id := Empty;
992    --  GNAT
993    --  This is set to Empty if GNAT_Mode is set, since pragma Extend_System
994    --  is never appropriate in GNAT_Mode (and causes troubles, including
995    --  bogus circularities, if we try to compile the run-time library with
996    --  a System extension). If GNAT_Mode is not set, then System_Extend_Unit
997    --  is a copy of the value set in System_Extend_Pragma_Arg.
998
999    Subunits_Missing : Boolean := False;
1000    --  GNAT
1001    --  This flag is set true if missing subunits are detected with code
1002    --  generation active. This causes code generation to be skipped.
1003
1004    Suppress_Checks : Boolean := False;
1005    --  GNAT
1006    --  Set to True if -gnatp (suppress all checks) switch present.
1007
1008    Suppress_Options : Suppress_Array;
1009    --  GNAT
1010    --  Flags set True to suppress corresponding check, i.e. add an implicit
1011    --  pragma Suppress at the outer level of each unit compiled. Note that
1012    --  these suppress actions can be overridden by the use of the Unsuppress
1013    --  pragma. This variable is initialized by Osint.Initialize.
1014
1015    Suppress_Back_Annotation : Boolean := False;
1016    --  GNAT
1017    --  This flag is set True if back annotation of representation information
1018    --  is to be suppressed. This is set if neither -gnatt or -gnatR0-3 is set.
1019    --  This avoids unnecessary time being spent on back annotation.
1020
1021    Table_Factor : Int := 1;
1022    --  GNAT
1023    --  Factor by which all initial table sizes set in Alloc are multiplied.
1024    --  Used in Table to calculate initial table sizes (the initial table size
1025    --  is the value in Alloc, used as the Table_Initial parameter value,
1026    --  multiplied by the factor given here. The default value is used if no
1027    --  -gnatT switch appears.
1028
1029    Task_Dispatching_Policy : Character := ' ';
1030    --  GNAT, GNATBIND
1031    --  Set to ' ' for the default case (no task dispatching policy specified).
1032    --  Reset to first character (uppercase) of task dispatching policy name
1033    --  if a valid Task_Dispatching_Policy pragma is encountered.
1034
1035    Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
1036    --  GNAT, GNATBIND
1037    --  Remember location of previous Task_Dispatching_Policy pragma. This is
1038    --  used for inconsistency error messages. A value of System_Location is
1039    --  used if the policy is set in package System.
1040
1041    Tasking_Used : Boolean := False;
1042    --  Set True if any tasking construct is encountered. Used to activate the
1043    --  output of the Q, L and T lines in ALI files.
1044
1045    Time_Slice_Set : Boolean := False;
1046    --  GNATBIND
1047    --  Set True if a pragma Time_Slice is processed in the main unit, or
1048    --  if the -gnatTnn switch is present to set a time slice value.
1049
1050    Time_Slice_Value : Nat;
1051    --  GNATBIND
1052    --  Time slice value. Valid only if Time_Slice_Set is True, i.e. if
1053    --  Time_Slice pragma has been processed. Set to the time slice value in
1054    --  microseconds. Negative values are stored as zero, and the value is not
1055    --  larger than 1_000_000_000 (1000 seconds). Values larger than this are
1056    --  reset to this maximum. This can also be set with the -gnatTnn switch.
1057
1058    Tolerate_Consistency_Errors : Boolean := False;
1059    --  GNATBIND
1060    --  Tolerate time stamp and other consistency errors. If this flag is set to
1061    --  True (-t), then inconsistencies result in warnings rather than errors.
1062
1063    Tree_Output : Boolean := False;
1064    --  GNAT
1065    --  Set to True (-gnatt) to generate output tree file
1066
1067    Try_Semantics : Boolean := False;
1068    --  GNAT
1069    --  Flag set to force attempt at semantic analysis, even if parser errors
1070    --  occur. This will probably cause blowups at this stage in the game. On
1071    --  the other hand, most such blowups will be caught cleanly and simply
1072    --  say compilation abandoned. This flag is set to True by -gnatq or -gnatQ.
1073
1074    Undefined_Symbols_Are_False : Boolean := False;
1075    --  GNAT, GNATPREP
1076    --  Set to True by switch -u of gnatprep or -u in the preprocessing data
1077    --  file for the compiler. Indicates that while preprocessing sources,
1078    --  symbols that are not defined have the value FALSE.
1079
1080    Unique_Error_Tag : Boolean := Tag_Errors;
1081    --  GNAT
1082    --  Indicates if error messages are to be prefixed by the string error:
1083    --  Initialized from Tag_Errors, can be forced on with the -gnatU switch.
1084
1085    Universal_Addressing_On_AAMP : Boolean := False;
1086    --  GNAAMP
1087    --  Indicates if library-level objects should be accessed and updated using
1088    --  universal addressing instructions on the AAMP architecture. This flag is
1089    --  set to True when pragma Universal_Data is given as a configuration
1090    --  pragma.
1091
1092    Unreserve_All_Interrupts : Boolean := False;
1093    --  GNAT, GNATBIND
1094    --  Normally set False, set True if a valid Unreserve_All_Interrupts pragma
1095    --  appears anywhere in the main unit for GNAT, or if any ALI file has the
1096    --  corresponding attribute set in GNATBIND.
1097
1098    Upper_Half_Encoding : Boolean := False;
1099    --  GNAT
1100    --  Normally set False, indicating that upper half ASCII characters are
1101    --  used in the normal way to represent themselves. If the wide character
1102    --  encoding method uses the upper bit for this encoding, then this flag is
1103    --  set True, and upper half characters in the source indicate the start of
1104    --  a wide character sequence.
1105
1106    Usage_Requested : Boolean := False;
1107    --  GNAT, GNATBIND, GNATMAKE
1108    --  Set to True if -h (-gnath for the compiler) switch encountered
1109    --  requesting usage information
1110
1111    Use_Pragma_Linker_Constructor : Boolean := False;
1112    --  GNATBIND
1113    --  True if pragma Linker_Constructor applies to adainit
1114
1115    Use_VADS_Size : Boolean := False;
1116    --  GNAT
1117    --  Set to True if a valid pragma Use_VADS_Size is processed
1118
1119    Validity_Checks_On  : Boolean := True;
1120    --  GNAT
1121    --  This flag determines if validity checking is on or off. The initial
1122    --  state is on, and the required default validity checks are active. The
1123    --  actual set of checks that is performed if Validity_Checks_On is set is
1124    --  defined by the switches in package Validsw. The Validity_Checks_On flag
1125    --  is controlled by pragma Validity_Checks (On | Off), and also some
1126    --  generated compiler code (typically code that has to do with validity
1127    --  check generation) is compiled with this flag set to False. This flag is
1128    --  set to False by the -gnatp switch.
1129
1130    Verbose_Mode : Boolean := False;
1131    --  GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATNAME, GNATCLEAN,
1132    --  GPRMAKE
1133    --  Set to True to get verbose mode (full error message text and location
1134    --  information sent to standard output, also header, copyright and summary)
1135
1136    type Verbosity_Level_Type is (None, Low, Medium, High);
1137    Verbosity_Level : Verbosity_Level_Type := High;
1138    --  GNATMAKE, GPRMAKE
1139    --  Modified by gnatmake or gprmake switches -v, -vl, -vm, -vh. Indicates
1140    --  the level of verbosity of informational messages:
1141    --
1142    --  In Low Verbosity, the reasons why a source is recompiled, the name
1143    --  of the executable and the reason it must be rebuilt is output.
1144    --
1145    --  In Medium Verbosity, additional lines are output for each ALI file
1146    --  that is checked.
1147    --
1148    --  In High Verbosity, additional lines are output when the ALI file
1149    --  is part of an Ada library, is read-only or is part of the runtime.
1150
1151    Warn_On_Ada_2005_Compatibility : Boolean := True;
1152    --  GNAT
1153    --  Set to True to generate all warnings on Ada 2005 compatibility issues,
1154    --  including warnings on Ada 2005 obsolescent features used in Ada 2005
1155    --  mode. Set False by -gnatwY.
1156
1157    Warn_On_Assumed_Low_Bound : Boolean := True;
1158    --  GNAT
1159    --  Set to True to activate warnings for string parameters that are indexed
1160    --  with literals or S'Length, presumably assuming a lower bound of one. Set
1161    --  False by -gnatwW.
1162
1163    Warn_On_Bad_Fixed_Value : Boolean := False;
1164    --  GNAT
1165    --  Set to True to generate warnings for static fixed-point expression
1166    --  values that are not an exact multiple of the small value of the type.
1167
1168    Warn_On_Constant : Boolean := False;
1169    --  GNAT
1170    --  Set to True to generate warnings for variables that could be declared
1171    --  as constants. Modified by use of -gnatwk/K.
1172
1173    Warn_On_Deleted_Code : Boolean := False;
1174    --  GNAT
1175    --  Set to True to generate warnings for code deleted by the front end
1176    --  for conditional statements whose outcome is known at compile time.
1177    --  Modified by use of -gnatwt/T.
1178
1179    Warn_On_Dereference : Boolean := False;
1180    --  GNAT
1181    --  Set to True to generate warnings for implicit dereferences for array
1182    --  indexing and record component access. Modified by use of -gnatwd/D.
1183
1184    Warn_On_Export_Import : Boolean := True;
1185    --  GNAT
1186    --  Set to True to generate warnings for suspicious use of export or
1187    --  import pragmas. Modified by use of -gnatwx/X.
1188
1189    Warn_On_Hiding : Boolean := False;
1190    --  GNAT
1191    --  Set to True to generate warnings if a declared entity hides another
1192    --  entity. The default is that this warning is suppressed.
1193
1194    Warn_On_Modified_Unread : Boolean := False;
1195    --  GNAT
1196    --  Set to True to generate warnings if a variable is assigned but is never
1197    --  read. The default is that this warning is suppressed.
1198
1199    Warn_On_Out_Parameter_Unread : Boolean := False;
1200    --  GNAT
1201    --  Set to True to generate warnings if a variable is modified by being
1202    --  passed as to an IN OUT or OUT formal, but the resulting value is never
1203    --  read. The default is that this warning is suppressed.
1204
1205    Warn_On_No_Value_Assigned : Boolean := True;
1206    --  GNAT
1207    --  Set to True to generate warnings if no value is ever assigned to a
1208    --  variable that is at least partially uninitialized. Set to false to
1209    --  suppress such warnings. The default is that such warnings are enabled.
1210
1211    Warn_On_Non_Local_Exception : Boolean := False;
1212    --  GNAT
1213    --  Set to True to generate warnings for non-local exception raises and also
1214    --  handlers that can never handle a local raise. This warning is only ever
1215    --  generated if pragma Restrictions (No_Exception_Propagation) is set. The
1216    --  default is not to generate the warnings even if the restriction is set.
1217
1218    Warn_On_Obsolescent_Feature : Boolean := False;
1219    --  GNAT
1220    --  Set to True to generate warnings on use of any feature in Annex or if a
1221    --  subprogram is called for which a pragma Obsolescent applies.
1222
1223    Warn_On_Questionable_Missing_Parens : Boolean := True;
1224    --  GNAT
1225    --  Set to True to generate warnings for cases where parenthese are missing
1226    --  and the usage is questionable, because the intent is unclear.
1227
1228    Warn_On_Redundant_Constructs : Boolean := False;
1229    --  GNAT
1230    --  Set to True to generate warnings for redundant constructs (e.g. useless
1231    --  assignments/conversions). The default is that this warning is disabled.
1232
1233    Warn_On_Object_Renames_Function : Boolean := False;
1234    --  GNAT
1235    --  Set to True to generate warnings when a function result is renamed as
1236    --  an object. The default is that this warning is disabled.
1237
1238    Warn_On_Reverse_Bit_Order : Boolean := True;
1239    --  GNAT
1240    --  Set to True to generate warning (informational) messages for component
1241    --  clauses that are affected by non-standard bit-order. The default is
1242    --  that this warning is enabled.
1243
1244    Warn_On_Unchecked_Conversion : Boolean := True;
1245    --  GNAT
1246    --  Set to True to generate warnings for unchecked conversions that may have
1247    --  non-portable semantics (e.g. because sizes of types differ). The default
1248    --  is that this warning is enabled.
1249
1250    Warn_On_Unrecognized_Pragma : Boolean := True;
1251    --  GNAT
1252    --  Set to True to generate warnings for unrecognized pragmas. The default
1253    --  is that this warning is enabled.
1254
1255    Warn_On_Unrepped_Components : Boolean := False;
1256    --  GNAT
1257    --  Set to True to generate warnings for the case of components of record
1258    --  which have a record representation clause but this component does not
1259    --  have a component clause. The default is that this warning is disabled.
1260
1261    type Warning_Mode_Type is (Suppress, Normal, Treat_As_Error);
1262    Warning_Mode : Warning_Mode_Type := Normal;
1263    --  GNAT, GNATBIND
1264    --  Controls treatment of warning messages. If set to Suppress, warning
1265    --  messages are not generated at all. In Normal mode, they are generated
1266    --  but do not count as errors. In Treat_As_Error mode, warning messages
1267    --  are generated and are treated as errors.
1268
1269    Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1270    --  GNAT
1271    --  Method used for encoding wide characters in the source program. See
1272    --  description of type in unit System.WCh_Con for a list of the methods
1273    --  that are currently supported. Note that brackets notation is always
1274    --  recognized in source programs regardless of the setting of this
1275    --  variable. The default setting causes only the brackets notation to be
1276    --  recognized. If this is the main unit, this setting also controls the
1277    --  output of the W=? parameter in the ALI file, which is used to provide
1278    --  the default for Wide_Text_IO files.
1279
1280    Xref_Active : Boolean := True;
1281    --  GNAT
1282    --  Set if cross-referencing is enabled (i.e. xref info in ALI files)
1283
1284    Zero_Formatting : Boolean := False;
1285    --  GNATBIND
1286    --  Do no formatting (no title, no leading spaces, no empty lines) in
1287    --  auxiliary outputs (-e, -K, -l, -R).
1288
1289    ----------------------------
1290    -- Configuration Settings --
1291    ----------------------------
1292
1293    --  These are settings that are used to establish the mode at the start of
1294    --  each unit. The values defined below can be affected either by command
1295    --  line switches, or by the use of appropriate configuration pragmas in the
1296    --  gnat.adc file.
1297
1298    Ada_Version_Config : Ada_Version_Type;
1299    --  GNAT
1300    --  This is the value of the configuration switch for the Ada 83 mode, as
1301    --  set by the command line switches -gnat83/95/05, and possibly modified by
1302    --  the use of configuration pragmas Ada_83/Ada95/Ada05. This switch is used
1303    --  to set the initial value for Ada_Version mode at the start of analysis
1304    --  of a unit. Note however, that the setting of this flag is ignored for
1305    --  internal and predefined units (which are always compiled in the most up
1306    --  to date version of Ada).
1307
1308    Ada_Version_Explicit_Config : Ada_Version_Type;
1309    --  GNAT
1310    --  This is set in the same manner as Ada_Version_Config. The difference is
1311    --  that the setting of this flag is not ignored for internal and predefined
1312    --  units, which for some purposes do indeed access this value, regardless
1313    --  of the fact that they are compiled the the most up to date ada version).
1314
1315    Assertions_Enabled_Config : Boolean;
1316    --  GNAT
1317    --  This is the value of the configuration switch for assertions enabled
1318    --  mode, as possibly set by the command line switch -gnata, and possibly
1319    --  modified by the use of the configuration pragma Assertion_Policy.
1320
1321    Debug_Pragmas_Enabled_Config : Boolean;
1322    --  GNAT
1323    --  This is the value of the configuration switch for debug pragmas enabled
1324    --  mode, as possibly set by the command line switch -gnata and possibly
1325    --  modified by the use of the configuration pragma Debug_Policy.
1326
1327    Dynamic_Elaboration_Checks_Config : Boolean := False;
1328    --  GNAT
1329    --  Set True for dynamic elaboration checking mode, as set by the -gnatE
1330    --  switch or by the use of pragma Elaboration_Checking (Dynamic).
1331
1332    Exception_Locations_Suppressed_Config : Boolean := False;
1333    --  GNAT
1334    --  Set True by use of the configuration pragma Suppress_Exception_Messages
1335
1336    Extensions_Allowed_Config : Boolean;
1337    --  GNAT
1338    --  This is the flag that indicates whether extensions are allowed. It can
1339    --  be set True either by use of the -gnatX switch, or by use of the
1340    --  configuration pragma Extensions_Allowed (On). It is always set to True
1341    --  for internal GNAT units, since extensions are always permitted in such
1342    --  units.
1343
1344    External_Name_Exp_Casing_Config : External_Casing_Type;
1345    --  GNAT
1346    --  This is the value of the configuration switch that controls casing of
1347    --  external symbols for which an explicit external name is given. It can be
1348    --  set to Uppercase by the command line switch -gnatF, and further modified
1349    --  by the use of the configuration pragma External_Name_Casing in the
1350    --  gnat.adc file. This flag is used to set the initial value for
1351    --  External_Name_Exp_Casing at the start of analyzing each unit. Note
1352    --  however that the setting of this flag is ignored for internal and
1353    --  predefined units (which are always compiled with As_Is mode).
1354
1355    External_Name_Imp_Casing_Config : External_Casing_Type;
1356    --  GNAT
1357    --  This is the value of the configuration switch that controls casing of
1358    --  external symbols where the external name is implicitly given. It can be
1359    --  set to Uppercase by the command line switch -gnatF, and further modified
1360    --  by the use of the configuration pragma External_Name_Casing in the
1361    --  gnat.adc file. This flag is used to set the initial value for
1362    --  External_Name_Imp_Casing at the start of analyzing each unit. Note
1363    --  however that the setting of this flag is ignored for internal and
1364    --  predefined units (which are always compiled with Lowercase mode).
1365
1366    Persistent_BSS_Mode_Config : Boolean;
1367    --  GNAT
1368    --  This is the value of the configuration switch that controls whether
1369    --  potentially persistent data is to be placed in the persistent_bss
1370    --  section. It can be set True by use of the pragma Persistent_BSS.
1371    --  This flag is used to set the initial value of Persistent_BSS_Mode
1372    --  at the start of each compilation unit, except that it is always
1373    --  set False for predefined units.
1374
1375    Polling_Required_Config : Boolean;
1376    --  GNAT
1377    --  This is the value of the configuration switch that controls polling
1378    --  mode. It can be set True by the command line switch -gnatP, and then
1379    --  further modified by the use of pragma Polling in the gnat.adc file. This
1380    --  flag is used to set the initial value for Polling_Required at the start
1381    --  of analyzing each unit.
1382
1383    Use_VADS_Size_Config : Boolean;
1384    --  GNAT
1385    --  This is the value of the configuration switch that controls the use of
1386    --  VADS_Size instead of Size whereever the attribute Size is used. It can
1387    --  be set True by the use of the pragma Use_VADS_Size in the gnat.adc file.
1388    --  This flag is used to set the initial value for Use_VADS_Size at the
1389    --  start of analyzing each unit. Note however that the setting of this flag
1390    --  is ignored for internal and predefined units (which are always compiled
1391    --  with the standard Size semantics).
1392
1393    type Config_Switches_Type is private;
1394    --  Type used to save values of the switches set from Config values
1395
1396    procedure Save_Opt_Config_Switches (Save : out Config_Switches_Type);
1397    --  This procedure saves the current values of the switches which are
1398    --  initialized from the above Config values, and then resets these switches
1399    --  according to the Config value settings.
1400
1401    procedure Set_Opt_Config_Switches
1402      (Internal_Unit : Boolean;
1403       Main_Unit     : Boolean);
1404    --  This procedure sets the switches to the appropriate initial values. The
1405    --  parameter Internal_Unit is True for an internal or predefined unit, and
1406    --  affects the way the switches are set (see above). Main_Unit is true if
1407    --  switches are being set for the main unit (this affects setting of the
1408    --  assert/debug pragma switches, which are normally set false by default
1409    --  for an internal unit, except when the internal unit is the main unit,
1410    --  in which case we use the command line settings).
1411
1412    procedure Restore_Opt_Config_Switches (Save : Config_Switches_Type);
1413    --  This procedure restores a set of switch values previously saved by a
1414    --  call to Save_Opt_Switches.
1415
1416    procedure Register_Opt_Config_Switches;
1417    --  This procedure is called after processing the gnat.adc file to record
1418    --  the values of the Config switches, as possibly modified by the use of
1419    --  command line switches and configuration pragmas.
1420
1421    ------------------------
1422    -- Other Global Flags --
1423    ------------------------
1424
1425    Expander_Active : Boolean := False;
1426    --  A flag that indicates if expansion is active (True) or deactivated
1427    --  (False). When expansion is deactivated all calls to expander routines
1428    --  have no effect. Note that the initial setting of False is merely to
1429    --  prevent saving of an undefined value for an initial call to the
1430    --  Expander_Mode_Save_And_Set procedure. For more information on the use of
1431    --  this flag, see package Expander. Indeed this flag might more logically
1432    --  be in the spec of Expander, but it is referenced by Errout, and it
1433    --  really seems wrong for Errout to depend on Expander.
1434
1435    Static_Dispatch_Tables : Boolean := True;
1436    --  This flag indicates if the backend supports generation of statically
1437    --  allocated dispatch tables. If it is True, then the front end will
1438    --  generate static aggregates for dispatch tables that contain forward
1439    --  references to addresses of subprograms not seen yet, and the back end
1440    --  must be prepared to handle this case. If it is False, then the front
1441    --  end generates assignments to initialize the dispatch table, and there
1442    --  are no such forward references. By default we build statically allocated
1443    --  dispatch tables for all library level tagged types in all platforms.This
1444    --  behavior can be disabled using switch -gnatd.t which will set this flag
1445    --  to False and revert to the previous dynamic behavior.
1446
1447    -----------------------
1448    -- Tree I/O Routines --
1449    -----------------------
1450
1451    procedure Tree_Read;
1452    --  Reads switch settings from current tree file using Tree_Read
1453
1454    procedure Tree_Write;
1455    --  Writes out switch settings to current tree file using Tree_Write
1456
1457    --------------------------
1458    -- ASIS Version Control --
1459    --------------------------
1460
1461    --  These two variables (Tree_Version_String and Tree_ASIS_Version_Number)
1462    --  are supposed to be used in the GNAT/ASIS version check performed in
1463    --  the ASIS code (this package is also a part of the ASIS implementation).
1464    --  They are set by Tree_Read procedure, so they represent the version
1465    --  number (and the version string) of the compiler which has created the
1466    --  tree, and they are supposed to be compared with the corresponding values
1467    --  from the Tree_IO and Gnatvsn packages which also are a part of ASIS
1468    --  implementation.
1469
1470    Tree_Version_String : String_Access;
1471    --  Used to store the compiler version string read from a tree file to check
1472    --  if it is from the same date as stored in the version string in Gnatvsn.
1473    --  We require that ASIS Pro can be used only with GNAT Pro, but we allow
1474    --  non-Pro ASIS and ASIS-based tools to be used with any version of the
1475    --  GNAT compiler. Therefore, we need the possibility to compare the dates
1476    --  of the corresponding source sets, using version strings that may be
1477    --  of different lengths.
1478
1479    Tree_ASIS_Version_Number : Int;
1480    --  Used to store the ASIS version number read from a tree file to check if
1481    --  it is the same as stored in the ASIS version number in Tree_IO.
1482
1483 private
1484
1485    --  The following type is used to save and restore settings of switches in
1486    --  Opt that represent the configuration (i.e. result of config pragmas).
1487
1488    --  Note that Ada_Version_Explicit is not included, since this is a sticky
1489    --  flag that once set does not get reset, since the whole idea of this flag
1490    --  is to record the setting for the main unit.
1491
1492    type Config_Switches_Type is record
1493       Ada_Version                    : Ada_Version_Type;
1494       Ada_Version_Explicit           : Ada_Version_Type;
1495       Assertions_Enabled             : Boolean;
1496       Debug_Pragmas_Enabled          : Boolean;
1497       Dynamic_Elaboration_Checks     : Boolean;
1498       Exception_Locations_Suppressed : Boolean;
1499       Extensions_Allowed             : Boolean;
1500       External_Name_Exp_Casing       : External_Casing_Type;
1501       External_Name_Imp_Casing       : External_Casing_Type;
1502       Persistent_BSS_Mode            : Boolean;
1503       Polling_Required               : Boolean;
1504       Use_VADS_Size                  : Boolean;
1505    end record;
1506
1507    --  The following declarations are for GCC version dependent flags. We do
1508    --  not let client code in the compiler test GCC_Version directly, but
1509    --  instead use deferred constants for relevant feature tags.
1510
1511    --  Note: there currently are no such constants defined in this section,
1512    --  since the compiler front end is currently entirely independent of the
1513    --  GCC version, which is a desirable state of affairs.
1514
1515    function get_gcc_version return Int;
1516    pragma Import (C, get_gcc_version, "get_gcc_version");
1517
1518    GCC_Version : constant Nat := get_gcc_version;
1519    --  GNATMAKE
1520    --  Indicates which version of gcc is in use (3 = 3.x, 4 = 4.x). Note that
1521    --  gcc 2.8.1 (which used to be a value of 2) is no longer supported.
1522
1523 end Opt;