2015-01-07 Hristian Kirtchev <kirtchev@adacore.com>
[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 special test, In some cases
481 -- this is called too early (see comments in 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 then
664 null;
665
666 elsif In_Instance_Body
667 and then In_Extended_Main_Code_Unit (N)
668 and then Is_Generic_Type (Etype (E))
669 then
670 Set_Referenced (E);
671 return;
672
673 elsif Inside_A_Generic
674 and then Is_Generic_Type (Etype (E))
675 then
676 Set_Referenced (E);
677 return;
678
679 else
680 return;
681 end if;
682 end if;
683
684 -- For reference type p, the entity must be in main source unit
685
686 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
687 return;
688 end if;
689
690 -- Unless the reference is forced, we ignore references where the
691 -- reference itself does not come from source.
692
693 if not Force and then not Comes_From_Source (N) then
694 return;
695 end if;
696
697 -- Deal with setting entity as referenced, unless suppressed. Note that
698 -- we still do Set_Referenced on entities that do not come from source.
699 -- This situation arises when we have a source reference to a derived
700 -- operation, where the derived operation itself does not come from
701 -- source, but we still want to mark it as referenced, since we really
702 -- are referencing an entity in the corresponding package (this avoids
703 -- wrong complaints that the package contains no referenced entities).
704
705 if Set_Ref then
706
707 -- Assignable object appearing on left side of assignment or as
708 -- an out parameter.
709
710 if Is_Assignable (E)
711 and then Is_On_LHS (N)
712 and then Ekind (E) /= E_In_Out_Parameter
713 then
714 -- For objects that are renamings, just set as simply referenced
715 -- we do not try to do assignment type tracking in this case.
716
717 if Present (Renamed_Object (E)) then
718 Set_Referenced (E);
719
720 -- Out parameter case
721
722 elsif Kind = E_Out_Parameter then
723
724 -- If warning mode for all out parameters is set, or this is
725 -- the only warning parameter, then we want to mark this for
726 -- later warning logic by setting Referenced_As_Out_Parameter
727
728 if Warn_On_Modified_As_Out_Parameter (Formal) then
729 Set_Referenced_As_Out_Parameter (E, True);
730 Set_Referenced_As_LHS (E, False);
731
732 -- For OUT parameter not covered by the above cases, we simply
733 -- regard it as a normal reference (in this case we do not
734 -- want any of the warning machinery for out parameters).
735
736 else
737 Set_Referenced (E);
738 end if;
739
740 -- For the left hand of an assignment case, we do nothing here.
741 -- The processing for Analyze_Assignment_Statement will set the
742 -- Referenced_As_LHS flag.
743
744 else
745 null;
746 end if;
747
748 -- Check for a reference in a pragma that should not count as a
749 -- making the variable referenced for warning purposes.
750
751 elsif Is_Non_Significant_Pragma_Reference (N) then
752 null;
753
754 -- A reference in an attribute definition clause does not count as a
755 -- reference except for the case of Address. The reason that 'Address
756 -- is an exception is that it creates an alias through which the
757 -- variable may be referenced.
758
759 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
760 and then Chars (Parent (N)) /= Name_Address
761 and then N = Name (Parent (N))
762 then
763 null;
764
765 -- Constant completion does not count as a reference
766
767 elsif Typ = 'c'
768 and then Ekind (E) = E_Constant
769 then
770 null;
771
772 -- Record representation clause does not count as a reference
773
774 elsif Nkind (N) = N_Identifier
775 and then Nkind (Parent (N)) = N_Record_Representation_Clause
776 then
777 null;
778
779 -- Discriminants do not need to produce a reference to record type
780
781 elsif Typ = 'd'
782 and then Nkind (Parent (N)) = N_Discriminant_Specification
783 then
784 null;
785
786 -- All other cases
787
788 else
789 -- Special processing for IN OUT parameters, where we have an
790 -- implicit assignment to a simple variable.
791
792 if Kind = E_In_Out_Parameter
793 and then Is_Assignable (E)
794 then
795 -- For sure this counts as a normal read reference
796
797 Set_Referenced (E);
798 Set_Last_Assignment (E, Empty);
799
800 -- We count it as being referenced as an out parameter if the
801 -- option is set to warn on all out parameters, except that we
802 -- have a special exclusion for an intrinsic subprogram, which
803 -- is most likely an instantiation of Unchecked_Deallocation
804 -- which we do not want to consider as an assignment since it
805 -- generates false positives. We also exclude the case of an
806 -- IN OUT parameter if the name of the procedure is Free,
807 -- since we suspect similar semantics.
808
809 if Warn_On_All_Unread_Out_Parameters
810 and then Is_Entity_Name (Name (Call))
811 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
812 and then Chars (Name (Call)) /= Name_Free
813 then
814 Set_Referenced_As_Out_Parameter (E, True);
815 Set_Referenced_As_LHS (E, False);
816 end if;
817
818 -- Don't count a recursive reference within a subprogram as a
819 -- reference (that allows detection of a recursive subprogram
820 -- whose only references are recursive calls as unreferenced).
821
822 elsif Is_Subprogram (E)
823 and then E = Nearest_Dynamic_Scope (Current_Scope)
824 then
825 null;
826
827 -- Any other occurrence counts as referencing the entity
828
829 elsif OK_To_Set_Referenced then
830 Set_Referenced (E);
831
832 -- If variable, this is an OK reference after an assignment
833 -- so we can clear the Last_Assignment indication.
834
835 if Is_Assignable (E) then
836 Set_Last_Assignment (E, Empty);
837 end if;
838 end if;
839 end if;
840
841 -- Check for pragma Unreferenced given and reference is within
842 -- this source unit (occasion for possible warning to be issued).
843
844 if Has_Unreferenced (E)
845 and then In_Same_Extended_Unit (E, N)
846 then
847 -- A reference as a named parameter in a call does not count
848 -- as a violation of pragma Unreferenced for this purpose...
849
850 if Nkind (N) = N_Identifier
851 and then Nkind (Parent (N)) = N_Parameter_Association
852 and then Selector_Name (Parent (N)) = N
853 then
854 null;
855
856 -- ... Neither does a reference to a variable on the left side
857 -- of an assignment.
858
859 elsif Is_On_LHS (N) then
860 null;
861
862 -- For entry formals, we want to place the warning message on the
863 -- corresponding entity in the accept statement. The current scope
864 -- is the body of the accept, so we find the formal whose name
865 -- matches that of the entry formal (there is no link between the
866 -- two entities, and the one in the accept statement is only used
867 -- for conformance checking).
868
869 elsif Ekind (Scope (E)) = E_Entry then
870 declare
871 BE : Entity_Id;
872
873 begin
874 BE := First_Entity (Current_Scope);
875 while Present (BE) loop
876 if Chars (BE) = Chars (E) then
877 Error_Msg_NE -- CODEFIX
878 ("??pragma Unreferenced given for&!", N, BE);
879 exit;
880 end if;
881
882 Next_Entity (BE);
883 end loop;
884 end;
885
886 -- Here we issue the warning, since this is a real reference
887
888 else
889 Error_Msg_NE -- CODEFIX
890 ("??pragma Unreferenced given for&!", N, E);
891 end if;
892 end if;
893
894 -- If this is a subprogram instance, mark as well the internal
895 -- subprogram in the wrapper package, which may be a visible
896 -- compilation unit.
897
898 if Is_Overloadable (E)
899 and then Is_Generic_Instance (E)
900 and then Present (Alias (E))
901 then
902 Set_Referenced (Alias (E));
903 end if;
904 end if;
905
906 -- Generate reference if all conditions are met:
907
908 if
909 -- Cross referencing must be active
910
911 Opt.Xref_Active
912
913 -- The entity must be one for which we collect references
914
915 and then Xref_Entity_Letters (Ekind (E)) /= ' '
916
917 -- Both Sloc values must be set to something sensible
918
919 and then Sloc (E) > No_Location
920 and then Sloc (N) > No_Location
921
922 -- Ignore references from within an instance. The only exceptions to
923 -- this are default subprograms, for which we generate an implicit
924 -- reference and compilations in SPARK mode.
925
926 and then
927 (Instantiation_Location (Sloc (N)) = No_Location
928 or else Typ = 'i'
929 or else GNATprove_Mode)
930
931 -- Ignore dummy references
932
933 and then Typ /= ' '
934 then
935 if Nkind_In (N, N_Identifier,
936 N_Defining_Identifier,
937 N_Defining_Operator_Symbol,
938 N_Operator_Symbol,
939 N_Defining_Character_Literal)
940 or else Nkind (N) in N_Op
941 or else (Nkind (N) = N_Character_Literal
942 and then Sloc (Entity (N)) /= Standard_Location)
943 then
944 Nod := N;
945
946 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
947 Nod := Selector_Name (N);
948
949 else
950 return;
951 end if;
952
953 -- Normal case of source entity comes from source
954
955 if Comes_From_Source (E) then
956 Ent := E;
957
958 -- Because a declaration may be generated for a subprogram body
959 -- without declaration in GNATprove mode, for inlining, some
960 -- parameters may end up being marked as not coming from source
961 -- although they are. Take these into account specially.
962
963 elsif GNATprove_Mode and then Ekind (E) in Formal_Kind then
964 Ent := E;
965
966 -- Entity does not come from source, but is a derived subprogram and
967 -- the derived subprogram comes from source (after one or more
968 -- derivations) in which case the reference is to parent subprogram.
969
970 elsif Is_Overloadable (E)
971 and then Present (Alias (E))
972 then
973 Ent := Alias (E);
974 while not Comes_From_Source (Ent) loop
975 if No (Alias (Ent)) then
976 return;
977 end if;
978
979 Ent := Alias (Ent);
980 end loop;
981
982 -- The internally created defining entity for a child subprogram
983 -- that has no previous spec has valid references.
984
985 elsif Is_Overloadable (E)
986 and then Is_Child_Unit (E)
987 then
988 Ent := E;
989
990 -- Ditto for the formals of such a subprogram
991
992 elsif Is_Overloadable (Scope (E))
993 and then Is_Child_Unit (Scope (E))
994 then
995 Ent := E;
996
997 -- Record components of discriminated subtypes or derived types must
998 -- be treated as references to the original component.
999
1000 elsif Ekind (E) = E_Component
1001 and then Comes_From_Source (Original_Record_Component (E))
1002 then
1003 Ent := Original_Record_Component (E);
1004
1005 -- If this is an expanded reference to a discriminant, recover the
1006 -- original discriminant, which gets the reference.
1007
1008 elsif Ekind (E) = E_In_Parameter
1009 and then Present (Discriminal_Link (E))
1010 then
1011 Ent := Discriminal_Link (E);
1012 Set_Referenced (Ent);
1013
1014 -- Ignore reference to any other entity that is not from source
1015
1016 else
1017 return;
1018 end if;
1019
1020 -- In SPARK mode, consider the underlying entity renamed instead of
1021 -- the renaming, which is needed to compute a valid set of effects
1022 -- (reads, writes) for the enclosing subprogram.
1023
1024 if GNATprove_Mode then
1025 Ent := Get_Through_Renamings (Ent);
1026
1027 -- If no enclosing object, then it could be a reference to any
1028 -- location not tracked individually, like heap-allocated data.
1029 -- Conservatively approximate this possibility by generating a
1030 -- dereference, and return.
1031
1032 if No (Ent) then
1033 if Actual_Typ = 'w' then
1034 SPARK_Specific.Generate_Dereference (Nod, 'r');
1035 SPARK_Specific.Generate_Dereference (Nod, 'w');
1036 else
1037 SPARK_Specific.Generate_Dereference (Nod, 'r');
1038 end if;
1039
1040 return;
1041 end if;
1042 end if;
1043
1044 -- Record reference to entity
1045
1046 if Actual_Typ = 'p'
1047 and then Is_Subprogram (Nod)
1048 and then Present (Overridden_Operation (Nod))
1049 then
1050 Actual_Typ := 'P';
1051 end if;
1052
1053 -- Comment needed here for special SPARK code ???
1054
1055 if GNATprove_Mode then
1056 Ref := Sloc (Nod);
1057 Def := Sloc (Ent);
1058
1059 Ref_Scope :=
1060 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1061 Ent_Scope :=
1062 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1063
1064 -- Since we are reaching through renamings in SPARK mode, we may
1065 -- end up with standard constants. Ignore those.
1066
1067 if Sloc (Ent_Scope) <= Standard_Location
1068 or else Def <= Standard_Location
1069 then
1070 return;
1071 end if;
1072
1073 Add_Entry
1074 ((Ent => Ent,
1075 Loc => Ref,
1076 Typ => Actual_Typ,
1077 Eun => Get_Code_Unit (Def),
1078 Lun => Get_Code_Unit (Ref),
1079 Ref_Scope => Ref_Scope,
1080 Ent_Scope => Ent_Scope),
1081 Ent_Scope_File => Get_Code_Unit (Ent));
1082
1083 else
1084 Ref := Original_Location (Sloc (Nod));
1085 Def := Original_Location (Sloc (Ent));
1086
1087 -- If this is an operator symbol, skip the initial quote for
1088 -- navigation purposes. This is not done for the end label,
1089 -- where we want the actual position after the closing quote.
1090
1091 if Typ = 't' then
1092 null;
1093
1094 elsif Nkind (N) = N_Defining_Operator_Symbol
1095 or else Nkind (Nod) = N_Operator_Symbol
1096 then
1097 Ref := Ref + 1;
1098 end if;
1099
1100 Add_Entry
1101 ((Ent => Ent,
1102 Loc => Ref,
1103 Typ => Actual_Typ,
1104 Eun => Get_Source_Unit (Def),
1105 Lun => Get_Source_Unit (Ref),
1106 Ref_Scope => Empty,
1107 Ent_Scope => Empty),
1108 Ent_Scope_File => No_Unit);
1109
1110 -- Generate reference to the first private entity
1111
1112 if Typ = 'e'
1113 and then Comes_From_Source (E)
1114 and then Nkind (Ent) = N_Defining_Identifier
1115 and then (Is_Package_Or_Generic_Package (Ent)
1116 or else Is_Concurrent_Type (Ent))
1117 and then Present (First_Private_Entity (E))
1118 and then In_Extended_Main_Source_Unit (N)
1119 then
1120 -- Handle case in which the full-view and partial-view of the
1121 -- first private entity are swapped
1122
1123 declare
1124 First_Private : Entity_Id := First_Private_Entity (E);
1125
1126 begin
1127 if Is_Private_Type (First_Private)
1128 and then Present (Full_View (First_Private))
1129 then
1130 First_Private := Full_View (First_Private);
1131 end if;
1132
1133 Add_Entry
1134 ((Ent => Ent,
1135 Loc => Sloc (First_Private),
1136 Typ => 'E',
1137 Eun => Get_Source_Unit (Def),
1138 Lun => Get_Source_Unit (Ref),
1139 Ref_Scope => Empty,
1140 Ent_Scope => Empty),
1141 Ent_Scope_File => No_Unit);
1142 end;
1143 end if;
1144 end if;
1145 end if;
1146 end Generate_Reference;
1147
1148 -----------------------------------
1149 -- Generate_Reference_To_Formals --
1150 -----------------------------------
1151
1152 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1153 Formal : Entity_Id;
1154
1155 begin
1156 if Is_Generic_Subprogram (E) then
1157 Formal := First_Entity (E);
1158
1159 while Present (Formal)
1160 and then not Is_Formal (Formal)
1161 loop
1162 Next_Entity (Formal);
1163 end loop;
1164
1165 elsif Ekind (E) in Access_Subprogram_Kind then
1166 Formal := First_Formal (Designated_Type (E));
1167
1168 else
1169 Formal := First_Formal (E);
1170 end if;
1171
1172 while Present (Formal) loop
1173 if Ekind (Formal) = E_In_Parameter then
1174
1175 if Nkind (Parameter_Type (Parent (Formal)))
1176 = 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 -- Hash --
1223 ----------
1224
1225 function Hash (F : Xref_Entry_Number) return Header_Num is
1226 -- It is unlikely to have two references to the same entity at the same
1227 -- source location, so the hash function depends only on the Ent and Loc
1228 -- fields.
1229
1230 XE : Xref_Entry renames Xrefs.Table (F);
1231 type M is mod 2**32;
1232
1233 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1234 -- It would be more natural to write:
1235 --
1236 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1237 --
1238 -- But we can't use M'Mod, because it prevents bootstrapping with older
1239 -- compilers. Loc can be negative, so we do "abs" before converting.
1240 -- One day this can be cleaned up ???
1241
1242 begin
1243 return Header_Num (H mod Num_Buckets);
1244 end Hash;
1245
1246 -----------------
1247 -- HT_Set_Next --
1248 -----------------
1249
1250 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1251 begin
1252 Xrefs.Table (E).HTable_Next := Next;
1253 end HT_Set_Next;
1254
1255 -------------
1256 -- HT_Next --
1257 -------------
1258
1259 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1260 begin
1261 return Xrefs.Table (E).HTable_Next;
1262 end HT_Next;
1263
1264 ----------------
1265 -- Initialize --
1266 ----------------
1267
1268 procedure Initialize is
1269 begin
1270 Xrefs.Init;
1271 end Initialize;
1272
1273 --------
1274 -- Lt --
1275 --------
1276
1277 function Lt (T1, T2 : Xref_Entry) return Boolean is
1278 begin
1279 -- First test: if entity is in different unit, sort by unit
1280
1281 if T1.Key.Eun /= T2.Key.Eun then
1282 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1283
1284 -- Second test: within same unit, sort by entity Sloc
1285
1286 elsif T1.Def /= T2.Def then
1287 return T1.Def < T2.Def;
1288
1289 -- Third test: sort definitions ahead of references
1290
1291 elsif T1.Key.Loc = No_Location then
1292 return True;
1293
1294 elsif T2.Key.Loc = No_Location then
1295 return False;
1296
1297 -- Fourth test: for same entity, sort by reference location unit
1298
1299 elsif T1.Key.Lun /= T2.Key.Lun then
1300 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1301
1302 -- Fifth test: order of location within referencing unit
1303
1304 elsif T1.Key.Loc /= T2.Key.Loc then
1305 return T1.Key.Loc < T2.Key.Loc;
1306
1307 -- Finally, for two locations at the same address, we prefer
1308 -- the one that does NOT have the type 'r' so that a modification
1309 -- or extension takes preference, when there are more than one
1310 -- reference at the same location. As a result, in the case of
1311 -- entities that are in-out actuals, the read reference follows
1312 -- the modify reference.
1313
1314 else
1315 return T2.Key.Typ = 'r';
1316 end if;
1317 end Lt;
1318
1319 -----------------------
1320 -- Output_References --
1321 -----------------------
1322
1323 procedure Output_References is
1324
1325 procedure Get_Type_Reference
1326 (Ent : Entity_Id;
1327 Tref : out Entity_Id;
1328 Left : out Character;
1329 Right : out Character);
1330 -- Given an Entity_Id Ent, determines whether a type reference is
1331 -- required. If so, Tref is set to the entity for the type reference
1332 -- and Left and Right are set to the left/right brackets to be output
1333 -- for the reference. If no type reference is required, then Tref is
1334 -- set to Empty, and Left/Right are set to space.
1335
1336 procedure Output_Import_Export_Info (Ent : Entity_Id);
1337 -- Output language and external name information for an interfaced
1338 -- entity, using the format <language, external_name>.
1339
1340 ------------------------
1341 -- Get_Type_Reference --
1342 ------------------------
1343
1344 procedure Get_Type_Reference
1345 (Ent : Entity_Id;
1346 Tref : out Entity_Id;
1347 Left : out Character;
1348 Right : out Character)
1349 is
1350 Sav : Entity_Id;
1351
1352 begin
1353 -- See if we have a type reference
1354
1355 Tref := Ent;
1356 Left := '{';
1357 Right := '}';
1358
1359 loop
1360 Sav := Tref;
1361
1362 -- Processing for types
1363
1364 if Is_Type (Tref) then
1365
1366 -- Case of base type
1367
1368 if Base_Type (Tref) = Tref then
1369
1370 -- If derived, then get first subtype
1371
1372 if Tref /= Etype (Tref) then
1373 Tref := First_Subtype (Etype (Tref));
1374
1375 -- Set brackets for derived type, but don't override
1376 -- pointer case since the fact that something is a
1377 -- pointer is more important.
1378
1379 if Left /= '(' then
1380 Left := '<';
1381 Right := '>';
1382 end if;
1383
1384 -- If the completion of a private type is itself a derived
1385 -- type, we need the parent of the full view.
1386
1387 elsif Is_Private_Type (Tref)
1388 and then Present (Full_View (Tref))
1389 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1390 then
1391 Tref := Etype (Full_View (Tref));
1392
1393 if Left /= '(' then
1394 Left := '<';
1395 Right := '>';
1396 end if;
1397
1398 -- If non-derived pointer, get directly designated type.
1399 -- If the type has a full view, all references are on the
1400 -- partial view that is seen first.
1401
1402 elsif Is_Access_Type (Tref) then
1403 Tref := Directly_Designated_Type (Tref);
1404 Left := '(';
1405 Right := ')';
1406
1407 elsif Is_Private_Type (Tref)
1408 and then Present (Full_View (Tref))
1409 then
1410 if Is_Access_Type (Full_View (Tref)) then
1411 Tref := Directly_Designated_Type (Full_View (Tref));
1412 Left := '(';
1413 Right := ')';
1414
1415 -- If the full view is an array type, we also retrieve
1416 -- the corresponding component type, because the ali
1417 -- entry already indicates that this is an array.
1418
1419 elsif Is_Array_Type (Full_View (Tref)) then
1420 Tref := Component_Type (Full_View (Tref));
1421 Left := '(';
1422 Right := ')';
1423 end if;
1424
1425 -- If non-derived array, get component type. Skip component
1426 -- type for case of String or Wide_String, saves worthwhile
1427 -- space.
1428
1429 elsif Is_Array_Type (Tref)
1430 and then Tref /= Standard_String
1431 and then Tref /= Standard_Wide_String
1432 then
1433 Tref := Component_Type (Tref);
1434 Left := '(';
1435 Right := ')';
1436
1437 -- For other non-derived base types, nothing
1438
1439 else
1440 exit;
1441 end if;
1442
1443 -- For a subtype, go to ancestor subtype
1444
1445 else
1446 Tref := Ancestor_Subtype (Tref);
1447
1448 -- If no ancestor subtype, go to base type
1449
1450 if No (Tref) then
1451 Tref := Base_Type (Sav);
1452 end if;
1453 end if;
1454
1455 -- For objects, functions, enum literals, just get type from
1456 -- Etype field.
1457
1458 elsif Is_Object (Tref)
1459 or else Ekind (Tref) = E_Enumeration_Literal
1460 or else Ekind (Tref) = E_Function
1461 or else Ekind (Tref) = E_Operator
1462 then
1463 Tref := Etype (Tref);
1464
1465 -- Another special case: an object of a classwide type
1466 -- initialized with a tag-indeterminate call gets a subtype
1467 -- of the classwide type during expansion. See if the original
1468 -- type in the declaration is named, and return it instead
1469 -- of going to the root type.
1470
1471 if Ekind (Tref) = E_Class_Wide_Subtype
1472 and then Nkind (Parent (Ent)) = N_Object_Declaration
1473 and then
1474 Nkind (Original_Node (Object_Definition (Parent (Ent))))
1475 = N_Identifier
1476 then
1477 Tref :=
1478 Entity
1479 (Original_Node ((Object_Definition (Parent (Ent)))));
1480 end if;
1481
1482 -- For anything else, exit
1483
1484 else
1485 exit;
1486 end if;
1487
1488 -- Exit if no type reference, or we are stuck in some loop trying
1489 -- to find the type reference, or if the type is standard void
1490 -- type (the latter is an implementation artifact that should not
1491 -- show up in the generated cross-references).
1492
1493 exit when No (Tref)
1494 or else Tref = Sav
1495 or else Tref = Standard_Void_Type;
1496
1497 -- If we have a usable type reference, return, otherwise keep
1498 -- looking for something useful (we are looking for something
1499 -- that either comes from source or standard)
1500
1501 if Sloc (Tref) = Standard_Location
1502 or else Comes_From_Source (Tref)
1503 then
1504 -- If the reference is a subtype created for a generic actual,
1505 -- go actual directly, the inner subtype is not user visible.
1506
1507 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1508 and then not Comes_From_Source (Parent (Tref))
1509 and then
1510 (Is_Wrapper_Package (Scope (Tref))
1511 or else Is_Generic_Instance (Scope (Tref)))
1512 then
1513 Tref := First_Subtype (Base_Type (Tref));
1514 end if;
1515
1516 return;
1517 end if;
1518 end loop;
1519
1520 -- If we fall through the loop, no type reference
1521
1522 Tref := Empty;
1523 Left := ' ';
1524 Right := ' ';
1525 end Get_Type_Reference;
1526
1527 -------------------------------
1528 -- Output_Import_Export_Info --
1529 -------------------------------
1530
1531 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1532 Language_Name : Name_Id;
1533 Conv : constant Convention_Id := Convention (Ent);
1534
1535 begin
1536 -- Generate language name from convention
1537
1538 if Conv = Convention_C then
1539 Language_Name := Name_C;
1540
1541 elsif Conv = Convention_CPP then
1542 Language_Name := Name_CPP;
1543
1544 elsif Conv = Convention_Ada then
1545 Language_Name := Name_Ada;
1546
1547 else
1548 -- For the moment we ignore all other cases ???
1549
1550 return;
1551 end if;
1552
1553 Write_Info_Char ('<');
1554 Get_Unqualified_Name_String (Language_Name);
1555
1556 for J in 1 .. Name_Len loop
1557 Write_Info_Char (Name_Buffer (J));
1558 end loop;
1559
1560 if Present (Interface_Name (Ent)) then
1561 Write_Info_Char (',');
1562 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1563
1564 for J in 1 .. Name_Len loop
1565 Write_Info_Char (Name_Buffer (J));
1566 end loop;
1567 end if;
1568
1569 Write_Info_Char ('>');
1570 end Output_Import_Export_Info;
1571
1572 -- Start of processing for Output_References
1573
1574 begin
1575 -- First we add references to the primitive operations of tagged types
1576 -- declared in the main unit.
1577
1578 Handle_Prim_Ops : declare
1579 Ent : Entity_Id;
1580
1581 begin
1582 for J in 1 .. Xrefs.Last loop
1583 Ent := Xrefs.Table (J).Key.Ent;
1584
1585 if Is_Type (Ent)
1586 and then Is_Tagged_Type (Ent)
1587 and then Is_Base_Type (Ent)
1588 and then In_Extended_Main_Source_Unit (Ent)
1589 then
1590 Generate_Prim_Op_References (Ent);
1591 end if;
1592 end loop;
1593 end Handle_Prim_Ops;
1594
1595 -- Before we go ahead and output the references we have a problem
1596 -- that needs dealing with. So far we have captured things that are
1597 -- definitely referenced by the main unit, or defined in the main
1598 -- unit. That's because we don't want to clutter up the ali file
1599 -- for this unit with definition lines for entities in other units
1600 -- that are not referenced.
1601
1602 -- But there is a glitch. We may reference an entity in another unit,
1603 -- and it may have a type reference to an entity that is not directly
1604 -- referenced in the main unit, which may mean that there is no xref
1605 -- entry for this entity yet in the list of references.
1606
1607 -- If we don't do something about this, we will end with an orphan type
1608 -- reference, i.e. it will point to an entity that does not appear
1609 -- within the generated references in the ali file. That is not good for
1610 -- tools using the xref information.
1611
1612 -- To fix this, we go through the references adding definition entries
1613 -- for any unreferenced entities that can be referenced in a type
1614 -- reference. There is a recursion problem here, and that is dealt with
1615 -- by making sure that this traversal also traverses any entries that
1616 -- get added by the traversal.
1617
1618 Handle_Orphan_Type_References : declare
1619 J : Nat;
1620 Tref : Entity_Id;
1621 Ent : Entity_Id;
1622
1623 L, R : Character;
1624 pragma Warnings (Off, L);
1625 pragma Warnings (Off, R);
1626
1627 procedure New_Entry (E : Entity_Id);
1628 -- Make an additional entry into the Xref table for a type entity
1629 -- that is related to the current entity (parent, type ancestor,
1630 -- progenitor, etc.).
1631
1632 ----------------
1633 -- New_Entry --
1634 ----------------
1635
1636 procedure New_Entry (E : Entity_Id) is
1637 begin
1638 pragma Assert (Present (E));
1639
1640 if not Has_Xref_Entry (Implementation_Base_Type (E))
1641 and then Sloc (E) > No_Location
1642 then
1643 Add_Entry
1644 ((Ent => E,
1645 Loc => No_Location,
1646 Typ => Character'First,
1647 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1648 Lun => No_Unit,
1649 Ref_Scope => Empty,
1650 Ent_Scope => Empty),
1651 Ent_Scope_File => No_Unit);
1652 end if;
1653 end New_Entry;
1654
1655 -- Start of processing for Handle_Orphan_Type_References
1656
1657 begin
1658 -- Note that this is not a for loop for a very good reason. The
1659 -- processing of items in the table can add new items to the table,
1660 -- and they must be processed as well.
1661
1662 J := 1;
1663 while J <= Xrefs.Last loop
1664 Ent := Xrefs.Table (J).Key.Ent;
1665
1666 -- Do not generate reference information for an ignored Ghost
1667 -- entity because neither the entity nor its references will
1668 -- appear in the final tree.
1669
1670 if Is_Ignored_Ghost_Entity (Ent) then
1671 goto Orphan_Continue;
1672 end if;
1673
1674 Get_Type_Reference (Ent, Tref, L, R);
1675
1676 if Present (Tref)
1677 and then not Has_Xref_Entry (Tref)
1678 and then Sloc (Tref) > No_Location
1679 then
1680 New_Entry (Tref);
1681
1682 if Is_Record_Type (Ent)
1683 and then Present (Interfaces (Ent))
1684 then
1685 -- Add an entry for each one of the given interfaces
1686 -- implemented by type Ent.
1687
1688 declare
1689 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1690 begin
1691 while Present (Elmt) loop
1692 New_Entry (Node (Elmt));
1693 Next_Elmt (Elmt);
1694 end loop;
1695 end;
1696 end if;
1697 end if;
1698
1699 -- Collect inherited primitive operations that may be declared in
1700 -- another unit and have no visible reference in the current one.
1701
1702 if Is_Type (Ent)
1703 and then Is_Tagged_Type (Ent)
1704 and then Is_Derived_Type (Ent)
1705 and then Is_Base_Type (Ent)
1706 and then In_Extended_Main_Source_Unit (Ent)
1707 then
1708 declare
1709 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1710 Op : Elmt_Id;
1711 Prim : Entity_Id;
1712
1713 function Parent_Op (E : Entity_Id) return Entity_Id;
1714 -- Find original operation, which may be inherited through
1715 -- several derivations.
1716
1717 function Parent_Op (E : Entity_Id) return Entity_Id is
1718 Orig_Op : constant Entity_Id := Alias (E);
1719
1720 begin
1721 if No (Orig_Op) then
1722 return Empty;
1723
1724 elsif not Comes_From_Source (E)
1725 and then not Has_Xref_Entry (Orig_Op)
1726 and then Comes_From_Source (Orig_Op)
1727 then
1728 return Orig_Op;
1729 else
1730 return Parent_Op (Orig_Op);
1731 end if;
1732 end Parent_Op;
1733
1734 begin
1735 Op := First_Elmt (Op_List);
1736 while Present (Op) loop
1737 Prim := Parent_Op (Node (Op));
1738
1739 if Present (Prim) then
1740 Add_Entry
1741 ((Ent => Prim,
1742 Loc => No_Location,
1743 Typ => Character'First,
1744 Eun => Get_Source_Unit (Sloc (Prim)),
1745 Lun => No_Unit,
1746 Ref_Scope => Empty,
1747 Ent_Scope => Empty),
1748 Ent_Scope_File => No_Unit);
1749 end if;
1750
1751 Next_Elmt (Op);
1752 end loop;
1753 end;
1754 end if;
1755
1756 <<Orphan_Continue>>
1757 J := J + 1;
1758 end loop;
1759 end Handle_Orphan_Type_References;
1760
1761 -- Now we have all the references, including those for any embedded type
1762 -- references, so we can sort them, and output them.
1763
1764 Output_Refs : declare
1765 Nrefs : constant Nat := Xrefs.Last;
1766 -- Number of references in table
1767
1768 Rnums : array (0 .. Nrefs) of Nat;
1769 -- This array contains numbers of references in the Xrefs table.
1770 -- This list is sorted in output order. The extra 0'th entry is
1771 -- convenient for the call to sort. When we sort the table, we
1772 -- move the entries in Rnums around, but we do not move the
1773 -- original table entries.
1774
1775 Curxu : Unit_Number_Type;
1776 -- Current xref unit
1777
1778 Curru : Unit_Number_Type;
1779 -- Current reference unit for one entity
1780
1781 Curent : Entity_Id;
1782 -- Current entity
1783
1784 Curnam : String (1 .. Name_Buffer'Length);
1785 Curlen : Natural;
1786 -- Simple name and length of current entity
1787
1788 Curdef : Source_Ptr;
1789 -- Original source location for current entity
1790
1791 Crloc : Source_Ptr;
1792 -- Current reference location
1793
1794 Ctyp : Character;
1795 -- Entity type character
1796
1797 Prevt : Character;
1798 -- reference kind of previous reference
1799
1800 Tref : Entity_Id;
1801 -- Type reference
1802
1803 Rref : Node_Id;
1804 -- Renaming reference
1805
1806 Trunit : Unit_Number_Type;
1807 -- Unit number for type reference
1808
1809 function Lt (Op1, Op2 : Natural) return Boolean;
1810 -- Comparison function for Sort call
1811
1812 function Name_Change (X : Entity_Id) return Boolean;
1813 -- Determines if entity X has a different simple name from Curent
1814
1815 procedure Move (From : Natural; To : Natural);
1816 -- Move procedure for Sort call
1817
1818 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1819
1820 --------
1821 -- Lt --
1822 --------
1823
1824 function Lt (Op1, Op2 : Natural) return Boolean is
1825 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1826 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1827
1828 begin
1829 return Lt (T1, T2);
1830 end Lt;
1831
1832 ----------
1833 -- Move --
1834 ----------
1835
1836 procedure Move (From : Natural; To : Natural) is
1837 begin
1838 Rnums (Nat (To)) := Rnums (Nat (From));
1839 end Move;
1840
1841 -----------------
1842 -- Name_Change --
1843 -----------------
1844
1845 -- Why a string comparison here??? Why not compare Name_Id values???
1846
1847 function Name_Change (X : Entity_Id) return Boolean is
1848 begin
1849 Get_Unqualified_Name_String (Chars (X));
1850
1851 if Name_Len /= Curlen then
1852 return True;
1853 else
1854 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1855 end if;
1856 end Name_Change;
1857
1858 -- Start of processing for Output_Refs
1859
1860 begin
1861 -- Capture the definition Sloc values. We delay doing this till now,
1862 -- since at the time the reference or definition is made, private
1863 -- types may be swapped, and the Sloc value may be incorrect. We
1864 -- also set up the pointer vector for the sort.
1865
1866 -- For user-defined operators we need to skip the initial quote and
1867 -- point to the first character of the name, for navigation purposes.
1868
1869 for J in 1 .. Nrefs loop
1870 declare
1871 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1872 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1873
1874 begin
1875 Rnums (J) := J;
1876
1877 if Nkind (E) = N_Defining_Operator_Symbol then
1878 Xrefs.Table (J).Def := Loc + 1;
1879 else
1880 Xrefs.Table (J).Def := Loc;
1881 end if;
1882 end;
1883 end loop;
1884
1885 -- Sort the references
1886
1887 Sorting.Sort (Integer (Nrefs));
1888
1889 -- Initialize loop through references
1890
1891 Curxu := No_Unit;
1892 Curent := Empty;
1893 Curdef := No_Location;
1894 Curru := No_Unit;
1895 Crloc := No_Location;
1896 Prevt := 'm';
1897
1898 -- Loop to output references
1899
1900 for Refno in 1 .. Nrefs loop
1901 Output_One_Ref : declare
1902 Ent : Entity_Id;
1903
1904 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1905 -- The current entry to be accessed
1906
1907 Left : Character;
1908 Right : Character;
1909 -- Used for {} or <> or () for type reference
1910
1911 procedure Check_Type_Reference
1912 (Ent : Entity_Id;
1913 List_Interface : Boolean;
1914 Is_Component : Boolean := False);
1915 -- Find whether there is a meaningful type reference for
1916 -- Ent, and display it accordingly. If List_Interface is
1917 -- true, then Ent is a progenitor interface of the current
1918 -- type entity being listed. In that case list it as is,
1919 -- without looking for a type reference for it. Flag is also
1920 -- used for index types of an array type, where the caller
1921 -- supplies the intended type reference. Is_Component serves
1922 -- the same purpose, to display the component type of a
1923 -- derived array type, for which only the parent type has
1924 -- ben displayed so far.
1925
1926 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1927 -- Recursive procedure to output instantiation references for
1928 -- the given source ptr in [file|line[...]] form. No output
1929 -- if the given location is not a generic template reference.
1930
1931 procedure Output_Overridden_Op (Old_E : Entity_Id);
1932 -- For a subprogram that is overriding, display information
1933 -- about the inherited operation that it overrides.
1934
1935 --------------------------
1936 -- Check_Type_Reference --
1937 --------------------------
1938
1939 procedure Check_Type_Reference
1940 (Ent : Entity_Id;
1941 List_Interface : Boolean;
1942 Is_Component : Boolean := False)
1943 is
1944 begin
1945 if List_Interface then
1946
1947 -- This is a progenitor interface of the type for which
1948 -- xref information is being generated.
1949
1950 Tref := Ent;
1951 Left := '<';
1952 Right := '>';
1953
1954 -- The following is not documented in lib-xref.ads ???
1955
1956 elsif Is_Component then
1957 Tref := Ent;
1958 Left := '(';
1959 Right := ')';
1960
1961 else
1962 Get_Type_Reference (Ent, Tref, Left, Right);
1963 end if;
1964
1965 if Present (Tref) then
1966
1967 -- Case of standard entity, output name
1968
1969 if Sloc (Tref) = Standard_Location then
1970 Write_Info_Char (Left);
1971 Write_Info_Name (Chars (Tref));
1972 Write_Info_Char (Right);
1973
1974 -- Case of source entity, output location
1975
1976 else
1977 Write_Info_Char (Left);
1978 Trunit := Get_Source_Unit (Sloc (Tref));
1979
1980 if Trunit /= Curxu then
1981 Write_Info_Nat (Dependency_Num (Trunit));
1982 Write_Info_Char ('|');
1983 end if;
1984
1985 Write_Info_Nat
1986 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1987
1988 declare
1989 Ent : Entity_Id;
1990 Ctyp : Character;
1991
1992 begin
1993 Ent := Tref;
1994 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1995
1996 if Ctyp = '+'
1997 and then Present (Full_View (Ent))
1998 then
1999 Ent := Underlying_Type (Ent);
2000
2001 if Present (Ent) then
2002 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2003 end if;
2004 end if;
2005
2006 Write_Info_Char (Ctyp);
2007 end;
2008
2009 Write_Info_Nat
2010 (Int (Get_Column_Number (Sloc (Tref))));
2011
2012 -- If the type comes from an instantiation, add the
2013 -- corresponding info.
2014
2015 Output_Instantiation_Refs (Sloc (Tref));
2016 Write_Info_Char (Right);
2017 end if;
2018 end if;
2019 end Check_Type_Reference;
2020
2021 -------------------------------
2022 -- Output_Instantiation_Refs --
2023 -------------------------------
2024
2025 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
2026 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
2027 Lun : Unit_Number_Type;
2028 Cu : constant Unit_Number_Type := Curru;
2029
2030 begin
2031 -- Nothing to do if this is not an instantiation
2032
2033 if Iloc = No_Location then
2034 return;
2035 end if;
2036
2037 -- Output instantiation reference
2038
2039 Write_Info_Char ('[');
2040 Lun := Get_Source_Unit (Iloc);
2041
2042 if Lun /= Curru then
2043 Curru := Lun;
2044 Write_Info_Nat (Dependency_Num (Curru));
2045 Write_Info_Char ('|');
2046 end if;
2047
2048 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2049
2050 -- Recursive call to get nested instantiations
2051
2052 Output_Instantiation_Refs (Iloc);
2053
2054 -- Output final ] after call to get proper nesting
2055
2056 Write_Info_Char (']');
2057 Curru := Cu;
2058 return;
2059 end Output_Instantiation_Refs;
2060
2061 --------------------------
2062 -- Output_Overridden_Op --
2063 --------------------------
2064
2065 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2066 Op : Entity_Id;
2067
2068 begin
2069 -- The overridden operation has an implicit declaration
2070 -- at the point of derivation. What we want to display
2071 -- is the original operation, which has the actual body
2072 -- (or abstract declaration) that is being overridden.
2073 -- The overridden operation is not always set, e.g. when
2074 -- it is a predefined operator.
2075
2076 if No (Old_E) then
2077 return;
2078
2079 -- Follow alias chain if one is present
2080
2081 elsif Present (Alias (Old_E)) then
2082
2083 -- The subprogram may have been implicitly inherited
2084 -- through several levels of derivation, so find the
2085 -- ultimate (source) ancestor.
2086
2087 Op := Ultimate_Alias (Old_E);
2088
2089 -- Normal case of no alias present. We omit generated
2090 -- primitives like tagged equality, that have no source
2091 -- representation.
2092
2093 else
2094 Op := Old_E;
2095 end if;
2096
2097 if Present (Op)
2098 and then Sloc (Op) /= Standard_Location
2099 and then Comes_From_Source (Op)
2100 then
2101 declare
2102 Loc : constant Source_Ptr := Sloc (Op);
2103 Par_Unit : constant Unit_Number_Type :=
2104 Get_Source_Unit (Loc);
2105
2106 begin
2107 Write_Info_Char ('<');
2108
2109 if Par_Unit /= Curxu then
2110 Write_Info_Nat (Dependency_Num (Par_Unit));
2111 Write_Info_Char ('|');
2112 end if;
2113
2114 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2115 Write_Info_Char ('p');
2116 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2117 Write_Info_Char ('>');
2118 end;
2119 end if;
2120 end Output_Overridden_Op;
2121
2122 -- Start of processing for Output_One_Ref
2123
2124 begin
2125 Ent := XE.Key.Ent;
2126
2127 -- Do not generate reference information for an ignored Ghost
2128 -- entity because neither the entity nor its references will
2129 -- appear in the final tree.
2130
2131 if Is_Ignored_Ghost_Entity (Ent) then
2132 goto Continue;
2133 end if;
2134
2135 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2136
2137 -- Skip reference if it is the only reference to an entity,
2138 -- and it is an END line reference, and the entity is not in
2139 -- the current extended source. This prevents junk entries
2140 -- consisting only of packages with END lines, where no
2141 -- entity from the package is actually referenced.
2142
2143 if XE.Key.Typ = 'e'
2144 and then Ent /= Curent
2145 and then (Refno = Nrefs
2146 or else
2147 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2148 and then not In_Extended_Main_Source_Unit (Ent)
2149 then
2150 goto Continue;
2151 end if;
2152
2153 -- For private type, get full view type
2154
2155 if Ctyp = '+'
2156 and then Present (Full_View (XE.Key.Ent))
2157 then
2158 Ent := Underlying_Type (Ent);
2159
2160 if Present (Ent) then
2161 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2162 end if;
2163 end if;
2164
2165 -- Special exception for Boolean
2166
2167 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2168 Ctyp := 'B';
2169 end if;
2170
2171 -- For variable reference, get corresponding type
2172
2173 if Ctyp = '*' then
2174 Ent := Etype (XE.Key.Ent);
2175 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2176
2177 -- If variable is private type, get full view type
2178
2179 if Ctyp = '+'
2180 and then Present (Full_View (Etype (XE.Key.Ent)))
2181 then
2182 Ent := Underlying_Type (Etype (XE.Key.Ent));
2183
2184 if Present (Ent) then
2185 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2186 end if;
2187
2188 elsif Is_Generic_Type (Ent) then
2189
2190 -- If the type of the entity is a generic private type,
2191 -- there is no usable full view, so retain the indication
2192 -- that this is an object.
2193
2194 Ctyp := '*';
2195 end if;
2196
2197 -- Special handling for access parameters and objects and
2198 -- components of an anonymous access type.
2199
2200 if Ekind_In (Etype (XE.Key.Ent),
2201 E_Anonymous_Access_Type,
2202 E_Anonymous_Access_Subprogram_Type,
2203 E_Anonymous_Access_Protected_Subprogram_Type)
2204 then
2205 if Is_Formal (XE.Key.Ent)
2206 or else
2207 Ekind_In
2208 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2209 then
2210 Ctyp := 'p';
2211 end if;
2212
2213 -- Special handling for Boolean
2214
2215 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2216 Ctyp := 'b';
2217 end if;
2218 end if;
2219
2220 -- Special handling for abstract types and operations
2221
2222 if Is_Overloadable (XE.Key.Ent)
2223 and then Is_Abstract_Subprogram (XE.Key.Ent)
2224 then
2225 if Ctyp = 'U' then
2226 Ctyp := 'x'; -- Abstract procedure
2227
2228 elsif Ctyp = 'V' then
2229 Ctyp := 'y'; -- Abstract function
2230 end if;
2231
2232 elsif Is_Type (XE.Key.Ent)
2233 and then Is_Abstract_Type (XE.Key.Ent)
2234 then
2235 if Is_Interface (XE.Key.Ent) then
2236 Ctyp := 'h';
2237
2238 elsif Ctyp = 'R' then
2239 Ctyp := 'H'; -- Abstract type
2240 end if;
2241 end if;
2242
2243 -- Only output reference if interesting type of entity
2244
2245 if Ctyp = ' '
2246
2247 -- Suppress references to object definitions, used for local
2248 -- references.
2249
2250 or else XE.Key.Typ = 'D'
2251 or else XE.Key.Typ = 'I'
2252
2253 -- Suppress self references, except for bodies that act as
2254 -- specs.
2255
2256 or else (XE.Key.Loc = XE.Def
2257 and then
2258 (XE.Key.Typ /= 'b'
2259 or else not Is_Subprogram (XE.Key.Ent)))
2260
2261 -- Also suppress definitions of body formals (we only
2262 -- treat these as references, and the references were
2263 -- separately recorded).
2264
2265 or else (Is_Formal (XE.Key.Ent)
2266 and then Present (Spec_Entity (XE.Key.Ent)))
2267 then
2268 null;
2269
2270 else
2271 -- Start new Xref section if new xref unit
2272
2273 if XE.Key.Eun /= Curxu then
2274 if Write_Info_Col > 1 then
2275 Write_Info_EOL;
2276 end if;
2277
2278 Curxu := XE.Key.Eun;
2279
2280 Write_Info_Initiate ('X');
2281 Write_Info_Char (' ');
2282 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2283 Write_Info_Char (' ');
2284 Write_Info_Name
2285 (Reference_Name (Source_Index (XE.Key.Eun)));
2286 end if;
2287
2288 -- Start new Entity line if new entity. Note that we
2289 -- consider two entities the same if they have the same
2290 -- name and source location. This causes entities in
2291 -- instantiations to be treated as though they referred
2292 -- to the template.
2293
2294 if No (Curent)
2295 or else
2296 (XE.Key.Ent /= Curent
2297 and then
2298 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2299 then
2300 Curent := XE.Key.Ent;
2301 Curdef := XE.Def;
2302
2303 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2304 Curlen := Name_Len;
2305 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2306
2307 if Write_Info_Col > 1 then
2308 Write_Info_EOL;
2309 end if;
2310
2311 -- Write column number information
2312
2313 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2314 Write_Info_Char (Ctyp);
2315 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2316
2317 -- Write level information
2318
2319 Write_Level_Info : declare
2320 function Is_Visible_Generic_Entity
2321 (E : Entity_Id) return Boolean;
2322 -- Check whether E is declared in the visible part
2323 -- of a generic package. For source navigation
2324 -- purposes, treat this as a visible entity.
2325
2326 function Is_Private_Record_Component
2327 (E : Entity_Id) return Boolean;
2328 -- Check whether E is a non-inherited component of a
2329 -- private extension. Even if the enclosing record is
2330 -- public, we want to treat the component as private
2331 -- for navigation purposes.
2332
2333 ---------------------------------
2334 -- Is_Private_Record_Component --
2335 ---------------------------------
2336
2337 function Is_Private_Record_Component
2338 (E : Entity_Id) return Boolean
2339 is
2340 S : constant Entity_Id := Scope (E);
2341 begin
2342 return
2343 Ekind (E) = E_Component
2344 and then Nkind (Declaration_Node (S)) =
2345 N_Private_Extension_Declaration
2346 and then Original_Record_Component (E) = E;
2347 end Is_Private_Record_Component;
2348
2349 -------------------------------
2350 -- Is_Visible_Generic_Entity --
2351 -------------------------------
2352
2353 function Is_Visible_Generic_Entity
2354 (E : Entity_Id) return Boolean
2355 is
2356 Par : Node_Id;
2357
2358 begin
2359 -- The Present check here is an error defense
2360
2361 if Present (Scope (E))
2362 and then Ekind (Scope (E)) /= E_Generic_Package
2363 then
2364 return False;
2365 end if;
2366
2367 Par := Parent (E);
2368 while Present (Par) loop
2369 if
2370 Nkind (Par) = N_Generic_Package_Declaration
2371 then
2372 -- Entity is a generic formal
2373
2374 return False;
2375
2376 elsif
2377 Nkind (Parent (Par)) = N_Package_Specification
2378 then
2379 return
2380 Is_List_Member (Par)
2381 and then List_Containing (Par) =
2382 Visible_Declarations (Parent (Par));
2383 else
2384 Par := Parent (Par);
2385 end if;
2386 end loop;
2387
2388 return False;
2389 end Is_Visible_Generic_Entity;
2390
2391 -- Start of processing for Write_Level_Info
2392
2393 begin
2394 if Is_Hidden (Curent)
2395 or else Is_Private_Record_Component (Curent)
2396 then
2397 Write_Info_Char (' ');
2398
2399 elsif
2400 Is_Public (Curent)
2401 or else Is_Visible_Generic_Entity (Curent)
2402 then
2403 Write_Info_Char ('*');
2404
2405 else
2406 Write_Info_Char (' ');
2407 end if;
2408 end Write_Level_Info;
2409
2410 -- Output entity name. We use the occurrence from the
2411 -- actual source program at the definition point.
2412
2413 declare
2414 Ent_Name : constant String :=
2415 Exact_Source_Name (Sloc (XE.Key.Ent));
2416 begin
2417 for C in Ent_Name'Range loop
2418 Write_Info_Char (Ent_Name (C));
2419 end loop;
2420 end;
2421
2422 -- See if we have a renaming reference
2423
2424 if Is_Object (XE.Key.Ent)
2425 and then Present (Renamed_Object (XE.Key.Ent))
2426 then
2427 Rref := Renamed_Object (XE.Key.Ent);
2428
2429 elsif Is_Overloadable (XE.Key.Ent)
2430 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2431 = N_Subprogram_Renaming_Declaration
2432 then
2433 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2434
2435 elsif Ekind (XE.Key.Ent) = E_Package
2436 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2437 N_Package_Renaming_Declaration
2438 then
2439 Rref := Name (Declaration_Node (XE.Key.Ent));
2440
2441 else
2442 Rref := Empty;
2443 end if;
2444
2445 if Present (Rref) then
2446 if Nkind (Rref) = N_Expanded_Name then
2447 Rref := Selector_Name (Rref);
2448 end if;
2449
2450 if Nkind (Rref) = N_Identifier
2451 or else Nkind (Rref) = N_Operator_Symbol
2452 then
2453 null;
2454
2455 -- For renamed array components, use the array name
2456 -- for the renamed entity, which reflect the fact that
2457 -- in general the whole array is aliased.
2458
2459 elsif Nkind (Rref) = N_Indexed_Component then
2460 if Nkind (Prefix (Rref)) = N_Identifier then
2461 Rref := Prefix (Rref);
2462 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2463 Rref := Selector_Name (Prefix (Rref));
2464 else
2465 Rref := Empty;
2466 end if;
2467
2468 else
2469 Rref := Empty;
2470 end if;
2471 end if;
2472
2473 -- Write out renaming reference if we have one
2474
2475 if Present (Rref) then
2476 Write_Info_Char ('=');
2477 Write_Info_Nat
2478 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2479 Write_Info_Char (':');
2480 Write_Info_Nat
2481 (Int (Get_Column_Number (Sloc (Rref))));
2482 end if;
2483
2484 -- Indicate that the entity is in the unit of the current
2485 -- xref section.
2486
2487 Curru := Curxu;
2488
2489 -- Write out information about generic parent, if entity
2490 -- is an instance.
2491
2492 if Is_Generic_Instance (XE.Key.Ent) then
2493 declare
2494 Gen_Par : constant Entity_Id :=
2495 Generic_Parent
2496 (Specification
2497 (Unit_Declaration_Node
2498 (XE.Key.Ent)));
2499 Loc : constant Source_Ptr := Sloc (Gen_Par);
2500 Gen_U : constant Unit_Number_Type :=
2501 Get_Source_Unit (Loc);
2502
2503 begin
2504 Write_Info_Char ('[');
2505
2506 if Curru /= Gen_U then
2507 Write_Info_Nat (Dependency_Num (Gen_U));
2508 Write_Info_Char ('|');
2509 end if;
2510
2511 Write_Info_Nat
2512 (Int (Get_Logical_Line_Number (Loc)));
2513 Write_Info_Char (']');
2514 end;
2515 end if;
2516
2517 -- See if we have a type reference and if so output
2518
2519 Check_Type_Reference (XE.Key.Ent, False);
2520
2521 -- Additional information for types with progenitors,
2522 -- including synchronized tagged types.
2523
2524 declare
2525 Typ : constant Entity_Id := XE.Key.Ent;
2526 Elmt : Elmt_Id;
2527
2528 begin
2529 if Is_Record_Type (Typ)
2530 and then Present (Interfaces (Typ))
2531 then
2532 Elmt := First_Elmt (Interfaces (Typ));
2533
2534 elsif Is_Concurrent_Type (Typ)
2535 and then Present (Corresponding_Record_Type (Typ))
2536 and then Present (
2537 Interfaces (Corresponding_Record_Type (Typ)))
2538 then
2539 Elmt :=
2540 First_Elmt (
2541 Interfaces (Corresponding_Record_Type (Typ)));
2542
2543 else
2544 Elmt := No_Elmt;
2545 end if;
2546
2547 while Present (Elmt) loop
2548 Check_Type_Reference (Node (Elmt), True);
2549 Next_Elmt (Elmt);
2550 end loop;
2551 end;
2552
2553 -- For array types, list index types as well. (This is
2554 -- not C, indexes have distinct types).
2555
2556 if Is_Array_Type (XE.Key.Ent) then
2557 declare
2558 A_Typ : constant Entity_Id := XE.Key.Ent;
2559 Indx : Node_Id;
2560
2561 begin
2562 -- If this is a derived array type, we have
2563 -- output the parent type, so add the component
2564 -- type now.
2565
2566 if Is_Derived_Type (A_Typ) then
2567 Check_Type_Reference
2568 (Component_Type (A_Typ), False, True);
2569 end if;
2570
2571 -- Add references to index types.
2572
2573 Indx := First_Index (XE.Key.Ent);
2574 while Present (Indx) loop
2575 Check_Type_Reference
2576 (First_Subtype (Etype (Indx)), True);
2577 Next_Index (Indx);
2578 end loop;
2579 end;
2580 end if;
2581
2582 -- If the entity is an overriding operation, write info
2583 -- on operation that was overridden.
2584
2585 if Is_Subprogram (XE.Key.Ent)
2586 and then Present (Overridden_Operation (XE.Key.Ent))
2587 then
2588 Output_Overridden_Op
2589 (Overridden_Operation (XE.Key.Ent));
2590 end if;
2591
2592 -- End of processing for entity output
2593
2594 Crloc := No_Location;
2595 end if;
2596
2597 -- Output the reference if it is not as the same location
2598 -- as the previous one, or it is a read-reference that
2599 -- indicates that the entity is an in-out actual in a call.
2600
2601 if XE.Key.Loc /= No_Location
2602 and then
2603 (XE.Key.Loc /= Crloc
2604 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2605 then
2606 Crloc := XE.Key.Loc;
2607 Prevt := XE.Key.Typ;
2608
2609 -- Start continuation if line full, else blank
2610
2611 if Write_Info_Col > 72 then
2612 Write_Info_EOL;
2613 Write_Info_Initiate ('.');
2614 end if;
2615
2616 Write_Info_Char (' ');
2617
2618 -- Output file number if changed
2619
2620 if XE.Key.Lun /= Curru then
2621 Curru := XE.Key.Lun;
2622 Write_Info_Nat (Dependency_Num (Curru));
2623 Write_Info_Char ('|');
2624 end if;
2625
2626 Write_Info_Nat
2627 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2628 Write_Info_Char (XE.Key.Typ);
2629
2630 if Is_Overloadable (XE.Key.Ent) then
2631 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2632 or else
2633 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2634 then
2635 Output_Import_Export_Info (XE.Key.Ent);
2636 end if;
2637 end if;
2638
2639 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2640
2641 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2642 end if;
2643 end if;
2644 end Output_One_Ref;
2645
2646 <<Continue>>
2647 null;
2648 end loop;
2649
2650 Write_Info_EOL;
2651 end Output_Refs;
2652 end Output_References;
2653
2654 ---------------------------------
2655 -- Process_Deferred_References --
2656 ---------------------------------
2657
2658 procedure Process_Deferred_References is
2659 begin
2660 for J in Deferred_References.First .. Deferred_References.Last loop
2661 declare
2662 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2663
2664 begin
2665 case Is_LHS (D.N) is
2666 when Yes =>
2667 Generate_Reference (D.E, D.N, 'm');
2668
2669 when No =>
2670 Generate_Reference (D.E, D.N, 'r');
2671
2672 -- Not clear if Unknown can occur at this stage, but if it
2673 -- does we will treat it as a normal reference.
2674
2675 when Unknown =>
2676 Generate_Reference (D.E, D.N, 'r');
2677 end case;
2678 end;
2679 end loop;
2680
2681 -- Clear processed entries from table
2682
2683 Deferred_References.Init;
2684 end Process_Deferred_References;
2685
2686 -- Start of elaboration for Lib.Xref
2687
2688 begin
2689 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2690 -- because it's not an access type.
2691
2692 Xref_Set.Reset;
2693 end Lib.Xref;