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 pragma Style_Checks (All_Checks);
35 -- Subprogram ordering not enforced in this unit
36 -- (because of some logical groupings).
38 with Atree; use Atree;
39 with Einfo; use Einfo;
40 with Fname; use Fname;
41 with Namet; use Namet;
42 with Namet; use Namet;
43 with Output; use Output;
44 with Sinfo; use Sinfo;
45 with Sinput; use Sinput;
46 with Stand; use Stand;
47 with Stringt; use Stringt;
48 with Tree_IO; use Tree_IO;
49 with Uname; use Uname;
53 -----------------------
54 -- Local Subprograms --
55 -----------------------
58 Yes_Before, -- S1 is in same extended unit as S2 and appears before it
59 Yes_Same, -- S1 is in same extended unit as S2, Slocs are the same
60 Yes_After, -- S1 is in same extended unit as S2, and appears after it
61 No); -- S2 is not in same extended unit as S2
63 function Check_Same_Extended_Unit (S1, S2 : Source_Ptr) return SEU_Result;
64 -- Used by In_Same_Extended_Unit and Earlier_In_Extended_Unit. Returns
65 -- value as described above.
67 --------------------------------------------
68 -- Access Functions for Unit Table Fields --
69 --------------------------------------------
71 function Cunit (U : Unit_Number_Type) return Node_Id is
73 return Units.Table (U).Cunit;
76 function Cunit_Entity (U : Unit_Number_Type) return Entity_Id is
78 return Units.Table (U).Cunit_Entity;
81 function Dependency_Num (U : Unit_Number_Type) return Nat is
83 return Units.Table (U).Dependency_Num;
86 function Dependent_Unit (U : Unit_Number_Type) return Boolean is
88 return Units.Table (U).Dependent_Unit;
91 function Dynamic_Elab (U : Unit_Number_Type) return Boolean is
93 return Units.Table (U).Dynamic_Elab;
96 function Error_Location (U : Unit_Number_Type) return Source_Ptr is
98 return Units.Table (U).Error_Location;
101 function Expected_Unit (U : Unit_Number_Type) return Unit_Name_Type is
103 return Units.Table (U).Expected_Unit;
106 function Fatal_Error (U : Unit_Number_Type) return Boolean is
108 return Units.Table (U).Fatal_Error;
111 function Generate_Code (U : Unit_Number_Type) return Boolean is
113 return Units.Table (U).Generate_Code;
116 function Has_RACW (U : Unit_Number_Type) return Boolean is
118 return Units.Table (U).Has_RACW;
121 function Ident_String (U : Unit_Number_Type) return Node_Id is
123 return Units.Table (U).Ident_String;
126 function Loading (U : Unit_Number_Type) return Boolean is
128 return Units.Table (U).Loading;
131 function Main_Priority (U : Unit_Number_Type) return Int is
133 return Units.Table (U).Main_Priority;
136 function Munit_Index (U : Unit_Number_Type) return Nat is
138 return Units.Table (U).Munit_Index;
141 function Source_Index (U : Unit_Number_Type) return Source_File_Index is
143 return Units.Table (U).Source_Index;
146 function Unit_File_Name (U : Unit_Number_Type) return File_Name_Type is
148 return Units.Table (U).Unit_File_Name;
151 function Unit_Name (U : Unit_Number_Type) return Unit_Name_Type is
153 return Units.Table (U).Unit_Name;
156 ------------------------------------------
157 -- Subprograms to Set Unit Table Fields --
158 ------------------------------------------
160 procedure Set_Cunit (U : Unit_Number_Type; N : Node_Id) is
162 Units.Table (U).Cunit := N;
165 procedure Set_Cunit_Entity (U : Unit_Number_Type; E : Entity_Id) is
167 Units.Table (U).Cunit_Entity := E;
168 Set_Is_Compilation_Unit (E);
169 end Set_Cunit_Entity;
171 procedure Set_Dynamic_Elab (U : Unit_Number_Type; B : Boolean := True) is
173 Units.Table (U).Dynamic_Elab := B;
174 end Set_Dynamic_Elab;
176 procedure Set_Error_Location (U : Unit_Number_Type; W : Source_Ptr) is
178 Units.Table (U).Error_Location := W;
179 end Set_Error_Location;
181 procedure Set_Fatal_Error (U : Unit_Number_Type; B : Boolean := True) is
183 Units.Table (U).Fatal_Error := B;
186 procedure Set_Generate_Code (U : Unit_Number_Type; B : Boolean := True) is
188 Units.Table (U).Generate_Code := B;
189 end Set_Generate_Code;
191 procedure Set_Has_RACW (U : Unit_Number_Type; B : Boolean := True) is
193 Units.Table (U).Has_RACW := B;
196 procedure Set_Ident_String (U : Unit_Number_Type; N : Node_Id) is
198 Units.Table (U).Ident_String := N;
199 end Set_Ident_String;
201 procedure Set_Loading (U : Unit_Number_Type; B : Boolean := True) is
203 Units.Table (U).Loading := B;
206 procedure Set_Main_Priority (U : Unit_Number_Type; P : Int) is
208 Units.Table (U).Main_Priority := P;
209 end Set_Main_Priority;
211 procedure Set_Unit_Name (U : Unit_Number_Type; N : Unit_Name_Type) is
213 Units.Table (U).Unit_Name := N;
216 ------------------------------
217 -- Check_Same_Extended_Unit --
218 ------------------------------
220 function Check_Same_Extended_Unit (S1, S2 : Source_Ptr) return SEU_Result is
223 Sind1 : Source_File_Index;
224 Sind2 : Source_File_Index;
227 Unum1 : Unit_Number_Type;
228 Unum2 : Unit_Number_Type;
235 if S1 = No_Location or else S2 = No_Location then
238 elsif S1 = Standard_Location then
239 if S2 = Standard_Location then
245 elsif S2 = Standard_Location then
251 Unum1 := Get_Code_Unit (Sloc1);
252 Unum2 := Get_Code_Unit (Sloc2);
255 Sind1 := Get_Source_File_Index (Sloc1);
256 Sind2 := Get_Source_File_Index (Sloc2);
258 if Sind1 = Sind2 then
259 if Sloc1 < Sloc2 then
261 elsif Sloc1 > Sloc2 then
268 -- OK, the two nodes are in separate source elements, but this is not
269 -- decisive, because of the issue of subunits and instantiations.
271 -- First we deal with subunits, since if the subunit is in an
272 -- instantiation, we know that the parent is in the corresponding
273 -- instantiation, since that is the only way we can have a subunit
274 -- that is part of an instantiation.
276 Unit1 := Unit (Cunit (Unum1));
277 Unit2 := Unit (Cunit (Unum2));
279 if Nkind (Unit1) = N_Subunit
280 and then Present (Corresponding_Stub (Unit1))
282 -- Both in subunits. They could have a common ancestor. If they
283 -- do, then the deeper one must have a longer unit name. Replace
284 -- the deeper one with its corresponding stub, in order to find
285 -- nearest common ancestor, if any.
287 if Nkind (Unit2) = N_Subunit
288 and then Present (Corresponding_Stub (Unit2))
290 if Length_Of_Name (Unit_Name (Unum1)) <
291 Length_Of_Name (Unit_Name (Unum2))
293 Sloc2 := Sloc (Corresponding_Stub (Unit2));
294 Unum2 := Get_Source_Unit (Sloc2);
298 Sloc1 := Sloc (Corresponding_Stub (Unit1));
299 Unum1 := Get_Source_Unit (Sloc1);
303 -- Nod1 in subunit, Nod2 not
306 Sloc1 := Sloc (Corresponding_Stub (Unit1));
307 Unum1 := Get_Source_Unit (Sloc1);
311 -- Nod2 in subunit, Nod1 not
313 elsif Nkind (Unit2) = N_Subunit
314 and then Present (Corresponding_Stub (Unit2))
316 Sloc2 := Sloc (Corresponding_Stub (Unit2));
317 Unum2 := Get_Source_Unit (Sloc2);
321 -- At this stage we know that neither is a subunit, so we deal
322 -- with instantiations, since we culd have a common ancestor
324 Inst1 := Instantiation (Sind1);
325 Inst2 := Instantiation (Sind2);
327 if Inst1 /= No_Location then
329 -- Both are instantiations
331 if Inst2 /= No_Location then
333 Depth1 := Instantiation_Depth (Sloc1);
334 Depth2 := Instantiation_Depth (Sloc2);
336 if Depth1 < Depth2 then
338 Unum2 := Get_Source_Unit (Sloc2);
341 elsif Depth1 > Depth2 then
343 Unum1 := Get_Source_Unit (Sloc1);
349 Unum1 := Get_Source_Unit (Sloc1);
350 Unum2 := Get_Source_Unit (Sloc2);
354 -- Only first node is in instantiation
358 Unum1 := Get_Source_Unit (Sloc1);
362 -- Only second node is instantiation
364 elsif Inst2 /= No_Location then
366 Unum2 := Get_Source_Unit (Sloc2);
370 -- No instantiations involved, so we are not in the same unit
371 -- However, there is one case still to check, namely the case
372 -- where one location is in the spec, and the other in the
373 -- corresponding body (the spec location is earlier).
375 if Nkind (Unit1) = N_Subprogram_Body
377 Nkind (Unit1) = N_Package_Body
379 if Library_Unit (Cunit (Unum1)) = Cunit (Unum2) then
383 elsif Nkind (Unit2) = N_Subprogram_Body
385 Nkind (Unit2) = N_Package_Body
387 if Library_Unit (Cunit (Unum2)) = Cunit (Unum1) then
392 -- If that special case does not occur, then we are certain that
393 -- the two locations are really in separate units.
400 end Check_Same_Extended_Unit;
402 -------------------------------
403 -- Compilation_Switches_Last --
404 -------------------------------
406 function Compilation_Switches_Last return Nat is
408 return Compilation_Switches.Last;
409 end Compilation_Switches_Last;
411 ------------------------------
412 -- Earlier_In_Extended_Unit --
413 ------------------------------
415 function Earlier_In_Extended_Unit (S1, S2 : Source_Ptr) return Boolean is
417 return Check_Same_Extended_Unit (S1, S2) = Yes_Before;
418 end Earlier_In_Extended_Unit;
420 ----------------------------
421 -- Entity_Is_In_Main_Unit --
422 ----------------------------
424 function Entity_Is_In_Main_Unit (E : Entity_Id) return Boolean is
430 while S /= Standard_Standard loop
431 if S = Main_Unit_Entity then
433 elsif Ekind (S) = E_Package and then Is_Child_Unit (S) then
441 end Entity_Is_In_Main_Unit;
443 ---------------------------------
444 -- Generic_Separately_Compiled --
445 ---------------------------------
447 function Generic_Separately_Compiled (E : Entity_Id) return Boolean is
449 -- We do not generate object files for internal generics, because
450 -- the only thing they would contain is the elaboration boolean, and
451 -- we are careful to elaborate all predefined units first anyway, so
452 -- this boolean is not needed.
454 if Is_Internal_File_Name
455 (Fname => Unit_File_Name (Get_Source_Unit (E)),
456 Renamings_Included => True)
460 -- All other generic units do generate object files
465 end Generic_Separately_Compiled;
467 function Generic_Separately_Compiled
468 (Sfile : File_Name_Type) return Boolean
471 -- Exactly the same as previous function, but works directly on a file
474 if Is_Internal_File_Name
476 Renamings_Included => True)
480 -- All other generic units do generate object files
485 end Generic_Separately_Compiled;
491 function Get_Code_Unit (S : Source_Ptr) return Unit_Number_Type is
493 -- Search table unless we have No_Location, which can happen if the
494 -- relevant location has not been set yet. Happens for example when
495 -- we obtain Sloc (Cunit (Main_Unit)) before it is set.
497 if S /= No_Location then
499 Source_File : constant Source_File_Index :=
500 Get_Source_File_Index (Top_Level_Location (S));
503 for U in Units.First .. Units.Last loop
504 if Source_Index (U) = Source_File then
511 -- If S was No_Location, or was not in the table, we must be in the
512 -- main source unit (and the value has not been placed in the table yet)
517 function Get_Code_Unit (N : Node_Or_Entity_Id) return Unit_Number_Type is
519 return Get_Code_Unit (Sloc (N));
522 ----------------------------
523 -- Get_Compilation_Switch --
524 ----------------------------
526 function Get_Compilation_Switch (N : Pos) return String_Ptr is
528 if N <= Compilation_Switches.Last then
529 return Compilation_Switches.Table (N);
534 end Get_Compilation_Switch;
536 ----------------------------------
537 -- Get_Cunit_Entity_Unit_Number --
538 ----------------------------------
540 function Get_Cunit_Entity_Unit_Number
541 (E : Entity_Id) return Unit_Number_Type
544 for U in Units.First .. Units.Last loop
545 if Cunit_Entity (U) = E then
550 -- If not in the table, must be the main source unit, and we just
551 -- have not got it put into the table yet.
554 end Get_Cunit_Entity_Unit_Number;
556 ---------------------------
557 -- Get_Cunit_Unit_Number --
558 ---------------------------
560 function Get_Cunit_Unit_Number (N : Node_Id) return Unit_Number_Type is
562 for U in Units.First .. Units.Last loop
563 if Cunit (U) = N then
568 -- If not in the table, must be the main source unit, and we just
569 -- have not got it put into the table yet.
572 end Get_Cunit_Unit_Number;
574 ---------------------
575 -- Get_Source_Unit --
576 ---------------------
578 function Get_Source_Unit (S : Source_Ptr) return Unit_Number_Type is
580 -- Search table unless we have No_Location, which can happen if the
581 -- relevant location has not been set yet. Happens for example when
582 -- we obtain Sloc (Cunit (Main_Unit)) before it is set.
584 if S /= No_Location then
586 Source_File : Source_File_Index :=
587 Get_Source_File_Index (Top_Level_Location (S));
590 Source_File := Get_Source_File_Index (S);
591 while Template (Source_File) /= No_Source_File loop
592 Source_File := Template (Source_File);
595 for U in Units.First .. Units.Last loop
596 if Source_Index (U) = Source_File then
603 -- If S was No_Location, or was not in the table, we must be in the
604 -- main source unit (and the value has not got put into the table yet)
609 function Get_Source_Unit (N : Node_Or_Entity_Id) return Unit_Number_Type is
611 return Get_Source_Unit (Sloc (N));
614 --------------------------------
615 -- In_Extended_Main_Code_Unit --
616 --------------------------------
618 function In_Extended_Main_Code_Unit
619 (N : Node_Or_Entity_Id) return Boolean
622 if Sloc (N) = Standard_Location then
625 elsif Sloc (N) = No_Location then
628 -- Special case Itypes to test the Sloc of the associated node. The
629 -- reason we do this is for possible calls from gigi after -gnatD
630 -- processing is complete in sprint. This processing updates the
631 -- sloc fields of all nodes in the tree, but itypes are not in the
632 -- tree so their slocs do not get updated.
634 elsif Nkind (N) = N_Defining_Identifier
635 and then Is_Itype (N)
637 return In_Extended_Main_Code_Unit (Associated_Node_For_Itype (N));
639 -- Otherwise see if we are in the main unit
641 elsif Get_Code_Unit (Sloc (N)) = Get_Code_Unit (Cunit (Main_Unit)) then
644 -- Node may be in spec (or subunit etc) of main unit
648 In_Same_Extended_Unit (Sloc (N), Sloc (Cunit (Main_Unit)));
650 end In_Extended_Main_Code_Unit;
652 function In_Extended_Main_Code_Unit (Loc : Source_Ptr) return Boolean is
654 if Loc = Standard_Location then
657 elsif Loc = No_Location then
660 -- Otherwise see if we are in the main unit
662 elsif Get_Code_Unit (Loc) = Get_Code_Unit (Cunit (Main_Unit)) then
665 -- Location may be in spec (or subunit etc) of main unit
669 In_Same_Extended_Unit (Loc, Sloc (Cunit (Main_Unit)));
671 end In_Extended_Main_Code_Unit;
673 ----------------------------------
674 -- In_Extended_Main_Source_Unit --
675 ----------------------------------
677 function In_Extended_Main_Source_Unit
678 (N : Node_Or_Entity_Id) return Boolean
680 Nloc : constant Source_Ptr := Sloc (N);
681 Mloc : constant Source_Ptr := Sloc (Cunit (Main_Unit));
684 -- If Mloc is not set, it means we are still parsing the main unit,
685 -- so everything so far is in the extended main source unit.
687 if Mloc = No_Location then
690 -- Special value cases
692 elsif Nloc = Standard_Location then
695 elsif Nloc = No_Location then
698 -- Special case Itypes to test the Sloc of the associated node. The
699 -- reason we do this is for possible calls from gigi after -gnatD
700 -- processing is complete in sprint. This processing updates the
701 -- sloc fields of all nodes in the tree, but itypes are not in the
702 -- tree so their slocs do not get updated.
704 elsif Nkind (N) = N_Defining_Identifier
705 and then Is_Itype (N)
707 return In_Extended_Main_Source_Unit (Associated_Node_For_Itype (N));
709 -- Otherwise compare original locations to see if in same unit
713 In_Same_Extended_Unit
714 (Original_Location (Nloc), Original_Location (Mloc));
716 end In_Extended_Main_Source_Unit;
718 function In_Extended_Main_Source_Unit
719 (Loc : Source_Ptr) return Boolean
721 Mloc : constant Source_Ptr := Sloc (Cunit (Main_Unit));
724 -- If Mloc is not set, it means we are still parsing the main unit,
725 -- so everything so far is in the extended main source unit.
727 if Mloc = No_Location then
730 -- Special value cases
732 elsif Loc = Standard_Location then
735 elsif Loc = No_Location then
738 -- Otherwise compare original locations to see if in same unit
742 In_Same_Extended_Unit
743 (Original_Location (Loc), Original_Location (Mloc));
745 end In_Extended_Main_Source_Unit;
747 -----------------------
748 -- In_Same_Code_Unit --
749 -----------------------
751 function In_Same_Code_Unit (N1, N2 : Node_Or_Entity_Id) return Boolean is
752 S1 : constant Source_Ptr := Sloc (N1);
753 S2 : constant Source_Ptr := Sloc (N2);
756 if S1 = No_Location or else S2 = No_Location then
759 elsif S1 = Standard_Location then
760 return S2 = Standard_Location;
762 elsif S2 = Standard_Location then
766 return Get_Code_Unit (N1) = Get_Code_Unit (N2);
767 end In_Same_Code_Unit;
769 ---------------------------
770 -- In_Same_Extended_Unit --
771 ---------------------------
773 function In_Same_Extended_Unit (S1, S2 : Source_Ptr) return Boolean is
775 return Check_Same_Extended_Unit (S1, S2) /= No;
776 end In_Same_Extended_Unit;
778 -------------------------
779 -- In_Same_Source_Unit --
780 -------------------------
782 function In_Same_Source_Unit (N1, N2 : Node_Or_Entity_Id) return Boolean is
783 S1 : constant Source_Ptr := Sloc (N1);
784 S2 : constant Source_Ptr := Sloc (N2);
787 if S1 = No_Location or else S2 = No_Location then
790 elsif S1 = Standard_Location then
791 return S2 = Standard_Location;
793 elsif S2 = Standard_Location then
797 return Get_Source_Unit (N1) = Get_Source_Unit (N2);
798 end In_Same_Source_Unit;
800 -----------------------------
801 -- Increment_Serial_Number --
802 -----------------------------
804 function Increment_Serial_Number return Nat is
805 TSN : Int renames Units.Table (Current_Sem_Unit).Serial_Number;
809 end Increment_Serial_Number;
815 procedure Initialize is
817 Linker_Option_Lines.Init;
820 Unit_Exception_Table_Present := False;
821 Compilation_Switches.Init;
828 function Is_Loaded (Uname : Unit_Name_Type) return Boolean is
830 for Unum in Units.First .. Units.Last loop
831 if Uname = Unit_Name (Unum) then
843 function Last_Unit return Unit_Number_Type is
852 procedure List (File_Names_Only : Boolean := False) is separate;
860 Linker_Option_Lines.Locked := True;
861 Load_Stack.Locked := True;
862 Units.Locked := True;
863 Linker_Option_Lines.Release;
872 function Num_Units return Nat is
874 return Int (Units.Last) - Int (Main_Unit) + 1;
881 procedure Remove_Unit (U : Unit_Number_Type) is
883 if U = Units.Last then
884 Units.Decrement_Last;
888 ----------------------------------
889 -- Replace_Linker_Option_String --
890 ----------------------------------
892 procedure Replace_Linker_Option_String
893 (S : String_Id; Match_String : String)
896 if Match_String'Length > 0 then
897 for J in 1 .. Linker_Option_Lines.Last loop
898 String_To_Name_Buffer (Linker_Option_Lines.Table (J).Option);
900 if Match_String = Name_Buffer (1 .. Match_String'Length) then
901 Linker_Option_Lines.Table (J).Option := S;
907 Store_Linker_Option_String (S);
908 end Replace_Linker_Option_String;
914 procedure Sort (Tbl : in out Unit_Ref_Table) is separate;
916 ------------------------------
917 -- Store_Compilation_Switch --
918 ------------------------------
920 procedure Store_Compilation_Switch (Switch : String) is
922 Compilation_Switches.Increment_Last;
923 Compilation_Switches.Table (Compilation_Switches.Last) :=
926 -- Fix up --RTS flag which has been transformed by the gcc driver
929 if Switch'Last >= Switch'First + 4
930 and then Switch (Switch'First .. Switch'First + 4) = "-fRTS"
932 Compilation_Switches.Table
933 (Compilation_Switches.Last) (Switch'First + 1) := '-';
935 end Store_Compilation_Switch;
937 --------------------------------
938 -- Store_Linker_Option_String --
939 --------------------------------
941 procedure Store_Linker_Option_String (S : String_Id) is
943 Linker_Option_Lines.Increment_Last;
944 Linker_Option_Lines.Table (Linker_Option_Lines.Last) :=
945 (Option => S, Unit => Current_Sem_Unit);
946 end Store_Linker_Option_String;
952 procedure Tree_Read is
959 -- Read Compilation_Switches table
962 Compilation_Switches.Set_Last (N);
966 Compilation_Switches.Table (J) := S;
974 procedure Tree_Write is
978 -- Write Compilation_Switches table
980 Tree_Write_Int (Compilation_Switches.Last);
982 for J in 1 .. Compilation_Switches.Last loop
983 Tree_Write_Str (Compilation_Switches.Table (J));
991 function Version_Get (U : Unit_Number_Type) return Word_Hex_String is
993 return Get_Hex_String (Units.Table (U).Version);
996 ------------------------
997 -- Version_Referenced --
998 ------------------------
1000 procedure Version_Referenced (S : String_Id) is
1002 Version_Ref.Append (S);
1003 end Version_Referenced;