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