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