1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2022, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Ada
.Unchecked_Conversion
;
27 with Aspects
; use Aspects
;
28 with Atree
; use Atree
;
29 with Debug
; use Debug
;
30 with Einfo
; use Einfo
;
31 with Einfo
.Entities
; use Einfo
.Entities
;
32 with Einfo
.Utils
; use Einfo
.Utils
;
33 with Elists
; use Elists
;
34 with GNAT
.Dynamic_HTables
; use GNAT
.Dynamic_HTables
;
36 with Namet
; use Namet
;
37 with Nlists
; use Nlists
;
38 with Output
; use Output
;
39 with Seinfo
; use Seinfo
;
40 with Sem_Eval
; use Sem_Eval
;
41 with Sinfo
; use Sinfo
;
42 with Sinfo
.Nodes
; use Sinfo
.Nodes
;
43 with Sinfo
.Utils
; use Sinfo
.Utils
;
44 with Snames
; use Snames
;
45 with Sinput
; use Sinput
;
46 with Stand
; use Stand
;
47 with Stringt
; use Stringt
;
48 with System
.Case_Util
; use System
.Case_Util
;
49 with SCIL_LL
; use SCIL_LL
;
50 with Uintp
; use Uintp
;
51 with Urealp
; use Urealp
;
52 with Uname
; use Uname
;
54 package body Treepr
is
56 ----------------------------------
57 -- Approach Used for Tree Print --
58 ----------------------------------
60 -- When a complete subtree is being printed, a trace phase first marks
61 -- the nodes and lists to be printed. This trace phase allocates logical
62 -- numbers corresponding to the order in which the nodes and lists will
63 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
64 -- logical node numbers using a hash table. Output is done using a set
65 -- of Print_xxx routines, which are similar to the Write_xxx routines
66 -- with the same name, except that they do not generate any output in
67 -- the marking phase. This allows identical logic to be used in the
70 -- Note that the hash table not only holds the serial numbers, but also
71 -- acts as a record of which nodes have already been visited. In the
72 -- marking phase, a node has been visited if it is already in the hash
73 -- table, and in the printing phase, we can tell whether a node has
74 -- already been printed by looking at the value of the serial number.
76 ----------------------
77 -- Global Variables --
78 ----------------------
80 Print_Low_Level_Info
: Boolean := False with Warnings
=> Off
;
81 -- Set True to print low-level information useful for debugging Atree and
84 function Hash
(Key
: Int
) return GNAT
.Bucket_Range_Type
;
85 -- Simple Hash function for Node_Ids, List_Ids and Elist_Ids
87 procedure Destroy
(Value
: in out Nat
) is null;
88 pragma Annotate
(CodePeer
, False_Positive
, "unassigned parameter",
89 "in out parameter is required to instantiate generic");
90 -- Dummy routine for destroing hashed values
92 package Serial_Numbers
is new Dynamic_Hash_Tables
96 Expansion_Threshold
=> 1.5,
97 Expansion_Factor
=> 2,
98 Compression_Threshold
=> 0.3,
99 Compression_Factor
=> 2,
101 Destroy_Value
=> Destroy
,
103 -- Hash tables with dynamic resizing based on load factor. They provide
104 -- reasonable performance both when the printed AST is small (e.g. when
105 -- printing from debugger) and large (e.g. when printing with -gnatdt).
107 Hash_Table
: Serial_Numbers
.Dynamic_Hash_Table
;
108 -- The hash table itself, see Serial_Number function for details of use
110 Next_Serial_Number
: Nat
;
111 -- Number of last visited node or list. Used during the marking phase to
112 -- set proper node numbers in the hash table, and during the printing
113 -- phase to make sure that a given node is not printed more than once.
114 -- (nodes are printed in order during the printing phase, that's the
115 -- point of numbering them in the first place).
117 Printing_Descendants
: Boolean;
118 -- True if descendants are being printed, False if not. In the false case,
119 -- only node Id's are printed. In the true case, node numbers as well as
120 -- node Id's are printed, as described above.
122 type Phase_Type
is (Marking
, Printing
);
123 -- Type for Phase variable
126 -- When an entire tree is being printed, the traversal operates in two
127 -- phases. The first phase marks the nodes in use by installing node
128 -- numbers in the node number table. The second phase prints the nodes.
129 -- This variable indicates the current phase.
131 ----------------------
132 -- Local Procedures --
133 ----------------------
135 function From_Union
is new Ada
.Unchecked_Conversion
(Union_Id
, Uint
);
136 function From_Union
is new Ada
.Unchecked_Conversion
(Union_Id
, Ureal
);
138 function To_Mixed
(S
: String) return String;
139 -- Turns an identifier into Mixed_Case. For bootstrap reasons, we cannot
140 -- use To_Mixed function from System.Case_Util.
142 function Image
(F
: Node_Or_Entity_Field
) return String;
144 procedure Print_Init
;
145 -- Initialize for printing of tree with descendants
147 procedure Print_End_Span
(N
: Node_Id
);
148 -- Print contents of End_Span field of node N. The format includes the
149 -- implicit source location as well as the value of the field.
151 procedure Print_Term
;
152 -- Clean up after printing of tree with descendants
154 procedure Print_Char
(C
: Character);
155 -- Print character C if currently in print phase, noop if in marking phase
157 procedure Print_Name
(N
: Name_Id
);
158 -- Print name from names table if currently in print phase, noop if in
159 -- marking phase. Note that the name is output in mixed case mode.
161 procedure Print_Node_Header
(N
: Node_Id
);
162 -- Print header line used by Print_Node and Print_Node_Briefly
164 procedure Print_Node_Kind
(N
: Node_Id
);
165 -- Print node kind name in mixed case if in print phase, noop if in
168 procedure Print_Str
(S
: String);
169 -- Print string S if currently in print phase, noop if in marking phase
171 procedure Print_Str_Mixed_Case
(S
: String);
172 -- Like Print_Str, except that the string is printed in mixed case mode
174 procedure Print_Int
(I
: Int
);
175 -- Print integer I if currently in print phase, noop if in marking phase
178 -- Print end of line if currently in print phase, noop if in marking phase
180 procedure Print_Node_Ref
(N
: Node_Id
);
181 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
182 -- in the latter case, including the Id and the Nkind of the node.
184 procedure Print_List_Ref
(L
: List_Id
);
185 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
187 procedure Print_Elist_Ref
(E
: Elist_Id
);
188 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
190 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
191 -- Called if the node being printed is an entity. Prints fields from the
192 -- extension, using routines in Einfo to get the field names and flags.
194 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
195 procedure Print_Field
198 N
: Node_Or_Entity_Id
;
199 FD
: Field_Descriptor
;
201 -- Print representation of Field value (name, tree, string, uint, charcode)
202 -- The format parameter controls the format of printing in the case of an
203 -- integer value (see UI_Write for details).
205 procedure Print_Node_Field
209 FD
: Field_Descriptor
;
210 Format
: UI_Format
:= Auto
);
212 procedure Print_Entity_Field
214 Field
: Entity_Field
;
216 FD
: Field_Descriptor
;
217 Format
: UI_Format
:= Auto
);
219 procedure Print_Flag
(F
: Boolean);
220 -- Print True or False
225 Prefix_Char
: Character);
226 -- This is the internal routine used to print a single node. Each line of
227 -- output is preceded by Prefix_Str (which is used to set the indentation
228 -- level and the bars used to link list elements). In addition, for lines
229 -- other than the first, an additional character Prefix_Char is output.
231 function Serial_Number
(Id
: Int
) return Nat
;
232 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
233 -- serial number, or zero if no serial number has yet been assigned.
235 procedure Set_Serial_Number
;
236 -- Can be called only immediately following a call to Serial_Number that
237 -- returned a value of zero. Causes the value of Next_Serial_Number to be
238 -- placed in the hash table (corresponding to the Id argument used in the
239 -- Serial_Number call), and increments Next_Serial_Number.
244 Prefix_Char
: Character);
245 -- Called to process a single node in the case where descendants are to
246 -- be printed before every line, and Prefix_Char added to all lines
247 -- except the header line for the node.
249 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
250 -- Visit_List is called to process a list in the case where descendants
251 -- are to be printed. Prefix_Str is to be added to all printed lines.
253 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
254 -- Visit_Elist is called to process an element list in the case where
255 -- descendants are to be printed. Prefix_Str is to be added to all
262 function Hash
(Key
: Int
) return GNAT
.Bucket_Range_Type
is
263 function Cast
is new Ada
.Unchecked_Conversion
264 (Source
=> Int
, Target
=> GNAT
.Bucket_Range_Type
);
273 function Image
(F
: Node_Or_Entity_Field
) return String is
276 when F_Alloc_For_BIP_Return
=>
277 return "Alloc_For_BIP_Return";
278 when F_Assignment_OK
=>
279 return "Assignment_OK";
280 when F_Backwards_OK
=>
281 return "Backwards_OK";
282 when F_Conversion_OK
=>
283 return "Conversion_OK";
284 when F_Forwards_OK
=>
285 return "Forwards_OK";
286 when F_Has_SP_Choice
=>
287 return "Has_SP_Choice";
288 when F_Is_Elaboration_Checks_OK_Node
=>
289 return "Is_Elaboration_Checks_OK_Node";
290 when F_Is_Elaboration_Warnings_OK_Node
=>
291 return "Is_Elaboration_Warnings_OK_Node";
292 when F_Is_Known_Guaranteed_ABE
=>
293 return "Is_Known_Guaranteed_ABE";
294 when F_Is_SPARK_Mode_On_Node
=>
295 return "Is_SPARK_Mode_On_Node";
296 when F_Local_Raise_Not_OK
=>
297 return "Local_Raise_Not_OK";
298 when F_SCIL_Controlling_Tag
=>
299 return "SCIL_Controlling_Tag";
300 when F_SCIL_Entity
=>
301 return "SCIL_Entity";
302 when F_SCIL_Tag_Value
=>
303 return "SCIL_Tag_Value";
304 when F_SCIL_Target_Prim
=>
305 return "SCIL_Target_Prim";
306 when F_Shift_Count_OK
=>
307 return "Shift_Count_OK";
313 when F_BIP_Initialization_Call
=>
314 return "BIP_Initialization_Call";
315 when F_Body_Needed_For_SAL
=>
316 return "Body_Needed_For_SAL";
317 when F_CR_Discriminant
=>
318 return "CR_Discriminant";
319 when F_DT_Entry_Count
=>
320 return "DT_Entry_Count";
321 when F_DT_Offset_To_Top_Func
=>
322 return "DT_Offset_To_Top_Func";
323 when F_DT_Position
=>
324 return "DT_Position";
327 when F_Has_Inherited_DIC
=>
328 return "Has_Inherited_DIC";
329 when F_Has_Own_DIC
=>
330 return "Has_Own_DIC";
333 when F_Ignore_SPARK_Mode_Pragmas
=>
334 return "Ignore_SPARK_Mode_Pragmas";
335 when F_Is_Constr_Subt_For_UN_Aliased
=>
336 return "Is_Constr_Subt_For_UN_Aliased";
337 when F_Is_CPP_Class
=>
338 return "Is_CPP_Class";
339 when F_Is_CUDA_Kernel
=>
340 return "Is_CUDA_Kernel";
341 when F_Is_DIC_Procedure
=>
342 return "Is_DIC_Procedure";
343 when F_Is_Discrim_SO_Function
=>
344 return "Is_Discrim_SO_Function";
345 when F_Is_Elaboration_Checks_OK_Id
=>
346 return "Is_Elaboration_Checks_OK_Id";
347 when F_Is_Elaboration_Warnings_OK_Id
=>
348 return "Is_Elaboration_Warnings_OK_Id";
349 when F_Is_RACW_Stub_Type
=>
350 return "Is_RACW_Stub_Type";
351 when F_LSP_Subprogram
=>
352 return "LSP_Subprogram";
353 when F_OK_To_Rename
=>
354 return "OK_To_Rename";
355 when F_Referenced_As_LHS
=>
356 return "Referenced_As_LHS";
359 when F_SPARK_Aux_Pragma
=>
360 return "SPARK_Aux_Pragma";
361 when F_SPARK_Aux_Pragma_Inherited
=>
362 return "SPARK_Aux_Pragma_Inherited";
363 when F_SPARK_Pragma
=>
364 return "SPARK_Pragma";
365 when F_SPARK_Pragma_Inherited
=>
366 return "SPARK_Pragma_Inherited";
367 when F_SSO_Set_High_By_Default
=>
368 return "SSO_Set_High_By_Default";
369 when F_SSO_Set_Low_By_Default
=>
370 return "SSO_Set_Low_By_Default";
374 Result
: constant String := To_Mixed
(F
'Img);
376 return Result
(3 .. Result
'Last); -- Remove "F_"
385 function p
(N
: Union_Id
) return Node_Or_Entity_Id
is
388 when List_Low_Bound
.. List_High_Bound
- 1 =>
389 return Nlists
.Parent
(List_Id
(N
));
392 return Parent
(Node_Or_Entity_Id
(N
));
396 Write_Str
(" is not a Node_Id or List_Id value");
406 function par
(N
: Union_Id
) return Node_Or_Entity_Id
renames p
;
408 procedure ppar
(N
: Union_Id
) is
410 if N
/= Empty_List_Or_Node
then
412 ppar
(Union_Id
(p
(N
)));
420 procedure pe
(N
: Union_Id
) renames pn
;
426 procedure pl
(L
: Int
) is
436 -- This is the case where we transform e.g. +36 to -99999936
440 Lid
:= -(99999990 + L
);
442 Lid
:= -(99999900 + L
);
444 Lid
:= -(99999000 + L
);
446 Lid
:= -(99990000 + L
);
447 elsif L
<= 99999 then
448 Lid
:= -(99900000 + L
);
449 elsif L
<= 999999 then
450 Lid
:= -(99000000 + L
);
451 elsif L
<= 9999999 then
452 Lid
:= -(90000000 + L
);
458 -- Now output the list
460 Print_Tree_List
(List_Id
(Lid
));
468 procedure pn
(N
: Union_Id
) is
474 when List_Low_Bound
.. List_High_Bound
- 1 =>
477 Print_Tree_Node
(Node_Id
(N
));
479 Print_Tree_Elist
(Elist_Id
(N
));
482 Id
: constant Elmt_Id
:= Elmt_Id
(N
);
485 Write_Str
("No_Elmt");
488 Write_Str
("Elmt_Id --> ");
489 Print_Tree_Node
(Node
(Id
));
493 Namet
.wn
(Name_Id
(N
));
494 when Strings_Range
=>
495 Write_String_Table_Entry
(String_Id
(N
));
497 Uintp
.pid
(From_Union
(N
));
499 Urealp
.pr
(From_Union
(N
));
501 Write_Str
("Invalid Union_Id: ");
513 procedure pp
(N
: Union_Id
) renames pn
;
519 procedure ppp
(N
: Union_Id
) renames pt
;
525 procedure Print_Char
(C
: Character) is
527 if Phase
= Printing
then
532 ---------------------
533 -- Print_Elist_Ref --
534 ---------------------
536 procedure Print_Elist_Ref
(E
: Elist_Id
) is
538 if Phase
/= Printing
then
543 Write_Str
("<no elist>");
545 elsif Is_Empty_Elmt_List
(E
) then
546 Write_Str
("Empty elist, (Elist_Id=");
551 Write_Str
("(Elist_Id=");
555 if Printing_Descendants
then
557 Write_Int
(Serial_Number
(Int
(E
)));
562 -------------------------
563 -- Print_Elist_Subtree --
564 -------------------------
566 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
570 Next_Serial_Number
:= 1;
574 Next_Serial_Number
:= 1;
579 end Print_Elist_Subtree
;
585 procedure Print_End_Span
(N
: Node_Id
) is
586 Val
: constant Uint
:= End_Span
(N
);
590 Write_Str
(" (Uint = ");
591 Write_Str
(UI_Image
(Val
));
594 if Present
(Val
) then
595 Write_Location
(End_Location
(N
));
599 -----------------------
600 -- Print_Entity_Info --
601 -----------------------
603 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
606 Print_Str
("Ekind = ");
607 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
611 Print_Str
("Etype = ");
612 Print_Node_Ref
(Etype
(Ent
));
615 if Convention
(Ent
) /= Convention_Ada
then
617 Print_Str
("Convention = ");
619 -- Print convention name skipping the Convention_ at the start
622 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
625 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
631 Fields
: Entity_Field_Array
renames
632 Entity_Field_Table
(Ekind
(Ent
)).all;
633 Should_Print
: constant Entity_Field_Set
:=
634 -- Set of fields that should be printed. False for fields that were
635 -- already printed above.
637 | F_Basic_Convention
=> False, -- Convention was printed
640 -- Outer loop makes flags come out last
642 for Print_Flags
in Boolean loop
643 for Field_Index
in Fields
'Range loop
645 FD
: Field_Descriptor
renames
646 Field_Descriptors
(Fields
(Field_Index
));
648 if Should_Print
(Fields
(Field_Index
))
649 and then (FD
.Kind
= Flag_Field
) = Print_Flags
652 (Prefix
, Fields
(Field_Index
), Ent
, FD
);
658 end Print_Entity_Info
;
664 procedure Print_Eol
is
666 if Phase
= Printing
then
675 -- Instantiations of low-level getters and setters that take offsets
676 -- in units of the size of the field.
678 use Atree
.Atree_Private_Part
;
680 function Get_Flag
is new Get_1_Bit_Field
681 (Boolean) with Inline
;
683 function Get_Node_Id
is new Get_32_Bit_Field
684 (Node_Id
) with Inline
;
686 function Get_List_Id
is new Get_32_Bit_Field
687 (List_Id
) with Inline
;
689 function Get_Elist_Id
is new Get_32_Bit_Field_With_Default
690 (Elist_Id
, No_Elist
) with Inline
;
692 function Get_Name_Id
is new Get_32_Bit_Field
693 (Name_Id
) with Inline
;
695 function Get_String_Id
is new Get_32_Bit_Field
696 (String_Id
) with Inline
;
698 function Get_Uint
is new Get_32_Bit_Field_With_Default
699 (Uint
, Uint_0
) with Inline
;
701 function Get_Valid_Uint
is new Get_32_Bit_Field
703 -- Used for both Valid_Uint and other subtypes of Uint. Note that we don't
704 -- instantiate Get_Valid_32_Bit_Field; we don't want to blow up if the
707 function Get_Ureal
is new Get_32_Bit_Field
710 function Get_Node_Kind_Type
is new Get_8_Bit_Field
711 (Node_Kind
) with Inline
;
713 function Get_Entity_Kind_Type
is new Get_8_Bit_Field
714 (Entity_Kind
) with Inline
;
716 function Get_Source_Ptr
is new Get_32_Bit_Field
717 (Source_Ptr
) with Inline
, Unreferenced
;
719 function Get_Small_Paren_Count_Type
is new Get_2_Bit_Field
720 (Small_Paren_Count_Type
) with Inline
, Unreferenced
;
722 function Get_Union_Id
is new Get_32_Bit_Field
723 (Union_Id
) with Inline
;
725 function Get_Convention_Id
is new Get_8_Bit_Field
726 (Convention_Id
) with Inline
, Unreferenced
;
728 function Get_Mechanism_Type
is new Get_32_Bit_Field
729 (Mechanism_Type
) with Inline
, Unreferenced
;
731 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
733 if Phase
/= Printing
then
737 if Val
in Node_Range
then
738 Print_Node_Ref
(Node_Id
(Val
));
740 elsif Val
in List_Range
then
741 Print_List_Ref
(List_Id
(Val
));
743 elsif Val
in Elist_Range
then
744 Print_Elist_Ref
(Elist_Id
(Val
));
746 elsif Val
in Names_Range
then
747 Print_Name
(Name_Id
(Val
));
748 Write_Str
(" (Name_Id=");
749 Write_Int
(Int
(Val
));
752 elsif Val
in Strings_Range
then
753 Write_String_Table_Entry
(String_Id
(Val
));
754 Write_Str
(" (String_Id=");
755 Write_Int
(Int
(Val
));
758 elsif Val
in Uint_Range
then
759 UI_Write
(From_Union
(Val
), Format
);
760 Write_Str
(" (Uint = ");
761 Write_Int
(Int
(Val
));
764 elsif Val
in Ureal_Range
then
765 UR_Write
(From_Union
(Val
));
766 Write_Str
(" (Ureal = ");
767 Write_Int
(Int
(Val
));
771 Print_Str
("****** Incorrect value = ");
772 Print_Int
(Int
(Val
));
776 procedure Print_Field
779 N
: Node_Or_Entity_Id
;
780 FD
: Field_Descriptor
;
783 Printed
: Boolean := False;
785 procedure Print_Initial
;
786 -- Print the initial stuff that goes before the value
792 procedure Print_Initial
is
798 if Print_Low_Level_Info
then
800 Write_Int
(Int
(FD
.Offset
));
806 -- Start of processing for Print_Field
809 if Phase
/= Printing
then
816 Val
: constant Boolean := Get_Flag
(N
, FD
.Offset
);
824 when Node_Id_Field
=>
826 Val
: constant Node_Id
:= Get_Node_Id
(N
, FD
.Offset
);
828 if Present
(Val
) then
830 Print_Node_Ref
(Val
);
834 when List_Id_Field
=>
836 Val
: constant List_Id
:= Get_List_Id
(N
, FD
.Offset
);
838 if Present
(Val
) then
840 Print_List_Ref
(Val
);
844 when Elist_Id_Field
=>
846 Val
: constant Elist_Id
:= Get_Elist_Id
(N
, FD
.Offset
);
848 if Present
(Val
) then
850 Print_Elist_Ref
(Val
);
854 when Name_Id_Field
=>
856 Val
: constant Name_Id
:= Get_Name_Id
(N
, FD
.Offset
);
858 if Present
(Val
) then
861 Write_Str
(" (Name_Id=");
862 Write_Int
(Int
(Val
));
867 when String_Id_Field
=>
869 Val
: constant String_Id
:= Get_String_Id
(N
, FD
.Offset
);
871 if Val
/= No_String
then
873 Write_String_Table_Entry
(Val
);
874 Write_Str
(" (String_Id=");
875 Write_Int
(Int
(Val
));
882 Val
: constant Uint
:= Get_Uint
(N
, FD
.Offset
);
883 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
885 if Present
(Val
) then
887 UI_Write
(Val
, Format
);
888 Write_Str
(" (Uint = ");
889 Write_Int
(Cast
(Val
));
894 when Valid_Uint_Field | Unat_Field | Upos_Field
895 | Nonzero_Uint_Field
=>
897 Val
: constant Uint
:= Get_Valid_Uint
(N
, FD
.Offset
);
898 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
901 UI_Write
(Val
, Format
);
904 when Valid_Uint_Field
=> Write_Str
(" v");
905 when Unat_Field
=> Write_Str
(" n");
906 when Upos_Field
=> Write_Str
(" p");
907 when Nonzero_Uint_Field
=> Write_Str
(" nz");
908 when others => raise Program_Error
;
911 Write_Str
(" (Uint = ");
912 Write_Int
(Cast
(Val
));
918 Val
: constant Ureal
:= Get_Ureal
(N
, FD
.Offset
);
919 function Cast
is new Ada
.Unchecked_Conversion
(Ureal
, Int
);
921 if Val
/= No_Ureal
then
924 Write_Str
(" (Ureal = ");
925 Write_Int
(Cast
(Val
));
930 when Node_Kind_Type_Field
=>
932 Val
: constant Node_Kind
:= Get_Node_Kind_Type
(N
, FD
.Offset
);
935 Print_Str_Mixed_Case
(Node_Kind
'Image (Val
));
938 when Entity_Kind_Type_Field
=>
940 Val
: constant Entity_Kind
:=
941 Get_Entity_Kind_Type
(N
, FD
.Offset
);
944 Print_Str_Mixed_Case
(Entity_Kind
'Image (Val
));
947 when Union_Id_Field
=>
949 Val
: constant Union_Id
:= Get_Union_Id
(N
, FD
.Offset
);
951 if Val
/= Empty_List_Or_Node
then
954 if Val
in Node_Range
then
955 Print_Node_Ref
(Node_Id
(Val
));
957 elsif Val
in List_Range
then
958 Print_List_Ref
(List_Id
(Val
));
961 Print_Str
("<invalid union id>");
968 Print_Str
("<unknown ");
969 Print_Str
(Field_Kind
'Image (FD
.Kind
));
977 -- If an exception is raised while printing, we try to print some low-level
978 -- information that is useful for debugging.
984 Ada
.Unchecked_Conversion
(Field_Size_32_Bit
, Int
);
988 Write_Str
("exception raised in Print_Field -- int val = ");
991 case Field_Size
(FD
.Kind
) is
992 when 1 => Write_Int
(Int
(Get_1_Bit_Val
(N
, FD
.Offset
)));
993 when 2 => Write_Int
(Int
(Get_2_Bit_Val
(N
, FD
.Offset
)));
994 when 4 => Write_Int
(Int
(Get_4_Bit_Val
(N
, FD
.Offset
)));
995 when 8 => Write_Int
(Int
(Get_8_Bit_Val
(N
, FD
.Offset
)));
997 Write_Int
(Cast
(Get_32_Bit_Val
(N
, FD
.Offset
)));
1001 Write_Str
(FD
.Kind
'Img);
1003 Write_Int
(Int
(Field_Size
(FD
.Kind
)));
1004 Write_Str
(" bits");
1009 Write_Str
("double exception raised in Print_Field");
1014 ----------------------
1015 -- Print_Node_Field --
1016 ----------------------
1018 procedure Print_Node_Field
1022 FD
: Field_Descriptor
;
1023 Format
: UI_Format
:= Auto
)
1025 pragma Assert
(FD
.Type_Only
= No_Type_Only
);
1026 -- Type_Only is for entities
1028 if not Field_Is_Initial_Zero
(N
, Field
) then
1029 Print_Field
(Prefix
, Image
(Field
), N
, FD
, Format
);
1031 end Print_Node_Field
;
1033 ------------------------
1034 -- Print_Entity_Field --
1035 ------------------------
1037 procedure Print_Entity_Field
1039 Field
: Entity_Field
;
1041 FD
: Field_Descriptor
;
1042 Format
: UI_Format
:= Auto
)
1044 NN
: constant Node_Id
:= Node_To_Fetch_From
(N
, Field
);
1046 if not Field_Is_Initial_Zero
(N
, Field
) then
1047 Print_Field
(Prefix
, Image
(Field
), NN
, FD
, Format
);
1049 end Print_Entity_Field
;
1055 procedure Print_Flag
(F
: Boolean) is
1060 Print_Str
("False");
1068 procedure Print_Init
is
1070 Printing_Descendants
:= True;
1073 pragma Assert
(not Serial_Numbers
.Present
(Hash_Table
));
1074 Hash_Table
:= Serial_Numbers
.Create
(512);
1081 procedure Print_Int
(I
: Int
) is
1083 if Phase
= Printing
then
1088 --------------------
1089 -- Print_List_Ref --
1090 --------------------
1092 procedure Print_List_Ref
(L
: List_Id
) is
1094 if Phase
/= Printing
then
1099 Write_Str
("<no list>");
1101 elsif Is_Empty_List
(L
) then
1102 Write_Str
("<empty list> (List_Id=");
1103 Write_Int
(Int
(L
));
1109 if Printing_Descendants
then
1111 Write_Int
(Serial_Number
(Int
(L
)));
1114 Write_Str
(" (List_Id=");
1115 Write_Int
(Int
(L
));
1120 ------------------------
1121 -- Print_List_Subtree --
1122 ------------------------
1124 procedure Print_List_Subtree
(L
: List_Id
) is
1128 Next_Serial_Number
:= 1;
1132 Next_Serial_Number
:= 1;
1137 end Print_List_Subtree
;
1143 procedure Print_Name
(N
: Name_Id
) is
1145 if Phase
= Printing
then
1146 Write_Name_For_Debug
(N
, Quote
=> """");
1154 procedure Print_Node
1156 Prefix_Str
: String;
1157 Prefix_Char
: Character)
1159 Prefix
: constant String := Prefix_Str
& Prefix_Char
;
1161 Sfile
: Source_File_Index
;
1164 if Phase
/= Printing
then
1168 -- If there is no such node, indicate that. Skip the rest, so we don't
1169 -- crash getting fields of the nonexistent node.
1171 if not Is_Valid_Node
(Union_Id
(N
)) then
1172 Print_Str
("No such node: ");
1173 Print_Int
(Int
(N
));
1178 -- Print header line
1180 Print_Str
(Prefix_Str
);
1181 Print_Node_Header
(N
);
1183 if Is_Rewrite_Substitution
(N
) then
1184 Print_Str
(Prefix_Str
);
1185 Print_Str
(" Rewritten: original node = ");
1186 Print_Node_Ref
(Original_Node
(N
));
1190 if Print_Low_Level_Info
then
1191 Print_Atree_Info
(N
);
1198 if not Is_List_Member
(N
) then
1199 Print_Str
(Prefix_Str
);
1200 Print_Str
(" Parent = ");
1201 Print_Node_Ref
(Parent
(N
));
1205 -- Print Sloc field if it is set
1207 if Sloc
(N
) /= No_Location
then
1209 Print_Str
("Sloc = ");
1211 if Sloc
(N
) = Standard_Location
then
1212 Print_Str
("Standard_Location");
1214 elsif Sloc
(N
) = Standard_ASCII_Location
then
1215 Print_Str
("Standard_ASCII_Location");
1218 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
1219 Print_Int
(Int
(Sloc
(N
) - Source_Text
(Sfile
)'First));
1221 Write_Location
(Sloc
(N
));
1227 -- Print Chars field if present
1229 if Nkind
(N
) in N_Has_Chars
then
1230 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1232 Print_Str
("Chars = initial zero");
1235 elsif Chars
(N
) /= No_Name
then
1237 Print_Str
("Chars = ");
1238 Print_Name
(Chars
(N
));
1239 Write_Str
(" (Name_Id=");
1240 Write_Int
(Int
(Chars
(N
)));
1246 -- Special field print operations for non-entity nodes
1248 if Nkind
(N
) not in N_Entity
then
1250 -- Deal with Left_Opnd and Right_Opnd fields
1252 if Nkind
(N
) in N_Op
1253 or else Nkind
(N
) in N_Short_Circuit
1254 or else Nkind
(N
) in N_Membership_Test
1256 -- Print Left_Opnd if present
1258 if Nkind
(N
) not in N_Unary_Op
then
1260 Print_Str
("Left_Opnd = ");
1261 Print_Node_Ref
(Left_Opnd
(N
));
1268 Print_Str
("Right_Opnd = ");
1269 Print_Node_Ref
(Right_Opnd
(N
));
1273 -- Deal with Entity_Or_Associated_Node. If N has both, then just
1274 -- print Entity; they are the same thing.
1276 if N
in N_Inclusive_Has_Entity
and then Present
(Entity
(N
)) then
1278 Print_Str
("Entity = ");
1279 Print_Node_Ref
(Entity
(N
));
1282 elsif N
in N_Has_Associated_Node
1283 and then Present
(Associated_Node
(N
))
1286 Print_Str
("Associated_Node = ");
1287 Print_Node_Ref
(Associated_Node
(N
));
1291 -- Print special fields if we have a subexpression
1293 if Nkind
(N
) in N_Subexpr
then
1295 if Assignment_OK
(N
) then
1297 Print_Str
("Assignment_OK = True");
1301 if Do_Range_Check
(N
) then
1303 Print_Str
("Do_Range_Check = True");
1307 if Has_Dynamic_Length_Check
(N
) then
1309 Print_Str
("Has_Dynamic_Length_Check = True");
1313 if Has_Aspects
(N
) then
1315 Print_Str
("Has_Aspects = True");
1319 if Is_Controlling_Actual
(N
) then
1321 Print_Str
("Is_Controlling_Actual = True");
1325 if Is_Overloaded
(N
) then
1327 Print_Str
("Is_Overloaded = True");
1331 if Is_Static_Expression
(N
) then
1333 Print_Str
("Is_Static_Expression = True");
1337 if Must_Not_Freeze
(N
) then
1339 Print_Str
("Must_Not_Freeze = True");
1343 if Paren_Count
(N
) /= 0 then
1345 Print_Str
("Paren_Count = ");
1346 Print_Int
(Int
(Paren_Count
(N
)));
1350 if Raises_Constraint_Error
(N
) then
1352 Print_Str
("Raises_Constraint_Error = True");
1358 -- Print Do_Overflow_Check field if present
1360 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1362 Print_Str
("Do_Overflow_Check = True");
1366 -- Print Etype field if present (printing of this field for entities
1367 -- is handled by the Print_Entity_Info procedure).
1369 if Nkind
(N
) in N_Has_Etype
and then Present
(Etype
(N
)) then
1371 Print_Str
("Etype = ");
1372 Print_Node_Ref
(Etype
(N
));
1378 Fields
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
1379 Should_Print
: constant Node_Field_Set
:=
1380 -- Set of fields that should be printed. False for fields that were
1381 -- already printed above, and for In_List, which we don't bother
1385 | F_Comes_From_Source
1388 | F_Is_Ignored_Ghost_Node
1390 | F_Link
-- Parent was printed
1394 | F_Entity_Or_Associated_Node
-- one of them was printed
1397 | F_Has_Dynamic_Length_Check
1399 | F_Is_Controlling_Actual
1401 | F_Is_Static_Expression
1403 | F_Small_Paren_Count
-- Paren_Count was printed
1404 | F_Raises_Constraint_Error
1405 | F_Do_Overflow_Check
1412 Fmt
: constant UI_Format
:=
1413 (if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
)
1418 -- Outer loop makes flags come out last
1420 for Print_Flags
in Boolean loop
1421 for Field_Index
in Fields
'Range loop
1423 FD
: Field_Descriptor
renames
1424 Field_Descriptors
(Fields
(Field_Index
));
1426 if Should_Print
(Fields
(Field_Index
))
1427 and then (FD
.Kind
= Flag_Field
) = Print_Flags
1429 -- Special case for End_Span, which also prints the
1432 if Fields
(Field_Index
) = F_End_Span
then
1437 (Prefix
, Fields
(Field_Index
), N
, FD
, Fmt
);
1445 -- Print aspects if present
1447 if Has_Aspects
(N
) then
1449 Print_Str
("Aspect_Specifications = ");
1450 Print_Field
(Union_Id
(Aspect_Specifications
(N
)));
1454 -- Print entity information for entities
1456 if Nkind
(N
) in N_Entity
then
1457 Print_Entity_Info
(N
, Prefix
);
1460 -- Print the SCIL node (if available)
1462 if Present
(Get_SCIL_Node
(N
)) then
1464 Print_Str
("SCIL_Node = ");
1465 Print_Node_Ref
(Get_SCIL_Node
(N
));
1470 ------------------------
1471 -- Print_Node_Briefly --
1472 ------------------------
1474 procedure Print_Node_Briefly
(N
: Node_Id
) is
1476 Printing_Descendants
:= False;
1478 Print_Node_Header
(N
);
1479 end Print_Node_Briefly
;
1481 -----------------------
1482 -- Print_Node_Header --
1483 -----------------------
1485 procedure Print_Node_Header
(N
: Node_Id
) is
1486 Enumerate
: Boolean := False;
1487 -- Flag set when enumerating multiple header flags
1489 procedure Print_Header_Flag
(Flag
: String);
1490 -- Output one of the flags that appears in a node header. The routine
1491 -- automatically handles enumeration of multiple flags.
1493 -----------------------
1494 -- Print_Header_Flag --
1495 -----------------------
1497 procedure Print_Header_Flag
(Flag
: String) is
1507 end Print_Header_Flag
;
1509 -- Start of processing for Print_Node_Header
1514 if not Is_Valid_Node
(Union_Id
(N
)) then
1515 Print_Str
(" (no such node)");
1522 if Comes_From_Source
(N
) then
1523 Print_Header_Flag
("source");
1526 if Analyzed
(N
) then
1527 Print_Header_Flag
("analyzed");
1530 if Error_Posted
(N
) then
1531 Print_Header_Flag
("posted");
1534 if Is_Ignored_Ghost_Node
(N
) then
1535 Print_Header_Flag
("ignored ghost");
1538 if Check_Actuals
(N
) then
1539 Print_Header_Flag
("check actuals");
1547 end Print_Node_Header
;
1549 ---------------------
1550 -- Print_Node_Kind --
1551 ---------------------
1553 procedure Print_Node_Kind
(N
: Node_Id
) is
1555 if Phase
= Printing
then
1556 Print_Str_Mixed_Case
(Node_Kind
'Image (Nkind
(N
)));
1558 end Print_Node_Kind
;
1560 --------------------
1561 -- Print_Node_Ref --
1562 --------------------
1564 procedure Print_Node_Ref
(N
: Node_Id
) is
1568 if Phase
/= Printing
then
1573 Write_Str
("<empty>");
1575 elsif N
= Error
then
1576 Write_Str
("<error>");
1579 if Printing_Descendants
then
1580 S
:= Serial_Number
(Int
(N
));
1590 Print_Node_Kind
(N
);
1592 if Nkind
(N
) in N_Has_Chars
then
1595 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1596 Print_Str
("Chars = initial zero");
1600 Print_Name
(Chars
(N
));
1604 -- If this is a discrete expression whose value is known, print that
1607 if Nkind
(N
) in N_Subexpr
1608 and then Compile_Time_Known_Value
(N
)
1609 and then Present
(Etype
(N
))
1610 and then Is_Discrete_Type
(Etype
(N
))
1612 if Is_Entity_Name
(N
) -- e.g. enumeration literal
1613 or else Nkind
(N
) in N_Integer_Literal
1614 | N_Character_Literal
1615 | N_Unchecked_Type_Conversion
1617 Print_Str
(" val = ");
1618 UI_Write
(Expr_Value
(N
));
1622 if Nkind
(N
) in N_Entity
then
1623 Write_Str
(" (Entity_Id=");
1625 Write_Str
(" (Node_Id=");
1628 Write_Int
(Int
(N
));
1630 if Sloc
(N
) <= Standard_Location
then
1639 ------------------------
1640 -- Print_Node_Subtree --
1641 ------------------------
1643 procedure Print_Node_Subtree
(N
: Node_Id
) is
1647 Next_Serial_Number
:= 1;
1649 Visit_Node
(N
, "", ' ');
1651 Next_Serial_Number
:= 1;
1653 Visit_Node
(N
, "", ' ');
1656 end Print_Node_Subtree
;
1662 procedure Print_Str
(S
: String) is
1664 if Phase
= Printing
then
1669 --------------------------
1670 -- Print_Str_Mixed_Case --
1671 --------------------------
1673 procedure Print_Str_Mixed_Case
(S
: String) is
1675 Print_Str
(To_Mixed
(S
));
1676 end Print_Str_Mixed_Case
;
1682 procedure Print_Term
is
1684 Serial_Numbers
.Destroy
(Hash_Table
);
1687 ---------------------
1688 -- Print_Tree_Elist --
1689 ---------------------
1691 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1695 Printing_Descendants
:= False;
1698 Print_Elist_Ref
(E
);
1701 if Present
(E
) and then not Is_Empty_Elmt_List
(E
) then
1702 M
:= First_Elmt
(E
);
1707 exit when No
(Next_Elmt
(M
));
1708 Print_Node
(Node
(M
), "", '|');
1712 Print_Node
(Node
(M
), "", ' ');
1715 end Print_Tree_Elist
;
1717 ---------------------
1718 -- Print_Tree_List --
1719 ---------------------
1721 procedure Print_Tree_List
(L
: List_Id
) is
1725 Printing_Descendants
:= False;
1729 Print_Str
(" List_Id=");
1730 Print_Int
(Int
(L
));
1736 Print_Str
("<empty node list>");
1743 exit when Next
(N
) = Empty
;
1744 Print_Node
(N
, "", '|');
1748 Print_Node
(N
, "", ' ');
1751 end Print_Tree_List
;
1753 ---------------------
1754 -- Print_Tree_Node --
1755 ---------------------
1757 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1759 Printing_Descendants
:= False;
1761 Print_Node
(N
, Label
, ' ');
1762 end Print_Tree_Node
;
1768 procedure pt
(N
: Union_Id
) is
1771 when List_Low_Bound
.. List_High_Bound
- 1 =>
1772 Print_List_Subtree
(List_Id
(N
));
1775 Print_Node_Subtree
(Node_Id
(N
));
1778 Print_Elist_Subtree
(Elist_Id
(N
));
1790 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1791 -- to save the Id that should be used if Set_Serial_Number is called.
1793 function Serial_Number
(Id
: Int
) return Nat
is
1796 return Serial_Numbers
.Get
(Hash_Table
, Id
);
1799 -----------------------
1800 -- Set_Serial_Number --
1801 -----------------------
1803 procedure Set_Serial_Number
is
1805 Serial_Numbers
.Put
(Hash_Table
, Hash_Id
, Next_Serial_Number
);
1806 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1807 end Set_Serial_Number
;
1813 function To_Mixed
(S
: String) return String is
1815 return Result
: String (S
'Range) := S
do
1824 procedure Tree_Dump
is
1825 procedure Underline
;
1826 -- Put underline under string we just printed
1828 procedure Underline
is
1829 Col
: constant Int
:= Column
;
1834 while Col
> Column
loop
1841 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1842 -- flags immediately, before starting the dump. This avoids generating two
1843 -- copies of the dump if an abort occurs after printing the dump, and more
1844 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1846 -- Note: unlike in the source print case (in Sprint), we do not output
1847 -- separate trees for each unit. Instead the -df debug switch causes the
1848 -- tree that is output from the main unit to trace references into other
1849 -- units (normally such references are not traced). Since all other units
1850 -- are linked to the main unit by at least one reference, this causes all
1851 -- tree nodes to be included in the output tree.
1854 if Debug_Flag_Y
then
1855 Debug_Flag_Y
:= False;
1857 Write_Str
("Tree created for Standard (spec) ");
1859 Print_Node_Subtree
(Standard_Package_Node
);
1863 if Debug_Flag_T
then
1864 Debug_Flag_T
:= False;
1867 Write_Str
("Tree created for ");
1868 Write_Unit_Name_For_Debug
(Unit_Name
(Main_Unit
));
1870 Print_Node_Subtree
(Cunit
(Main_Unit
));
1879 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1882 S
: constant Nat
:= Serial_Number
(Int
(E
));
1885 -- In marking phase, return if already marked, otherwise set next
1886 -- serial number in hash table for later reference.
1888 if Phase
= Marking
then
1890 return; -- already visited
1895 -- In printing phase, if already printed, then return, otherwise we
1896 -- are printing the next item, so increment the serial number.
1899 if S
< Next_Serial_Number
then
1900 return; -- already printed
1902 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1906 -- Now process the list (Print calls have no effect in marking phase)
1908 Print_Str
(Prefix_Str
);
1909 Print_Elist_Ref
(E
);
1912 if Is_Empty_Elmt_List
(E
) then
1913 Print_Str
(Prefix_Str
);
1914 Print_Str
("(Empty element list)");
1919 if Phase
= Printing
then
1920 M
:= First_Elmt
(E
);
1921 while Present
(M
) loop
1923 Print_Str
(Prefix_Str
);
1930 Print_Str
(Prefix_Str
);
1934 M
:= First_Elmt
(E
);
1935 while Present
(M
) loop
1936 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1946 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1948 S
: constant Nat
:= Serial_Number
(Int
(L
));
1951 -- In marking phase, return if already marked, otherwise set next
1952 -- serial number in hash table for later reference.
1954 if Phase
= Marking
then
1961 -- In printing phase, if already printed, then return, otherwise we
1962 -- are printing the next item, so increment the serial number.
1965 if S
< Next_Serial_Number
then
1966 return; -- already printed
1968 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1972 -- Now process the list (Print calls have no effect in marking phase)
1974 Print_Str
(Prefix_Str
);
1978 Print_Str
(Prefix_Str
);
1979 Print_Str
("|Parent = ");
1980 Print_Node_Ref
(Parent
(L
));
1986 Print_Str
(Prefix_Str
);
1987 Print_Str
("(Empty list)");
1992 Print_Str
(Prefix_Str
);
1996 while Next
(N
) /= Empty
loop
1997 Visit_Node
(N
, Prefix_Str
, '|');
2002 Visit_Node
(N
, Prefix_Str
, ' ');
2009 procedure Visit_Node
2011 Prefix_Str
: String;
2012 Prefix_Char
: Character)
2014 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
2015 -- Prefix string for printing referenced fields
2017 procedure Visit_Descendant
(D
: Union_Id
);
2018 -- This procedure tests the given value of one of the Fields referenced
2019 -- by the current node to determine whether to visit it recursively.
2020 -- The visited node will be indented using New_Prefix.
2022 ----------------------
2023 -- Visit_Descendant --
2024 ----------------------
2026 procedure Visit_Descendant
(D
: Union_Id
) is
2028 -- Case of descendant is a node
2030 if D
in Node_Range
then
2032 -- Don't bother about Empty or Error descendants
2034 if D
<= Union_Id
(Empty_Or_Error
) then
2039 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
2042 -- Descendants in one of the standardly compiled internal
2043 -- packages are normally ignored, unless the parent is also
2044 -- in such a package (happens when Standard itself is output)
2045 -- or if the -df switch is set which causes all links to be
2046 -- followed, even into package standard.
2048 if Sloc
(Nod
) <= Standard_Location
then
2049 if Sloc
(N
) > Standard_Location
2050 and then not Debug_Flag_F
2055 -- Don't bother about a descendant in a different unit than
2056 -- the node we came from unless the -df switch is set. Note
2057 -- that we know at this point that Sloc (D) > Standard_Location
2059 -- Note: the tests for No_Location here just make sure that we
2060 -- don't blow up on a node which is missing an Sloc value. This
2061 -- should not normally happen.
2064 if (Sloc
(N
) <= Standard_Location
2065 or else Sloc
(N
) = No_Location
2066 or else Sloc
(Nod
) = No_Location
2067 or else not In_Same_Source_Unit
(Nod
, N
))
2068 and then not Debug_Flag_F
2074 -- Don't bother visiting a source node that has a parent which
2075 -- is not the node we came from. We prefer to trace such nodes
2076 -- from their real parents. This causes the tree to be printed
2077 -- in a more coherent order, e.g. a defining identifier listed
2078 -- next to its corresponding declaration, instead of next to
2079 -- some semantic reference.
2081 -- This test is skipped for nodes in standard packages unless
2082 -- the -dy option is set (which outputs the tree for standard)
2084 -- Also, always follow pointers to Is_Itype entities,
2085 -- since we want to list these when they are first referenced.
2087 if Parent
(Nod
) /= Empty
2088 and then Comes_From_Source
(Nod
)
2089 and then Parent
(Nod
) /= N
2090 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
2095 -- If we successfully fall through all the above tests (which
2096 -- execute a return if the node is not to be visited), we can
2097 -- go ahead and visit the node.
2099 Visit_Node
(Nod
, New_Prefix
, ' ');
2102 -- Case of descendant is a list
2104 elsif D
in List_Range
then
2106 -- Don't bother with a missing list, empty list or error list
2108 pragma Assert
(D
/= Union_Id
(No_List
));
2109 -- Because No_List = Empty, which is in Node_Range above
2111 if D
= Union_Id
(Error_List
)
2112 or else Is_Empty_List
(List_Id
(D
))
2116 -- Otherwise we can visit the list. Note that we don't bother to
2117 -- do the parent test that we did for the node case, because it
2118 -- just does not happen that lists are referenced more than one
2119 -- place in the tree. We aren't counting on this being the case
2120 -- to generate valid output, it is just that we don't need in
2121 -- practice to worry about listing the list at a place that is
2125 Visit_List
(List_Id
(D
), New_Prefix
);
2128 -- Case of descendant is an element list
2130 elsif D
in Elist_Range
then
2132 -- Don't bother with a missing list, or an empty list
2134 if D
= Union_Id
(No_Elist
)
2135 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
2139 -- Otherwise, visit the referenced element list
2142 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
2146 raise Program_Error
;
2148 end Visit_Descendant
;
2150 -- Start of processing for Visit_Node
2157 -- Set fatal error node in case we get a blow up during the trace
2159 Current_Error_Node
:= N
;
2161 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
2162 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
2163 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
2165 -- In the marking phase, all we do is to set the serial number
2167 if Phase
= Marking
then
2168 if Serial_Number
(Int
(N
)) /= 0 then
2169 return; -- already visited
2174 -- In the printing phase, we print the node
2177 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
2179 -- Here we have already visited the node, but if it is in a list,
2180 -- we still want to print the reference, so that it is clear that
2181 -- it belongs to the list.
2183 if Is_List_Member
(N
) then
2184 Print_Str
(Prefix_Str
);
2187 Print_Str
(Prefix_Str
);
2188 Print_Char
(Prefix_Char
);
2189 Print_Str
("(already output)");
2191 Print_Str
(Prefix_Str
);
2192 Print_Char
(Prefix_Char
);
2199 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
2200 Print_Str
(Prefix_Str
);
2201 Print_Char
(Prefix_Char
);
2203 Next_Serial_Number
:= Next_Serial_Number
+ 1;
2207 -- Visit all descendants of this node
2210 A
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
2212 for Field_Index
in A
'Range loop
2214 F
: constant Node_Field
:= A
(Field_Index
);
2215 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2217 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2218 -- For all other kinds of descendants (strings, names, uints
2219 -- etc), there is nothing to visit (the contents of the
2220 -- field will be printed when we print the containing node,
2221 -- but what concerns us now is looking for descendants in
2224 and then F
/= F_Next_Entity
-- See below for why we skip this
2226 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2232 if Has_Aspects
(N
) then
2233 Visit_Descendant
(Union_Id
(Aspect_Specifications
(N
)));
2236 if Nkind
(N
) in N_Entity
then
2238 A
: Entity_Field_Array
renames Entity_Field_Table
(Ekind
(N
)).all;
2240 for Field_Index
in A
'Range loop
2242 F
: constant Entity_Field
:= A
(Field_Index
);
2243 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2245 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2247 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2253 -- Now an interesting special case. Normally parents are always
2254 -- printed since we traverse the tree in a downwards direction.
2255 -- However, there is an exception to this rule, which is the
2256 -- case where a parent is constructed by the compiler and is not
2257 -- referenced elsewhere in the tree. The following catches this case.
2259 if not Comes_From_Source
(N
) then
2260 Visit_Descendant
(Union_Id
(Parent
(N
)));
2263 -- You may be wondering why we omitted Next_Entity above. The answer
2264 -- is that we want to treat it rather specially. Why? Because a
2265 -- Next_Entity link does not correspond to a level deeper in the
2266 -- tree, and we do not want the tree to march off to the right of the
2267 -- page due to bogus indentations coming from this effect.
2269 -- To prevent this, what we do is to control references via
2270 -- Next_Entity only from the first entity on a given scope chain,
2271 -- and we keep them all at the same level. Of course if an entity
2272 -- has already been referenced it is not printed.
2274 if Present
(Next_Entity
(N
))
2275 and then Present
(Scope
(N
))
2276 and then First_Entity
(Scope
(N
)) = N
2283 while Present
(Nod
) loop
2285 Visit_Descendant
(Union_Id
(Nod
));