1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
11 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
13 -- GNAT is free software; you can redistribute it and/or modify it under --
14 -- terms of the GNU General Public License as published by the Free Soft- --
15 -- ware Foundation; either version 2, or (at your option) any later ver- --
16 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
19 -- for more details. You should have received a copy of the GNU General --
20 -- Public License distributed with GNAT; see file COPYING. If not, write --
21 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
22 -- MA 02111-1307, USA. --
24 -- GNAT was originally developed by the GNAT team at New York University. --
25 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
27 ------------------------------------------------------------------------------
29 with Atree
; use Atree
;
30 with Csets
; use Csets
;
31 with Debug
; use Debug
;
32 with Einfo
; use Einfo
;
33 with Elists
; use Elists
;
35 with Namet
; use Namet
;
36 with Nlists
; use Nlists
;
37 with Output
; use Output
;
38 with Sem_Mech
; use Sem_Mech
;
39 with Sinfo
; use Sinfo
;
40 with Snames
; use Snames
;
41 with Sinput
; use Sinput
;
42 with Stand
; use Stand
;
43 with Stringt
; use Stringt
;
44 with Treeprs
; use Treeprs
;
45 with Uintp
; use Uintp
;
46 with Urealp
; use Urealp
;
47 with Uname
; use Uname
;
48 with Unchecked_Deallocation
;
50 package body Treepr
is
52 use Atree
.Unchecked_Access
;
53 -- This module uses the unchecked access functions in package Atree
54 -- since it does an untyped traversal of the tree (we do not want to
55 -- count on the structure of the tree being correct in this routine!)
57 ----------------------------------
58 -- Approach Used for Tree Print --
59 ----------------------------------
61 -- When a complete subtree is being printed, a trace phase first marks
62 -- the nodes and lists to be printed. This trace phase allocates logical
63 -- numbers corresponding to the order in which the nodes and lists will
64 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
65 -- logical node numbers using a hash table. Output is done using a set
66 -- of Print_xxx routines, which are similar to the Write_xxx routines
67 -- with the same name, except that they do not generate any output in
68 -- the marking phase. This allows identical logic to be used in the
71 -- Note that the hash table not only holds the serial numbers, but also
72 -- acts as a record of which nodes have already been visited. In the
73 -- marking phase, a node has been visited if it is already in the hash
74 -- table, and in the printing phase, we can tell whether a node has
75 -- already been printed by looking at the value of the serial number.
77 ----------------------
78 -- Global Variables --
79 ----------------------
81 type Hash_Record
is record
83 -- Serial number for hash table entry. A value of zero means that
84 -- the entry is currently unused.
87 -- If serial number field is non-zero, contains corresponding Id value
90 type Hash_Table_Type
is array (Nat
range <>) of Hash_Record
;
91 type Access_Hash_Table_Type
is access Hash_Table_Type
;
92 Hash_Table
: Access_Hash_Table_Type
;
93 -- The hash table itself, see Serial_Number function for details of use
96 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
97 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
99 Next_Serial_Number
: Nat
;
100 -- Number of last visited node or list. Used during the marking phase to
101 -- set proper node numbers in the hash table, and during the printing
102 -- phase to make sure that a given node is not printed more than once.
103 -- (nodes are printed in order during the printing phase, that's the
104 -- point of numbering them in the first place!)
106 Printing_Descendants
: Boolean;
107 -- True if descendants are being printed, False if not. In the false case,
108 -- only node Id's are printed. In the true case, node numbers as well as
109 -- node Id's are printed, as described above.
111 type Phase_Type
is (Marking
, Printing
);
112 -- Type for Phase variable
115 -- When an entire tree is being printed, the traversal operates in two
116 -- phases. The first phase marks the nodes in use by installing node
117 -- numbers in the node number table. The second phase prints the nodes.
118 -- This variable indicates the current phase.
120 ----------------------
121 -- Local Procedures --
122 ----------------------
124 procedure Print_End_Span
(N
: Node_Id
);
125 -- Special routine to print contents of End_Span field of node N.
126 -- The format includes the implicit source location as well as the
127 -- value of the field.
129 procedure Print_Init
;
130 -- Initialize for printing of tree with descendents
132 procedure Print_Term
;
133 -- Clean up after printing of tree with descendents
135 procedure Print_Char
(C
: Character);
136 -- Print character C if currently in print phase, noop if in marking phase
138 procedure Print_Name
(N
: Name_Id
);
139 -- Print name from names table if currently in print phase, noop if in
140 -- marking phase. Note that the name is output in mixed case mode.
142 procedure Print_Node_Kind
(N
: Node_Id
);
143 -- Print node kind name in mixed case if in print phase, noop if in
146 procedure Print_Str
(S
: String);
147 -- Print string S if currently in print phase, noop if in marking phase
149 procedure Print_Str_Mixed_Case
(S
: String);
150 -- Like Print_Str, except that the string is printed in mixed case mode
152 procedure Print_Int
(I
: Int
);
153 -- Print integer I if currently in print phase, noop if in marking phase
156 -- Print end of line if currently in print phase, noop if in marking phase
158 procedure Print_Node_Ref
(N
: Node_Id
);
159 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
160 -- in the latter case, including the Id and the Nkind of the node.
162 procedure Print_List_Ref
(L
: List_Id
);
163 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
165 procedure Print_Elist_Ref
(E
: Elist_Id
);
166 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
168 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
169 -- Called if the node being printed is an entity. Prints fields from the
170 -- extension, using routines in Einfo to get the field names and flags.
172 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
173 -- Print representation of Field value (name, tree, string, uint, charcode)
174 -- The format parameter controls the format of printing in the case of an
175 -- integer value (see UI_Write for details).
177 procedure Print_Flag
(F
: Boolean);
178 -- Print True or False
183 Prefix_Char
: Character);
184 -- This is the internal routine used to print a single node. Each line of
185 -- output is preceded by Prefix_Str (which is used to set the indentation
186 -- level and the bars used to link list elements). In addition, for lines
187 -- other than the first, an additional character Prefix_Char is output.
189 function Serial_Number
(Id
: Int
) return Nat
;
190 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
191 -- serial number, or zero if no serial number has yet been assigned.
193 procedure Set_Serial_Number
;
194 -- Can be called only immediately following a call to Serial_Number that
195 -- returned a value of zero. Causes the value of Next_Serial_Number to be
196 -- placed in the hash table (corresponding to the Id argument used in the
197 -- Serial_Number call), and increments Next_Serial_Number.
202 Prefix_Char
: Character);
203 -- Called to process a single node in the case where descendents are to
204 -- be printed before every line, and Prefix_Char added to all lines
205 -- except the header line for the node.
207 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
208 -- Visit_List is called to process a list in the case where descendents
209 -- are to be printed. Prefix_Str is to be added to all printed lines.
211 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
212 -- Visit_Elist is called to process an element list in the case where
213 -- descendents are to be printed. Prefix_Str is to be added to all
220 procedure PE
(E
: Elist_Id
) is
222 Print_Tree_Elist
(E
);
229 procedure PL
(L
: List_Id
) is
238 procedure PN
(N
: Node_Id
) is
247 procedure Print_Char
(C
: Character) is
249 if Phase
= Printing
then
254 ---------------------
255 -- Print_Elist_Ref --
256 ---------------------
258 procedure Print_Elist_Ref
(E
: Elist_Id
) is
260 if Phase
/= Printing
then
265 Write_Str
("<no elist>");
267 elsif Is_Empty_Elmt_List
(E
) then
268 Write_Str
("Empty elist, (Elist_Id=");
273 Write_Str
("(Elist_Id=");
277 if Printing_Descendants
then
279 Write_Int
(Serial_Number
(Int
(E
)));
284 -------------------------
285 -- Print_Elist_Subtree --
286 -------------------------
288 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
292 Next_Serial_Number
:= 1;
296 Next_Serial_Number
:= 1;
301 end Print_Elist_Subtree
;
307 procedure Print_End_Span
(N
: Node_Id
) is
308 Val
: constant Uint
:= End_Span
(N
);
312 Write_Str
(" (Uint = ");
313 Write_Int
(Int
(Field5
(N
)));
316 if Val
/= No_Uint
then
317 Write_Location
(End_Location
(N
));
321 -----------------------
322 -- Print_Entity_Info --
323 -----------------------
325 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
326 function Field_Present
(U
: Union_Id
) return Boolean;
327 -- Returns False unless the value U represents a missing value
328 -- (Empty, No_Uint, No_Ureal or No_String)
330 function Field_Present
(U
: Union_Id
) return Boolean is
333 U
/= Union_Id
(Empty
) and then
334 U
/= To_Union
(No_Uint
) and then
335 U
/= To_Union
(No_Ureal
) and then
336 U
/= Union_Id
(No_String
);
339 -- Start of processing for Print_Entity_Info
343 Print_Str
("Ekind = ");
344 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
348 Print_Str
("Etype = ");
349 Print_Node_Ref
(Etype
(Ent
));
352 if Convention
(Ent
) /= Convention_Ada
then
354 Print_Str
("Convention = ");
356 -- Print convention name skipping the Convention_ at the start
359 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
362 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
367 if Field_Present
(Field6
(Ent
)) then
369 Write_Field6_Name
(Ent
);
371 Print_Field
(Field6
(Ent
));
375 if Field_Present
(Field7
(Ent
)) then
377 Write_Field7_Name
(Ent
);
379 Print_Field
(Field7
(Ent
));
383 if Field_Present
(Field8
(Ent
)) then
385 Write_Field8_Name
(Ent
);
387 Print_Field
(Field8
(Ent
));
391 if Field_Present
(Field9
(Ent
)) then
393 Write_Field9_Name
(Ent
);
395 Print_Field
(Field9
(Ent
));
399 if Field_Present
(Field10
(Ent
)) then
401 Write_Field10_Name
(Ent
);
403 Print_Field
(Field10
(Ent
));
407 if Field_Present
(Field11
(Ent
)) then
409 Write_Field11_Name
(Ent
);
411 Print_Field
(Field11
(Ent
));
415 if Field_Present
(Field12
(Ent
)) then
417 Write_Field12_Name
(Ent
);
419 Print_Field
(Field12
(Ent
));
423 if Field_Present
(Field13
(Ent
)) then
425 Write_Field13_Name
(Ent
);
427 Print_Field
(Field13
(Ent
));
431 if Field_Present
(Field14
(Ent
)) then
433 Write_Field14_Name
(Ent
);
435 Print_Field
(Field14
(Ent
));
439 if Field_Present
(Field15
(Ent
)) then
441 Write_Field15_Name
(Ent
);
443 Print_Field
(Field15
(Ent
));
447 if Field_Present
(Field16
(Ent
)) then
449 Write_Field16_Name
(Ent
);
451 Print_Field
(Field16
(Ent
));
455 if Field_Present
(Field17
(Ent
)) then
457 Write_Field17_Name
(Ent
);
459 Print_Field
(Field17
(Ent
));
463 if Field_Present
(Field18
(Ent
)) then
465 Write_Field18_Name
(Ent
);
467 Print_Field
(Field18
(Ent
));
471 if Field_Present
(Field19
(Ent
)) then
473 Write_Field19_Name
(Ent
);
475 Print_Field
(Field19
(Ent
));
479 if Field_Present
(Field20
(Ent
)) then
481 Write_Field20_Name
(Ent
);
483 Print_Field
(Field20
(Ent
));
487 if Field_Present
(Field21
(Ent
)) then
489 Write_Field21_Name
(Ent
);
491 Print_Field
(Field21
(Ent
));
495 if Field_Present
(Field22
(Ent
)) then
497 Write_Field22_Name
(Ent
);
500 -- Mechanism case has to be handled specially
502 if Ekind
(Ent
) = E_Function
or else Is_Formal
(Ent
) then
504 M
: constant Mechanism_Type
:= Mechanism
(Ent
);
508 when Default_Mechanism
=> Write_Str
("Default");
509 when By_Copy
=> Write_Str
("By_Copy");
510 when By_Reference
=> Write_Str
("By_Reference");
511 when By_Descriptor
=> Write_Str
("By_Descriptor");
512 when By_Descriptor_UBS
=> Write_Str
("By_Descriptor_UBS");
513 when By_Descriptor_UBSB
=> Write_Str
("By_Descriptor_UBSB");
514 when By_Descriptor_UBA
=> Write_Str
("By_Descriptor_UBA");
515 when By_Descriptor_S
=> Write_Str
("By_Descriptor_S");
516 when By_Descriptor_SB
=> Write_Str
("By_Descriptor_SB");
517 when By_Descriptor_A
=> Write_Str
("By_Descriptor_A");
518 when By_Descriptor_NCA
=> Write_Str
("By_Descriptor_NCA");
520 when 1 .. Mechanism_Type
'Last =>
521 Write_Str
("By_Copy if size <= ");
527 -- Normal case (not Mechanism)
530 Print_Field
(Field22
(Ent
));
536 if Field_Present
(Field23
(Ent
)) then
538 Write_Field23_Name
(Ent
);
540 Print_Field
(Field23
(Ent
));
544 Write_Entity_Flags
(Ent
, Prefix
);
546 end Print_Entity_Info
;
552 procedure Print_Eol
is
554 if Phase
= Printing
then
563 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
565 if Phase
/= Printing
then
569 if Val
in Node_Range
then
570 Print_Node_Ref
(Node_Id
(Val
));
572 elsif Val
in List_Range
then
573 Print_List_Ref
(List_Id
(Val
));
575 elsif Val
in Elist_Range
then
576 Print_Elist_Ref
(Elist_Id
(Val
));
578 elsif Val
in Names_Range
then
579 Print_Name
(Name_Id
(Val
));
580 Write_Str
(" (Name_Id=");
581 Write_Int
(Int
(Val
));
584 elsif Val
in Strings_Range
then
585 Write_String_Table_Entry
(String_Id
(Val
));
586 Write_Str
(" (String_Id=");
587 Write_Int
(Int
(Val
));
590 elsif Val
in Uint_Range
then
591 UI_Write
(From_Union
(Val
), Format
);
592 Write_Str
(" (Uint = ");
593 Write_Int
(Int
(Val
));
596 elsif Val
in Ureal_Range
then
597 UR_Write
(From_Union
(Val
));
598 Write_Str
(" (Ureal = ");
599 Write_Int
(Int
(Val
));
602 elsif Val
in Char_Code_Range
then
603 Write_Str
("Character code = ");
606 C
: Char_Code
:= Char_Code
(Val
- Char_Code_Bias
);
616 Print_Str
("****** Incorrect value = ");
617 Print_Int
(Int
(Val
));
625 procedure Print_Flag
(F
: Boolean) is
638 procedure Print_Init
is
640 Printing_Descendants
:= True;
643 -- Allocate and clear serial number hash table. The size is 150% of
644 -- the maximum possible number of entries, so that the hash table
645 -- cannot get significantly overloaded.
647 Hash_Table_Len
:= (150 * (Num_Nodes
+ Num_Lists
+ Num_Elists
)) / 100;
648 Hash_Table
:= new Hash_Table_Type
(0 .. Hash_Table_Len
- 1);
650 for J
in Hash_Table
'Range loop
651 Hash_Table
(J
).Serial
:= 0;
660 procedure Print_Int
(I
: Int
) is
662 if Phase
= Printing
then
671 procedure Print_List_Ref
(L
: List_Id
) is
673 if Phase
/= Printing
then
678 Write_Str
("<no list>");
680 elsif Is_Empty_List
(L
) then
681 Write_Str
("<empty list> (List_Id=");
688 if Printing_Descendants
then
690 Write_Int
(Serial_Number
(Int
(L
)));
693 Write_Str
(" (List_Id=");
699 ------------------------
700 -- Print_List_Subtree --
701 ------------------------
703 procedure Print_List_Subtree
(L
: List_Id
) is
707 Next_Serial_Number
:= 1;
711 Next_Serial_Number
:= 1;
716 end Print_List_Subtree
;
722 procedure Print_Name
(N
: Name_Id
) is
724 if Phase
= Printing
then
726 Print_Str
("<No_Name>");
728 elsif N
= Error_Name
then
729 Print_Str
("<Error_Name>");
747 Prefix_Char
: Character)
750 P
: Natural := Pchar_Pos
(Nkind
(N
));
752 Field_To_Be_Printed
: Boolean;
753 Prefix_Str_Char
: String (Prefix_Str
'First .. Prefix_Str
'Last + 1);
755 Sfile
: Source_File_Index
;
760 if Phase
/= Printing
then
764 if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
) then
770 Prefix_Str_Char
(Prefix_Str
'Range) := Prefix_Str
;
771 Prefix_Str_Char
(Prefix_Str
'Last + 1) := Prefix_Char
;
775 Print_Str
(Prefix_Str
);
780 if Comes_From_Source
(N
) then
782 Print_Str
(" (source");
793 Print_Str
("analyzed");
796 if Error_Posted
(N
) then
804 Print_Str
("posted");
813 if Is_Rewrite_Substitution
(N
) then
814 Print_Str
(Prefix_Str
);
815 Print_Str
(" Rewritten: original node = ");
816 Print_Node_Ref
(Original_Node
(N
));
824 if not Is_List_Member
(N
) then
825 Print_Str
(Prefix_Str
);
826 Print_Str
(" Parent = ");
827 Print_Node_Ref
(Parent
(N
));
831 -- Print Sloc field if it is set
833 if Sloc
(N
) /= No_Location
then
834 Print_Str
(Prefix_Str_Char
);
835 Print_Str
("Sloc = ");
837 if Sloc
(N
) = Standard_Location
then
838 Print_Str
("Standard_Location");
840 elsif Sloc
(N
) = Standard_ASCII_Location
then
841 Print_Str
("Standard_ASCII_Location");
844 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
845 Print_Int
(Int
(Sloc
(N
)) - Int
(Source_Text
(Sfile
)'First));
847 Write_Location
(Sloc
(N
));
853 -- Print Chars field if present
855 if Nkind
(N
) in N_Has_Chars
and then Chars
(N
) /= No_Name
then
856 Print_Str
(Prefix_Str_Char
);
857 Print_Str
("Chars = ");
858 Print_Name
(Chars
(N
));
859 Write_Str
(" (Name_Id=");
860 Write_Int
(Int
(Chars
(N
)));
865 -- Special field print operations for non-entity nodes
867 if Nkind
(N
) not in N_Entity
then
869 -- Deal with Left_Opnd and Right_Opnd fields
872 or else Nkind
(N
) = N_And_Then
873 or else Nkind
(N
) = N_In
874 or else Nkind
(N
) = N_Not_In
875 or else Nkind
(N
) = N_Or_Else
877 -- Print Left_Opnd if present
879 if Nkind
(N
) not in N_Unary_Op
then
880 Print_Str
(Prefix_Str_Char
);
881 Print_Str
("Left_Opnd = ");
882 Print_Node_Ref
(Left_Opnd
(N
));
888 Print_Str
(Prefix_Str_Char
);
889 Print_Str
("Right_Opnd = ");
890 Print_Node_Ref
(Right_Opnd
(N
));
894 -- Print Entity field if operator (other cases of Entity
895 -- are in the table, so are handled in the normal circuit)
897 if Nkind
(N
) in N_Op
and then Present
(Entity
(N
)) then
898 Print_Str
(Prefix_Str_Char
);
899 Print_Str
("Entity = ");
900 Print_Node_Ref
(Entity
(N
));
904 -- Print special fields if we have a subexpression
906 if Nkind
(N
) in N_Subexpr
then
908 if Assignment_OK
(N
) then
909 Print_Str
(Prefix_Str_Char
);
910 Print_Str
("Assignment_OK = True");
914 if Do_Range_Check
(N
) then
915 Print_Str
(Prefix_Str_Char
);
916 Print_Str
("Do_Range_Check = True");
920 if Has_Dynamic_Length_Check
(N
) then
921 Print_Str
(Prefix_Str_Char
);
922 Print_Str
("Has_Dynamic_Length_Check = True");
926 if Has_Dynamic_Range_Check
(N
) then
927 Print_Str
(Prefix_Str_Char
);
928 Print_Str
("Has_Dynamic_Range_Check = True");
932 if Is_Controlling_Actual
(N
) then
933 Print_Str
(Prefix_Str_Char
);
934 Print_Str
("Is_Controlling_Actual = True");
938 if Is_Overloaded
(N
) then
939 Print_Str
(Prefix_Str_Char
);
940 Print_Str
("Is_Overloaded = True");
944 if Is_Static_Expression
(N
) then
945 Print_Str
(Prefix_Str_Char
);
946 Print_Str
("Is_Static_Expression = True");
950 if Must_Not_Freeze
(N
) then
951 Print_Str
(Prefix_Str_Char
);
952 Print_Str
("Must_Not_Freeze = True");
956 if Paren_Count
(N
) /= 0 then
957 Print_Str
(Prefix_Str_Char
);
958 Print_Str
("Paren_Count = ");
959 Print_Int
(Int
(Paren_Count
(N
)));
963 if Raises_Constraint_Error
(N
) then
964 Print_Str
(Prefix_Str_Char
);
965 Print_Str
("Raise_Constraint_Error = True");
971 -- Print Do_Overflow_Check field if present
973 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
974 Print_Str
(Prefix_Str_Char
);
975 Print_Str
("Do_Overflow_Check = True");
979 -- Print Etype field if present (printing of this field for entities
980 -- is handled by the Print_Entity_Info procedure).
982 if Nkind
(N
) in N_Has_Etype
983 and then Present
(Etype
(N
))
985 Print_Str
(Prefix_Str_Char
);
986 Print_Str
("Etype = ");
987 Print_Node_Ref
(Etype
(N
));
992 -- Loop to print fields included in Pchars array
994 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
))) loop
998 -- Check for case of False flag, which we never print, or
999 -- an Empty field, which is also never printed
1003 Field_To_Be_Printed
:= Field1
(N
) /= Union_Id
(Empty
);
1006 Field_To_Be_Printed
:= Field2
(N
) /= Union_Id
(Empty
);
1009 Field_To_Be_Printed
:= Field3
(N
) /= Union_Id
(Empty
);
1012 Field_To_Be_Printed
:= Field4
(N
) /= Union_Id
(Empty
);
1015 Field_To_Be_Printed
:= Field5
(N
) /= Union_Id
(Empty
);
1017 when F_Flag4
=> Field_To_Be_Printed
:= Flag4
(N
);
1018 when F_Flag5
=> Field_To_Be_Printed
:= Flag5
(N
);
1019 when F_Flag6
=> Field_To_Be_Printed
:= Flag6
(N
);
1020 when F_Flag7
=> Field_To_Be_Printed
:= Flag7
(N
);
1021 when F_Flag8
=> Field_To_Be_Printed
:= Flag8
(N
);
1022 when F_Flag9
=> Field_To_Be_Printed
:= Flag9
(N
);
1023 when F_Flag10
=> Field_To_Be_Printed
:= Flag10
(N
);
1024 when F_Flag11
=> Field_To_Be_Printed
:= Flag11
(N
);
1025 when F_Flag12
=> Field_To_Be_Printed
:= Flag12
(N
);
1026 when F_Flag13
=> Field_To_Be_Printed
:= Flag13
(N
);
1027 when F_Flag14
=> Field_To_Be_Printed
:= Flag14
(N
);
1028 when F_Flag15
=> Field_To_Be_Printed
:= Flag15
(N
);
1029 when F_Flag16
=> Field_To_Be_Printed
:= Flag16
(N
);
1030 when F_Flag17
=> Field_To_Be_Printed
:= Flag17
(N
);
1031 when F_Flag18
=> Field_To_Be_Printed
:= Flag18
(N
);
1033 -- Flag1,2,3 are no longer used
1035 when F_Flag1
=> raise Program_Error
;
1036 when F_Flag2
=> raise Program_Error
;
1037 when F_Flag3
=> raise Program_Error
;
1041 -- Print field if it is to be printed
1043 if Field_To_Be_Printed
then
1044 Print_Str
(Prefix_Str_Char
);
1046 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1047 and then Pchars
(P
) not in Fchar
1049 Print_Char
(Pchars
(P
));
1056 when F_Field1
=> Print_Field
(Field1
(N
), Fmt
);
1057 when F_Field2
=> Print_Field
(Field2
(N
), Fmt
);
1058 when F_Field3
=> Print_Field
(Field3
(N
), Fmt
);
1059 when F_Field4
=> Print_Field
(Field4
(N
), Fmt
);
1061 -- Special case End_Span = Uint5
1064 if Nkind
(N
) = N_Case_Statement
1065 or else Nkind
(N
) = N_If_Statement
1069 Print_Field
(Field5
(N
), Fmt
);
1072 when F_Flag4
=> Print_Flag
(Flag4
(N
));
1073 when F_Flag5
=> Print_Flag
(Flag5
(N
));
1074 when F_Flag6
=> Print_Flag
(Flag6
(N
));
1075 when F_Flag7
=> Print_Flag
(Flag7
(N
));
1076 when F_Flag8
=> Print_Flag
(Flag8
(N
));
1077 when F_Flag9
=> Print_Flag
(Flag9
(N
));
1078 when F_Flag10
=> Print_Flag
(Flag10
(N
));
1079 when F_Flag11
=> Print_Flag
(Flag11
(N
));
1080 when F_Flag12
=> Print_Flag
(Flag12
(N
));
1081 when F_Flag13
=> Print_Flag
(Flag13
(N
));
1082 when F_Flag14
=> Print_Flag
(Flag14
(N
));
1083 when F_Flag15
=> Print_Flag
(Flag15
(N
));
1084 when F_Flag16
=> Print_Flag
(Flag16
(N
));
1085 when F_Flag17
=> Print_Flag
(Flag17
(N
));
1086 when F_Flag18
=> Print_Flag
(Flag18
(N
));
1088 -- Flag1,2,3 are no longer used
1090 when F_Flag1
=> raise Program_Error
;
1091 when F_Flag2
=> raise Program_Error
;
1092 when F_Flag3
=> raise Program_Error
;
1097 -- Field is not to be printed (False flag field)
1100 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1101 and then Pchars
(P
) not in Fchar
1109 -- Print entity information for entities
1111 if Nkind
(N
) in N_Entity
then
1112 Print_Entity_Info
(N
, Prefix_Str_Char
);
1117 ---------------------
1118 -- Print_Node_Kind --
1119 ---------------------
1121 procedure Print_Node_Kind
(N
: Node_Id
) is
1123 S
: constant String := Node_Kind
'Image (Nkind
(N
));
1126 if Phase
= Printing
then
1129 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1130 -- bug of 'Image returning lower case instead of upper case.
1132 for J
in S
'Range loop
1134 Write_Char
(Fold_Upper
(S
(J
)));
1136 Write_Char
(Fold_Lower
(S
(J
)));
1139 Ucase
:= (S
(J
) = '_');
1142 end Print_Node_Kind
;
1144 --------------------
1145 -- Print_Node_Ref --
1146 --------------------
1148 procedure Print_Node_Ref
(N
: Node_Id
) is
1152 if Phase
/= Printing
then
1157 Write_Str
("<empty>");
1159 elsif N
= Error
then
1160 Write_Str
("<error>");
1163 if Printing_Descendants
then
1164 S
:= Serial_Number
(Int
(N
));
1174 Print_Node_Kind
(N
);
1176 if Nkind
(N
) in N_Has_Chars
then
1178 Print_Name
(Chars
(N
));
1181 if Nkind
(N
) in N_Entity
then
1182 Write_Str
(" (Entity_Id=");
1184 Write_Str
(" (Node_Id=");
1187 Write_Int
(Int
(N
));
1189 if Sloc
(N
) <= Standard_Location
then
1198 ------------------------
1199 -- Print_Node_Subtree --
1200 ------------------------
1202 procedure Print_Node_Subtree
(N
: Node_Id
) is
1206 Next_Serial_Number
:= 1;
1208 Visit_Node
(N
, "", ' ');
1210 Next_Serial_Number
:= 1;
1212 Visit_Node
(N
, "", ' ');
1215 end Print_Node_Subtree
;
1221 procedure Print_Str
(S
: String) is
1223 if Phase
= Printing
then
1228 --------------------------
1229 -- Print_Str_Mixed_Case --
1230 --------------------------
1232 procedure Print_Str_Mixed_Case
(S
: String) is
1236 if Phase
= Printing
then
1239 for J
in S
'Range loop
1243 Write_Char
(Fold_Lower
(S
(J
)));
1246 Ucase
:= (S
(J
) = '_');
1249 end Print_Str_Mixed_Case
;
1255 procedure Print_Term
is
1256 procedure Free
is new Unchecked_Deallocation
1257 (Hash_Table_Type
, Access_Hash_Table_Type
);
1263 ---------------------
1264 -- Print_Tree_Elist --
1265 ---------------------
1267 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1271 Printing_Descendants
:= False;
1274 Print_Elist_Ref
(E
);
1277 M
:= First_Elmt
(E
);
1280 Print_Str
("<empty element list>");
1287 exit when No
(Next_Elmt
(M
));
1288 Print_Node
(Node
(M
), "", '|');
1292 Print_Node
(Node
(M
), "", ' ');
1295 end Print_Tree_Elist
;
1297 ---------------------
1298 -- Print_Tree_List --
1299 ---------------------
1301 procedure Print_Tree_List
(L
: List_Id
) is
1305 Printing_Descendants
:= False;
1309 Print_Str
(" List_Id=");
1310 Print_Int
(Int
(L
));
1316 Print_Str
("<empty node list>");
1323 exit when Next
(N
) = Empty
;
1324 Print_Node
(N
, "", '|');
1328 Print_Node
(N
, "", ' ');
1331 end Print_Tree_List
;
1333 ---------------------
1334 -- Print_Tree_Node --
1335 ---------------------
1337 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1339 Printing_Descendants
:= False;
1341 Print_Node
(N
, Label
, ' ');
1342 end Print_Tree_Node
;
1348 procedure PT
(N
: Node_Id
) is
1350 Print_Node_Subtree
(N
);
1357 -- The hashing algorithm is to use the remainder of the ID value divided
1358 -- by the hash table length as the starting point in the table, and then
1359 -- handle collisions by serial searching wrapping at the end of the table.
1362 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1363 -- to save the slot that should be used if Set_Serial_Number is called.
1365 function Serial_Number
(Id
: Int
) return Nat
is
1366 H
: Int
:= Id
mod Hash_Table_Len
;
1369 while Hash_Table
(H
).Serial
/= 0 loop
1371 if Id
= Hash_Table
(H
).Id
then
1372 return Hash_Table
(H
).Serial
;
1377 if H
> Hash_Table
'Last then
1382 -- Entry was not found, save slot number for possible subsequent call
1383 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1384 -- in case of such a call (the Id field is never read if the serial
1385 -- number of the slot is zero, so this is harmless in the case where
1386 -- Set_Serial_Number is not subsequently called).
1389 Hash_Table
(H
).Id
:= Id
;
1394 -----------------------
1395 -- Set_Serial_Number --
1396 -----------------------
1398 procedure Set_Serial_Number
is
1400 Hash_Table
(Hash_Slot
).Serial
:= Next_Serial_Number
;
1401 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1402 end Set_Serial_Number
;
1408 procedure Tree_Dump
is
1409 procedure Underline
;
1410 -- Put underline under string we just printed
1412 procedure Underline
is
1413 Col
: constant Int
:= Column
;
1418 while Col
> Column
loop
1425 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1426 -- flags immediately, before starting the dump. This avoids generating two
1427 -- copies of the dump if an abort occurs after printing the dump, and more
1428 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1430 -- Note: unlike in the source print case (in Sprint), we do not output
1431 -- separate trees for each unit. Instead the -df debug switch causes the
1432 -- tree that is output from the main unit to trace references into other
1433 -- units (normally such references are not traced). Since all other units
1434 -- are linked to the main unit by at least one reference, this causes all
1435 -- tree nodes to be included in the output tree.
1438 if Debug_Flag_Y
then
1439 Debug_Flag_Y
:= False;
1441 Write_Str
("Tree created for Standard (spec) ");
1443 Print_Node_Subtree
(Standard_Package_Node
);
1447 if Debug_Flag_T
then
1448 Debug_Flag_T
:= False;
1451 Write_Str
("Tree created for ");
1452 Write_Unit_Name
(Unit_Name
(Main_Unit
));
1454 Print_Node_Subtree
(Cunit
(Main_Unit
));
1464 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1467 S
: constant Nat
:= Serial_Number
(Int
(E
));
1470 -- In marking phase, return if already marked, otherwise set next
1471 -- serial number in hash table for later reference.
1473 if Phase
= Marking
then
1475 return; -- already visited
1480 -- In printing phase, if already printed, then return, otherwise we
1481 -- are printing the next item, so increment the serial number.
1484 if S
< Next_Serial_Number
then
1485 return; -- already printed
1487 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1491 -- Now process the list (Print calls have no effect in marking phase)
1493 Print_Str
(Prefix_Str
);
1494 Print_Elist_Ref
(E
);
1497 if Is_Empty_Elmt_List
(E
) then
1498 Print_Str
(Prefix_Str
);
1499 Print_Str
("(Empty element list)");
1504 if Phase
= Printing
then
1505 M
:= First_Elmt
(E
);
1506 while Present
(M
) loop
1508 Print_Str
(Prefix_Str
);
1515 Print_Str
(Prefix_Str
);
1519 M
:= First_Elmt
(E
);
1520 while Present
(M
) loop
1521 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1531 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1533 S
: constant Nat
:= Serial_Number
(Int
(L
));
1536 -- In marking phase, return if already marked, otherwise set next
1537 -- serial number in hash table for later reference.
1539 if Phase
= Marking
then
1546 -- In printing phase, if already printed, then return, otherwise we
1547 -- are printing the next item, so increment the serial number.
1550 if S
< Next_Serial_Number
then
1551 return; -- already printed
1553 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1557 -- Now process the list (Print calls have no effect in marking phase)
1559 Print_Str
(Prefix_Str
);
1563 Print_Str
(Prefix_Str
);
1564 Print_Str
("|Parent = ");
1565 Print_Node_Ref
(Parent
(L
));
1571 Print_Str
(Prefix_Str
);
1572 Print_Str
("(Empty list)");
1577 Print_Str
(Prefix_Str
);
1581 while Next
(N
) /= Empty
loop
1582 Visit_Node
(N
, Prefix_Str
, '|');
1587 Visit_Node
(N
, Prefix_Str
, ' ');
1594 procedure Visit_Node
1596 Prefix_Str
: String;
1597 Prefix_Char
: Character)
1599 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
1600 -- Prefix string for printing referenced fields
1602 procedure Visit_Descendent
1604 No_Indent
: Boolean := False);
1605 -- This procedure tests the given value of one of the Fields referenced
1606 -- by the current node to determine whether to visit it recursively.
1607 -- Normally No_Indent is false, which means tha the visited node will
1608 -- be indented using New_Prefix. If No_Indent is set to True, then
1609 -- this indentation is skipped, and Prefix_Str is used for the call
1610 -- to print the descendent. No_Indent is effective only if the
1611 -- referenced descendent is a node.
1613 ----------------------
1614 -- Visit_Descendent --
1615 ----------------------
1617 procedure Visit_Descendent
1619 No_Indent
: Boolean := False)
1622 -- Case of descendent is a node
1624 if D
in Node_Range
then
1626 -- Don't bother about Empty or Error descendents
1628 if D
<= Union_Id
(Empty_Or_Error
) then
1633 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
1636 -- Descendents in one of the standardly compiled internal
1637 -- packages are normally ignored, unless the parent is also
1638 -- in such a package (happens when Standard itself is output)
1639 -- or if the -df switch is set which causes all links to be
1640 -- followed, even into package standard.
1642 if Sloc
(Nod
) <= Standard_Location
then
1643 if Sloc
(N
) > Standard_Location
1644 and then not Debug_Flag_F
1649 -- Don't bother about a descendent in a different unit than
1650 -- the node we came from unless the -df switch is set. Note
1651 -- that we know at this point that Sloc (D) > Standard_Location
1653 -- Note: the tests for No_Location here just make sure that we
1654 -- don't blow up on a node which is missing an Sloc value. This
1655 -- should not normally happen.
1658 if (Sloc
(N
) <= Standard_Location
1659 or else Sloc
(N
) = No_Location
1660 or else Sloc
(Nod
) = No_Location
1661 or else not In_Same_Source_Unit
(Nod
, N
))
1662 and then not Debug_Flag_F
1668 -- Don't bother visiting a source node that has a parent which
1669 -- is not the node we came from. We prefer to trace such nodes
1670 -- from their real parents. This causes the tree to be printed
1671 -- in a more coherent order, e.g. a defining identifier listed
1672 -- next to its corresponding declaration, instead of next to
1673 -- some semantic reference.
1675 -- This test is skipped for nodes in standard packages unless
1676 -- the -dy option is set (which outputs the tree for standard)
1678 -- Also, always follow pointers to Is_Itype entities,
1679 -- since we want to list these when they are first referenced.
1681 if Parent
(Nod
) /= Empty
1682 and then Comes_From_Source
(Nod
)
1683 and then Parent
(Nod
) /= N
1684 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
1689 -- If we successfully fall through all the above tests (which
1690 -- execute a return if the node is not to be visited), we can
1691 -- go ahead and visit the node!
1694 Visit_Node
(Nod
, Prefix_Str
, Prefix_Char
);
1696 Visit_Node
(Nod
, New_Prefix
, ' ');
1700 -- Case of descendent is a list
1702 elsif D
in List_Range
then
1704 -- Don't bother with a missing list, empty list or error list
1706 if D
= Union_Id
(No_List
)
1707 or else D
= Union_Id
(Error_List
)
1708 or else Is_Empty_List
(List_Id
(D
))
1712 -- Otherwise we can visit the list. Note that we don't bother
1713 -- to do the parent test that we did for the node case, because
1714 -- it just does not happen that lists are referenced more than
1715 -- one place in the tree. We aren't counting on this being the
1716 -- case to generate valid output, it is just that we don't need
1717 -- in practice to worry about listing the list at a place that
1721 Visit_List
(List_Id
(D
), New_Prefix
);
1724 -- Case of descendent is an element list
1726 elsif D
in Elist_Range
then
1728 -- Don't bother with a missing list, or an empty list
1730 if D
= Union_Id
(No_Elist
)
1731 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
1735 -- Otherwise, visit the referenced element list
1738 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
1741 -- For all other kinds of descendents (strings, names, uints etc),
1742 -- there is nothing to visit (the contents of the field will be
1743 -- printed when we print the containing node, but what concerns
1744 -- us now is looking for descendents in the tree.
1749 end Visit_Descendent
;
1751 -- Start of processing for Visit_Node
1758 -- Set fatal error node in case we get a blow up during the trace
1760 Current_Error_Node
:= N
;
1762 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
1763 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
1764 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
1766 -- In the marking phase, all we do is to set the serial number
1768 if Phase
= Marking
then
1769 if Serial_Number
(Int
(N
)) /= 0 then
1770 return; -- already visited
1775 -- In the printing phase, we print the node
1778 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
1780 -- Here we have already visited the node, but if it is in
1781 -- a list, we still want to print the reference, so that
1782 -- it is clear that it belongs to the list.
1784 if Is_List_Member
(N
) then
1785 Print_Str
(Prefix_Str
);
1788 Print_Str
(Prefix_Str
);
1789 Print_Char
(Prefix_Char
);
1790 Print_Str
("(already output)");
1792 Print_Str
(Prefix_Str
);
1793 Print_Char
(Prefix_Char
);
1800 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
1801 Print_Str
(Prefix_Str
);
1802 Print_Char
(Prefix_Char
);
1804 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1808 -- Visit all descendents of this node
1810 if Nkind
(N
) not in N_Entity
then
1811 Visit_Descendent
(Field1
(N
));
1812 Visit_Descendent
(Field2
(N
));
1813 Visit_Descendent
(Field3
(N
));
1814 Visit_Descendent
(Field4
(N
));
1815 Visit_Descendent
(Field5
(N
));
1820 Visit_Descendent
(Field1
(N
));
1821 Visit_Descendent
(Field3
(N
));
1822 Visit_Descendent
(Field4
(N
));
1823 Visit_Descendent
(Field5
(N
));
1824 Visit_Descendent
(Field6
(N
));
1825 Visit_Descendent
(Field7
(N
));
1826 Visit_Descendent
(Field8
(N
));
1827 Visit_Descendent
(Field9
(N
));
1828 Visit_Descendent
(Field10
(N
));
1829 Visit_Descendent
(Field11
(N
));
1830 Visit_Descendent
(Field12
(N
));
1831 Visit_Descendent
(Field13
(N
));
1832 Visit_Descendent
(Field14
(N
));
1833 Visit_Descendent
(Field15
(N
));
1834 Visit_Descendent
(Field16
(N
));
1835 Visit_Descendent
(Field17
(N
));
1836 Visit_Descendent
(Field18
(N
));
1837 Visit_Descendent
(Field19
(N
));
1838 Visit_Descendent
(Field20
(N
));
1839 Visit_Descendent
(Field21
(N
));
1840 Visit_Descendent
(Field22
(N
));
1841 Visit_Descendent
(Field23
(N
));
1843 -- You may be wondering why we omitted Field2 above. The answer
1844 -- is that this is the Next_Entity field, and we want to treat
1845 -- it rather specially. Why? Because a Next_Entity link does not
1846 -- correspond to a level deeper in the tree, and we do not want
1847 -- the tree to march off to the right of the page due to bogus
1848 -- indentations coming from this effect.
1850 -- To prevent this, what we do is to control references via
1851 -- Next_Entity only from the first entity on a given scope
1852 -- chain, and we keep them all at the same level. Of course
1853 -- if an entity has already been referenced it is not printed.
1855 if Present
(Next_Entity
(N
))
1856 and then Present
(Scope
(N
))
1857 and then First_Entity
(Scope
(N
)) = N
1864 while Present
(Nod
) loop
1865 Visit_Descendent
(Union_Id
(Next_Entity
(Nod
)));
1866 Nod
:= Next_Entity
(Nod
);