1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1996-2009, 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 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. 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 COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Alloc; use Alloc;
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Nlists; use Nlists;
31 with Nmake; use Nmake;
33 with Output; use Output;
34 with Sem_Aux; use Sem_Aux;
35 with Sem_Eval; use Sem_Eval;
36 with Sem_Util; use Sem_Util;
37 with Sinfo; use Sinfo;
38 with Stand; use Stand;
39 with Stringt; use Stringt;
41 with Targparm; use Targparm;
42 with Tbuild; use Tbuild;
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);
305 function Output_Subscript (N : Node_Id; S : String) return Boolean;
306 -- Outputs a single subscript value as ?nnn (subscript is compile time
307 -- known value with value nnn) or as ?e (subscript is local constant
308 -- with name e), where S supplies the proper string to use for ?.
309 -- Returns False if the subscript is not of an appropriate type to
310 -- output in one of these two forms. The result is prepended to the
311 -- name stored in Name_Buffer.
313 ----------------------
314 -- Output_Subscript --
315 ----------------------
317 function Output_Subscript (N : Node_Id; S : String) return Boolean is
319 if Compile_Time_Known_Value (N) then
320 Prepend_Uint_To_Buffer (Expr_Value (N));
322 elsif Nkind (N) = N_Identifier
323 and then Scope (Entity (N)) = Scope (Ent)
324 and then Ekind (Entity (N)) = E_Constant
326 Prepend_String_To_Buffer (Get_Name_String (Chars (Entity (N))));
332 Prepend_String_To_Buffer (S);
334 end Output_Subscript;
336 -- Start of processing for Debug_Renaming_Declaration
339 if not Comes_From_Source (N)
340 and then not Needs_Debug_Info (Ent)
345 -- Do not output those local variables in VM case, as this does not
346 -- help debugging (they are just unused), and might lead to duplicated
347 -- local variable names.
349 if VM_Target /= No_VM then
353 -- Get renamed entity and compute suffix
363 when N_Expanded_Name =>
365 -- The entity field for an N_Expanded_Name is on the expanded
366 -- name node itself, so we are done here too.
370 when N_Selected_Component =>
371 Prepend_String_To_Buffer
372 (Get_Name_String (Chars (Selector_Name (Ren))));
373 Prepend_String_To_Buffer ("XR");
376 when N_Indexed_Component =>
378 X : Node_Id := Last (Expressions (Ren));
381 while Present (X) loop
382 if not Output_Subscript (X, "XS") then
383 Set_Materialize_Entity (Ent);
395 Typ := Etype (First_Index (Etype (Nam)));
397 if not Output_Subscript (Type_High_Bound (Typ), "XS") then
398 Set_Materialize_Entity (Ent);
402 if not Output_Subscript (Type_Low_Bound (Typ), "XL") then
403 Set_Materialize_Entity (Ent);
409 when N_Explicit_Dereference =>
410 Set_Materialize_Entity (Ent);
411 Prepend_String_To_Buffer ("XA");
414 -- For now, anything else simply results in no translation
417 Set_Materialize_Entity (Ent);
422 Prepend_String_To_Buffer ("___XE");
424 -- Include the designation of the form of renaming
427 when N_Object_Renaming_Declaration =>
428 Prepend_String_To_Buffer ("___XR");
430 when N_Exception_Renaming_Declaration =>
431 Prepend_String_To_Buffer ("___XRE");
433 when N_Package_Renaming_Declaration =>
434 Prepend_String_To_Buffer ("___XRP");
440 -- Add the name of the renaming entity to the front
442 Prepend_String_To_Buffer (Get_Name_String (Chars (Ent)));
444 -- If it is a child unit create a fully qualified name, to disambiguate
445 -- multiple child units with the same name and different parents.
447 if Nkind (N) = N_Package_Renaming_Declaration
448 and then Is_Child_Unit (Ent)
450 Prepend_String_To_Buffer ("__");
451 Prepend_String_To_Buffer
452 (Get_Name_String (Chars (Scope (Ent))));
455 -- Create the special object whose name is the debug encoding for the
456 -- renaming declaration.
458 -- For now, the object name contains the suffix encoding for the renamed
459 -- object, but not the name of the leading entity. The object is linked
460 -- the renamed entity using the Debug_Renaming_Link field. Then the
461 -- Qualify_Entity_Name procedure uses this link to create the proper
462 -- fully qualified name.
464 -- The reason we do things this way is that we really need to copy the
465 -- qualification of the renamed entity, and it is really much easier to
466 -- do this after the renamed entity has itself been fully qualified.
468 Obj := Make_Defining_Identifier (Loc, Chars => Name_Enter);
470 Make_Object_Declaration (Loc,
471 Defining_Identifier => Obj,
472 Object_Definition => New_Reference_To
473 (Standard_Debug_Renaming_Type, Loc));
475 Set_Debug_Renaming_Link (Obj, Entity (Ren));
477 Set_Debug_Info_Needed (Obj);
479 -- Mark the object as internal so that it won't be initialized when
480 -- pragma Initialize_Scalars or Normalize_Scalars is in use.
482 Set_Is_Internal (Obj);
486 -- If we get an exception, just figure it is a case that we cannot
487 -- successfully handle using our current approach, since this is
488 -- only for debugging, no need to take the compilation with us!
492 return Make_Null_Statement (Loc);
493 end Debug_Renaming_Declaration;
495 ----------------------
496 -- Get_Encoded_Name --
497 ----------------------
499 -- Note: see spec for details on encodings
501 procedure Get_Encoded_Name (E : Entity_Id) is
502 Has_Suffix : Boolean;
505 -- If not generating code, there is no need to create encoded names, and
506 -- problems when the back-end is called to annotate types without full
507 -- code generation. See comments in Get_External_Name_With_Suffix for
508 -- additional details.
510 -- However we do create encoded names if the back end is active, even
511 -- if Operating_Mode got reset. Otherwise any serious error reported
512 -- by the backend calling Error_Msg changes the Compilation_Mode to
513 -- Check_Semantics, which disables the functionality of this routine,
514 -- causing the generation of spurious additional errors.
516 -- Couldn't we just test Original_Operating_Mode here? ???
518 if Operating_Mode /= Generate_Code
519 and then not Generating_Code
524 Get_Name_String (Chars (E));
526 -- Nothing to do if we do not have a type
530 -- Or if this is an enumeration base type
532 or else (Is_Enumeration_Type (E)
533 and then E = Base_Type (E))
535 -- Or if this is a dummy type for a renaming
537 or else (Name_Len >= 3 and then
538 Name_Buffer (Name_Len - 2 .. Name_Len) = "_XR")
540 or else (Name_Len >= 4 and then
541 (Name_Buffer (Name_Len - 3 .. Name_Len) = "_XRE"
543 Name_Buffer (Name_Len - 3 .. Name_Len) = "_XRP"))
545 -- For all these cases, just return the name unchanged
548 Name_Buffer (Name_Len + 1) := ASCII.NUL;
556 if Is_Fixed_Point_Type (E) then
557 Get_External_Name_With_Suffix (E, "XF_");
558 Add_Real_To_Buffer (Delta_Value (E));
560 if Small_Value (E) /= Delta_Value (E) then
561 Add_Str_To_Name_Buffer ("_");
562 Add_Real_To_Buffer (Small_Value (E));
565 -- Vax floating-point case
567 elsif Vax_Float (E) then
568 if Digits_Value (Base_Type (E)) = 6 then
569 Get_External_Name_With_Suffix (E, "XFF");
571 elsif Digits_Value (Base_Type (E)) = 9 then
572 Get_External_Name_With_Suffix (E, "XFF");
575 pragma Assert (Digits_Value (Base_Type (E)) = 15);
576 Get_External_Name_With_Suffix (E, "XFG");
579 -- Discrete case where bounds do not match size
581 elsif Is_Discrete_Type (E)
582 and then not Bounds_Match_Size (E)
585 Lo : constant Node_Id := Type_Low_Bound (E);
586 Hi : constant Node_Id := Type_High_Bound (E);
588 Lo_Con : constant Boolean := Compile_Time_Known_Value (Lo);
589 Hi_Con : constant Boolean := Compile_Time_Known_Value (Hi);
591 Lo_Discr : constant Boolean :=
592 Nkind (Lo) = N_Identifier
594 Ekind (Entity (Lo)) = E_Discriminant;
596 Hi_Discr : constant Boolean :=
597 Nkind (Hi) = N_Identifier
599 Ekind (Entity (Hi)) = E_Discriminant;
601 Lo_Encode : constant Boolean := Lo_Con or Lo_Discr;
602 Hi_Encode : constant Boolean := Hi_Con or Hi_Discr;
604 Biased : constant Boolean := Has_Biased_Representation (E);
608 Get_External_Name_With_Suffix (E, "XB");
610 Get_External_Name_With_Suffix (E, "XD");
613 if Lo_Encode or Hi_Encode then
615 Add_Str_To_Name_Buffer ("_");
619 Add_Str_To_Name_Buffer ("LU_");
621 Add_Str_To_Name_Buffer ("L_");
624 Add_Str_To_Name_Buffer ("U_");
629 Add_Uint_To_Buffer (Expr_Rep_Value (Lo));
631 Get_Name_String_And_Append (Chars (Entity (Lo)));
634 if Lo_Encode and Hi_Encode then
635 Add_Str_To_Name_Buffer ("__");
639 Add_Uint_To_Buffer (Expr_Rep_Value (Hi));
641 Get_Name_String_And_Append (Chars (Entity (Hi)));
646 -- For all other cases, the encoded name is the normal type name
650 Get_External_Name (E, Has_Suffix);
653 if Debug_Flag_B and then Has_Suffix then
654 Write_Str ("**** type ");
655 Write_Name (Chars (E));
656 Write_Str (" is encoded as ");
657 Write_Str (Name_Buffer (1 .. Name_Len));
661 Name_Buffer (Name_Len + 1) := ASCII.NUL;
662 end Get_Encoded_Name;
664 -----------------------
665 -- Get_External_Name --
666 -----------------------
668 procedure Get_External_Name (Entity : Entity_Id; Has_Suffix : Boolean) is
669 E : Entity_Id := Entity;
672 procedure Get_Qualified_Name_And_Append (Entity : Entity_Id);
673 -- Appends fully qualified name of given entity to Name_Buffer
675 -----------------------------------
676 -- Get_Qualified_Name_And_Append --
677 -----------------------------------
679 procedure Get_Qualified_Name_And_Append (Entity : Entity_Id) is
681 -- If the entity is a compilation unit, its scope is Standard,
682 -- there is no outer scope, and the no further qualification
685 -- If the front end has already computed a fully qualified name,
686 -- then it is also the case that no further qualification is
689 if Present (Scope (Scope (Entity)))
690 and then not Has_Fully_Qualified_Name (Entity)
692 Get_Qualified_Name_And_Append (Scope (Entity));
693 Add_Str_To_Name_Buffer ("__");
694 Get_Name_String_And_Append (Chars (Entity));
695 Append_Homonym_Number (Entity);
698 Get_Name_String_And_Append (Chars (Entity));
700 end Get_Qualified_Name_And_Append;
702 -- Start of processing for Get_External_Name
708 -- If this is a child unit, we want the child
710 if Nkind (E) = N_Defining_Program_Unit_Name then
711 E := Defining_Identifier (Entity);
716 -- Case of interface name being used
718 if (Kind = E_Procedure or else
719 Kind = E_Function or else
720 Kind = E_Constant or else
721 Kind = E_Variable or else
723 and then Present (Interface_Name (E))
724 and then No (Address_Clause (E))
725 and then not Has_Suffix
727 Add_String_To_Name_Buffer (Strval (Interface_Name (E)));
729 -- All other cases besides the interface name case
732 -- If this is a library level subprogram (i.e. a subprogram that is a
733 -- compilation unit other than a subunit), then we prepend _ada_ to
734 -- ensure distinctions required as described in the spec.
736 -- Check explicitly for child units, because those are not flagged
737 -- as Compilation_Units by lib. Should they be ???
740 and then (Is_Compilation_Unit (E) or Is_Child_Unit (E))
741 and then not Has_Suffix
743 Add_Str_To_Name_Buffer ("_ada_");
746 -- If the entity is a subprogram instance that is not a compilation
747 -- unit, generate the name of the original Ada entity, which is the
750 if Is_Generic_Instance (E)
751 and then Is_Subprogram (E)
752 and then not Is_Compilation_Unit (Scope (E))
753 and then (Ekind (Scope (E)) = E_Package
755 Ekind (Scope (E)) = E_Package_Body)
756 and then Present (Related_Instance (Scope (E)))
758 E := Related_Instance (Scope (E));
761 Get_Qualified_Name_And_Append (E);
764 Name_Buffer (Name_Len + 1) := ASCII.NUL;
765 end Get_External_Name;
767 -----------------------------------
768 -- Get_External_Name_With_Suffix --
769 -----------------------------------
771 procedure Get_External_Name_With_Suffix
775 Has_Suffix : constant Boolean := (Suffix /= "");
778 -- If we are not in code generation mode, this procedure may still be
779 -- called from Back_End (more specifically - from gigi for doing type
780 -- representation annotation or some representation-specific checks).
781 -- But in this mode there is no need to mess with external names.
783 -- Furthermore, the call causes difficulties in this case because the
784 -- string representing the homonym number is not correctly reset as a
785 -- part of the call to Output_Homonym_Numbers_Suffix (which is not
788 if Operating_Mode /= Generate_Code then
792 Get_External_Name (Entity, Has_Suffix);
795 Add_Str_To_Name_Buffer ("___");
796 Add_Str_To_Name_Buffer (Suffix);
797 Name_Buffer (Name_Len + 1) := ASCII.NUL;
799 end Get_External_Name_With_Suffix;
801 --------------------------
802 -- Get_Variant_Encoding --
803 --------------------------
805 procedure Get_Variant_Encoding (V : Node_Id) is
808 procedure Choice_Val (Typ : Character; Choice : Node_Id);
809 -- Output encoded value for a single choice value. Typ is the key
810 -- character ('S', 'F', or 'T') that precedes the choice value.
816 procedure Choice_Val (Typ : Character; Choice : Node_Id) is
818 if Nkind (Choice) = N_Integer_Literal then
819 Add_Char_To_Name_Buffer (Typ);
820 Add_Uint_To_Buffer (Intval (Choice));
822 -- Character literal with no entity present (this is the case
823 -- Standard.Character or Standard.Wide_Character as root type)
825 elsif Nkind (Choice) = N_Character_Literal
826 and then No (Entity (Choice))
828 Add_Char_To_Name_Buffer (Typ);
829 Add_Uint_To_Buffer (Char_Literal_Value (Choice));
833 Ent : constant Entity_Id := Entity (Choice);
836 if Ekind (Ent) = E_Enumeration_Literal then
837 Add_Char_To_Name_Buffer (Typ);
838 Add_Uint_To_Buffer (Enumeration_Rep (Ent));
841 pragma Assert (Ekind (Ent) = E_Constant);
842 Choice_Val (Typ, Constant_Value (Ent));
848 -- Start of processing for Get_Variant_Encoding
853 Choice := First (Discrete_Choices (V));
854 while Present (Choice) loop
855 if Nkind (Choice) = N_Others_Choice then
856 Add_Char_To_Name_Buffer ('O');
858 elsif Nkind (Choice) = N_Range then
859 Choice_Val ('R', Low_Bound (Choice));
860 Choice_Val ('T', High_Bound (Choice));
862 elsif Is_Entity_Name (Choice)
863 and then Is_Type (Entity (Choice))
865 Choice_Val ('R', Type_Low_Bound (Entity (Choice)));
866 Choice_Val ('T', Type_High_Bound (Entity (Choice)));
868 elsif Nkind (Choice) = N_Subtype_Indication then
870 Rang : constant Node_Id :=
871 Range_Expression (Constraint (Choice));
873 Choice_Val ('R', Low_Bound (Rang));
874 Choice_Val ('T', High_Bound (Rang));
878 Choice_Val ('S', Choice);
884 Name_Buffer (Name_Len + 1) := ASCII.NUL;
888 VP : constant Node_Id := Parent (V); -- Variant_Part
889 CL : constant Node_Id := Parent (VP); -- Component_List
890 RD : constant Node_Id := Parent (CL); -- Record_Definition
891 FT : constant Node_Id := Parent (RD); -- Full_Type_Declaration
894 Write_Str ("**** variant for type ");
895 Write_Name (Chars (Defining_Identifier (FT)));
896 Write_Str (" is encoded as ");
897 Write_Str (Name_Buffer (1 .. Name_Len));
901 end Get_Variant_Encoding;
903 ------------------------------------
904 -- Get_Secondary_DT_External_Name --
905 ------------------------------------
907 procedure Get_Secondary_DT_External_Name
909 Ancestor_Typ : Entity_Id;
913 Get_External_Name (Typ, Has_Suffix => False);
915 if Ancestor_Typ /= Typ then
917 Len : constant Natural := Name_Len;
918 Save_Str : constant String (1 .. Name_Len)
919 := Name_Buffer (1 .. Name_Len);
921 Get_External_Name (Ancestor_Typ, Has_Suffix => False);
923 -- Append the extended name of the ancestor to the
924 -- extended name of Typ
926 Name_Buffer (Len + 2 .. Len + Name_Len + 1) :=
927 Name_Buffer (1 .. Name_Len);
928 Name_Buffer (1 .. Len) := Save_Str;
929 Name_Buffer (Len + 1) := '_';
930 Name_Len := Len + Name_Len + 1;
934 Add_Nat_To_Name_Buffer (Suffix_Index);
935 end Get_Secondary_DT_External_Name;
937 ---------------------------------
938 -- Make_Packed_Array_Type_Name --
939 ---------------------------------
941 function Make_Packed_Array_Type_Name
947 Get_Name_String (Chars (Typ));
948 Add_Str_To_Name_Buffer ("___XP");
949 Add_Uint_To_Buffer (Csize);
951 end Make_Packed_Array_Type_Name;
953 -----------------------------------
954 -- Output_Homonym_Numbers_Suffix --
955 -----------------------------------
957 procedure Output_Homonym_Numbers_Suffix is
961 if Homonym_Len > 0 then
963 -- Check for all 1's, in which case we do not output
967 exit when Homonym_Numbers (J) /= '1';
969 -- If we reached end of string we do not output
971 if J = Homonym_Len then
976 exit when Homonym_Numbers (J + 1) /= '_';
980 -- If we exit the loop then suffix must be output
982 Add_Str_To_Name_Buffer ("__");
983 Add_Str_To_Name_Buffer (Homonym_Numbers (1 .. Homonym_Len));
986 end Output_Homonym_Numbers_Suffix;
988 ------------------------------
989 -- Prepend_String_To_Buffer --
990 ------------------------------
992 procedure Prepend_String_To_Buffer (S : String) is
993 N : constant Integer := S'Length;
995 Name_Buffer (1 + N .. Name_Len + N) := Name_Buffer (1 .. Name_Len);
996 Name_Buffer (1 .. N) := S;
997 Name_Len := Name_Len + N;
998 end Prepend_String_To_Buffer;
1000 ----------------------------
1001 -- Prepend_Uint_To_Buffer --
1002 ----------------------------
1004 procedure Prepend_Uint_To_Buffer (U : Uint) is
1007 Prepend_String_To_Buffer ("m");
1008 Prepend_Uint_To_Buffer (-U);
1010 UI_Image (U, Decimal);
1011 Prepend_String_To_Buffer (UI_Image_Buffer (1 .. UI_Image_Length));
1013 end Prepend_Uint_To_Buffer;
1015 ------------------------------
1016 -- Qualify_All_Entity_Names --
1017 ------------------------------
1019 procedure Qualify_All_Entity_Names is
1024 for J in Name_Qualify_Units.First .. Name_Qualify_Units.Last loop
1025 E := Defining_Entity (Name_Qualify_Units.Table (J));
1026 Qualify_Entity_Name (E);
1028 -- Normally entities in the qualification list are scopes, but in the
1029 -- case of a library-level package renaming there is an associated
1030 -- variable that encodes the debugger name and that variable is
1031 -- entered in the list since it occurs in the Aux_Decls list of the
1032 -- compilation and doesn't have a normal scope.
1034 if Ekind (E) /= E_Variable then
1035 Ent := First_Entity (E);
1036 while Present (Ent) loop
1037 Qualify_Entity_Name (Ent);
1040 -- There are odd cases where Last_Entity (E) = E. This happens
1041 -- in the case of renaming of packages. This test avoids
1042 -- getting stuck in such cases.
1048 end Qualify_All_Entity_Names;
1050 -------------------------
1051 -- Qualify_Entity_Name --
1052 -------------------------
1054 procedure Qualify_Entity_Name (Ent : Entity_Id) is
1056 Full_Qualify_Name : String (1 .. Name_Buffer'Length);
1057 Full_Qualify_Len : Natural := 0;
1058 -- Used to accumulate fully qualified name of subprogram
1060 procedure Fully_Qualify_Name (E : Entity_Id);
1061 -- Used to qualify a subprogram or type name, where full
1062 -- qualification up to Standard is always used. Name is set
1063 -- in Full_Qualify_Name with the length in Full_Qualify_Len.
1064 -- Note that this routine does not prepend the _ada_ string
1065 -- required for library subprograms (this is done in the back end).
1067 function Is_BNPE (S : Entity_Id) return Boolean;
1068 -- Determines if S is a BNPE, i.e. Body-Nested Package Entity, which
1069 -- is defined to be a package which is immediately nested within a
1072 function Qualify_Needed (S : Entity_Id) return Boolean;
1073 -- Given a scope, determines if the scope is to be included in the
1074 -- fully qualified name, True if so, False if not.
1076 procedure Set_BNPE_Suffix (E : Entity_Id);
1077 -- Recursive routine to append the BNPE qualification suffix. Works
1078 -- from right to left with E being the current entity in the list.
1079 -- The result does NOT have the trailing n's and trailing b stripped.
1080 -- The caller must do this required stripping.
1082 procedure Set_Entity_Name (E : Entity_Id);
1083 -- Internal recursive routine that does most of the work. This routine
1084 -- leaves the result sitting in Name_Buffer and Name_Len.
1086 BNPE_Suffix_Needed : Boolean := False;
1087 -- Set true if a body-nested package entity suffix is required
1089 Save_Chars : constant Name_Id := Chars (Ent);
1090 -- Save original name
1092 ------------------------
1093 -- Fully_Qualify_Name --
1094 ------------------------
1096 procedure Fully_Qualify_Name (E : Entity_Id) is
1097 Discard : Boolean := False;
1100 -- Ignore empty entry (can happen in error cases)
1105 -- If this we are qualifying entities local to a generic
1106 -- instance, use the name of the original instantiation,
1107 -- not that of the anonymous subprogram in the wrapper
1108 -- package, so that gdb doesn't have to know about these.
1110 elsif Is_Generic_Instance (E)
1111 and then Is_Subprogram (E)
1112 and then not Comes_From_Source (E)
1113 and then not Is_Compilation_Unit (Scope (E))
1115 Fully_Qualify_Name (Related_Instance (Scope (E)));
1119 -- If we reached fully qualified name, then just copy it
1121 if Has_Fully_Qualified_Name (E) then
1122 Get_Name_String (Chars (E));
1123 Strip_Suffixes (Discard);
1124 Full_Qualify_Name (1 .. Name_Len) := Name_Buffer (1 .. Name_Len);
1125 Full_Qualify_Len := Name_Len;
1126 Set_Has_Fully_Qualified_Name (Ent);
1128 -- Case of non-fully qualified name
1131 if Scope (E) = Standard_Standard then
1132 Set_Has_Fully_Qualified_Name (Ent);
1134 Fully_Qualify_Name (Scope (E));
1135 Full_Qualify_Name (Full_Qualify_Len + 1) := '_';
1136 Full_Qualify_Name (Full_Qualify_Len + 2) := '_';
1137 Full_Qualify_Len := Full_Qualify_Len + 2;
1140 if Has_Qualified_Name (E) then
1141 Get_Unqualified_Name_String (Chars (E));
1143 Get_Name_String (Chars (E));
1146 -- Here we do one step of the qualification
1149 (Full_Qualify_Len + 1 .. Full_Qualify_Len + Name_Len) :=
1150 Name_Buffer (1 .. Name_Len);
1151 Full_Qualify_Len := Full_Qualify_Len + Name_Len;
1152 Append_Homonym_Number (E);
1156 BNPE_Suffix_Needed := True;
1158 end Fully_Qualify_Name;
1164 function Is_BNPE (S : Entity_Id) return Boolean is
1167 Ekind (S) = E_Package
1168 and then Is_Package_Body_Entity (S);
1171 --------------------
1172 -- Qualify_Needed --
1173 --------------------
1175 function Qualify_Needed (S : Entity_Id) return Boolean is
1177 -- If we got all the way to Standard, then we have certainly
1178 -- fully qualified the name, so set the flag appropriately,
1179 -- and then return False, since we are most certainly done!
1181 if S = Standard_Standard then
1182 Set_Has_Fully_Qualified_Name (Ent, True);
1185 -- Otherwise figure out if further qualification is required
1191 Ekind (Ent) = E_Subprogram_Body
1193 (Ekind (S) /= E_Block
1194 and then not Is_Dynamic_Scope (S));
1198 ---------------------
1199 -- Set_BNPE_Suffix --
1200 ---------------------
1202 procedure Set_BNPE_Suffix (E : Entity_Id) is
1203 S : constant Entity_Id := Scope (E);
1206 if Qualify_Needed (S) then
1207 Set_BNPE_Suffix (S);
1210 Add_Char_To_Name_Buffer ('b');
1212 Add_Char_To_Name_Buffer ('n');
1216 Add_Char_To_Name_Buffer ('X');
1218 end Set_BNPE_Suffix;
1220 ---------------------
1221 -- Set_Entity_Name --
1222 ---------------------
1224 procedure Set_Entity_Name (E : Entity_Id) is
1225 S : constant Entity_Id := Scope (E);
1228 -- If we reach an already qualified name, just take the encoding
1229 -- except that we strip the package body suffixes, since these
1230 -- will be separately put on later.
1232 if Has_Qualified_Name (E) then
1233 Get_Name_String_And_Append (Chars (E));
1234 Strip_Suffixes (BNPE_Suffix_Needed);
1236 -- If the top level name we are adding is itself fully
1237 -- qualified, then that means that the name that we are
1238 -- preparing for the Fully_Qualify_Name call will also
1239 -- generate a fully qualified name.
1241 if Has_Fully_Qualified_Name (E) then
1242 Set_Has_Fully_Qualified_Name (Ent);
1245 -- Case where upper level name is not encoded yet
1248 -- Recurse if further qualification required
1250 if Qualify_Needed (S) then
1251 Set_Entity_Name (S);
1252 Add_Str_To_Name_Buffer ("__");
1255 -- Otherwise get name and note if it is a BNPE
1257 Get_Name_String_And_Append (Chars (E));
1260 BNPE_Suffix_Needed := True;
1263 Append_Homonym_Number (E);
1265 end Set_Entity_Name;
1267 -- Start of processing for Qualify_Entity_Name
1270 if Has_Qualified_Name (Ent) then
1273 -- If the entity is a variable encoding the debug name for an object
1274 -- renaming, then the qualified name of the entity associated with the
1275 -- renamed object can now be incorporated in the debug name.
1277 elsif Ekind (Ent) = E_Variable
1278 and then Present (Debug_Renaming_Link (Ent))
1281 Qualify_Entity_Name (Debug_Renaming_Link (Ent));
1282 Get_Name_String (Chars (Ent));
1284 -- Retrieve the now-qualified name of the renamed entity and insert
1285 -- it in the middle of the name, just preceding the suffix encoding
1286 -- describing the renamed object.
1289 Renamed_Id : constant String :=
1290 Get_Name_String (Chars (Debug_Renaming_Link (Ent)));
1291 Insert_Len : constant Integer := Renamed_Id'Length + 1;
1292 Index : Natural := Name_Len - 3;
1295 -- Loop backwards through the name to find the start of the "___"
1296 -- sequence associated with the suffix.
1298 while Index >= Name_Buffer'First
1299 and then (Name_Buffer (Index + 1) /= '_'
1300 or else Name_Buffer (Index + 2) /= '_'
1301 or else Name_Buffer (Index + 3) /= '_')
1306 pragma Assert (Name_Buffer (Index + 1 .. Index + 3) = "___");
1308 -- Insert an underscore separator and the entity name just in
1309 -- front of the suffix.
1311 Name_Buffer (Index + 1 + Insert_Len .. Name_Len + Insert_Len) :=
1312 Name_Buffer (Index + 1 .. Name_Len);
1313 Name_Buffer (Index + 1) := '_';
1314 Name_Buffer (Index + 2 .. Index + Insert_Len) := Renamed_Id;
1315 Name_Len := Name_Len + Insert_Len;
1318 -- Reset the name of the variable to the new name that includes the
1319 -- name of the renamed entity.
1321 Set_Chars (Ent, Name_Enter);
1323 -- If the entity needs qualification by its scope then develop it
1324 -- here, add the variable's name, and again reset the entity name.
1326 if Qualify_Needed (Scope (Ent)) then
1328 Set_Entity_Name (Scope (Ent));
1329 Add_Str_To_Name_Buffer ("__");
1331 Get_Name_String_And_Append (Chars (Ent));
1333 Set_Chars (Ent, Name_Enter);
1336 Set_Has_Qualified_Name (Ent);
1339 elsif Is_Subprogram (Ent)
1340 or else Ekind (Ent) = E_Subprogram_Body
1341 or else Is_Type (Ent)
1343 Fully_Qualify_Name (Ent);
1344 Name_Len := Full_Qualify_Len;
1345 Name_Buffer (1 .. Name_Len) := Full_Qualify_Name (1 .. Name_Len);
1347 elsif Qualify_Needed (Scope (Ent)) then
1349 Set_Entity_Name (Ent);
1352 Set_Has_Qualified_Name (Ent);
1356 -- Fall through with a fully qualified name in Name_Buffer/Name_Len
1358 Output_Homonym_Numbers_Suffix;
1360 -- Add body-nested package suffix if required
1362 if BNPE_Suffix_Needed
1363 and then Ekind (Ent) /= E_Enumeration_Literal
1365 Set_BNPE_Suffix (Ent);
1367 -- Strip trailing n's and last trailing b as required. note that
1368 -- we know there is at least one b, or no suffix would be generated.
1370 while Name_Buffer (Name_Len) = 'n' loop
1371 Name_Len := Name_Len - 1;
1374 Name_Len := Name_Len - 1;
1377 Set_Chars (Ent, Name_Enter);
1378 Set_Has_Qualified_Name (Ent);
1380 if Debug_Flag_BB then
1382 Write_Name (Save_Chars);
1383 Write_Str (" qualified as ");
1384 Write_Name (Chars (Ent));
1387 end Qualify_Entity_Name;
1389 --------------------------
1390 -- Qualify_Entity_Names --
1391 --------------------------
1393 procedure Qualify_Entity_Names (N : Node_Id) is
1395 Name_Qualify_Units.Append (N);
1396 end Qualify_Entity_Names;
1398 --------------------
1399 -- Strip_Suffixes --
1400 --------------------
1402 procedure Strip_Suffixes (BNPE_Suffix_Found : in out Boolean) is
1405 pragma Warnings (Off, BNPE_Suffix_Found);
1406 -- Since this procedure only ever sets the flag
1409 -- Search for and strip BNPE suffix
1411 for J in reverse 2 .. Name_Len loop
1412 if Name_Buffer (J) = 'X' then
1414 BNPE_Suffix_Found := True;
1418 exit when Name_Buffer (J) /= 'b' and then Name_Buffer (J) /= 'n';
1421 -- Search for and strip homonym numbers suffix
1423 for J in reverse 2 .. Name_Len - 2 loop
1424 if Name_Buffer (J) = '_'
1425 and then Name_Buffer (J + 1) = '_'
1427 if Name_Buffer (J + 2) in '0' .. '9' then
1428 if Homonym_Len > 0 then
1429 Homonym_Len := Homonym_Len + 1;
1430 Homonym_Numbers (Homonym_Len) := '-';
1433 SL := Name_Len - (J + 1);
1435 Homonym_Numbers (Homonym_Len + 1 .. Homonym_Len + SL) :=
1436 Name_Buffer (J + 2 .. Name_Len);
1438 Homonym_Len := Homonym_Len + SL;