1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2004, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- This package contains global flags set by the initialization
35 -- routine from the command line and referenced throughout the compiler,
36 -- the binder, gnatmake or other GNAT tools. The comments indicate which
37 -- options are used by which programs (GNAT, GNATBIND, GNATMAKE, etc).
39 with Gnatvsn; use Gnatvsn;
40 with Hostparm; use Hostparm;
41 with Types; use Types;
43 with System.WCh_Con; use System.WCh_Con;
44 with GNAT.Strings; use GNAT.Strings;
48 ----------------------------------------------
49 -- Settings of Modes for Current Processing --
50 ----------------------------------------------
52 -- The following mode values represent the current state of processing.
53 -- The values set here are the default values. Unless otherwise noted,
54 -- the value may be reset in Switch with an appropropiate switch. In
55 -- some cases, the values can also be modified by pragmas, and in the
56 -- case of some binder variables, Gnatbind.Scan_Bind_Arg may modify
57 -- the default values.
59 Ada_Bind_File : Boolean := True;
61 -- Set True if binder file to be generated in Ada rather than C
63 Ada_95 : Boolean := True;
65 -- Set True if operating in Ada 95 mode
66 -- Set False if operating in Ada 83 mode
68 Ada_83 : Boolean := False;
70 -- Set True if operating in Ada 83 mode
71 -- Set False if operating in Ada 95 mode
73 Ada_Final_Suffix : constant String := "final";
74 Ada_Final_Name : String_Ptr := new String'("ada" & Ada_Final_Suffix);
76 -- The name of the procedure that performs the finalization at the end of
77 -- execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
79 Ada_Init_Suffix : constant String := "init";
80 Ada_Init_Name : String_Ptr := new String'("ada" & Ada_Init_Suffix);
82 -- The name of the procedure that performs initialization at the start
83 -- of execution. This variable may be modified by Gnatbind.Scan_Bind_Arg.
85 Ada_Main_Name_Suffix : constant String := "main";
87 -- The suffix for Ada_Main_Name. Defined as a constant here so that it
88 -- can be referenced in a uniform manner to create either the default
89 -- value of Ada_Main_Name (declared below), or the non-default name
90 -- set by Gnatbind.Scan_Bind_Arg.
92 Ada_Main_Name : String_Ptr := new String'("ada_" & Ada_Main_Name_Suffix);
94 -- The name of the Ada package generated by the binder (when in Ada mode).
95 -- This variable may be modified by Gnatbind.Scan_Bind_Arg.
97 Address_Clause_Overlay_Warnings : Boolean := True;
99 -- Set False to disable address clause warnings
101 All_Errors_Mode : Boolean := False;
103 -- Flag set to force display of multiple errors on a single line and
104 -- also repeated error messages for references to undefined identifiers
105 -- and certain other repeated error messages.
107 All_Sources : Boolean := False;
109 -- Set to True to require all source files to be present. This flag is
110 -- directly modified by gnatmake to affect the shared binder routines.
112 Alternate_Main_Name : String_Ptr := null;
114 -- Set to non null when Bind_Alternate_Main_Name is True. This value
115 -- is modified as needed by Gnatbind.Scan_Bind_Arg.
117 Assertions_Enabled : Boolean := False;
119 -- Enable assertions made using pragma Assert.
121 ASIS_Mode : Boolean := False;
123 -- Enable semantic checks and tree transformations that are important
124 -- for ASIS but that are usually skipped if Operating_Mode is set to
125 -- Check_Semantics. This flag does not have the corresponding option to set
126 -- it ON. It is set ON when Tree_Output is set ON, it can also be set ON
127 -- from the code of GNSA-based tool (a client may need to set ON the
128 -- Back_Annotate_Rep_Info flag in this case. At the moment this does not
129 -- make very much sense, because GNSA can not do back annotation).
131 Back_Annotate_Rep_Info : Boolean := False;
133 -- If set True, enables back annotation of representation information
134 -- by gigi, even in -gnatc mode. This is set True by the use of -gnatR
135 -- (list representation information) or -gnatt (generate tree). It is
136 -- also set true if certain Unchecked_Conversion instantiations require
137 -- checking based on annotated values.
139 Bind_Alternate_Main_Name : Boolean := False;
141 -- True if main should be called Alternate_Main_Name.all.
142 -- This variable may be set to True by Gnatbind.Scan_Bind_Arg.
144 Bind_Main_Program : Boolean := True;
146 -- Set to False if not binding main Ada program.
148 Bind_For_Library : Boolean := False;
150 -- Set to True if the binder needs to generate a file designed for
151 -- building a library. May be set to True by Gnatbind.Scan_Bind_Arg.
153 Bind_Only : Boolean := False;
155 -- Set to True to skip compile and link steps
156 -- (except when Compile_Only and/or Link_Only are True).
158 Blank_Deleted_Lines : Boolean := False;
160 -- Output empty lines for each line of preprocessed input that is deleted
161 -- in the output, including preprocessor lines starting with a '#'.
163 Brief_Output : Boolean := False;
165 -- Force brief error messages to standard error, even if verbose mode is
166 -- set (so that main error messages go to standard output).
168 Build_Bind_And_Link_Full_Project : Boolean := False;
170 -- Set to True to build, bind and link all the sources of a project file
173 Check_Object_Consistency : Boolean := False;
174 -- GNATBIND, GNATMAKE
175 -- Set to True to check whether every object file is consistent with
176 -- its corresponding ada library information (ALI) file. An object
177 -- file is inconsistent with the corresponding ALI file if the object
178 -- file does not exist or if it has an older time stamp than the ALI file.
179 -- Default above is for GNATBIND. GNATMAKE overrides this default to
180 -- True (see Make.Initialize) since we normally do need to check source
181 -- consistencies in gnatmake.
183 Check_Only : Boolean := False;
185 -- Set to True to do checks only, no output of binder file.
187 Check_Readonly_Files : Boolean := False;
189 -- Set to True to check readonly files during the make process.
191 Check_Source_Files : Boolean := True;
192 -- GNATBIND, GNATMAKE
193 -- Set to True to enable consistency checking for any source files that
194 -- are present (i.e. date must match the date in the library info file).
195 -- Set to False for object file consistency check only. This flag is
196 -- directly modified by gnatmake, to affect the shared binder routines.
198 Check_Switches : Boolean := False;
200 -- Set to True to check compiler options during the make process.
202 Check_Unreferenced : Boolean := False;
204 -- Set to True to enable checking for unreferenced entities other
205 -- than formal parameters (for which see Check_Unreferenced_Formals)
207 Check_Unreferenced_Formals : Boolean := False;
209 -- Set True to check for unreferenced formals. This is turned
210 -- on by -gnatwa/wf/wu and turned off by -gnatwA/wF/wU.
212 Check_Withs : Boolean := False;
214 -- Set to True to enable checking for unused withs, and also the case
215 -- of withing a package and using none of the entities in the package.
217 Comment_Deleted_Lines : Boolean := False;
219 -- True if source lines removed by the preprocessor should be commented
220 -- in the output file.
222 Compile_Only : Boolean := False;
223 -- GNATMAKE, GNATCLEAN
224 -- GNATMAKE: set to True to skip bind and link steps (except when
225 -- Bind_Only is True).
226 -- GNATCLEAN: set to True to only the files produced by the compiler are to
227 -- be deleted, but not the library files or executable files.
229 Config_File : Boolean := True;
231 -- Set to False to inhibit reading and processing of gnat.adc file
233 Config_File_Names : String_List_Access := null;
235 -- Names of configuration pragmas files (given by switches -gnatec)
237 Configurable_Run_Time_Mode : Boolean := False;
239 -- Set True if the compiler is operating in configurable run-time mode.
240 -- This happens if the flag Targparm.Configurable_Run_TimeMode_On_Target
241 -- is set True, or if pragma No_Run_Time is used. See the spec of Rtsfind
242 -- for details on the handling of the latter pragma.
244 Constant_Condition_Warnings : Boolean := False;
246 -- Set to True to activate warnings on constant conditions
248 Create_Mapping_File : Boolean := False;
250 -- Set to True (-C switch) to indicate that gnatmake
251 -- invokes the compiler with a mapping file (-gnatem compiler switch).
253 subtype Debug_Level_Value is Nat range 0 .. 3;
254 Debugger_Level : Debug_Level_Value := 0;
256 -- The value given to the -g parameter.
257 -- The default value for -g with no value is 2
258 -- This is usually ignored by GNATBIND, except in the VMS version
259 -- where it is passed as an argument to __gnat_initialize to trigger
260 -- the activation of the remote debugging interface (is this true???).
262 Debug_Generated_Code : Boolean := False;
264 -- Set True (-gnatD switch) to debug generated expanded code instead
265 -- of the original source code. Causes debugging information to be
266 -- written with respect to the generated code file that is written.
268 Default_Sec_Stack_Size : Int := -1;
270 -- Set to default secondary stack size in units of kilobytes. Set by
271 -- the -Dnnn switch for the binder. A value of -1 indicates that no
272 -- default was set by the binder, and that the default should be the
273 -- initial value of System.Secondary_Stack.Default_Secondary_Stack_Size.
275 Display_Compilation_Progress : Boolean := False;
277 -- Set True (-d switch) to display information on progress while compiling
278 -- files. Internal flag to be used in conjunction with an IDE such as
281 type Distribution_Stub_Mode_Type is
284 -- Normal mode, no generation/compilation of distribution stubs
286 Generate_Receiver_Stub_Body,
287 -- The unit being compiled is the RCI body, and the compiler will
288 -- generate the body for the receiver stubs and compile it.
290 Generate_Caller_Stub_Body);
291 -- The unit being compiled is the RCI spec, and the compiler will
292 -- generate the body for the caller stubs and compile it.
294 Distribution_Stub_Mode : Distribution_Stub_Mode_Type := No_Stubs;
296 -- This enumeration variable indicates the five states of distribution
297 -- annex stub generation/compilation.
299 Do_Not_Execute : Boolean := False;
301 -- Set to True if no actual compilations should be undertaken.
303 Dynamic_Elaboration_Checks : Boolean := False;
305 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
306 -- switch or by the use of pragma Elaboration_Checks (Dynamic).
308 Elab_Dependency_Output : Boolean := False;
310 -- Set to True to output complete list of elaboration constraints
312 Elab_Order_Output : Boolean := False;
314 -- Set to True to output chosen elaboration order
316 Elab_Warnings : Boolean := False;
318 -- Set to True to generate full elaboration warnings (-gnatwl)
320 Enable_Overflow_Checks : Boolean := False;
322 -- Set to True if -gnato (enable overflow checks) switch is set,
325 Exception_Locations_Suppressed : Boolean := False;
327 -- This flag is set True if a Suppress_Exception_Locations configuration
328 -- pragma is currently active.
330 type Exception_Mechanism_Type is
331 -- Determines the handling of exceptions. See Exp_Ch11 for details
333 (Front_End_Setjmp_Longjmp_Exceptions,
334 -- Exceptions use setjmp/longjmp generated explicitly by the
335 -- front end (this includes gigi or other equivalent parts of
336 -- the code generator). AT END handlers are converted into
337 -- exception handlers by the front end in this mode.
339 Front_End_ZCX_Exceptions,
340 -- Exceptions use the zero cost table mechanism with explicit
341 -- tables and exception regions generated by the front end.
342 -- AT END handlers are converted into exception handlers by
343 -- the front end in this mode.
345 Back_End_ZCX_Exceptions);
346 -- Exceptions are handled by the back end. The front end simply
347 -- generates the handlers as they appear in the source, and AT
348 -- END handlers are left untouched (they are not converted into
349 -- exception handlers when operating in this mode. Note that the
350 -- name includes ZCX, since the expectation is that the back end
351 -- mechanism will in fact be a ZCX approach, but nothing in the
352 -- compiler depends on this, so for example if GNAT is run with
353 -- a version of GCC configured for setjmp/longjmp exception handling,
354 -- then everything will work fine.
355 pragma Convention (C, Exception_Mechanism_Type);
357 Exception_Mechanism : Exception_Mechanism_Type :=
358 Front_End_Setjmp_Longjmp_Exceptions;
360 -- Set to the appropriate value depending on the default as given in
361 -- system.ads (ZCX_By_Default, GCC_ZCX_Support, Front_End_ZCX_Support)
362 -- and the use of -gnatL -gnatZ (and -gnatdX). The C convention is
363 -- there to make this variable accessible to gigi.
365 Exception_Tracebacks : Boolean := False;
367 -- Set to True to store tracebacks in exception occurrences (-E)
369 Extensions_Allowed : Boolean := False;
371 -- Set to True by switch -gnatX if GNAT specific language extensions
372 -- are allowed. For example, "with type" is a GNAT extension.
374 type External_Casing_Type is (
375 As_Is, -- External names cased as they appear in the Ada source
376 Uppercase, -- External names forced to all uppercase letters
377 Lowercase); -- External names forced to all lowercase letters
379 External_Name_Imp_Casing : External_Casing_Type := Lowercase;
381 -- The setting of this flag determines the casing of external names
382 -- when the name is implicitly derived from an entity name (i.e. either
383 -- no explicit External_Name or Link_Name argument is used, or, in the
384 -- case of extended DEC pragmas, the external name is given using an
385 -- identifier. The As_Is setting is not permitted here (since this would
386 -- create Ada source programs that were case sensitive).
388 External_Name_Exp_Casing : External_Casing_Type := As_Is;
390 -- The setting of this flag determines the casing of an external name
391 -- specified explicitly with a string literal. As_Is means the string
392 -- literal is used as given with no modification to the casing. If
393 -- Lowercase or Uppercase is set, then the string is forced to all
394 -- lowercase or all uppercase letters as appropriate. Note that this
395 -- setting has no effect if the external name is given using an identifier
396 -- in the case of extended DEC import/export pragmas (in this case the
397 -- casing is controlled by External_Name_Imp_Casing), and also has no
398 -- effect if an explicit Link_Name is supplied (a link name is always
399 -- used exactly as given).
401 Float_Format : Character := ' ';
403 -- A non-blank value indicates that a Float_Format pragma has been
404 -- processed, in which case this variable is set to 'I' for IEEE or
405 -- to 'V' for VAX. The setting of 'V' is only possible on OpenVMS
408 Float_Format_Long : Character := ' ';
410 -- A non-blank value indicates that a Long_Float pragma has been
411 -- processed (this pragma is recognized only in OpenVMS versions
412 -- of GNAT), in which case this variable is set to D or G for
413 -- D_Float or G_Float.
415 Force_ALI_Tree_File : Boolean := False;
417 -- Force generation of ALI file even if errors are encountered.
418 -- Also forces generation of tree file if -gnatt is also set.
420 Force_Checking_Of_Elaboration_Flags : Boolean := False;
422 -- True if binding with forced checking of the elaboration flags
425 Force_Compilations : Boolean := False;
427 -- Set to force recompilations even when the objects are up-to-date.
429 Force_RM_Elaboration_Order : Boolean := False;
431 -- True if binding with forced RM elaboration order (-f switch set)
432 -- Note: this is considered an obsolescent option, to be removed in
433 -- some future release. It is no longer documented. The proper way
434 -- to get this effect is to use -gnatE and suppress elab checks.
436 Full_Path_Name_For_Brief_Errors : Boolean := False;
437 -- GNAT, GNATMAKE, GNATCLEAN
438 -- When True, in Brief_Output mode, each error message line
439 -- will start with the full path name of the source.
440 -- When False, only the file name without directory information
443 Full_List : Boolean := False;
445 -- Set True to generate full source listing with embedded errors
447 function get_gcc_version return Int;
448 pragma Import (C, get_gcc_version, "get_gcc_version");
450 GCC_Version : constant Nat := get_gcc_version;
452 -- Indicates which version of gcc is in use (2 = 2.8.1, 3 = 3.x).
453 -- Used in particular to decide if gcc switch -shared-libgcc should be
454 -- used (it cannot be used for 2.8.1).
456 Global_Discard_Names : Boolean := False;
458 -- Set true if a pragma Discard_Names applies to the current unit
460 GNAT_Mode : Boolean := False;
462 -- True if compiling in GNAT system mode (-gnatg switch)
464 HLO_Active : Boolean := False;
466 -- True if High Level Optimizer is activated (-gnatH switch)
468 Implementation_Unit_Warnings : Boolean := True;
470 -- Set True to active warnings for use of implementation internal units.
471 -- Can be controlled by use of -gnatwi/-gnatwI.
473 Identifier_Character_Set : Character;
475 -- This variable indicates the character set to be used for identifiers.
476 -- The possible settings are:
477 -- '1' Latin-5 (ISO-8859-1)
478 -- '2' Latin-5 (ISO-8859-2)
479 -- '3' Latin-5 (ISO-8859-3)
480 -- '4' Latin-5 (ISO-8859-4)
481 -- '5' Latin-5 (ISO-8859-5, Cyrillic)
482 -- '9' Latin-5 (ISO-8859-9)
483 -- 'p' PC (US, IBM page 437)
484 -- '8' PC (European, IBM page 850)
485 -- 'f' Full upper set (all distinct)
486 -- 'n' No upper characters (Ada/83 rules)
487 -- 'w' Latin-1 plus wide characters allowed in identifiers
489 -- The setting affects the set of letters allowed in identifiers and the
490 -- upper/lower case equivalences. It does not affect the interpretation of
491 -- character and string literals, which are always stored using the actual
492 -- coding in the source program. This variable is initialized to the
493 -- default value appropriate to the system (in Osint.Initialize), and then
494 -- reset if a command line switch is used to change the setting.
496 Ineffective_Inline_Warnings : Boolean := False;
498 -- Set True to activate warnings if front-end inlining (-gnatN) is not
499 -- able to actually inline a particular call (or all calls). Can be
500 -- controlled by use of -gnatwp/-gnatwP.
502 Init_Or_Norm_Scalars : Boolean := False;
504 -- Set True if a pragma Initialize_Scalars applies to the current unit.
505 -- Also set True if a pragma Normalize_Scalars applies.
507 Initialize_Scalars : Boolean := False;
509 -- Set True if a pragma Initialize_Scalars applies to the current unit.
510 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
512 Initialize_Scalars_Mode1 : Character := 'I';
513 Initialize_Scalars_Mode2 : Character := 'N';
515 -- Set to two characters from -S switch (IN/LO/HI/EV/xx). The default
516 -- is IN (invalid values), used if no -S switch is used.
518 Inline_Active : Boolean := False;
520 -- Set True to activate pragma Inline processing across modules. Default
521 -- for now is not to inline across module boundaries.
523 Interface_Library_Unit : Boolean := False;
525 -- Set to True to indicate that at least one ALI file is an interface ALI:
526 -- then elaboration flag checks are to be generated in the binder
529 Front_End_Inlining : Boolean := False;
531 -- Set True to activate inlining by front-end expansion.
533 Inline_Processing_Required : Boolean := False;
535 -- Set True if inline processing is required. Inline processing is
536 -- required if an active Inline pragma is processed. The flag is set
537 -- for a pragma Inline or Inline_Always that is actually active.
539 In_Place_Mode : Boolean := False;
541 -- Set True to store ALI and object files in place ie in the object
542 -- directory if these files already exist or in the source directory
545 Keep_Going : Boolean := False;
547 -- When True signals gnatmake to ignore compilation errors and keep
548 -- processing sources until there is no more work.
550 Link_Only : Boolean := False;
552 -- Set to True to skip compile and bind steps
553 -- (except when Bind_Only is set to True).
555 List_Restrictions : Boolean := False;
557 -- Set to True to list restrictions pragmas that could apply to partition
559 List_Units : Boolean := False;
561 -- List units in the active library for a compilation (-gnatu switch)
563 List_Dependencies : Boolean := False;
565 -- When True gnatmake verifies that the objects are up to date and
566 -- outputs the list of object dependencies (-M switch).
567 -- Output depends if -a switch is used or not.
568 -- This list can be used directly in a Makefile.
570 List_Representation_Info : Int range 0 .. 3 := 0;
572 -- Set non-zero by -gnatR switch to list representation information.
573 -- The settings are as follows:
575 -- 0 = no listing of representation information (default as above)
576 -- 1 = list rep info for user defined record and array types
577 -- 2 = list rep info for all user defined types and objects
578 -- 3 = like 2, but variable fields are decoded symbolically
580 List_Representation_Info_To_File : Boolean := False;
582 -- Set true by -gnatRs switch. Causes information from -gnatR/1/2/3
583 -- to be written to file.rep (where file is the name of the source
584 -- file) instead of stdout. For example, if file x.adb is compiled
585 -- using -gnatR2s then representation info is written to x.adb.ref.
587 List_Representation_Info_Mechanisms : Boolean := False;
589 -- Set true by -gnatRm switch. Causes information on mechanisms to
590 -- be included in the representation output information.
592 List_Preprocessing_Symbols : Boolean := False;
594 -- Set to True if symbols for preprocessing a source are to be listed
595 -- before preprocessing occurs. Set to True by switch -s of gnatprep
596 -- or -s in preprocessing data file for the compiler.
598 type Creat_Repinfo_File_Proc is access procedure (Src : File_Name_Type);
599 type Write_Repinfo_Line_Proc is access procedure (Info : String);
600 type Close_Repinfo_File_Proc is access procedure;
601 -- Types used for procedure addresses below
603 Creat_Repinfo_File_Access : Creat_Repinfo_File_Proc := null;
604 Write_Repinfo_Line_Access : Write_Repinfo_Line_Proc := null;
605 Close_Repinfo_File_Access : Close_Repinfo_File_Proc := null;
607 -- These three locations are left null when operating in non-compiler
608 -- (e.g. ASIS mode), but when operating in compiler mode, they are
609 -- set to point to the three corresponding procedures in Osint. The
610 -- reason for this slightly strange interface is to prevent Repinfo
611 -- from dragging in Osint in ASIS mode, which would include a lot of
612 -- unwanted units in the ASIS build.
614 Locking_Policy : Character := ' ';
616 -- Set to ' ' for the default case (no locking policy specified).
617 -- Reset to first character (uppercase) of locking policy name if a
618 -- valid pragma Locking_Policy is encountered.
620 Locking_Policy_Sloc : Source_Ptr := No_Location;
622 -- Remember location of previous Locking_Policy pragma. This is used
623 -- for inconsistency error messages. A value of System_Location is
624 -- used if the policy is set in package System.
626 Look_In_Primary_Dir : Boolean := True;
627 -- GNAT, GNATBIND, GNATMAKE, GNATCLEAN
628 -- Set to False if a -I- was present on the command line.
629 -- When True we are allowed to look in the primary directory to locate
630 -- other source or library files.
632 Make_Steps : Boolean := False;
634 -- Set to True when either Compile_Only, Bind_Only or Link_Only is
637 Mapping_File_Name : String_Ptr := null;
639 -- File name of mapping between unit names, file names and path names.
640 -- (given by switch -gnatem)
642 Maximum_Errors : Int := 9999;
644 -- Maximum default number of errors before compilation is terminated.
645 -- Can be overridden using -gnatm (GNAT) or -m (GNATBIND) switch.
647 Maximum_File_Name_Length : Int;
649 -- Maximum number of characters allowed in a file name, not counting the
650 -- extension, as set by the appropriate switch. If no switch is given,
651 -- then this value is initialized by Osint to the appropriate value.
653 Maximum_Processes : Positive := 1;
655 -- Maximum number of processes that should be spawned to carry out
658 Minimal_Recompilation : Boolean := False;
660 -- Set to True if minimal recompilation mode requested.
662 No_Stdlib : Boolean := False;
663 -- GNATMAKE, GNATBIND, GNATFIND, GNATXREF
664 -- Set to True if no default library search dirs added to search list.
666 No_Stdinc : Boolean := False;
667 -- GNAT, GNATBIND, GNATMAKE, GNATFIND, GNATXREF
668 -- Set to True if no default source search dirs added to search list.
670 No_Main_Subprogram : Boolean := False;
671 -- GNATMAKE, GNATBIND
672 -- Set to True if compilation/binding of a program without main
673 -- subprogram requested.
675 No_Run_Time_Mode : Boolean := False;
677 -- This flag is set True if a No_Run_Time pragma is encountered. See
678 -- spec of Rtsfind for a full description of handling of this pragma.
680 Normalize_Scalars : Boolean := False;
682 -- Set True if a pragma Normalize_Scalars applies to the current unit.
683 -- Note that Init_Or_Norm_Scalars is also set to True if this is True.
685 Object_Directory_Present : Boolean := False;
687 -- Set to True when an object directory is specified with option -D
689 type Operating_Mode_Type is (Check_Syntax, Check_Semantics, Generate_Code);
690 Operating_Mode : Operating_Mode_Type := Generate_Code;
692 -- Indicates the operating mode of the compiler. The default is generate
693 -- code, which runs the parser, semantics and backend. Switches can be
694 -- used to set syntax checking only mode, or syntax and semantics checking
695 -- only mode. Operating_Mode can also be modified as a result of detecting
696 -- errors during the compilation process. In particular if any serious
697 -- error is detected then this flag is reset from Generate_Code to
698 -- Check_Semantics after generating an error message.
700 Original_Operating_Mode : Operating_Mode_Type := Generate_Code;
702 -- Indicates the original operating mode of the compiler as set by
703 -- compiler options. This is identical to Operating_Mode except that
704 -- this is not affected by errors.
706 Optimization_Level : Int;
707 pragma Import (C, Optimization_Level, "optimize");
708 -- This constant reflects the optimization level (0,1,2 for -O0,-O1,-O2)
710 Output_File_Name_Present : Boolean := False;
711 -- GNATBIND, GNAT, GNATMAKE
712 -- Set to True when the output C file name is given with option -o
713 -- for GNATBIND, when the object file name is given with option
714 -- -gnatO for GNAT or when the executable is given with option -o
717 Output_Linker_Option_List : Boolean := False;
719 -- True if output of list of linker options is requested (-K switch set)
721 Output_Object_List : Boolean := False;
723 -- True if output of list of objects is requested (-O switch set)
725 Pessimistic_Elab_Order : Boolean := False;
727 -- True if pessimistic elaboration order is to be chosen (-p switch set)
729 Polling_Required : Boolean := False;
731 -- Set to True if polling for asynchronous abort is enabled by using
732 -- the -gnatP option for GNAT.
734 Preprocessing_Data_File : String_Ptr := null;
736 -- Set by switch -gnatep=. The file name of the prepocessing data file.
738 Print_Generated_Code : Boolean := False;
740 -- Set to True to enable output of generated code in source form. This
741 -- flag is set by the -gnatG switch.
743 Print_Standard : Boolean := False;
745 -- Set to true to enable printing of package standard in source form.
746 -- This flag is set by the -gnatS switch
748 Propagate_Exceptions : Boolean := False;
750 -- Indicates if subprogram descriptor exception tables should be
751 -- built for imported subprograms. Set True if a Propagate_Exceptions
752 -- pragma applies to the extended main unit.
754 type Usage is (Unknown, Not_In_Use, In_Use);
755 Project_File_In_Use : Usage := Unknown;
757 -- Indicates if a project file is used or not.
758 -- Set to In_Use by the first SFNP pragma.
760 Queuing_Policy : Character := ' ';
762 -- Set to ' ' for the default case (no queuing policy specified).
763 -- Reset to first character (uppercase) of locking policy name if a valid
764 -- Queuing_Policy pragma is encountered.
766 Queuing_Policy_Sloc : Source_Ptr := No_Location;
768 -- Remember location of previous Queuing_Policy pragma. This is used
769 -- for inconsistency error messages. A value of System_Location is
770 -- used if the policy is set in package System.
772 Quiet_Output : Boolean := False;
773 -- GNATMAKE, GNATCLEAN, GPR2MAKE
774 -- Set to True if the tool should not have any output if there are no
775 -- errors or warnings.
777 RTS_Lib_Path_Name : String_Ptr := null;
778 RTS_Src_Path_Name : String_Ptr := null;
780 -- Set to the "adalib" and "adainclude" directories of the run time
781 -- specified by --RTS=.
783 RTS_Switch : Boolean := False;
784 -- GNAT, GNATMAKE, GNATBIND, GNATLS, GNATFIND, GNATXREF
785 -- Set to True when the --RTS switch is set
787 Run_Path_Option : Boolean := True;
788 -- GNATMAKE, GNATLINK
789 -- Set to False when no run_path_option should be issued to the linker
791 Sec_Stack_Used : Boolean := False;
793 -- Set True if generated code uses the System.Secondary_Stack package.
794 -- For the binder, set if any unit uses the secondary stack package.
796 Shared_Libgnat : Boolean;
798 -- Set to True if a shared libgnat is requested by using the -shared
799 -- option for GNATBIND and to False when using the -static option. The
800 -- value of this flag is set by Gnatbind.Scan_Bind_Arg.
802 Stack_Checking_Enabled : Boolean;
804 -- Set to indicate if -fstack-check switch is set for the compilation.
805 -- True means that the switch is set, so that stack checking is enabled.
806 -- False means that the switch is not set (no stack checking). This
807 -- value is obtained from the external imported value flag_stack_check
808 -- in the gcc backend (see Frontend) and may be referenced throughout
809 -- the compilation phases.
811 Style_Check : Boolean := False;
813 -- Set True to perform style checks. Activates checks carried out
814 -- in package Style (see body of this package for details of checks)
815 -- This flag is set True by either the -gnatg or -gnaty switches.
817 System_Extend_Pragma_Arg : Node_Id := Empty;
819 -- Set non-empty if and only if a correct Extend_System pragma was present
820 -- in which case it points to the argument of the pragma, and the name can
821 -- be located as Chars (Expression (System_Extend_Pragma_Arg)).
823 System_Extend_Unit : Node_Id := Empty;
825 -- This is set to Empty if GNAT_Mode is set, since pragma Extend_System
826 -- is never appropriate in GNAT_Mode (and causes troubles, including
827 -- bogus circularities, if we try to compile the run-time library with
828 -- a System extension). If GNAT_Mode is not set, then System_Extend_Unit
829 -- is a copy of the value set in System_Extend_Pragma_Ary.
831 Subunits_Missing : Boolean := False;
833 -- This flag is set true if missing subunits are detected with code
834 -- generation active. This causes code generation to be skipped.
836 Suppress_Checks : Boolean := False;
838 -- Set to True if -gnatp (suppress all checks) switch present.
840 Suppress_Options : Suppress_Array;
842 -- Flags set True to suppress corresponding check, i.e. add an implicit
843 -- pragma Suppress at the outer level of each unit compiled. Note that
844 -- these suppress actions can be overridden by the use of the Unsuppress
845 -- pragma. This variable is initialized by Osint.Initialize.
847 Suppress_Back_Annotation : Boolean := False;
849 -- This flag is set True if back annotation of representation information
850 -- is to be suppressed. This is set if neither -gnatt or -gnatR0-3 is set.
851 -- This avoids unnecessary time being spent on back annotation.
853 Table_Factor : Int := 1;
855 -- Factor by which all initial table sizes set in Alloc are multiplied.
856 -- Used in Table to calculate initial table sizes (the initial table
857 -- size is the value in Alloc, used as the Table_Initial parameter
858 -- value, multiplied by the factor given here. The default value is
859 -- used if no -gnatT switch appears.
861 Task_Dispatching_Policy : Character := ' ';
863 -- Set to ' ' for the default case (no task dispatching policy specified).
864 -- Reset to first character (uppercase) of task dispatching policy name
865 -- if a valid Task_Dispatching_Policy pragma is encountered.
867 Task_Dispatching_Policy_Sloc : Source_Ptr := No_Location;
869 -- Remember location of previous Task_Dispatching_Policy pragma. This is
870 -- used for inconsistency error messages. A value of System_Location is
871 -- used if the policy is set in package System.
873 Tasking_Used : Boolean := False;
874 -- Set True if any tasking construct is encountered. Used to activate the
875 -- output of the Q, L and T lines in ALI files.
877 Time_Slice_Set : Boolean := False;
879 -- Set True if a pragma Time_Slice is processed in the main unit, or
880 -- if the -gnatTnn switch is present to set a time slice value.
882 Time_Slice_Value : Nat;
884 -- Time slice value. Valid only if Time_Slice_Set is True, i.e. if a
885 -- Time_Slice pragma has been processed. Set to the time slice value
886 -- in microseconds. Negative values are stored as zero, and the value
887 -- is not larger than 1_000_000_000 (1000 seconds). Values larger than
888 -- this are reset to this maximum. This can also be set with the -gnatTnn
891 Tolerate_Consistency_Errors : Boolean := False;
893 -- Tolerate time stamp and other consistency errors. If this flag is
894 -- set to True (-t), then inconsistencies result in warnings rather than
897 Tree_Output : Boolean := False;
899 -- Set to True (-gnatt) to generate output tree file
901 Try_Semantics : Boolean := False;
903 -- Flag set to force attempt at semantic analysis, even if parser errors
904 -- occur. This will probably cause blowups at this stage in the game. On
905 -- the other hand, most such blowups will be caught cleanly and simply
906 -- say compilation abandoned. This flag is set to True by -gnatq or -gnatQ.
908 Undefined_Symbols_Are_False : Boolean := False;
910 -- Set to True by switch -u of gnatprep or -u in the preprocessing data
911 -- file for the compiler. Indicates that while preprocessing sources,
912 -- symbols that are not defined have the value FALSE.
914 Unique_Error_Tag : Boolean := Tag_Errors;
916 -- Indicates if error messages are to be prefixed by the string error:
917 -- Initialized from Tag_Errors, can be forced on with the -gnatU switch.
919 Universal_Addressing_On_AAMP : Boolean := False;
921 -- Indicates if library-level objects should be accessed and updated
922 -- using universal addressing instructions on the AAMP architecture.
923 -- This flag is set to True when pragma Universal_Data is given as
924 -- a configuration pragma.
926 Unreserve_All_Interrupts : Boolean := False;
928 -- Normally set False, set True if a valid Unreserve_All_Interrupts
929 -- pragma appears anywhere in the main unit for GNAT, or if any ALI
930 -- file has the corresponding attribute set in GNATBIND.
932 Upper_Half_Encoding : Boolean := False;
934 -- Normally set False, indicating that upper half ASCII characters are
935 -- used in the normal way to represent themselves. If the wide character
936 -- encoding method uses the upper bit for this encoding, then this flag
937 -- is set True, and upper half characters in the source indicate the
938 -- start of a wide character sequence.
940 Usage_Requested : Boolean := False;
941 -- GNAT, GNATBIND, GNATMAKE
942 -- Set to True if -h (-gnath for the compiler) switch encountered
943 -- requesting usage information
945 Use_VADS_Size : Boolean := False;
947 -- Set to True if a valid pragma Use_VADS_Size is processed
949 Validity_Checks_On : Boolean := True;
951 -- This flag determines if validity checking is on or off. The initial
952 -- state is on, and the required default validity checks are active. The
953 -- actual set of checks that is performed if Validity_Checks_On is set
954 -- is defined by the switches in package Sem_Val. The Validity_Checks_On
955 -- flag is controlled by pragma Validity_Checks (On | Off), and also
956 -- some generated compiler code (typically code that has to do with
957 -- validity check generation) is compiled with this flag set to False.
958 -- This flag is set to False by the -gnatp switch.
960 Verbose_Mode : Boolean := False;
961 -- GNAT, GNATBIND, GNATMAKE, GNATLINK, GNATLS, GNATCHOP, GNATNAME,
963 -- Set to True to get verbose mode (full error message text and location
964 -- information sent to standard output, also header, copyright and summary)
966 Warn_On_Constant : Boolean := False;
968 -- Set to True to generate warnings for variables that could be declared
969 -- as constants. Modified by use of -gnatwk/K.
971 Warn_On_Dereference : Boolean := False;
973 -- Set to True to generate warnings for implicit dereferences for array
974 -- indexing and record component access. Modified by use of -gnatwd/D.
976 Warn_On_Export_Import : Boolean := True;
978 -- Set to True to generate warnings for suspicious use of export or
979 -- import pragmas. Modified by use of -gnatwx/X.
981 Warn_On_Hiding : Boolean := False;
983 -- Set to True to generate warnings if a declared entity hides another
984 -- entity. The default is that this warning is suppressed.
986 Warn_On_Modified_Unread : Boolean := False;
988 -- Set to True to generate warnings if a variable is assigned but is
989 -- never read. The default is that this warning is suppressed.
991 Warn_On_No_Value_Assigned : Boolean := True;
993 -- Set to True to generate warnings if no value is ever assigned to a
994 -- variable that is at least partially uninitialized. Set to false to
995 -- suppress such warnings. The default is that such warnings are enabled.
997 Warn_On_Obsolescent_Feature : Boolean := False;
999 -- Set to True to generate warnings on use of any feature in Annex J
1000 -- or if a subprogram is called for which a pragma Obsolescent applies.
1002 Warn_On_Redundant_Constructs : Boolean := False;
1004 -- Set to True to generate warnings for redundant constructs (e.g. useless
1005 -- assignments/conversions). The default is that this warning is disabled.
1007 Warn_On_Unchecked_Conversion : Boolean := True;
1009 -- Set to True to generate warnings for unchecked conversions that may have
1010 -- non-portable semantics (e.g. because sizes of types differ). The default
1011 -- is that this warning is enabled.
1013 Warn_On_Unrecognized_Pragma : Boolean := True;
1015 -- Set to True to generate warnings for unrecognized pragmas. The default
1016 -- is that this warning is enabled.
1018 type Warning_Mode_Type is (Suppress, Normal, Treat_As_Error);
1019 Warning_Mode : Warning_Mode_Type := Normal;
1021 -- Controls treatment of warning messages. If set to Suppress, warning
1022 -- messages are not generated at all. In Normal mode, they are generated
1023 -- but do not count as errors. In Treat_As_Error mode, warning messages
1024 -- are generated and are treated as errors.
1026 Wide_Character_Encoding_Method : WC_Encoding_Method := WCEM_Brackets;
1028 -- Method used for encoding wide characters in the source program. See
1029 -- description of type in unit System.WCh_Con for a list of the methods
1030 -- that are currently supported. Note that brackets notation is always
1031 -- recognized in source programs regardless of the setting of this
1032 -- variable. The default setting causes only the brackets notation
1033 -- to be recognized. If this is the main unit, this setting also
1034 -- controls the output of the W=? parameter in the ALI file, which
1035 -- is used to provide the default for Wide_Text_IO files.
1037 Xref_Active : Boolean := True;
1039 -- Set if cross-referencing is enabled (i.e. xref info in ALI files)
1041 Zero_Cost_Exceptions_Val : Boolean;
1042 Zero_Cost_Exceptions_Set : Boolean := False;
1044 -- These values are to record the setting of the zero cost exception
1045 -- handling mode set by argument switches (-gnatZ/-gnatL). If the
1046 -- value is set by one of these switches, then Zero_Cost_Exceptions_Set
1047 -- is set to True, and Zero_Cost_Exceptions_Val indicates the setting.
1049 ----------------------------
1050 -- Configuration Settings --
1051 ----------------------------
1053 -- These are settings that are used to establish the mode at the start
1054 -- of each unit. The values defined below can be affected either by
1055 -- command line switches, or by the use of appropriate configuration
1056 -- pragmas in the gnat.adc file.
1058 Ada_83_Config : Boolean;
1060 -- This is the value of the configuration switch for Ada 83 mode, as set
1061 -- by the command line switch -gnat83, and possibly modified by the use
1062 -- of configuration pragmas Ada_95 and Ada_83 in the gnat.adc file. This
1063 -- switch is used to set the initial value for Ada_83 mode at the start
1064 -- of analysis of a unit. Note however, that the setting of this flag
1065 -- is ignored for internal and predefined units (which are always compiled
1068 Dynamic_Elaboration_Checks_Config : Boolean := False;
1070 -- Set True for dynamic elaboration checking mode, as set by the -gnatE
1071 -- switch or by the use of pragma Elaboration_Checking (Dynamic).
1073 Exception_Locations_Suppressed_Config : Boolean := False;
1075 -- Set True by use of the configuration pragma Suppress_Exception_Messages
1077 Extensions_Allowed_Config : Boolean;
1079 -- This is the flag that indicates whether extensions are allowed.
1080 -- It can be set True either by use of the -gnatX switch, or by use
1081 -- of the configuration pragma Extensions_Allowed (On). It is always
1082 -- set to True for internal GNAT units, since extensions are always
1083 -- permitted in such units.
1085 External_Name_Exp_Casing_Config : External_Casing_Type;
1087 -- This is the value of the configuration switch that controls casing
1088 -- of external symbols for which an explicit external name is given. It
1089 -- can be set to Uppercase by the command line switch -gnatF, and further
1090 -- modified by the use of the configuration pragma External_Name_Casing
1091 -- in the gnat.adc file. This flag is used to set the initial value
1092 -- for External_Name_Exp_Casing at the start of analyzing each unit.
1093 -- Note however that the setting of this flag is ignored for internal
1094 -- and predefined units (which are always compiled with As_Is mode).
1096 External_Name_Imp_Casing_Config : External_Casing_Type;
1098 -- This is the value of the configuration switch that controls casing
1099 -- of external symbols where the external name is implicitly given. It
1100 -- can be set to Uppercase by the command line switch -gnatF, and further
1101 -- modified by the use of the configuration pragma External_Name_Casing
1102 -- in the gnat.adc file. This flag is used to set the initial value
1103 -- for External_Name_Imp_Casing at the start of analyzing each unit.
1104 -- Note however that the setting of this flag is ignored for internal
1105 -- and predefined units (which are always compiled with Lowercase mode).
1107 Polling_Required_Config : Boolean;
1109 -- This is the value of the configuration switch that controls polling
1110 -- mode. It can be set True by the command line switch -gnatP, and then
1111 -- further modified by the use of pragma Polling in the gnat.adc file.
1112 -- This flag is used to set the initial value for Polling_Required
1113 -- at the start of analyzing each unit.
1115 Use_VADS_Size_Config : Boolean;
1117 -- This is the value of the configuration switch that controls the use
1118 -- of VADS_Size instead of Size whereever the attribute Size is used.
1119 -- It can be set True by the use of the pragma Use_VADS_Size in the
1120 -- gnat.adc file. This flag is used to set the initial value for
1121 -- Use_VADS_Size at the start of analyzing each unit. Note however that
1122 -- the setting of this flag is ignored for internal and predefined
1123 -- units (which are always compiled with the standard Size semantics).
1125 type Config_Switches_Type is private;
1126 -- Type used to save values of the switches set from Config values
1128 procedure Save_Opt_Config_Switches (Save : out Config_Switches_Type);
1129 -- This procedure saves the current values of the switches which are
1130 -- initialized from the above Config values, and then resets these
1131 -- switches according to the Config value settings.
1133 procedure Set_Opt_Config_Switches (Internal_Unit : Boolean);
1134 -- This procedure sets the switches to the appropriate initial values.
1135 -- The parameter Internal_Unit is True for an internal or predefined
1136 -- unit, and affects the way the switches are set (see above).
1138 procedure Restore_Opt_Config_Switches (Save : Config_Switches_Type);
1139 -- This procedure restores a set of switch values previously saved
1140 -- by a call to Save_Opt_Switches.
1142 procedure Register_Opt_Config_Switches;
1143 -- This procedure is called after processing the gnat.adc file to record
1144 -- the values of the Config switches, as possibly modified by the use
1145 -- of command line switches and configuration pragmas.
1147 ------------------------
1148 -- Other Global Flags --
1149 ------------------------
1151 Expander_Active : Boolean := False;
1152 -- A flag that indicates if expansion is active (True) or deactivated
1153 -- (False). When expansion is deactivated all calls to expander routines
1154 -- have no effect. Note that the initial setting of False is merely to
1155 -- prevent saving of an undefined value for an initial call to the
1156 -- Expander_Mode_Save_And_Set procedure. For more information on the
1157 -- use of this flag, see package Expander. Indeed this flag might more
1158 -- logically be in the spec of Expander, but it is referenced by Errout,
1159 -- and it really seems wrong for Errout to depend on Expander.
1161 -----------------------
1162 -- Tree I/O Routines --
1163 -----------------------
1165 procedure Tree_Read;
1166 -- Reads switch settings from current tree file using Tree_Read
1168 procedure Tree_Write;
1169 -- Writes out switch settings to current tree file using Tree_Write
1171 --------------------------
1172 -- ASIS Version Control --
1173 --------------------------
1175 -- These two variables (Tree_Version_String and Tree_ASIS_Version_Number)
1176 -- are supposed to be used in the GNAT/ASIS version check performed in
1177 -- the ASIS code (this package is also a part of the ASIS implementation).
1178 -- They are set by Tree_Read procedure, so they represent the version
1179 -- number (and the version string) of the compiler which has created the
1180 -- tree, and they are supposed to be compared with the corresponding values
1181 -- from the Gnatvsn package which is a part of ASIS implementation.
1183 Tree_Version_String : String (Gnat_Version_String'Range);
1184 -- Used to store the compiler version string read from a tree file to
1185 -- check if it is the same as stored in the version string in Gnatvsn.
1186 -- Therefore its length is taken directly from the version string in
1187 -- Gnatvsn. If the length of the version string stored in the tree is
1188 -- different, then versions are for sure different, and a string containing
1189 -- '?' characters is assigned to this variable as a result of tree read.
1191 Tree_ASIS_Version_Number : Int;
1192 -- Used to store the ASIS version number read from a tree file to check if
1193 -- it is the same as stored in the ASIS version number in Gnatvsn.
1197 type Config_Switches_Type is record
1199 Dynamic_Elaboration_Checks : Boolean;
1200 Exception_Locations_Suppressed : Boolean;
1201 Extensions_Allowed : Boolean;
1202 External_Name_Exp_Casing : External_Casing_Type;
1203 External_Name_Imp_Casing : External_Casing_Type;
1204 Polling_Required : Boolean;
1205 Use_VADS_Size : Boolean;