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
193 N
: Node_Or_Entity_Id
;
194 FD
: Field_Descriptor
;
196 -- Print representation of Field value (name, tree, string, uint, charcode)
197 -- The format parameter controls the format of printing in the case of an
198 -- integer value (see UI_Write for details).
200 procedure Print_Node_Field
204 FD
: Field_Descriptor
;
205 Format
: UI_Format
:= Auto
);
207 procedure Print_Entity_Field
209 Field
: Entity_Field
;
211 FD
: Field_Descriptor
;
212 Format
: UI_Format
:= Auto
);
214 procedure Print_Flag
(F
: Boolean);
215 -- Print True or False
220 Prefix_Char
: Character);
221 -- This is the internal routine used to print a single node. Each line of
222 -- output is preceded by Prefix_Str (which is used to set the indentation
223 -- level and the bars used to link list elements). In addition, for lines
224 -- other than the first, an additional character Prefix_Char is output.
226 function Serial_Number
(Id
: Int
) return Nat
;
227 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
228 -- serial number, or zero if no serial number has yet been assigned.
230 procedure Set_Serial_Number
;
231 -- Can be called only immediately following a call to Serial_Number that
232 -- returned a value of zero. Causes the value of Next_Serial_Number to be
233 -- placed in the hash table (corresponding to the Id argument used in the
234 -- Serial_Number call), and increments Next_Serial_Number.
239 Prefix_Char
: Character);
240 -- Called to process a single node in the case where descendants are to
241 -- be printed before every line, and Prefix_Char added to all lines
242 -- except the header line for the node.
244 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
245 -- Visit_List is called to process a list in the case where descendants
246 -- are to be printed. Prefix_Str is to be added to all printed lines.
248 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
249 -- Visit_Elist is called to process an element list in the case where
250 -- descendants are to be printed. Prefix_Str is to be added to all
257 function Hash
(Key
: Int
) return GNAT
.Bucket_Range_Type
is
258 function Cast
is new Ada
.Unchecked_Conversion
259 (Source
=> Int
, Target
=> GNAT
.Bucket_Range_Type
);
268 function Image
(F
: Node_Or_Entity_Field
) return String is
271 -- We special case the following; otherwise the compiler will use
272 -- the usual Mixed_Case convention.
274 when F_Assignment_OK
=>
275 return "Assignment_OK";
276 when F_Backwards_OK
=>
277 return "Backwards_OK";
278 when F_Conversion_OK
=>
279 return "Conversion_OK";
280 when F_Forwards_OK
=>
281 return "Forwards_OK";
282 when F_Has_SP_Choice
=>
283 return "Has_SP_Choice";
284 when F_Is_Elaboration_Checks_OK_Node
=>
285 return "Is_Elaboration_Checks_OK_Node";
286 when F_Is_Elaboration_Warnings_OK_Node
=>
287 return "Is_Elaboration_Warnings_OK_Node";
288 when F_Is_Known_Guaranteed_ABE
=>
289 return "Is_Known_Guaranteed_ABE";
290 when F_Is_SPARK_Mode_On_Node
=>
291 return "Is_SPARK_Mode_On_Node";
292 when F_Local_Raise_Not_OK
=>
293 return "Local_Raise_Not_OK";
294 when F_SCIL_Controlling_Tag
=>
295 return "SCIL_Controlling_Tag";
296 when F_SCIL_Entity
=>
297 return "SCIL_Entity";
298 when F_SCIL_Tag_Value
=>
299 return "SCIL_Tag_Value";
300 when F_SCIL_Target_Prim
=>
301 return "SCIL_Target_Prim";
302 when F_Shift_Count_OK
=>
303 return "Shift_Count_OK";
309 when F_BIP_Initialization_Call
=>
310 return "BIP_Initialization_Call";
311 when F_Body_Needed_For_SAL
=>
312 return "Body_Needed_For_SAL";
313 when F_CR_Discriminant
=>
314 return "CR_Discriminant";
315 when F_DT_Entry_Count
=>
316 return "DT_Entry_Count";
317 when F_DT_Offset_To_Top_Func
=>
318 return "DT_Offset_To_Top_Func";
319 when F_DT_Position
=>
320 return "DT_Position";
323 when F_Has_Inherited_DIC
=>
324 return "Has_Inherited_DIC";
325 when F_Has_Own_DIC
=>
326 return "Has_Own_DIC";
329 when F_Ignore_SPARK_Mode_Pragmas
=>
330 return "Ignore_SPARK_Mode_Pragmas";
331 when F_Is_CPP_Class
=>
332 return "Is_CPP_Class";
333 when F_Is_CUDA_Kernel
=>
334 return "Is_CUDA_Kernel";
335 when F_Is_DIC_Procedure
=>
336 return "Is_DIC_Procedure";
337 when F_Is_Discrim_SO_Function
=>
338 return "Is_Discrim_SO_Function";
339 when F_Is_Elaboration_Checks_OK_Id
=>
340 return "Is_Elaboration_Checks_OK_Id";
341 when F_Is_Elaboration_Warnings_OK_Id
=>
342 return "Is_Elaboration_Warnings_OK_Id";
343 when F_Is_RACW_Stub_Type
=>
344 return "Is_RACW_Stub_Type";
345 when F_LSP_Subprogram
=>
346 return "LSP_Subprogram";
347 when F_OK_To_Rename
=>
348 return "OK_To_Rename";
349 when F_Referenced_As_LHS
=>
350 return "Referenced_As_LHS";
353 when F_SPARK_Aux_Pragma
=>
354 return "SPARK_Aux_Pragma";
355 when F_SPARK_Aux_Pragma_Inherited
=>
356 return "SPARK_Aux_Pragma_Inherited";
357 when F_SPARK_Pragma
=>
358 return "SPARK_Pragma";
359 when F_SPARK_Pragma_Inherited
=>
360 return "SPARK_Pragma_Inherited";
361 when F_SSO_Set_High_By_Default
=>
362 return "SSO_Set_High_By_Default";
363 when F_SSO_Set_Low_By_Default
=>
364 return "SSO_Set_Low_By_Default";
368 Result
: String := F
'Img;
371 return Result
(3 .. Result
'Last); -- Remove "F_"
380 function p
(N
: Union_Id
) return Node_Or_Entity_Id
is
383 when List_Low_Bound
.. List_High_Bound
- 1 =>
384 return Nlists
.Parent
(List_Id
(N
));
387 return Parent
(Node_Or_Entity_Id
(N
));
391 Write_Str
(" is not a Node_Id or List_Id value");
401 function par
(N
: Union_Id
) return Node_Or_Entity_Id
renames p
;
403 procedure ppar
(N
: Union_Id
) is
405 if N
/= Empty_List_Or_Node
then
407 ppar
(Union_Id
(p
(N
)));
415 procedure pe
(N
: Union_Id
) renames pn
;
421 procedure pl
(L
: Int
) is
431 -- This is the case where we transform e.g. +36 to -99999936
435 Lid
:= -(99999990 + L
);
437 Lid
:= -(99999900 + L
);
439 Lid
:= -(99999000 + L
);
441 Lid
:= -(99990000 + L
);
442 elsif L
<= 99999 then
443 Lid
:= -(99900000 + L
);
444 elsif L
<= 999999 then
445 Lid
:= -(99000000 + L
);
446 elsif L
<= 9999999 then
447 Lid
:= -(90000000 + L
);
453 -- Now output the list
455 Print_Tree_List
(List_Id
(Lid
));
463 procedure pn
(N
: Union_Id
) is
469 when List_Low_Bound
.. List_High_Bound
- 1 =>
472 Print_Tree_Node
(Node_Id
(N
));
474 Print_Tree_Elist
(Elist_Id
(N
));
477 Id
: constant Elmt_Id
:= Elmt_Id
(N
);
480 Write_Str
("No_Elmt");
483 Write_Str
("Elmt_Id --> ");
484 Print_Tree_Node
(Node
(Id
));
488 Namet
.wn
(Name_Id
(N
));
489 when Strings_Range
=>
490 Write_String_Table_Entry
(String_Id
(N
));
492 Uintp
.pid
(From_Union
(N
));
494 Urealp
.pr
(From_Union
(N
));
496 Write_Str
("Invalid Union_Id: ");
508 procedure pp
(N
: Union_Id
) renames pn
;
514 procedure ppp
(N
: Union_Id
) renames pt
;
520 procedure Print_Char
(C
: Character) is
522 if Phase
= Printing
then
527 ---------------------
528 -- Print_Elist_Ref --
529 ---------------------
531 procedure Print_Elist_Ref
(E
: Elist_Id
) is
533 if Phase
/= Printing
then
538 Write_Str
("<no elist>");
540 elsif Is_Empty_Elmt_List
(E
) then
541 Write_Str
("Empty elist, (Elist_Id=");
546 Write_Str
("(Elist_Id=");
550 if Printing_Descendants
then
552 Write_Int
(Serial_Number
(Int
(E
)));
557 -------------------------
558 -- Print_Elist_Subtree --
559 -------------------------
561 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
565 Next_Serial_Number
:= 1;
569 Next_Serial_Number
:= 1;
574 end Print_Elist_Subtree
;
580 procedure Print_End_Span
(N
: Node_Id
) is
581 Val
: constant Uint
:= End_Span
(N
);
585 Write_Str
(" (Uint = ");
586 Write_Str
(UI_Image
(Val
));
589 if Present
(Val
) then
590 Write_Location
(End_Location
(N
));
594 -----------------------
595 -- Print_Entity_Info --
596 -----------------------
598 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
601 Print_Str
("Ekind = ");
602 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
606 Print_Str
("Etype = ");
607 Print_Node_Ref
(Etype
(Ent
));
610 if Convention
(Ent
) /= Convention_Ada
then
612 Print_Str
("Convention = ");
614 -- Print convention name skipping the Convention_ at the start
617 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
620 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
626 Fields
: Entity_Field_Array
renames
627 Entity_Field_Table
(Ekind
(Ent
)).all;
628 Should_Print
: constant Entity_Field_Set
:=
629 -- Set of fields that should be printed. False for fields that were
630 -- already printed above.
632 | F_Basic_Convention
=> False, -- Convention was printed
635 -- Outer loop makes flags come out last
637 for Print_Flags
in Boolean loop
638 for Field_Index
in Fields
'Range loop
640 FD
: Field_Descriptor
renames
641 Field_Descriptors
(Fields
(Field_Index
));
643 if Should_Print
(Fields
(Field_Index
))
644 and then (FD
.Kind
= Flag_Field
) = Print_Flags
647 (Prefix
, Fields
(Field_Index
), Ent
, FD
);
653 end Print_Entity_Info
;
659 procedure Print_Eol
is
661 if Phase
= Printing
then
670 -- Instantiations of low-level getters and setters that take offsets
671 -- in units of the size of the field.
673 use Atree
.Atree_Private_Part
;
675 function Get_Flag
is new Get_1_Bit_Field
676 (Boolean) with Inline
;
678 function Get_Node_Id
is new Get_32_Bit_Field
679 (Node_Id
) with Inline
;
681 function Get_List_Id
is new Get_32_Bit_Field
682 (List_Id
) with Inline
;
684 function Get_Elist_Id
is new Get_32_Bit_Field_With_Default
685 (Elist_Id
, No_Elist
) with Inline
;
687 function Get_Name_Id
is new Get_32_Bit_Field
688 (Name_Id
) with Inline
;
690 function Get_String_Id
is new Get_32_Bit_Field
691 (String_Id
) with Inline
;
693 function Get_Uint
is new Get_32_Bit_Field_With_Default
694 (Uint
, Uint_0
) with Inline
;
696 function Get_Valid_Uint
is new Get_32_Bit_Field
698 -- Used for both Valid_Uint and other subtypes of Uint. Note that we don't
699 -- instantiate Get_Valid_32_Bit_Field; we don't want to blow up if the
702 function Get_Ureal
is new Get_32_Bit_Field
705 function Get_Node_Kind_Type
is new Get_8_Bit_Field
706 (Node_Kind
) with Inline
;
708 function Get_Entity_Kind_Type
is new Get_8_Bit_Field
709 (Entity_Kind
) with Inline
;
711 function Get_Source_Ptr
is new Get_32_Bit_Field
712 (Source_Ptr
) with Inline
, Unreferenced
;
714 function Get_Small_Paren_Count_Type
is new Get_2_Bit_Field
715 (Small_Paren_Count_Type
) with Inline
, Unreferenced
;
717 function Get_Union_Id
is new Get_32_Bit_Field
718 (Union_Id
) with Inline
;
720 function Get_Convention_Id
is new Get_8_Bit_Field
721 (Convention_Id
) with Inline
, Unreferenced
;
723 function Get_Mechanism_Type
is new Get_32_Bit_Field
724 (Mechanism_Type
) with Inline
, Unreferenced
;
726 procedure Print_Field
729 N
: Node_Or_Entity_Id
;
730 FD
: Field_Descriptor
;
733 Printed
: Boolean := False;
735 procedure Print_Initial
;
736 -- Print the initial stuff that goes before the value
742 procedure Print_Initial
is
748 if Print_Low_Level_Info
then
750 Write_Int
(Int
(FD
.Offset
));
756 -- Start of processing for Print_Field
759 if Phase
/= Printing
then
766 Val
: constant Boolean := Get_Flag
(N
, FD
.Offset
);
774 when Node_Id_Field
=>
776 Val
: constant Node_Id
:= Get_Node_Id
(N
, FD
.Offset
);
778 if Present
(Val
) then
780 Print_Node_Ref
(Val
);
784 when List_Id_Field
=>
786 Val
: constant List_Id
:= Get_List_Id
(N
, FD
.Offset
);
788 if Present
(Val
) then
790 Print_List_Ref
(Val
);
794 when Elist_Id_Field
=>
796 Val
: constant Elist_Id
:= Get_Elist_Id
(N
, FD
.Offset
);
798 if Present
(Val
) then
800 Print_Elist_Ref
(Val
);
804 when Name_Id_Field
=>
806 Val
: constant Name_Id
:= Get_Name_Id
(N
, FD
.Offset
);
808 if Present
(Val
) then
811 Write_Str
(" (Name_Id=");
812 Write_Int
(Int
(Val
));
817 when String_Id_Field
=>
819 Val
: constant String_Id
:= Get_String_Id
(N
, FD
.Offset
);
821 if Val
/= No_String
then
823 Write_String_Table_Entry
(Val
);
824 Write_Str
(" (String_Id=");
825 Write_Int
(Int
(Val
));
832 Val
: constant Uint
:= Get_Uint
(N
, FD
.Offset
);
833 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
835 if Present
(Val
) then
837 UI_Write
(Val
, Format
);
838 Write_Str
(" (Uint = ");
839 Write_Int
(Cast
(Val
));
844 when Valid_Uint_Field | Unat_Field | Upos_Field
845 | Nonzero_Uint_Field
=>
847 Val
: constant Uint
:= Get_Valid_Uint
(N
, FD
.Offset
);
848 function Cast
is new Ada
.Unchecked_Conversion
(Uint
, Int
);
851 UI_Write
(Val
, Format
);
854 when Valid_Uint_Field
=> Write_Str
(" v");
855 when Unat_Field
=> Write_Str
(" n");
856 when Upos_Field
=> Write_Str
(" p");
857 when Nonzero_Uint_Field
=> Write_Str
(" nz");
858 when others => raise Program_Error
;
861 Write_Str
(" (Uint = ");
862 Write_Int
(Cast
(Val
));
868 Val
: constant Ureal
:= Get_Ureal
(N
, FD
.Offset
);
869 function Cast
is new Ada
.Unchecked_Conversion
(Ureal
, Int
);
871 if Val
/= No_Ureal
then
874 Write_Str
(" (Ureal = ");
875 Write_Int
(Cast
(Val
));
880 when Node_Kind_Type_Field
=>
882 Val
: constant Node_Kind
:= Get_Node_Kind_Type
(N
, FD
.Offset
);
885 Print_Str_Mixed_Case
(Node_Kind
'Image (Val
));
888 when Entity_Kind_Type_Field
=>
890 Val
: constant Entity_Kind
:=
891 Get_Entity_Kind_Type
(N
, FD
.Offset
);
894 Print_Str_Mixed_Case
(Entity_Kind
'Image (Val
));
897 when Union_Id_Field
=>
899 Val
: constant Union_Id
:= Get_Union_Id
(N
, FD
.Offset
);
901 if Val
/= Empty_List_Or_Node
then
904 if Val
in Node_Range
then
905 Print_Node_Ref
(Node_Id
(Val
));
907 elsif Val
in List_Range
then
908 Print_List_Ref
(List_Id
(Val
));
911 Print_Str
("<invalid union id>");
918 Print_Str
("<unknown ");
919 Print_Str
(Field_Kind
'Image (FD
.Kind
));
927 -- If an exception is raised while printing, we try to print some low-level
928 -- information that is useful for debugging.
934 Ada
.Unchecked_Conversion
(Field_Size_32_Bit
, Int
);
938 Write_Str
("exception raised in Print_Field -- int val = ");
941 case Field_Size
(FD
.Kind
) is
942 when 1 => Write_Int
(Int
(Get_1_Bit_Val
(N
, FD
.Offset
)));
943 when 2 => Write_Int
(Int
(Get_2_Bit_Val
(N
, FD
.Offset
)));
944 when 4 => Write_Int
(Int
(Get_4_Bit_Val
(N
, FD
.Offset
)));
945 when 8 => Write_Int
(Int
(Get_8_Bit_Val
(N
, FD
.Offset
)));
947 Write_Int
(Cast
(Get_32_Bit_Val
(N
, FD
.Offset
)));
951 Write_Str
(FD
.Kind
'Img);
953 Write_Int
(Int
(Field_Size
(FD
.Kind
)));
959 Write_Str
("double exception raised in Print_Field");
964 ----------------------
965 -- Print_Node_Field --
966 ----------------------
968 procedure Print_Node_Field
972 FD
: Field_Descriptor
;
973 Format
: UI_Format
:= Auto
)
975 pragma Assert
(FD
.Type_Only
= No_Type_Only
);
976 -- Type_Only is for entities
978 if not Field_Is_Initial_Zero
(N
, Field
) then
979 Print_Field
(Prefix
, Image
(Field
), N
, FD
, Format
);
981 end Print_Node_Field
;
983 ------------------------
984 -- Print_Entity_Field --
985 ------------------------
987 procedure Print_Entity_Field
989 Field
: Entity_Field
;
991 FD
: Field_Descriptor
;
992 Format
: UI_Format
:= Auto
)
994 NN
: constant Node_Id
:= Node_To_Fetch_From
(N
, Field
);
996 if not Field_Is_Initial_Zero
(N
, Field
) then
997 Print_Field
(Prefix
, Image
(Field
), NN
, FD
, Format
);
999 end Print_Entity_Field
;
1005 procedure Print_Flag
(F
: Boolean) is
1010 Print_Str
("False");
1018 procedure Print_Init
is
1020 Printing_Descendants
:= True;
1023 pragma Assert
(not Serial_Numbers
.Present
(Hash_Table
));
1024 Hash_Table
:= Serial_Numbers
.Create
(512);
1031 procedure Print_Int
(I
: Int
) is
1033 if Phase
= Printing
then
1038 --------------------
1039 -- Print_List_Ref --
1040 --------------------
1042 procedure Print_List_Ref
(L
: List_Id
) is
1044 if Phase
/= Printing
then
1049 Write_Str
("<no list>");
1051 elsif Is_Empty_List
(L
) then
1052 Write_Str
("<empty list> (List_Id=");
1053 Write_Int
(Int
(L
));
1059 if Printing_Descendants
then
1061 Write_Int
(Serial_Number
(Int
(L
)));
1064 Write_Str
(" (List_Id=");
1065 Write_Int
(Int
(L
));
1070 ------------------------
1071 -- Print_List_Subtree --
1072 ------------------------
1074 procedure Print_List_Subtree
(L
: List_Id
) is
1078 Next_Serial_Number
:= 1;
1082 Next_Serial_Number
:= 1;
1087 end Print_List_Subtree
;
1093 procedure Print_Name
(N
: Name_Id
) is
1095 if Phase
= Printing
then
1096 Write_Name_For_Debug
(N
, Quote
=> """");
1104 procedure Print_Node
1106 Prefix_Str
: String;
1107 Prefix_Char
: Character)
1109 Prefix
: constant String := Prefix_Str
& Prefix_Char
;
1111 Sfile
: Source_File_Index
;
1114 if Phase
/= Printing
then
1118 -- If there is no such node, indicate that. Skip the rest, so we don't
1119 -- crash getting fields of the nonexistent node.
1121 if not Is_Valid_Node
(Union_Id
(N
)) then
1122 Print_Str
("No such node: ");
1123 Print_Int
(Int
(N
));
1128 -- Print header line
1130 Print_Str
(Prefix_Str
);
1131 Print_Node_Header
(N
);
1133 if Is_Rewrite_Substitution
(N
) then
1134 Print_Str
(Prefix_Str
);
1135 Print_Str
(" Rewritten: original node = ");
1136 Print_Node_Ref
(Original_Node
(N
));
1140 if Print_Low_Level_Info
then
1141 Print_Atree_Info
(N
);
1148 if not Is_List_Member
(N
) then
1149 Print_Str
(Prefix_Str
);
1150 Print_Str
(" Parent = ");
1151 Print_Node_Ref
(Parent
(N
));
1155 -- Print Sloc field if it is set
1157 if Sloc
(N
) /= No_Location
then
1159 Print_Str
("Sloc = ");
1161 if Sloc
(N
) = Standard_Location
then
1162 Print_Str
("Standard_Location");
1164 elsif Sloc
(N
) = Standard_ASCII_Location
then
1165 Print_Str
("Standard_ASCII_Location");
1168 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
1169 Print_Int
(Int
(Sloc
(N
) - Source_Text
(Sfile
)'First));
1171 Write_Location
(Sloc
(N
));
1177 -- Print Chars field if present
1179 if Nkind
(N
) in N_Has_Chars
then
1180 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1182 Print_Str
("Chars = initial zero");
1185 elsif Chars
(N
) /= No_Name
then
1187 Print_Str
("Chars = ");
1188 Print_Name
(Chars
(N
));
1189 Write_Str
(" (Name_Id=");
1190 Write_Int
(Int
(Chars
(N
)));
1196 -- Special field print operations for non-entity nodes
1198 if Nkind
(N
) not in N_Entity
then
1200 -- Deal with Left_Opnd and Right_Opnd fields
1202 if Nkind
(N
) in N_Op
1203 or else Nkind
(N
) in N_Short_Circuit
1204 or else Nkind
(N
) in N_Membership_Test
1206 -- Print Left_Opnd if present
1208 if Nkind
(N
) not in N_Unary_Op
then
1210 Print_Str
("Left_Opnd = ");
1211 Print_Node_Ref
(Left_Opnd
(N
));
1218 Print_Str
("Right_Opnd = ");
1219 Print_Node_Ref
(Right_Opnd
(N
));
1223 -- Deal with Entity_Or_Associated_Node. If N has both, then just
1224 -- print Entity; they are the same thing.
1226 if N
in N_Inclusive_Has_Entity
and then Present
(Entity
(N
)) then
1228 Print_Str
("Entity = ");
1229 Print_Node_Ref
(Entity
(N
));
1232 elsif N
in N_Has_Associated_Node
1233 and then Present
(Associated_Node
(N
))
1236 Print_Str
("Associated_Node = ");
1237 Print_Node_Ref
(Associated_Node
(N
));
1241 -- Print special fields if we have a subexpression
1243 if Nkind
(N
) in N_Subexpr
then
1245 if Assignment_OK
(N
) then
1247 Print_Str
("Assignment_OK = True");
1251 if Do_Range_Check
(N
) then
1253 Print_Str
("Do_Range_Check = True");
1257 if Has_Dynamic_Length_Check
(N
) then
1259 Print_Str
("Has_Dynamic_Length_Check = True");
1263 if Has_Aspects
(N
) then
1265 Print_Str
("Has_Aspects = True");
1269 if Is_Controlling_Actual
(N
) then
1271 Print_Str
("Is_Controlling_Actual = True");
1275 if Is_Overloaded
(N
) then
1277 Print_Str
("Is_Overloaded = True");
1281 if Is_Static_Expression
(N
) then
1283 Print_Str
("Is_Static_Expression = True");
1287 if Must_Not_Freeze
(N
) then
1289 Print_Str
("Must_Not_Freeze = True");
1293 if Paren_Count
(N
) /= 0 then
1295 Print_Str
("Paren_Count = ");
1296 Print_Int
(Int
(Paren_Count
(N
)));
1300 if Raises_Constraint_Error
(N
) then
1302 Print_Str
("Raises_Constraint_Error = True");
1308 -- Print Do_Overflow_Check field if present
1310 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1312 Print_Str
("Do_Overflow_Check = True");
1316 -- Print Etype field if present (printing of this field for entities
1317 -- is handled by the Print_Entity_Info procedure).
1319 if Nkind
(N
) in N_Has_Etype
and then Present
(Etype
(N
)) then
1321 Print_Str
("Etype = ");
1322 Print_Node_Ref
(Etype
(N
));
1328 Fields
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
1329 Should_Print
: constant Node_Field_Set
:=
1330 -- Set of fields that should be printed. False for fields that were
1331 -- already printed above, and for In_List, which we don't bother
1335 | F_Comes_From_Source
1338 | F_Is_Ignored_Ghost_Node
1340 | F_Link
-- Parent was printed
1344 | F_Entity_Or_Associated_Node
-- one of them was printed
1347 | F_Has_Dynamic_Length_Check
1348 | F_Is_Controlling_Actual
1350 | F_Is_Static_Expression
1352 | F_Small_Paren_Count
-- Paren_Count was printed
1353 | F_Raises_Constraint_Error
1354 | F_Do_Overflow_Check
1361 Fmt
: constant UI_Format
:=
1362 (if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
)
1367 -- Outer loop makes flags come out last
1369 for Print_Flags
in Boolean loop
1370 for Field_Index
in Fields
'Range loop
1372 FD
: Field_Descriptor
renames
1373 Field_Descriptors
(Fields
(Field_Index
));
1375 if Should_Print
(Fields
(Field_Index
))
1376 and then (FD
.Kind
= Flag_Field
) = Print_Flags
1378 -- Special case for End_Span, which also prints the
1381 if Fields
(Field_Index
) = F_End_Span
then
1386 (Prefix
, Fields
(Field_Index
), N
, FD
, Fmt
);
1394 -- Print entity information for entities
1396 if Nkind
(N
) in N_Entity
then
1397 Print_Entity_Info
(N
, Prefix
);
1400 -- Print the SCIL node (if available)
1402 if Present
(Get_SCIL_Node
(N
)) then
1404 Print_Str
("SCIL_Node = ");
1405 Print_Node_Ref
(Get_SCIL_Node
(N
));
1410 ------------------------
1411 -- Print_Node_Briefly --
1412 ------------------------
1414 procedure Print_Node_Briefly
(N
: Node_Id
) is
1416 Printing_Descendants
:= False;
1418 Print_Node_Header
(N
);
1419 end Print_Node_Briefly
;
1421 -----------------------
1422 -- Print_Node_Header --
1423 -----------------------
1425 procedure Print_Node_Header
(N
: Node_Id
) is
1426 Enumerate
: Boolean := False;
1427 -- Flag set when enumerating multiple header flags
1429 procedure Print_Header_Flag
(Flag
: String);
1430 -- Output one of the flags that appears in a node header. The routine
1431 -- automatically handles enumeration of multiple flags.
1433 -----------------------
1434 -- Print_Header_Flag --
1435 -----------------------
1437 procedure Print_Header_Flag
(Flag
: String) is
1447 end Print_Header_Flag
;
1449 -- Start of processing for Print_Node_Header
1454 if not Is_Valid_Node
(Union_Id
(N
)) then
1455 Print_Str
(" (no such node)");
1462 if Comes_From_Source
(N
) then
1463 Print_Header_Flag
("source");
1466 if Analyzed
(N
) then
1467 Print_Header_Flag
("analyzed");
1470 if Error_Posted
(N
) then
1471 Print_Header_Flag
("posted");
1474 if Is_Ignored_Ghost_Node
(N
) then
1475 Print_Header_Flag
("ignored ghost");
1478 if Check_Actuals
(N
) then
1479 Print_Header_Flag
("check actuals");
1487 end Print_Node_Header
;
1489 ---------------------
1490 -- Print_Node_Kind --
1491 ---------------------
1493 procedure Print_Node_Kind
(N
: Node_Id
) is
1495 if Phase
= Printing
then
1496 Print_Str_Mixed_Case
(Node_Kind
'Image (Nkind
(N
)));
1498 end Print_Node_Kind
;
1500 --------------------
1501 -- Print_Node_Ref --
1502 --------------------
1504 procedure Print_Node_Ref
(N
: Node_Id
) is
1508 if Phase
/= Printing
then
1513 Write_Str
("<empty>");
1515 elsif N
= Error
then
1516 Write_Str
("<error>");
1519 if Printing_Descendants
then
1520 S
:= Serial_Number
(Int
(N
));
1530 Print_Node_Kind
(N
);
1532 if Nkind
(N
) in N_Has_Chars
then
1535 if Field_Is_Initial_Zero
(N
, F_Chars
) then
1536 Print_Str
("Chars = initial zero");
1540 Print_Name
(Chars
(N
));
1544 -- If this is a discrete expression whose value is known, print that
1547 if Nkind
(N
) in N_Subexpr
1548 and then Compile_Time_Known_Value
(N
)
1549 and then Present
(Etype
(N
))
1550 and then Is_Discrete_Type
(Etype
(N
))
1552 if Is_Entity_Name
(N
) -- e.g. enumeration literal
1553 or else Nkind
(N
) in N_Integer_Literal
1554 | N_Character_Literal
1555 | N_Unchecked_Type_Conversion
1557 Print_Str
(" val = ");
1558 UI_Write
(Expr_Value
(N
));
1562 if Nkind
(N
) in N_Entity
then
1563 Write_Str
(" (Entity_Id=");
1565 Write_Str
(" (Node_Id=");
1568 Write_Int
(Int
(N
));
1570 if Sloc
(N
) <= Standard_Location
then
1579 ------------------------
1580 -- Print_Node_Subtree --
1581 ------------------------
1583 procedure Print_Node_Subtree
(N
: Node_Id
) is
1587 Next_Serial_Number
:= 1;
1589 Visit_Node
(N
, "", ' ');
1591 Next_Serial_Number
:= 1;
1593 Visit_Node
(N
, "", ' ');
1596 end Print_Node_Subtree
;
1602 procedure Print_Str
(S
: String) is
1604 if Phase
= Printing
then
1609 --------------------------
1610 -- Print_Str_Mixed_Case --
1611 --------------------------
1613 procedure Print_Str_Mixed_Case
(S
: String) is
1618 end Print_Str_Mixed_Case
;
1624 procedure Print_Term
is
1626 Serial_Numbers
.Destroy
(Hash_Table
);
1629 ---------------------
1630 -- Print_Tree_Elist --
1631 ---------------------
1633 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1637 Printing_Descendants
:= False;
1640 Print_Elist_Ref
(E
);
1643 if Present
(E
) and then not Is_Empty_Elmt_List
(E
) then
1644 M
:= First_Elmt
(E
);
1649 exit when No
(Next_Elmt
(M
));
1650 Print_Node
(Node
(M
), "", '|');
1654 Print_Node
(Node
(M
), "", ' ');
1657 end Print_Tree_Elist
;
1659 ---------------------
1660 -- Print_Tree_List --
1661 ---------------------
1663 procedure Print_Tree_List
(L
: List_Id
) is
1667 Printing_Descendants
:= False;
1671 Print_Str
(" List_Id=");
1672 Print_Int
(Int
(L
));
1678 Print_Str
("<empty node list>");
1685 exit when Next
(N
) = Empty
;
1686 Print_Node
(N
, "", '|');
1690 Print_Node
(N
, "", ' ');
1693 end Print_Tree_List
;
1695 ---------------------
1696 -- Print_Tree_Node --
1697 ---------------------
1699 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1701 Printing_Descendants
:= False;
1703 Print_Node
(N
, Label
, ' ');
1704 end Print_Tree_Node
;
1710 procedure pt
(N
: Union_Id
) is
1713 when List_Low_Bound
.. List_High_Bound
- 1 =>
1714 Print_List_Subtree
(List_Id
(N
));
1717 Print_Node_Subtree
(Node_Id
(N
));
1720 Print_Elist_Subtree
(Elist_Id
(N
));
1732 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1733 -- to save the Id that should be used if Set_Serial_Number is called.
1735 function Serial_Number
(Id
: Int
) return Nat
is
1738 return Serial_Numbers
.Get
(Hash_Table
, Id
);
1741 -----------------------
1742 -- Set_Serial_Number --
1743 -----------------------
1745 procedure Set_Serial_Number
is
1747 Serial_Numbers
.Put
(Hash_Table
, Hash_Id
, Next_Serial_Number
);
1748 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1749 end Set_Serial_Number
;
1755 procedure Tree_Dump
is
1756 procedure Underline
;
1757 -- Put underline under string we just printed
1759 procedure Underline
is
1760 Col
: constant Int
:= Column
;
1765 while Col
> Column
loop
1772 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1773 -- flags immediately, before starting the dump. This avoids generating two
1774 -- copies of the dump if an abort occurs after printing the dump, and more
1775 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1777 -- Note: unlike in the source print case (in Sprint), we do not output
1778 -- separate trees for each unit. Instead the -df debug switch causes the
1779 -- tree that is output from the main unit to trace references into other
1780 -- units (normally such references are not traced). Since all other units
1781 -- are linked to the main unit by at least one reference, this causes all
1782 -- tree nodes to be included in the output tree.
1785 if Debug_Flag_Y
then
1786 Debug_Flag_Y
:= False;
1788 Write_Str
("Tree created for Standard (spec) ");
1790 Print_Node_Subtree
(Standard_Package_Node
);
1794 if Debug_Flag_T
then
1795 Debug_Flag_T
:= False;
1798 Write_Str
("Tree created for ");
1799 Write_Unit_Name_For_Debug
(Unit_Name
(Main_Unit
));
1801 Print_Node_Subtree
(Cunit
(Main_Unit
));
1810 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1813 S
: constant Nat
:= Serial_Number
(Int
(E
));
1816 -- In marking phase, return if already marked, otherwise set next
1817 -- serial number in hash table for later reference.
1819 if Phase
= Marking
then
1821 return; -- already visited
1826 -- In printing phase, if already printed, then return, otherwise we
1827 -- are printing the next item, so increment the serial number.
1830 if S
< Next_Serial_Number
then
1831 return; -- already printed
1833 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1837 -- Now process the list (Print calls have no effect in marking phase)
1839 Print_Str
(Prefix_Str
);
1840 Print_Elist_Ref
(E
);
1843 if Is_Empty_Elmt_List
(E
) then
1844 Print_Str
(Prefix_Str
);
1845 Print_Str
("(Empty element list)");
1850 if Phase
= Printing
then
1851 M
:= First_Elmt
(E
);
1852 while Present
(M
) loop
1854 Print_Str
(Prefix_Str
);
1861 Print_Str
(Prefix_Str
);
1865 M
:= First_Elmt
(E
);
1866 while Present
(M
) loop
1867 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1877 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1879 S
: constant Nat
:= Serial_Number
(Int
(L
));
1882 -- In marking phase, return if already marked, otherwise set next
1883 -- serial number in hash table for later reference.
1885 if Phase
= Marking
then
1892 -- In printing phase, if already printed, then return, otherwise we
1893 -- are printing the next item, so increment the serial number.
1896 if S
< Next_Serial_Number
then
1897 return; -- already printed
1899 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1903 -- Now process the list (Print calls have no effect in marking phase)
1905 Print_Str
(Prefix_Str
);
1909 Print_Str
(Prefix_Str
);
1910 Print_Str
("|Parent = ");
1911 Print_Node_Ref
(Parent
(L
));
1917 Print_Str
(Prefix_Str
);
1918 Print_Str
("(Empty list)");
1923 Print_Str
(Prefix_Str
);
1927 while Next
(N
) /= Empty
loop
1928 Visit_Node
(N
, Prefix_Str
, '|');
1933 Visit_Node
(N
, Prefix_Str
, ' ');
1940 procedure Visit_Node
1942 Prefix_Str
: String;
1943 Prefix_Char
: Character)
1945 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
1946 -- Prefix string for printing referenced fields
1948 procedure Visit_Descendant
(D
: Union_Id
);
1949 -- This procedure tests the given value of one of the Fields referenced
1950 -- by the current node to determine whether to visit it recursively.
1951 -- The visited node will be indented using New_Prefix.
1953 ----------------------
1954 -- Visit_Descendant --
1955 ----------------------
1957 procedure Visit_Descendant
(D
: Union_Id
) is
1959 -- Case of descendant is a node
1961 if D
in Node_Range
then
1963 -- Don't bother about Empty or Error descendants
1965 if D
<= Union_Id
(Empty_Or_Error
) then
1970 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
1973 -- Descendants in one of the standardly compiled internal
1974 -- packages are normally ignored, unless the parent is also
1975 -- in such a package (happens when Standard itself is output)
1976 -- or if the -df switch is set which causes all links to be
1977 -- followed, even into package standard.
1979 if Sloc
(Nod
) <= Standard_Location
then
1980 if Sloc
(N
) > Standard_Location
1981 and then not Debug_Flag_F
1986 -- Don't bother about a descendant in a different unit than
1987 -- the node we came from unless the -df switch is set. Note
1988 -- that we know at this point that Sloc (D) > Standard_Location
1990 -- Note: the tests for No_Location here just make sure that we
1991 -- don't blow up on a node which is missing an Sloc value. This
1992 -- should not normally happen.
1995 if (Sloc
(N
) <= Standard_Location
1996 or else Sloc
(N
) = No_Location
1997 or else Sloc
(Nod
) = No_Location
1998 or else not In_Same_Source_Unit
(Nod
, N
))
1999 and then not Debug_Flag_F
2005 -- Don't bother visiting a source node that has a parent which
2006 -- is not the node we came from. We prefer to trace such nodes
2007 -- from their real parents. This causes the tree to be printed
2008 -- in a more coherent order, e.g. a defining identifier listed
2009 -- next to its corresponding declaration, instead of next to
2010 -- some semantic reference.
2012 -- This test is skipped for nodes in standard packages unless
2013 -- the -dy option is set (which outputs the tree for standard)
2015 -- Also, always follow pointers to Is_Itype entities,
2016 -- since we want to list these when they are first referenced.
2018 if Parent
(Nod
) /= Empty
2019 and then Comes_From_Source
(Nod
)
2020 and then Parent
(Nod
) /= N
2021 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
2026 -- If we successfully fall through all the above tests (which
2027 -- execute a return if the node is not to be visited), we can
2028 -- go ahead and visit the node.
2030 Visit_Node
(Nod
, New_Prefix
, ' ');
2033 -- Case of descendant is a list
2035 elsif D
in List_Range
then
2037 -- Don't bother with a missing list, empty list or error list
2039 pragma Assert
(D
/= Union_Id
(No_List
));
2040 -- Because No_List = Empty, which is in Node_Range above
2042 if D
= Union_Id
(Error_List
)
2043 or else Is_Empty_List
(List_Id
(D
))
2047 -- Otherwise we can visit the list. Note that we don't bother to
2048 -- do the parent test that we did for the node case, because it
2049 -- just does not happen that lists are referenced more than one
2050 -- place in the tree. We aren't counting on this being the case
2051 -- to generate valid output, it is just that we don't need in
2052 -- practice to worry about listing the list at a place that is
2056 Visit_List
(List_Id
(D
), New_Prefix
);
2059 -- Case of descendant is an element list
2061 elsif D
in Elist_Range
then
2063 -- Don't bother with a missing list, or an empty list
2065 if D
= Union_Id
(No_Elist
)
2066 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
2070 -- Otherwise, visit the referenced element list
2073 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
2077 raise Program_Error
;
2079 end Visit_Descendant
;
2081 -- Start of processing for Visit_Node
2088 -- Set fatal error node in case we get a blow up during the trace
2090 Current_Error_Node
:= N
;
2092 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
2093 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
2094 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
2096 -- In the marking phase, all we do is to set the serial number
2098 if Phase
= Marking
then
2099 if Serial_Number
(Int
(N
)) /= 0 then
2100 return; -- already visited
2105 -- In the printing phase, we print the node
2108 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
2110 -- Here we have already visited the node, but if it is in a list,
2111 -- we still want to print the reference, so that it is clear that
2112 -- it belongs to the list.
2114 if Is_List_Member
(N
) then
2115 Print_Str
(Prefix_Str
);
2118 Print_Str
(Prefix_Str
);
2119 Print_Char
(Prefix_Char
);
2120 Print_Str
("(already output)");
2122 Print_Str
(Prefix_Str
);
2123 Print_Char
(Prefix_Char
);
2130 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
2131 Print_Str
(Prefix_Str
);
2132 Print_Char
(Prefix_Char
);
2134 Next_Serial_Number
:= Next_Serial_Number
+ 1;
2138 -- Visit all descendants of this node
2141 A
: Node_Field_Array
renames Node_Field_Table
(Nkind
(N
)).all;
2143 for Field_Index
in A
'Range loop
2145 F
: constant Node_Field
:= A
(Field_Index
);
2146 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2148 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2149 -- For all other kinds of descendants (strings, names, uints
2150 -- etc), there is nothing to visit (the contents of the
2151 -- field will be printed when we print the containing node,
2152 -- but what concerns us now is looking for descendants in
2155 and then F
/= F_Next_Entity
-- See below for why we skip this
2157 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2163 if Has_Aspects
(N
) then
2164 Visit_Descendant
(Union_Id
(Aspect_Specifications
(N
)));
2167 if Nkind
(N
) in N_Entity
then
2169 A
: Entity_Field_Array
renames Entity_Field_Table
(Ekind
(N
)).all;
2171 for Field_Index
in A
'Range loop
2173 F
: constant Entity_Field
:= A
(Field_Index
);
2174 FD
: Field_Descriptor
renames Field_Descriptors
(F
);
2176 if FD
.Kind
in Node_Id_Field | List_Id_Field | Elist_Id_Field
2178 Visit_Descendant
(Get_Union_Id
(N
, FD
.Offset
));
2184 -- Now an interesting special case. Normally parents are always
2185 -- printed since we traverse the tree in a downwards direction.
2186 -- However, there is an exception to this rule, which is the
2187 -- case where a parent is constructed by the compiler and is not
2188 -- referenced elsewhere in the tree. The following catches this case.
2190 if not Comes_From_Source
(N
) then
2191 Visit_Descendant
(Union_Id
(Parent
(N
)));
2194 -- You may be wondering why we omitted Next_Entity above. The answer
2195 -- is that we want to treat it rather specially. Why? Because a
2196 -- Next_Entity link does not correspond to a level deeper in the
2197 -- tree, and we do not want the tree to march off to the right of the
2198 -- page due to bogus indentations coming from this effect.
2200 -- To prevent this, what we do is to control references via
2201 -- Next_Entity only from the first entity on a given scope chain,
2202 -- and we keep them all at the same level. Of course if an entity
2203 -- has already been referenced it is not printed.
2205 if Present
(Next_Entity
(N
))
2206 and then Present
(Scope
(N
))
2207 and then First_Entity
(Scope
(N
)) = N
2214 while Present
(Nod
) loop
2216 Visit_Descendant
(Union_Id
(Nod
));