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