OSDN Git Service

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