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