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