1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2010, 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 Aspects
; use Aspects
;
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 SCIL_LL
; use SCIL_LL
;
43 with Treeprs
; use Treeprs
;
44 with Uintp
; use Uintp
;
45 with Urealp
; use Urealp
;
46 with Uname
; use Uname
;
47 with Unchecked_Deallocation
;
49 package body Treepr
is
51 use Atree
.Unchecked_Access
;
52 -- This module uses the unchecked access functions in package Atree
53 -- since it does an untyped traversal of the tree (we do not want to
54 -- count on the structure of the tree being correct in this routine!)
56 ----------------------------------
57 -- Approach Used for Tree Print --
58 ----------------------------------
60 -- When a complete subtree is being printed, a trace phase first marks
61 -- the nodes and lists to be printed. This trace phase allocates logical
62 -- numbers corresponding to the order in which the nodes and lists will
63 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
64 -- logical node numbers using a hash table. Output is done using a set
65 -- of Print_xxx routines, which are similar to the Write_xxx routines
66 -- with the same name, except that they do not generate any output in
67 -- the marking phase. This allows identical logic to be used in the
70 -- Note that the hash table not only holds the serial numbers, but also
71 -- acts as a record of which nodes have already been visited. In the
72 -- marking phase, a node has been visited if it is already in the hash
73 -- table, and in the printing phase, we can tell whether a node has
74 -- already been printed by looking at the value of the serial number.
76 ----------------------
77 -- Global Variables --
78 ----------------------
80 type Hash_Record
is record
82 -- Serial number for hash table entry. A value of zero means that
83 -- the entry is currently unused.
86 -- If serial number field is non-zero, contains corresponding Id value
89 type Hash_Table_Type
is array (Nat
range <>) of Hash_Record
;
90 type Access_Hash_Table_Type
is access Hash_Table_Type
;
91 Hash_Table
: Access_Hash_Table_Type
;
92 -- The hash table itself, see Serial_Number function for details of use
95 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
96 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
98 Next_Serial_Number
: Nat
;
99 -- Number of last visited node or list. Used during the marking phase to
100 -- set proper node numbers in the hash table, and during the printing
101 -- phase to make sure that a given node is not printed more than once.
102 -- (nodes are printed in order during the printing phase, that's the
103 -- point of numbering them in the first place!)
105 Printing_Descendants
: Boolean;
106 -- True if descendants are being printed, False if not. In the false case,
107 -- only node Id's are printed. In the true case, node numbers as well as
108 -- node Id's are printed, as described above.
110 type Phase_Type
is (Marking
, Printing
);
111 -- Type for Phase variable
114 -- When an entire tree is being printed, the traversal operates in two
115 -- phases. The first phase marks the nodes in use by installing node
116 -- numbers in the node number table. The second phase prints the nodes.
117 -- This variable indicates the current phase.
119 ----------------------
120 -- Local Procedures --
121 ----------------------
123 procedure Print_End_Span
(N
: Node_Id
);
124 -- Special routine to print contents of End_Span field of node N.
125 -- The format includes the implicit source location as well as the
126 -- value of the field.
128 procedure Print_Init
;
129 -- Initialize for printing of tree with descendents
131 procedure Print_Term
;
132 -- Clean up after printing of tree with descendents
134 procedure Print_Char
(C
: Character);
135 -- Print character C if currently in print phase, noop if in marking phase
137 procedure Print_Name
(N
: Name_Id
);
138 -- Print name from names table if currently in print phase, noop if in
139 -- marking phase. Note that the name is output in mixed case mode.
141 procedure Print_Node_Kind
(N
: Node_Id
);
142 -- Print node kind name in mixed case if in print phase, noop if in
145 procedure Print_Str
(S
: String);
146 -- Print string S if currently in print phase, noop if in marking phase
148 procedure Print_Str_Mixed_Case
(S
: String);
149 -- Like Print_Str, except that the string is printed in mixed case mode
151 procedure Print_Int
(I
: Int
);
152 -- Print integer I if currently in print phase, noop if in marking phase
155 -- Print end of line if currently in print phase, noop if in marking phase
157 procedure Print_Node_Ref
(N
: Node_Id
);
158 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
159 -- in the latter case, including the Id and the Nkind of the node.
161 procedure Print_List_Ref
(L
: List_Id
);
162 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
164 procedure Print_Elist_Ref
(E
: Elist_Id
);
165 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
167 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String);
168 -- Called if the node being printed is an entity. Prints fields from the
169 -- extension, using routines in Einfo to get the field names and flags.
171 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
);
172 -- Print representation of Field value (name, tree, string, uint, charcode)
173 -- The format parameter controls the format of printing in the case of an
174 -- integer value (see UI_Write for details).
176 procedure Print_Flag
(F
: Boolean);
177 -- Print True or False
182 Prefix_Char
: Character);
183 -- This is the internal routine used to print a single node. Each line of
184 -- output is preceded by Prefix_Str (which is used to set the indentation
185 -- level and the bars used to link list elements). In addition, for lines
186 -- other than the first, an additional character Prefix_Char is output.
188 function Serial_Number
(Id
: Int
) return Nat
;
189 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
190 -- serial number, or zero if no serial number has yet been assigned.
192 procedure Set_Serial_Number
;
193 -- Can be called only immediately following a call to Serial_Number that
194 -- returned a value of zero. Causes the value of Next_Serial_Number to be
195 -- placed in the hash table (corresponding to the Id argument used in the
196 -- Serial_Number call), and increments Next_Serial_Number.
201 Prefix_Char
: Character);
202 -- Called to process a single node in the case where descendents are to
203 -- be printed before every line, and Prefix_Char added to all lines
204 -- except the header line for the node.
206 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String);
207 -- Visit_List is called to process a list in the case where descendents
208 -- are to be printed. Prefix_Str is to be added to all printed lines.
210 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String);
211 -- Visit_Elist is called to process an element list in the case where
212 -- descendents are to be printed. Prefix_Str is to be added to all
219 procedure pe
(E
: Elist_Id
) is
221 Print_Tree_Elist
(E
);
228 procedure pl
(L
: Int
) is
235 -- This is the case where we transform e.g. +36 to -99999936
239 Lid
:= -(99999990 + L
);
241 Lid
:= -(99999900 + L
);
243 Lid
:= -(99999000 + L
);
245 Lid
:= -(99990000 + L
);
246 elsif L
<= 99999 then
247 Lid
:= -(99900000 + L
);
248 elsif L
<= 999999 then
249 Lid
:= -(99000000 + L
);
250 elsif L
<= 9999999 then
251 Lid
:= -(90000000 + L
);
257 -- Now output the list
259 Print_Tree_List
(List_Id
(Lid
));
266 procedure pn
(N
: Node_Id
) is
275 procedure Print_Char
(C
: Character) is
277 if Phase
= Printing
then
282 ---------------------
283 -- Print_Elist_Ref --
284 ---------------------
286 procedure Print_Elist_Ref
(E
: Elist_Id
) is
288 if Phase
/= Printing
then
293 Write_Str
("<no elist>");
295 elsif Is_Empty_Elmt_List
(E
) then
296 Write_Str
("Empty elist, (Elist_Id=");
301 Write_Str
("(Elist_Id=");
305 if Printing_Descendants
then
307 Write_Int
(Serial_Number
(Int
(E
)));
312 -------------------------
313 -- Print_Elist_Subtree --
314 -------------------------
316 procedure Print_Elist_Subtree
(E
: Elist_Id
) is
320 Next_Serial_Number
:= 1;
324 Next_Serial_Number
:= 1;
329 end Print_Elist_Subtree
;
335 procedure Print_End_Span
(N
: Node_Id
) is
336 Val
: constant Uint
:= End_Span
(N
);
340 Write_Str
(" (Uint = ");
341 Write_Int
(Int
(Field5
(N
)));
344 if Val
/= No_Uint
then
345 Write_Location
(End_Location
(N
));
349 -----------------------
350 -- Print_Entity_Info --
351 -----------------------
353 procedure Print_Entity_Info
(Ent
: Entity_Id
; Prefix
: String) is
354 function Field_Present
(U
: Union_Id
) return Boolean;
355 -- Returns False unless the value U represents a missing value
356 -- (Empty, No_Uint, No_Ureal or No_String)
358 function Field_Present
(U
: Union_Id
) return Boolean is
361 U
/= Union_Id
(Empty
) and then
362 U
/= To_Union
(No_Uint
) and then
363 U
/= To_Union
(No_Ureal
) and then
364 U
/= Union_Id
(No_String
);
367 -- Start of processing for Print_Entity_Info
371 Print_Str
("Ekind = ");
372 Print_Str_Mixed_Case
(Entity_Kind
'Image (Ekind
(Ent
)));
376 Print_Str
("Etype = ");
377 Print_Node_Ref
(Etype
(Ent
));
380 if Convention
(Ent
) /= Convention_Ada
then
382 Print_Str
("Convention = ");
384 -- Print convention name skipping the Convention_ at the start
387 S
: constant String := Convention_Id
'Image (Convention
(Ent
));
390 Print_Str_Mixed_Case
(S
(12 .. S
'Last));
395 if Field_Present
(Field6
(Ent
)) then
397 Write_Field6_Name
(Ent
);
399 Print_Field
(Field6
(Ent
));
403 if Field_Present
(Field7
(Ent
)) then
405 Write_Field7_Name
(Ent
);
407 Print_Field
(Field7
(Ent
));
411 if Field_Present
(Field8
(Ent
)) then
413 Write_Field8_Name
(Ent
);
415 Print_Field
(Field8
(Ent
));
419 if Field_Present
(Field9
(Ent
)) then
421 Write_Field9_Name
(Ent
);
423 Print_Field
(Field9
(Ent
));
427 if Field_Present
(Field10
(Ent
)) then
429 Write_Field10_Name
(Ent
);
431 Print_Field
(Field10
(Ent
));
435 if Field_Present
(Field11
(Ent
)) then
437 Write_Field11_Name
(Ent
);
439 Print_Field
(Field11
(Ent
));
443 if Field_Present
(Field12
(Ent
)) then
445 Write_Field12_Name
(Ent
);
447 Print_Field
(Field12
(Ent
));
451 if Field_Present
(Field13
(Ent
)) then
453 Write_Field13_Name
(Ent
);
455 Print_Field
(Field13
(Ent
));
459 if Field_Present
(Field14
(Ent
)) then
461 Write_Field14_Name
(Ent
);
463 Print_Field
(Field14
(Ent
));
467 if Field_Present
(Field15
(Ent
)) then
469 Write_Field15_Name
(Ent
);
471 Print_Field
(Field15
(Ent
));
475 if Field_Present
(Field16
(Ent
)) then
477 Write_Field16_Name
(Ent
);
479 Print_Field
(Field16
(Ent
));
483 if Field_Present
(Field17
(Ent
)) then
485 Write_Field17_Name
(Ent
);
487 Print_Field
(Field17
(Ent
));
491 if Field_Present
(Field18
(Ent
)) then
493 Write_Field18_Name
(Ent
);
495 Print_Field
(Field18
(Ent
));
499 if Field_Present
(Field19
(Ent
)) then
501 Write_Field19_Name
(Ent
);
503 Print_Field
(Field19
(Ent
));
507 if Field_Present
(Field20
(Ent
)) then
509 Write_Field20_Name
(Ent
);
511 Print_Field
(Field20
(Ent
));
515 if Field_Present
(Field21
(Ent
)) then
517 Write_Field21_Name
(Ent
);
519 Print_Field
(Field21
(Ent
));
523 if Field_Present
(Field22
(Ent
)) then
525 Write_Field22_Name
(Ent
);
528 -- Mechanism case has to be handled specially
530 if Ekind
(Ent
) = E_Function
or else Is_Formal
(Ent
) then
532 M
: constant Mechanism_Type
:= Mechanism
(Ent
);
536 when Default_Mechanism
537 => Write_Str
("Default");
539 => Write_Str
("By_Copy");
541 => Write_Str
("By_Reference");
543 => Write_Str
("By_Descriptor");
544 when By_Descriptor_UBS
545 => Write_Str
("By_Descriptor_UBS");
546 when By_Descriptor_UBSB
547 => Write_Str
("By_Descriptor_UBSB");
548 when By_Descriptor_UBA
549 => Write_Str
("By_Descriptor_UBA");
551 => Write_Str
("By_Descriptor_S");
552 when By_Descriptor_SB
553 => Write_Str
("By_Descriptor_SB");
555 => Write_Str
("By_Descriptor_A");
556 when By_Descriptor_NCA
557 => Write_Str
("By_Descriptor_NCA");
558 when By_Short_Descriptor
559 => Write_Str
("By_Short_Descriptor");
560 when By_Short_Descriptor_UBS
561 => Write_Str
("By_Short_Descriptor_UBS");
562 when By_Short_Descriptor_UBSB
563 => Write_Str
("By_Short_Descriptor_UBSB");
564 when By_Short_Descriptor_UBA
565 => Write_Str
("By_Short_Descriptor_UBA");
566 when By_Short_Descriptor_S
567 => Write_Str
("By_Short_Descriptor_S");
568 when By_Short_Descriptor_SB
569 => Write_Str
("By_Short_Descriptor_SB");
570 when By_Short_Descriptor_A
571 => Write_Str
("By_Short_Descriptor_A");
572 when By_Short_Descriptor_NCA
573 => Write_Str
("By_Short_Descriptor_NCA");
575 when 1 .. Mechanism_Type
'Last =>
576 Write_Str
("By_Copy if size <= ");
582 -- Normal case (not Mechanism)
585 Print_Field
(Field22
(Ent
));
591 if Field_Present
(Field23
(Ent
)) then
593 Write_Field23_Name
(Ent
);
595 Print_Field
(Field23
(Ent
));
599 if Field_Present
(Field24
(Ent
)) then
601 Write_Field24_Name
(Ent
);
603 Print_Field
(Field24
(Ent
));
607 if Field_Present
(Field25
(Ent
)) then
609 Write_Field25_Name
(Ent
);
611 Print_Field
(Field25
(Ent
));
615 if Field_Present
(Field26
(Ent
)) then
617 Write_Field26_Name
(Ent
);
619 Print_Field
(Field26
(Ent
));
623 if Field_Present
(Field27
(Ent
)) then
625 Write_Field27_Name
(Ent
);
627 Print_Field
(Field27
(Ent
));
631 if Field_Present
(Field28
(Ent
)) then
633 Write_Field28_Name
(Ent
);
635 Print_Field
(Field28
(Ent
));
639 if Field_Present
(Field29
(Ent
)) then
641 Write_Field29_Name
(Ent
);
643 Print_Field
(Field29
(Ent
));
647 Write_Entity_Flags
(Ent
, Prefix
);
648 end Print_Entity_Info
;
654 procedure Print_Eol
is
656 if Phase
= Printing
then
665 procedure Print_Field
(Val
: Union_Id
; Format
: UI_Format
:= Auto
) is
667 if Phase
/= Printing
then
671 if Val
in Node_Range
then
672 Print_Node_Ref
(Node_Id
(Val
));
674 elsif Val
in List_Range
then
675 Print_List_Ref
(List_Id
(Val
));
677 elsif Val
in Elist_Range
then
678 Print_Elist_Ref
(Elist_Id
(Val
));
680 elsif Val
in Names_Range
then
681 Print_Name
(Name_Id
(Val
));
682 Write_Str
(" (Name_Id=");
683 Write_Int
(Int
(Val
));
686 elsif Val
in Strings_Range
then
687 Write_String_Table_Entry
(String_Id
(Val
));
688 Write_Str
(" (String_Id=");
689 Write_Int
(Int
(Val
));
692 elsif Val
in Uint_Range
then
693 UI_Write
(From_Union
(Val
), Format
);
694 Write_Str
(" (Uint = ");
695 Write_Int
(Int
(Val
));
698 elsif Val
in Ureal_Range
then
699 UR_Write
(From_Union
(Val
));
700 Write_Str
(" (Ureal = ");
701 Write_Int
(Int
(Val
));
705 Print_Str
("****** Incorrect value = ");
706 Print_Int
(Int
(Val
));
714 procedure Print_Flag
(F
: Boolean) is
727 procedure Print_Init
is
729 Printing_Descendants
:= True;
732 -- Allocate and clear serial number hash table. The size is 150% of
733 -- the maximum possible number of entries, so that the hash table
734 -- cannot get significantly overloaded.
736 Hash_Table_Len
:= (150 * (Num_Nodes
+ Num_Lists
+ Num_Elists
)) / 100;
737 Hash_Table
:= new Hash_Table_Type
(0 .. Hash_Table_Len
- 1);
739 for J
in Hash_Table
'Range loop
740 Hash_Table
(J
).Serial
:= 0;
749 procedure Print_Int
(I
: Int
) is
751 if Phase
= Printing
then
760 procedure Print_List_Ref
(L
: List_Id
) is
762 if Phase
/= Printing
then
767 Write_Str
("<no list>");
769 elsif Is_Empty_List
(L
) then
770 Write_Str
("<empty list> (List_Id=");
777 if Printing_Descendants
then
779 Write_Int
(Serial_Number
(Int
(L
)));
782 Write_Str
(" (List_Id=");
788 ------------------------
789 -- Print_List_Subtree --
790 ------------------------
792 procedure Print_List_Subtree
(L
: List_Id
) is
796 Next_Serial_Number
:= 1;
800 Next_Serial_Number
:= 1;
805 end Print_List_Subtree
;
811 procedure Print_Name
(N
: Name_Id
) is
813 if Phase
= Printing
then
815 Print_Str
("<No_Name>");
817 elsif N
= Error_Name
then
818 Print_Str
("<Error_Name>");
820 elsif Is_Valid_Name
(N
) then
827 Print_Str
("<invalid name ???>");
839 Prefix_Char
: Character)
842 P
: Natural := Pchar_Pos
(Nkind
(N
));
844 Field_To_Be_Printed
: Boolean;
845 Prefix_Str_Char
: String (Prefix_Str
'First .. Prefix_Str
'Last + 1);
847 Sfile
: Source_File_Index
;
852 if Phase
/= Printing
then
856 if Nkind
(N
) = N_Integer_Literal
and then Print_In_Hex
(N
) then
862 Prefix_Str_Char
(Prefix_Str
'Range) := Prefix_Str
;
863 Prefix_Str_Char
(Prefix_Str
'Last + 1) := Prefix_Char
;
867 Print_Str
(Prefix_Str
);
872 if N
> Atree_Private_Part
.Nodes
.Last
then
873 Print_Str
(" (no such node)");
878 if Comes_From_Source
(N
) then
880 Print_Str
(" (source");
891 Print_Str
("analyzed");
894 if Error_Posted
(N
) then
902 Print_Str
("posted");
911 if Is_Rewrite_Substitution
(N
) then
912 Print_Str
(Prefix_Str
);
913 Print_Str
(" Rewritten: original node = ");
914 Print_Node_Ref
(Original_Node
(N
));
922 if not Is_List_Member
(N
) then
923 Print_Str
(Prefix_Str
);
924 Print_Str
(" Parent = ");
925 Print_Node_Ref
(Parent
(N
));
929 -- Print Sloc field if it is set
931 if Sloc
(N
) /= No_Location
then
932 Print_Str
(Prefix_Str_Char
);
933 Print_Str
("Sloc = ");
935 if Sloc
(N
) = Standard_Location
then
936 Print_Str
("Standard_Location");
938 elsif Sloc
(N
) = Standard_ASCII_Location
then
939 Print_Str
("Standard_ASCII_Location");
942 Sfile
:= Get_Source_File_Index
(Sloc
(N
));
943 Print_Int
(Int
(Sloc
(N
)) - Int
(Source_Text
(Sfile
)'First));
945 Write_Location
(Sloc
(N
));
951 -- Print Chars field if present
953 if Nkind
(N
) in N_Has_Chars
and then Chars
(N
) /= No_Name
then
954 Print_Str
(Prefix_Str_Char
);
955 Print_Str
("Chars = ");
956 Print_Name
(Chars
(N
));
957 Write_Str
(" (Name_Id=");
958 Write_Int
(Int
(Chars
(N
)));
963 -- Special field print operations for non-entity nodes
965 if Nkind
(N
) not in N_Entity
then
967 -- Deal with Left_Opnd and Right_Opnd fields
970 or else Nkind
(N
) in N_Short_Circuit
971 or else Nkind
(N
) in N_Membership_Test
973 -- Print Left_Opnd if present
975 if Nkind
(N
) not in N_Unary_Op
then
976 Print_Str
(Prefix_Str_Char
);
977 Print_Str
("Left_Opnd = ");
978 Print_Node_Ref
(Left_Opnd
(N
));
984 Print_Str
(Prefix_Str_Char
);
985 Print_Str
("Right_Opnd = ");
986 Print_Node_Ref
(Right_Opnd
(N
));
990 -- Print Entity field if operator (other cases of Entity
991 -- are in the table, so are handled in the normal circuit)
993 if Nkind
(N
) in N_Op
and then Present
(Entity
(N
)) then
994 Print_Str
(Prefix_Str_Char
);
995 Print_Str
("Entity = ");
996 Print_Node_Ref
(Entity
(N
));
1000 -- Print special fields if we have a subexpression
1002 if Nkind
(N
) in N_Subexpr
then
1004 if Assignment_OK
(N
) then
1005 Print_Str
(Prefix_Str_Char
);
1006 Print_Str
("Assignment_OK = True");
1010 if Do_Range_Check
(N
) then
1011 Print_Str
(Prefix_Str_Char
);
1012 Print_Str
("Do_Range_Check = True");
1016 if Has_Dynamic_Length_Check
(N
) then
1017 Print_Str
(Prefix_Str_Char
);
1018 Print_Str
("Has_Dynamic_Length_Check = True");
1022 if Has_Aspects
(N
) then
1023 Print_Str
(Prefix_Str_Char
);
1024 Print_Str
("Has_Aspects = True");
1028 if Has_Dynamic_Range_Check
(N
) then
1029 Print_Str
(Prefix_Str_Char
);
1030 Print_Str
("Has_Dynamic_Range_Check = True");
1034 if Is_Controlling_Actual
(N
) then
1035 Print_Str
(Prefix_Str_Char
);
1036 Print_Str
("Is_Controlling_Actual = True");
1040 if Is_Overloaded
(N
) then
1041 Print_Str
(Prefix_Str_Char
);
1042 Print_Str
("Is_Overloaded = True");
1046 if Is_Static_Expression
(N
) then
1047 Print_Str
(Prefix_Str_Char
);
1048 Print_Str
("Is_Static_Expression = True");
1052 if Must_Not_Freeze
(N
) then
1053 Print_Str
(Prefix_Str_Char
);
1054 Print_Str
("Must_Not_Freeze = True");
1058 if Paren_Count
(N
) /= 0 then
1059 Print_Str
(Prefix_Str_Char
);
1060 Print_Str
("Paren_Count = ");
1061 Print_Int
(Int
(Paren_Count
(N
)));
1065 if Raises_Constraint_Error
(N
) then
1066 Print_Str
(Prefix_Str_Char
);
1067 Print_Str
("Raise_Constraint_Error = True");
1073 -- Print Do_Overflow_Check field if present
1075 if Nkind
(N
) in N_Op
and then Do_Overflow_Check
(N
) then
1076 Print_Str
(Prefix_Str_Char
);
1077 Print_Str
("Do_Overflow_Check = True");
1081 -- Print Etype field if present (printing of this field for entities
1082 -- is handled by the Print_Entity_Info procedure).
1084 if Nkind
(N
) in N_Has_Etype
and then Present
(Etype
(N
)) then
1085 Print_Str
(Prefix_Str_Char
);
1086 Print_Str
("Etype = ");
1087 Print_Node_Ref
(Etype
(N
));
1092 -- Loop to print fields included in Pchars array
1094 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
))) loop
1098 -- Check for case of False flag, which we never print, or
1099 -- an Empty field, which is also never printed
1103 Field_To_Be_Printed
:= Field1
(N
) /= Union_Id
(Empty
);
1106 Field_To_Be_Printed
:= Field2
(N
) /= Union_Id
(Empty
);
1109 Field_To_Be_Printed
:= Field3
(N
) /= Union_Id
(Empty
);
1112 Field_To_Be_Printed
:= Field4
(N
) /= Union_Id
(Empty
);
1115 Field_To_Be_Printed
:= Field5
(N
) /= Union_Id
(Empty
);
1117 -- Flag3 is obsolete, so this probably gets removed ???
1119 when F_Flag3
=> Field_To_Be_Printed
:= Has_Aspects
(N
);
1121 when F_Flag4
=> Field_To_Be_Printed
:= Flag4
(N
);
1122 when F_Flag5
=> Field_To_Be_Printed
:= Flag5
(N
);
1123 when F_Flag6
=> Field_To_Be_Printed
:= Flag6
(N
);
1124 when F_Flag7
=> Field_To_Be_Printed
:= Flag7
(N
);
1125 when F_Flag8
=> Field_To_Be_Printed
:= Flag8
(N
);
1126 when F_Flag9
=> Field_To_Be_Printed
:= Flag9
(N
);
1127 when F_Flag10
=> Field_To_Be_Printed
:= Flag10
(N
);
1128 when F_Flag11
=> Field_To_Be_Printed
:= Flag11
(N
);
1129 when F_Flag12
=> Field_To_Be_Printed
:= Flag12
(N
);
1130 when F_Flag13
=> Field_To_Be_Printed
:= Flag13
(N
);
1131 when F_Flag14
=> Field_To_Be_Printed
:= Flag14
(N
);
1132 when F_Flag15
=> Field_To_Be_Printed
:= Flag15
(N
);
1133 when F_Flag16
=> Field_To_Be_Printed
:= Flag16
(N
);
1134 when F_Flag17
=> Field_To_Be_Printed
:= Flag17
(N
);
1135 when F_Flag18
=> Field_To_Be_Printed
:= Flag18
(N
);
1137 -- Flag1,2 are no longer used
1139 when F_Flag1
=> raise Program_Error
;
1140 when F_Flag2
=> raise Program_Error
;
1143 -- Print field if it is to be printed
1145 if Field_To_Be_Printed
then
1146 Print_Str
(Prefix_Str_Char
);
1148 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1149 and then Pchars
(P
) not in Fchar
1151 Print_Char
(Pchars
(P
));
1158 when F_Field1
=> Print_Field
(Field1
(N
), Fmt
);
1159 when F_Field2
=> Print_Field
(Field2
(N
), Fmt
);
1160 when F_Field3
=> Print_Field
(Field3
(N
), Fmt
);
1161 when F_Field4
=> Print_Field
(Field4
(N
), Fmt
);
1163 -- Special case End_Span = Uint5
1166 if Nkind
(N
) = N_Case_Statement
1167 or else Nkind
(N
) = N_If_Statement
1171 Print_Field
(Field5
(N
), Fmt
);
1174 when F_Flag4
=> Print_Flag
(Flag4
(N
));
1175 when F_Flag5
=> Print_Flag
(Flag5
(N
));
1176 when F_Flag6
=> Print_Flag
(Flag6
(N
));
1177 when F_Flag7
=> Print_Flag
(Flag7
(N
));
1178 when F_Flag8
=> Print_Flag
(Flag8
(N
));
1179 when F_Flag9
=> Print_Flag
(Flag9
(N
));
1180 when F_Flag10
=> Print_Flag
(Flag10
(N
));
1181 when F_Flag11
=> Print_Flag
(Flag11
(N
));
1182 when F_Flag12
=> Print_Flag
(Flag12
(N
));
1183 when F_Flag13
=> Print_Flag
(Flag13
(N
));
1184 when F_Flag14
=> Print_Flag
(Flag14
(N
));
1185 when F_Flag15
=> Print_Flag
(Flag15
(N
));
1186 when F_Flag16
=> Print_Flag
(Flag16
(N
));
1187 when F_Flag17
=> Print_Flag
(Flag17
(N
));
1188 when F_Flag18
=> Print_Flag
(Flag18
(N
));
1190 -- Flag1,2 are no longer used
1192 when F_Flag1
=> raise Program_Error
;
1193 when F_Flag2
=> raise Program_Error
;
1195 -- Not clear why we need the following ???
1197 when F_Flag3
=> Print_Flag
(Has_Aspects
(N
));
1202 -- Field is not to be printed (False flag field)
1205 while P
< Pchar_Pos
(Node_Kind
'Succ (Nkind
(N
)))
1206 and then Pchars
(P
) not in Fchar
1213 -- Print aspects if present
1215 if Has_Aspects
(N
) then
1216 Print_Str
(Prefix_Str_Char
);
1217 Print_Str
("Aspect_Specifications = ");
1218 Print_Field
(Union_Id
(Aspect_Specifications
(N
)));
1222 -- Print entity information for entities
1224 if Nkind
(N
) in N_Entity
then
1225 Print_Entity_Info
(N
, Prefix_Str_Char
);
1228 -- Print the SCIL node (if available)
1230 if Present
(Get_SCIL_Node
(N
)) then
1231 Print_Str
(Prefix_Str_Char
);
1232 Print_Str
("SCIL_Node = ");
1233 Print_Node_Ref
(Get_SCIL_Node
(N
));
1238 ---------------------
1239 -- Print_Node_Kind --
1240 ---------------------
1242 procedure Print_Node_Kind
(N
: Node_Id
) is
1244 S
: constant String := Node_Kind
'Image (Nkind
(N
));
1247 if Phase
= Printing
then
1250 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1251 -- bug of 'Image returning lower case instead of upper case.
1253 for J
in S
'Range loop
1255 Write_Char
(Fold_Upper
(S
(J
)));
1257 Write_Char
(Fold_Lower
(S
(J
)));
1260 Ucase
:= (S
(J
) = '_');
1263 end Print_Node_Kind
;
1265 --------------------
1266 -- Print_Node_Ref --
1267 --------------------
1269 procedure Print_Node_Ref
(N
: Node_Id
) is
1273 if Phase
/= Printing
then
1278 Write_Str
("<empty>");
1280 elsif N
= Error
then
1281 Write_Str
("<error>");
1284 if Printing_Descendants
then
1285 S
:= Serial_Number
(Int
(N
));
1295 Print_Node_Kind
(N
);
1297 if Nkind
(N
) in N_Has_Chars
then
1299 Print_Name
(Chars
(N
));
1302 if Nkind
(N
) in N_Entity
then
1303 Write_Str
(" (Entity_Id=");
1305 Write_Str
(" (Node_Id=");
1308 Write_Int
(Int
(N
));
1310 if Sloc
(N
) <= Standard_Location
then
1319 ------------------------
1320 -- Print_Node_Subtree --
1321 ------------------------
1323 procedure Print_Node_Subtree
(N
: Node_Id
) is
1327 Next_Serial_Number
:= 1;
1329 Visit_Node
(N
, "", ' ');
1331 Next_Serial_Number
:= 1;
1333 Visit_Node
(N
, "", ' ');
1336 end Print_Node_Subtree
;
1342 procedure Print_Str
(S
: String) is
1344 if Phase
= Printing
then
1349 --------------------------
1350 -- Print_Str_Mixed_Case --
1351 --------------------------
1353 procedure Print_Str_Mixed_Case
(S
: String) is
1357 if Phase
= Printing
then
1360 for J
in S
'Range loop
1364 Write_Char
(Fold_Lower
(S
(J
)));
1367 Ucase
:= (S
(J
) = '_');
1370 end Print_Str_Mixed_Case
;
1376 procedure Print_Term
is
1377 procedure Free
is new Unchecked_Deallocation
1378 (Hash_Table_Type
, Access_Hash_Table_Type
);
1384 ---------------------
1385 -- Print_Tree_Elist --
1386 ---------------------
1388 procedure Print_Tree_Elist
(E
: Elist_Id
) is
1392 Printing_Descendants
:= False;
1395 Print_Elist_Ref
(E
);
1398 M
:= First_Elmt
(E
);
1401 Print_Str
("<empty element list>");
1408 exit when No
(Next_Elmt
(M
));
1409 Print_Node
(Node
(M
), "", '|');
1413 Print_Node
(Node
(M
), "", ' ');
1416 end Print_Tree_Elist
;
1418 ---------------------
1419 -- Print_Tree_List --
1420 ---------------------
1422 procedure Print_Tree_List
(L
: List_Id
) is
1426 Printing_Descendants
:= False;
1430 Print_Str
(" List_Id=");
1431 Print_Int
(Int
(L
));
1437 Print_Str
("<empty node list>");
1444 exit when Next
(N
) = Empty
;
1445 Print_Node
(N
, "", '|');
1449 Print_Node
(N
, "", ' ');
1452 end Print_Tree_List
;
1454 ---------------------
1455 -- Print_Tree_Node --
1456 ---------------------
1458 procedure Print_Tree_Node
(N
: Node_Id
; Label
: String := "") is
1460 Printing_Descendants
:= False;
1462 Print_Node
(N
, Label
, ' ');
1463 end Print_Tree_Node
;
1469 procedure pt
(N
: Node_Id
) is
1471 Print_Node_Subtree
(N
);
1478 -- The hashing algorithm is to use the remainder of the ID value divided
1479 -- by the hash table length as the starting point in the table, and then
1480 -- handle collisions by serial searching wrapping at the end of the table.
1483 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1484 -- to save the slot that should be used if Set_Serial_Number is called.
1486 function Serial_Number
(Id
: Int
) return Nat
is
1487 H
: Int
:= Id
mod Hash_Table_Len
;
1490 while Hash_Table
(H
).Serial
/= 0 loop
1492 if Id
= Hash_Table
(H
).Id
then
1493 return Hash_Table
(H
).Serial
;
1498 if H
> Hash_Table
'Last then
1503 -- Entry was not found, save slot number for possible subsequent call
1504 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1505 -- in case of such a call (the Id field is never read if the serial
1506 -- number of the slot is zero, so this is harmless in the case where
1507 -- Set_Serial_Number is not subsequently called).
1510 Hash_Table
(H
).Id
:= Id
;
1515 -----------------------
1516 -- Set_Serial_Number --
1517 -----------------------
1519 procedure Set_Serial_Number
is
1521 Hash_Table
(Hash_Slot
).Serial
:= Next_Serial_Number
;
1522 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1523 end Set_Serial_Number
;
1529 procedure Tree_Dump
is
1530 procedure Underline
;
1531 -- Put underline under string we just printed
1533 procedure Underline
is
1534 Col
: constant Int
:= Column
;
1539 while Col
> Column
loop
1546 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1547 -- flags immediately, before starting the dump. This avoids generating two
1548 -- copies of the dump if an abort occurs after printing the dump, and more
1549 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1551 -- Note: unlike in the source print case (in Sprint), we do not output
1552 -- separate trees for each unit. Instead the -df debug switch causes the
1553 -- tree that is output from the main unit to trace references into other
1554 -- units (normally such references are not traced). Since all other units
1555 -- are linked to the main unit by at least one reference, this causes all
1556 -- tree nodes to be included in the output tree.
1559 if Debug_Flag_Y
then
1560 Debug_Flag_Y
:= False;
1562 Write_Str
("Tree created for Standard (spec) ");
1564 Print_Node_Subtree
(Standard_Package_Node
);
1568 if Debug_Flag_T
then
1569 Debug_Flag_T
:= False;
1572 Write_Str
("Tree created for ");
1573 Write_Unit_Name
(Unit_Name
(Main_Unit
));
1575 Print_Node_Subtree
(Cunit
(Main_Unit
));
1585 procedure Visit_Elist
(E
: Elist_Id
; Prefix_Str
: String) is
1588 S
: constant Nat
:= Serial_Number
(Int
(E
));
1591 -- In marking phase, return if already marked, otherwise set next
1592 -- serial number in hash table for later reference.
1594 if Phase
= Marking
then
1596 return; -- already visited
1601 -- In printing phase, if already printed, then return, otherwise we
1602 -- are printing the next item, so increment the serial number.
1605 if S
< Next_Serial_Number
then
1606 return; -- already printed
1608 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1612 -- Now process the list (Print calls have no effect in marking phase)
1614 Print_Str
(Prefix_Str
);
1615 Print_Elist_Ref
(E
);
1618 if Is_Empty_Elmt_List
(E
) then
1619 Print_Str
(Prefix_Str
);
1620 Print_Str
("(Empty element list)");
1625 if Phase
= Printing
then
1626 M
:= First_Elmt
(E
);
1627 while Present
(M
) loop
1629 Print_Str
(Prefix_Str
);
1636 Print_Str
(Prefix_Str
);
1640 M
:= First_Elmt
(E
);
1641 while Present
(M
) loop
1642 Visit_Node
(Node
(M
), Prefix_Str
, ' ');
1652 procedure Visit_List
(L
: List_Id
; Prefix_Str
: String) is
1654 S
: constant Nat
:= Serial_Number
(Int
(L
));
1657 -- In marking phase, return if already marked, otherwise set next
1658 -- serial number in hash table for later reference.
1660 if Phase
= Marking
then
1667 -- In printing phase, if already printed, then return, otherwise we
1668 -- are printing the next item, so increment the serial number.
1671 if S
< Next_Serial_Number
then
1672 return; -- already printed
1674 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1678 -- Now process the list (Print calls have no effect in marking phase)
1680 Print_Str
(Prefix_Str
);
1684 Print_Str
(Prefix_Str
);
1685 Print_Str
("|Parent = ");
1686 Print_Node_Ref
(Parent
(L
));
1692 Print_Str
(Prefix_Str
);
1693 Print_Str
("(Empty list)");
1698 Print_Str
(Prefix_Str
);
1702 while Next
(N
) /= Empty
loop
1703 Visit_Node
(N
, Prefix_Str
, '|');
1708 Visit_Node
(N
, Prefix_Str
, ' ');
1715 procedure Visit_Node
1717 Prefix_Str
: String;
1718 Prefix_Char
: Character)
1720 New_Prefix
: String (Prefix_Str
'First .. Prefix_Str
'Last + 2);
1721 -- Prefix string for printing referenced fields
1723 procedure Visit_Descendent
1725 No_Indent
: Boolean := False);
1726 -- This procedure tests the given value of one of the Fields referenced
1727 -- by the current node to determine whether to visit it recursively.
1728 -- Normally No_Indent is false, which means that the visited node will
1729 -- be indented using New_Prefix. If No_Indent is set to True, then
1730 -- this indentation is skipped, and Prefix_Str is used for the call
1731 -- to print the descendent. No_Indent is effective only if the
1732 -- referenced descendent is a node.
1734 ----------------------
1735 -- Visit_Descendent --
1736 ----------------------
1738 procedure Visit_Descendent
1740 No_Indent
: Boolean := False)
1743 -- Case of descendent is a node
1745 if D
in Node_Range
then
1747 -- Don't bother about Empty or Error descendents
1749 if D
<= Union_Id
(Empty_Or_Error
) then
1754 Nod
: constant Node_Or_Entity_Id
:= Node_Or_Entity_Id
(D
);
1757 -- Descendents in one of the standardly compiled internal
1758 -- packages are normally ignored, unless the parent is also
1759 -- in such a package (happens when Standard itself is output)
1760 -- or if the -df switch is set which causes all links to be
1761 -- followed, even into package standard.
1763 if Sloc
(Nod
) <= Standard_Location
then
1764 if Sloc
(N
) > Standard_Location
1765 and then not Debug_Flag_F
1770 -- Don't bother about a descendent in a different unit than
1771 -- the node we came from unless the -df switch is set. Note
1772 -- that we know at this point that Sloc (D) > Standard_Location
1774 -- Note: the tests for No_Location here just make sure that we
1775 -- don't blow up on a node which is missing an Sloc value. This
1776 -- should not normally happen.
1779 if (Sloc
(N
) <= Standard_Location
1780 or else Sloc
(N
) = No_Location
1781 or else Sloc
(Nod
) = No_Location
1782 or else not In_Same_Source_Unit
(Nod
, N
))
1783 and then not Debug_Flag_F
1789 -- Don't bother visiting a source node that has a parent which
1790 -- is not the node we came from. We prefer to trace such nodes
1791 -- from their real parents. This causes the tree to be printed
1792 -- in a more coherent order, e.g. a defining identifier listed
1793 -- next to its corresponding declaration, instead of next to
1794 -- some semantic reference.
1796 -- This test is skipped for nodes in standard packages unless
1797 -- the -dy option is set (which outputs the tree for standard)
1799 -- Also, always follow pointers to Is_Itype entities,
1800 -- since we want to list these when they are first referenced.
1802 if Parent
(Nod
) /= Empty
1803 and then Comes_From_Source
(Nod
)
1804 and then Parent
(Nod
) /= N
1805 and then (Sloc
(N
) > Standard_Location
or else Debug_Flag_Y
)
1810 -- If we successfully fall through all the above tests (which
1811 -- execute a return if the node is not to be visited), we can
1812 -- go ahead and visit the node!
1815 Visit_Node
(Nod
, Prefix_Str
, Prefix_Char
);
1817 Visit_Node
(Nod
, New_Prefix
, ' ');
1821 -- Case of descendent is a list
1823 elsif D
in List_Range
then
1825 -- Don't bother with a missing list, empty list or error list
1827 if D
= Union_Id
(No_List
)
1828 or else D
= Union_Id
(Error_List
)
1829 or else Is_Empty_List
(List_Id
(D
))
1833 -- Otherwise we can visit the list. Note that we don't bother
1834 -- to do the parent test that we did for the node case, because
1835 -- it just does not happen that lists are referenced more than
1836 -- one place in the tree. We aren't counting on this being the
1837 -- case to generate valid output, it is just that we don't need
1838 -- in practice to worry about listing the list at a place that
1842 Visit_List
(List_Id
(D
), New_Prefix
);
1845 -- Case of descendent is an element list
1847 elsif D
in Elist_Range
then
1849 -- Don't bother with a missing list, or an empty list
1851 if D
= Union_Id
(No_Elist
)
1852 or else Is_Empty_Elmt_List
(Elist_Id
(D
))
1856 -- Otherwise, visit the referenced element list
1859 Visit_Elist
(Elist_Id
(D
), New_Prefix
);
1862 -- For all other kinds of descendents (strings, names, uints etc),
1863 -- there is nothing to visit (the contents of the field will be
1864 -- printed when we print the containing node, but what concerns
1865 -- us now is looking for descendents in the tree.
1870 end Visit_Descendent
;
1872 -- Start of processing for Visit_Node
1879 -- Set fatal error node in case we get a blow up during the trace
1881 Current_Error_Node
:= N
;
1883 New_Prefix
(Prefix_Str
'Range) := Prefix_Str
;
1884 New_Prefix
(Prefix_Str
'Last + 1) := Prefix_Char
;
1885 New_Prefix
(Prefix_Str
'Last + 2) := ' ';
1887 -- In the marking phase, all we do is to set the serial number
1889 if Phase
= Marking
then
1890 if Serial_Number
(Int
(N
)) /= 0 then
1891 return; -- already visited
1896 -- In the printing phase, we print the node
1899 if Serial_Number
(Int
(N
)) < Next_Serial_Number
then
1901 -- Here we have already visited the node, but if it is in
1902 -- a list, we still want to print the reference, so that
1903 -- it is clear that it belongs to the list.
1905 if Is_List_Member
(N
) then
1906 Print_Str
(Prefix_Str
);
1909 Print_Str
(Prefix_Str
);
1910 Print_Char
(Prefix_Char
);
1911 Print_Str
("(already output)");
1913 Print_Str
(Prefix_Str
);
1914 Print_Char
(Prefix_Char
);
1921 Print_Node
(N
, Prefix_Str
, Prefix_Char
);
1922 Print_Str
(Prefix_Str
);
1923 Print_Char
(Prefix_Char
);
1925 Next_Serial_Number
:= Next_Serial_Number
+ 1;
1929 -- Visit all descendents of this node
1931 if Nkind
(N
) not in N_Entity
then
1932 Visit_Descendent
(Field1
(N
));
1933 Visit_Descendent
(Field2
(N
));
1934 Visit_Descendent
(Field3
(N
));
1935 Visit_Descendent
(Field4
(N
));
1936 Visit_Descendent
(Field5
(N
));
1938 if Has_Aspects
(N
) then
1939 Visit_Descendent
(Union_Id
(Aspect_Specifications
(N
)));
1945 Visit_Descendent
(Field1
(N
));
1946 Visit_Descendent
(Field3
(N
));
1947 Visit_Descendent
(Field4
(N
));
1948 Visit_Descendent
(Field5
(N
));
1949 Visit_Descendent
(Field6
(N
));
1950 Visit_Descendent
(Field7
(N
));
1951 Visit_Descendent
(Field8
(N
));
1952 Visit_Descendent
(Field9
(N
));
1953 Visit_Descendent
(Field10
(N
));
1954 Visit_Descendent
(Field11
(N
));
1955 Visit_Descendent
(Field12
(N
));
1956 Visit_Descendent
(Field13
(N
));
1957 Visit_Descendent
(Field14
(N
));
1958 Visit_Descendent
(Field15
(N
));
1959 Visit_Descendent
(Field16
(N
));
1960 Visit_Descendent
(Field17
(N
));
1961 Visit_Descendent
(Field18
(N
));
1962 Visit_Descendent
(Field19
(N
));
1963 Visit_Descendent
(Field20
(N
));
1964 Visit_Descendent
(Field21
(N
));
1965 Visit_Descendent
(Field22
(N
));
1966 Visit_Descendent
(Field23
(N
));
1968 -- Now an interesting kludge. Normally parents are always printed
1969 -- since we traverse the tree in a downwards direction. There is
1970 -- however an exception to this rule, which is the case where a
1971 -- parent is constructed by the compiler and is not referenced
1972 -- elsewhere in the tree. The following catches this case
1974 if not Comes_From_Source
(N
) then
1975 Visit_Descendent
(Union_Id
(Parent
(N
)));
1978 -- You may be wondering why we omitted Field2 above. The answer
1979 -- is that this is the Next_Entity field, and we want to treat
1980 -- it rather specially. Why? Because a Next_Entity link does not
1981 -- correspond to a level deeper in the tree, and we do not want
1982 -- the tree to march off to the right of the page due to bogus
1983 -- indentations coming from this effect.
1985 -- To prevent this, what we do is to control references via
1986 -- Next_Entity only from the first entity on a given scope
1987 -- chain, and we keep them all at the same level. Of course
1988 -- if an entity has already been referenced it is not printed.
1990 if Present
(Next_Entity
(N
))
1991 and then Present
(Scope
(N
))
1992 and then First_Entity
(Scope
(N
)) = N
1999 while Present
(Nod
) loop
2000 Visit_Descendent
(Union_Id
(Next_Entity
(Nod
)));
2001 Nod
:= Next_Entity
(Nod
);