1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
11 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
13 -- GNAT is free software; you can redistribute it and/or modify it under --
14 -- terms of the GNU General Public License as published by the Free Soft- --
15 -- ware Foundation; either version 2, or (at your option) any later ver- --
16 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
19 -- for more details. You should have received a copy of the GNU General --
20 -- Public License distributed with GNAT; see file COPYING. If not, write --
21 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
22 -- MA 02111-1307, USA. --
24 -- As a special exception, if other files instantiate generics from this --
25 -- unit, or you link this unit with other files to produce an executable, --
26 -- this unit does not by itself cause the resulting executable to be --
27 -- covered by the GNU General Public License. This exception does not --
28 -- however invalidate any other reasons why the executable file might be --
29 -- covered by the GNU Public License. --
31 -- GNAT was originally developed by the GNAT team at New York University. --
32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
34 ------------------------------------------------------------------------------
36 -- This package contains routines for accessing and outputting the library
37 -- information. It contains the routine to load subsidiary units.
41 with Types; use Types;
45 --------------------------------------------
46 -- General Approach to Library Management --
47 --------------------------------------------
49 -- As described in GNote #1, when a unit is compiled, all its subsidiary
50 -- units are recompiled, including the following:
52 -- (a) Corresponding spec for a body
53 -- (b) Parent spec of a child library spec
55 -- (d) Parent body of a subunit
56 -- (e) Subunits corresponding to any specified stubs
57 -- (f) Bodies of inlined subprograms that are called
58 -- (g) Bodies of generic subprograms or packages that are instantiated
59 -- (h) Bodies of packages containing either of the above two items
60 -- (i) Specs and bodies of runtime units
61 -- (j) Parent specs for with'ed child library units
63 -- If a unit is being compiled only for syntax checking, then no subsidiary
64 -- units are loaded, the syntax check applies only to the main unit,
65 -- i.e. the one contained in the source submitted to the library.
67 -- If a unit is being compiled for syntax and semantic checking, then only
68 -- cases (a)-(d) loads are performed, since the full semantic checking can
69 -- be carried out without needing (e)-(i) loads. In this case no object
70 -- file, or library information file, is generated, so the missing units
71 -- do not affect the results.
73 -- Specifications of library subprograms, subunits, and generic specs
74 -- and bodies, can only be compiled in syntax/semantic checking mode,
75 -- since no code is ever generated directly for these units. In the case
76 -- of subunits, only the compilation of the ultimate parent unit generates
77 -- actual code. If a subunit is submitted to the compiler in syntax/
78 -- semantic checking mode, the parent (or parents in the nested case) are
79 -- semantically checked only up to the point of the corresponding stub.
81 -- If code is being generated, then all the above units are required,
82 -- although the need for bodies of inlined procedures can be suppressed
83 -- by the use of a switch that sets the mode to ignore pragma Inline
86 -- The two main sections of the front end, Par and Sem, are recursive.
87 -- Compilation proceeds unit by unit making recursive calls as necessary.
88 -- The process is controlled from the GNAT main program, which makes calls
89 -- to Par and Sem sequence for the main unit.
91 -- Par parses the given unit, and then, after the parse is complete, uses
92 -- the Par.Load subprogram to load all its subsidiary units in categories
93 -- (a)-(d) above, installing pointers to the loaded units in the parse
94 -- tree, as described in a later section of this spec. If any of these
95 -- required units is missing, a fatal error is signalled, so that no
96 -- attempt is made to run Sem in such cases, since it is assumed that
97 -- too many cascaded errors would result, and the confusion would not
100 -- Following the call to Par on the main unit, the entire tree of required
101 -- units is thus loaded, and Sem is called on the main unit. The parameter
102 -- passed to Sem is the unit to be analyzed. The visibility table, which
103 -- is a single global structure, starts out containing only the entries
104 -- for the visible entities in Standard. Every call to Sem establishes a
105 -- new scope stack table, pushing an entry for Standard on entry to provide
106 -- the proper initial scope environment.
108 -- Sem first proceeds to perform semantic analysis on the currently loaded
111 -- In the case of a body (case (a) above), Sem analyzes the corresponding
112 -- spec, using a recursive call to Sem. As is always expected to be the
113 -- case with calls to Sem, any entities installed in the visibility table
114 -- are removed on exit from Sem, so that these entities have to be
115 -- reinstalled on return to continue the analysis of the body which of
116 -- course needs visibility of these entities.
118 -- In the case of the parent of a child spec (case (b) above), a similar
119 -- call is made to Sem to analyze the parent. Again, on return, the
120 -- entities from the analyzed parent spec have to be installed in the
121 -- visibility table of the caller (the child unit), which must have
122 -- visibility to the entities in its parent spec.
124 -- For with'ed specs (case (c) above), a recursive call to Sem is made
125 -- to analyze each spec in turn. After all the spec's have been analyzed,
126 -- but not till that point, the entities from all the with'ed units are
127 -- reinstalled in the visibility table so that the caller can proceed
128 -- with the analysis of the unit doing the with's with the necessary
129 -- entities made either potentially use visible or visible by selection
132 -- Case (d) arises when Sem is passed a subunit to analyze. This means
133 -- that the main unit is a subunit, and the unit passed to Sem is either
134 -- the main unit, or one of its ancestors that is still a subunit. Since
135 -- analysis must start at the top of the tree, Sem essentially cancels
136 -- the current call by immediately making a call to analyze the parent
137 -- (when this call is finished it immediately returns, so logically this
138 -- call is like a goto). The subunit will then be analyzed at the proper
139 -- time as described for the stub case. Note that we also turn off the
140 -- indication that code should be generated in this case, since the only
141 -- time we generate code for subunits is when compiling the main parent.
143 -- Case (e), subunits corresponding to stubs, are handled as the stubs
144 -- are encountered. There are three sub-cases:
146 -- If the subunit has already been loaded, then this means that the
147 -- main unit was a subunit, and we are back on our way down to it
148 -- after following the initial processing described for case (d).
149 -- In this case we analyze this particular subunit, as described
150 -- for the case where we are generating code, but when we get back
151 -- we are all done, since the rest of the parent is irrelevant. To
152 -- get out of the parent, we raise the exception Subunit_Found, which
153 -- is handled at the outer level of Sem.
155 -- The cases where the subunit has not already been loaded correspond
156 -- to cases where the main unit was a parent. In this case the action
157 -- depends on whether or not we are generating code. If we are not
158 -- generating code, then this is the case where we can simply ignore
159 -- the subunit, since in checking mode we don't even want to insist
160 -- that the subunit exist, much less waste time checking it.
162 -- If we are generating code, then we need to load and analyze
163 -- all subunits. This is achieved with a call to Lib.Load to load
164 -- and parse the unit, followed by processing that installs the
165 -- context clause of the subunit, analyzes the subunit, and then
166 -- removes the context clause (from the visibility chains of the
167 -- parent). Note that we do *not* do a recursive call to Sem in
168 -- this case, precisely because we need to do the analysis of the
169 -- subunit with the current visibility table and scope stack.
171 -- Case (f) applies only to subprograms for which a pragma Inline is
172 -- given, providing that the compiler is operating in the mode where
173 -- pragma Inline's are activated. When the expander encounters a call
174 -- to such a subprogram, it loads the body of the subprogram if it has
175 -- not already been loaded, and calls Sem to process it.
177 -- Case (g) is similar to case (f), except that the body of a generic
178 -- is unconditionally required, regardless of compiler mode settings.
179 -- As in the subprogram case, when the expander encounters a generic
180 -- instantiation, it loads the generic body of the subprogram if it
181 -- has not already been loaded, and calls Sem to process it.
183 -- Case (h) arises when a package contains either an inlined subprogram
184 -- which is called, or a generic which is instantiated. In this case the
185 -- body of the package must be loaded and analyzed with a call to Sem.
187 -- Case (i) is handled by adding implicit with clauses to the context
188 -- clauses of all units that potentially reference the relevant runtime
189 -- entities. Note that since we have the full set of units available,
190 -- the parser can always determine the set of runtime units that is
191 -- needed. These with clauses do not have associated use clauses, so
192 -- all references to the entities must be by selection. Once the with
193 -- clauses have been added, subsequent processing is as for normal
196 -- Case (j) is also handled by adding appropriate implicit with clauses
197 -- to any unit that withs a child unit. Again there is no use clause,
198 -- and subsequent processing proceeds as for an explicit with clause.
200 -- Sem thus completes the loading of all required units, except those
201 -- required for inline subprogram bodies or inlined generics. If any
202 -- of these load attempts fails, then the expander will not be called,
203 -- even if code was to be generated. If the load attempts all succeed
204 -- then the expander is called, though the attempt to generate code may
205 -- still fail if an error occurs during a load attempt for an inlined
206 -- body or a generic body.
208 -------------------------------------------
209 -- Special Handling of Subprogram Bodies --
210 -------------------------------------------
212 -- A subprogram body (in an adb file) may stand for both a spec and a
213 -- body. A simple model (and one that was adopted through version 2.07),
214 -- is simply to assume that such an adb file acts as its own spec if no
215 -- ads file is present.
217 -- However, this is not correct. RM 10.1.4(4) requires that such a body
218 -- act as a spec unless a subprogram declaration of the same name is
219 -- already present. The correct interpretation of this in GNAT library
220 -- terms is to ignore an existing ads file of the same name unless this
221 -- ads file contains a subprogram declaration with the same name.
223 -- If there is an ads file with a unit other than a subprogram declaration
224 -- with the same name, then a fatal message is output, noting that this
225 -- irrelevant file must be deleted before the body can be compiled. See
226 -- ACVC test CA1020D to see how this processing is required.
232 Current_Sem_Unit : Unit_Number_Type := Main_Unit;
233 -- Unit number of unit currently being analyzed/expanded. This is set when
234 -- ever a new unit is entered, saving and restoring the old value, so that
235 -- it always reflects the unit currently being analyzed. The initial value
236 -- of Main_Unit ensures that a proper value is set initially, and in
237 -- particular for analysis of configuration pragmas in gnat.adc.
239 Main_Unit_Entity : Entity_Id;
240 -- Entity of main unit, same as Cunit_Entity (Main_Unit) except where
241 -- Main_Unit is a body with a separate spec, in which case it is the
242 -- entity for the spec.
244 Unit_Exception_Table_Present : Boolean;
245 -- Set true if a unit exception table is present for the unit (i.e.
246 -- zero cost exception handling is active and there is at least one
247 -- subprogram in the extended unit).
253 -- The units table has an entry for each unit (source file) read in by the
254 -- current compilation. The table is indexed by the unit number value,
255 -- The first entry in the table, subscript Main_Unit, is for the main file.
256 -- Each entry in this units table contains the following data.
259 -- The name of the source file containing the unit. Set when the entry
260 -- is created by a call to Lib.Load, and then cannot be changed.
263 -- The index in the source file table of the corresponding source file.
264 -- Set when the entry is created by a call to Lib.Load and then cannot
268 -- This is copied from the Sloc field of the Enode argument passed
269 -- to Load_Unit. It refers to the enclosing construct which caused
270 -- this unit to be loaded, e.g. most typically the with clause that
271 -- referenced the unit, and is used for error handling in Par.Load.
274 -- This is the expected unit name for a file other than the main unit,
275 -- since these are cases where we load the unit using Lib.Load and we
276 -- know the unit that is expected. It must be the same as Unit_Name
277 -- if it is set (see test in Par.Load). Expected_Unit is set to
278 -- No_Name for the main unit.
281 -- The name of the unit. Initialized to No_Name by Lib.Load, and then
282 -- set by the parser when the unit is parsed to the unit name actually
283 -- found in the file (which should, in the absence of errors) be the
284 -- same name as Expected_Unit.
287 -- Pointer to the N_Compilation_Unit node. Initially set to Empty by
288 -- Lib.Load, and then reset to the required node by the parser when
289 -- the unit is parsed.
292 -- Pointer to the entity node for the compilation unit. Initially set
293 -- to Empty by Lib.Load, and then reset to the required entity by the
294 -- parser when the unit is parsed.
297 -- This is the number of the unit within the generated dependency
298 -- lines (D lines in the ALI file) which are sorted into alphabetical
299 -- order. The number is ones origin, so a value of 2 refers to the
300 -- second generated D line. The Dependency_Number values are set
301 -- as the D lines are generated, and are used to generate proper
302 -- unit references in the generated xref information.
305 -- A flag indicating if this unit was compiled with dynamic elaboration
306 -- checks specified (as the result of using the -gnatE compilation
307 -- option or a pragma Elaboration_Checks (Dynamic).
310 -- A flag that is initialized to False, and gets set to True if a fatal
311 -- error occurs during the processing of a unit. A fatal error is one
312 -- defined as serious enough to stop the next phase of the compiler
313 -- from running (i.e. fatal error during parsing stops semantics,
314 -- fatal error during semantics stops code generation). Note that
315 -- currently, errors of any kind cause Fatal_Error to be set, but
316 -- eventually perhaps only errors labeled as Fatal_Errors should be
317 -- this severe if we decide to try Sem on sources with minor errors.
320 -- This flag is set True for all units in the current file for which
321 -- code is to be generated. This includes the unit explicitly compiled,
322 -- together with its specification, and any subunits.
325 -- A Boolean flag, initially set to False when a unit entry is created,
326 -- and set to True if the unit defines a remote access to class wide
327 -- (RACW) object. This is used for controlling generation of the RA
328 -- attribute in the ali file.
331 -- N_String_Literal node from a valid pragma Ident that applies to
332 -- this unit. If no Ident pragma applies to the unit, then Empty.
335 -- A flag that is used to catch circular WITH dependencies. It is set
336 -- True when an entry is initially created in the file table, and set
337 -- False when the load is completed, or ends with an error.
340 -- This field is used to indicate the priority of a possible main
341 -- program, as set by a pragma Priority. A value of -1 indicates
342 -- that the default priority is to be used (and is also used for
343 -- entries that do not correspond to possible main programs).
346 -- This field holds a serial number used by New_Internal_Name to
347 -- generate unique temporary numbers on a unit by unit basis. The
348 -- only access to this field is via the Increment_Serial_Number
349 -- routine which increments the current value and returns it. This
350 -- serial number is separate for each unit.
353 -- This field holds the version of the unit, which is computed as
354 -- the exclusive or of the checksums of this unit, and all its
355 -- semantically dependent units. Access to the version number field
356 -- is not direct, but is done through the routines described below.
357 -- When a unit table entry is created, this field is initialized to
358 -- the checksum of the corresponding source file. Version_Update is
359 -- then called to reflect the contributions of any unit on which this
360 -- unit is semantically dependent.
363 -- This is a Boolean flag, which is set True to indicate that this
364 -- entry is for a semantically dependent unit. This flag is nearly
365 -- always set True, the only exception is for a unit that is loaded
366 -- by an Rtsfind request in No_Run_Time mode, where the entity that
367 -- is obtained by Rtsfind.RTE is for an inlined subprogram or other
368 -- entity for which a dependency need not be created.
370 -- The units table is reset to empty at the start of the compilation of
371 -- each main unit by Lib.Initialize. Entries are then added by calls to
372 -- the Lib.Load procedure. The following subprograms are used to access
373 -- and modify entries in the Units table. Individual entries are accessed
374 -- using a unit number value which ranges from Main_Unit (the first entry,
375 -- which is always for the current main unit) to Last_Unit.
377 Default_Main_Priority : constant Int := -1;
378 -- Value used in Main_Priority field to indicate default main priority
380 function Cunit (U : Unit_Number_Type) return Node_Id;
381 function Cunit_Entity (U : Unit_Number_Type) return Entity_Id;
382 function Dependent_Unit (U : Unit_Number_Type) return Boolean;
383 function Dependency_Num (U : Unit_Number_Type) return Nat;
384 function Dynamic_Elab (U : Unit_Number_Type) return Boolean;
385 function Error_Location (U : Unit_Number_Type) return Source_Ptr;
386 function Expected_Unit (U : Unit_Number_Type) return Unit_Name_Type;
387 function Fatal_Error (U : Unit_Number_Type) return Boolean;
388 function Generate_Code (U : Unit_Number_Type) return Boolean;
389 function Ident_String (U : Unit_Number_Type) return Node_Id;
390 function Has_RACW (U : Unit_Number_Type) return Boolean;
391 function Loading (U : Unit_Number_Type) return Boolean;
392 function Main_Priority (U : Unit_Number_Type) return Int;
393 function Source_Index (U : Unit_Number_Type) return Source_File_Index;
394 function Unit_File_Name (U : Unit_Number_Type) return File_Name_Type;
395 function Unit_Name (U : Unit_Number_Type) return Unit_Name_Type;
396 -- Get value of named field from given units table entry
398 procedure Set_Cunit (U : Unit_Number_Type; N : Node_Id);
399 procedure Set_Cunit_Entity (U : Unit_Number_Type; E : Entity_Id);
400 procedure Set_Dynamic_Elab (U : Unit_Number_Type; B : Boolean := True);
401 procedure Set_Error_Location (U : Unit_Number_Type; W : Source_Ptr);
402 procedure Set_Fatal_Error (U : Unit_Number_Type; B : Boolean := True);
403 procedure Set_Generate_Code (U : Unit_Number_Type; B : Boolean := True);
404 procedure Set_Has_RACW (U : Unit_Number_Type; B : Boolean := True);
405 procedure Set_Ident_String (U : Unit_Number_Type; N : Node_Id);
406 procedure Set_Loading (U : Unit_Number_Type; B : Boolean := True);
407 procedure Set_Main_Priority (U : Unit_Number_Type; P : Int);
408 procedure Set_Unit_Name (U : Unit_Number_Type; N : Unit_Name_Type);
409 -- Set value of named field for given units table entry. Note that we
410 -- do not have an entry for each possible field, since some of the fields
411 -- can only be set by specialized interfaces (defined below).
413 function Version_Get (U : Unit_Number_Type) return Word_Hex_String;
414 -- Returns the version as a string with 8 hex digits (upper case letters)
416 function Last_Unit return Unit_Number_Type;
417 -- Unit number of last allocated unit
419 function Num_Units return Nat;
420 -- Number of units currently in unit table
422 function Entity_Is_In_Main_Unit (E : Entity_Id) return Boolean;
423 -- Returns True if the entity E is declared in the main unit, or, in
424 -- its corresponding spec, or one of its subunits. Entities declared
425 -- within generic instantiations return True if the instantiation is
426 -- itself "in the main unit" by this definition. Otherwise False.
428 function Get_Source_Unit (N : Node_Id) return Unit_Number_Type;
429 pragma Inline (Get_Source_Unit);
430 function Get_Source_Unit (S : Source_Ptr) return Unit_Number_Type;
431 -- Return unit number of file identified by given source pointer value.
432 -- This call must always succeed, since any valid source pointer value
433 -- belongs to some previously loaded module. If the given source pointer
434 -- value is within an instantiation, this function returns the unit
435 -- number of the templace, i.e. the unit containing the source code
436 -- corresponding to the given Source_Ptr value. The version taking
437 -- a Node_Id argument, N, simply applies the function to Sloc (N).
439 function Get_Code_Unit (N : Node_Id) return Unit_Number_Type;
440 pragma Inline (Get_Code_Unit);
441 function Get_Code_Unit (S : Source_Ptr) return Unit_Number_Type;
442 -- This is like Get_Source_Unit, except that in the instantiation case,
443 -- it uses the location of the top level instantiation, rather than the
444 -- template, so it returns the unit number containing the code that
445 -- corresponds to the node N, or the source location S.
447 function In_Same_Source_Unit (N1, N2 : Node_Or_Entity_Id) return Boolean;
448 pragma Inline (In_Same_Source_Unit);
449 -- Determines if the two nodes or entities N1 and N2 are in the same
450 -- source unit, the criterion being that Get_Source_Unit yields the
451 -- same value for each argument.
453 function In_Same_Code_Unit (N1, N2 : Node_Or_Entity_Id) return Boolean;
454 pragma Inline (In_Same_Source_Unit);
455 -- Determines if the two nodes or entities N1 and N2 are in the same
456 -- code unit, the criterion being that Get_Code_Unit yields the same
457 -- value for each argument.
459 function In_Same_Extended_Unit (S1, S2 : Source_Ptr) return Boolean;
460 -- Determines if the two source locations S1 and S2 are in the same
461 -- extended unit, where an extended unit is defined as a unit and all
462 -- its subunits (considered recursively, i.e. subunits or subunits are
463 -- included). Returns true if S1 and S2 are in the same extended unit
464 -- and False otherwise.
466 function In_Extended_Main_Code_Unit (N : Node_Id) return Boolean;
467 -- Return True if the node is in the generated code of the extended main
468 -- unit, defined as the main unit, its specification (if any), and all
469 -- its subunits (considered recursively). Units for which this enquiry
470 -- returns True are those for which code will be generated. Nodes from
471 -- instantiations are included in the extended main unit for this call.
472 -- If the main unit is itself a subunit, then the extended main unit
473 -- includes its parent unit, and the parent unit spec if it is separate.
475 function In_Extended_Main_Source_Unit (N : Node_Id) return Boolean;
476 -- Return True if the node is in the source text of the extended main
477 -- unit, defined as the main unit, its specification (if any), and all
478 -- its subunits (considered recursively). Units for which this enquiry
479 -- returns True are those for which code will be generated. This differs
480 -- from In_Extended_Main_Code_Unit only in that instantiations are not
481 -- included for the purposes of this call. If the main unit is itself
482 -- a subunit, then the extended main unit includes its parent unit,
483 -- and the parent unit spec if it is separate.
485 function Earlier_In_Extended_Unit (S1, S2 : Source_Ptr) return Boolean;
486 -- Given two Sloc values for which In_Same_Extended_Unit is true,
487 -- determine if S1 appears before S2. Returns True if S1 appears before
488 -- S2, and False otherwise. The result is undefined if S1 and S2 are
489 -- not in the same extended unit.
491 function Get_Compilation_Switch (N : Pos) return String_Ptr;
492 -- Return the Nth stored compilation switch, or null if less than N
493 -- switches have been stored. Used by ASIS.
495 function Get_Cunit_Unit_Number (N : Node_Id) return Unit_Number_Type;
496 -- Return unit number of the unit whose N_Compilation_Unit node is the
497 -- one passed as an argument. This must always succeed since the node
498 -- could not have been built without making a unit table entry.
500 function Get_Cunit_Entity_Unit_Number
502 return Unit_Number_Type;
503 -- Return unit number of the unit whose compilation unit spec entity is
504 -- the one passed as an argument. This must always succeed since the
505 -- entity could not have been built without making a unit table entry.
507 function Increment_Serial_Number return Nat;
508 -- Increment Serial_Number field for current unit, and return the
509 -- incremented value.
511 procedure Replace_Linker_Option_String
512 (S : String_Id; Match_String : String);
513 -- Replace an existing Linker_Option if the prefix Match_String
514 -- matches, otherwise call Store_Linker_Option_String.
516 procedure Store_Compilation_Switch (Switch : String);
517 -- Called to register a compilation switch, either front-end or
518 -- back-end, which may influence the generated output file(s).
520 procedure Store_Linker_Option_String (S : String_Id);
521 -- This procedure is called to register the string from a pragma
522 -- Linker_Option. The argument is the Id of the string to register.
524 procedure Initialize;
525 -- Initialize internal tables
528 -- Lock internal tables before calling back end
530 procedure Tree_Write;
531 -- Writes out internal tables to current tree file using Tree_Write
534 -- Initializes internal tables from current tree file using Tree_Read
536 function Is_Loaded (Uname : Unit_Name_Type) return Boolean;
537 -- Determines if unit with given name is already loaded, i.e. there is
538 -- already an entry in the file table with this unit name for which the
539 -- corresponding file was found and parsed. Note that the Fatal_Error flag
540 -- of this entry must be checked before proceeding with further processing.
542 procedure Version_Referenced (S : String_Id);
543 -- This routine is called from Exp_Attr to register the use of a Version
544 -- or Body_Version attribute. The argument is the external name used to
545 -- access the version string.
547 procedure List (File_Names_Only : Boolean := False);
548 -- Lists units in active library (i.e. generates output consisting of a
549 -- sorted listing of the units represented in File table, with the
550 -- exception of the main unit). If File_Names_Only is set to True, then
551 -- the list includes only file names, and no other information. Otherwise
552 -- the unit name and time stamp are also output. File_Names_Only also
553 -- restricts the list to exclude any predefined files.
555 function Generic_Separately_Compiled (E : Entity_Id) return Boolean;
556 -- Most generic units must be separately compiled. Since we always use
557 -- macro substitution for generics, the resulting object file is a dummy
558 -- one with no code, but the ali file has the normal form, and we need
559 -- this ali file so that the binder can work out a correct order of
560 -- elaboration. However, we do not need to separate compile generics
561 -- if the generic files are language defined, since in this case there
562 -- are no order of elaborration problems, and we can simply incorporate
563 -- the context clause of the generic unit into the client. There are two
564 -- reasons for making this exception for predefined units. First, clearly
565 -- it is more efficient not to introduce extra unnecessary files. Second,
566 -- the old version of GNAT did not compile any generic units. That was
567 -- clearly incorrect in some cases of complex order of elaboration and
568 -- was fixed in version 3.10 of GNAT. However, the transition would have
569 -- caused bootstrap path problems in the case of generics used in the
570 -- compiler itself. The only such generics are predefined ones. This
571 -- function returns True if the given generic unit entity E is for a
572 -- generic unit that should be separately compiled, and false otherwise.
575 pragma Inline (Cunit);
576 pragma Inline (Cunit_Entity);
577 pragma Inline (Dependency_Num);
578 pragma Inline (Dependent_Unit);
579 pragma Inline (Fatal_Error);
580 pragma Inline (Generate_Code);
581 pragma Inline (Has_RACW);
582 pragma Inline (Increment_Serial_Number);
583 pragma Inline (Loading);
584 pragma Inline (Main_Priority);
585 pragma Inline (Set_Cunit);
586 pragma Inline (Set_Cunit_Entity);
587 pragma Inline (Set_Fatal_Error);
588 pragma Inline (Set_Generate_Code);
589 pragma Inline (Set_Has_RACW);
590 pragma Inline (Set_Loading);
591 pragma Inline (Set_Main_Priority);
592 pragma Inline (Set_Unit_Name);
593 pragma Inline (Source_Index);
594 pragma Inline (Unit_File_Name);
595 pragma Inline (Unit_Name);
597 type Unit_Record is record
598 Unit_File_Name : File_Name_Type;
599 Unit_Name : Unit_Name_Type;
600 Expected_Unit : Unit_Name_Type;
601 Source_Index : Source_File_Index;
603 Cunit_Entity : Node_Id;
604 Dependency_Num : Int;
605 Dependent_Unit : Boolean;
606 Fatal_Error : Boolean;
607 Generate_Code : Boolean;
609 Ident_String : Node_Id;
614 Dynamic_Elab : Boolean;
615 Error_Location : Source_Ptr;
618 package Units is new Table.Table (
619 Table_Component_Type => Unit_Record,
620 Table_Index_Type => Unit_Number_Type,
621 Table_Low_Bound => Main_Unit,
622 Table_Initial => Alloc.Units_Initial,
623 Table_Increment => Alloc.Units_Increment,
624 Table_Name => "Units");
626 -- The following table stores strings from pragma Linker_Option lines
628 package Linker_Option_Lines is new Table.Table (
629 Table_Component_Type => String_Id,
630 Table_Index_Type => Integer,
631 Table_Low_Bound => 1,
632 Table_Initial => Alloc.Linker_Option_Lines_Initial,
633 Table_Increment => Alloc.Linker_Option_Lines_Increment,
634 Table_Name => "Linker_Option_Lines");
636 -- The following table records the compilation switches used to compile
637 -- the main unit. The table includes only switches and excludes -quiet,
638 -- -dumpbase, and -o switches, since the latter are typically artifacts
639 -- of the gcc/gnat1 interface.
641 -- This table is set as part of the compiler argument scanning in
642 -- Back_End. It can also be reset in -gnatc mode from the data in an
643 -- existing ali file, and is read and written by the Tree_Read and
644 -- Tree_Write routines for ASIS.
646 package Compilation_Switches is new Table.Table (
647 Table_Component_Type => String_Ptr,
648 Table_Index_Type => Nat,
649 Table_Low_Bound => 1,
651 Table_Increment => 100,
652 Table_Name => "Compilation_Switches");
654 Load_Msg_Sloc : Source_Ptr;
655 -- Location for placing error messages (a token in the main source text)
656 -- This is set from Sloc (Enode) by Load only in the case where this Sloc
657 -- is in the main source file. This ensures that not found messages and
658 -- circular dependency messages reference the original with in this source.
660 type Unit_Ref_Table is array (Pos range <>) of Unit_Number_Type;
661 -- Type to hold list of indirect references to unit number table
663 -- The Load_Stack table contains a list of unit numbers (indexes into the
664 -- unit table) of units being loaded on a single dependency chain. The
665 -- First entry is the main unit. The second entry, if present is a unit
666 -- on which the first unit depends, etc. This stack is used to generate
667 -- error messages showing the dependency chain if a file is not found.
668 -- The Load function makes an entry in this table when it is called, and
669 -- removes the entry just before it returns.
671 package Load_Stack is new Table.Table (
672 Table_Component_Type => Unit_Number_Type,
673 Table_Index_Type => Nat,
674 Table_Low_Bound => 0,
675 Table_Initial => Alloc.Load_Stack_Initial,
676 Table_Increment => Alloc.Load_Stack_Increment,
677 Table_Name => "Load_Stack");
679 procedure Sort (Tbl : in out Unit_Ref_Table);
680 -- This procedure sorts the given unit reference table in order of
681 -- ascending unit names, where the ordering relation is as described
682 -- by the comparison routines provided by package Uname.
684 -- The Version_Ref table records Body_Version and Version attribute
685 -- references. The entries are simply the strings for the external
686 -- names that correspond to the referenced values.
688 package Version_Ref is new Table.Table (
689 Table_Component_Type => String_Id,
690 Table_Index_Type => Nat,
691 Table_Low_Bound => 1,
693 Table_Increment => 100,
694 Table_Name => "Version_Ref");