OSDN Git Service

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