1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1996-2013, 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 gather
109 -- the homonym string that will be appended to Name_Buffer when the name
110 -- is complete. Strip_Suffixes appends to this string as does
111 -- Append_Homonym_Number, and Output_Homonym_Numbers_Suffix appends the
112 -- 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 Reset_Buffers
;
151 -- Reset the contents of Name_Buffer and Homonym_Numbers by setting their
152 -- respective lengths to zero.
154 procedure Strip_Suffixes
(BNPE_Suffix_Found
: in out Boolean);
155 -- Given an qualified entity name in Name_Buffer, remove any plain X or
156 -- X{nb} qualification suffix. The contents of Name_Buffer is not changed
157 -- but Name_Len may be adjusted on return to remove the suffix. If a
158 -- BNPE suffix is found and stripped, then BNPE_Suffix_Found is set to
159 -- True. If no suffix is found, then BNPE_Suffix_Found is not modified.
160 -- This routine also searches for a homonym suffix, and if one is found
161 -- it is also stripped, and the entries are added to the global homonym
162 -- list (Homonym_Numbers) so that they can later be put back.
164 ------------------------
165 -- Add_Real_To_Buffer --
166 ------------------------
168 procedure Add_Real_To_Buffer
(U
: Ureal
) is
170 Add_Uint_To_Buffer
(Norm_Num
(U
));
171 Add_Str_To_Name_Buffer
("_");
172 Add_Uint_To_Buffer
(Norm_Den
(U
));
173 end Add_Real_To_Buffer
;
175 ------------------------
176 -- Add_Uint_To_Buffer --
177 ------------------------
179 procedure Add_Uint_To_Buffer
(U
: Uint
) is
182 Add_Uint_To_Buffer
(-U
);
183 Add_Char_To_Name_Buffer
('m');
185 UI_Image
(U
, Decimal
);
186 Add_Str_To_Name_Buffer
(UI_Image_Buffer
(1 .. UI_Image_Length
));
188 end Add_Uint_To_Buffer
;
190 ---------------------------
191 -- Append_Homonym_Number --
192 ---------------------------
194 procedure Append_Homonym_Number
(E
: Entity_Id
) is
196 procedure Add_Nat_To_H
(Nr
: Nat
);
197 -- Little procedure to append Nr to Homonym_Numbers
203 procedure Add_Nat_To_H
(Nr
: Nat
) is
206 Add_Nat_To_H
(Nr
/ 10);
209 Homonym_Len
:= Homonym_Len
+ 1;
210 Homonym_Numbers
(Homonym_Len
) :=
211 Character'Val (Nr
mod 10 + Character'Pos ('0'));
214 -- Start of processing for Append_Homonym_Number
217 if Has_Homonym
(E
) then
219 H
: Entity_Id
:= Homonym
(E
);
223 while Present
(H
) loop
224 if Scope
(H
) = Scope
(E
) then
231 if Homonym_Len
> 0 then
232 Homonym_Len
:= Homonym_Len
+ 1;
233 Homonym_Numbers
(Homonym_Len
) := '_';
239 end Append_Homonym_Number
;
241 -----------------------
242 -- Bounds_Match_Size --
243 -----------------------
245 function Bounds_Match_Size
(E
: Entity_Id
) return Boolean is
249 if not Is_OK_Static_Subtype
(E
) then
252 elsif Is_Integer_Type
(E
)
253 and then Subtypes_Statically_Match
(E
, Base_Type
(E
))
257 -- Here we check if the static bounds match the natural size, which is
258 -- the size passed through with the debugging information. This is the
259 -- Esize rounded up to 8, 16, 32 or 64 as appropriate.
263 Umark
: constant Uintp
.Save_Mark
:= Uintp
.Mark
;
267 if Esize
(E
) <= 8 then
269 elsif Esize
(E
) <= 16 then
271 elsif Esize
(E
) <= 32 then
277 if Is_Modular_Integer_Type
(E
) or else Is_Enumeration_Type
(E
) then
279 Expr_Rep_Value
(Type_Low_Bound
(E
)) = 0
281 2 ** Siz
- Expr_Rep_Value
(Type_High_Bound
(E
)) = 1;
285 Expr_Rep_Value
(Type_Low_Bound
(E
)) + 2 ** (Siz
- 1) = 0
287 2 ** (Siz
- 1) - Expr_Rep_Value
(Type_High_Bound
(E
)) = 1;
294 end Bounds_Match_Size
;
296 --------------------------------
297 -- Debug_Renaming_Declaration --
298 --------------------------------
300 function Debug_Renaming_Declaration
(N
: Node_Id
) return Node_Id
is
301 Loc
: constant Source_Ptr
:= Sloc
(N
);
302 Ent
: constant Node_Id
:= Defining_Entity
(N
);
303 Nam
: constant Node_Id
:= Name
(N
);
309 function Output_Subscript
(N
: Node_Id
; S
: String) return Boolean;
310 -- Outputs a single subscript value as ?nnn (subscript is compile time
311 -- known value with value nnn) or as ?e (subscript is local constant
312 -- with name e), where S supplies the proper string to use for ?.
313 -- Returns False if the subscript is not of an appropriate type to
314 -- output in one of these two forms. The result is prepended to the
315 -- name stored in Name_Buffer.
317 ----------------------
318 -- Output_Subscript --
319 ----------------------
321 function Output_Subscript
(N
: Node_Id
; S
: String) return Boolean is
323 if Compile_Time_Known_Value
(N
) then
324 Prepend_Uint_To_Buffer
(Expr_Value
(N
));
326 elsif Nkind
(N
) = N_Identifier
327 and then Scope
(Entity
(N
)) = Scope
(Ent
)
328 and then Ekind
(Entity
(N
)) = E_Constant
330 Prepend_String_To_Buffer
(Get_Name_String
(Chars
(Entity
(N
))));
336 Prepend_String_To_Buffer
(S
);
338 end Output_Subscript
;
340 -- Start of processing for Debug_Renaming_Declaration
343 if not Comes_From_Source
(N
)
344 and then not Needs_Debug_Info
(Ent
)
349 -- Do not output those local variables in VM case, as this does not
350 -- help debugging (they are just unused), and might lead to duplicated
351 -- local variable names.
353 if VM_Target
/= No_VM
then
357 -- Get renamed entity and compute suffix
367 when N_Expanded_Name
=>
369 -- The entity field for an N_Expanded_Name is on the expanded
370 -- name node itself, so we are done here too.
374 when N_Selected_Component
=>
375 Prepend_String_To_Buffer
376 (Get_Name_String
(Chars
(Selector_Name
(Ren
))));
377 Prepend_String_To_Buffer
("XR");
380 when N_Indexed_Component
=>
382 X
: Node_Id
:= Last
(Expressions
(Ren
));
385 while Present
(X
) loop
386 if not Output_Subscript
(X
, "XS") then
387 Set_Materialize_Entity
(Ent
);
399 Typ
:= Etype
(First_Index
(Etype
(Nam
)));
401 if not Output_Subscript
(Type_High_Bound
(Typ
), "XS") then
402 Set_Materialize_Entity
(Ent
);
406 if not Output_Subscript
(Type_Low_Bound
(Typ
), "XL") then
407 Set_Materialize_Entity
(Ent
);
413 when N_Explicit_Dereference
=>
414 Prepend_String_To_Buffer
("XA");
417 -- For now, anything else simply results in no translation
420 Set_Materialize_Entity
(Ent
);
425 Prepend_String_To_Buffer
("___XE");
427 -- Include the designation of the form of renaming
430 when N_Object_Renaming_Declaration
=>
431 Prepend_String_To_Buffer
("___XR");
433 when N_Exception_Renaming_Declaration
=>
434 Prepend_String_To_Buffer
("___XRE");
436 when N_Package_Renaming_Declaration
=>
437 Prepend_String_To_Buffer
("___XRP");
443 -- Add the name of the renaming entity to the front
445 Prepend_String_To_Buffer
(Get_Name_String
(Chars
(Ent
)));
447 -- If it is a child unit create a fully qualified name, to disambiguate
448 -- multiple child units with the same name and different parents.
450 if Nkind
(N
) = N_Package_Renaming_Declaration
451 and then Is_Child_Unit
(Ent
)
453 Prepend_String_To_Buffer
("__");
454 Prepend_String_To_Buffer
455 (Get_Name_String
(Chars
(Scope
(Ent
))));
458 -- Create the special object whose name is the debug encoding for the
459 -- renaming declaration.
461 -- For now, the object name contains the suffix encoding for the renamed
462 -- object, but not the name of the leading entity. The object is linked
463 -- the renamed entity using the Debug_Renaming_Link field. Then the
464 -- Qualify_Entity_Name procedure uses this link to create the proper
465 -- fully qualified name.
467 -- The reason we do things this way is that we really need to copy the
468 -- qualification of the renamed entity, and it is really much easier to
469 -- do this after the renamed entity has itself been fully qualified.
471 Obj
:= Make_Defining_Identifier
(Loc
, Chars
=> Name_Enter
);
473 Make_Object_Declaration
(Loc
,
474 Defining_Identifier
=> Obj
,
475 Object_Definition
=> New_Occurrence_Of
476 (Standard_Debug_Renaming_Type
, Loc
));
478 Set_Debug_Renaming_Link
(Obj
, Entity
(Ren
));
480 Set_Debug_Info_Needed
(Obj
);
482 -- Mark the object as internal so that it won't be initialized when
483 -- pragma Initialize_Scalars or Normalize_Scalars is in use.
485 Set_Is_Internal
(Obj
);
489 -- If we get an exception, just figure it is a case that we cannot
490 -- successfully handle using our current approach, since this is
491 -- only for debugging, no need to take the compilation with us.
495 return Make_Null_Statement
(Loc
);
496 end Debug_Renaming_Declaration
;
498 ----------------------
499 -- Get_Encoded_Name --
500 ----------------------
502 -- Note: see spec for details on encodings
504 procedure Get_Encoded_Name
(E
: Entity_Id
) is
505 Has_Suffix
: Boolean;
508 -- If not generating code, there is no need to create encoded names, and
509 -- problems when the back-end is called to annotate types without full
510 -- code generation. See comments in Get_External_Name for additional
513 -- However we do create encoded names if the back end is active, even
514 -- if Operating_Mode got reset. Otherwise any serious error reported
515 -- by the backend calling Error_Msg changes the Compilation_Mode to
516 -- Check_Semantics, which disables the functionality of this routine,
517 -- causing the generation of spurious additional errors.
519 -- Couldn't we just test Original_Operating_Mode here? ???
521 if Operating_Mode
/= Generate_Code
522 and then not Generating_Code
527 Get_Name_String
(Chars
(E
));
529 -- Nothing to do if we do not have a type
533 -- Or if this is an enumeration base type
535 or else (Is_Enumeration_Type
(E
) and then Is_Base_Type
(E
))
537 -- Or if this is a dummy type for a renaming
539 or else (Name_Len
>= 3 and then
540 Name_Buffer
(Name_Len
- 2 .. Name_Len
) = "_XR")
542 or else (Name_Len
>= 4 and then
543 (Name_Buffer
(Name_Len
- 3 .. Name_Len
) = "_XRE"
545 Name_Buffer
(Name_Len
- 3 .. Name_Len
) = "_XRP"))
547 -- For all these cases, just return the name unchanged
550 Name_Buffer
(Name_Len
+ 1) := ASCII
.NUL
;
558 if Is_Fixed_Point_Type
(E
) then
559 Get_External_Name
(E
, True, "XF_");
560 Add_Real_To_Buffer
(Delta_Value
(E
));
562 if Small_Value
(E
) /= Delta_Value
(E
) then
563 Add_Str_To_Name_Buffer
("_");
564 Add_Real_To_Buffer
(Small_Value
(E
));
567 -- Vax floating-point case
569 elsif Vax_Float
(E
) then
570 if Digits_Value
(Base_Type
(E
)) = 6 then
571 Get_External_Name
(E
, True, "XFF");
573 elsif Digits_Value
(Base_Type
(E
)) = 9 then
574 Get_External_Name
(E
, True, "XFF");
577 pragma Assert
(Digits_Value
(Base_Type
(E
)) = 15);
578 Get_External_Name
(E
, True, "XFG");
581 -- Discrete case where bounds do not match size
583 elsif Is_Discrete_Type
(E
)
584 and then not Bounds_Match_Size
(E
)
587 Lo
: constant Node_Id
:= Type_Low_Bound
(E
);
588 Hi
: constant Node_Id
:= Type_High_Bound
(E
);
590 Lo_Con
: constant Boolean := Compile_Time_Known_Value
(Lo
);
591 Hi_Con
: constant Boolean := Compile_Time_Known_Value
(Hi
);
593 Lo_Discr
: constant Boolean :=
594 Nkind
(Lo
) = N_Identifier
596 Ekind
(Entity
(Lo
)) = E_Discriminant
;
598 Hi_Discr
: constant Boolean :=
599 Nkind
(Hi
) = N_Identifier
601 Ekind
(Entity
(Hi
)) = E_Discriminant
;
603 Lo_Encode
: constant Boolean := Lo_Con
or Lo_Discr
;
604 Hi_Encode
: constant Boolean := Hi_Con
or Hi_Discr
;
606 Biased
: constant Boolean := Has_Biased_Representation
(E
);
610 Get_External_Name
(E
, True, "XB");
612 Get_External_Name
(E
, True, "XD");
615 if Lo_Encode
or Hi_Encode
then
617 Add_Str_To_Name_Buffer
("_");
621 Add_Str_To_Name_Buffer
("LU_");
623 Add_Str_To_Name_Buffer
("L_");
626 Add_Str_To_Name_Buffer
("U_");
631 Add_Uint_To_Buffer
(Expr_Rep_Value
(Lo
));
633 Get_Name_String_And_Append
(Chars
(Entity
(Lo
)));
636 if Lo_Encode
and Hi_Encode
then
637 Add_Str_To_Name_Buffer
("__");
641 Add_Uint_To_Buffer
(Expr_Rep_Value
(Hi
));
643 Get_Name_String_And_Append
(Chars
(Entity
(Hi
)));
648 -- For all other cases, the encoded name is the normal type name
652 Get_External_Name
(E
);
655 if Debug_Flag_B
and then Has_Suffix
then
656 Write_Str
("**** type ");
657 Write_Name
(Chars
(E
));
658 Write_Str
(" is encoded as ");
659 Write_Str
(Name_Buffer
(1 .. Name_Len
));
663 Name_Buffer
(Name_Len
+ 1) := ASCII
.NUL
;
664 end Get_Encoded_Name
;
666 -----------------------
667 -- Get_External_Name --
668 -----------------------
670 procedure Get_External_Name
672 Has_Suffix
: Boolean := False;
673 Suffix
: String := "")
675 E
: Entity_Id
:= Entity
;
678 procedure Get_Qualified_Name_And_Append
(Entity
: Entity_Id
);
679 -- Appends fully qualified name of given entity to Name_Buffer
681 -----------------------------------
682 -- Get_Qualified_Name_And_Append --
683 -----------------------------------
685 procedure Get_Qualified_Name_And_Append
(Entity
: Entity_Id
) is
687 -- If the entity is a compilation unit, its scope is Standard,
688 -- there is no outer scope, and the no further qualification
691 -- If the front end has already computed a fully qualified name,
692 -- then it is also the case that no further qualification is
695 if Present
(Scope
(Scope
(Entity
)))
696 and then not Has_Fully_Qualified_Name
(Entity
)
698 Get_Qualified_Name_And_Append
(Scope
(Entity
));
699 Add_Str_To_Name_Buffer
("__");
700 Get_Name_String_And_Append
(Chars
(Entity
));
701 Append_Homonym_Number
(Entity
);
704 Get_Name_String_And_Append
(Chars
(Entity
));
706 end Get_Qualified_Name_And_Append
;
708 -- Start of processing for Get_External_Name
711 -- If we are not in code generation mode, this procedure may still be
712 -- called from Back_End (more specifically - from gigi for doing type
713 -- representation annotation or some representation-specific checks).
714 -- But in this mode there is no need to mess with external names.
716 -- Furthermore, the call causes difficulties in this case because the
717 -- string representing the homonym number is not correctly reset as a
718 -- part of the call to Output_Homonym_Numbers_Suffix (which is not
721 if Operating_Mode
/= Generate_Code
then
727 -- If this is a child unit, we want the child
729 if Nkind
(E
) = N_Defining_Program_Unit_Name
then
730 E
:= Defining_Identifier
(Entity
);
735 -- Case of interface name being used
737 if (Kind
= E_Procedure
or else
738 Kind
= E_Function
or else
739 Kind
= E_Constant
or else
740 Kind
= E_Variable
or else
742 and then Present
(Interface_Name
(E
))
743 and then No
(Address_Clause
(E
))
744 and then not Has_Suffix
746 Add_String_To_Name_Buffer
(Strval
(Interface_Name
(E
)));
748 -- All other cases besides the interface name case
751 -- If this is a library level subprogram (i.e. a subprogram that is a
752 -- compilation unit other than a subunit), then we prepend _ada_ to
753 -- ensure distinctions required as described in the spec.
755 -- Check explicitly for child units, because those are not flagged
756 -- as Compilation_Units by lib. Should they be ???
759 and then (Is_Compilation_Unit
(E
) or Is_Child_Unit
(E
))
760 and then not Has_Suffix
762 Add_Str_To_Name_Buffer
("_ada_");
765 -- If the entity is a subprogram instance that is not a compilation
766 -- unit, generate the name of the original Ada entity, which is the
769 if Is_Generic_Instance
(E
)
770 and then Is_Subprogram
(E
)
771 and then not Is_Compilation_Unit
(Scope
(E
))
772 and then (Ekind
(Scope
(E
)) = E_Package
774 Ekind
(Scope
(E
)) = E_Package_Body
)
775 and then Present
(Related_Instance
(Scope
(E
)))
777 E
:= Related_Instance
(Scope
(E
));
780 Get_Qualified_Name_And_Append
(E
);
784 Add_Str_To_Name_Buffer
("___");
785 Add_Str_To_Name_Buffer
(Suffix
);
788 Name_Buffer
(Name_Len
+ 1) := ASCII
.NUL
;
789 end Get_External_Name
;
791 --------------------------
792 -- Get_Variant_Encoding --
793 --------------------------
795 procedure Get_Variant_Encoding
(V
: Node_Id
) is
798 procedure Choice_Val
(Typ
: Character; Choice
: Node_Id
);
799 -- Output encoded value for a single choice value. Typ is the key
800 -- character ('S', 'F', or 'T') that precedes the choice value.
806 procedure Choice_Val
(Typ
: Character; Choice
: Node_Id
) is
808 if Nkind
(Choice
) = N_Integer_Literal
then
809 Add_Char_To_Name_Buffer
(Typ
);
810 Add_Uint_To_Buffer
(Intval
(Choice
));
812 -- Character literal with no entity present (this is the case
813 -- Standard.Character or Standard.Wide_Character as root type)
815 elsif Nkind
(Choice
) = N_Character_Literal
816 and then No
(Entity
(Choice
))
818 Add_Char_To_Name_Buffer
(Typ
);
819 Add_Uint_To_Buffer
(Char_Literal_Value
(Choice
));
823 Ent
: constant Entity_Id
:= Entity
(Choice
);
826 if Ekind
(Ent
) = E_Enumeration_Literal
then
827 Add_Char_To_Name_Buffer
(Typ
);
828 Add_Uint_To_Buffer
(Enumeration_Rep
(Ent
));
831 pragma Assert
(Ekind
(Ent
) = E_Constant
);
832 Choice_Val
(Typ
, Constant_Value
(Ent
));
838 -- Start of processing for Get_Variant_Encoding
843 Choice
:= First
(Discrete_Choices
(V
));
844 while Present
(Choice
) loop
845 if Nkind
(Choice
) = N_Others_Choice
then
846 Add_Char_To_Name_Buffer
('O');
848 elsif Nkind
(Choice
) = N_Range
then
849 Choice_Val
('R', Low_Bound
(Choice
));
850 Choice_Val
('T', High_Bound
(Choice
));
852 elsif Is_Entity_Name
(Choice
)
853 and then Is_Type
(Entity
(Choice
))
855 Choice_Val
('R', Type_Low_Bound
(Entity
(Choice
)));
856 Choice_Val
('T', Type_High_Bound
(Entity
(Choice
)));
858 elsif Nkind
(Choice
) = N_Subtype_Indication
then
860 Rang
: constant Node_Id
:=
861 Range_Expression
(Constraint
(Choice
));
863 Choice_Val
('R', Low_Bound
(Rang
));
864 Choice_Val
('T', High_Bound
(Rang
));
868 Choice_Val
('S', Choice
);
874 Name_Buffer
(Name_Len
+ 1) := ASCII
.NUL
;
878 VP
: constant Node_Id
:= Parent
(V
); -- Variant_Part
879 CL
: constant Node_Id
:= Parent
(VP
); -- Component_List
880 RD
: constant Node_Id
:= Parent
(CL
); -- Record_Definition
881 FT
: constant Node_Id
:= Parent
(RD
); -- Full_Type_Declaration
884 Write_Str
("**** variant for type ");
885 Write_Name
(Chars
(Defining_Identifier
(FT
)));
886 Write_Str
(" is encoded as ");
887 Write_Str
(Name_Buffer
(1 .. Name_Len
));
891 end Get_Variant_Encoding
;
893 -----------------------------------------
894 -- Build_Subprogram_Instance_Renamings --
895 -----------------------------------------
897 procedure Build_Subprogram_Instance_Renamings
906 E
:= First_Entity
(Wrapper
);
907 while Present
(E
) loop
908 if Nkind
(Parent
(E
)) = N_Object_Declaration
909 and then Is_Elementary_Type
(Etype
(E
))
911 Loc
:= Sloc
(Expression
(Parent
(E
)));
912 Decl
:= Make_Object_Renaming_Declaration
(Loc
,
913 Defining_Identifier
=>
914 Make_Defining_Identifier
(Loc
, Chars
(E
)),
915 Subtype_Mark
=> New_Occurrence_Of
(Etype
(E
), Loc
),
916 Name
=> New_Occurrence_Of
(E
, Loc
));
918 Append
(Decl
, Declarations
(N
));
919 Set_Needs_Debug_Info
(Defining_Identifier
(Decl
));
924 end Build_Subprogram_Instance_Renamings
;
926 ------------------------------------
927 -- Get_Secondary_DT_External_Name --
928 ------------------------------------
930 procedure Get_Secondary_DT_External_Name
932 Ancestor_Typ
: Entity_Id
;
936 Get_External_Name
(Typ
);
938 if Ancestor_Typ
/= Typ
then
940 Len
: constant Natural := Name_Len
;
941 Save_Str
: constant String (1 .. Name_Len
)
942 := Name_Buffer
(1 .. Name_Len
);
944 Get_External_Name
(Ancestor_Typ
);
946 -- Append the extended name of the ancestor to the
947 -- extended name of Typ
949 Name_Buffer
(Len
+ 2 .. Len
+ Name_Len
+ 1) :=
950 Name_Buffer
(1 .. Name_Len
);
951 Name_Buffer
(1 .. Len
) := Save_Str
;
952 Name_Buffer
(Len
+ 1) := '_';
953 Name_Len
:= Len
+ Name_Len
+ 1;
957 Add_Nat_To_Name_Buffer
(Suffix_Index
);
958 end Get_Secondary_DT_External_Name
;
960 ---------------------------------
961 -- Make_Packed_Array_Type_Name --
962 ---------------------------------
964 function Make_Packed_Array_Type_Name
970 Get_Name_String
(Chars
(Typ
));
971 Add_Str_To_Name_Buffer
("___XP");
972 Add_Uint_To_Buffer
(Csize
);
974 end Make_Packed_Array_Type_Name
;
976 -----------------------------------
977 -- Output_Homonym_Numbers_Suffix --
978 -----------------------------------
980 procedure Output_Homonym_Numbers_Suffix
is
984 if Homonym_Len
> 0 then
986 -- Check for all 1's, in which case we do not output
990 exit when Homonym_Numbers
(J
) /= '1';
992 -- If we reached end of string we do not output
994 if J
= Homonym_Len
then
999 exit when Homonym_Numbers
(J
+ 1) /= '_';
1003 -- If we exit the loop then suffix must be output
1005 Add_Str_To_Name_Buffer
("__");
1006 Add_Str_To_Name_Buffer
(Homonym_Numbers
(1 .. Homonym_Len
));
1009 end Output_Homonym_Numbers_Suffix
;
1011 ------------------------------
1012 -- Prepend_String_To_Buffer --
1013 ------------------------------
1015 procedure Prepend_String_To_Buffer
(S
: String) is
1016 N
: constant Integer := S
'Length;
1018 Name_Buffer
(1 + N
.. Name_Len
+ N
) := Name_Buffer
(1 .. Name_Len
);
1019 Name_Buffer
(1 .. N
) := S
;
1020 Name_Len
:= Name_Len
+ N
;
1021 end Prepend_String_To_Buffer
;
1023 ----------------------------
1024 -- Prepend_Uint_To_Buffer --
1025 ----------------------------
1027 procedure Prepend_Uint_To_Buffer
(U
: Uint
) is
1030 Prepend_String_To_Buffer
("m");
1031 Prepend_Uint_To_Buffer
(-U
);
1033 UI_Image
(U
, Decimal
);
1034 Prepend_String_To_Buffer
(UI_Image_Buffer
(1 .. UI_Image_Length
));
1036 end Prepend_Uint_To_Buffer
;
1038 ------------------------------
1039 -- Qualify_All_Entity_Names --
1040 ------------------------------
1042 procedure Qualify_All_Entity_Names
is
1047 for J
in Name_Qualify_Units
.First
.. Name_Qualify_Units
.Last
loop
1048 E
:= Defining_Entity
(Name_Qualify_Units
.Table
(J
));
1050 Qualify_Entity_Name
(E
);
1052 -- Normally entities in the qualification list are scopes, but in the
1053 -- case of a library-level package renaming there is an associated
1054 -- variable that encodes the debugger name and that variable is
1055 -- entered in the list since it occurs in the Aux_Decls list of the
1056 -- compilation and doesn't have a normal scope.
1058 if Ekind
(E
) /= E_Variable
then
1059 Ent
:= First_Entity
(E
);
1060 while Present
(Ent
) loop
1062 Qualify_Entity_Name
(Ent
);
1065 -- There are odd cases where Last_Entity (E) = E. This happens
1066 -- in the case of renaming of packages. This test avoids
1067 -- getting stuck in such cases.
1073 end Qualify_All_Entity_Names
;
1075 -------------------------
1076 -- Qualify_Entity_Name --
1077 -------------------------
1079 procedure Qualify_Entity_Name
(Ent
: Entity_Id
) is
1081 Full_Qualify_Name
: String (1 .. Name_Buffer
'Length);
1082 Full_Qualify_Len
: Natural := 0;
1083 -- Used to accumulate fully qualified name of subprogram
1085 procedure Fully_Qualify_Name
(E
: Entity_Id
);
1086 -- Used to qualify a subprogram or type name, where full
1087 -- qualification up to Standard is always used. Name is set
1088 -- in Full_Qualify_Name with the length in Full_Qualify_Len.
1089 -- Note that this routine does not prepend the _ada_ string
1090 -- required for library subprograms (this is done in the back end).
1092 function Is_BNPE
(S
: Entity_Id
) return Boolean;
1093 -- Determines if S is a BNPE, i.e. Body-Nested Package Entity, which
1094 -- is defined to be a package which is immediately nested within a
1097 function Qualify_Needed
(S
: Entity_Id
) return Boolean;
1098 -- Given a scope, determines if the scope is to be included in the
1099 -- fully qualified name, True if so, False if not.
1101 procedure Set_BNPE_Suffix
(E
: Entity_Id
);
1102 -- Recursive routine to append the BNPE qualification suffix. Works
1103 -- from right to left with E being the current entity in the list.
1104 -- The result does NOT have the trailing n's and trailing b stripped.
1105 -- The caller must do this required stripping.
1107 procedure Set_Entity_Name
(E
: Entity_Id
);
1108 -- Internal recursive routine that does most of the work. This routine
1109 -- leaves the result sitting in Name_Buffer and Name_Len.
1111 BNPE_Suffix_Needed
: Boolean := False;
1112 -- Set true if a body-nested package entity suffix is required
1114 Save_Chars
: constant Name_Id
:= Chars
(Ent
);
1115 -- Save original name
1117 ------------------------
1118 -- Fully_Qualify_Name --
1119 ------------------------
1121 procedure Fully_Qualify_Name
(E
: Entity_Id
) is
1122 Discard
: Boolean := False;
1125 -- Ignore empty entry (can happen in error cases)
1130 -- If this we are qualifying entities local to a generic instance,
1131 -- use the name of the original instantiation, not that of the
1132 -- anonymous subprogram in the wrapper package, so that gdb doesn't
1133 -- have to know about these.
1135 elsif Is_Generic_Instance
(E
)
1136 and then Is_Subprogram
(E
)
1137 and then not Comes_From_Source
(E
)
1138 and then not Is_Compilation_Unit
(Scope
(E
))
1140 Fully_Qualify_Name
(Related_Instance
(Scope
(E
)));
1144 -- If we reached fully qualified name, then just copy it
1146 if Has_Fully_Qualified_Name
(E
) then
1147 Get_Name_String
(Chars
(E
));
1148 Strip_Suffixes
(Discard
);
1149 Full_Qualify_Name
(1 .. Name_Len
) := Name_Buffer
(1 .. Name_Len
);
1150 Full_Qualify_Len
:= Name_Len
;
1151 Set_Has_Fully_Qualified_Name
(Ent
);
1153 -- Case of non-fully qualified name
1156 if Scope
(E
) = Standard_Standard
then
1157 Set_Has_Fully_Qualified_Name
(Ent
);
1159 Fully_Qualify_Name
(Scope
(E
));
1160 Full_Qualify_Name
(Full_Qualify_Len
+ 1) := '_';
1161 Full_Qualify_Name
(Full_Qualify_Len
+ 2) := '_';
1162 Full_Qualify_Len
:= Full_Qualify_Len
+ 2;
1165 if Has_Qualified_Name
(E
) then
1166 Get_Unqualified_Name_String
(Chars
(E
));
1168 Get_Name_String
(Chars
(E
));
1171 -- Here we do one step of the qualification
1174 (Full_Qualify_Len
+ 1 .. Full_Qualify_Len
+ Name_Len
) :=
1175 Name_Buffer
(1 .. Name_Len
);
1176 Full_Qualify_Len
:= Full_Qualify_Len
+ Name_Len
;
1177 Append_Homonym_Number
(E
);
1181 BNPE_Suffix_Needed
:= True;
1183 end Fully_Qualify_Name
;
1189 function Is_BNPE
(S
: Entity_Id
) return Boolean is
1191 return Ekind
(S
) = E_Package
and then Is_Package_Body_Entity
(S
);
1194 --------------------
1195 -- Qualify_Needed --
1196 --------------------
1198 function Qualify_Needed
(S
: Entity_Id
) return Boolean is
1200 -- If we got all the way to Standard, then we have certainly
1201 -- fully qualified the name, so set the flag appropriately,
1202 -- and then return False, since we are most certainly done.
1204 if S
= Standard_Standard
then
1205 Set_Has_Fully_Qualified_Name
(Ent
, True);
1208 -- Otherwise figure out if further qualification is required
1211 return Is_Subprogram
(Ent
)
1212 or else Ekind
(Ent
) = E_Subprogram_Body
1213 or else (Ekind
(S
) /= E_Block
1214 and then not Is_Dynamic_Scope
(S
));
1218 ---------------------
1219 -- Set_BNPE_Suffix --
1220 ---------------------
1222 procedure Set_BNPE_Suffix
(E
: Entity_Id
) is
1223 S
: constant Entity_Id
:= Scope
(E
);
1226 if Qualify_Needed
(S
) then
1227 Set_BNPE_Suffix
(S
);
1230 Add_Char_To_Name_Buffer
('b');
1232 Add_Char_To_Name_Buffer
('n');
1236 Add_Char_To_Name_Buffer
('X');
1238 end Set_BNPE_Suffix
;
1240 ---------------------
1241 -- Set_Entity_Name --
1242 ---------------------
1244 procedure Set_Entity_Name
(E
: Entity_Id
) is
1245 S
: constant Entity_Id
:= Scope
(E
);
1248 -- If we reach an already qualified name, just take the encoding
1249 -- except that we strip the package body suffixes, since these
1250 -- will be separately put on later.
1252 if Has_Qualified_Name
(E
) then
1253 Get_Name_String_And_Append
(Chars
(E
));
1254 Strip_Suffixes
(BNPE_Suffix_Needed
);
1256 -- If the top level name we are adding is itself fully
1257 -- qualified, then that means that the name that we are
1258 -- preparing for the Fully_Qualify_Name call will also
1259 -- generate a fully qualified name.
1261 if Has_Fully_Qualified_Name
(E
) then
1262 Set_Has_Fully_Qualified_Name
(Ent
);
1265 -- Case where upper level name is not encoded yet
1268 -- Recurse if further qualification required
1270 if Qualify_Needed
(S
) then
1271 Set_Entity_Name
(S
);
1272 Add_Str_To_Name_Buffer
("__");
1275 -- Otherwise get name and note if it is a BNPE
1277 Get_Name_String_And_Append
(Chars
(E
));
1280 BNPE_Suffix_Needed
:= True;
1283 Append_Homonym_Number
(E
);
1285 end Set_Entity_Name
;
1287 -- Start of processing for Qualify_Entity_Name
1290 if Has_Qualified_Name
(Ent
) then
1293 -- In formal verification mode, simply append a suffix for homonyms.
1294 -- We used to qualify entity names as full expansion does, but this was
1295 -- removed as this prevents the verification back-end from using a short
1296 -- name for debugging and user interaction. The verification back-end
1297 -- already takes care of qualifying names when needed. Still mark the
1298 -- name as being qualified, as Qualify_Entity_Name may be called more
1299 -- than once on the same entity.
1301 elsif GNATprove_Mode
then
1302 if Has_Homonym
(Ent
) then
1303 Get_Name_String
(Chars
(Ent
));
1304 Append_Homonym_Number
(Ent
);
1305 Output_Homonym_Numbers_Suffix
;
1306 Set_Chars
(Ent
, Name_Enter
);
1309 Set_Has_Qualified_Name
(Ent
);
1312 -- If the entity is a variable encoding the debug name for an object
1313 -- renaming, then the qualified name of the entity associated with the
1314 -- renamed object can now be incorporated in the debug name.
1316 elsif Ekind
(Ent
) = E_Variable
1317 and then Present
(Debug_Renaming_Link
(Ent
))
1320 Qualify_Entity_Name
(Debug_Renaming_Link
(Ent
));
1321 Get_Name_String
(Chars
(Ent
));
1323 -- Retrieve the now-qualified name of the renamed entity and insert
1324 -- it in the middle of the name, just preceding the suffix encoding
1325 -- describing the renamed object.
1328 Renamed_Id
: constant String :=
1329 Get_Name_String
(Chars
(Debug_Renaming_Link
(Ent
)));
1330 Insert_Len
: constant Integer := Renamed_Id
'Length + 1;
1331 Index
: Natural := Name_Len
- 3;
1334 -- Loop backwards through the name to find the start of the "___"
1335 -- sequence associated with the suffix.
1337 while Index
>= Name_Buffer
'First
1338 and then (Name_Buffer
(Index
+ 1) /= '_'
1339 or else Name_Buffer
(Index
+ 2) /= '_'
1340 or else Name_Buffer
(Index
+ 3) /= '_')
1345 pragma Assert
(Name_Buffer
(Index
+ 1 .. Index
+ 3) = "___");
1347 -- Insert an underscore separator and the entity name just in
1348 -- front of the suffix.
1350 Name_Buffer
(Index
+ 1 + Insert_Len
.. Name_Len
+ Insert_Len
) :=
1351 Name_Buffer
(Index
+ 1 .. Name_Len
);
1352 Name_Buffer
(Index
+ 1) := '_';
1353 Name_Buffer
(Index
+ 2 .. Index
+ Insert_Len
) := Renamed_Id
;
1354 Name_Len
:= Name_Len
+ Insert_Len
;
1357 -- Reset the name of the variable to the new name that includes the
1358 -- name of the renamed entity.
1360 Set_Chars
(Ent
, Name_Enter
);
1362 -- If the entity needs qualification by its scope then develop it
1363 -- here, add the variable's name, and again reset the entity name.
1365 if Qualify_Needed
(Scope
(Ent
)) then
1367 Set_Entity_Name
(Scope
(Ent
));
1368 Add_Str_To_Name_Buffer
("__");
1370 Get_Name_String_And_Append
(Chars
(Ent
));
1372 Set_Chars
(Ent
, Name_Enter
);
1375 Set_Has_Qualified_Name
(Ent
);
1378 elsif Is_Subprogram
(Ent
)
1379 or else Ekind
(Ent
) = E_Subprogram_Body
1380 or else Is_Type
(Ent
)
1382 Fully_Qualify_Name
(Ent
);
1383 Name_Len
:= Full_Qualify_Len
;
1384 Name_Buffer
(1 .. Name_Len
) := Full_Qualify_Name
(1 .. Name_Len
);
1386 elsif Qualify_Needed
(Scope
(Ent
)) then
1388 Set_Entity_Name
(Ent
);
1391 Set_Has_Qualified_Name
(Ent
);
1395 -- Fall through with a fully qualified name in Name_Buffer/Name_Len
1397 Output_Homonym_Numbers_Suffix
;
1399 -- Add body-nested package suffix if required
1401 if BNPE_Suffix_Needed
1402 and then Ekind
(Ent
) /= E_Enumeration_Literal
1404 Set_BNPE_Suffix
(Ent
);
1406 -- Strip trailing n's and last trailing b as required. note that
1407 -- we know there is at least one b, or no suffix would be generated.
1409 while Name_Buffer
(Name_Len
) = 'n' loop
1410 Name_Len
:= Name_Len
- 1;
1413 Name_Len
:= Name_Len
- 1;
1416 Set_Chars
(Ent
, Name_Enter
);
1417 Set_Has_Qualified_Name
(Ent
);
1419 if Debug_Flag_BB
then
1421 Write_Name
(Save_Chars
);
1422 Write_Str
(" qualified as ");
1423 Write_Name
(Chars
(Ent
));
1426 end Qualify_Entity_Name
;
1428 --------------------------
1429 -- Qualify_Entity_Names --
1430 --------------------------
1432 procedure Qualify_Entity_Names
(N
: Node_Id
) is
1434 Name_Qualify_Units
.Append
(N
);
1435 end Qualify_Entity_Names
;
1441 procedure Reset_Buffers
is
1447 --------------------
1448 -- Strip_Suffixes --
1449 --------------------
1451 procedure Strip_Suffixes
(BNPE_Suffix_Found
: in out Boolean) is
1454 pragma Warnings
(Off
, BNPE_Suffix_Found
);
1455 -- Since this procedure only ever sets the flag
1458 -- Search for and strip BNPE suffix
1460 for J
in reverse 2 .. Name_Len
loop
1461 if Name_Buffer
(J
) = 'X' then
1463 BNPE_Suffix_Found
:= True;
1467 exit when Name_Buffer
(J
) /= 'b' and then Name_Buffer
(J
) /= 'n';
1470 -- Search for and strip homonym numbers suffix
1472 for J
in reverse 2 .. Name_Len
- 2 loop
1473 if Name_Buffer
(J
) = '_'
1474 and then Name_Buffer
(J
+ 1) = '_'
1476 if Name_Buffer
(J
+ 2) in '0' .. '9' then
1477 if Homonym_Len
> 0 then
1478 Homonym_Len
:= Homonym_Len
+ 1;
1479 Homonym_Numbers
(Homonym_Len
) := '-';
1482 SL
:= Name_Len
- (J
+ 1);
1484 Homonym_Numbers
(Homonym_Len
+ 1 .. Homonym_Len
+ SL
) :=
1485 Name_Buffer
(J
+ 2 .. Name_Len
);
1487 Homonym_Len
:= Homonym_Len
+ SL
;