1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1996-2005, 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, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 with Alloc; use Alloc;
28 with Atree; use Atree;
29 with Debug; use Debug;
30 with Einfo; use Einfo;
31 with Namet; use Namet;
32 with Nlists; use Nlists;
33 with Nmake; use Nmake;
35 with Output; use Output;
36 with Sem_Eval; use Sem_Eval;
37 with Sem_Util; use Sem_Util;
38 with Sinfo; use Sinfo;
39 with Snames; use Snames;
40 with Stand; use Stand;
41 with Stringt; use Stringt;
43 with Urealp; use Urealp;
45 package body Exp_Dbug is
47 -- The following table is used to queue up the entities passed as
48 -- arguments to Qualify_Entity_Names for later processing when
49 -- Qualify_All_Entity_Names is called.
51 package Name_Qualify_Units is new Table.Table (
52 Table_Component_Type => Node_Id,
53 Table_Index_Type => Nat,
55 Table_Initial => Alloc.Name_Qualify_Units_Initial,
56 Table_Increment => Alloc.Name_Qualify_Units_Increment,
57 Table_Name => "Name_Qualify_Units");
59 --------------------------------
60 -- Use of Qualification Flags --
61 --------------------------------
63 -- There are two flags used to keep track of qualification of entities
65 -- Has_Fully_Qualified_Name
68 -- The difference between these is as follows. Has_Qualified_Name is
69 -- set to indicate that the name has been qualified as required by the
70 -- spec of this package. As described there, this may involve the full
71 -- qualification for the name, but for some entities, notably procedure
72 -- local variables, this full qualification is not required.
74 -- The flag Has_Fully_Qualified_Name is set if indeed the name has been
75 -- fully qualified in the Ada sense. If Has_Fully_Qualified_Name is set,
76 -- then Has_Qualified_Name is also set, but the other way round is not
79 -- Consider the following example:
86 -- Here B is a procedure local variable, so it does not need fully
87 -- qualification. The flag Has_Qualified_Name will be set on the
88 -- first attempt to qualify B, to indicate that the job is done
89 -- and need not be redone.
91 -- But Y is qualified as x__y, since procedures are always fully
92 -- qualified, so the first time that an attempt is made to qualify
93 -- the name y, it will be replaced by x__y, and both flags are set.
95 -- Why the two flags? Well there are cases where we derive type names
96 -- from object names. As noted in the spec, type names are always
97 -- fully qualified. Suppose for example that the backend has to build
98 -- a padded type for variable B. then it will construct the PAD name
99 -- from B, but it requires full qualification, so the fully qualified
100 -- type name will be x__b___PAD. The two flags allow the circuit for
101 -- building this name to realize efficiently that b needs further
108 -- The string defined here (and its associated length) is used to
109 -- gather the homonym string that will be appended to Name_Buffer
110 -- when the name is complete. Strip_Suffixes appends to this string
111 -- as does Append_Homonym_Number, and Output_Homonym_Numbers_Suffix
112 -- appends the string to the end of Name_Buffer.
114 Homonym_Numbers : String (1 .. 256);
115 Homonym_Len : Natural := 0;
117 ----------------------
118 -- Local Procedures --
119 ----------------------
121 procedure Add_Uint_To_Buffer (U : Uint);
122 -- Add image of universal integer to Name_Buffer, updating Name_Len
124 procedure Add_Real_To_Buffer (U : Ureal);
125 -- Add nnn_ddd to Name_Buffer, where nnn and ddd are integer values of
126 -- the normalized numerator and denominator of the given real value.
128 procedure Append_Homonym_Number (E : Entity_Id);
129 -- If the entity E has homonyms in the same scope, then make an entry
130 -- in the Homonym_Numbers array, bumping Homonym_Count accordingly.
132 function Bounds_Match_Size (E : Entity_Id) return Boolean;
133 -- Determine whether the bounds of E match the size of the type. This is
134 -- used to determine whether encoding is required for a discrete type.
136 procedure Output_Homonym_Numbers_Suffix;
137 -- If homonym numbers are stored, then output them into Name_Buffer
139 procedure Prepend_String_To_Buffer (S : String);
140 -- Prepend given string to the contents of the string buffer, updating
141 -- the value in Name_Len (i.e. string is added at start of buffer).
143 procedure Prepend_Uint_To_Buffer (U : Uint);
144 -- Prepend image of universal integer to Name_Buffer, updating Name_Len
146 procedure Qualify_Entity_Name (Ent : Entity_Id);
147 -- If not already done, replaces the Chars field of the given entity
148 -- with the appropriate fully qualified name.
150 procedure Strip_Suffixes (BNPE_Suffix_Found : in out Boolean);
151 -- Given an qualified entity name in Name_Buffer, remove any plain X or
152 -- X{nb} qualification suffix. The contents of Name_Buffer is not changed
153 -- but Name_Len may be adjusted on return to remove the suffix. If a
154 -- BNPE suffix is found and stripped, then BNPE_Suffix_Found is set to
155 -- True. If no suffix is found, then BNPE_Suffix_Found is not modified.
156 -- This routine also searches for a homonym suffix, and if one is found
157 -- it is also stripped, and the entries are added to the global homonym
158 -- list (Homonym_Numbers) so that they can later be put back.
160 ------------------------
161 -- Add_Real_To_Buffer --
162 ------------------------
164 procedure Add_Real_To_Buffer (U : Ureal) is
166 Add_Uint_To_Buffer (Norm_Num (U));
167 Add_Str_To_Name_Buffer ("_");
168 Add_Uint_To_Buffer (Norm_Den (U));
169 end Add_Real_To_Buffer;
171 ------------------------
172 -- Add_Uint_To_Buffer --
173 ------------------------
175 procedure Add_Uint_To_Buffer (U : Uint) is
178 Add_Uint_To_Buffer (-U);
179 Add_Char_To_Name_Buffer ('m');
181 UI_Image (U, Decimal);
182 Add_Str_To_Name_Buffer (UI_Image_Buffer (1 .. UI_Image_Length));
184 end Add_Uint_To_Buffer;
186 ---------------------------
187 -- Append_Homonym_Number --
188 ---------------------------
190 procedure Append_Homonym_Number (E : Entity_Id) is
192 procedure Add_Nat_To_H (Nr : Nat);
193 -- Little procedure to append Nr to Homonym_Numbers
199 procedure Add_Nat_To_H (Nr : Nat) is
202 Add_Nat_To_H (Nr / 10);
205 Homonym_Len := Homonym_Len + 1;
206 Homonym_Numbers (Homonym_Len) :=
207 Character'Val (Nr mod 10 + Character'Pos ('0'));
210 -- Start of processing for Append_Homonym_Number
213 if Has_Homonym (E) then
215 H : Entity_Id := Homonym (E);
219 while Present (H) loop
220 if Scope (H) = Scope (E) then
227 if Homonym_Len > 0 then
228 Homonym_Len := Homonym_Len + 1;
229 Homonym_Numbers (Homonym_Len) := '_';
235 end Append_Homonym_Number;
237 -----------------------
238 -- Bounds_Match_Size --
239 -----------------------
241 function Bounds_Match_Size (E : Entity_Id) return Boolean is
245 if not Is_OK_Static_Subtype (E) then
248 elsif Is_Integer_Type (E)
249 and then Subtypes_Statically_Match (E, Base_Type (E))
253 -- Here we check if the static bounds match the natural size, which is
254 -- the size passed through with the debugging information. This is the
255 -- Esize rounded up to 8, 16, 32 or 64 as appropriate.
259 Umark : constant Uintp.Save_Mark := Uintp.Mark;
263 if Esize (E) <= 8 then
265 elsif Esize (E) <= 16 then
267 elsif Esize (E) <= 32 then
273 if Is_Modular_Integer_Type (E) or else Is_Enumeration_Type (E) then
275 Expr_Rep_Value (Type_Low_Bound (E)) = 0
277 2 ** Siz - Expr_Rep_Value (Type_High_Bound (E)) = 1;
281 Expr_Rep_Value (Type_Low_Bound (E)) + 2 ** (Siz - 1) = 0
283 2 ** (Siz - 1) - Expr_Rep_Value (Type_High_Bound (E)) = 1;
290 end Bounds_Match_Size;
292 --------------------------------
293 -- Debug_Renaming_Declaration --
294 --------------------------------
296 function Debug_Renaming_Declaration (N : Node_Id) return Node_Id is
297 Loc : constant Source_Ptr := Sloc (N);
298 Ent : constant Node_Id := Defining_Entity (N);
299 Nam : constant Node_Id := Name (N);
307 function Output_Subscript (N : Node_Id; S : String) return Boolean;
308 -- Outputs a single subscript value as ?nnn (subscript is compile time
309 -- known value with value nnn) or as ?e (subscript is local constant
310 -- with name e), where S supplies the proper string to use for ?.
311 -- Returns False if the subscript is not of an appropriate type to
312 -- output in one of these two forms. The result is prepended to the
313 -- name stored in Name_Buffer.
315 ----------------------
316 -- Output_Subscript --
317 ----------------------
319 function Output_Subscript (N : Node_Id; S : String) return Boolean is
321 if Compile_Time_Known_Value (N) then
322 Prepend_Uint_To_Buffer (Expr_Value (N));
324 elsif Nkind (N) = N_Identifier
325 and then Scope (Entity (N)) = Scope (Ent)
326 and then Ekind (Entity (N)) = E_Constant
328 Prepend_String_To_Buffer (Get_Name_String (Chars (Entity (N))));
334 Prepend_String_To_Buffer (S);
336 end Output_Subscript;
338 -- Start of processing for Debug_Renaming_Declaration
341 if not Comes_From_Source (N)
342 and then not Needs_Debug_Info (Ent)
347 -- Prepare entity name for type declaration
349 Get_Name_String (Chars (Ent));
352 when N_Object_Renaming_Declaration =>
353 Add_Str_To_Name_Buffer ("___XR");
355 when N_Exception_Renaming_Declaration =>
356 Add_Str_To_Name_Buffer ("___XRE");
358 when N_Package_Renaming_Declaration =>
359 Add_Str_To_Name_Buffer ("___XRP");
361 -- If it is a child unit create a fully qualified name, to
362 -- disambiguate multiple child units with the same name and
363 -- different parents.
365 if Is_Child_Unit (Ent) then
366 Prepend_String_To_Buffer ("__");
367 Prepend_String_To_Buffer
368 (Get_Name_String (Chars (Scope (Ent))));
377 -- Get renamed entity and compute suffix
387 when N_Expanded_Name =>
389 -- The entity field for an N_Expanded_Name is on the expanded
390 -- name node itself, so we are done here too.
394 when N_Selected_Component =>
395 Prepend_String_To_Buffer
396 (Get_Name_String (Chars (Selector_Name (Ren))));
397 Prepend_String_To_Buffer ("XR");
400 when N_Indexed_Component =>
402 X : Node_Id := Last (Expressions (Ren));
405 while Present (X) loop
406 if not Output_Subscript (X, "XS") then
407 Set_Materialize_Entity (Ent);
419 Typ := Etype (First_Index (Etype (Nam)));
421 if not Output_Subscript (Type_High_Bound (Typ), "XS") then
422 Set_Materialize_Entity (Ent);
426 if not Output_Subscript (Type_Low_Bound (Typ), "XL") then
427 Set_Materialize_Entity (Ent);
433 when N_Explicit_Dereference =>
434 Prepend_String_To_Buffer ("XA");
437 -- For now, anything else simply results in no translation
440 Set_Materialize_Entity (Ent);
445 Prepend_String_To_Buffer ("___XE");
447 -- For now, the literal name contains only the suffix. The Entity_Id
448 -- value for the name is used to create a link from this literal name
449 -- to the renamed entity using the Debug_Renaming_Link field. Then the
450 -- Qualify_Entity_Name procedure uses this link to create the proper
451 -- fully qualified name.
453 -- The reason we do things this way is that we really need to copy the
454 -- qualification of the renamed entity, and it is really much easier to
455 -- do this after the renamed entity has itself been fully qualified.
457 Lit := Make_Defining_Identifier (Loc, Chars => Name_Enter);
458 Set_Debug_Renaming_Link (Lit, Entity (Ren));
460 -- Return the appropriate enumeration type
462 Def := Make_Defining_Identifier (Loc, Chars => Rnm);
464 Make_Full_Type_Declaration (Loc,
465 Defining_Identifier => Def,
467 Make_Enumeration_Type_Definition (Loc,
468 Literals => New_List (Lit)));
470 Set_Needs_Debug_Info (Def);
471 Set_Needs_Debug_Info (Lit);
473 Set_Discard_Names (Defining_Identifier (Res));
476 -- If we get an exception, just figure it is a case that we cannot
477 -- successfully handle using our current approach, since this is
478 -- only for debugging, no need to take the compilation with us!
482 return Make_Null_Statement (Loc);
483 end Debug_Renaming_Declaration;
485 ----------------------
486 -- Get_Encoded_Name --
487 ----------------------
489 -- Note: see spec for details on encodings
491 procedure Get_Encoded_Name (E : Entity_Id) is
492 Has_Suffix : Boolean;
495 -- If not generating code, there is no need to create encoded
496 -- names, and problems when the back-end is called to annotate
497 -- types without full code generation. See comments at beginning
498 -- of Get_External_Name_With_Suffix for additional details.
500 if Operating_Mode /= Generate_Code then
504 Get_Name_String (Chars (E));
506 -- Nothing to do if we do not have a type
510 -- Or if this is an enumeration base type
512 or else (Is_Enumeration_Type (E)
513 and then E = Base_Type (E))
515 -- Or if this is a dummy type for a renaming
517 or else (Name_Len >= 3 and then
518 Name_Buffer (Name_Len - 2 .. Name_Len) = "_XR")
520 or else (Name_Len >= 4 and then
521 (Name_Buffer (Name_Len - 3 .. Name_Len) = "_XRE"
523 Name_Buffer (Name_Len - 3 .. Name_Len) = "_XRP"))
525 -- For all these cases, just return the name unchanged
528 Name_Buffer (Name_Len + 1) := ASCII.Nul;
536 if Is_Fixed_Point_Type (E) then
537 Get_External_Name_With_Suffix (E, "XF_");
538 Add_Real_To_Buffer (Delta_Value (E));
540 if Small_Value (E) /= Delta_Value (E) then
541 Add_Str_To_Name_Buffer ("_");
542 Add_Real_To_Buffer (Small_Value (E));
545 -- Vax floating-point case
547 elsif Vax_Float (E) then
549 if Digits_Value (Base_Type (E)) = 6 then
550 Get_External_Name_With_Suffix (E, "XFF");
552 elsif Digits_Value (Base_Type (E)) = 9 then
553 Get_External_Name_With_Suffix (E, "XFF");
556 pragma Assert (Digits_Value (Base_Type (E)) = 15);
557 Get_External_Name_With_Suffix (E, "XFG");
560 -- Discrete case where bounds do not match size
562 elsif Is_Discrete_Type (E)
563 and then not Bounds_Match_Size (E)
566 Lo : constant Node_Id := Type_Low_Bound (E);
567 Hi : constant Node_Id := Type_High_Bound (E);
569 Lo_Con : constant Boolean := Compile_Time_Known_Value (Lo);
570 Hi_Con : constant Boolean := Compile_Time_Known_Value (Hi);
572 Lo_Discr : constant Boolean :=
573 Nkind (Lo) = N_Identifier
575 Ekind (Entity (Lo)) = E_Discriminant;
577 Hi_Discr : constant Boolean :=
578 Nkind (Hi) = N_Identifier
580 Ekind (Entity (Hi)) = E_Discriminant;
582 Lo_Encode : constant Boolean := Lo_Con or Lo_Discr;
583 Hi_Encode : constant Boolean := Hi_Con or Hi_Discr;
585 Biased : constant Boolean := Has_Biased_Representation (E);
589 Get_External_Name_With_Suffix (E, "XB");
591 Get_External_Name_With_Suffix (E, "XD");
594 if Lo_Encode or Hi_Encode then
596 Add_Str_To_Name_Buffer ("_");
600 Add_Str_To_Name_Buffer ("LU_");
602 Add_Str_To_Name_Buffer ("L_");
605 Add_Str_To_Name_Buffer ("U_");
610 Add_Uint_To_Buffer (Expr_Rep_Value (Lo));
612 Get_Name_String_And_Append (Chars (Entity (Lo)));
615 if Lo_Encode and Hi_Encode then
616 Add_Str_To_Name_Buffer ("__");
620 Add_Uint_To_Buffer (Expr_Rep_Value (Hi));
622 Get_Name_String_And_Append (Chars (Entity (Hi)));
627 -- For all other cases, the encoded name is the normal type name
631 Get_External_Name (E, Has_Suffix);
634 if Debug_Flag_B and then Has_Suffix then
635 Write_Str ("**** type ");
636 Write_Name (Chars (E));
637 Write_Str (" is encoded as ");
638 Write_Str (Name_Buffer (1 .. Name_Len));
642 Name_Buffer (Name_Len + 1) := ASCII.NUL;
643 end Get_Encoded_Name;
645 -----------------------
646 -- Get_External_Name --
647 -----------------------
649 procedure Get_External_Name (Entity : Entity_Id; Has_Suffix : Boolean) is
650 E : Entity_Id := Entity;
653 procedure Get_Qualified_Name_And_Append (Entity : Entity_Id);
654 -- Appends fully qualified name of given entity to Name_Buffer
656 -----------------------------------
657 -- Get_Qualified_Name_And_Append --
658 -----------------------------------
660 procedure Get_Qualified_Name_And_Append (Entity : Entity_Id) is
662 -- If the entity is a compilation unit, its scope is Standard,
663 -- there is no outer scope, and the no further qualification
666 -- If the front end has already computed a fully qualified name,
667 -- then it is also the case that no further qualification is
670 if Present (Scope (Scope (Entity)))
671 and then not Has_Fully_Qualified_Name (Entity)
673 Get_Qualified_Name_And_Append (Scope (Entity));
674 Add_Str_To_Name_Buffer ("__");
675 Get_Name_String_And_Append (Chars (Entity));
676 Append_Homonym_Number (Entity);
679 Get_Name_String_And_Append (Chars (Entity));
682 end Get_Qualified_Name_And_Append;
684 -- Start of processing for Get_External_Name
689 -- If this is a child unit, we want the child
691 if Nkind (E) = N_Defining_Program_Unit_Name then
692 E := Defining_Identifier (Entity);
697 -- Case of interface name being used
699 if (Kind = E_Procedure or else
700 Kind = E_Function or else
701 Kind = E_Constant or else
702 Kind = E_Variable or else
704 and then Present (Interface_Name (E))
705 and then No (Address_Clause (E))
706 and then not Has_Suffix
708 Add_String_To_Name_Buffer (Strval (Interface_Name (E)));
710 -- All other cases besides the interface name case
713 -- If this is a library level subprogram (i.e. a subprogram that is a
714 -- compilation unit other than a subunit), then we prepend _ada_ to
715 -- ensure distinctions required as described in the spec.
717 -- Check explicitly for child units, because those are not flagged
718 -- as Compilation_Units by lib. Should they be ???
721 and then (Is_Compilation_Unit (E) or Is_Child_Unit (E))
722 and then not Has_Suffix
724 Add_Str_To_Name_Buffer ("_ada_");
727 -- If the entity is a subprogram instance that is not a compilation
728 -- unit, generate the name of the original Ada entity, which is the
731 if Is_Generic_Instance (E)
732 and then Is_Subprogram (E)
733 and then not Is_Compilation_Unit (Scope (E))
734 and then (Ekind (Scope (E)) = E_Package
736 Ekind (Scope (E)) = E_Package_Body)
737 and then Present (Related_Instance (Scope (E)))
739 E := Related_Instance (Scope (E));
742 Get_Qualified_Name_And_Append (E);
745 Name_Buffer (Name_Len + 1) := ASCII.Nul;
746 end Get_External_Name;
748 -----------------------------------
749 -- Get_External_Name_With_Suffix --
750 -----------------------------------
752 procedure Get_External_Name_With_Suffix
756 Has_Suffix : constant Boolean := (Suffix /= "");
759 -- If we are not in code generation mode, this procedure may still be
760 -- called from Back_End (more specifically - from gigi for doing type
761 -- representation annotation or some representation-specific checks).
762 -- But in this mode there is no need to mess with external names.
764 -- Furthermore, the call causes difficulties in this case because the
765 -- string representing the homonym number is not correctly reset as a
766 -- part of the call to Output_Homonym_Numbers_Suffix (which is not
769 if Operating_Mode /= Generate_Code then
773 Get_External_Name (Entity, Has_Suffix);
776 Add_Str_To_Name_Buffer ("___");
777 Add_Str_To_Name_Buffer (Suffix);
778 Name_Buffer (Name_Len + 1) := ASCII.Nul;
780 end Get_External_Name_With_Suffix;
782 --------------------------
783 -- Get_Variant_Encoding --
784 --------------------------
786 procedure Get_Variant_Encoding (V : Node_Id) is
789 procedure Choice_Val (Typ : Character; Choice : Node_Id);
790 -- Output encoded value for a single choice value. Typ is the key
791 -- character ('S', 'F', or 'T') that precedes the choice value.
797 procedure Choice_Val (Typ : Character; Choice : Node_Id) is
799 if Nkind (Choice) = N_Integer_Literal then
800 Add_Char_To_Name_Buffer (Typ);
801 Add_Uint_To_Buffer (Intval (Choice));
803 -- Character literal with no entity present (this is the case
804 -- Standard.Character or Standard.Wide_Character as root type)
806 elsif Nkind (Choice) = N_Character_Literal
807 and then No (Entity (Choice))
809 Add_Char_To_Name_Buffer (Typ);
810 Add_Uint_To_Buffer (Char_Literal_Value (Choice));
814 Ent : constant Entity_Id := Entity (Choice);
817 if Ekind (Ent) = E_Enumeration_Literal then
818 Add_Char_To_Name_Buffer (Typ);
819 Add_Uint_To_Buffer (Enumeration_Rep (Ent));
822 pragma Assert (Ekind (Ent) = E_Constant);
823 Choice_Val (Typ, Constant_Value (Ent));
829 -- Start of processing for Get_Variant_Encoding
834 Choice := First (Discrete_Choices (V));
835 while Present (Choice) loop
836 if Nkind (Choice) = N_Others_Choice then
837 Add_Char_To_Name_Buffer ('O');
839 elsif Nkind (Choice) = N_Range then
840 Choice_Val ('R', Low_Bound (Choice));
841 Choice_Val ('T', High_Bound (Choice));
843 elsif Is_Entity_Name (Choice)
844 and then Is_Type (Entity (Choice))
846 Choice_Val ('R', Type_Low_Bound (Entity (Choice)));
847 Choice_Val ('T', Type_High_Bound (Entity (Choice)));
849 elsif Nkind (Choice) = N_Subtype_Indication then
851 Rang : constant Node_Id :=
852 Range_Expression (Constraint (Choice));
854 Choice_Val ('R', Low_Bound (Rang));
855 Choice_Val ('T', High_Bound (Rang));
859 Choice_Val ('S', Choice);
865 Name_Buffer (Name_Len + 1) := ASCII.NUL;
869 VP : constant Node_Id := Parent (V); -- Variant_Part
870 CL : constant Node_Id := Parent (VP); -- Component_List
871 RD : constant Node_Id := Parent (CL); -- Record_Definition
872 FT : constant Node_Id := Parent (RD); -- Full_Type_Declaration
875 Write_Str ("**** variant for type ");
876 Write_Name (Chars (Defining_Identifier (FT)));
877 Write_Str (" is encoded as ");
878 Write_Str (Name_Buffer (1 .. Name_Len));
882 end Get_Variant_Encoding;
884 ------------------------------------
885 -- Get_Secondary_DT_External_Name --
886 ------------------------------------
888 procedure Get_Secondary_DT_External_Name
890 Ancestor_Typ : Entity_Id;
891 Suffix_Index : Int) is
893 Get_External_Name (Typ, Has_Suffix => False);
895 if Ancestor_Typ /= Typ then
897 Len : constant Natural := Name_Len;
898 Save_Str : constant String (1 .. Name_Len)
899 := Name_Buffer (1 .. Name_Len);
901 Get_External_Name (Ancestor_Typ, Has_Suffix => False);
903 -- Append the extended name of the ancestor to the
904 -- extended name of Typ
906 Name_Buffer (Len + 2 .. Len + Name_Len + 1) :=
907 Name_Buffer (1 .. Name_Len);
908 Name_Buffer (1 .. Len) := Save_Str;
909 Name_Buffer (Len + 1) := '_';
910 Name_Len := Len + Name_Len + 1;
914 Add_Nat_To_Name_Buffer (Suffix_Index);
915 end Get_Secondary_DT_External_Name;
917 ---------------------------------
918 -- Make_Packed_Array_Type_Name --
919 ---------------------------------
921 function Make_Packed_Array_Type_Name
927 Get_Name_String (Chars (Typ));
928 Add_Str_To_Name_Buffer ("___XP");
929 Add_Uint_To_Buffer (Csize);
931 end Make_Packed_Array_Type_Name;
933 -----------------------------------
934 -- Output_Homonym_Numbers_Suffix --
935 -----------------------------------
937 procedure Output_Homonym_Numbers_Suffix is
941 if Homonym_Len > 0 then
943 -- Check for all 1's, in which case we do not output
947 exit when Homonym_Numbers (J) /= '1';
949 -- If we reached end of string we do not output
951 if J = Homonym_Len then
956 exit when Homonym_Numbers (J + 1) /= '_';
960 -- If we exit the loop then suffix must be output
962 Add_Str_To_Name_Buffer ("__");
963 Add_Str_To_Name_Buffer (Homonym_Numbers (1 .. Homonym_Len));
966 end Output_Homonym_Numbers_Suffix;
968 ------------------------------
969 -- Prepend_String_To_Buffer --
970 ------------------------------
972 procedure Prepend_String_To_Buffer (S : String) is
973 N : constant Integer := S'Length;
975 Name_Buffer (1 + N .. Name_Len + N) := Name_Buffer (1 .. Name_Len);
976 Name_Buffer (1 .. N) := S;
977 Name_Len := Name_Len + N;
978 end Prepend_String_To_Buffer;
980 ----------------------------
981 -- Prepend_Uint_To_Buffer --
982 ----------------------------
984 procedure Prepend_Uint_To_Buffer (U : Uint) is
987 Prepend_String_To_Buffer ("m");
988 Prepend_Uint_To_Buffer (-U);
990 UI_Image (U, Decimal);
991 Prepend_String_To_Buffer (UI_Image_Buffer (1 .. UI_Image_Length));
993 end Prepend_Uint_To_Buffer;
995 ------------------------------
996 -- Qualify_All_Entity_Names --
997 ------------------------------
999 procedure Qualify_All_Entity_Names is
1004 for J in Name_Qualify_Units.First .. Name_Qualify_Units.Last loop
1005 E := Defining_Entity (Name_Qualify_Units.Table (J));
1006 Qualify_Entity_Name (E);
1008 Ent := First_Entity (E);
1009 while Present (Ent) loop
1010 Qualify_Entity_Name (Ent);
1013 -- There are odd cases where Last_Entity (E) = E. This happens
1014 -- in the case of renaming of packages. This test avoids getting
1015 -- stuck in such cases.
1020 end Qualify_All_Entity_Names;
1022 -------------------------
1023 -- Qualify_Entity_Name --
1024 -------------------------
1026 procedure Qualify_Entity_Name (Ent : Entity_Id) is
1028 Full_Qualify_Name : String (1 .. Name_Buffer'Length);
1029 Full_Qualify_Len : Natural := 0;
1030 -- Used to accumulate fully qualified name of subprogram
1032 procedure Fully_Qualify_Name (E : Entity_Id);
1033 -- Used to qualify a subprogram or type name, where full
1034 -- qualification up to Standard is always used. Name is set
1035 -- in Full_Qualify_Name with the length in Full_Qualify_Len.
1036 -- Note that this routine does not prepend the _ada_ string
1037 -- required for library subprograms (this is done in the back end).
1039 function Is_BNPE (S : Entity_Id) return Boolean;
1040 -- Determines if S is a BNPE, i.e. Body-Nested Package Entity, which
1041 -- is defined to be a package which is immediately nested within a
1044 function Qualify_Needed (S : Entity_Id) return Boolean;
1045 -- Given a scope, determines if the scope is to be included in the
1046 -- fully qualified name, True if so, False if not.
1048 procedure Set_BNPE_Suffix (E : Entity_Id);
1049 -- Recursive routine to append the BNPE qualification suffix. Works
1050 -- from right to left with E being the current entity in the list.
1051 -- The result does NOT have the trailing n's and trailing b stripped.
1052 -- The caller must do this required stripping.
1054 procedure Set_Entity_Name (E : Entity_Id);
1055 -- Internal recursive routine that does most of the work. This routine
1056 -- leaves the result sitting in Name_Buffer and Name_Len.
1058 BNPE_Suffix_Needed : Boolean := False;
1059 -- Set true if a body-nested package entity suffix is required
1061 Save_Chars : constant Name_Id := Chars (Ent);
1062 -- Save original name
1064 ------------------------
1065 -- Fully_Qualify_Name --
1066 ------------------------
1068 procedure Fully_Qualify_Name (E : Entity_Id) is
1069 Discard : Boolean := False;
1072 -- Ignore empty entry (can happen in error cases)
1077 -- If this we are qualifying entities local to a generic
1078 -- instance, use the name of the original instantiation,
1079 -- not that of the anonymous subprogram in the wrapper
1080 -- package, so that gdb doesn't have to know about these.
1082 elsif Is_Generic_Instance (E)
1083 and then Is_Subprogram (E)
1084 and then not Comes_From_Source (E)
1085 and then not Is_Compilation_Unit (Scope (E))
1087 Fully_Qualify_Name (Related_Instance (Scope (E)));
1091 -- If we reached fully qualified name, then just copy it
1093 if Has_Fully_Qualified_Name (E) then
1094 Get_Name_String (Chars (E));
1095 Strip_Suffixes (Discard);
1096 Full_Qualify_Name (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
1097 Full_Qualify_Len := Name_Len;
1098 Set_Has_Fully_Qualified_Name (Ent);
1100 -- Case of non-fully qualified name
1103 if Scope (E) = Standard_Standard then
1104 Set_Has_Fully_Qualified_Name (Ent);
1106 Fully_Qualify_Name (Scope (E));
1107 Full_Qualify_Name (Full_Qualify_Len + 1) := '_';
1108 Full_Qualify_Name (Full_Qualify_Len + 2) := '_';
1109 Full_Qualify_Len := Full_Qualify_Len + 2;
1112 if Has_Qualified_Name (E) then
1113 Get_Unqualified_Name_String (Chars (E));
1115 Get_Name_String (Chars (E));
1118 -- A special check here, we never add internal block or loop
1119 -- names, since they intefere with debugging. We identify these
1120 -- by the fact that they start with an upper case B or L.
1121 -- But do add these if what we are qualifying is a __clean
1122 -- procedure since those need to be made unique.
1124 if (Name_Buffer (1) = 'B' or else Name_Buffer (1) = 'L')
1125 and then (not Debug_Flag_VV)
1126 and then Full_Qualify_Len > 2
1127 and then Chars (Ent) /= Name_uClean
1129 Full_Qualify_Len := Full_Qualify_Len - 2;
1133 (Full_Qualify_Len + 1 .. Full_Qualify_Len + Name_Len) :=
1134 Name_Buffer (1 .. Name_Len);
1135 Full_Qualify_Len := Full_Qualify_Len + Name_Len;
1136 Append_Homonym_Number (E);
1141 BNPE_Suffix_Needed := True;
1143 end Fully_Qualify_Name;
1149 function Is_BNPE (S : Entity_Id) return Boolean is
1152 Ekind (S) = E_Package
1153 and then Is_Package_Body_Entity (S);
1156 --------------------
1157 -- Qualify_Needed --
1158 --------------------
1160 function Qualify_Needed (S : Entity_Id) return Boolean is
1162 -- If we got all the way to Standard, then we have certainly
1163 -- fully qualified the name, so set the flag appropriately,
1164 -- and then return False, since we are most certainly done!
1166 if S = Standard_Standard then
1167 Set_Has_Fully_Qualified_Name (Ent, True);
1170 -- Otherwise figure out if further qualification is required
1176 Ekind (Ent) = E_Subprogram_Body
1178 (Ekind (S) /= E_Block
1179 and then not Is_Dynamic_Scope (S));
1183 ---------------------
1184 -- Set_BNPE_Suffix --
1185 ---------------------
1187 procedure Set_BNPE_Suffix (E : Entity_Id) is
1188 S : constant Entity_Id := Scope (E);
1191 if Qualify_Needed (S) then
1192 Set_BNPE_Suffix (S);
1195 Add_Char_To_Name_Buffer ('b');
1197 Add_Char_To_Name_Buffer ('n');
1201 Add_Char_To_Name_Buffer ('X');
1203 end Set_BNPE_Suffix;
1205 ---------------------
1206 -- Set_Entity_Name --
1207 ---------------------
1209 procedure Set_Entity_Name (E : Entity_Id) is
1210 S : constant Entity_Id := Scope (E);
1213 -- If we reach an already qualified name, just take the encoding
1214 -- except that we strip the package body suffixes, since these
1215 -- will be separately put on later.
1217 if Has_Qualified_Name (E) then
1218 Get_Name_String_And_Append (Chars (E));
1219 Strip_Suffixes (BNPE_Suffix_Needed);
1221 -- If the top level name we are adding is itself fully
1222 -- qualified, then that means that the name that we are
1223 -- preparing for the Fully_Qualify_Name call will also
1224 -- generate a fully qualified name.
1226 if Has_Fully_Qualified_Name (E) then
1227 Set_Has_Fully_Qualified_Name (Ent);
1230 -- Case where upper level name is not encoded yet
1233 -- Recurse if further qualification required
1235 if Qualify_Needed (S) then
1236 Set_Entity_Name (S);
1237 Add_Str_To_Name_Buffer ("__");
1240 -- Otherwise get name and note if it is a NPBE
1242 Get_Name_String_And_Append (Chars (E));
1245 BNPE_Suffix_Needed := True;
1248 Append_Homonym_Number (E);
1250 end Set_Entity_Name;
1252 -- Start of processing for Qualify_Entity_Name
1255 if Has_Qualified_Name (Ent) then
1258 -- Here is where we create the proper link for renaming
1260 elsif Ekind (Ent) = E_Enumeration_Literal
1261 and then Present (Debug_Renaming_Link (Ent))
1264 Qualify_Entity_Name (Debug_Renaming_Link (Ent));
1265 Get_Name_String (Chars (Ent));
1266 Prepend_String_To_Buffer
1267 (Get_Name_String (Chars (Debug_Renaming_Link (Ent))));
1268 Set_Chars (Ent, Name_Enter);
1269 Set_Has_Qualified_Name (Ent);
1272 elsif Is_Subprogram (Ent)
1273 or else Ekind (Ent) = E_Subprogram_Body
1274 or else Is_Type (Ent)
1276 Fully_Qualify_Name (Ent);
1277 Name_Len := Full_Qualify_Len;
1278 Name_Buffer (1 .. Name_Len) := Full_Qualify_Name (1 .. Name_Len);
1280 elsif Qualify_Needed (Scope (Ent)) then
1282 Set_Entity_Name (Ent);
1285 Set_Has_Qualified_Name (Ent);
1289 -- Fall through with a fully qualified name in Name_Buffer/Name_Len
1291 Output_Homonym_Numbers_Suffix;
1293 -- Add body-nested package suffix if required
1295 if BNPE_Suffix_Needed
1296 and then Ekind (Ent) /= E_Enumeration_Literal
1298 Set_BNPE_Suffix (Ent);
1300 -- Strip trailing n's and last trailing b as required. note that
1301 -- we know there is at least one b, or no suffix would be generated.
1303 while Name_Buffer (Name_Len) = 'n' loop
1304 Name_Len := Name_Len - 1;
1307 Name_Len := Name_Len - 1;
1310 Set_Chars (Ent, Name_Enter);
1311 Set_Has_Qualified_Name (Ent);
1313 if Debug_Flag_BB then
1315 Write_Name (Save_Chars);
1316 Write_Str (" qualified as ");
1317 Write_Name (Chars (Ent));
1320 end Qualify_Entity_Name;
1322 --------------------------
1323 -- Qualify_Entity_Names --
1324 --------------------------
1326 procedure Qualify_Entity_Names (N : Node_Id) is
1328 Name_Qualify_Units.Append (N);
1329 end Qualify_Entity_Names;
1331 --------------------
1332 -- Strip_Suffixes --
1333 --------------------
1335 procedure Strip_Suffixes (BNPE_Suffix_Found : in out Boolean) is
1339 -- Search for and strip BNPE suffix
1341 for J in reverse 2 .. Name_Len loop
1342 if Name_Buffer (J) = 'X' then
1344 BNPE_Suffix_Found := True;
1348 exit when Name_Buffer (J) /= 'b' and then Name_Buffer (J) /= 'n';
1351 -- Search for and strip homonym numbers suffix
1353 for J in reverse 2 .. Name_Len - 2 loop
1354 if Name_Buffer (J) = '_'
1355 and then Name_Buffer (J + 1) = '_'
1357 if Name_Buffer (J + 2) in '0' .. '9' then
1358 if Homonym_Len > 0 then
1359 Homonym_Len := Homonym_Len + 1;
1360 Homonym_Numbers (Homonym_Len) := '-';
1363 SL := Name_Len - (J + 1);
1365 Homonym_Numbers (Homonym_Len + 1 .. Homonym_Len + SL) :=
1366 Name_Buffer (J + 2 .. Name_Len);
1368 Homonym_Len := Homonym_Len + SL;