bff6d25b7c80a97751c41dbfa3ea45436c61b8d9
[gcc.git] / gcc / ada / lib-xref.adb
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- L I B . X R E F --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1998-2016, Free Software Foundation, Inc. --
10 -- --
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. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
25
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Elists; use Elists;
29 with Errout; use Errout;
30 with Nlists; use Nlists;
31 with Opt; use Opt;
32 with Restrict; use Restrict;
33 with Rident; use Rident;
34 with Sem; use Sem;
35 with Sem_Aux; use Sem_Aux;
36 with Sem_Prag; use Sem_Prag;
37 with Sem_Util; use Sem_Util;
38 with Sem_Warn; use Sem_Warn;
39 with Sinfo; use Sinfo;
40 with Sinput; use Sinput;
41 with Snames; use Snames;
42 with Stringt; use Stringt;
43 with Stand; use Stand;
44 with Table; use Table;
45
46 with GNAT.Heap_Sort_G;
47 with GNAT.HTable;
48
49 package body Lib.Xref is
50
51 ------------------
52 -- Declarations --
53 ------------------
54
55 -- The Xref table is used to record references. The Loc field is set
56 -- to No_Location for a definition entry.
57
58 subtype Xref_Entry_Number is Int;
59
60 type Xref_Key is record
61 -- These are the components of Xref_Entry that participate in hash
62 -- lookups.
63
64 Ent : Entity_Id;
65 -- Entity referenced (E parameter to Generate_Reference)
66
67 Loc : Source_Ptr;
68 -- Location of reference (Original_Location (Sloc field of N parameter
69 -- to Generate_Reference)). Set to No_Location for the case of a
70 -- defining occurrence.
71
72 Typ : Character;
73 -- Reference type (Typ param to Generate_Reference)
74
75 Eun : Unit_Number_Type;
76 -- Unit number corresponding to Ent
77
78 Lun : Unit_Number_Type;
79 -- Unit number corresponding to Loc. Value is undefined and not
80 -- referenced if Loc is set to No_Location.
81
82 -- The following components are only used for SPARK cross-references
83
84 Ref_Scope : Entity_Id;
85 -- Entity of the closest subprogram or package enclosing the reference
86
87 Ent_Scope : Entity_Id;
88 -- Entity of the closest subprogram or package enclosing the definition,
89 -- which should be located in the same file as the definition itself.
90 end record;
91
92 type Xref_Entry is record
93 Key : Xref_Key;
94
95 Ent_Scope_File : Unit_Number_Type;
96 -- File for entity Ent_Scope
97
98 Def : Source_Ptr;
99 -- Original source location for entity being referenced. Note that these
100 -- values are used only during the output process, they are not set when
101 -- the entries are originally built. This is because private entities
102 -- can be swapped when the initial call is made.
103
104 HTable_Next : Xref_Entry_Number;
105 -- For use only by Static_HTable
106 end record;
107
108 package Xrefs is new Table.Table (
109 Table_Component_Type => Xref_Entry,
110 Table_Index_Type => Xref_Entry_Number,
111 Table_Low_Bound => 1,
112 Table_Initial => Alloc.Xrefs_Initial,
113 Table_Increment => Alloc.Xrefs_Increment,
114 Table_Name => "Xrefs");
115
116 --------------
117 -- Xref_Set --
118 --------------
119
120 -- We keep a set of xref entries, in order to avoid inserting duplicate
121 -- entries into the above Xrefs table. An entry is in Xref_Set if and only
122 -- if it is in Xrefs.
123
124 Num_Buckets : constant := 2**16;
125
126 subtype Header_Num is Integer range 0 .. Num_Buckets - 1;
127 type Null_Type is null record;
128 pragma Unreferenced (Null_Type);
129
130 function Hash (F : Xref_Entry_Number) return Header_Num;
131
132 function Equal (F1, F2 : Xref_Entry_Number) return Boolean;
133
134 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number);
135
136 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number;
137
138 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number;
139
140 pragma Inline (Hash, Equal, HT_Set_Next, HT_Next, Get_Key);
141
142 package Xref_Set is new GNAT.HTable.Static_HTable (
143 Header_Num,
144 Element => Xref_Entry,
145 Elmt_Ptr => Xref_Entry_Number,
146 Null_Ptr => 0,
147 Set_Next => HT_Set_Next,
148 Next => HT_Next,
149 Key => Xref_Entry_Number,
150 Get_Key => Get_Key,
151 Hash => Hash,
152 Equal => Equal);
153
154 -----------------------------
155 -- SPARK Xrefs Information --
156 -----------------------------
157
158 package body SPARK_Specific is separate;
159
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
163
164 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
165 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
166
167 procedure Generate_Prim_Op_References (Typ : Entity_Id);
168 -- For a tagged type, generate implicit references to its primitive
169 -- operations, for source navigation. This is done right before emitting
170 -- cross-reference information rather than at the freeze point of the type
171 -- in order to handle late bodies that are primitive operations.
172
173 function Lt (T1, T2 : Xref_Entry) return Boolean;
174 -- Order cross-references
175
176 ---------------
177 -- Add_Entry --
178 ---------------
179
180 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
181 begin
182 Xrefs.Increment_Last; -- tentative
183 Xrefs.Table (Xrefs.Last).Key := Key;
184
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
187
188 if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
189 Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
190 -- Leave Def and HTable_Next uninitialized
191
192 Set_Has_Xref_Entry (Key.Ent);
193
194 -- It was already in Xref_Set, so throw away the tentatively-added entry
195
196 else
197 Xrefs.Decrement_Last;
198 end if;
199 end Add_Entry;
200
201 -----------
202 -- Equal --
203 -----------
204
205 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
206 Result : constant Boolean :=
207 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
208 begin
209 return Result;
210 end Equal;
211
212 -------------------------
213 -- Generate_Definition --
214 -------------------------
215
216 procedure Generate_Definition (E : Entity_Id) is
217 begin
218 pragma Assert (Nkind (E) in N_Entity);
219
220 -- Note that we do not test Xref_Entity_Letters here. It is too early
221 -- to do so, since we are often called before the entity is fully
222 -- constructed, so that the Ekind is still E_Void.
223
224 if Opt.Xref_Active
225
226 -- Definition must come from source
227
228 -- We make an exception for subprogram child units that have no spec.
229 -- For these we generate a subprogram declaration for library use,
230 -- and the corresponding entity does not come from source.
231 -- Nevertheless, all references will be attached to it and we have
232 -- to treat is as coming from user code.
233
234 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
235
236 -- And must have a reasonable source location that is not
237 -- within an instance (all entities in instances are ignored)
238
239 and then Sloc (E) > No_Location
240 and then Instantiation_Location (Sloc (E)) = No_Location
241
242 -- And must be a non-internal name from the main source unit
243
244 and then In_Extended_Main_Source_Unit (E)
245 and then not Is_Internal_Name (Chars (E))
246 then
247 Add_Entry
248 ((Ent => E,
249 Loc => No_Location,
250 Typ => ' ',
251 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
252 Lun => No_Unit,
253 Ref_Scope => Empty,
254 Ent_Scope => Empty),
255 Ent_Scope_File => No_Unit);
256
257 if In_Inlined_Body then
258 Set_Referenced (E);
259 end if;
260 end if;
261 end Generate_Definition;
262
263 ---------------------------------
264 -- Generate_Operator_Reference --
265 ---------------------------------
266
267 procedure Generate_Operator_Reference
268 (N : Node_Id;
269 T : Entity_Id)
270 is
271 begin
272 if not In_Extended_Main_Source_Unit (N) then
273 return;
274 end if;
275
276 -- If the operator is not a Standard operator, then we generate a real
277 -- reference to the user defined operator.
278
279 if Sloc (Entity (N)) /= Standard_Location then
280 Generate_Reference (Entity (N), N);
281
282 -- A reference to an implicit inequality operator is also a reference
283 -- to the user-defined equality.
284
285 if Nkind (N) = N_Op_Ne
286 and then not Comes_From_Source (Entity (N))
287 and then Present (Corresponding_Equality (Entity (N)))
288 then
289 Generate_Reference (Corresponding_Equality (Entity (N)), N);
290 end if;
291
292 -- For the case of Standard operators, we mark the result type as
293 -- referenced. This ensures that in the case where we are using a
294 -- derived operator, we mark an entity of the unit that implicitly
295 -- defines this operator as used. Otherwise we may think that no entity
296 -- of the unit is used. The actual entity marked as referenced is the
297 -- first subtype, which is the relevant user defined entity.
298
299 -- Note: we only do this for operators that come from source. The
300 -- generated code sometimes reaches for entities that do not need to be
301 -- explicitly visible (for example, when we expand the code for
302 -- comparing two record objects, the fields of the record may not be
303 -- visible).
304
305 elsif Comes_From_Source (N) then
306 Set_Referenced (First_Subtype (T));
307 end if;
308 end Generate_Operator_Reference;
309
310 ---------------------------------
311 -- Generate_Prim_Op_References --
312 ---------------------------------
313
314 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
315 Base_T : Entity_Id;
316 Prim : Elmt_Id;
317 Prim_List : Elist_Id;
318
319 begin
320 -- Handle subtypes of synchronized types
321
322 if Ekind (Typ) = E_Protected_Subtype
323 or else Ekind (Typ) = E_Task_Subtype
324 then
325 Base_T := Etype (Typ);
326 else
327 Base_T := Typ;
328 end if;
329
330 -- References to primitive operations are only relevant for tagged types
331
332 if not Is_Tagged_Type (Base_T)
333 or else Is_Class_Wide_Type (Base_T)
334 then
335 return;
336 end if;
337
338 -- Ada 2005 (AI-345): For synchronized types generate reference to the
339 -- wrapper that allow us to dispatch calls through their implemented
340 -- abstract interface types.
341
342 -- The check for Present here is to protect against previously reported
343 -- critical errors.
344
345 Prim_List := Primitive_Operations (Base_T);
346
347 if No (Prim_List) then
348 return;
349 end if;
350
351 Prim := First_Elmt (Prim_List);
352 while Present (Prim) loop
353
354 -- If the operation is derived, get the original for cross-reference
355 -- reference purposes (it is the original for which we want the xref
356 -- and for which the comes_from_source test must be performed).
357
358 Generate_Reference
359 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
360 Next_Elmt (Prim);
361 end loop;
362 end Generate_Prim_Op_References;
363
364 ------------------------
365 -- Generate_Reference --
366 ------------------------
367
368 procedure Generate_Reference
369 (E : Entity_Id;
370 N : Node_Id;
371 Typ : Character := 'r';
372 Set_Ref : Boolean := True;
373 Force : Boolean := False)
374 is
375 Actual_Typ : Character := Typ;
376 Call : Node_Id;
377 Def : Source_Ptr;
378 Ent : Entity_Id;
379 Ent_Scope : Entity_Id;
380 Formal : Entity_Id;
381 Kind : Entity_Kind;
382 Nod : Node_Id;
383 Ref : Source_Ptr;
384 Ref_Scope : Entity_Id;
385
386 function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
387 -- Get the enclosing entity through renamings, which may come from
388 -- source or from the translation of generic instantiations.
389
390 function Is_On_LHS (Node : Node_Id) return Boolean;
391 -- Used to check if a node is on the left hand side of an assignment.
392 -- The following cases are handled:
393 --
394 -- Variable Node is a direct descendant of left hand side of an
395 -- assignment statement.
396 --
397 -- Prefix Of an indexed or selected component that is present in
398 -- a subtree rooted by an assignment statement. There is
399 -- no restriction of nesting of components, thus cases
400 -- such as A.B (C).D are handled properly. However a prefix
401 -- of a dereference (either implicit or explicit) is never
402 -- considered as on a LHS.
403 --
404 -- Out param Same as above cases, but OUT parameter
405
406 function OK_To_Set_Referenced return Boolean;
407 -- Returns True if the Referenced flag can be set. There are a few
408 -- exceptions where we do not want to set this flag, see body for
409 -- details of these exceptional cases.
410
411 ---------------------------
412 -- Get_Through_Renamings --
413 ---------------------------
414
415 function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
416 Result : Entity_Id := E;
417
418 begin
419 while Present (Result)
420 and then Is_Object (Result)
421 and then Present (Renamed_Object (Result))
422 loop
423 Result := Get_Enclosing_Object (Renamed_Object (Result));
424 end loop;
425
426 return Result;
427 end Get_Through_Renamings;
428
429 ---------------
430 -- Is_On_LHS --
431 ---------------
432
433 -- ??? There are several routines here and there that perform a similar
434 -- (but subtly different) computation, which should be factored:
435
436 -- Sem_Util.Is_LHS
437 -- Sem_Util.May_Be_Lvalue
438 -- Sem_Util.Known_To_Be_Assigned
439 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
440 -- Exp_Smem.Is_Out_Actual
441
442 function Is_On_LHS (Node : Node_Id) return Boolean is
443 N : Node_Id;
444 P : Node_Id;
445 K : Node_Kind;
446
447 begin
448 -- Only identifiers are considered, is this necessary???
449
450 if Nkind (Node) /= N_Identifier then
451 return False;
452 end if;
453
454 -- Immediate return if appeared as OUT parameter
455
456 if Kind = E_Out_Parameter then
457 return True;
458 end if;
459
460 -- Search for assignment statement subtree root
461
462 N := Node;
463 loop
464 P := Parent (N);
465 K := Nkind (P);
466
467 if K = N_Assignment_Statement then
468 return Name (P) = N;
469
470 -- Check whether the parent is a component and the current node is
471 -- its prefix, but return False if the current node has an access
472 -- type, as in that case the selected or indexed component is an
473 -- implicit dereference, and the LHS is the designated object, not
474 -- the access object.
475
476 -- ??? case of a slice assignment?
477
478 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
479 and then Prefix (P) = N
480 then
481 -- Check for access type. First a special test, In some cases
482 -- this is called too early (see comments in Find_Direct_Name),
483 -- at a point where the tree is not fully typed yet. In that
484 -- case we may lack an Etype for N, and we can't check the
485 -- Etype. For now, we always return False in such a case,
486 -- but this is clearly not right in all cases ???
487
488 if No (Etype (N)) then
489 return False;
490
491 elsif Is_Access_Type (Etype (N)) then
492 return False;
493
494 -- Access type case dealt with, keep going
495
496 else
497 N := P;
498 end if;
499
500 -- All other cases, definitely not on left side
501
502 else
503 return False;
504 end if;
505 end loop;
506 end Is_On_LHS;
507
508 ---------------------------
509 -- OK_To_Set_Referenced --
510 ---------------------------
511
512 function OK_To_Set_Referenced return Boolean is
513 P : Node_Id;
514
515 begin
516 -- A reference from a pragma Unreferenced or pragma Unmodified or
517 -- pragma Warnings does not cause the Referenced flag to be set.
518 -- This avoids silly warnings about things being referenced and
519 -- not assigned when the only reference is from the pragma.
520
521 if Nkind (N) = N_Identifier then
522 P := Parent (N);
523
524 if Nkind (P) = N_Pragma_Argument_Association then
525 P := Parent (P);
526
527 if Nkind (P) = N_Pragma then
528 if Nam_In (Pragma_Name (P), Name_Warnings,
529 Name_Unmodified,
530 Name_Unreferenced)
531 then
532 return False;
533 end if;
534 end if;
535
536 -- A reference to a formal in a named parameter association does
537 -- not make the formal referenced. Formals that are unused in the
538 -- subprogram body are properly flagged as such, even if calls
539 -- elsewhere use named notation.
540
541 elsif Nkind (P) = N_Parameter_Association
542 and then N = Selector_Name (P)
543 then
544 return False;
545 end if;
546 end if;
547
548 return True;
549 end OK_To_Set_Referenced;
550
551 -- Start of processing for Generate_Reference
552
553 begin
554 pragma Assert (Nkind (E) in N_Entity);
555 Find_Actual (N, Formal, Call);
556
557 if Present (Formal) then
558 Kind := Ekind (Formal);
559 else
560 Kind := E_Void;
561 end if;
562
563 -- Check for obsolescent reference to package ASCII. GNAT treats this
564 -- element of annex J specially since in practice, programs make a lot
565 -- of use of this feature, so we don't include it in the set of features
566 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
567 -- are required to note it as a violation of the RM defined restriction.
568
569 if E = Standard_ASCII then
570 Check_Restriction (No_Obsolescent_Features, N);
571 end if;
572
573 -- Check for reference to entity marked with Is_Obsolescent
574
575 -- Note that we always allow obsolescent references in the compiler
576 -- itself and the run time, since we assume that we know what we are
577 -- doing in such cases. For example the calls in Ada.Characters.Handling
578 -- to its own obsolescent subprograms are just fine.
579
580 -- In any case we only generate warnings if we are in the extended main
581 -- source unit, and the entity itself is not in the extended main source
582 -- unit, since we assume the source unit itself knows what is going on
583 -- (and for sure we do not want silly warnings, e.g. on the end line of
584 -- an obsolescent procedure body).
585
586 if Is_Obsolescent (E)
587 and then not GNAT_Mode
588 and then not In_Extended_Main_Source_Unit (E)
589 and then In_Extended_Main_Source_Unit (N)
590 then
591 Check_Restriction (No_Obsolescent_Features, N);
592
593 if Warn_On_Obsolescent_Feature then
594 Output_Obsolescent_Entity_Warnings (N, E);
595 end if;
596 end if;
597
598 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
599 -- detect real explicit references (modifications and references).
600
601 if Comes_From_Source (N)
602 and then Is_Ada_2005_Only (E)
603 and then Ada_Version < Ada_2005
604 and then Warn_On_Ada_2005_Compatibility
605 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
606 then
607 Error_Msg_NE ("& is only defined in Ada 2005?y?", N, E);
608 end if;
609
610 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
611 -- detect real explicit references (modifications and references).
612
613 if Comes_From_Source (N)
614 and then Is_Ada_2012_Only (E)
615 and then Ada_Version < Ada_2012
616 and then Warn_On_Ada_2012_Compatibility
617 and then (Typ = 'm' or else Typ = 'r')
618 then
619 Error_Msg_NE ("& is only defined in Ada 2012?y?", N, E);
620 end if;
621
622 -- Do not generate references if we are within a postcondition sub-
623 -- program, because the reference does not comes from source, and the
624 -- pre-analysis of the aspect has already created an entry for the ALI
625 -- file at the proper source location.
626
627 if Chars (Current_Scope) = Name_uPostconditions then
628 return;
629 end if;
630
631 -- Never collect references if not in main source unit. However, we omit
632 -- this test if Typ is 'e' or 'k', since these entries are structural,
633 -- and it is useful to have them in units that reference packages as
634 -- well as units that define packages. We also omit the test for the
635 -- case of 'p' since we want to include inherited primitive operations
636 -- from other packages.
637
638 -- We also omit this test is this is a body reference for a subprogram
639 -- instantiation. In this case the reference is to the generic body,
640 -- which clearly need not be in the main unit containing the instance.
641 -- For the same reason we accept an implicit reference generated for
642 -- a default in an instance.
643
644 -- We also set the referenced flag in a generic package that is not in
645 -- then main source unit, when the variable is of a formal private type,
646 -- to warn in the instance if the corresponding type is not a fully
647 -- initialized type.
648
649 if not In_Extended_Main_Source_Unit (N) then
650 if Typ = 'e' or else
651 Typ = 'I' or else
652 Typ = 'p' or else
653 Typ = 'i' or else
654 Typ = 'k'
655 or else (Typ = 'b' and then Is_Generic_Instance (E))
656
657 -- Allow the generation of references to reads, writes and calls
658 -- in SPARK mode when the related context comes from an instance.
659
660 or else
661 (GNATprove_Mode
662 and then In_Extended_Main_Code_Unit (N)
663 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
664 then
665 null;
666
667 elsif In_Instance_Body
668 and then In_Extended_Main_Code_Unit (N)
669 and then Is_Generic_Type (Etype (E))
670 then
671 Set_Referenced (E);
672 return;
673
674 elsif Inside_A_Generic
675 and then Is_Generic_Type (Etype (E))
676 then
677 Set_Referenced (E);
678 return;
679
680 else
681 return;
682 end if;
683 end if;
684
685 -- For reference type p, the entity must be in main source unit
686
687 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
688 return;
689 end if;
690
691 -- Unless the reference is forced, we ignore references where the
692 -- reference itself does not come from source.
693
694 if not Force and then not Comes_From_Source (N) then
695 return;
696 end if;
697
698 -- Deal with setting entity as referenced, unless suppressed. Note that
699 -- we still do Set_Referenced on entities that do not come from source.
700 -- This situation arises when we have a source reference to a derived
701 -- operation, where the derived operation itself does not come from
702 -- source, but we still want to mark it as referenced, since we really
703 -- are referencing an entity in the corresponding package (this avoids
704 -- wrong complaints that the package contains no referenced entities).
705
706 if Set_Ref then
707
708 -- Assignable object appearing on left side of assignment or as
709 -- an out parameter.
710
711 if Is_Assignable (E)
712 and then Is_On_LHS (N)
713 and then Ekind (E) /= E_In_Out_Parameter
714 then
715 -- For objects that are renamings, just set as simply referenced
716 -- we do not try to do assignment type tracking in this case.
717
718 if Present (Renamed_Object (E)) then
719 Set_Referenced (E);
720
721 -- Out parameter case
722
723 elsif Kind = E_Out_Parameter then
724
725 -- If warning mode for all out parameters is set, or this is
726 -- the only warning parameter, then we want to mark this for
727 -- later warning logic by setting Referenced_As_Out_Parameter
728
729 if Warn_On_Modified_As_Out_Parameter (Formal) then
730 Set_Referenced_As_Out_Parameter (E, True);
731 Set_Referenced_As_LHS (E, False);
732
733 -- For OUT parameter not covered by the above cases, we simply
734 -- regard it as a normal reference (in this case we do not
735 -- want any of the warning machinery for out parameters).
736
737 else
738 Set_Referenced (E);
739 end if;
740
741 -- For the left hand of an assignment case, we do nothing here.
742 -- The processing for Analyze_Assignment_Statement will set the
743 -- Referenced_As_LHS flag.
744
745 else
746 null;
747 end if;
748
749 -- Check for a reference in a pragma that should not count as a
750 -- making the variable referenced for warning purposes.
751
752 elsif Is_Non_Significant_Pragma_Reference (N) then
753 null;
754
755 -- A reference in an attribute definition clause does not count as a
756 -- reference except for the case of Address. The reason that 'Address
757 -- is an exception is that it creates an alias through which the
758 -- variable may be referenced.
759
760 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
761 and then Chars (Parent (N)) /= Name_Address
762 and then N = Name (Parent (N))
763 then
764 null;
765
766 -- Constant completion does not count as a reference
767
768 elsif Typ = 'c'
769 and then Ekind (E) = E_Constant
770 then
771 null;
772
773 -- Record representation clause does not count as a reference
774
775 elsif Nkind (N) = N_Identifier
776 and then Nkind (Parent (N)) = N_Record_Representation_Clause
777 then
778 null;
779
780 -- Discriminants do not need to produce a reference to record type
781
782 elsif Typ = 'd'
783 and then Nkind (Parent (N)) = N_Discriminant_Specification
784 then
785 null;
786
787 -- All other cases
788
789 else
790 -- Special processing for IN OUT parameters, where we have an
791 -- implicit assignment to a simple variable.
792
793 if Kind = E_In_Out_Parameter
794 and then Is_Assignable (E)
795 then
796 -- For sure this counts as a normal read reference
797
798 Set_Referenced (E);
799 Set_Last_Assignment (E, Empty);
800
801 -- We count it as being referenced as an out parameter if the
802 -- option is set to warn on all out parameters, except that we
803 -- have a special exclusion for an intrinsic subprogram, which
804 -- is most likely an instantiation of Unchecked_Deallocation
805 -- which we do not want to consider as an assignment since it
806 -- generates false positives. We also exclude the case of an
807 -- IN OUT parameter if the name of the procedure is Free,
808 -- since we suspect similar semantics.
809
810 if Warn_On_All_Unread_Out_Parameters
811 and then Is_Entity_Name (Name (Call))
812 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
813 and then Chars (Name (Call)) /= Name_Free
814 then
815 Set_Referenced_As_Out_Parameter (E, True);
816 Set_Referenced_As_LHS (E, False);
817 end if;
818
819 -- Don't count a recursive reference within a subprogram as a
820 -- reference (that allows detection of a recursive subprogram
821 -- whose only references are recursive calls as unreferenced).
822
823 elsif Is_Subprogram (E)
824 and then E = Nearest_Dynamic_Scope (Current_Scope)
825 then
826 null;
827
828 -- Any other occurrence counts as referencing the entity
829
830 elsif OK_To_Set_Referenced then
831 Set_Referenced (E);
832
833 -- If variable, this is an OK reference after an assignment
834 -- so we can clear the Last_Assignment indication.
835
836 if Is_Assignable (E) then
837 Set_Last_Assignment (E, Empty);
838 end if;
839 end if;
840 end if;
841
842 -- Check for pragma Unreferenced given and reference is within
843 -- this source unit (occasion for possible warning to be issued).
844
845 if Has_Unreferenced (E)
846 and then In_Same_Extended_Unit (E, N)
847 then
848 -- A reference as a named parameter in a call does not count
849 -- as a violation of pragma Unreferenced for this purpose...
850
851 if Nkind (N) = N_Identifier
852 and then Nkind (Parent (N)) = N_Parameter_Association
853 and then Selector_Name (Parent (N)) = N
854 then
855 null;
856
857 -- ... Neither does a reference to a variable on the left side
858 -- of an assignment.
859
860 elsif Is_On_LHS (N) then
861 null;
862
863 -- For entry formals, we want to place the warning message on the
864 -- corresponding entity in the accept statement. The current scope
865 -- is the body of the accept, so we find the formal whose name
866 -- matches that of the entry formal (there is no link between the
867 -- two entities, and the one in the accept statement is only used
868 -- for conformance checking).
869
870 elsif Ekind (Scope (E)) = E_Entry then
871 declare
872 BE : Entity_Id;
873
874 begin
875 BE := First_Entity (Current_Scope);
876 while Present (BE) loop
877 if Chars (BE) = Chars (E) then
878 Error_Msg_NE -- CODEFIX
879 ("??pragma Unreferenced given for&!", N, BE);
880 exit;
881 end if;
882
883 Next_Entity (BE);
884 end loop;
885 end;
886
887 -- Here we issue the warning, since this is a real reference
888
889 else
890 Error_Msg_NE -- CODEFIX
891 ("??pragma Unreferenced given for&!", N, E);
892 end if;
893 end if;
894
895 -- If this is a subprogram instance, mark as well the internal
896 -- subprogram in the wrapper package, which may be a visible
897 -- compilation unit.
898
899 if Is_Overloadable (E)
900 and then Is_Generic_Instance (E)
901 and then Present (Alias (E))
902 then
903 Set_Referenced (Alias (E));
904 end if;
905 end if;
906
907 -- Generate reference if all conditions are met:
908
909 if
910 -- Cross referencing must be active
911
912 Opt.Xref_Active
913
914 -- The entity must be one for which we collect references
915
916 and then Xref_Entity_Letters (Ekind (E)) /= ' '
917
918 -- Both Sloc values must be set to something sensible
919
920 and then Sloc (E) > No_Location
921 and then Sloc (N) > No_Location
922
923 -- Ignore references from within an instance. The only exceptions to
924 -- this are default subprograms, for which we generate an implicit
925 -- reference and compilations in SPARK mode.
926
927 and then
928 (Instantiation_Location (Sloc (N)) = No_Location
929 or else Typ = 'i'
930 or else GNATprove_Mode)
931
932 -- Ignore dummy references
933
934 and then Typ /= ' '
935 then
936 if Nkind_In (N, N_Identifier,
937 N_Defining_Identifier,
938 N_Defining_Operator_Symbol,
939 N_Operator_Symbol,
940 N_Defining_Character_Literal)
941 or else Nkind (N) in N_Op
942 or else (Nkind (N) = N_Character_Literal
943 and then Sloc (Entity (N)) /= Standard_Location)
944 then
945 Nod := N;
946
947 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
948 Nod := Selector_Name (N);
949
950 else
951 return;
952 end if;
953
954 -- Normal case of source entity comes from source
955
956 if Comes_From_Source (E) then
957 Ent := E;
958
959 -- Because a declaration may be generated for a subprogram body
960 -- without declaration in GNATprove mode, for inlining, some
961 -- parameters may end up being marked as not coming from source
962 -- although they are. Take these into account specially.
963
964 elsif GNATprove_Mode and then Ekind (E) in Formal_Kind then
965 Ent := E;
966
967 -- Entity does not come from source, but is a derived subprogram and
968 -- the derived subprogram comes from source (after one or more
969 -- derivations) in which case the reference is to parent subprogram.
970
971 elsif Is_Overloadable (E)
972 and then Present (Alias (E))
973 then
974 Ent := Alias (E);
975 while not Comes_From_Source (Ent) loop
976 if No (Alias (Ent)) then
977 return;
978 end if;
979
980 Ent := Alias (Ent);
981 end loop;
982
983 -- The internally created defining entity for a child subprogram
984 -- that has no previous spec has valid references.
985
986 elsif Is_Overloadable (E)
987 and then Is_Child_Unit (E)
988 then
989 Ent := E;
990
991 -- Ditto for the formals of such a subprogram
992
993 elsif Is_Overloadable (Scope (E))
994 and then Is_Child_Unit (Scope (E))
995 then
996 Ent := E;
997
998 -- Record components of discriminated subtypes or derived types must
999 -- be treated as references to the original component.
1000
1001 elsif Ekind (E) = E_Component
1002 and then Comes_From_Source (Original_Record_Component (E))
1003 then
1004 Ent := Original_Record_Component (E);
1005
1006 -- If this is an expanded reference to a discriminant, recover the
1007 -- original discriminant, which gets the reference.
1008
1009 elsif Ekind (E) = E_In_Parameter
1010 and then Present (Discriminal_Link (E))
1011 then
1012 Ent := Discriminal_Link (E);
1013 Set_Referenced (Ent);
1014
1015 -- Ignore reference to any other entity that is not from source
1016
1017 else
1018 return;
1019 end if;
1020
1021 -- In SPARK mode, consider the underlying entity renamed instead of
1022 -- the renaming, which is needed to compute a valid set of effects
1023 -- (reads, writes) for the enclosing subprogram.
1024
1025 if GNATprove_Mode then
1026 Ent := Get_Through_Renamings (Ent);
1027
1028 -- If no enclosing object, then it could be a reference to any
1029 -- location not tracked individually, like heap-allocated data.
1030 -- Conservatively approximate this possibility by generating a
1031 -- dereference, and return.
1032
1033 if No (Ent) then
1034 if Actual_Typ = 'w' then
1035 SPARK_Specific.Generate_Dereference (Nod, 'r');
1036 SPARK_Specific.Generate_Dereference (Nod, 'w');
1037 else
1038 SPARK_Specific.Generate_Dereference (Nod, 'r');
1039 end if;
1040
1041 return;
1042 end if;
1043 end if;
1044
1045 -- Record reference to entity
1046
1047 if Actual_Typ = 'p'
1048 and then Is_Subprogram (Nod)
1049 and then Present (Overridden_Operation (Nod))
1050 then
1051 Actual_Typ := 'P';
1052 end if;
1053
1054 -- Comment needed here for special SPARK code ???
1055
1056 if GNATprove_Mode then
1057 Ref := Sloc (Nod);
1058 Def := Sloc (Ent);
1059
1060 Ref_Scope :=
1061 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1062 Ent_Scope :=
1063 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1064
1065 -- Since we are reaching through renamings in SPARK mode, we may
1066 -- end up with standard constants. Ignore those.
1067
1068 if Sloc (Ent_Scope) <= Standard_Location
1069 or else Def <= Standard_Location
1070 then
1071 return;
1072 end if;
1073
1074 Add_Entry
1075 ((Ent => Ent,
1076 Loc => Ref,
1077 Typ => Actual_Typ,
1078 Eun => Get_Top_Level_Code_Unit (Def),
1079 Lun => Get_Top_Level_Code_Unit (Ref),
1080 Ref_Scope => Ref_Scope,
1081 Ent_Scope => Ent_Scope),
1082 Ent_Scope_File => Get_Top_Level_Code_Unit (Ent));
1083
1084 else
1085 Ref := Original_Location (Sloc (Nod));
1086 Def := Original_Location (Sloc (Ent));
1087
1088 -- If this is an operator symbol, skip the initial quote for
1089 -- navigation purposes. This is not done for the end label,
1090 -- where we want the actual position after the closing quote.
1091
1092 if Typ = 't' then
1093 null;
1094
1095 elsif Nkind (N) = N_Defining_Operator_Symbol
1096 or else Nkind (Nod) = N_Operator_Symbol
1097 then
1098 Ref := Ref + 1;
1099 end if;
1100
1101 Add_Entry
1102 ((Ent => Ent,
1103 Loc => Ref,
1104 Typ => Actual_Typ,
1105 Eun => Get_Source_Unit (Def),
1106 Lun => Get_Source_Unit (Ref),
1107 Ref_Scope => Empty,
1108 Ent_Scope => Empty),
1109 Ent_Scope_File => No_Unit);
1110
1111 -- Generate reference to the first private entity
1112
1113 if Typ = 'e'
1114 and then Comes_From_Source (E)
1115 and then Nkind (Ent) = N_Defining_Identifier
1116 and then (Is_Package_Or_Generic_Package (Ent)
1117 or else Is_Concurrent_Type (Ent))
1118 and then Present (First_Private_Entity (E))
1119 and then In_Extended_Main_Source_Unit (N)
1120 then
1121 -- Handle case in which the full-view and partial-view of the
1122 -- first private entity are swapped.
1123
1124 declare
1125 First_Private : Entity_Id := First_Private_Entity (E);
1126
1127 begin
1128 if Is_Private_Type (First_Private)
1129 and then Present (Full_View (First_Private))
1130 then
1131 First_Private := Full_View (First_Private);
1132 end if;
1133
1134 Add_Entry
1135 ((Ent => Ent,
1136 Loc => Sloc (First_Private),
1137 Typ => 'E',
1138 Eun => Get_Source_Unit (Def),
1139 Lun => Get_Source_Unit (Ref),
1140 Ref_Scope => Empty,
1141 Ent_Scope => Empty),
1142 Ent_Scope_File => No_Unit);
1143 end;
1144 end if;
1145 end if;
1146 end if;
1147 end Generate_Reference;
1148
1149 -----------------------------------
1150 -- Generate_Reference_To_Formals --
1151 -----------------------------------
1152
1153 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1154 Formal : Entity_Id;
1155
1156 begin
1157 if Is_Generic_Subprogram (E) then
1158 Formal := First_Entity (E);
1159
1160 while Present (Formal)
1161 and then not Is_Formal (Formal)
1162 loop
1163 Next_Entity (Formal);
1164 end loop;
1165
1166 elsif Ekind (E) in Access_Subprogram_Kind then
1167 Formal := First_Formal (Designated_Type (E));
1168
1169 else
1170 Formal := First_Formal (E);
1171 end if;
1172
1173 while Present (Formal) loop
1174 if Ekind (Formal) = E_In_Parameter then
1175
1176 if Nkind (Parameter_Type (Parent (Formal))) = N_Access_Definition
1177 then
1178 Generate_Reference (E, Formal, '^', False);
1179 else
1180 Generate_Reference (E, Formal, '>', False);
1181 end if;
1182
1183 elsif Ekind (Formal) = E_In_Out_Parameter then
1184 Generate_Reference (E, Formal, '=', False);
1185
1186 else
1187 Generate_Reference (E, Formal, '<', False);
1188 end if;
1189
1190 Next_Formal (Formal);
1191 end loop;
1192 end Generate_Reference_To_Formals;
1193
1194 -------------------------------------------
1195 -- Generate_Reference_To_Generic_Formals --
1196 -------------------------------------------
1197
1198 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1199 Formal : Entity_Id;
1200
1201 begin
1202 Formal := First_Entity (E);
1203 while Present (Formal) loop
1204 if Comes_From_Source (Formal) then
1205 Generate_Reference (E, Formal, 'z', False);
1206 end if;
1207
1208 Next_Entity (Formal);
1209 end loop;
1210 end Generate_Reference_To_Generic_Formals;
1211
1212 -------------
1213 -- Get_Key --
1214 -------------
1215
1216 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1217 begin
1218 return E;
1219 end Get_Key;
1220
1221 ----------------------------
1222 -- Has_Deferred_Reference --
1223 ----------------------------
1224
1225 function Has_Deferred_Reference (Ent : Entity_Id) return Boolean is
1226 begin
1227 for J in Deferred_References.First .. Deferred_References.Last loop
1228 if Deferred_References.Table (J).E = Ent then
1229 return True;
1230 end if;
1231 end loop;
1232
1233 return False;
1234 end Has_Deferred_Reference;
1235
1236 ----------
1237 -- Hash --
1238 ----------
1239
1240 function Hash (F : Xref_Entry_Number) return Header_Num is
1241 -- It is unlikely to have two references to the same entity at the same
1242 -- source location, so the hash function depends only on the Ent and Loc
1243 -- fields.
1244
1245 XE : Xref_Entry renames Xrefs.Table (F);
1246 type M is mod 2**32;
1247
1248 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1249 -- It would be more natural to write:
1250 --
1251 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1252 --
1253 -- But we can't use M'Mod, because it prevents bootstrapping with older
1254 -- compilers. Loc can be negative, so we do "abs" before converting.
1255 -- One day this can be cleaned up ???
1256
1257 begin
1258 return Header_Num (H mod Num_Buckets);
1259 end Hash;
1260
1261 -----------------
1262 -- HT_Set_Next --
1263 -----------------
1264
1265 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1266 begin
1267 Xrefs.Table (E).HTable_Next := Next;
1268 end HT_Set_Next;
1269
1270 -------------
1271 -- HT_Next --
1272 -------------
1273
1274 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1275 begin
1276 return Xrefs.Table (E).HTable_Next;
1277 end HT_Next;
1278
1279 ----------------
1280 -- Initialize --
1281 ----------------
1282
1283 procedure Initialize is
1284 begin
1285 Xrefs.Init;
1286 end Initialize;
1287
1288 --------
1289 -- Lt --
1290 --------
1291
1292 function Lt (T1, T2 : Xref_Entry) return Boolean is
1293 begin
1294 -- First test: if entity is in different unit, sort by unit
1295
1296 if T1.Key.Eun /= T2.Key.Eun then
1297 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1298
1299 -- Second test: within same unit, sort by entity Sloc
1300
1301 elsif T1.Def /= T2.Def then
1302 return T1.Def < T2.Def;
1303
1304 -- Third test: sort definitions ahead of references
1305
1306 elsif T1.Key.Loc = No_Location then
1307 return True;
1308
1309 elsif T2.Key.Loc = No_Location then
1310 return False;
1311
1312 -- Fourth test: for same entity, sort by reference location unit
1313
1314 elsif T1.Key.Lun /= T2.Key.Lun then
1315 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1316
1317 -- Fifth test: order of location within referencing unit
1318
1319 elsif T1.Key.Loc /= T2.Key.Loc then
1320 return T1.Key.Loc < T2.Key.Loc;
1321
1322 -- Finally, for two locations at the same address, we prefer
1323 -- the one that does NOT have the type 'r' so that a modification
1324 -- or extension takes preference, when there are more than one
1325 -- reference at the same location. As a result, in the case of
1326 -- entities that are in-out actuals, the read reference follows
1327 -- the modify reference.
1328
1329 else
1330 return T2.Key.Typ = 'r';
1331 end if;
1332 end Lt;
1333
1334 -----------------------
1335 -- Output_References --
1336 -----------------------
1337
1338 procedure Output_References is
1339
1340 procedure Get_Type_Reference
1341 (Ent : Entity_Id;
1342 Tref : out Entity_Id;
1343 Left : out Character;
1344 Right : out Character);
1345 -- Given an Entity_Id Ent, determines whether a type reference is
1346 -- required. If so, Tref is set to the entity for the type reference
1347 -- and Left and Right are set to the left/right brackets to be output
1348 -- for the reference. If no type reference is required, then Tref is
1349 -- set to Empty, and Left/Right are set to space.
1350
1351 procedure Output_Import_Export_Info (Ent : Entity_Id);
1352 -- Output language and external name information for an interfaced
1353 -- entity, using the format <language, external_name>.
1354
1355 ------------------------
1356 -- Get_Type_Reference --
1357 ------------------------
1358
1359 procedure Get_Type_Reference
1360 (Ent : Entity_Id;
1361 Tref : out Entity_Id;
1362 Left : out Character;
1363 Right : out Character)
1364 is
1365 Sav : Entity_Id;
1366
1367 begin
1368 -- See if we have a type reference
1369
1370 Tref := Ent;
1371 Left := '{';
1372 Right := '}';
1373
1374 loop
1375 Sav := Tref;
1376
1377 -- Processing for types
1378
1379 if Is_Type (Tref) then
1380
1381 -- Case of base type
1382
1383 if Base_Type (Tref) = Tref then
1384
1385 -- If derived, then get first subtype
1386
1387 if Tref /= Etype (Tref) then
1388 Tref := First_Subtype (Etype (Tref));
1389
1390 -- Set brackets for derived type, but don't override
1391 -- pointer case since the fact that something is a
1392 -- pointer is more important.
1393
1394 if Left /= '(' then
1395 Left := '<';
1396 Right := '>';
1397 end if;
1398
1399 -- If the completion of a private type is itself a derived
1400 -- type, we need the parent of the full view.
1401
1402 elsif Is_Private_Type (Tref)
1403 and then Present (Full_View (Tref))
1404 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1405 then
1406 Tref := Etype (Full_View (Tref));
1407
1408 if Left /= '(' then
1409 Left := '<';
1410 Right := '>';
1411 end if;
1412
1413 -- If non-derived pointer, get directly designated type.
1414 -- If the type has a full view, all references are on the
1415 -- partial view that is seen first.
1416
1417 elsif Is_Access_Type (Tref) then
1418 Tref := Directly_Designated_Type (Tref);
1419 Left := '(';
1420 Right := ')';
1421
1422 elsif Is_Private_Type (Tref)
1423 and then Present (Full_View (Tref))
1424 then
1425 if Is_Access_Type (Full_View (Tref)) then
1426 Tref := Directly_Designated_Type (Full_View (Tref));
1427 Left := '(';
1428 Right := ')';
1429
1430 -- If the full view is an array type, we also retrieve
1431 -- the corresponding component type, because the ali
1432 -- entry already indicates that this is an array.
1433
1434 elsif Is_Array_Type (Full_View (Tref)) then
1435 Tref := Component_Type (Full_View (Tref));
1436 Left := '(';
1437 Right := ')';
1438 end if;
1439
1440 -- If non-derived array, get component type. Skip component
1441 -- type for case of String or Wide_String, saves worthwhile
1442 -- space.
1443
1444 elsif Is_Array_Type (Tref)
1445 and then Tref /= Standard_String
1446 and then Tref /= Standard_Wide_String
1447 then
1448 Tref := Component_Type (Tref);
1449 Left := '(';
1450 Right := ')';
1451
1452 -- For other non-derived base types, nothing
1453
1454 else
1455 exit;
1456 end if;
1457
1458 -- For a subtype, go to ancestor subtype
1459
1460 else
1461 Tref := Ancestor_Subtype (Tref);
1462
1463 -- If no ancestor subtype, go to base type
1464
1465 if No (Tref) then
1466 Tref := Base_Type (Sav);
1467 end if;
1468 end if;
1469
1470 -- For objects, functions, enum literals, just get type from
1471 -- Etype field.
1472
1473 elsif Is_Object (Tref)
1474 or else Ekind (Tref) = E_Enumeration_Literal
1475 or else Ekind (Tref) = E_Function
1476 or else Ekind (Tref) = E_Operator
1477 then
1478 Tref := Etype (Tref);
1479
1480 -- Another special case: an object of a classwide type
1481 -- initialized with a tag-indeterminate call gets a subtype
1482 -- of the classwide type during expansion. See if the original
1483 -- type in the declaration is named, and return it instead
1484 -- of going to the root type. The expression may be a class-
1485 -- wide function call whose result is on the secondary stack,
1486 -- which forces the declaration to be rewritten as a renaming,
1487 -- so examine the source declaration.
1488
1489 if Ekind (Tref) = E_Class_Wide_Subtype then
1490 declare
1491 Decl : constant Node_Id := Original_Node (Parent (Ent));
1492 begin
1493 if Nkind (Decl) = N_Object_Declaration
1494 and then Is_Entity_Name
1495 (Original_Node (Object_Definition (Decl)))
1496 then
1497 Tref :=
1498 Entity (Original_Node (Object_Definition (Decl)));
1499 end if;
1500 end;
1501 end if;
1502
1503 -- For anything else, exit
1504
1505 else
1506 exit;
1507 end if;
1508
1509 -- Exit if no type reference, or we are stuck in some loop trying
1510 -- to find the type reference, or if the type is standard void
1511 -- type (the latter is an implementation artifact that should not
1512 -- show up in the generated cross-references).
1513
1514 exit when No (Tref)
1515 or else Tref = Sav
1516 or else Tref = Standard_Void_Type;
1517
1518 -- If we have a usable type reference, return, otherwise keep
1519 -- looking for something useful (we are looking for something
1520 -- that either comes from source or standard)
1521
1522 if Sloc (Tref) = Standard_Location
1523 or else Comes_From_Source (Tref)
1524 then
1525 -- If the reference is a subtype created for a generic actual,
1526 -- go actual directly, the inner subtype is not user visible.
1527
1528 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1529 and then not Comes_From_Source (Parent (Tref))
1530 and then
1531 (Is_Wrapper_Package (Scope (Tref))
1532 or else Is_Generic_Instance (Scope (Tref)))
1533 then
1534 Tref := First_Subtype (Base_Type (Tref));
1535 end if;
1536
1537 return;
1538 end if;
1539 end loop;
1540
1541 -- If we fall through the loop, no type reference
1542
1543 Tref := Empty;
1544 Left := ' ';
1545 Right := ' ';
1546 end Get_Type_Reference;
1547
1548 -------------------------------
1549 -- Output_Import_Export_Info --
1550 -------------------------------
1551
1552 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1553 Language_Name : Name_Id;
1554 Conv : constant Convention_Id := Convention (Ent);
1555
1556 begin
1557 -- Generate language name from convention
1558
1559 if Conv = Convention_C then
1560 Language_Name := Name_C;
1561
1562 elsif Conv = Convention_CPP then
1563 Language_Name := Name_CPP;
1564
1565 elsif Conv = Convention_Ada then
1566 Language_Name := Name_Ada;
1567
1568 else
1569 -- For the moment we ignore all other cases ???
1570
1571 return;
1572 end if;
1573
1574 Write_Info_Char ('<');
1575 Get_Unqualified_Name_String (Language_Name);
1576
1577 for J in 1 .. Name_Len loop
1578 Write_Info_Char (Name_Buffer (J));
1579 end loop;
1580
1581 if Present (Interface_Name (Ent)) then
1582 Write_Info_Char (',');
1583 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1584
1585 for J in 1 .. Name_Len loop
1586 Write_Info_Char (Name_Buffer (J));
1587 end loop;
1588 end if;
1589
1590 Write_Info_Char ('>');
1591 end Output_Import_Export_Info;
1592
1593 -- Start of processing for Output_References
1594
1595 begin
1596 -- First we add references to the primitive operations of tagged types
1597 -- declared in the main unit.
1598
1599 Handle_Prim_Ops : declare
1600 Ent : Entity_Id;
1601
1602 begin
1603 for J in 1 .. Xrefs.Last loop
1604 Ent := Xrefs.Table (J).Key.Ent;
1605
1606 if Is_Type (Ent)
1607 and then Is_Tagged_Type (Ent)
1608 and then Is_Base_Type (Ent)
1609 and then In_Extended_Main_Source_Unit (Ent)
1610 then
1611 Generate_Prim_Op_References (Ent);
1612 end if;
1613 end loop;
1614 end Handle_Prim_Ops;
1615
1616 -- Before we go ahead and output the references we have a problem
1617 -- that needs dealing with. So far we have captured things that are
1618 -- definitely referenced by the main unit, or defined in the main
1619 -- unit. That's because we don't want to clutter up the ali file
1620 -- for this unit with definition lines for entities in other units
1621 -- that are not referenced.
1622
1623 -- But there is a glitch. We may reference an entity in another unit,
1624 -- and it may have a type reference to an entity that is not directly
1625 -- referenced in the main unit, which may mean that there is no xref
1626 -- entry for this entity yet in the list of references.
1627
1628 -- If we don't do something about this, we will end with an orphan type
1629 -- reference, i.e. it will point to an entity that does not appear
1630 -- within the generated references in the ali file. That is not good for
1631 -- tools using the xref information.
1632
1633 -- To fix this, we go through the references adding definition entries
1634 -- for any unreferenced entities that can be referenced in a type
1635 -- reference. There is a recursion problem here, and that is dealt with
1636 -- by making sure that this traversal also traverses any entries that
1637 -- get added by the traversal.
1638
1639 Handle_Orphan_Type_References : declare
1640 J : Nat;
1641 Tref : Entity_Id;
1642 Ent : Entity_Id;
1643
1644 L, R : Character;
1645 pragma Warnings (Off, L);
1646 pragma Warnings (Off, R);
1647
1648 procedure New_Entry (E : Entity_Id);
1649 -- Make an additional entry into the Xref table for a type entity
1650 -- that is related to the current entity (parent, type ancestor,
1651 -- progenitor, etc.).
1652
1653 ----------------
1654 -- New_Entry --
1655 ----------------
1656
1657 procedure New_Entry (E : Entity_Id) is
1658 begin
1659 pragma Assert (Present (E));
1660
1661 if not Has_Xref_Entry (Implementation_Base_Type (E))
1662 and then Sloc (E) > No_Location
1663 then
1664 Add_Entry
1665 ((Ent => E,
1666 Loc => No_Location,
1667 Typ => Character'First,
1668 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1669 Lun => No_Unit,
1670 Ref_Scope => Empty,
1671 Ent_Scope => Empty),
1672 Ent_Scope_File => No_Unit);
1673 end if;
1674 end New_Entry;
1675
1676 -- Start of processing for Handle_Orphan_Type_References
1677
1678 begin
1679 -- Note that this is not a for loop for a very good reason. The
1680 -- processing of items in the table can add new items to the table,
1681 -- and they must be processed as well.
1682
1683 J := 1;
1684 while J <= Xrefs.Last loop
1685 Ent := Xrefs.Table (J).Key.Ent;
1686
1687 -- Do not generate reference information for an ignored Ghost
1688 -- entity because neither the entity nor its references will
1689 -- appear in the final tree.
1690
1691 if Is_Ignored_Ghost_Entity (Ent) then
1692 goto Orphan_Continue;
1693 end if;
1694
1695 Get_Type_Reference (Ent, Tref, L, R);
1696
1697 if Present (Tref)
1698 and then not Has_Xref_Entry (Tref)
1699 and then Sloc (Tref) > No_Location
1700 then
1701 New_Entry (Tref);
1702
1703 if Is_Record_Type (Ent)
1704 and then Present (Interfaces (Ent))
1705 then
1706 -- Add an entry for each one of the given interfaces
1707 -- implemented by type Ent.
1708
1709 declare
1710 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1711 begin
1712 while Present (Elmt) loop
1713 New_Entry (Node (Elmt));
1714 Next_Elmt (Elmt);
1715 end loop;
1716 end;
1717 end if;
1718 end if;
1719
1720 -- Collect inherited primitive operations that may be declared in
1721 -- another unit and have no visible reference in the current one.
1722
1723 if Is_Type (Ent)
1724 and then Is_Tagged_Type (Ent)
1725 and then Is_Derived_Type (Ent)
1726 and then Is_Base_Type (Ent)
1727 and then In_Extended_Main_Source_Unit (Ent)
1728 then
1729 declare
1730 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1731 Op : Elmt_Id;
1732 Prim : Entity_Id;
1733
1734 function Parent_Op (E : Entity_Id) return Entity_Id;
1735 -- Find original operation, which may be inherited through
1736 -- several derivations.
1737
1738 function Parent_Op (E : Entity_Id) return Entity_Id is
1739 Orig_Op : constant Entity_Id := Alias (E);
1740
1741 begin
1742 if No (Orig_Op) then
1743 return Empty;
1744
1745 elsif not Comes_From_Source (E)
1746 and then not Has_Xref_Entry (Orig_Op)
1747 and then Comes_From_Source (Orig_Op)
1748 then
1749 return Orig_Op;
1750 else
1751 return Parent_Op (Orig_Op);
1752 end if;
1753 end Parent_Op;
1754
1755 begin
1756 Op := First_Elmt (Op_List);
1757 while Present (Op) loop
1758 Prim := Parent_Op (Node (Op));
1759
1760 if Present (Prim) then
1761 Add_Entry
1762 ((Ent => Prim,
1763 Loc => No_Location,
1764 Typ => Character'First,
1765 Eun => Get_Source_Unit (Sloc (Prim)),
1766 Lun => No_Unit,
1767 Ref_Scope => Empty,
1768 Ent_Scope => Empty),
1769 Ent_Scope_File => No_Unit);
1770 end if;
1771
1772 Next_Elmt (Op);
1773 end loop;
1774 end;
1775 end if;
1776
1777 <<Orphan_Continue>>
1778 J := J + 1;
1779 end loop;
1780 end Handle_Orphan_Type_References;
1781
1782 -- Now we have all the references, including those for any embedded type
1783 -- references, so we can sort them, and output them.
1784
1785 Output_Refs : declare
1786 Nrefs : constant Nat := Xrefs.Last;
1787 -- Number of references in table
1788
1789 Rnums : array (0 .. Nrefs) of Nat;
1790 -- This array contains numbers of references in the Xrefs table.
1791 -- This list is sorted in output order. The extra 0'th entry is
1792 -- convenient for the call to sort. When we sort the table, we
1793 -- move the entries in Rnums around, but we do not move the
1794 -- original table entries.
1795
1796 Curxu : Unit_Number_Type;
1797 -- Current xref unit
1798
1799 Curru : Unit_Number_Type;
1800 -- Current reference unit for one entity
1801
1802 Curent : Entity_Id;
1803 -- Current entity
1804
1805 Curnam : String (1 .. Name_Buffer'Length);
1806 Curlen : Natural;
1807 -- Simple name and length of current entity
1808
1809 Curdef : Source_Ptr;
1810 -- Original source location for current entity
1811
1812 Crloc : Source_Ptr;
1813 -- Current reference location
1814
1815 Ctyp : Character;
1816 -- Entity type character
1817
1818 Prevt : Character;
1819 -- reference kind of previous reference
1820
1821 Tref : Entity_Id;
1822 -- Type reference
1823
1824 Rref : Node_Id;
1825 -- Renaming reference
1826
1827 Trunit : Unit_Number_Type;
1828 -- Unit number for type reference
1829
1830 function Lt (Op1, Op2 : Natural) return Boolean;
1831 -- Comparison function for Sort call
1832
1833 function Name_Change (X : Entity_Id) return Boolean;
1834 -- Determines if entity X has a different simple name from Curent
1835
1836 procedure Move (From : Natural; To : Natural);
1837 -- Move procedure for Sort call
1838
1839 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1840
1841 --------
1842 -- Lt --
1843 --------
1844
1845 function Lt (Op1, Op2 : Natural) return Boolean is
1846 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1847 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1848
1849 begin
1850 return Lt (T1, T2);
1851 end Lt;
1852
1853 ----------
1854 -- Move --
1855 ----------
1856
1857 procedure Move (From : Natural; To : Natural) is
1858 begin
1859 Rnums (Nat (To)) := Rnums (Nat (From));
1860 end Move;
1861
1862 -----------------
1863 -- Name_Change --
1864 -----------------
1865
1866 -- Why a string comparison here??? Why not compare Name_Id values???
1867
1868 function Name_Change (X : Entity_Id) return Boolean is
1869 begin
1870 Get_Unqualified_Name_String (Chars (X));
1871
1872 if Name_Len /= Curlen then
1873 return True;
1874 else
1875 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1876 end if;
1877 end Name_Change;
1878
1879 -- Start of processing for Output_Refs
1880
1881 begin
1882 -- Capture the definition Sloc values. We delay doing this till now,
1883 -- since at the time the reference or definition is made, private
1884 -- types may be swapped, and the Sloc value may be incorrect. We
1885 -- also set up the pointer vector for the sort.
1886
1887 -- For user-defined operators we need to skip the initial quote and
1888 -- point to the first character of the name, for navigation purposes.
1889
1890 for J in 1 .. Nrefs loop
1891 declare
1892 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1893 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1894
1895 begin
1896 Rnums (J) := J;
1897
1898 if Nkind (E) = N_Defining_Operator_Symbol then
1899 Xrefs.Table (J).Def := Loc + 1;
1900 else
1901 Xrefs.Table (J).Def := Loc;
1902 end if;
1903 end;
1904 end loop;
1905
1906 -- Sort the references
1907
1908 Sorting.Sort (Integer (Nrefs));
1909
1910 -- Initialize loop through references
1911
1912 Curxu := No_Unit;
1913 Curent := Empty;
1914 Curdef := No_Location;
1915 Curru := No_Unit;
1916 Crloc := No_Location;
1917 Prevt := 'm';
1918
1919 -- Loop to output references
1920
1921 for Refno in 1 .. Nrefs loop
1922 Output_One_Ref : declare
1923 Ent : Entity_Id;
1924
1925 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1926 -- The current entry to be accessed
1927
1928 Left : Character;
1929 Right : Character;
1930 -- Used for {} or <> or () for type reference
1931
1932 procedure Check_Type_Reference
1933 (Ent : Entity_Id;
1934 List_Interface : Boolean;
1935 Is_Component : Boolean := False);
1936 -- Find whether there is a meaningful type reference for
1937 -- Ent, and display it accordingly. If List_Interface is
1938 -- true, then Ent is a progenitor interface of the current
1939 -- type entity being listed. In that case list it as is,
1940 -- without looking for a type reference for it. Flag is also
1941 -- used for index types of an array type, where the caller
1942 -- supplies the intended type reference. Is_Component serves
1943 -- the same purpose, to display the component type of a
1944 -- derived array type, for which only the parent type has
1945 -- ben displayed so far.
1946
1947 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1948 -- Recursive procedure to output instantiation references for
1949 -- the given source ptr in [file|line[...]] form. No output
1950 -- if the given location is not a generic template reference.
1951
1952 procedure Output_Overridden_Op (Old_E : Entity_Id);
1953 -- For a subprogram that is overriding, display information
1954 -- about the inherited operation that it overrides.
1955
1956 --------------------------
1957 -- Check_Type_Reference --
1958 --------------------------
1959
1960 procedure Check_Type_Reference
1961 (Ent : Entity_Id;
1962 List_Interface : Boolean;
1963 Is_Component : Boolean := False)
1964 is
1965 begin
1966 if List_Interface then
1967
1968 -- This is a progenitor interface of the type for which
1969 -- xref information is being generated.
1970
1971 Tref := Ent;
1972 Left := '<';
1973 Right := '>';
1974
1975 -- The following is not documented in lib-xref.ads ???
1976
1977 elsif Is_Component then
1978 Tref := Ent;
1979 Left := '(';
1980 Right := ')';
1981
1982 else
1983 Get_Type_Reference (Ent, Tref, Left, Right);
1984 end if;
1985
1986 if Present (Tref) then
1987
1988 -- Case of standard entity, output name
1989
1990 if Sloc (Tref) = Standard_Location then
1991 Write_Info_Char (Left);
1992 Write_Info_Name (Chars (Tref));
1993 Write_Info_Char (Right);
1994
1995 -- Case of source entity, output location
1996
1997 else
1998 Write_Info_Char (Left);
1999 Trunit := Get_Source_Unit (Sloc (Tref));
2000
2001 if Trunit /= Curxu then
2002 Write_Info_Nat (Dependency_Num (Trunit));
2003 Write_Info_Char ('|');
2004 end if;
2005
2006 Write_Info_Nat
2007 (Int (Get_Logical_Line_Number (Sloc (Tref))));
2008
2009 declare
2010 Ent : Entity_Id;
2011 Ctyp : Character;
2012
2013 begin
2014 Ent := Tref;
2015 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2016
2017 if Ctyp = '+'
2018 and then Present (Full_View (Ent))
2019 then
2020 Ent := Underlying_Type (Ent);
2021
2022 if Present (Ent) then
2023 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2024 end if;
2025 end if;
2026
2027 Write_Info_Char (Ctyp);
2028 end;
2029
2030 Write_Info_Nat
2031 (Int (Get_Column_Number (Sloc (Tref))));
2032
2033 -- If the type comes from an instantiation, add the
2034 -- corresponding info.
2035
2036 Output_Instantiation_Refs (Sloc (Tref));
2037 Write_Info_Char (Right);
2038 end if;
2039 end if;
2040 end Check_Type_Reference;
2041
2042 -------------------------------
2043 -- Output_Instantiation_Refs --
2044 -------------------------------
2045
2046 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
2047 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
2048 Lun : Unit_Number_Type;
2049 Cu : constant Unit_Number_Type := Curru;
2050
2051 begin
2052 -- Nothing to do if this is not an instantiation
2053
2054 if Iloc = No_Location then
2055 return;
2056 end if;
2057
2058 -- Output instantiation reference
2059
2060 Write_Info_Char ('[');
2061 Lun := Get_Source_Unit (Iloc);
2062
2063 if Lun /= Curru then
2064 Curru := Lun;
2065 Write_Info_Nat (Dependency_Num (Curru));
2066 Write_Info_Char ('|');
2067 end if;
2068
2069 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2070
2071 -- Recursive call to get nested instantiations
2072
2073 Output_Instantiation_Refs (Iloc);
2074
2075 -- Output final ] after call to get proper nesting
2076
2077 Write_Info_Char (']');
2078 Curru := Cu;
2079 return;
2080 end Output_Instantiation_Refs;
2081
2082 --------------------------
2083 -- Output_Overridden_Op --
2084 --------------------------
2085
2086 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2087 Op : Entity_Id;
2088
2089 begin
2090 -- The overridden operation has an implicit declaration
2091 -- at the point of derivation. What we want to display
2092 -- is the original operation, which has the actual body
2093 -- (or abstract declaration) that is being overridden.
2094 -- The overridden operation is not always set, e.g. when
2095 -- it is a predefined operator.
2096
2097 if No (Old_E) then
2098 return;
2099
2100 -- Follow alias chain if one is present
2101
2102 elsif Present (Alias (Old_E)) then
2103
2104 -- The subprogram may have been implicitly inherited
2105 -- through several levels of derivation, so find the
2106 -- ultimate (source) ancestor.
2107
2108 Op := Ultimate_Alias (Old_E);
2109
2110 -- Normal case of no alias present. We omit generated
2111 -- primitives like tagged equality, that have no source
2112 -- representation.
2113
2114 else
2115 Op := Old_E;
2116 end if;
2117
2118 if Present (Op)
2119 and then Sloc (Op) /= Standard_Location
2120 and then Comes_From_Source (Op)
2121 then
2122 declare
2123 Loc : constant Source_Ptr := Sloc (Op);
2124 Par_Unit : constant Unit_Number_Type :=
2125 Get_Source_Unit (Loc);
2126
2127 begin
2128 Write_Info_Char ('<');
2129
2130 if Par_Unit /= Curxu then
2131 Write_Info_Nat (Dependency_Num (Par_Unit));
2132 Write_Info_Char ('|');
2133 end if;
2134
2135 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2136 Write_Info_Char ('p');
2137 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2138 Write_Info_Char ('>');
2139 end;
2140 end if;
2141 end Output_Overridden_Op;
2142
2143 -- Start of processing for Output_One_Ref
2144
2145 begin
2146 Ent := XE.Key.Ent;
2147
2148 -- Do not generate reference information for an ignored Ghost
2149 -- entity because neither the entity nor its references will
2150 -- appear in the final tree.
2151
2152 if Is_Ignored_Ghost_Entity (Ent) then
2153 goto Continue;
2154 end if;
2155
2156 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2157
2158 -- Skip reference if it is the only reference to an entity,
2159 -- and it is an END line reference, and the entity is not in
2160 -- the current extended source. This prevents junk entries
2161 -- consisting only of packages with END lines, where no
2162 -- entity from the package is actually referenced.
2163
2164 if XE.Key.Typ = 'e'
2165 and then Ent /= Curent
2166 and then (Refno = Nrefs
2167 or else
2168 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2169 and then not In_Extended_Main_Source_Unit (Ent)
2170 then
2171 goto Continue;
2172 end if;
2173
2174 -- For private type, get full view type
2175
2176 if Ctyp = '+'
2177 and then Present (Full_View (XE.Key.Ent))
2178 then
2179 Ent := Underlying_Type (Ent);
2180
2181 if Present (Ent) then
2182 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2183 end if;
2184 end if;
2185
2186 -- Special exception for Boolean
2187
2188 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2189 Ctyp := 'B';
2190 end if;
2191
2192 -- For variable reference, get corresponding type
2193
2194 if Ctyp = '*' then
2195 Ent := Etype (XE.Key.Ent);
2196 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2197
2198 -- If variable is private type, get full view type
2199
2200 if Ctyp = '+'
2201 and then Present (Full_View (Etype (XE.Key.Ent)))
2202 then
2203 Ent := Underlying_Type (Etype (XE.Key.Ent));
2204
2205 if Present (Ent) then
2206 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2207 end if;
2208
2209 elsif Is_Generic_Type (Ent) then
2210
2211 -- If the type of the entity is a generic private type,
2212 -- there is no usable full view, so retain the indication
2213 -- that this is an object.
2214
2215 Ctyp := '*';
2216 end if;
2217
2218 -- Special handling for access parameters and objects and
2219 -- components of an anonymous access type.
2220
2221 if Ekind_In (Etype (XE.Key.Ent),
2222 E_Anonymous_Access_Type,
2223 E_Anonymous_Access_Subprogram_Type,
2224 E_Anonymous_Access_Protected_Subprogram_Type)
2225 then
2226 if Is_Formal (XE.Key.Ent)
2227 or else
2228 Ekind_In
2229 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2230 then
2231 Ctyp := 'p';
2232 end if;
2233
2234 -- Special handling for Boolean
2235
2236 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2237 Ctyp := 'b';
2238 end if;
2239 end if;
2240
2241 -- Special handling for abstract types and operations
2242
2243 if Is_Overloadable (XE.Key.Ent)
2244 and then Is_Abstract_Subprogram (XE.Key.Ent)
2245 then
2246 if Ctyp = 'U' then
2247 Ctyp := 'x'; -- Abstract procedure
2248
2249 elsif Ctyp = 'V' then
2250 Ctyp := 'y'; -- Abstract function
2251 end if;
2252
2253 elsif Is_Type (XE.Key.Ent)
2254 and then Is_Abstract_Type (XE.Key.Ent)
2255 then
2256 if Is_Interface (XE.Key.Ent) then
2257 Ctyp := 'h';
2258
2259 elsif Ctyp = 'R' then
2260 Ctyp := 'H'; -- Abstract type
2261 end if;
2262 end if;
2263
2264 -- Only output reference if interesting type of entity
2265
2266 if Ctyp = ' '
2267
2268 -- Suppress references to object definitions, used for local
2269 -- references.
2270
2271 or else XE.Key.Typ = 'D'
2272 or else XE.Key.Typ = 'I'
2273
2274 -- Suppress self references, except for bodies that act as
2275 -- specs.
2276
2277 or else (XE.Key.Loc = XE.Def
2278 and then
2279 (XE.Key.Typ /= 'b'
2280 or else not Is_Subprogram (XE.Key.Ent)))
2281
2282 -- Also suppress definitions of body formals (we only
2283 -- treat these as references, and the references were
2284 -- separately recorded).
2285
2286 or else (Is_Formal (XE.Key.Ent)
2287 and then Present (Spec_Entity (XE.Key.Ent)))
2288 then
2289 null;
2290
2291 else
2292 -- Start new Xref section if new xref unit
2293
2294 if XE.Key.Eun /= Curxu then
2295 if Write_Info_Col > 1 then
2296 Write_Info_EOL;
2297 end if;
2298
2299 Curxu := XE.Key.Eun;
2300
2301 Write_Info_Initiate ('X');
2302 Write_Info_Char (' ');
2303 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2304 Write_Info_Char (' ');
2305 Write_Info_Name
2306 (Reference_Name (Source_Index (XE.Key.Eun)));
2307 end if;
2308
2309 -- Start new Entity line if new entity. Note that we
2310 -- consider two entities the same if they have the same
2311 -- name and source location. This causes entities in
2312 -- instantiations to be treated as though they referred
2313 -- to the template.
2314
2315 if No (Curent)
2316 or else
2317 (XE.Key.Ent /= Curent
2318 and then
2319 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2320 then
2321 Curent := XE.Key.Ent;
2322 Curdef := XE.Def;
2323
2324 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2325 Curlen := Name_Len;
2326 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2327
2328 if Write_Info_Col > 1 then
2329 Write_Info_EOL;
2330 end if;
2331
2332 -- Write column number information
2333
2334 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2335 Write_Info_Char (Ctyp);
2336 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2337
2338 -- Write level information
2339
2340 Write_Level_Info : declare
2341 function Is_Visible_Generic_Entity
2342 (E : Entity_Id) return Boolean;
2343 -- Check whether E is declared in the visible part
2344 -- of a generic package. For source navigation
2345 -- purposes, treat this as a visible entity.
2346
2347 function Is_Private_Record_Component
2348 (E : Entity_Id) return Boolean;
2349 -- Check whether E is a non-inherited component of a
2350 -- private extension. Even if the enclosing record is
2351 -- public, we want to treat the component as private
2352 -- for navigation purposes.
2353
2354 ---------------------------------
2355 -- Is_Private_Record_Component --
2356 ---------------------------------
2357
2358 function Is_Private_Record_Component
2359 (E : Entity_Id) return Boolean
2360 is
2361 S : constant Entity_Id := Scope (E);
2362 begin
2363 return
2364 Ekind (E) = E_Component
2365 and then Nkind (Declaration_Node (S)) =
2366 N_Private_Extension_Declaration
2367 and then Original_Record_Component (E) = E;
2368 end Is_Private_Record_Component;
2369
2370 -------------------------------
2371 -- Is_Visible_Generic_Entity --
2372 -------------------------------
2373
2374 function Is_Visible_Generic_Entity
2375 (E : Entity_Id) return Boolean
2376 is
2377 Par : Node_Id;
2378
2379 begin
2380 -- The Present check here is an error defense
2381
2382 if Present (Scope (E))
2383 and then Ekind (Scope (E)) /= E_Generic_Package
2384 then
2385 return False;
2386 end if;
2387
2388 Par := Parent (E);
2389 while Present (Par) loop
2390 if
2391 Nkind (Par) = N_Generic_Package_Declaration
2392 then
2393 -- Entity is a generic formal
2394
2395 return False;
2396
2397 elsif
2398 Nkind (Parent (Par)) = N_Package_Specification
2399 then
2400 return
2401 Is_List_Member (Par)
2402 and then List_Containing (Par) =
2403 Visible_Declarations (Parent (Par));
2404 else
2405 Par := Parent (Par);
2406 end if;
2407 end loop;
2408
2409 return False;
2410 end Is_Visible_Generic_Entity;
2411
2412 -- Start of processing for Write_Level_Info
2413
2414 begin
2415 if Is_Hidden (Curent)
2416 or else Is_Private_Record_Component (Curent)
2417 then
2418 Write_Info_Char (' ');
2419
2420 elsif
2421 Is_Public (Curent)
2422 or else Is_Visible_Generic_Entity (Curent)
2423 then
2424 Write_Info_Char ('*');
2425
2426 else
2427 Write_Info_Char (' ');
2428 end if;
2429 end Write_Level_Info;
2430
2431 -- Output entity name. We use the occurrence from the
2432 -- actual source program at the definition point.
2433
2434 declare
2435 Ent_Name : constant String :=
2436 Exact_Source_Name (Sloc (XE.Key.Ent));
2437 begin
2438 for C in Ent_Name'Range loop
2439 Write_Info_Char (Ent_Name (C));
2440 end loop;
2441 end;
2442
2443 -- See if we have a renaming reference
2444
2445 if Is_Object (XE.Key.Ent)
2446 and then Present (Renamed_Object (XE.Key.Ent))
2447 then
2448 Rref := Renamed_Object (XE.Key.Ent);
2449
2450 elsif Is_Overloadable (XE.Key.Ent)
2451 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2452 = N_Subprogram_Renaming_Declaration
2453 then
2454 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2455
2456 elsif Ekind (XE.Key.Ent) = E_Package
2457 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2458 N_Package_Renaming_Declaration
2459 then
2460 Rref := Name (Declaration_Node (XE.Key.Ent));
2461
2462 else
2463 Rref := Empty;
2464 end if;
2465
2466 if Present (Rref) then
2467 if Nkind (Rref) = N_Expanded_Name then
2468 Rref := Selector_Name (Rref);
2469 end if;
2470
2471 if Nkind (Rref) = N_Identifier
2472 or else Nkind (Rref) = N_Operator_Symbol
2473 then
2474 null;
2475
2476 -- For renamed array components, use the array name
2477 -- for the renamed entity, which reflect the fact that
2478 -- in general the whole array is aliased.
2479
2480 elsif Nkind (Rref) = N_Indexed_Component then
2481 if Nkind (Prefix (Rref)) = N_Identifier then
2482 Rref := Prefix (Rref);
2483 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2484 Rref := Selector_Name (Prefix (Rref));
2485 else
2486 Rref := Empty;
2487 end if;
2488
2489 else
2490 Rref := Empty;
2491 end if;
2492 end if;
2493
2494 -- Write out renaming reference if we have one
2495
2496 if Present (Rref) then
2497 Write_Info_Char ('=');
2498 Write_Info_Nat
2499 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2500 Write_Info_Char (':');
2501 Write_Info_Nat
2502 (Int (Get_Column_Number (Sloc (Rref))));
2503 end if;
2504
2505 -- Indicate that the entity is in the unit of the current
2506 -- xref section.
2507
2508 Curru := Curxu;
2509
2510 -- Write out information about generic parent, if entity
2511 -- is an instance.
2512
2513 if Is_Generic_Instance (XE.Key.Ent) then
2514 declare
2515 Gen_Par : constant Entity_Id :=
2516 Generic_Parent
2517 (Specification
2518 (Unit_Declaration_Node
2519 (XE.Key.Ent)));
2520 Loc : constant Source_Ptr := Sloc (Gen_Par);
2521 Gen_U : constant Unit_Number_Type :=
2522 Get_Source_Unit (Loc);
2523
2524 begin
2525 Write_Info_Char ('[');
2526
2527 if Curru /= Gen_U then
2528 Write_Info_Nat (Dependency_Num (Gen_U));
2529 Write_Info_Char ('|');
2530 end if;
2531
2532 Write_Info_Nat
2533 (Int (Get_Logical_Line_Number (Loc)));
2534 Write_Info_Char (']');
2535 end;
2536 end if;
2537
2538 -- See if we have a type reference and if so output
2539
2540 Check_Type_Reference (XE.Key.Ent, False);
2541
2542 -- Additional information for types with progenitors,
2543 -- including synchronized tagged types.
2544
2545 declare
2546 Typ : constant Entity_Id := XE.Key.Ent;
2547 Elmt : Elmt_Id;
2548
2549 begin
2550 if Is_Record_Type (Typ)
2551 and then Present (Interfaces (Typ))
2552 then
2553 Elmt := First_Elmt (Interfaces (Typ));
2554
2555 elsif Is_Concurrent_Type (Typ)
2556 and then Present (Corresponding_Record_Type (Typ))
2557 and then Present (
2558 Interfaces (Corresponding_Record_Type (Typ)))
2559 then
2560 Elmt :=
2561 First_Elmt (
2562 Interfaces (Corresponding_Record_Type (Typ)));
2563
2564 else
2565 Elmt := No_Elmt;
2566 end if;
2567
2568 while Present (Elmt) loop
2569 Check_Type_Reference (Node (Elmt), True);
2570 Next_Elmt (Elmt);
2571 end loop;
2572 end;
2573
2574 -- For array types, list index types as well. (This is
2575 -- not C, indexes have distinct types).
2576
2577 if Is_Array_Type (XE.Key.Ent) then
2578 declare
2579 A_Typ : constant Entity_Id := XE.Key.Ent;
2580 Indx : Node_Id;
2581
2582 begin
2583 -- If this is a derived array type, we have
2584 -- output the parent type, so add the component
2585 -- type now.
2586
2587 if Is_Derived_Type (A_Typ) then
2588 Check_Type_Reference
2589 (Component_Type (A_Typ), False, True);
2590 end if;
2591
2592 -- Add references to index types.
2593
2594 Indx := First_Index (XE.Key.Ent);
2595 while Present (Indx) loop
2596 Check_Type_Reference
2597 (First_Subtype (Etype (Indx)), True);
2598 Next_Index (Indx);
2599 end loop;
2600 end;
2601 end if;
2602
2603 -- If the entity is an overriding operation, write info
2604 -- on operation that was overridden.
2605
2606 if Is_Subprogram (XE.Key.Ent)
2607 and then Present (Overridden_Operation (XE.Key.Ent))
2608 then
2609 Output_Overridden_Op
2610 (Overridden_Operation (XE.Key.Ent));
2611 end if;
2612
2613 -- End of processing for entity output
2614
2615 Crloc := No_Location;
2616 end if;
2617
2618 -- Output the reference if it is not as the same location
2619 -- as the previous one, or it is a read-reference that
2620 -- indicates that the entity is an in-out actual in a call.
2621
2622 if XE.Key.Loc /= No_Location
2623 and then
2624 (XE.Key.Loc /= Crloc
2625 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2626 then
2627 Crloc := XE.Key.Loc;
2628 Prevt := XE.Key.Typ;
2629
2630 -- Start continuation if line full, else blank
2631
2632 if Write_Info_Col > 72 then
2633 Write_Info_EOL;
2634 Write_Info_Initiate ('.');
2635 end if;
2636
2637 Write_Info_Char (' ');
2638
2639 -- Output file number if changed
2640
2641 if XE.Key.Lun /= Curru then
2642 Curru := XE.Key.Lun;
2643 Write_Info_Nat (Dependency_Num (Curru));
2644 Write_Info_Char ('|');
2645 end if;
2646
2647 Write_Info_Nat
2648 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2649 Write_Info_Char (XE.Key.Typ);
2650
2651 if Is_Overloadable (XE.Key.Ent) then
2652 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2653 or else
2654 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2655 then
2656 Output_Import_Export_Info (XE.Key.Ent);
2657 end if;
2658 end if;
2659
2660 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2661
2662 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2663 end if;
2664 end if;
2665 end Output_One_Ref;
2666
2667 <<Continue>>
2668 null;
2669 end loop;
2670
2671 Write_Info_EOL;
2672 end Output_Refs;
2673 end Output_References;
2674
2675 ---------------------------------
2676 -- Process_Deferred_References --
2677 ---------------------------------
2678
2679 procedure Process_Deferred_References is
2680 begin
2681 for J in Deferred_References.First .. Deferred_References.Last loop
2682 declare
2683 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2684
2685 begin
2686 case Is_LHS (D.N) is
2687 when Yes =>
2688 Generate_Reference (D.E, D.N, 'm');
2689
2690 when No =>
2691 Generate_Reference (D.E, D.N, 'r');
2692
2693 -- Not clear if Unknown can occur at this stage, but if it
2694 -- does we will treat it as a normal reference.
2695
2696 when Unknown =>
2697 Generate_Reference (D.E, D.N, 'r');
2698 end case;
2699 end;
2700 end loop;
2701
2702 -- Clear processed entries from table
2703
2704 Deferred_References.Init;
2705 end Process_Deferred_References;
2706
2707 -- Start of elaboration for Lib.Xref
2708
2709 begin
2710 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2711 -- because it's not an access type.
2712
2713 Xref_Set.Reset;
2714 end Lib.Xref;