1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, 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 Atree
; use Atree
;
27 with Csets
; use Csets
;
28 with Debug
; use Debug
;
29 with Einfo
; use Einfo
;
30 with Elists
; use Elists
;
32 with Namet
; use Namet
;
33 with Nlists
; use Nlists
;
34 with Output
; use Output
;
35 with Sem_Mech
; use Sem_Mech
;
36 with Sinfo
; use Sinfo
;
37 with Snames
; use Snames
;
38 with Sinput
; use Sinput
;
39 with Stand
; use Stand
;
40 with Stringt
; use Stringt
;
41 with Treeprs
; use Treeprs
;
42 with Uintp
; use Uintp
;
43 with Urealp
; use Urealp
;
44 with Uname
; use Uname
;
45 with Unchecked_Deallocation
;
47 package body Treepr
is
49 use Atree
.Unchecked_Access
;
50 -- This module uses the unchecked access functions in package Atree
51 -- since it does an untyped traversal of the tree (we do not want to
52 -- count on the structure of the tree being correct in this routine!)
54 ----------------------------------
55 -- Approach Used for Tree Print --
56 ----------------------------------
58 -- When a complete subtree is being printed, a trace phase first marks
59 -- the nodes and lists to be printed. This trace phase allocates logical
60 -- numbers corresponding to the order in which the nodes and lists will
61 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
62 -- logical node numbers using a hash table. Output is done using a set
63 -- of Print_xxx routines, which are similar to the Write_xxx routines
64 -- with the same name, except that they do not generate any output in
65 -- the marking phase. This allows identical logic to be used in the
68 -- Note that the hash table not only holds the serial numbers, but also
69 -- acts as a record of which nodes have already been visited. In the
70 -- marking phase, a node has been visited if it is already in the hash
71 -- table, and in the printing phase, we can tell whether a node has
72 -- already been printed by looking at the value of the serial number.
74 ----------------------
75 -- Global Variables --
76 ----------------------
78 type Hash_Record
is record
80 -- Serial number for hash table entry. A value of zero means that
81 -- the entry is currently unused.
84 -- If serial number field is non-zero, contains corresponding Id value
87 type Hash_Table_Type
is array (Nat
range <>) of Hash_Record
;
88 type Access_Hash_Table_Type
is access Hash_Table_Type
;
89 Hash_Table
: Access_Hash_Table_Type
;
90 -- The hash table itself, see Serial_Number function for details of use
93 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
94 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
96 Next_Serial_Number
: Nat
;
97 -- Number of last visited node or list. Used during the marking phase to
98 -- set proper node numbers in the hash table, and during the printing
99 -- phase to make sure that a given node is not printed more than once.
100 -- (nodes are printed in order during the printing phase, that's the
101 -- point of numbering them in the first place!)
103 Printing_Descendants
: Boolean;
104 -- True if descendants are being printed, False if not. In the false case,
105 -- only node Id's are printed. In the true case, node numbers as well as
106 -- node Id's are printed, as described above.
108 type Phase_Type
is (Marking
, Printing
);
109 -- Type for Phase variable
112 -- When an entire tree is being printed, the traversal operates in two
113 -- phases. The first phase marks the nodes in use by installing node
114 -- numbers in the node number table. The second phase prints the nodes.
115 -- This variable indicates the current phase.
117 ----------------------
118 -- Local Procedures --
119 ----------------------
121 procedure Print_End_Span
(N
: Node_Id
);
122 -- Special routine to print contents of End_Span field of node N.
123 -- The format includes the implicit source location as well as the
124 -- value of the field.
126 procedure Print_Init
;
127 -- Initialize for printing of tree with descendents
129 procedure Print_Term
;
130 -- Clean up after printing of tree with descendents
132 procedure Print_Char
(C
: Character);
133 -- Print character C if currently in print phase, noop if in marking phase
135 procedure Print_Name
(N
: Name_Id
);
136 -- Print name from names table if currently in print phase, noop if in
137 -- marking phase. Note that the name is output in mixed case mode.
139 procedure Print_Node_Kind
(N
: Node_Id
);
140 -- Print node kind name in mixed case if in print phase, noop if in
143 procedure Print_Str
(S
: String);
144 -- Print string S if currently in print phase, noop if in marking phase
146 procedure Print_Str_Mixed_Case
(S
: String);
147 -- Like Print_Str, except that the string is printed in mixed case mode
149 procedure Print_Int
(I
: Int
);
150 -- Print integer I if currently in print phase, noop if in marking phase
153 -- Print end of line if currently in print phase, noop if in marking phase
155 procedure Print_Node_Ref
(N
: Node_Id
);
156 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
157 -- in the latter case, including the Id and the Nkind of the node.
159 procedure Print_List_Ref
(L
: List_Id
);
160 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
162 procedure Print_Elist_Ref
(E
: Elist_Id
);
163 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
165 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
166 -- Called if the node being printed is an entity. Prints fields from the
167 -- extension, using routines in Einfo to get the field names and flags.
169 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
170 -- Print representation of Field value (name, tree, string, uint, charcode)
171 -- The format parameter controls the format of printing in the case of an
172 -- integer value (see UI_Write for details).
174 procedure Print_Flag
(F
: Boolean);
175 -- Print True or False
180 Prefix_Char
: Character);
181 -- This is the internal routine used to print a single node. Each line of
182 -- output is preceded by Prefix_Str (which is used to set the indentation
183 -- level and the bars used to link list elements). In addition, for lines
184 -- other than the first, an additional character Prefix_Char is output.
186 function Serial_Number
(Id
: Int
) return Nat
;
187 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
188 -- serial number, or zero if no serial number has yet been assigned.
190 procedure Set_Serial_Number
;
191 -- Can be called only immediately following a call to Serial_Number that
192 -- returned a value of zero. Causes the value of Next_Serial_Number to be
193 -- placed in the hash table (corresponding to the Id argument used in the
194 -- Serial_Number call), and increments Next_Serial_Number.
199 Prefix_Char
: Character);
200 -- Called to process a single node in the case where descendents are to
201 -- be printed before every line, and Prefix_Char added to all lines
202 -- except the header line for the node.
204 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
205 -- Visit_List is called to process a list in the case where descendents
206 -- are to be printed. Prefix_Str is to be added to all printed lines.
208 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
209 -- Visit_Elist is called to process an element list in the case where
210 -- descendents are to be printed. Prefix_Str is to be added to all
217 procedure pe
(E
: Elist_Id
) is
219 Print_Tree_Elist
(E
);
226 procedure pl
(L
: Int
) is
233 -- This is the case where we transform e.g. +36 to -99999936
237 Lid
:= -(99999990 + L
);
239 Lid
:= -(99999900 + L
);
241 Lid
:= -(99999000 + L
);
243 Lid
:= -(99990000 + L
);
244 elsif L
<= 99999 then
245 Lid
:= -(99900000 + L
);
246 elsif L
<= 999999 then
247 Lid
:= -(99000000 + L
);
248 elsif L
<= 9999999 then
249 Lid
:= -(90000000 + L
);
255 -- Now output the list
257 Print_Tree_List
(List_Id
(Lid
));
264 procedure pn
(N
: Node_Id
) is
273 procedure Print_Char
(C
: Character) is
275 if Phase
= Printing
then
280 ---------------------
281 -- Print_Elist_Ref --
282 ---------------------
284 procedure Print_Elist_Ref
(E
: Elist_Id
) is
286 if Phase
/= Printing
then
291 Write_Str
("<no elist>");
293 elsif Is_Empty_Elmt_List
(E
) then
294 Write_Str
("Empty elist, (Elist_Id=");
299 Write_Str
("(Elist_Id=");
303 if Printing_Descendants
then
305 Write_Int
(Serial_Number
(Int
(E
)));
310 -------------------------
311 -- Print_Elist_Subtree --
312 -------------------------
314 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
318 Next_Serial_Number
:= 1;
322 Next_Serial_Number
:= 1;
327 end Print_Elist_Subtree
;
333 procedure Print_End_Span
(N
: Node_Id
) is
334 Val
: constant Uint
:= End_Span
(N
);
338 Write_Str
(" (Uint = ");
339 Write_Int
(Int
(Field5
(N
)));
342 if Val
/= No_Uint
then
343 Write_Location
(End_Location
(N
));
347 -----------------------
348 -- Print_Entity_Info --
349 -----------------------
351 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
352 function Field_Present
(U
: Union_Id
) return Boolean;
353 -- Returns False unless the value U represents a missing value
354 -- (Empty, No_Uint, No_Ureal or No_String)
356 function Field_Present
(U
: Union_Id
) return Boolean is
359 U
/= Union_Id
(Empty
) and then
360 U
/= To_Union
(No_Uint
) and then
361 U
/= To_Union
(No_Ureal
) and then
362 U
/= Union_Id
(No_String
);
365 -- Start of processing for Print_Entity_Info
369 Print_Str
("Ekind = ");
370 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
374 Print_Str
("Etype = ");
375 Print_Node_Ref
(Etype
(Ent
));
378 if Convention
(Ent
) /= Convention_Ada
then
380 Print_Str
("Convention = ");
382 -- Print convention name skipping the Convention_ at the start
385 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
388 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
393 if Field_Present
(Field6
(Ent
)) then
395 Write_Field6_Name
(Ent
);
397 Print_Field
(Field6
(Ent
));
401 if Field_Present
(Field7
(Ent
)) then
403 Write_Field7_Name
(Ent
);
405 Print_Field
(Field7
(Ent
));
409 if Field_Present
(Field8
(Ent
)) then
411 Write_Field8_Name
(Ent
);
413 Print_Field
(Field8
(Ent
));
417 if Field_Present
(Field9
(Ent
)) then
419 Write_Field9_Name
(Ent
);
421 Print_Field
(Field9
(Ent
));
425 if Field_Present
(Field10
(Ent
)) then
427 Write_Field10_Name
(Ent
);
429 Print_Field
(Field10
(Ent
));
433 if Field_Present
(Field11
(Ent
)) then
435 Write_Field11_Name
(Ent
);
437 Print_Field
(Field11
(Ent
));
441 if Field_Present
(Field12
(Ent
)) then
443 Write_Field12_Name
(Ent
);
445 Print_Field
(Field12
(Ent
));
449 if Field_Present
(Field13
(Ent
)) then
451 Write_Field13_Name
(Ent
);
453 Print_Field
(Field13
(Ent
));
457 if Field_Present
(Field14
(Ent
)) then
459 Write_Field14_Name
(Ent
);
461 Print_Field
(Field14
(Ent
));
465 if Field_Present
(Field15
(Ent
)) then
467 Write_Field15_Name
(Ent
);
469 Print_Field
(Field15
(Ent
));
473 if Field_Present
(Field16
(Ent
)) then
475 Write_Field16_Name
(Ent
);
477 Print_Field
(Field16
(Ent
));
481 if Field_Present
(Field17
(Ent
)) then
483 Write_Field17_Name
(Ent
);
485 Print_Field
(Field17
(Ent
));
489 if Field_Present
(Field18
(Ent
)) then
491 Write_Field18_Name
(Ent
);
493 Print_Field
(Field18
(Ent
));
497 if Field_Present
(Field19
(Ent
)) then
499 Write_Field19_Name
(Ent
);
501 Print_Field
(Field19
(Ent
));
505 if Field_Present
(Field20
(Ent
)) then
507 Write_Field20_Name
(Ent
);
509 Print_Field
(Field20
(Ent
));
513 if Field_Present
(Field21
(Ent
)) then
515 Write_Field21_Name
(Ent
);
517 Print_Field
(Field21
(Ent
));
521 if Field_Present
(Field22
(Ent
)) then
523 Write_Field22_Name
(Ent
);
526 -- Mechanism case has to be handled specially
528 if Ekind
(Ent
) = E_Function
or else Is_Formal
(Ent
) then
530 M
: constant Mechanism_Type
:= Mechanism
(Ent
);
534 when Default_Mechanism
=> Write_Str
("Default");
535 when By_Copy
=> Write_Str
("By_Copy");
536 when By_Reference
=> Write_Str
("By_Reference");
537 when By_Descriptor
=> Write_Str
("By_Descriptor");
538 when By_Descriptor_UBS
=> Write_Str
("By_Descriptor_UBS");
539 when By_Descriptor_UBSB
=> Write_Str
("By_Descriptor_UBSB");
540 when By_Descriptor_UBA
=> Write_Str
("By_Descriptor_UBA");
541 when By_Descriptor_S
=> Write_Str
("By_Descriptor_S");
542 when By_Descriptor_SB
=> Write_Str
("By_Descriptor_SB");
543 when By_Descriptor_A
=> Write_Str
("By_Descriptor_A");
544 when By_Descriptor_NCA
=> Write_Str
("By_Descriptor_NCA");
546 when 1 .. Mechanism_Type
'Last =>
547 Write_Str
("By_Copy if size <= ");
553 -- Normal case (not Mechanism)
556 Print_Field
(Field22
(Ent
));
562 if Field_Present
(Field23
(Ent
)) then
564 Write_Field23_Name
(Ent
);
566 Print_Field
(Field23
(Ent
));
570 if Field_Present
(Field24
(Ent
)) then
572 Write_Field24_Name
(Ent
);
574 Print_Field
(Field24
(Ent
));
578 if Field_Present
(Field25
(Ent
)) then
580 Write_Field25_Name
(Ent
);
582 Print_Field
(Field25
(Ent
));
586 if Field_Present
(Field26
(Ent
)) then
588 Write_Field26_Name
(Ent
);
590 Print_Field
(Field26
(Ent
));
594 if Field_Present
(Field27
(Ent
)) then
596 Write_Field27_Name
(Ent
);
598 Print_Field
(Field27
(Ent
));
602 Write_Entity_Flags
(Ent
, Prefix
);
603 end Print_Entity_Info
;
609 procedure Print_Eol
is
611 if Phase
= Printing
then
620 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
622 if Phase
/= Printing
then
626 if Val
in Node_Range
then
627 Print_Node_Ref
(Node_Id
(Val
));
629 elsif Val
in List_Range
then
630 Print_List_Ref
(List_Id
(Val
));
632 elsif Val
in Elist_Range
then
633 Print_Elist_Ref
(Elist_Id
(Val
));
635 elsif Val
in Names_Range
then
636 Print_Name
(Name_Id
(Val
));
637 Write_Str
(" (Name_Id=");
638 Write_Int
(Int
(Val
));
641 elsif Val
in Strings_Range
then
642 Write_String_Table_Entry
(String_Id
(Val
));
643 Write_Str
(" (String_Id=");
644 Write_Int
(Int
(Val
));
647 elsif Val
in Uint_Range
then
648 UI_Write
(From_Union
(Val
), Format
);
649 Write_Str
(" (Uint = ");
650 Write_Int
(Int
(Val
));
653 elsif Val
in Ureal_Range
then
654 UR_Write
(From_Union
(Val
));
655 Write_Str
(" (Ureal = ");
656 Write_Int
(Int
(Val
));
660 Print_Str
("****** Incorrect value = ");
661 Print_Int
(Int
(Val
));
669 procedure Print_Flag
(F
: Boolean) is
682 procedure Print_Init
is
684 Printing_Descendants
:= True;
687 -- Allocate and clear serial number hash table. The size is 150% of
688 -- the maximum possible number of entries, so that the hash table
689 -- cannot get significantly overloaded.
691 Hash_Table_Len
:= (150 * (Num_Nodes
+ Num_Lists
+ Num_Elists
)) / 100;
692 Hash_Table
:= new Hash_Table_Type
(0 .. Hash_Table_Len
- 1);
694 for J
in Hash_Table
'Range loop
695 Hash_Table
(J
).Serial
:= 0;
704 procedure Print_Int
(I
: Int
) is
706 if Phase
= Printing
then
715 procedure Print_List_Ref
(L
: List_Id
) is
717 if Phase
/= Printing
then
722 Write_Str
("<no list>");
724 elsif Is_Empty_List
(L
) then
725 Write_Str
("<empty list> (List_Id=");
732 if Printing_Descendants
then
734 Write_Int
(Serial_Number
(Int
(L
)));
737 Write_Str
(" (List_Id=");
743 ------------------------
744 -- Print_List_Subtree --
745 ------------------------
747 procedure Print_List_Subtree
(L
: List_Id
) is
751 Next_Serial_Number
:= 1;
755 Next_Serial_Number
:= 1;
760 end Print_List_Subtree
;
766 procedure Print_Name
(N
: Name_Id
) is
768 if Phase
= Printing
then
770 Print_Str
("<No_Name>");
772 elsif N
= Error_Name
then
773 Print_Str
("<Error_Name>");
775 elsif Is_Valid_Name
(N
) then
782 Print_Str
("<invalid name ???>");
794 Prefix_Char
: Character)
797 P
: Natural := Pchar_Pos
(Nkind
(N
));
799 Field_To_Be_Printed
: Boolean;
800 Prefix_Str_Char
: String (Prefix_Str
'First .. Prefix_Str
'Last + 1);
802 Sfile
: Source_File_Index
;
807 if Phase
/= Printing
then
811 if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
) then
817 Prefix_Str_Char
(Prefix_Str
'Range) := Prefix_Str
;
818 Prefix_Str_Char
(Prefix_Str
'Last + 1) := Prefix_Char
;
822 Print_Str
(Prefix_Str
);
827 if N
> Atree_Private_Part
.Nodes
.Last
then
828 Print_Str
(" (no such node)");
833 if Comes_From_Source
(N
) then
835 Print_Str
(" (source");
846 Print_Str
("analyzed");
849 if Error_Posted
(N
) then
857 Print_Str
("posted");
866 if Is_Rewrite_Substitution
(N
) then
867 Print_Str
(Prefix_Str
);
868 Print_Str
(" Rewritten: original node = ");
869 Print_Node_Ref
(Original_Node
(N
));
877 if not Is_List_Member
(N
) then
878 Print_Str
(Prefix_Str
);
879 Print_Str
(" Parent = ");
880 Print_Node_Ref
(Parent
(N
));
884 -- Print Sloc field if it is set
886 if Sloc
(N
) /= No_Location
then
887 Print_Str
(Prefix_Str_Char
);
888 Print_Str
("Sloc = ");
890 if Sloc
(N
) = Standard_Location
then
891 Print_Str
("Standard_Location");
893 elsif Sloc
(N
) = Standard_ASCII_Location
then
894 Print_Str
("Standard_ASCII_Location");
897 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
898 Print_Int
(Int
(Sloc
(N
)) - Int
(Source_Text
(Sfile
)'First));
900 Write_Location
(Sloc
(N
));
906 -- Print Chars field if present
908 if Nkind
(N
) in N_Has_Chars
and then Chars
(N
) /= No_Name
then
909 Print_Str
(Prefix_Str_Char
);
910 Print_Str
("Chars = ");
911 Print_Name
(Chars
(N
));
912 Write_Str
(" (Name_Id=");
913 Write_Int
(Int
(Chars
(N
)));
918 -- Special field print operations for non-entity nodes
920 if Nkind
(N
) not in N_Entity
then
922 -- Deal with Left_Opnd and Right_Opnd fields
925 or else Nkind
(N
) = N_And_Then
926 or else Nkind
(N
) = N_Or_Else
927 or else Nkind
(N
) in N_Membership_Test
929 -- Print Left_Opnd if present
931 if Nkind
(N
) not in N_Unary_Op
then
932 Print_Str
(Prefix_Str_Char
);
933 Print_Str
("Left_Opnd = ");
934 Print_Node_Ref
(Left_Opnd
(N
));
940 Print_Str
(Prefix_Str_Char
);
941 Print_Str
("Right_Opnd = ");
942 Print_Node_Ref
(Right_Opnd
(N
));
946 -- Print Entity field if operator (other cases of Entity
947 -- are in the table, so are handled in the normal circuit)
949 if Nkind
(N
) in N_Op
and then Present
(Entity
(N
)) then
950 Print_Str
(Prefix_Str_Char
);
951 Print_Str
("Entity = ");
952 Print_Node_Ref
(Entity
(N
));
956 -- Print special fields if we have a subexpression
958 if Nkind
(N
) in N_Subexpr
then
960 if Assignment_OK
(N
) then
961 Print_Str
(Prefix_Str_Char
);
962 Print_Str
("Assignment_OK = True");
966 if Do_Range_Check
(N
) then
967 Print_Str
(Prefix_Str_Char
);
968 Print_Str
("Do_Range_Check = True");
972 if Has_Dynamic_Length_Check
(N
) then
973 Print_Str
(Prefix_Str_Char
);
974 Print_Str
("Has_Dynamic_Length_Check = True");
978 if Has_Dynamic_Range_Check
(N
) then
979 Print_Str
(Prefix_Str_Char
);
980 Print_Str
("Has_Dynamic_Range_Check = True");
984 if Is_Controlling_Actual
(N
) then
985 Print_Str
(Prefix_Str_Char
);
986 Print_Str
("Is_Controlling_Actual = True");
990 if Is_Overloaded
(N
) then
991 Print_Str
(Prefix_Str_Char
);
992 Print_Str
("Is_Overloaded = True");
996 if Is_Static_Expression
(N
) then
997 Print_Str
(Prefix_Str_Char
);
998 Print_Str
("Is_Static_Expression = True");
1002 if Must_Not_Freeze
(N
) then
1003 Print_Str
(Prefix_Str_Char
);
1004 Print_Str
("Must_Not_Freeze = True");
1008 if Paren_Count
(N
) /= 0 then
1009 Print_Str
(Prefix_Str_Char
);
1010 Print_Str
("Paren_Count = ");
1011 Print_Int
(Int
(Paren_Count
(N
)));
1015 if Raises_Constraint_Error
(N
) then
1016 Print_Str
(Prefix_Str_Char
);
1017 Print_Str
("Raise_Constraint_Error = True");
1023 -- Print Do_Overflow_Check field if present
1025 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1026 Print_Str
(Prefix_Str_Char
);
1027 Print_Str
("Do_Overflow_Check = True");
1031 -- Print Etype field if present (printing of this field for entities
1032 -- is handled by the Print_Entity_Info procedure).
1034 if Nkind
(N
) in N_Has_Etype
and then Present
(Etype
(N
)) then
1035 Print_Str
(Prefix_Str_Char
);
1036 Print_Str
("Etype = ");
1037 Print_Node_Ref
(Etype
(N
));
1042 -- Loop to print fields included in Pchars array
1044 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
))) loop
1048 -- Check for case of False flag, which we never print, or
1049 -- an Empty field, which is also never printed
1053 Field_To_Be_Printed
:= Field1
(N
) /= Union_Id
(Empty
);
1056 Field_To_Be_Printed
:= Field2
(N
) /= Union_Id
(Empty
);
1059 Field_To_Be_Printed
:= Field3
(N
) /= Union_Id
(Empty
);
1062 Field_To_Be_Printed
:= Field4
(N
) /= Union_Id
(Empty
);
1065 Field_To_Be_Printed
:= Field5
(N
) /= Union_Id
(Empty
);
1067 when F_Flag4
=> Field_To_Be_Printed
:= Flag4
(N
);
1068 when F_Flag5
=> Field_To_Be_Printed
:= Flag5
(N
);
1069 when F_Flag6
=> Field_To_Be_Printed
:= Flag6
(N
);
1070 when F_Flag7
=> Field_To_Be_Printed
:= Flag7
(N
);
1071 when F_Flag8
=> Field_To_Be_Printed
:= Flag8
(N
);
1072 when F_Flag9
=> Field_To_Be_Printed
:= Flag9
(N
);
1073 when F_Flag10
=> Field_To_Be_Printed
:= Flag10
(N
);
1074 when F_Flag11
=> Field_To_Be_Printed
:= Flag11
(N
);
1075 when F_Flag12
=> Field_To_Be_Printed
:= Flag12
(N
);
1076 when F_Flag13
=> Field_To_Be_Printed
:= Flag13
(N
);
1077 when F_Flag14
=> Field_To_Be_Printed
:= Flag14
(N
);
1078 when F_Flag15
=> Field_To_Be_Printed
:= Flag15
(N
);
1079 when F_Flag16
=> Field_To_Be_Printed
:= Flag16
(N
);
1080 when F_Flag17
=> Field_To_Be_Printed
:= Flag17
(N
);
1081 when F_Flag18
=> Field_To_Be_Printed
:= Flag18
(N
);
1083 -- Flag1,2,3 are no longer used
1085 when F_Flag1
=> raise Program_Error
;
1086 when F_Flag2
=> raise Program_Error
;
1087 when F_Flag3
=> raise Program_Error
;
1091 -- Print field if it is to be printed
1093 if Field_To_Be_Printed
then
1094 Print_Str
(Prefix_Str_Char
);
1096 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1097 and then Pchars
(P
) not in Fchar
1099 Print_Char
(Pchars
(P
));
1106 when F_Field1
=> Print_Field
(Field1
(N
), Fmt
);
1107 when F_Field2
=> Print_Field
(Field2
(N
), Fmt
);
1108 when F_Field3
=> Print_Field
(Field3
(N
), Fmt
);
1109 when F_Field4
=> Print_Field
(Field4
(N
), Fmt
);
1111 -- Special case End_Span = Uint5
1114 if Nkind
(N
) = N_Case_Statement
1115 or else Nkind
(N
) = N_If_Statement
1119 Print_Field
(Field5
(N
), Fmt
);
1122 when F_Flag4
=> Print_Flag
(Flag4
(N
));
1123 when F_Flag5
=> Print_Flag
(Flag5
(N
));
1124 when F_Flag6
=> Print_Flag
(Flag6
(N
));
1125 when F_Flag7
=> Print_Flag
(Flag7
(N
));
1126 when F_Flag8
=> Print_Flag
(Flag8
(N
));
1127 when F_Flag9
=> Print_Flag
(Flag9
(N
));
1128 when F_Flag10
=> Print_Flag
(Flag10
(N
));
1129 when F_Flag11
=> Print_Flag
(Flag11
(N
));
1130 when F_Flag12
=> Print_Flag
(Flag12
(N
));
1131 when F_Flag13
=> Print_Flag
(Flag13
(N
));
1132 when F_Flag14
=> Print_Flag
(Flag14
(N
));
1133 when F_Flag15
=> Print_Flag
(Flag15
(N
));
1134 when F_Flag16
=> Print_Flag
(Flag16
(N
));
1135 when F_Flag17
=> Print_Flag
(Flag17
(N
));
1136 when F_Flag18
=> Print_Flag
(Flag18
(N
));
1138 -- Flag1,2,3 are no longer used
1140 when F_Flag1
=> raise Program_Error
;
1141 when F_Flag2
=> raise Program_Error
;
1142 when F_Flag3
=> raise Program_Error
;
1147 -- Field is not to be printed (False flag field)
1150 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1151 and then Pchars
(P
) not in Fchar
1159 -- Print entity information for entities
1161 if Nkind
(N
) in N_Entity
then
1162 Print_Entity_Info
(N
, Prefix_Str_Char
);
1167 ---------------------
1168 -- Print_Node_Kind --
1169 ---------------------
1171 procedure Print_Node_Kind
(N
: Node_Id
) is
1173 S
: constant String := Node_Kind
'Image (Nkind
(N
));
1176 if Phase
= Printing
then
1179 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1180 -- bug of 'Image returning lower case instead of upper case.
1182 for J
in S
'Range loop
1184 Write_Char
(Fold_Upper
(S
(J
)));
1186 Write_Char
(Fold_Lower
(S
(J
)));
1189 Ucase
:= (S
(J
) = '_');
1192 end Print_Node_Kind
;
1194 --------------------
1195 -- Print_Node_Ref --
1196 --------------------
1198 procedure Print_Node_Ref
(N
: Node_Id
) is
1202 if Phase
/= Printing
then
1207 Write_Str
("<empty>");
1209 elsif N
= Error
then
1210 Write_Str
("<error>");
1213 if Printing_Descendants
then
1214 S
:= Serial_Number
(Int
(N
));
1224 Print_Node_Kind
(N
);
1226 if Nkind
(N
) in N_Has_Chars
then
1228 Print_Name
(Chars
(N
));
1231 if Nkind
(N
) in N_Entity
then
1232 Write_Str
(" (Entity_Id=");
1234 Write_Str
(" (Node_Id=");
1237 Write_Int
(Int
(N
));
1239 if Sloc
(N
) <= Standard_Location
then
1248 ------------------------
1249 -- Print_Node_Subtree --
1250 ------------------------
1252 procedure Print_Node_Subtree
(N
: Node_Id
) is
1256 Next_Serial_Number
:= 1;
1258 Visit_Node
(N
, "", ' ');
1260 Next_Serial_Number
:= 1;
1262 Visit_Node
(N
, "", ' ');
1265 end Print_Node_Subtree
;
1271 procedure Print_Str
(S
: String) is
1273 if Phase
= Printing
then
1278 --------------------------
1279 -- Print_Str_Mixed_Case --
1280 --------------------------
1282 procedure Print_Str_Mixed_Case
(S
: String) is
1286 if Phase
= Printing
then
1289 for J
in S
'Range loop
1293 Write_Char
(Fold_Lower
(S
(J
)));
1296 Ucase
:= (S
(J
) = '_');
1299 end Print_Str_Mixed_Case
;
1305 procedure Print_Term
is
1306 procedure Free
is new Unchecked_Deallocation
1307 (Hash_Table_Type
, Access_Hash_Table_Type
);
1313 ---------------------
1314 -- Print_Tree_Elist --
1315 ---------------------
1317 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1321 Printing_Descendants
:= False;
1324 Print_Elist_Ref
(E
);
1327 M
:= First_Elmt
(E
);
1330 Print_Str
("<empty element list>");
1337 exit when No
(Next_Elmt
(M
));
1338 Print_Node
(Node
(M
), "", '|');
1342 Print_Node
(Node
(M
), "", ' ');
1345 end Print_Tree_Elist
;
1347 ---------------------
1348 -- Print_Tree_List --
1349 ---------------------
1351 procedure Print_Tree_List
(L
: List_Id
) is
1355 Printing_Descendants
:= False;
1359 Print_Str
(" List_Id=");
1360 Print_Int
(Int
(L
));
1366 Print_Str
("<empty node list>");
1373 exit when Next
(N
) = Empty
;
1374 Print_Node
(N
, "", '|');
1378 Print_Node
(N
, "", ' ');
1381 end Print_Tree_List
;
1383 ---------------------
1384 -- Print_Tree_Node --
1385 ---------------------
1387 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1389 Printing_Descendants
:= False;
1391 Print_Node
(N
, Label
, ' ');
1392 end Print_Tree_Node
;
1398 procedure pt
(N
: Node_Id
) is
1400 Print_Node_Subtree
(N
);
1407 -- The hashing algorithm is to use the remainder of the ID value divided
1408 -- by the hash table length as the starting point in the table, and then
1409 -- handle collisions by serial searching wrapping at the end of the table.
1412 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1413 -- to save the slot that should be used if Set_Serial_Number is called.
1415 function Serial_Number
(Id
: Int
) return Nat
is
1416 H
: Int
:= Id
mod Hash_Table_Len
;
1419 while Hash_Table
(H
).Serial
/= 0 loop
1421 if Id
= Hash_Table
(H
).Id
then
1422 return Hash_Table
(H
).Serial
;
1427 if H
> Hash_Table
'Last then
1432 -- Entry was not found, save slot number for possible subsequent call
1433 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1434 -- in case of such a call (the Id field is never read if the serial
1435 -- number of the slot is zero, so this is harmless in the case where
1436 -- Set_Serial_Number is not subsequently called).
1439 Hash_Table
(H
).Id
:= Id
;
1444 -----------------------
1445 -- Set_Serial_Number --
1446 -----------------------
1448 procedure Set_Serial_Number
is
1450 Hash_Table
(Hash_Slot
).Serial
:= Next_Serial_Number
;
1451 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1452 end Set_Serial_Number
;
1458 procedure Tree_Dump
is
1459 procedure Underline
;
1460 -- Put underline under string we just printed
1462 procedure Underline
is
1463 Col
: constant Int
:= Column
;
1468 while Col
> Column
loop
1475 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1476 -- flags immediately, before starting the dump. This avoids generating two
1477 -- copies of the dump if an abort occurs after printing the dump, and more
1478 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1480 -- Note: unlike in the source print case (in Sprint), we do not output
1481 -- separate trees for each unit. Instead the -df debug switch causes the
1482 -- tree that is output from the main unit to trace references into other
1483 -- units (normally such references are not traced). Since all other units
1484 -- are linked to the main unit by at least one reference, this causes all
1485 -- tree nodes to be included in the output tree.
1488 if Debug_Flag_Y
then
1489 Debug_Flag_Y
:= False;
1491 Write_Str
("Tree created for Standard (spec) ");
1493 Print_Node_Subtree
(Standard_Package_Node
);
1497 if Debug_Flag_T
then
1498 Debug_Flag_T
:= False;
1501 Write_Str
("Tree created for ");
1502 Write_Unit_Name
(Unit_Name
(Main_Unit
));
1504 Print_Node_Subtree
(Cunit
(Main_Unit
));
1514 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1517 S
: constant Nat
:= Serial_Number
(Int
(E
));
1520 -- In marking phase, return if already marked, otherwise set next
1521 -- serial number in hash table for later reference.
1523 if Phase
= Marking
then
1525 return; -- already visited
1530 -- In printing phase, if already printed, then return, otherwise we
1531 -- are printing the next item, so increment the serial number.
1534 if S
< Next_Serial_Number
then
1535 return; -- already printed
1537 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1541 -- Now process the list (Print calls have no effect in marking phase)
1543 Print_Str
(Prefix_Str
);
1544 Print_Elist_Ref
(E
);
1547 if Is_Empty_Elmt_List
(E
) then
1548 Print_Str
(Prefix_Str
);
1549 Print_Str
("(Empty element list)");
1554 if Phase
= Printing
then
1555 M
:= First_Elmt
(E
);
1556 while Present
(M
) loop
1558 Print_Str
(Prefix_Str
);
1565 Print_Str
(Prefix_Str
);
1569 M
:= First_Elmt
(E
);
1570 while Present
(M
) loop
1571 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1581 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1583 S
: constant Nat
:= Serial_Number
(Int
(L
));
1586 -- In marking phase, return if already marked, otherwise set next
1587 -- serial number in hash table for later reference.
1589 if Phase
= Marking
then
1596 -- In printing phase, if already printed, then return, otherwise we
1597 -- are printing the next item, so increment the serial number.
1600 if S
< Next_Serial_Number
then
1601 return; -- already printed
1603 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1607 -- Now process the list (Print calls have no effect in marking phase)
1609 Print_Str
(Prefix_Str
);
1613 Print_Str
(Prefix_Str
);
1614 Print_Str
("|Parent = ");
1615 Print_Node_Ref
(Parent
(L
));
1621 Print_Str
(Prefix_Str
);
1622 Print_Str
("(Empty list)");
1627 Print_Str
(Prefix_Str
);
1631 while Next
(N
) /= Empty
loop
1632 Visit_Node
(N
, Prefix_Str
, '|');
1637 Visit_Node
(N
, Prefix_Str
, ' ');
1644 procedure Visit_Node
1646 Prefix_Str
: String;
1647 Prefix_Char
: Character)
1649 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
1650 -- Prefix string for printing referenced fields
1652 procedure Visit_Descendent
1654 No_Indent
: Boolean := False);
1655 -- This procedure tests the given value of one of the Fields referenced
1656 -- by the current node to determine whether to visit it recursively.
1657 -- Normally No_Indent is false, which means that the visited node will
1658 -- be indented using New_Prefix. If No_Indent is set to True, then
1659 -- this indentation is skipped, and Prefix_Str is used for the call
1660 -- to print the descendent. No_Indent is effective only if the
1661 -- referenced descendent is a node.
1663 ----------------------
1664 -- Visit_Descendent --
1665 ----------------------
1667 procedure Visit_Descendent
1669 No_Indent
: Boolean := False)
1672 -- Case of descendent is a node
1674 if D
in Node_Range
then
1676 -- Don't bother about Empty or Error descendents
1678 if D
<= Union_Id
(Empty_Or_Error
) then
1683 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
1686 -- Descendents in one of the standardly compiled internal
1687 -- packages are normally ignored, unless the parent is also
1688 -- in such a package (happens when Standard itself is output)
1689 -- or if the -df switch is set which causes all links to be
1690 -- followed, even into package standard.
1692 if Sloc
(Nod
) <= Standard_Location
then
1693 if Sloc
(N
) > Standard_Location
1694 and then not Debug_Flag_F
1699 -- Don't bother about a descendent in a different unit than
1700 -- the node we came from unless the -df switch is set. Note
1701 -- that we know at this point that Sloc (D) > Standard_Location
1703 -- Note: the tests for No_Location here just make sure that we
1704 -- don't blow up on a node which is missing an Sloc value. This
1705 -- should not normally happen.
1708 if (Sloc
(N
) <= Standard_Location
1709 or else Sloc
(N
) = No_Location
1710 or else Sloc
(Nod
) = No_Location
1711 or else not In_Same_Source_Unit
(Nod
, N
))
1712 and then not Debug_Flag_F
1718 -- Don't bother visiting a source node that has a parent which
1719 -- is not the node we came from. We prefer to trace such nodes
1720 -- from their real parents. This causes the tree to be printed
1721 -- in a more coherent order, e.g. a defining identifier listed
1722 -- next to its corresponding declaration, instead of next to
1723 -- some semantic reference.
1725 -- This test is skipped for nodes in standard packages unless
1726 -- the -dy option is set (which outputs the tree for standard)
1728 -- Also, always follow pointers to Is_Itype entities,
1729 -- since we want to list these when they are first referenced.
1731 if Parent
(Nod
) /= Empty
1732 and then Comes_From_Source
(Nod
)
1733 and then Parent
(Nod
) /= N
1734 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
1739 -- If we successfully fall through all the above tests (which
1740 -- execute a return if the node is not to be visited), we can
1741 -- go ahead and visit the node!
1744 Visit_Node
(Nod
, Prefix_Str
, Prefix_Char
);
1746 Visit_Node
(Nod
, New_Prefix
, ' ');
1750 -- Case of descendent is a list
1752 elsif D
in List_Range
then
1754 -- Don't bother with a missing list, empty list or error list
1756 if D
= Union_Id
(No_List
)
1757 or else D
= Union_Id
(Error_List
)
1758 or else Is_Empty_List
(List_Id
(D
))
1762 -- Otherwise we can visit the list. Note that we don't bother
1763 -- to do the parent test that we did for the node case, because
1764 -- it just does not happen that lists are referenced more than
1765 -- one place in the tree. We aren't counting on this being the
1766 -- case to generate valid output, it is just that we don't need
1767 -- in practice to worry about listing the list at a place that
1771 Visit_List
(List_Id
(D
), New_Prefix
);
1774 -- Case of descendent is an element list
1776 elsif D
in Elist_Range
then
1778 -- Don't bother with a missing list, or an empty list
1780 if D
= Union_Id
(No_Elist
)
1781 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
1785 -- Otherwise, visit the referenced element list
1788 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
1791 -- For all other kinds of descendents (strings, names, uints etc),
1792 -- there is nothing to visit (the contents of the field will be
1793 -- printed when we print the containing node, but what concerns
1794 -- us now is looking for descendents in the tree.
1799 end Visit_Descendent
;
1801 -- Start of processing for Visit_Node
1808 -- Set fatal error node in case we get a blow up during the trace
1810 Current_Error_Node
:= N
;
1812 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
1813 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
1814 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
1816 -- In the marking phase, all we do is to set the serial number
1818 if Phase
= Marking
then
1819 if Serial_Number
(Int
(N
)) /= 0 then
1820 return; -- already visited
1825 -- In the printing phase, we print the node
1828 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
1830 -- Here we have already visited the node, but if it is in
1831 -- a list, we still want to print the reference, so that
1832 -- it is clear that it belongs to the list.
1834 if Is_List_Member
(N
) then
1835 Print_Str
(Prefix_Str
);
1838 Print_Str
(Prefix_Str
);
1839 Print_Char
(Prefix_Char
);
1840 Print_Str
("(already output)");
1842 Print_Str
(Prefix_Str
);
1843 Print_Char
(Prefix_Char
);
1850 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
1851 Print_Str
(Prefix_Str
);
1852 Print_Char
(Prefix_Char
);
1854 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1858 -- Visit all descendents of this node
1860 if Nkind
(N
) not in N_Entity
then
1861 Visit_Descendent
(Field1
(N
));
1862 Visit_Descendent
(Field2
(N
));
1863 Visit_Descendent
(Field3
(N
));
1864 Visit_Descendent
(Field4
(N
));
1865 Visit_Descendent
(Field5
(N
));
1870 Visit_Descendent
(Field1
(N
));
1871 Visit_Descendent
(Field3
(N
));
1872 Visit_Descendent
(Field4
(N
));
1873 Visit_Descendent
(Field5
(N
));
1874 Visit_Descendent
(Field6
(N
));
1875 Visit_Descendent
(Field7
(N
));
1876 Visit_Descendent
(Field8
(N
));
1877 Visit_Descendent
(Field9
(N
));
1878 Visit_Descendent
(Field10
(N
));
1879 Visit_Descendent
(Field11
(N
));
1880 Visit_Descendent
(Field12
(N
));
1881 Visit_Descendent
(Field13
(N
));
1882 Visit_Descendent
(Field14
(N
));
1883 Visit_Descendent
(Field15
(N
));
1884 Visit_Descendent
(Field16
(N
));
1885 Visit_Descendent
(Field17
(N
));
1886 Visit_Descendent
(Field18
(N
));
1887 Visit_Descendent
(Field19
(N
));
1888 Visit_Descendent
(Field20
(N
));
1889 Visit_Descendent
(Field21
(N
));
1890 Visit_Descendent
(Field22
(N
));
1891 Visit_Descendent
(Field23
(N
));
1893 -- Now an interesting kludge. Normally parents are always printed
1894 -- since we traverse the tree in a downwards direction. There is
1895 -- however an exception to this rule, which is the case where a
1896 -- parent is constructed by the compiler and is not referenced
1897 -- elsewhere in the tree. The following catches this case
1899 if not Comes_From_Source
(N
) then
1900 Visit_Descendent
(Union_Id
(Parent
(N
)));
1903 -- You may be wondering why we omitted Field2 above. The answer
1904 -- is that this is the Next_Entity field, and we want to treat
1905 -- it rather specially. Why? Because a Next_Entity link does not
1906 -- correspond to a level deeper in the tree, and we do not want
1907 -- the tree to march off to the right of the page due to bogus
1908 -- indentations coming from this effect.
1910 -- To prevent this, what we do is to control references via
1911 -- Next_Entity only from the first entity on a given scope
1912 -- chain, and we keep them all at the same level. Of course
1913 -- if an entity has already been referenced it is not printed.
1915 if Present
(Next_Entity
(N
))
1916 and then Present
(Scope
(N
))
1917 and then First_Entity
(Scope
(N
)) = N
1924 while Present
(Nod
) loop
1925 Visit_Descendent
(Union_Id
(Next_Entity
(Nod
)));
1926 Nod
:= Next_Entity
(Nod
);