1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2023, 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 Image
(F
: Node_Or_Entity_Field
) return String;
140 procedure Print_Init
;
141 -- Initialize for printing of tree with descendants
143 procedure Print_End_Span
(N
: Node_Id
);
144 -- Print contents of End_Span field of node N. The format includes the
145 -- implicit source location as well as the value of the field.
147 procedure Print_Term
;
148 -- Clean up after printing of tree with descendants
150 procedure Print_Char
(C
: Character);
151 -- Print character C if currently in print phase, noop if in marking phase
153 procedure Print_Name
(N
: Name_Id
);
154 -- Print name from names table if currently in print phase, noop if in
155 -- marking phase. Note that the name is output in mixed case mode.
157 procedure Print_Node_Header
(N
: Node_Id
);
158 -- Print header line used by Print_Node and Print_Node_Briefly
160 procedure Print_Node_Kind
(N
: Node_Id
);
161 -- Print node kind name in mixed case if in print phase, noop if in
164 procedure Print_Str
(S
: String);
165 -- Print string S if currently in print phase, noop if in marking phase
167 procedure Print_Str_Mixed_Case
(S
: String);
168 -- Like Print_Str, except that the string is printed in mixed case mode
170 procedure Print_Int
(I
: Int
);
171 -- Print integer I if currently in print phase, noop if in marking phase
174 -- Print end of line if currently in print phase, noop if in marking phase
176 procedure Print_Node_Ref
(N
: Node_Id
);
177 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
178 -- in the latter case, including the Id and the Nkind of the node.
180 procedure Print_List_Ref
(L
: List_Id
);
181 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
183 procedure Print_Elist_Ref
(E
: Elist_Id
);
184 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
186 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
187 -- Called if the node being printed is an entity. Prints fields from the
188 -- extension, using routines in Einfo to get the field names and flags.
190 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
191 procedure Print_Field
194 N
: Node_Or_Entity_Id
;
195 FD
: Field_Descriptor
;
197 -- Print representation of Field value (name, tree, string, uint, charcode)
198 -- The format parameter controls the format of printing in the case of an
199 -- integer value (see UI_Write for details).
201 procedure Print_Node_Field
205 FD
: Field_Descriptor
;
206 Format
: UI_Format
:= Auto
);
208 procedure Print_Entity_Field
210 Field
: Entity_Field
;
212 FD
: Field_Descriptor
;
213 Format
: UI_Format
:= Auto
);
215 procedure Print_Flag
(F
: Boolean);
216 -- Print True or False
221 Prefix_Char
: Character);
222 -- This is the internal routine used to print a single node. Each line of
223 -- output is preceded by Prefix_Str (which is used to set the indentation
224 -- level and the bars used to link list elements). In addition, for lines
225 -- other than the first, an additional character Prefix_Char is output.
227 function Serial_Number
(Id
: Int
) return Nat
;
228 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
229 -- serial number, or zero if no serial number has yet been assigned.
231 procedure Set_Serial_Number
;
232 -- Can be called only immediately following a call to Serial_Number that
233 -- returned a value of zero. Causes the value of Next_Serial_Number to be
234 -- placed in the hash table (corresponding to the Id argument used in the
235 -- Serial_Number call), and increments Next_Serial_Number.
240 Prefix_Char
: Character);
241 -- Called to process a single node in the case where descendants are to
242 -- be printed before every line, and Prefix_Char added to all lines
243 -- except the header line for the node.
245 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
246 -- Visit_List is called to process a list in the case where descendants
247 -- are to be printed. Prefix_Str is to be added to all printed lines.
249 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
250 -- Visit_Elist is called to process an element list in the case where
251 -- descendants are to be printed. Prefix_Str is to be added to all
258 function Hash
(Key
: Int
) return GNAT
.Bucket_Range_Type
is
259 function Cast
is new Ada
.Unchecked_Conversion
260 (Source
=> Int
, Target
=> GNAT
.Bucket_Range_Type
);
269 function Image
(F
: Node_Or_Entity_Field
) return String is
272 -- We special case the following; otherwise the compiler will use
273 -- the usual Mixed_Case convention.
275 when F_Assignment_OK
=>
276 return "Assignment_OK";
277 when F_Backwards_OK
=>
278 return "Backwards_OK";
279 when F_Conversion_OK
=>
280 return "Conversion_OK";
281 when F_Forwards_OK
=>
282 return "Forwards_OK";
283 when F_Has_SP_Choice
=>
284 return "Has_SP_Choice";
285 when F_Is_Elaboration_Checks_OK_Node
=>
286 return "Is_Elaboration_Checks_OK_Node";
287 when F_Is_Elaboration_Warnings_OK_Node
=>
288 return "Is_Elaboration_Warnings_OK_Node";
289 when F_Is_Known_Guaranteed_ABE
=>
290 return "Is_Known_Guaranteed_ABE";
291 when F_Is_SPARK_Mode_On_Node
=>
292 return "Is_SPARK_Mode_On_Node";
293 when F_Local_Raise_Not_OK
=>
294 return "Local_Raise_Not_OK";
295 when F_SCIL_Controlling_Tag
=>
296 return "SCIL_Controlling_Tag";
297 when F_SCIL_Entity
=>
298 return "SCIL_Entity";
299 when F_SCIL_Tag_Value
=>
300 return "SCIL_Tag_Value";
301 when F_SCIL_Target_Prim
=>
302 return "SCIL_Target_Prim";
303 when F_Shift_Count_OK
=>
304 return "Shift_Count_OK";
310 when F_BIP_Initialization_Call
=>
311 return "BIP_Initialization_Call";
312 when F_Body_Needed_For_SAL
=>
313 return "Body_Needed_For_SAL";
314 when F_CR_Discriminant
=>
315 return "CR_Discriminant";
316 when F_DT_Entry_Count
=>
317 return "DT_Entry_Count";
318 when F_DT_Offset_To_Top_Func
=>
319 return "DT_Offset_To_Top_Func";
320 when F_DT_Position
=>
321 return "DT_Position";
324 when F_Has_Inherited_DIC
=>
325 return "Has_Inherited_DIC";
326 when F_Has_Own_DIC
=>
327 return "Has_Own_DIC";
330 when F_Ignore_SPARK_Mode_Pragmas
=>
331 return "Ignore_SPARK_Mode_Pragmas";
332 when F_Is_Constr_Subt_For_UN_Aliased
=>
333 return "Is_Constr_Subt_For_UN_Aliased";
334 when F_Is_CPP_Class
=>
335 return "Is_CPP_Class";
336 when F_Is_CUDA_Kernel
=>
337 return "Is_CUDA_Kernel";
338 when F_Is_DIC_Procedure
=>
339 return "Is_DIC_Procedure";
340 when F_Is_Discrim_SO_Function
=>
341 return "Is_Discrim_SO_Function";
342 when F_Is_Elaboration_Checks_OK_Id
=>
343 return "Is_Elaboration_Checks_OK_Id";
344 when F_Is_Elaboration_Warnings_OK_Id
=>
345 return "Is_Elaboration_Warnings_OK_Id";
346 when F_Is_RACW_Stub_Type
=>
347 return "Is_RACW_Stub_Type";
348 when F_LSP_Subprogram
=>
349 return "LSP_Subprogram";
350 when F_OK_To_Rename
=>
351 return "OK_To_Rename";
352 when F_Referenced_As_LHS
=>
353 return "Referenced_As_LHS";
356 when F_SPARK_Aux_Pragma
=>
357 return "SPARK_Aux_Pragma";
358 when F_SPARK_Aux_Pragma_Inherited
=>
359 return "SPARK_Aux_Pragma_Inherited";
360 when F_SPARK_Pragma
=>
361 return "SPARK_Pragma";
362 when F_SPARK_Pragma_Inherited
=>
363 return "SPARK_Pragma_Inherited";
364 when F_SSO_Set_High_By_Default
=>
365 return "SSO_Set_High_By_Default";
366 when F_SSO_Set_Low_By_Default
=>
367 return "SSO_Set_Low_By_Default";
371 Result
: String := F
'Img;
374 return Result
(3 .. Result
'Last); -- Remove "F_"
383 function p
(N
: Union_Id
) return Node_Or_Entity_Id
is
386 when List_Low_Bound
.. List_High_Bound
- 1 =>
387 return Nlists
.Parent
(List_Id
(N
));
390 return Parent
(Node_Or_Entity_Id
(N
));
394 Write_Str
(" is not a Node_Id or List_Id value");
404 function par
(N
: Union_Id
) return Node_Or_Entity_Id
renames p
;
406 procedure ppar
(N
: Union_Id
) is
408 if N
/= Empty_List_Or_Node
then
410 ppar
(Union_Id
(p
(N
)));
418 procedure pe
(N
: Union_Id
) renames pn
;
424 procedure pl
(L
: Int
) is
434 -- This is the case where we transform e.g. +36 to -99999936
438 Lid
:= -(99999990 + L
);
440 Lid
:= -(99999900 + L
);
442 Lid
:= -(99999000 + L
);
444 Lid
:= -(99990000 + L
);
445 elsif L
<= 99999 then
446 Lid
:= -(99900000 + L
);
447 elsif L
<= 999999 then
448 Lid
:= -(99000000 + L
);
449 elsif L
<= 9999999 then
450 Lid
:= -(90000000 + L
);
456 -- Now output the list
458 Print_Tree_List
(List_Id
(Lid
));
466 procedure pn
(N
: Union_Id
) is
472 when List_Low_Bound
.. List_High_Bound
- 1 =>
475 Print_Tree_Node
(Node_Id
(N
));
477 Print_Tree_Elist
(Elist_Id
(N
));
480 Id
: constant Elmt_Id
:= Elmt_Id
(N
);
483 Write_Str
("No_Elmt");
486 Write_Str
("Elmt_Id --> ");
487 Print_Tree_Node
(Node
(Id
));
491 Namet
.wn
(Name_Id
(N
));
492 when Strings_Range
=>
493 Write_String_Table_Entry
(String_Id
(N
));
495 Uintp
.pid
(From_Union
(N
));
497 Urealp
.pr
(From_Union
(N
));
499 Write_Str
("Invalid Union_Id: ");
511 procedure pp
(N
: Union_Id
) renames pn
;
517 procedure ppp
(N
: Union_Id
) renames pt
;
523 procedure Print_Char
(C
: Character) is
525 if Phase
= Printing
then
530 ---------------------
531 -- Print_Elist_Ref --
532 ---------------------
534 procedure Print_Elist_Ref
(E
: Elist_Id
) is
536 if Phase
/= Printing
then
541 Write_Str
("<no elist>");
543 elsif Is_Empty_Elmt_List
(E
) then
544 Write_Str
("Empty elist, (Elist_Id=");
549 Write_Str
("(Elist_Id=");
553 if Printing_Descendants
then
555 Write_Int
(Serial_Number
(Int
(E
)));
560 -------------------------
561 -- Print_Elist_Subtree --
562 -------------------------
564 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
568 Next_Serial_Number
:= 1;
572 Next_Serial_Number
:= 1;
577 end Print_Elist_Subtree
;
583 procedure Print_End_Span
(N
: Node_Id
) is
584 Val
: constant Uint
:= End_Span
(N
);
588 Write_Str
(" (Uint = ");
589 Write_Str
(UI_Image
(Val
));
592 if Present
(Val
) then
593 Write_Location
(End_Location
(N
));
597 -----------------------
598 -- Print_Entity_Info --
599 -----------------------
601 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
604 Print_Str
("Ekind = ");
605 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
609 Print_Str
("Etype = ");
610 Print_Node_Ref
(Etype
(Ent
));
613 if Convention
(Ent
) /= Convention_Ada
then
615 Print_Str
("Convention = ");
617 -- Print convention name skipping the Convention_ at the start
620 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
623 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
629 Fields
: Entity_Field_Array
renames
630 Entity_Field_Table
(Ekind
(Ent
)).all;
631 Should_Print
: constant Entity_Field_Set
:=
632 -- Set of fields that should be printed. False for fields that were
633 -- already printed above.
635 | F_Basic_Convention
=> False, -- Convention was printed
638 -- Outer loop makes flags come out last
640 for Print_Flags
in Boolean loop
641 for Field_Index
in Fields
'Range loop
643 FD
: Field_Descriptor
renames
644 Field_Descriptors
(Fields
(Field_Index
));
646 if Should_Print
(Fields
(Field_Index
))
647 and then (FD
.Kind
= Flag_Field
) = Print_Flags
650 (Prefix
, Fields
(Field_Index
), Ent
, FD
);
656 end Print_Entity_Info
;
662 procedure Print_Eol
is
664 if Phase
= Printing
then
673 -- Instantiations of low-level getters and setters that take offsets
674 -- in units of the size of the field.
676 use Atree
.Atree_Private_Part
;
678 function Get_Flag
is new Get_1_Bit_Field
679 (Boolean) with Inline
;
681 function Get_Node_Id
is new Get_32_Bit_Field
682 (Node_Id
) with Inline
;
684 function Get_List_Id
is new Get_32_Bit_Field
685 (List_Id
) with Inline
;
687 function Get_Elist_Id
is new Get_32_Bit_Field_With_Default
688 (Elist_Id
, No_Elist
) with Inline
;
690 function Get_Name_Id
is new Get_32_Bit_Field
691 (Name_Id
) with Inline
;
693 function Get_String_Id
is new Get_32_Bit_Field
694 (String_Id
) with Inline
;
696 function Get_Uint
is new Get_32_Bit_Field_With_Default
697 (Uint
, Uint_0
) with Inline
;
699 function Get_Valid_Uint
is new Get_32_Bit_Field
701 -- Used for both Valid_Uint and other subtypes of Uint. Note that we don't
702 -- instantiate Get_Valid_32_Bit_Field; we don't want to blow up if the
705 function Get_Ureal
is new Get_32_Bit_Field
708 function Get_Node_Kind_Type
is new Get_8_Bit_Field
709 (Node_Kind
) with Inline
;
711 function Get_Entity_Kind_Type
is new Get_8_Bit_Field
712 (Entity_Kind
) with Inline
;
714 function Get_Source_Ptr
is new Get_32_Bit_Field
715 (Source_Ptr
) with Inline
, Unreferenced
;
717 function Get_Small_Paren_Count_Type
is new Get_2_Bit_Field
718 (Small_Paren_Count_Type
) with Inline
, Unreferenced
;
720 function Get_Union_Id
is new Get_32_Bit_Field
721 (Union_Id
) with Inline
;
723 function Get_Convention_Id
is new Get_8_Bit_Field
724 (Convention_Id
) with Inline
, Unreferenced
;
726 function Get_Mechanism_Type
is new Get_32_Bit_Field
727 (Mechanism_Type
) with Inline
, Unreferenced
;
729 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
731 if Phase
/= Printing
then
735 if Val
in Node_Range
then
736 Print_Node_Ref
(Node_Id
(Val
));
738 elsif Val
in List_Range
then
739 Print_List_Ref
(List_Id
(Val
));
741 elsif Val
in Elist_Range
then
742 Print_Elist_Ref
(Elist_Id
(Val
));
744 elsif Val
in Names_Range
then
745 Print_Name
(Name_Id
(Val
));
746 Write_Str
(" (Name_Id=");
747 Write_Int
(Int
(Val
));
750 elsif Val
in Strings_Range
then
751 Write_String_Table_Entry
(String_Id
(Val
));
752 Write_Str
(" (String_Id=");
753 Write_Int
(Int
(Val
));
756 elsif Val
in Uint_Range
then
757 UI_Write
(From_Union
(Val
), Format
);
758 Write_Str
(" (Uint = ");
759 Write_Int
(Int
(Val
));
762 elsif Val
in Ureal_Range
then
763 UR_Write
(From_Union
(Val
));
764 Write_Str
(" (Ureal = ");
765 Write_Int
(Int
(Val
));
769 Print_Str
("****** Incorrect value = ");
770 Print_Int
(Int
(Val
));
774 procedure Print_Field
777 N
: Node_Or_Entity_Id
;
778 FD
: Field_Descriptor
;
781 Printed
: Boolean := False;
783 procedure Print_Initial
;
784 -- Print the initial stuff that goes before the value
790 procedure Print_Initial
is
796 if Print_Low_Level_Info
then
798 Write_Int
(Int
(FD
.Offset
));
804 -- Start of processing for Print_Field
807 if Phase
/= Printing
then
814 Val
: constant Boolean := Get_Flag
(N
, FD
.Offset
);
822 when Node_Id_Field
=>
824 Val
: constant Node_Id
:= Get_Node_Id
(N
, FD
.Offset
);
826 if Present
(Val
) then
828 Print_Node_Ref
(Val
);
832 when List_Id_Field
=>
834 Val
: constant List_Id
:= Get_List_Id
(N
, FD
.Offset
);
836 if Present
(Val
) then
838 Print_List_Ref
(Val
);
842 when Elist_Id_Field
=>
844 Val
: constant Elist_Id
:= Get_Elist_Id
(N
, FD
.Offset
);
846 if Present
(Val
) then
848 Print_Elist_Ref
(Val
);
852 when Name_Id_Field
=>
854 Val
: constant Name_Id
:= Get_Name_Id
(N
, FD
.Offset
);
856 if Present
(Val
) then
859 Write_Str
(" (Name_Id=");
860 Write_Int
(Int
(Val
));
865 when String_Id_Field
=>
867 Val
: constant String_Id
:= Get_String_Id
(N
, FD
.Offset
);
869 if Val
/= No_String
then
871 Write_String_Table_Entry
(Val
);
872 Write_Str
(" (String_Id=");
873 Write_Int
(Int
(Val
));
880 Val
: constant Uint
:= Get_Uint
(N
, FD
.Offset
);
881 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
883 if Present
(Val
) then
885 UI_Write
(Val
, Format
);
886 Write_Str
(" (Uint = ");
887 Write_Int
(Cast
(Val
));
892 when Valid_Uint_Field | Unat_Field | Upos_Field
893 | Nonzero_Uint_Field
=>
895 Val
: constant Uint
:= Get_Valid_Uint
(N
, FD
.Offset
);
896 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
899 UI_Write
(Val
, Format
);
902 when Valid_Uint_Field
=> Write_Str
(" v");
903 when Unat_Field
=> Write_Str
(" n");
904 when Upos_Field
=> Write_Str
(" p");
905 when Nonzero_Uint_Field
=> Write_Str
(" nz");
906 when others => raise Program_Error
;
909 Write_Str
(" (Uint = ");
910 Write_Int
(Cast
(Val
));
916 Val
: constant Ureal
:= Get_Ureal
(N
, FD
.Offset
);
917 function Cast
is new Ada
.Unchecked_Conversion
(Ureal
, Int
);
919 if Val
/= No_Ureal
then
922 Write_Str
(" (Ureal = ");
923 Write_Int
(Cast
(Val
));
928 when Node_Kind_Type_Field
=>
930 Val
: constant Node_Kind
:= Get_Node_Kind_Type
(N
, FD
.Offset
);
933 Print_Str_Mixed_Case
(Node_Kind
'Image (Val
));
936 when Entity_Kind_Type_Field
=>
938 Val
: constant Entity_Kind
:=
939 Get_Entity_Kind_Type
(N
, FD
.Offset
);
942 Print_Str_Mixed_Case
(Entity_Kind
'Image (Val
));
945 when Union_Id_Field
=>
947 Val
: constant Union_Id
:= Get_Union_Id
(N
, FD
.Offset
);
949 if Val
/= Empty_List_Or_Node
then
952 if Val
in Node_Range
then
953 Print_Node_Ref
(Node_Id
(Val
));
955 elsif Val
in List_Range
then
956 Print_List_Ref
(List_Id
(Val
));
959 Print_Str
("<invalid union id>");
966 Print_Str
("<unknown ");
967 Print_Str
(Field_Kind
'Image (FD
.Kind
));
975 -- If an exception is raised while printing, we try to print some low-level
976 -- information that is useful for debugging.
982 Ada
.Unchecked_Conversion
(Field_Size_32_Bit
, Int
);
986 Write_Str
("exception raised in Print_Field -- int val = ");
989 case Field_Size
(FD
.Kind
) is
990 when 1 => Write_Int
(Int
(Get_1_Bit_Val
(N
, FD
.Offset
)));
991 when 2 => Write_Int
(Int
(Get_2_Bit_Val
(N
, FD
.Offset
)));
992 when 4 => Write_Int
(Int
(Get_4_Bit_Val
(N
, FD
.Offset
)));
993 when 8 => Write_Int
(Int
(Get_8_Bit_Val
(N
, FD
.Offset
)));
995 Write_Int
(Cast
(Get_32_Bit_Val
(N
, FD
.Offset
)));
999 Write_Str
(FD
.Kind
'Img);
1001 Write_Int
(Int
(Field_Size
(FD
.Kind
)));
1002 Write_Str
(" bits");
1007 Write_Str
("double exception raised in Print_Field");
1012 ----------------------
1013 -- Print_Node_Field --
1014 ----------------------
1016 procedure Print_Node_Field
1020 FD
: Field_Descriptor
;
1021 Format
: UI_Format
:= Auto
)
1023 pragma Assert
(FD
.Type_Only
= No_Type_Only
);
1024 -- Type_Only is for entities
1026 if not Field_Is_Initial_Zero
(N
, Field
) then
1027 Print_Field
(Prefix
, Image
(Field
), N
, FD
, Format
);
1029 end Print_Node_Field
;
1031 ------------------------
1032 -- Print_Entity_Field --
1033 ------------------------
1035 procedure Print_Entity_Field
1037 Field
: Entity_Field
;
1039 FD
: Field_Descriptor
;
1040 Format
: UI_Format
:= Auto
)
1042 NN
: constant Node_Id
:= Node_To_Fetch_From
(N
, Field
);
1044 if not Field_Is_Initial_Zero
(N
, Field
) then
1045 Print_Field
(Prefix
, Image
(Field
), NN
, FD
, Format
);
1047 end Print_Entity_Field
;
1053 procedure Print_Flag
(F
: Boolean) is
1058 Print_Str
("False");
1066 procedure Print_Init
is
1068 Printing_Descendants
:= True;
1071 pragma Assert
(not Serial_Numbers
.Present
(Hash_Table
));
1072 Hash_Table
:= Serial_Numbers
.Create
(512);
1079 procedure Print_Int
(I
: Int
) is
1081 if Phase
= Printing
then
1086 --------------------
1087 -- Print_List_Ref --
1088 --------------------
1090 procedure Print_List_Ref
(L
: List_Id
) is
1092 if Phase
/= Printing
then
1097 Write_Str
("<no list>");
1099 elsif Is_Empty_List
(L
) then
1100 Write_Str
("<empty list> (List_Id=");
1101 Write_Int
(Int
(L
));
1107 if Printing_Descendants
then
1109 Write_Int
(Serial_Number
(Int
(L
)));
1112 Write_Str
(" (List_Id=");
1113 Write_Int
(Int
(L
));
1118 ------------------------
1119 -- Print_List_Subtree --
1120 ------------------------
1122 procedure Print_List_Subtree
(L
: List_Id
) is
1126 Next_Serial_Number
:= 1;
1130 Next_Serial_Number
:= 1;
1135 end Print_List_Subtree
;
1141 procedure Print_Name
(N
: Name_Id
) is
1143 if Phase
= Printing
then
1144 Write_Name_For_Debug
(N
, Quote
=> """");
1152 procedure Print_Node
1154 Prefix_Str
: String;
1155 Prefix_Char
: Character)
1157 Prefix
: constant String := Prefix_Str
& Prefix_Char
;
1159 Sfile
: Source_File_Index
;
1162 if Phase
/= Printing
then
1166 -- If there is no such node, indicate that. Skip the rest, so we don't
1167 -- crash getting fields of the nonexistent node.
1169 if not Is_Valid_Node
(Union_Id
(N
)) then
1170 Print_Str
("No such node: ");
1171 Print_Int
(Int
(N
));
1176 -- Print header line
1178 Print_Str
(Prefix_Str
);
1179 Print_Node_Header
(N
);
1181 if Is_Rewrite_Substitution
(N
) then
1182 Print_Str
(Prefix_Str
);
1183 Print_Str
(" Rewritten: original node = ");
1184 Print_Node_Ref
(Original_Node
(N
));
1188 if Print_Low_Level_Info
then
1189 Print_Atree_Info
(N
);
1196 if not Is_List_Member
(N
) then
1197 Print_Str
(Prefix_Str
);
1198 Print_Str
(" Parent = ");
1199 Print_Node_Ref
(Parent
(N
));
1203 -- Print Sloc field if it is set
1205 if Sloc
(N
) /= No_Location
then
1207 Print_Str
("Sloc = ");
1209 if Sloc
(N
) = Standard_Location
then
1210 Print_Str
("Standard_Location");
1212 elsif Sloc
(N
) = Standard_ASCII_Location
then
1213 Print_Str
("Standard_ASCII_Location");
1216 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
1217 Print_Int
(Int
(Sloc
(N
) - Source_Text
(Sfile
)'First));
1219 Write_Location
(Sloc
(N
));
1225 -- Print Chars field if present
1227 if Nkind
(N
) in N_Has_Chars
then
1228 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1230 Print_Str
("Chars = initial zero");
1233 elsif Chars
(N
) /= No_Name
then
1235 Print_Str
("Chars = ");
1236 Print_Name
(Chars
(N
));
1237 Write_Str
(" (Name_Id=");
1238 Write_Int
(Int
(Chars
(N
)));
1244 -- Special field print operations for non-entity nodes
1246 if Nkind
(N
) not in N_Entity
then
1248 -- Deal with Left_Opnd and Right_Opnd fields
1250 if Nkind
(N
) in N_Op
1251 or else Nkind
(N
) in N_Short_Circuit
1252 or else Nkind
(N
) in N_Membership_Test
1254 -- Print Left_Opnd if present
1256 if Nkind
(N
) not in N_Unary_Op
then
1258 Print_Str
("Left_Opnd = ");
1259 Print_Node_Ref
(Left_Opnd
(N
));
1266 Print_Str
("Right_Opnd = ");
1267 Print_Node_Ref
(Right_Opnd
(N
));
1271 -- Deal with Entity_Or_Associated_Node. If N has both, then just
1272 -- print Entity; they are the same thing.
1274 if N
in N_Inclusive_Has_Entity
and then Present
(Entity
(N
)) then
1276 Print_Str
("Entity = ");
1277 Print_Node_Ref
(Entity
(N
));
1280 elsif N
in N_Has_Associated_Node
1281 and then Present
(Associated_Node
(N
))
1284 Print_Str
("Associated_Node = ");
1285 Print_Node_Ref
(Associated_Node
(N
));
1289 -- Print special fields if we have a subexpression
1291 if Nkind
(N
) in N_Subexpr
then
1293 if Assignment_OK
(N
) then
1295 Print_Str
("Assignment_OK = True");
1299 if Do_Range_Check
(N
) then
1301 Print_Str
("Do_Range_Check = True");
1305 if Has_Dynamic_Length_Check
(N
) then
1307 Print_Str
("Has_Dynamic_Length_Check = True");
1311 if Has_Aspects
(N
) then
1313 Print_Str
("Has_Aspects = True");
1317 if Is_Controlling_Actual
(N
) then
1319 Print_Str
("Is_Controlling_Actual = True");
1323 if Is_Overloaded
(N
) then
1325 Print_Str
("Is_Overloaded = True");
1329 if Is_Static_Expression
(N
) then
1331 Print_Str
("Is_Static_Expression = True");
1335 if Must_Not_Freeze
(N
) then
1337 Print_Str
("Must_Not_Freeze = True");
1341 if Paren_Count
(N
) /= 0 then
1343 Print_Str
("Paren_Count = ");
1344 Print_Int
(Int
(Paren_Count
(N
)));
1348 if Raises_Constraint_Error
(N
) then
1350 Print_Str
("Raises_Constraint_Error = True");
1356 -- Print Do_Overflow_Check field if present
1358 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1360 Print_Str
("Do_Overflow_Check = True");
1364 -- Print Etype field if present (printing of this field for entities
1365 -- is handled by the Print_Entity_Info procedure).
1367 if Nkind
(N
) in N_Has_Etype
and then Present
(Etype
(N
)) then
1369 Print_Str
("Etype = ");
1370 Print_Node_Ref
(Etype
(N
));
1376 Fields
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
1377 Should_Print
: constant Node_Field_Set
:=
1378 -- Set of fields that should be printed. False for fields that were
1379 -- already printed above, and for In_List, which we don't bother
1383 | F_Comes_From_Source
1386 | F_Is_Ignored_Ghost_Node
1388 | F_Link
-- Parent was printed
1392 | F_Entity_Or_Associated_Node
-- one of them was printed
1395 | F_Has_Dynamic_Length_Check
1397 | F_Is_Controlling_Actual
1399 | F_Is_Static_Expression
1401 | F_Small_Paren_Count
-- Paren_Count was printed
1402 | F_Raises_Constraint_Error
1403 | F_Do_Overflow_Check
1410 Fmt
: constant UI_Format
:=
1411 (if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
)
1416 -- Outer loop makes flags come out last
1418 for Print_Flags
in Boolean loop
1419 for Field_Index
in Fields
'Range loop
1421 FD
: Field_Descriptor
renames
1422 Field_Descriptors
(Fields
(Field_Index
));
1424 if Should_Print
(Fields
(Field_Index
))
1425 and then (FD
.Kind
= Flag_Field
) = Print_Flags
1427 -- Special case for End_Span, which also prints the
1430 if Fields
(Field_Index
) = F_End_Span
then
1435 (Prefix
, Fields
(Field_Index
), N
, FD
, Fmt
);
1443 -- Print aspects if present
1445 if Has_Aspects
(N
) then
1447 Print_Str
("Aspect_Specifications = ");
1448 Print_Field
(Union_Id
(Aspect_Specifications
(N
)));
1452 -- Print entity information for entities
1454 if Nkind
(N
) in N_Entity
then
1455 Print_Entity_Info
(N
, Prefix
);
1458 -- Print the SCIL node (if available)
1460 if Present
(Get_SCIL_Node
(N
)) then
1462 Print_Str
("SCIL_Node = ");
1463 Print_Node_Ref
(Get_SCIL_Node
(N
));
1468 ------------------------
1469 -- Print_Node_Briefly --
1470 ------------------------
1472 procedure Print_Node_Briefly
(N
: Node_Id
) is
1474 Printing_Descendants
:= False;
1476 Print_Node_Header
(N
);
1477 end Print_Node_Briefly
;
1479 -----------------------
1480 -- Print_Node_Header --
1481 -----------------------
1483 procedure Print_Node_Header
(N
: Node_Id
) is
1484 Enumerate
: Boolean := False;
1485 -- Flag set when enumerating multiple header flags
1487 procedure Print_Header_Flag
(Flag
: String);
1488 -- Output one of the flags that appears in a node header. The routine
1489 -- automatically handles enumeration of multiple flags.
1491 -----------------------
1492 -- Print_Header_Flag --
1493 -----------------------
1495 procedure Print_Header_Flag
(Flag
: String) is
1505 end Print_Header_Flag
;
1507 -- Start of processing for Print_Node_Header
1512 if not Is_Valid_Node
(Union_Id
(N
)) then
1513 Print_Str
(" (no such node)");
1520 if Comes_From_Source
(N
) then
1521 Print_Header_Flag
("source");
1524 if Analyzed
(N
) then
1525 Print_Header_Flag
("analyzed");
1528 if Error_Posted
(N
) then
1529 Print_Header_Flag
("posted");
1532 if Is_Ignored_Ghost_Node
(N
) then
1533 Print_Header_Flag
("ignored ghost");
1536 if Check_Actuals
(N
) then
1537 Print_Header_Flag
("check actuals");
1545 end Print_Node_Header
;
1547 ---------------------
1548 -- Print_Node_Kind --
1549 ---------------------
1551 procedure Print_Node_Kind
(N
: Node_Id
) is
1553 if Phase
= Printing
then
1554 Print_Str_Mixed_Case
(Node_Kind
'Image (Nkind
(N
)));
1556 end Print_Node_Kind
;
1558 --------------------
1559 -- Print_Node_Ref --
1560 --------------------
1562 procedure Print_Node_Ref
(N
: Node_Id
) is
1566 if Phase
/= Printing
then
1571 Write_Str
("<empty>");
1573 elsif N
= Error
then
1574 Write_Str
("<error>");
1577 if Printing_Descendants
then
1578 S
:= Serial_Number
(Int
(N
));
1588 Print_Node_Kind
(N
);
1590 if Nkind
(N
) in N_Has_Chars
then
1593 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1594 Print_Str
("Chars = initial zero");
1598 Print_Name
(Chars
(N
));
1602 -- If this is a discrete expression whose value is known, print that
1605 if Nkind
(N
) in N_Subexpr
1606 and then Compile_Time_Known_Value
(N
)
1607 and then Present
(Etype
(N
))
1608 and then Is_Discrete_Type
(Etype
(N
))
1610 if Is_Entity_Name
(N
) -- e.g. enumeration literal
1611 or else Nkind
(N
) in N_Integer_Literal
1612 | N_Character_Literal
1613 | N_Unchecked_Type_Conversion
1615 Print_Str
(" val = ");
1616 UI_Write
(Expr_Value
(N
));
1620 if Nkind
(N
) in N_Entity
then
1621 Write_Str
(" (Entity_Id=");
1623 Write_Str
(" (Node_Id=");
1626 Write_Int
(Int
(N
));
1628 if Sloc
(N
) <= Standard_Location
then
1637 ------------------------
1638 -- Print_Node_Subtree --
1639 ------------------------
1641 procedure Print_Node_Subtree
(N
: Node_Id
) is
1645 Next_Serial_Number
:= 1;
1647 Visit_Node
(N
, "", ' ');
1649 Next_Serial_Number
:= 1;
1651 Visit_Node
(N
, "", ' ');
1654 end Print_Node_Subtree
;
1660 procedure Print_Str
(S
: String) is
1662 if Phase
= Printing
then
1667 --------------------------
1668 -- Print_Str_Mixed_Case --
1669 --------------------------
1671 procedure Print_Str_Mixed_Case
(S
: String) is
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 procedure Tree_Dump
is
1814 procedure Underline
;
1815 -- Put underline under string we just printed
1817 procedure Underline
is
1818 Col
: constant Int
:= Column
;
1823 while Col
> Column
loop
1830 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1831 -- flags immediately, before starting the dump. This avoids generating two
1832 -- copies of the dump if an abort occurs after printing the dump, and more
1833 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1835 -- Note: unlike in the source print case (in Sprint), we do not output
1836 -- separate trees for each unit. Instead the -df debug switch causes the
1837 -- tree that is output from the main unit to trace references into other
1838 -- units (normally such references are not traced). Since all other units
1839 -- are linked to the main unit by at least one reference, this causes all
1840 -- tree nodes to be included in the output tree.
1843 if Debug_Flag_Y
then
1844 Debug_Flag_Y
:= False;
1846 Write_Str
("Tree created for Standard (spec) ");
1848 Print_Node_Subtree
(Standard_Package_Node
);
1852 if Debug_Flag_T
then
1853 Debug_Flag_T
:= False;
1856 Write_Str
("Tree created for ");
1857 Write_Unit_Name_For_Debug
(Unit_Name
(Main_Unit
));
1859 Print_Node_Subtree
(Cunit
(Main_Unit
));
1868 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1871 S
: constant Nat
:= Serial_Number
(Int
(E
));
1874 -- In marking phase, return if already marked, otherwise set next
1875 -- serial number in hash table for later reference.
1877 if Phase
= Marking
then
1879 return; -- already visited
1884 -- In printing phase, if already printed, then return, otherwise we
1885 -- are printing the next item, so increment the serial number.
1888 if S
< Next_Serial_Number
then
1889 return; -- already printed
1891 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1895 -- Now process the list (Print calls have no effect in marking phase)
1897 Print_Str
(Prefix_Str
);
1898 Print_Elist_Ref
(E
);
1901 if Is_Empty_Elmt_List
(E
) then
1902 Print_Str
(Prefix_Str
);
1903 Print_Str
("(Empty element list)");
1908 if Phase
= Printing
then
1909 M
:= First_Elmt
(E
);
1910 while Present
(M
) loop
1912 Print_Str
(Prefix_Str
);
1919 Print_Str
(Prefix_Str
);
1923 M
:= First_Elmt
(E
);
1924 while Present
(M
) loop
1925 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1935 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1937 S
: constant Nat
:= Serial_Number
(Int
(L
));
1940 -- In marking phase, return if already marked, otherwise set next
1941 -- serial number in hash table for later reference.
1943 if Phase
= Marking
then
1950 -- In printing phase, if already printed, then return, otherwise we
1951 -- are printing the next item, so increment the serial number.
1954 if S
< Next_Serial_Number
then
1955 return; -- already printed
1957 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1961 -- Now process the list (Print calls have no effect in marking phase)
1963 Print_Str
(Prefix_Str
);
1967 Print_Str
(Prefix_Str
);
1968 Print_Str
("|Parent = ");
1969 Print_Node_Ref
(Parent
(L
));
1975 Print_Str
(Prefix_Str
);
1976 Print_Str
("(Empty list)");
1981 Print_Str
(Prefix_Str
);
1985 while Next
(N
) /= Empty
loop
1986 Visit_Node
(N
, Prefix_Str
, '|');
1991 Visit_Node
(N
, Prefix_Str
, ' ');
1998 procedure Visit_Node
2000 Prefix_Str
: String;
2001 Prefix_Char
: Character)
2003 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
2004 -- Prefix string for printing referenced fields
2006 procedure Visit_Descendant
(D
: Union_Id
);
2007 -- This procedure tests the given value of one of the Fields referenced
2008 -- by the current node to determine whether to visit it recursively.
2009 -- The visited node will be indented using New_Prefix.
2011 ----------------------
2012 -- Visit_Descendant --
2013 ----------------------
2015 procedure Visit_Descendant
(D
: Union_Id
) is
2017 -- Case of descendant is a node
2019 if D
in Node_Range
then
2021 -- Don't bother about Empty or Error descendants
2023 if D
<= Union_Id
(Empty_Or_Error
) then
2028 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
2031 -- Descendants in one of the standardly compiled internal
2032 -- packages are normally ignored, unless the parent is also
2033 -- in such a package (happens when Standard itself is output)
2034 -- or if the -df switch is set which causes all links to be
2035 -- followed, even into package standard.
2037 if Sloc
(Nod
) <= Standard_Location
then
2038 if Sloc
(N
) > Standard_Location
2039 and then not Debug_Flag_F
2044 -- Don't bother about a descendant in a different unit than
2045 -- the node we came from unless the -df switch is set. Note
2046 -- that we know at this point that Sloc (D) > Standard_Location
2048 -- Note: the tests for No_Location here just make sure that we
2049 -- don't blow up on a node which is missing an Sloc value. This
2050 -- should not normally happen.
2053 if (Sloc
(N
) <= Standard_Location
2054 or else Sloc
(N
) = No_Location
2055 or else Sloc
(Nod
) = No_Location
2056 or else not In_Same_Source_Unit
(Nod
, N
))
2057 and then not Debug_Flag_F
2063 -- Don't bother visiting a source node that has a parent which
2064 -- is not the node we came from. We prefer to trace such nodes
2065 -- from their real parents. This causes the tree to be printed
2066 -- in a more coherent order, e.g. a defining identifier listed
2067 -- next to its corresponding declaration, instead of next to
2068 -- some semantic reference.
2070 -- This test is skipped for nodes in standard packages unless
2071 -- the -dy option is set (which outputs the tree for standard)
2073 -- Also, always follow pointers to Is_Itype entities,
2074 -- since we want to list these when they are first referenced.
2076 if Parent
(Nod
) /= Empty
2077 and then Comes_From_Source
(Nod
)
2078 and then Parent
(Nod
) /= N
2079 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
2084 -- If we successfully fall through all the above tests (which
2085 -- execute a return if the node is not to be visited), we can
2086 -- go ahead and visit the node.
2088 Visit_Node
(Nod
, New_Prefix
, ' ');
2091 -- Case of descendant is a list
2093 elsif D
in List_Range
then
2095 -- Don't bother with a missing list, empty list or error list
2097 pragma Assert
(D
/= Union_Id
(No_List
));
2098 -- Because No_List = Empty, which is in Node_Range above
2100 if D
= Union_Id
(Error_List
)
2101 or else Is_Empty_List
(List_Id
(D
))
2105 -- Otherwise we can visit the list. Note that we don't bother to
2106 -- do the parent test that we did for the node case, because it
2107 -- just does not happen that lists are referenced more than one
2108 -- place in the tree. We aren't counting on this being the case
2109 -- to generate valid output, it is just that we don't need in
2110 -- practice to worry about listing the list at a place that is
2114 Visit_List
(List_Id
(D
), New_Prefix
);
2117 -- Case of descendant is an element list
2119 elsif D
in Elist_Range
then
2121 -- Don't bother with a missing list, or an empty list
2123 if D
= Union_Id
(No_Elist
)
2124 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
2128 -- Otherwise, visit the referenced element list
2131 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
2135 raise Program_Error
;
2137 end Visit_Descendant
;
2139 -- Start of processing for Visit_Node
2146 -- Set fatal error node in case we get a blow up during the trace
2148 Current_Error_Node
:= N
;
2150 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
2151 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
2152 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
2154 -- In the marking phase, all we do is to set the serial number
2156 if Phase
= Marking
then
2157 if Serial_Number
(Int
(N
)) /= 0 then
2158 return; -- already visited
2163 -- In the printing phase, we print the node
2166 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
2168 -- Here we have already visited the node, but if it is in a list,
2169 -- we still want to print the reference, so that it is clear that
2170 -- it belongs to the list.
2172 if Is_List_Member
(N
) then
2173 Print_Str
(Prefix_Str
);
2176 Print_Str
(Prefix_Str
);
2177 Print_Char
(Prefix_Char
);
2178 Print_Str
("(already output)");
2180 Print_Str
(Prefix_Str
);
2181 Print_Char
(Prefix_Char
);
2188 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
2189 Print_Str
(Prefix_Str
);
2190 Print_Char
(Prefix_Char
);
2192 Next_Serial_Number
:= Next_Serial_Number
+ 1;
2196 -- Visit all descendants of this node
2199 A
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
2201 for Field_Index
in A
'Range loop
2203 F
: constant Node_Field
:= A
(Field_Index
);
2204 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2206 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2207 -- For all other kinds of descendants (strings, names, uints
2208 -- etc), there is nothing to visit (the contents of the
2209 -- field will be printed when we print the containing node,
2210 -- but what concerns us now is looking for descendants in
2213 and then F
/= F_Next_Entity
-- See below for why we skip this
2215 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2221 if Has_Aspects
(N
) then
2222 Visit_Descendant
(Union_Id
(Aspect_Specifications
(N
)));
2225 if Nkind
(N
) in N_Entity
then
2227 A
: Entity_Field_Array
renames Entity_Field_Table
(Ekind
(N
)).all;
2229 for Field_Index
in A
'Range loop
2231 F
: constant Entity_Field
:= A
(Field_Index
);
2232 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2234 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2236 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2242 -- Now an interesting special case. Normally parents are always
2243 -- printed since we traverse the tree in a downwards direction.
2244 -- However, there is an exception to this rule, which is the
2245 -- case where a parent is constructed by the compiler and is not
2246 -- referenced elsewhere in the tree. The following catches this case.
2248 if not Comes_From_Source
(N
) then
2249 Visit_Descendant
(Union_Id
(Parent
(N
)));
2252 -- You may be wondering why we omitted Next_Entity above. The answer
2253 -- is that we want to treat it rather specially. Why? Because a
2254 -- Next_Entity link does not correspond to a level deeper in the
2255 -- tree, and we do not want the tree to march off to the right of the
2256 -- page due to bogus indentations coming from this effect.
2258 -- To prevent this, what we do is to control references via
2259 -- Next_Entity only from the first entity on a given scope chain,
2260 -- and we keep them all at the same level. Of course if an entity
2261 -- has already been referenced it is not printed.
2263 if Present
(Next_Entity
(N
))
2264 and then Present
(Scope
(N
))
2265 and then First_Entity
(Scope
(N
)) = N
2272 while Present
(Nod
) loop
2274 Visit_Descendant
(Union_Id
(Nod
));