1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2004 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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 with Atree
; use Atree
;
28 with Csets
; use Csets
;
29 with Debug
; use Debug
;
30 with Einfo
; use Einfo
;
31 with Elists
; use Elists
;
33 with Namet
; use Namet
;
34 with Nlists
; use Nlists
;
35 with Output
; use Output
;
36 with Sem_Mech
; use Sem_Mech
;
37 with Sinfo
; use Sinfo
;
38 with Snames
; use Snames
;
39 with Sinput
; use Sinput
;
40 with Stand
; use Stand
;
41 with Stringt
; use Stringt
;
42 with Treeprs
; use Treeprs
;
43 with Uintp
; use Uintp
;
44 with Urealp
; use Urealp
;
45 with Uname
; use Uname
;
46 with Unchecked_Deallocation
;
48 package body Treepr
is
50 use Atree
.Unchecked_Access
;
51 -- This module uses the unchecked access functions in package Atree
52 -- since it does an untyped traversal of the tree (we do not want to
53 -- count on the structure of the tree being correct in this routine!)
55 ----------------------------------
56 -- Approach Used for Tree Print --
57 ----------------------------------
59 -- When a complete subtree is being printed, a trace phase first marks
60 -- the nodes and lists to be printed. This trace phase allocates logical
61 -- numbers corresponding to the order in which the nodes and lists will
62 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
63 -- logical node numbers using a hash table. Output is done using a set
64 -- of Print_xxx routines, which are similar to the Write_xxx routines
65 -- with the same name, except that they do not generate any output in
66 -- the marking phase. This allows identical logic to be used in the
69 -- Note that the hash table not only holds the serial numbers, but also
70 -- acts as a record of which nodes have already been visited. In the
71 -- marking phase, a node has been visited if it is already in the hash
72 -- table, and in the printing phase, we can tell whether a node has
73 -- already been printed by looking at the value of the serial number.
75 ----------------------
76 -- Global Variables --
77 ----------------------
79 type Hash_Record
is record
81 -- Serial number for hash table entry. A value of zero means that
82 -- the entry is currently unused.
85 -- If serial number field is non-zero, contains corresponding Id value
88 type Hash_Table_Type
is array (Nat
range <>) of Hash_Record
;
89 type Access_Hash_Table_Type
is access Hash_Table_Type
;
90 Hash_Table
: Access_Hash_Table_Type
;
91 -- The hash table itself, see Serial_Number function for details of use
94 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
95 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
97 Next_Serial_Number
: Nat
;
98 -- Number of last visited node or list. Used during the marking phase to
99 -- set proper node numbers in the hash table, and during the printing
100 -- phase to make sure that a given node is not printed more than once.
101 -- (nodes are printed in order during the printing phase, that's the
102 -- point of numbering them in the first place!)
104 Printing_Descendants
: Boolean;
105 -- True if descendants are being printed, False if not. In the false case,
106 -- only node Id's are printed. In the true case, node numbers as well as
107 -- node Id's are printed, as described above.
109 type Phase_Type
is (Marking
, Printing
);
110 -- Type for Phase variable
113 -- When an entire tree is being printed, the traversal operates in two
114 -- phases. The first phase marks the nodes in use by installing node
115 -- numbers in the node number table. The second phase prints the nodes.
116 -- This variable indicates the current phase.
118 ----------------------
119 -- Local Procedures --
120 ----------------------
122 procedure Print_End_Span
(N
: Node_Id
);
123 -- Special routine to print contents of End_Span field of node N.
124 -- The format includes the implicit source location as well as the
125 -- value of the field.
127 procedure Print_Init
;
128 -- Initialize for printing of tree with descendents
130 procedure Print_Term
;
131 -- Clean up after printing of tree with descendents
133 procedure Print_Char
(C
: Character);
134 -- Print character C if currently in print phase, noop if in marking phase
136 procedure Print_Name
(N
: Name_Id
);
137 -- Print name from names table if currently in print phase, noop if in
138 -- marking phase. Note that the name is output in mixed case mode.
140 procedure Print_Node_Kind
(N
: Node_Id
);
141 -- Print node kind name in mixed case if in print phase, noop if in
144 procedure Print_Str
(S
: String);
145 -- Print string S if currently in print phase, noop if in marking phase
147 procedure Print_Str_Mixed_Case
(S
: String);
148 -- Like Print_Str, except that the string is printed in mixed case mode
150 procedure Print_Int
(I
: Int
);
151 -- Print integer I if currently in print phase, noop if in marking phase
154 -- Print end of line if currently in print phase, noop if in marking phase
156 procedure Print_Node_Ref
(N
: Node_Id
);
157 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
158 -- in the latter case, including the Id and the Nkind of the node.
160 procedure Print_List_Ref
(L
: List_Id
);
161 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
163 procedure Print_Elist_Ref
(E
: Elist_Id
);
164 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
166 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
167 -- Called if the node being printed is an entity. Prints fields from the
168 -- extension, using routines in Einfo to get the field names and flags.
170 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
171 -- Print representation of Field value (name, tree, string, uint, charcode)
172 -- The format parameter controls the format of printing in the case of an
173 -- integer value (see UI_Write for details).
175 procedure Print_Flag
(F
: Boolean);
176 -- Print True or False
181 Prefix_Char
: Character);
182 -- This is the internal routine used to print a single node. Each line of
183 -- output is preceded by Prefix_Str (which is used to set the indentation
184 -- level and the bars used to link list elements). In addition, for lines
185 -- other than the first, an additional character Prefix_Char is output.
187 function Serial_Number
(Id
: Int
) return Nat
;
188 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
189 -- serial number, or zero if no serial number has yet been assigned.
191 procedure Set_Serial_Number
;
192 -- Can be called only immediately following a call to Serial_Number that
193 -- returned a value of zero. Causes the value of Next_Serial_Number to be
194 -- placed in the hash table (corresponding to the Id argument used in the
195 -- Serial_Number call), and increments Next_Serial_Number.
200 Prefix_Char
: Character);
201 -- Called to process a single node in the case where descendents are to
202 -- be printed before every line, and Prefix_Char added to all lines
203 -- except the header line for the node.
205 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
206 -- Visit_List is called to process a list in the case where descendents
207 -- are to be printed. Prefix_Str is to be added to all printed lines.
209 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
210 -- Visit_Elist is called to process an element list in the case where
211 -- descendents are to be printed. Prefix_Str is to be added to all
218 procedure pe
(E
: Elist_Id
) is
220 Print_Tree_Elist
(E
);
227 procedure pl
(L
: List_Id
) is
236 procedure pn
(N
: Node_Id
) is
245 procedure Print_Char
(C
: Character) is
247 if Phase
= Printing
then
252 ---------------------
253 -- Print_Elist_Ref --
254 ---------------------
256 procedure Print_Elist_Ref
(E
: Elist_Id
) is
258 if Phase
/= Printing
then
263 Write_Str
("<no elist>");
265 elsif Is_Empty_Elmt_List
(E
) then
266 Write_Str
("Empty elist, (Elist_Id=");
271 Write_Str
("(Elist_Id=");
275 if Printing_Descendants
then
277 Write_Int
(Serial_Number
(Int
(E
)));
282 -------------------------
283 -- Print_Elist_Subtree --
284 -------------------------
286 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
290 Next_Serial_Number
:= 1;
294 Next_Serial_Number
:= 1;
299 end Print_Elist_Subtree
;
305 procedure Print_End_Span
(N
: Node_Id
) is
306 Val
: constant Uint
:= End_Span
(N
);
310 Write_Str
(" (Uint = ");
311 Write_Int
(Int
(Field5
(N
)));
314 if Val
/= No_Uint
then
315 Write_Location
(End_Location
(N
));
319 -----------------------
320 -- Print_Entity_Info --
321 -----------------------
323 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
324 function Field_Present
(U
: Union_Id
) return Boolean;
325 -- Returns False unless the value U represents a missing value
326 -- (Empty, No_Uint, No_Ureal or No_String)
328 function Field_Present
(U
: Union_Id
) return Boolean is
331 U
/= Union_Id
(Empty
) and then
332 U
/= To_Union
(No_Uint
) and then
333 U
/= To_Union
(No_Ureal
) and then
334 U
/= Union_Id
(No_String
);
337 -- Start of processing for Print_Entity_Info
341 Print_Str
("Ekind = ");
342 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
346 Print_Str
("Etype = ");
347 Print_Node_Ref
(Etype
(Ent
));
350 if Convention
(Ent
) /= Convention_Ada
then
352 Print_Str
("Convention = ");
354 -- Print convention name skipping the Convention_ at the start
357 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
360 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
365 if Field_Present
(Field6
(Ent
)) then
367 Write_Field6_Name
(Ent
);
369 Print_Field
(Field6
(Ent
));
373 if Field_Present
(Field7
(Ent
)) then
375 Write_Field7_Name
(Ent
);
377 Print_Field
(Field7
(Ent
));
381 if Field_Present
(Field8
(Ent
)) then
383 Write_Field8_Name
(Ent
);
385 Print_Field
(Field8
(Ent
));
389 if Field_Present
(Field9
(Ent
)) then
391 Write_Field9_Name
(Ent
);
393 Print_Field
(Field9
(Ent
));
397 if Field_Present
(Field10
(Ent
)) then
399 Write_Field10_Name
(Ent
);
401 Print_Field
(Field10
(Ent
));
405 if Field_Present
(Field11
(Ent
)) then
407 Write_Field11_Name
(Ent
);
409 Print_Field
(Field11
(Ent
));
413 if Field_Present
(Field12
(Ent
)) then
415 Write_Field12_Name
(Ent
);
417 Print_Field
(Field12
(Ent
));
421 if Field_Present
(Field13
(Ent
)) then
423 Write_Field13_Name
(Ent
);
425 Print_Field
(Field13
(Ent
));
429 if Field_Present
(Field14
(Ent
)) then
431 Write_Field14_Name
(Ent
);
433 Print_Field
(Field14
(Ent
));
437 if Field_Present
(Field15
(Ent
)) then
439 Write_Field15_Name
(Ent
);
441 Print_Field
(Field15
(Ent
));
445 if Field_Present
(Field16
(Ent
)) then
447 Write_Field16_Name
(Ent
);
449 Print_Field
(Field16
(Ent
));
453 if Field_Present
(Field17
(Ent
)) then
455 Write_Field17_Name
(Ent
);
457 Print_Field
(Field17
(Ent
));
461 if Field_Present
(Field18
(Ent
)) then
463 Write_Field18_Name
(Ent
);
465 Print_Field
(Field18
(Ent
));
469 if Field_Present
(Field19
(Ent
)) then
471 Write_Field19_Name
(Ent
);
473 Print_Field
(Field19
(Ent
));
477 if Field_Present
(Field20
(Ent
)) then
479 Write_Field20_Name
(Ent
);
481 Print_Field
(Field20
(Ent
));
485 if Field_Present
(Field21
(Ent
)) then
487 Write_Field21_Name
(Ent
);
489 Print_Field
(Field21
(Ent
));
493 if Field_Present
(Field22
(Ent
)) then
495 Write_Field22_Name
(Ent
);
498 -- Mechanism case has to be handled specially
500 if Ekind
(Ent
) = E_Function
or else Is_Formal
(Ent
) then
502 M
: constant Mechanism_Type
:= Mechanism
(Ent
);
506 when Default_Mechanism
=> Write_Str
("Default");
507 when By_Copy
=> Write_Str
("By_Copy");
508 when By_Reference
=> Write_Str
("By_Reference");
509 when By_Descriptor
=> Write_Str
("By_Descriptor");
510 when By_Descriptor_UBS
=> Write_Str
("By_Descriptor_UBS");
511 when By_Descriptor_UBSB
=> Write_Str
("By_Descriptor_UBSB");
512 when By_Descriptor_UBA
=> Write_Str
("By_Descriptor_UBA");
513 when By_Descriptor_S
=> Write_Str
("By_Descriptor_S");
514 when By_Descriptor_SB
=> Write_Str
("By_Descriptor_SB");
515 when By_Descriptor_A
=> Write_Str
("By_Descriptor_A");
516 when By_Descriptor_NCA
=> Write_Str
("By_Descriptor_NCA");
518 when 1 .. Mechanism_Type
'Last =>
519 Write_Str
("By_Copy if size <= ");
525 -- Normal case (not Mechanism)
528 Print_Field
(Field22
(Ent
));
534 if Field_Present
(Field23
(Ent
)) then
536 Write_Field23_Name
(Ent
);
538 Print_Field
(Field23
(Ent
));
542 if Field_Present
(Field24
(Ent
)) then
544 Write_Field24_Name
(Ent
);
546 Print_Field
(Field24
(Ent
));
550 if Field_Present
(Field25
(Ent
)) then
552 Write_Field25_Name
(Ent
);
554 Print_Field
(Field25
(Ent
));
558 if Field_Present
(Field26
(Ent
)) then
560 Write_Field26_Name
(Ent
);
562 Print_Field
(Field26
(Ent
));
566 if Field_Present
(Field27
(Ent
)) then
568 Write_Field27_Name
(Ent
);
570 Print_Field
(Field27
(Ent
));
574 Write_Entity_Flags
(Ent
, Prefix
);
575 end Print_Entity_Info
;
581 procedure Print_Eol
is
583 if Phase
= Printing
then
592 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
594 if Phase
/= Printing
then
598 if Val
in Node_Range
then
599 Print_Node_Ref
(Node_Id
(Val
));
601 elsif Val
in List_Range
then
602 Print_List_Ref
(List_Id
(Val
));
604 elsif Val
in Elist_Range
then
605 Print_Elist_Ref
(Elist_Id
(Val
));
607 elsif Val
in Names_Range
then
608 Print_Name
(Name_Id
(Val
));
609 Write_Str
(" (Name_Id=");
610 Write_Int
(Int
(Val
));
613 elsif Val
in Strings_Range
then
614 Write_String_Table_Entry
(String_Id
(Val
));
615 Write_Str
(" (String_Id=");
616 Write_Int
(Int
(Val
));
619 elsif Val
in Uint_Range
then
620 UI_Write
(From_Union
(Val
), Format
);
621 Write_Str
(" (Uint = ");
622 Write_Int
(Int
(Val
));
625 elsif Val
in Ureal_Range
then
626 UR_Write
(From_Union
(Val
));
627 Write_Str
(" (Ureal = ");
628 Write_Int
(Int
(Val
));
631 elsif Val
in Char_Code_Range
then
632 Write_Str
("Character code = ");
635 C
: constant Char_Code
:= Char_Code
(Val
- Char_Code_Bias
);
645 Print_Str
("****** Incorrect value = ");
646 Print_Int
(Int
(Val
));
654 procedure Print_Flag
(F
: Boolean) is
667 procedure Print_Init
is
669 Printing_Descendants
:= True;
672 -- Allocate and clear serial number hash table. The size is 150% of
673 -- the maximum possible number of entries, so that the hash table
674 -- cannot get significantly overloaded.
676 Hash_Table_Len
:= (150 * (Num_Nodes
+ Num_Lists
+ Num_Elists
)) / 100;
677 Hash_Table
:= new Hash_Table_Type
(0 .. Hash_Table_Len
- 1);
679 for J
in Hash_Table
'Range loop
680 Hash_Table
(J
).Serial
:= 0;
689 procedure Print_Int
(I
: Int
) is
691 if Phase
= Printing
then
700 procedure Print_List_Ref
(L
: List_Id
) is
702 if Phase
/= Printing
then
707 Write_Str
("<no list>");
709 elsif Is_Empty_List
(L
) then
710 Write_Str
("<empty list> (List_Id=");
717 if Printing_Descendants
then
719 Write_Int
(Serial_Number
(Int
(L
)));
722 Write_Str
(" (List_Id=");
728 ------------------------
729 -- Print_List_Subtree --
730 ------------------------
732 procedure Print_List_Subtree
(L
: List_Id
) is
736 Next_Serial_Number
:= 1;
740 Next_Serial_Number
:= 1;
745 end Print_List_Subtree
;
751 procedure Print_Name
(N
: Name_Id
) is
753 if Phase
= Printing
then
755 Print_Str
("<No_Name>");
757 elsif N
= Error_Name
then
758 Print_Str
("<Error_Name>");
776 Prefix_Char
: Character)
779 P
: Natural := Pchar_Pos
(Nkind
(N
));
781 Field_To_Be_Printed
: Boolean;
782 Prefix_Str_Char
: String (Prefix_Str
'First .. Prefix_Str
'Last + 1);
784 Sfile
: Source_File_Index
;
789 if Phase
/= Printing
then
793 if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
) then
799 Prefix_Str_Char
(Prefix_Str
'Range) := Prefix_Str
;
800 Prefix_Str_Char
(Prefix_Str
'Last + 1) := Prefix_Char
;
804 Print_Str
(Prefix_Str
);
809 if Comes_From_Source
(N
) then
811 Print_Str
(" (source");
822 Print_Str
("analyzed");
825 if Error_Posted
(N
) then
833 Print_Str
("posted");
842 if Is_Rewrite_Substitution
(N
) then
843 Print_Str
(Prefix_Str
);
844 Print_Str
(" Rewritten: original node = ");
845 Print_Node_Ref
(Original_Node
(N
));
853 if not Is_List_Member
(N
) then
854 Print_Str
(Prefix_Str
);
855 Print_Str
(" Parent = ");
856 Print_Node_Ref
(Parent
(N
));
860 -- Print Sloc field if it is set
862 if Sloc
(N
) /= No_Location
then
863 Print_Str
(Prefix_Str_Char
);
864 Print_Str
("Sloc = ");
866 if Sloc
(N
) = Standard_Location
then
867 Print_Str
("Standard_Location");
869 elsif Sloc
(N
) = Standard_ASCII_Location
then
870 Print_Str
("Standard_ASCII_Location");
873 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
874 Print_Int
(Int
(Sloc
(N
)) - Int
(Source_Text
(Sfile
)'First));
876 Write_Location
(Sloc
(N
));
882 -- Print Chars field if present
884 if Nkind
(N
) in N_Has_Chars
and then Chars
(N
) /= No_Name
then
885 Print_Str
(Prefix_Str_Char
);
886 Print_Str
("Chars = ");
887 Print_Name
(Chars
(N
));
888 Write_Str
(" (Name_Id=");
889 Write_Int
(Int
(Chars
(N
)));
894 -- Special field print operations for non-entity nodes
896 if Nkind
(N
) not in N_Entity
then
898 -- Deal with Left_Opnd and Right_Opnd fields
901 or else Nkind
(N
) = N_And_Then
902 or else Nkind
(N
) = N_In
903 or else Nkind
(N
) = N_Not_In
904 or else Nkind
(N
) = N_Or_Else
906 -- Print Left_Opnd if present
908 if Nkind
(N
) not in N_Unary_Op
then
909 Print_Str
(Prefix_Str_Char
);
910 Print_Str
("Left_Opnd = ");
911 Print_Node_Ref
(Left_Opnd
(N
));
917 Print_Str
(Prefix_Str_Char
);
918 Print_Str
("Right_Opnd = ");
919 Print_Node_Ref
(Right_Opnd
(N
));
923 -- Print Entity field if operator (other cases of Entity
924 -- are in the table, so are handled in the normal circuit)
926 if Nkind
(N
) in N_Op
and then Present
(Entity
(N
)) then
927 Print_Str
(Prefix_Str_Char
);
928 Print_Str
("Entity = ");
929 Print_Node_Ref
(Entity
(N
));
933 -- Print special fields if we have a subexpression
935 if Nkind
(N
) in N_Subexpr
then
937 if Assignment_OK
(N
) then
938 Print_Str
(Prefix_Str_Char
);
939 Print_Str
("Assignment_OK = True");
943 if Do_Range_Check
(N
) then
944 Print_Str
(Prefix_Str_Char
);
945 Print_Str
("Do_Range_Check = True");
949 if Has_Dynamic_Length_Check
(N
) then
950 Print_Str
(Prefix_Str_Char
);
951 Print_Str
("Has_Dynamic_Length_Check = True");
955 if Has_Dynamic_Range_Check
(N
) then
956 Print_Str
(Prefix_Str_Char
);
957 Print_Str
("Has_Dynamic_Range_Check = True");
961 if Is_Controlling_Actual
(N
) then
962 Print_Str
(Prefix_Str_Char
);
963 Print_Str
("Is_Controlling_Actual = True");
967 if Is_Overloaded
(N
) then
968 Print_Str
(Prefix_Str_Char
);
969 Print_Str
("Is_Overloaded = True");
973 if Is_Static_Expression
(N
) then
974 Print_Str
(Prefix_Str_Char
);
975 Print_Str
("Is_Static_Expression = True");
979 if Must_Not_Freeze
(N
) then
980 Print_Str
(Prefix_Str_Char
);
981 Print_Str
("Must_Not_Freeze = True");
985 if Paren_Count
(N
) /= 0 then
986 Print_Str
(Prefix_Str_Char
);
987 Print_Str
("Paren_Count = ");
988 Print_Int
(Int
(Paren_Count
(N
)));
992 if Raises_Constraint_Error
(N
) then
993 Print_Str
(Prefix_Str_Char
);
994 Print_Str
("Raise_Constraint_Error = True");
1000 -- Print Do_Overflow_Check field if present
1002 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1003 Print_Str
(Prefix_Str_Char
);
1004 Print_Str
("Do_Overflow_Check = True");
1008 -- Print Etype field if present (printing of this field for entities
1009 -- is handled by the Print_Entity_Info procedure).
1011 if Nkind
(N
) in N_Has_Etype
1012 and then Present
(Etype
(N
))
1014 Print_Str
(Prefix_Str_Char
);
1015 Print_Str
("Etype = ");
1016 Print_Node_Ref
(Etype
(N
));
1021 -- Loop to print fields included in Pchars array
1023 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
))) loop
1027 -- Check for case of False flag, which we never print, or
1028 -- an Empty field, which is also never printed
1032 Field_To_Be_Printed
:= Field1
(N
) /= Union_Id
(Empty
);
1035 Field_To_Be_Printed
:= Field2
(N
) /= Union_Id
(Empty
);
1038 Field_To_Be_Printed
:= Field3
(N
) /= Union_Id
(Empty
);
1041 Field_To_Be_Printed
:= Field4
(N
) /= Union_Id
(Empty
);
1044 Field_To_Be_Printed
:= Field5
(N
) /= Union_Id
(Empty
);
1046 when F_Flag4
=> Field_To_Be_Printed
:= Flag4
(N
);
1047 when F_Flag5
=> Field_To_Be_Printed
:= Flag5
(N
);
1048 when F_Flag6
=> Field_To_Be_Printed
:= Flag6
(N
);
1049 when F_Flag7
=> Field_To_Be_Printed
:= Flag7
(N
);
1050 when F_Flag8
=> Field_To_Be_Printed
:= Flag8
(N
);
1051 when F_Flag9
=> Field_To_Be_Printed
:= Flag9
(N
);
1052 when F_Flag10
=> Field_To_Be_Printed
:= Flag10
(N
);
1053 when F_Flag11
=> Field_To_Be_Printed
:= Flag11
(N
);
1054 when F_Flag12
=> Field_To_Be_Printed
:= Flag12
(N
);
1055 when F_Flag13
=> Field_To_Be_Printed
:= Flag13
(N
);
1056 when F_Flag14
=> Field_To_Be_Printed
:= Flag14
(N
);
1057 when F_Flag15
=> Field_To_Be_Printed
:= Flag15
(N
);
1058 when F_Flag16
=> Field_To_Be_Printed
:= Flag16
(N
);
1059 when F_Flag17
=> Field_To_Be_Printed
:= Flag17
(N
);
1060 when F_Flag18
=> Field_To_Be_Printed
:= Flag18
(N
);
1062 -- Flag1,2,3 are no longer used
1064 when F_Flag1
=> raise Program_Error
;
1065 when F_Flag2
=> raise Program_Error
;
1066 when F_Flag3
=> raise Program_Error
;
1070 -- Print field if it is to be printed
1072 if Field_To_Be_Printed
then
1073 Print_Str
(Prefix_Str_Char
);
1075 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1076 and then Pchars
(P
) not in Fchar
1078 Print_Char
(Pchars
(P
));
1085 when F_Field1
=> Print_Field
(Field1
(N
), Fmt
);
1086 when F_Field2
=> Print_Field
(Field2
(N
), Fmt
);
1087 when F_Field3
=> Print_Field
(Field3
(N
), Fmt
);
1088 when F_Field4
=> Print_Field
(Field4
(N
), Fmt
);
1090 -- Special case End_Span = Uint5
1093 if Nkind
(N
) = N_Case_Statement
1094 or else Nkind
(N
) = N_If_Statement
1098 Print_Field
(Field5
(N
), Fmt
);
1101 when F_Flag4
=> Print_Flag
(Flag4
(N
));
1102 when F_Flag5
=> Print_Flag
(Flag5
(N
));
1103 when F_Flag6
=> Print_Flag
(Flag6
(N
));
1104 when F_Flag7
=> Print_Flag
(Flag7
(N
));
1105 when F_Flag8
=> Print_Flag
(Flag8
(N
));
1106 when F_Flag9
=> Print_Flag
(Flag9
(N
));
1107 when F_Flag10
=> Print_Flag
(Flag10
(N
));
1108 when F_Flag11
=> Print_Flag
(Flag11
(N
));
1109 when F_Flag12
=> Print_Flag
(Flag12
(N
));
1110 when F_Flag13
=> Print_Flag
(Flag13
(N
));
1111 when F_Flag14
=> Print_Flag
(Flag14
(N
));
1112 when F_Flag15
=> Print_Flag
(Flag15
(N
));
1113 when F_Flag16
=> Print_Flag
(Flag16
(N
));
1114 when F_Flag17
=> Print_Flag
(Flag17
(N
));
1115 when F_Flag18
=> Print_Flag
(Flag18
(N
));
1117 -- Flag1,2,3 are no longer used
1119 when F_Flag1
=> raise Program_Error
;
1120 when F_Flag2
=> raise Program_Error
;
1121 when F_Flag3
=> raise Program_Error
;
1126 -- Field is not to be printed (False flag field)
1129 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1130 and then Pchars
(P
) not in Fchar
1138 -- Print entity information for entities
1140 if Nkind
(N
) in N_Entity
then
1141 Print_Entity_Info
(N
, Prefix_Str_Char
);
1146 ---------------------
1147 -- Print_Node_Kind --
1148 ---------------------
1150 procedure Print_Node_Kind
(N
: Node_Id
) is
1152 S
: constant String := Node_Kind
'Image (Nkind
(N
));
1155 if Phase
= Printing
then
1158 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1159 -- bug of 'Image returning lower case instead of upper case.
1161 for J
in S
'Range loop
1163 Write_Char
(Fold_Upper
(S
(J
)));
1165 Write_Char
(Fold_Lower
(S
(J
)));
1168 Ucase
:= (S
(J
) = '_');
1171 end Print_Node_Kind
;
1173 --------------------
1174 -- Print_Node_Ref --
1175 --------------------
1177 procedure Print_Node_Ref
(N
: Node_Id
) is
1181 if Phase
/= Printing
then
1186 Write_Str
("<empty>");
1188 elsif N
= Error
then
1189 Write_Str
("<error>");
1192 if Printing_Descendants
then
1193 S
:= Serial_Number
(Int
(N
));
1203 Print_Node_Kind
(N
);
1205 if Nkind
(N
) in N_Has_Chars
then
1207 Print_Name
(Chars
(N
));
1210 if Nkind
(N
) in N_Entity
then
1211 Write_Str
(" (Entity_Id=");
1213 Write_Str
(" (Node_Id=");
1216 Write_Int
(Int
(N
));
1218 if Sloc
(N
) <= Standard_Location
then
1227 ------------------------
1228 -- Print_Node_Subtree --
1229 ------------------------
1231 procedure Print_Node_Subtree
(N
: Node_Id
) is
1235 Next_Serial_Number
:= 1;
1237 Visit_Node
(N
, "", ' ');
1239 Next_Serial_Number
:= 1;
1241 Visit_Node
(N
, "", ' ');
1244 end Print_Node_Subtree
;
1250 procedure Print_Str
(S
: String) is
1252 if Phase
= Printing
then
1257 --------------------------
1258 -- Print_Str_Mixed_Case --
1259 --------------------------
1261 procedure Print_Str_Mixed_Case
(S
: String) is
1265 if Phase
= Printing
then
1268 for J
in S
'Range loop
1272 Write_Char
(Fold_Lower
(S
(J
)));
1275 Ucase
:= (S
(J
) = '_');
1278 end Print_Str_Mixed_Case
;
1284 procedure Print_Term
is
1285 procedure Free
is new Unchecked_Deallocation
1286 (Hash_Table_Type
, Access_Hash_Table_Type
);
1292 ---------------------
1293 -- Print_Tree_Elist --
1294 ---------------------
1296 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1300 Printing_Descendants
:= False;
1303 Print_Elist_Ref
(E
);
1306 M
:= First_Elmt
(E
);
1309 Print_Str
("<empty element list>");
1316 exit when No
(Next_Elmt
(M
));
1317 Print_Node
(Node
(M
), "", '|');
1321 Print_Node
(Node
(M
), "", ' ');
1324 end Print_Tree_Elist
;
1326 ---------------------
1327 -- Print_Tree_List --
1328 ---------------------
1330 procedure Print_Tree_List
(L
: List_Id
) is
1334 Printing_Descendants
:= False;
1338 Print_Str
(" List_Id=");
1339 Print_Int
(Int
(L
));
1345 Print_Str
("<empty node list>");
1352 exit when Next
(N
) = Empty
;
1353 Print_Node
(N
, "", '|');
1357 Print_Node
(N
, "", ' ');
1360 end Print_Tree_List
;
1362 ---------------------
1363 -- Print_Tree_Node --
1364 ---------------------
1366 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1368 Printing_Descendants
:= False;
1370 Print_Node
(N
, Label
, ' ');
1371 end Print_Tree_Node
;
1377 procedure pt
(N
: Node_Id
) is
1379 Print_Node_Subtree
(N
);
1386 -- The hashing algorithm is to use the remainder of the ID value divided
1387 -- by the hash table length as the starting point in the table, and then
1388 -- handle collisions by serial searching wrapping at the end of the table.
1391 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1392 -- to save the slot that should be used if Set_Serial_Number is called.
1394 function Serial_Number
(Id
: Int
) return Nat
is
1395 H
: Int
:= Id
mod Hash_Table_Len
;
1398 while Hash_Table
(H
).Serial
/= 0 loop
1400 if Id
= Hash_Table
(H
).Id
then
1401 return Hash_Table
(H
).Serial
;
1406 if H
> Hash_Table
'Last then
1411 -- Entry was not found, save slot number for possible subsequent call
1412 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1413 -- in case of such a call (the Id field is never read if the serial
1414 -- number of the slot is zero, so this is harmless in the case where
1415 -- Set_Serial_Number is not subsequently called).
1418 Hash_Table
(H
).Id
:= Id
;
1423 -----------------------
1424 -- Set_Serial_Number --
1425 -----------------------
1427 procedure Set_Serial_Number
is
1429 Hash_Table
(Hash_Slot
).Serial
:= Next_Serial_Number
;
1430 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1431 end Set_Serial_Number
;
1437 procedure Tree_Dump
is
1438 procedure Underline
;
1439 -- Put underline under string we just printed
1441 procedure Underline
is
1442 Col
: constant Int
:= Column
;
1447 while Col
> Column
loop
1454 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1455 -- flags immediately, before starting the dump. This avoids generating two
1456 -- copies of the dump if an abort occurs after printing the dump, and more
1457 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1459 -- Note: unlike in the source print case (in Sprint), we do not output
1460 -- separate trees for each unit. Instead the -df debug switch causes the
1461 -- tree that is output from the main unit to trace references into other
1462 -- units (normally such references are not traced). Since all other units
1463 -- are linked to the main unit by at least one reference, this causes all
1464 -- tree nodes to be included in the output tree.
1467 if Debug_Flag_Y
then
1468 Debug_Flag_Y
:= False;
1470 Write_Str
("Tree created for Standard (spec) ");
1472 Print_Node_Subtree
(Standard_Package_Node
);
1476 if Debug_Flag_T
then
1477 Debug_Flag_T
:= False;
1480 Write_Str
("Tree created for ");
1481 Write_Unit_Name
(Unit_Name
(Main_Unit
));
1483 Print_Node_Subtree
(Cunit
(Main_Unit
));
1493 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1496 S
: constant Nat
:= Serial_Number
(Int
(E
));
1499 -- In marking phase, return if already marked, otherwise set next
1500 -- serial number in hash table for later reference.
1502 if Phase
= Marking
then
1504 return; -- already visited
1509 -- In printing phase, if already printed, then return, otherwise we
1510 -- are printing the next item, so increment the serial number.
1513 if S
< Next_Serial_Number
then
1514 return; -- already printed
1516 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1520 -- Now process the list (Print calls have no effect in marking phase)
1522 Print_Str
(Prefix_Str
);
1523 Print_Elist_Ref
(E
);
1526 if Is_Empty_Elmt_List
(E
) then
1527 Print_Str
(Prefix_Str
);
1528 Print_Str
("(Empty element list)");
1533 if Phase
= Printing
then
1534 M
:= First_Elmt
(E
);
1535 while Present
(M
) loop
1537 Print_Str
(Prefix_Str
);
1544 Print_Str
(Prefix_Str
);
1548 M
:= First_Elmt
(E
);
1549 while Present
(M
) loop
1550 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1560 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1562 S
: constant Nat
:= Serial_Number
(Int
(L
));
1565 -- In marking phase, return if already marked, otherwise set next
1566 -- serial number in hash table for later reference.
1568 if Phase
= Marking
then
1575 -- In printing phase, if already printed, then return, otherwise we
1576 -- are printing the next item, so increment the serial number.
1579 if S
< Next_Serial_Number
then
1580 return; -- already printed
1582 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1586 -- Now process the list (Print calls have no effect in marking phase)
1588 Print_Str
(Prefix_Str
);
1592 Print_Str
(Prefix_Str
);
1593 Print_Str
("|Parent = ");
1594 Print_Node_Ref
(Parent
(L
));
1600 Print_Str
(Prefix_Str
);
1601 Print_Str
("(Empty list)");
1606 Print_Str
(Prefix_Str
);
1610 while Next
(N
) /= Empty
loop
1611 Visit_Node
(N
, Prefix_Str
, '|');
1616 Visit_Node
(N
, Prefix_Str
, ' ');
1623 procedure Visit_Node
1625 Prefix_Str
: String;
1626 Prefix_Char
: Character)
1628 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
1629 -- Prefix string for printing referenced fields
1631 procedure Visit_Descendent
1633 No_Indent
: Boolean := False);
1634 -- This procedure tests the given value of one of the Fields referenced
1635 -- by the current node to determine whether to visit it recursively.
1636 -- Normally No_Indent is false, which means tha the visited node will
1637 -- be indented using New_Prefix. If No_Indent is set to True, then
1638 -- this indentation is skipped, and Prefix_Str is used for the call
1639 -- to print the descendent. No_Indent is effective only if the
1640 -- referenced descendent is a node.
1642 ----------------------
1643 -- Visit_Descendent --
1644 ----------------------
1646 procedure Visit_Descendent
1648 No_Indent
: Boolean := False)
1651 -- Case of descendent is a node
1653 if D
in Node_Range
then
1655 -- Don't bother about Empty or Error descendents
1657 if D
<= Union_Id
(Empty_Or_Error
) then
1662 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
1665 -- Descendents in one of the standardly compiled internal
1666 -- packages are normally ignored, unless the parent is also
1667 -- in such a package (happens when Standard itself is output)
1668 -- or if the -df switch is set which causes all links to be
1669 -- followed, even into package standard.
1671 if Sloc
(Nod
) <= Standard_Location
then
1672 if Sloc
(N
) > Standard_Location
1673 and then not Debug_Flag_F
1678 -- Don't bother about a descendent in a different unit than
1679 -- the node we came from unless the -df switch is set. Note
1680 -- that we know at this point that Sloc (D) > Standard_Location
1682 -- Note: the tests for No_Location here just make sure that we
1683 -- don't blow up on a node which is missing an Sloc value. This
1684 -- should not normally happen.
1687 if (Sloc
(N
) <= Standard_Location
1688 or else Sloc
(N
) = No_Location
1689 or else Sloc
(Nod
) = No_Location
1690 or else not In_Same_Source_Unit
(Nod
, N
))
1691 and then not Debug_Flag_F
1697 -- Don't bother visiting a source node that has a parent which
1698 -- is not the node we came from. We prefer to trace such nodes
1699 -- from their real parents. This causes the tree to be printed
1700 -- in a more coherent order, e.g. a defining identifier listed
1701 -- next to its corresponding declaration, instead of next to
1702 -- some semantic reference.
1704 -- This test is skipped for nodes in standard packages unless
1705 -- the -dy option is set (which outputs the tree for standard)
1707 -- Also, always follow pointers to Is_Itype entities,
1708 -- since we want to list these when they are first referenced.
1710 if Parent
(Nod
) /= Empty
1711 and then Comes_From_Source
(Nod
)
1712 and then Parent
(Nod
) /= N
1713 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
1718 -- If we successfully fall through all the above tests (which
1719 -- execute a return if the node is not to be visited), we can
1720 -- go ahead and visit the node!
1723 Visit_Node
(Nod
, Prefix_Str
, Prefix_Char
);
1725 Visit_Node
(Nod
, New_Prefix
, ' ');
1729 -- Case of descendent is a list
1731 elsif D
in List_Range
then
1733 -- Don't bother with a missing list, empty list or error list
1735 if D
= Union_Id
(No_List
)
1736 or else D
= Union_Id
(Error_List
)
1737 or else Is_Empty_List
(List_Id
(D
))
1741 -- Otherwise we can visit the list. Note that we don't bother
1742 -- to do the parent test that we did for the node case, because
1743 -- it just does not happen that lists are referenced more than
1744 -- one place in the tree. We aren't counting on this being the
1745 -- case to generate valid output, it is just that we don't need
1746 -- in practice to worry about listing the list at a place that
1750 Visit_List
(List_Id
(D
), New_Prefix
);
1753 -- Case of descendent is an element list
1755 elsif D
in Elist_Range
then
1757 -- Don't bother with a missing list, or an empty list
1759 if D
= Union_Id
(No_Elist
)
1760 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
1764 -- Otherwise, visit the referenced element list
1767 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
1770 -- For all other kinds of descendents (strings, names, uints etc),
1771 -- there is nothing to visit (the contents of the field will be
1772 -- printed when we print the containing node, but what concerns
1773 -- us now is looking for descendents in the tree.
1778 end Visit_Descendent
;
1780 -- Start of processing for Visit_Node
1787 -- Set fatal error node in case we get a blow up during the trace
1789 Current_Error_Node
:= N
;
1791 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
1792 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
1793 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
1795 -- In the marking phase, all we do is to set the serial number
1797 if Phase
= Marking
then
1798 if Serial_Number
(Int
(N
)) /= 0 then
1799 return; -- already visited
1804 -- In the printing phase, we print the node
1807 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
1809 -- Here we have already visited the node, but if it is in
1810 -- a list, we still want to print the reference, so that
1811 -- it is clear that it belongs to the list.
1813 if Is_List_Member
(N
) then
1814 Print_Str
(Prefix_Str
);
1817 Print_Str
(Prefix_Str
);
1818 Print_Char
(Prefix_Char
);
1819 Print_Str
("(already output)");
1821 Print_Str
(Prefix_Str
);
1822 Print_Char
(Prefix_Char
);
1829 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
1830 Print_Str
(Prefix_Str
);
1831 Print_Char
(Prefix_Char
);
1833 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1837 -- Visit all descendents of this node
1839 if Nkind
(N
) not in N_Entity
then
1840 Visit_Descendent
(Field1
(N
));
1841 Visit_Descendent
(Field2
(N
));
1842 Visit_Descendent
(Field3
(N
));
1843 Visit_Descendent
(Field4
(N
));
1844 Visit_Descendent
(Field5
(N
));
1849 Visit_Descendent
(Field1
(N
));
1850 Visit_Descendent
(Field3
(N
));
1851 Visit_Descendent
(Field4
(N
));
1852 Visit_Descendent
(Field5
(N
));
1853 Visit_Descendent
(Field6
(N
));
1854 Visit_Descendent
(Field7
(N
));
1855 Visit_Descendent
(Field8
(N
));
1856 Visit_Descendent
(Field9
(N
));
1857 Visit_Descendent
(Field10
(N
));
1858 Visit_Descendent
(Field11
(N
));
1859 Visit_Descendent
(Field12
(N
));
1860 Visit_Descendent
(Field13
(N
));
1861 Visit_Descendent
(Field14
(N
));
1862 Visit_Descendent
(Field15
(N
));
1863 Visit_Descendent
(Field16
(N
));
1864 Visit_Descendent
(Field17
(N
));
1865 Visit_Descendent
(Field18
(N
));
1866 Visit_Descendent
(Field19
(N
));
1867 Visit_Descendent
(Field20
(N
));
1868 Visit_Descendent
(Field21
(N
));
1869 Visit_Descendent
(Field22
(N
));
1870 Visit_Descendent
(Field23
(N
));
1872 -- Now an interesting kludge. Normally parents are always printed
1873 -- since we traverse the tree in a downwards direction. There is
1874 -- however an exception to this rule, which is the case where a
1875 -- parent is constructed by the compiler and is not referenced
1876 -- elsewhere in the tree. The following catches this case
1878 if not Comes_From_Source
(N
) then
1879 Visit_Descendent
(Union_Id
(Parent
(N
)));
1882 -- You may be wondering why we omitted Field2 above. The answer
1883 -- is that this is the Next_Entity field, and we want to treat
1884 -- it rather specially. Why? Because a Next_Entity link does not
1885 -- correspond to a level deeper in the tree, and we do not want
1886 -- the tree to march off to the right of the page due to bogus
1887 -- indentations coming from this effect.
1889 -- To prevent this, what we do is to control references via
1890 -- Next_Entity only from the first entity on a given scope
1891 -- chain, and we keep them all at the same level. Of course
1892 -- if an entity has already been referenced it is not printed.
1894 if Present
(Next_Entity
(N
))
1895 and then Present
(Scope
(N
))
1896 and then First_Entity
(Scope
(N
)) = N
1903 while Present
(Nod
) loop
1904 Visit_Descendent
(Union_Id
(Next_Entity
(Nod
)));
1905 Nod
:= Next_Entity
(Nod
);