1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2012, 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_Header (N : Node_Id);
142 -- Print header line used by Print_Node and Print_Node_Briefly
144 procedure Print_Node_Kind (N : Node_Id);
145 -- Print node kind name in mixed case if in print phase, noop if in
148 procedure Print_Str (S : String);
149 -- Print string S if currently in print phase, noop if in marking phase
151 procedure Print_Str_Mixed_Case (S : String);
152 -- Like Print_Str, except that the string is printed in mixed case mode
154 procedure Print_Int (I : Int);
155 -- Print integer I if currently in print phase, noop if in marking phase
158 -- Print end of line if currently in print phase, noop if in marking phase
160 procedure Print_Node_Ref (N : Node_Id);
161 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
162 -- in the latter case, including the Id and the Nkind of the node.
164 procedure Print_List_Ref (L : List_Id);
165 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
167 procedure Print_Elist_Ref (E : Elist_Id);
168 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
170 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String);
171 -- Called if the node being printed is an entity. Prints fields from the
172 -- extension, using routines in Einfo to get the field names and flags.
174 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto);
175 -- Print representation of Field value (name, tree, string, uint, charcode)
176 -- The format parameter controls the format of printing in the case of an
177 -- integer value (see UI_Write for details).
179 procedure Print_Flag (F : Boolean);
180 -- Print True or False
185 Prefix_Char : Character);
186 -- This is the internal routine used to print a single node. Each line of
187 -- output is preceded by Prefix_Str (which is used to set the indentation
188 -- level and the bars used to link list elements). In addition, for lines
189 -- other than the first, an additional character Prefix_Char is output.
191 function Serial_Number (Id : Int) return Nat;
192 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
193 -- serial number, or zero if no serial number has yet been assigned.
195 procedure Set_Serial_Number;
196 -- Can be called only immediately following a call to Serial_Number that
197 -- returned a value of zero. Causes the value of Next_Serial_Number to be
198 -- placed in the hash table (corresponding to the Id argument used in the
199 -- Serial_Number call), and increments Next_Serial_Number.
204 Prefix_Char : Character);
205 -- Called to process a single node in the case where descendents are to
206 -- be printed before every line, and Prefix_Char added to all lines
207 -- except the header line for the node.
209 procedure Visit_List (L : List_Id; Prefix_Str : String);
210 -- Visit_List is called to process a list in the case where descendents
211 -- are to be printed. Prefix_Str is to be added to all printed lines.
213 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String);
214 -- Visit_Elist is called to process an element list in the case where
215 -- descendents are to be printed. Prefix_Str is to be added to all
222 procedure pe (E : Elist_Id) is
224 Print_Tree_Elist (E);
231 procedure pl (L : Int) is
238 -- This is the case where we transform e.g. +36 to -99999936
242 Lid := -(99999990 + L);
244 Lid := -(99999900 + L);
246 Lid := -(99999000 + L);
248 Lid := -(99990000 + L);
249 elsif L <= 99999 then
250 Lid := -(99900000 + L);
251 elsif L <= 999999 then
252 Lid := -(99000000 + L);
253 elsif L <= 9999999 then
254 Lid := -(90000000 + L);
260 -- Now output the list
262 Print_Tree_List (List_Id (Lid));
269 procedure pn (N : Union_Id) is
272 when List_Low_Bound .. List_High_Bound - 1 =>
275 Print_Tree_Node (Node_Id (N));
277 Print_Tree_Elist (Elist_Id (N));
280 Id : constant Elmt_Id := Elmt_Id (N);
283 Write_Str ("No_Elmt");
286 Write_Str ("Elmt_Id --> ");
287 Print_Tree_Node (Node (Id));
291 Namet.wn (Name_Id (N));
292 when Strings_Range =>
293 Write_String_Table_Entry (String_Id (N));
295 Uintp.pid (From_Union (N));
297 Urealp.pr (From_Union (N));
299 Write_Str ("Invalid Union_Id: ");
309 procedure pp (N : Union_Id) is
318 procedure Print_Char (C : Character) is
320 if Phase = Printing then
325 ---------------------
326 -- Print_Elist_Ref --
327 ---------------------
329 procedure Print_Elist_Ref (E : Elist_Id) is
331 if Phase /= Printing then
336 Write_Str ("<no elist>");
338 elsif Is_Empty_Elmt_List (E) then
339 Write_Str ("Empty elist, (Elist_Id=");
344 Write_Str ("(Elist_Id=");
348 if Printing_Descendants then
350 Write_Int (Serial_Number (Int (E)));
355 -------------------------
356 -- Print_Elist_Subtree --
357 -------------------------
359 procedure Print_Elist_Subtree (E : Elist_Id) is
363 Next_Serial_Number := 1;
367 Next_Serial_Number := 1;
372 end Print_Elist_Subtree;
378 procedure Print_End_Span (N : Node_Id) is
379 Val : constant Uint := End_Span (N);
383 Write_Str (" (Uint = ");
384 Write_Int (Int (Field5 (N)));
387 if Val /= No_Uint then
388 Write_Location (End_Location (N));
392 -----------------------
393 -- Print_Entity_Info --
394 -----------------------
396 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
397 function Field_Present (U : Union_Id) return Boolean;
398 -- Returns False unless the value U represents a missing value
399 -- (Empty, No_Uint, No_Ureal or No_String)
401 function Field_Present (U : Union_Id) return Boolean is
404 U /= Union_Id (Empty) and then
405 U /= To_Union (No_Uint) and then
406 U /= To_Union (No_Ureal) and then
407 U /= Union_Id (No_String);
410 -- Start of processing for Print_Entity_Info
414 Print_Str ("Ekind = ");
415 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
419 Print_Str ("Etype = ");
420 Print_Node_Ref (Etype (Ent));
423 if Convention (Ent) /= Convention_Ada then
425 Print_Str ("Convention = ");
427 -- Print convention name skipping the Convention_ at the start
430 S : constant String := Convention_Id'Image (Convention (Ent));
433 Print_Str_Mixed_Case (S (12 .. S'Last));
438 if Field_Present (Field6 (Ent)) then
440 Write_Field6_Name (Ent);
442 Print_Field (Field6 (Ent));
446 if Field_Present (Field7 (Ent)) then
448 Write_Field7_Name (Ent);
450 Print_Field (Field7 (Ent));
454 if Field_Present (Field8 (Ent)) then
456 Write_Field8_Name (Ent);
458 Print_Field (Field8 (Ent));
462 if Field_Present (Field9 (Ent)) then
464 Write_Field9_Name (Ent);
466 Print_Field (Field9 (Ent));
470 if Field_Present (Field10 (Ent)) then
472 Write_Field10_Name (Ent);
474 Print_Field (Field10 (Ent));
478 if Field_Present (Field11 (Ent)) then
480 Write_Field11_Name (Ent);
482 Print_Field (Field11 (Ent));
486 if Field_Present (Field12 (Ent)) then
488 Write_Field12_Name (Ent);
490 Print_Field (Field12 (Ent));
494 if Field_Present (Field13 (Ent)) then
496 Write_Field13_Name (Ent);
498 Print_Field (Field13 (Ent));
502 if Field_Present (Field14 (Ent)) then
504 Write_Field14_Name (Ent);
506 Print_Field (Field14 (Ent));
510 if Field_Present (Field15 (Ent)) then
512 Write_Field15_Name (Ent);
514 Print_Field (Field15 (Ent));
518 if Field_Present (Field16 (Ent)) then
520 Write_Field16_Name (Ent);
522 Print_Field (Field16 (Ent));
526 if Field_Present (Field17 (Ent)) then
528 Write_Field17_Name (Ent);
530 Print_Field (Field17 (Ent));
534 if Field_Present (Field18 (Ent)) then
536 Write_Field18_Name (Ent);
538 Print_Field (Field18 (Ent));
542 if Field_Present (Field19 (Ent)) then
544 Write_Field19_Name (Ent);
546 Print_Field (Field19 (Ent));
550 if Field_Present (Field20 (Ent)) then
552 Write_Field20_Name (Ent);
554 Print_Field (Field20 (Ent));
558 if Field_Present (Field21 (Ent)) then
560 Write_Field21_Name (Ent);
562 Print_Field (Field21 (Ent));
566 if Field_Present (Field22 (Ent)) then
568 Write_Field22_Name (Ent);
571 -- Mechanism case has to be handled specially
573 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
575 M : constant Mechanism_Type := Mechanism (Ent);
579 when Default_Mechanism
580 => Write_Str ("Default");
582 => Write_Str ("By_Copy");
584 => Write_Str ("By_Reference");
586 => Write_Str ("By_Descriptor");
587 when By_Descriptor_UBS
588 => Write_Str ("By_Descriptor_UBS");
589 when By_Descriptor_UBSB
590 => Write_Str ("By_Descriptor_UBSB");
591 when By_Descriptor_UBA
592 => Write_Str ("By_Descriptor_UBA");
594 => Write_Str ("By_Descriptor_S");
595 when By_Descriptor_SB
596 => Write_Str ("By_Descriptor_SB");
598 => Write_Str ("By_Descriptor_A");
599 when By_Descriptor_NCA
600 => Write_Str ("By_Descriptor_NCA");
601 when By_Short_Descriptor
602 => Write_Str ("By_Short_Descriptor");
603 when By_Short_Descriptor_UBS
604 => Write_Str ("By_Short_Descriptor_UBS");
605 when By_Short_Descriptor_UBSB
606 => Write_Str ("By_Short_Descriptor_UBSB");
607 when By_Short_Descriptor_UBA
608 => Write_Str ("By_Short_Descriptor_UBA");
609 when By_Short_Descriptor_S
610 => Write_Str ("By_Short_Descriptor_S");
611 when By_Short_Descriptor_SB
612 => Write_Str ("By_Short_Descriptor_SB");
613 when By_Short_Descriptor_A
614 => Write_Str ("By_Short_Descriptor_A");
615 when By_Short_Descriptor_NCA
616 => Write_Str ("By_Short_Descriptor_NCA");
618 when 1 .. Mechanism_Type'Last =>
619 Write_Str ("By_Copy if size <= ");
625 -- Normal case (not Mechanism)
628 Print_Field (Field22 (Ent));
634 if Field_Present (Field23 (Ent)) then
636 Write_Field23_Name (Ent);
638 Print_Field (Field23 (Ent));
642 if Field_Present (Field24 (Ent)) then
644 Write_Field24_Name (Ent);
646 Print_Field (Field24 (Ent));
650 if Field_Present (Field25 (Ent)) then
652 Write_Field25_Name (Ent);
654 Print_Field (Field25 (Ent));
658 if Field_Present (Field26 (Ent)) then
660 Write_Field26_Name (Ent);
662 Print_Field (Field26 (Ent));
666 if Field_Present (Field27 (Ent)) then
668 Write_Field27_Name (Ent);
670 Print_Field (Field27 (Ent));
674 if Field_Present (Field28 (Ent)) then
676 Write_Field28_Name (Ent);
678 Print_Field (Field28 (Ent));
682 if Field_Present (Field29 (Ent)) then
684 Write_Field29_Name (Ent);
686 Print_Field (Field29 (Ent));
690 if Field_Present (Field30 (Ent)) then
692 Write_Field30_Name (Ent);
694 Print_Field (Field30 (Ent));
698 if Field_Present (Field31 (Ent)) then
700 Write_Field31_Name (Ent);
702 Print_Field (Field31 (Ent));
706 if Field_Present (Field32 (Ent)) then
708 Write_Field32_Name (Ent);
710 Print_Field (Field32 (Ent));
714 if Field_Present (Field33 (Ent)) then
716 Write_Field33_Name (Ent);
718 Print_Field (Field33 (Ent));
722 if Field_Present (Field34 (Ent)) then
724 Write_Field34_Name (Ent);
726 Print_Field (Field34 (Ent));
730 if Field_Present (Field35 (Ent)) then
732 Write_Field35_Name (Ent);
734 Print_Field (Field35 (Ent));
738 Write_Entity_Flags (Ent, Prefix);
739 end Print_Entity_Info;
745 procedure Print_Eol is
747 if Phase = Printing then
756 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
758 if Phase /= Printing then
762 if Val in Node_Range then
763 Print_Node_Ref (Node_Id (Val));
765 elsif Val in List_Range then
766 Print_List_Ref (List_Id (Val));
768 elsif Val in Elist_Range then
769 Print_Elist_Ref (Elist_Id (Val));
771 elsif Val in Names_Range then
772 Print_Name (Name_Id (Val));
773 Write_Str (" (Name_Id=");
774 Write_Int (Int (Val));
777 elsif Val in Strings_Range then
778 Write_String_Table_Entry (String_Id (Val));
779 Write_Str (" (String_Id=");
780 Write_Int (Int (Val));
783 elsif Val in Uint_Range then
784 UI_Write (From_Union (Val), Format);
785 Write_Str (" (Uint = ");
786 Write_Int (Int (Val));
789 elsif Val in Ureal_Range then
790 UR_Write (From_Union (Val));
791 Write_Str (" (Ureal = ");
792 Write_Int (Int (Val));
796 Print_Str ("****** Incorrect value = ");
797 Print_Int (Int (Val));
805 procedure Print_Flag (F : Boolean) is
818 procedure Print_Init is
820 Printing_Descendants := True;
823 -- Allocate and clear serial number hash table. The size is 150% of
824 -- the maximum possible number of entries, so that the hash table
825 -- cannot get significantly overloaded.
827 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
828 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
830 for J in Hash_Table'Range loop
831 Hash_Table (J).Serial := 0;
840 procedure Print_Int (I : Int) is
842 if Phase = Printing then
851 procedure Print_List_Ref (L : List_Id) is
853 if Phase /= Printing then
858 Write_Str ("<no list>");
860 elsif Is_Empty_List (L) then
861 Write_Str ("<empty list> (List_Id=");
868 if Printing_Descendants then
870 Write_Int (Serial_Number (Int (L)));
873 Write_Str (" (List_Id=");
879 ------------------------
880 -- Print_List_Subtree --
881 ------------------------
883 procedure Print_List_Subtree (L : List_Id) is
887 Next_Serial_Number := 1;
891 Next_Serial_Number := 1;
896 end Print_List_Subtree;
902 procedure Print_Name (N : Name_Id) is
904 if Phase = Printing then
906 Print_Str ("<No_Name>");
908 elsif N = Error_Name then
909 Print_Str ("<Error_Name>");
911 elsif Is_Valid_Name (N) then
918 Print_Str ("<invalid name ???>");
930 Prefix_Char : Character)
933 P : Natural := Pchar_Pos (Nkind (N));
935 Field_To_Be_Printed : Boolean;
936 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
938 Sfile : Source_File_Index;
942 if Phase /= Printing then
946 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
952 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
953 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
957 Print_Str (Prefix_Str);
958 Print_Node_Header (N);
960 if Is_Rewrite_Substitution (N) then
961 Print_Str (Prefix_Str);
962 Print_Str (" Rewritten: original node = ");
963 Print_Node_Ref (Original_Node (N));
971 if not Is_List_Member (N) then
972 Print_Str (Prefix_Str);
973 Print_Str (" Parent = ");
974 Print_Node_Ref (Parent (N));
978 -- Print Sloc field if it is set
980 if Sloc (N) /= No_Location then
981 Print_Str (Prefix_Str_Char);
982 Print_Str ("Sloc = ");
984 if Sloc (N) = Standard_Location then
985 Print_Str ("Standard_Location");
987 elsif Sloc (N) = Standard_ASCII_Location then
988 Print_Str ("Standard_ASCII_Location");
991 Sfile := Get_Source_File_Index (Sloc (N));
992 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
994 Write_Location (Sloc (N));
1000 -- Print Chars field if present
1002 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
1003 Print_Str (Prefix_Str_Char);
1004 Print_Str ("Chars = ");
1005 Print_Name (Chars (N));
1006 Write_Str (" (Name_Id=");
1007 Write_Int (Int (Chars (N)));
1012 -- Special field print operations for non-entity nodes
1014 if Nkind (N) not in N_Entity then
1016 -- Deal with Left_Opnd and Right_Opnd fields
1018 if Nkind (N) in N_Op
1019 or else Nkind (N) in N_Short_Circuit
1020 or else Nkind (N) in N_Membership_Test
1022 -- Print Left_Opnd if present
1024 if Nkind (N) not in N_Unary_Op then
1025 Print_Str (Prefix_Str_Char);
1026 Print_Str ("Left_Opnd = ");
1027 Print_Node_Ref (Left_Opnd (N));
1033 Print_Str (Prefix_Str_Char);
1034 Print_Str ("Right_Opnd = ");
1035 Print_Node_Ref (Right_Opnd (N));
1039 -- Print Entity field if operator (other cases of Entity
1040 -- are in the table, so are handled in the normal circuit)
1042 if Nkind (N) in N_Op and then Present (Entity (N)) then
1043 Print_Str (Prefix_Str_Char);
1044 Print_Str ("Entity = ");
1045 Print_Node_Ref (Entity (N));
1049 -- Print special fields if we have a subexpression
1051 if Nkind (N) in N_Subexpr then
1053 if Assignment_OK (N) then
1054 Print_Str (Prefix_Str_Char);
1055 Print_Str ("Assignment_OK = True");
1059 if Do_Range_Check (N) then
1060 Print_Str (Prefix_Str_Char);
1061 Print_Str ("Do_Range_Check = True");
1065 if Has_Dynamic_Length_Check (N) then
1066 Print_Str (Prefix_Str_Char);
1067 Print_Str ("Has_Dynamic_Length_Check = True");
1071 if Has_Aspects (N) then
1072 Print_Str (Prefix_Str_Char);
1073 Print_Str ("Has_Aspects = True");
1077 if Has_Dynamic_Range_Check (N) then
1078 Print_Str (Prefix_Str_Char);
1079 Print_Str ("Has_Dynamic_Range_Check = True");
1083 if Is_Controlling_Actual (N) then
1084 Print_Str (Prefix_Str_Char);
1085 Print_Str ("Is_Controlling_Actual = True");
1089 if Is_Overloaded (N) then
1090 Print_Str (Prefix_Str_Char);
1091 Print_Str ("Is_Overloaded = True");
1095 if Is_Static_Expression (N) then
1096 Print_Str (Prefix_Str_Char);
1097 Print_Str ("Is_Static_Expression = True");
1101 if Must_Not_Freeze (N) then
1102 Print_Str (Prefix_Str_Char);
1103 Print_Str ("Must_Not_Freeze = True");
1107 if Paren_Count (N) /= 0 then
1108 Print_Str (Prefix_Str_Char);
1109 Print_Str ("Paren_Count = ");
1110 Print_Int (Int (Paren_Count (N)));
1114 if Raises_Constraint_Error (N) then
1115 Print_Str (Prefix_Str_Char);
1116 Print_Str ("Raise_Constraint_Error = True");
1122 -- Print Do_Overflow_Check field if present
1124 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
1125 Print_Str (Prefix_Str_Char);
1126 Print_Str ("Do_Overflow_Check = True");
1130 -- Print Etype field if present (printing of this field for entities
1131 -- is handled by the Print_Entity_Info procedure).
1133 if Nkind (N) in N_Has_Etype and then Present (Etype (N)) then
1134 Print_Str (Prefix_Str_Char);
1135 Print_Str ("Etype = ");
1136 Print_Node_Ref (Etype (N));
1141 -- Loop to print fields included in Pchars array
1143 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1147 -- Check for case of False flag, which we never print, or
1148 -- an Empty field, which is also never printed
1152 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1155 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1158 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1161 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1164 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1166 -- Flag3 is obsolete, so this probably gets removed ???
1168 when F_Flag3 => Field_To_Be_Printed := Has_Aspects (N);
1170 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1171 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1172 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1173 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1174 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1175 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1176 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1177 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1178 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1179 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1180 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1181 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1182 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1183 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1184 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1186 -- Flag1,2 are no longer used
1188 when F_Flag1 => raise Program_Error;
1189 when F_Flag2 => raise Program_Error;
1192 -- Print field if it is to be printed
1194 if Field_To_Be_Printed then
1195 Print_Str (Prefix_Str_Char);
1197 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1198 and then Pchars (P) not in Fchar
1200 Print_Char (Pchars (P));
1207 when F_Field1 => Print_Field (Field1 (N), Fmt);
1208 when F_Field2 => Print_Field (Field2 (N), Fmt);
1209 when F_Field3 => Print_Field (Field3 (N), Fmt);
1210 when F_Field4 => Print_Field (Field4 (N), Fmt);
1212 -- Special case End_Span = Uint5
1215 if Nkind (N) = N_Case_Statement
1216 or else Nkind (N) = N_If_Statement
1220 Print_Field (Field5 (N), Fmt);
1223 when F_Flag4 => Print_Flag (Flag4 (N));
1224 when F_Flag5 => Print_Flag (Flag5 (N));
1225 when F_Flag6 => Print_Flag (Flag6 (N));
1226 when F_Flag7 => Print_Flag (Flag7 (N));
1227 when F_Flag8 => Print_Flag (Flag8 (N));
1228 when F_Flag9 => Print_Flag (Flag9 (N));
1229 when F_Flag10 => Print_Flag (Flag10 (N));
1230 when F_Flag11 => Print_Flag (Flag11 (N));
1231 when F_Flag12 => Print_Flag (Flag12 (N));
1232 when F_Flag13 => Print_Flag (Flag13 (N));
1233 when F_Flag14 => Print_Flag (Flag14 (N));
1234 when F_Flag15 => Print_Flag (Flag15 (N));
1235 when F_Flag16 => Print_Flag (Flag16 (N));
1236 when F_Flag17 => Print_Flag (Flag17 (N));
1237 when F_Flag18 => Print_Flag (Flag18 (N));
1239 -- Flag1,2 are no longer used
1241 when F_Flag1 => raise Program_Error;
1242 when F_Flag2 => raise Program_Error;
1244 -- Not clear why we need the following ???
1246 when F_Flag3 => Print_Flag (Has_Aspects (N));
1251 -- Field is not to be printed (False flag field)
1254 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1255 and then Pchars (P) not in Fchar
1262 -- Print aspects if present
1264 if Has_Aspects (N) then
1265 Print_Str (Prefix_Str_Char);
1266 Print_Str ("Aspect_Specifications = ");
1267 Print_Field (Union_Id (Aspect_Specifications (N)));
1271 -- Print entity information for entities
1273 if Nkind (N) in N_Entity then
1274 Print_Entity_Info (N, Prefix_Str_Char);
1277 -- Print the SCIL node (if available)
1279 if Present (Get_SCIL_Node (N)) then
1280 Print_Str (Prefix_Str_Char);
1281 Print_Str ("SCIL_Node = ");
1282 Print_Node_Ref (Get_SCIL_Node (N));
1287 ------------------------
1288 -- Print_Node_Briefly --
1289 ------------------------
1291 procedure Print_Node_Briefly (N : Node_Id) is
1293 Printing_Descendants := False;
1295 Print_Node_Header (N);
1296 end Print_Node_Briefly;
1298 -----------------------
1299 -- Print_Node_Header --
1300 -----------------------
1302 procedure Print_Node_Header (N : Node_Id) is
1303 Notes : Boolean := False;
1308 if N > Atree_Private_Part.Nodes.Last then
1309 Print_Str (" (no such node)");
1314 if Comes_From_Source (N) then
1316 Print_Str (" (source");
1319 if Analyzed (N) then
1327 Print_Str ("analyzed");
1330 if Error_Posted (N) then
1338 Print_Str ("posted");
1346 end Print_Node_Header;
1348 ---------------------
1349 -- Print_Node_Kind --
1350 ---------------------
1352 procedure Print_Node_Kind (N : Node_Id) is
1354 S : constant String := Node_Kind'Image (Nkind (N));
1357 if Phase = Printing then
1360 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1361 -- bug of 'Image returning lower case instead of upper case.
1363 for J in S'Range loop
1365 Write_Char (Fold_Upper (S (J)));
1367 Write_Char (Fold_Lower (S (J)));
1370 Ucase := (S (J) = '_');
1373 end Print_Node_Kind;
1375 --------------------
1376 -- Print_Node_Ref --
1377 --------------------
1379 procedure Print_Node_Ref (N : Node_Id) is
1383 if Phase /= Printing then
1388 Write_Str ("<empty>");
1390 elsif N = Error then
1391 Write_Str ("<error>");
1394 if Printing_Descendants then
1395 S := Serial_Number (Int (N));
1405 Print_Node_Kind (N);
1407 if Nkind (N) in N_Has_Chars then
1409 Print_Name (Chars (N));
1412 if Nkind (N) in N_Entity then
1413 Write_Str (" (Entity_Id=");
1415 Write_Str (" (Node_Id=");
1418 Write_Int (Int (N));
1420 if Sloc (N) <= Standard_Location then
1429 ------------------------
1430 -- Print_Node_Subtree --
1431 ------------------------
1433 procedure Print_Node_Subtree (N : Node_Id) is
1437 Next_Serial_Number := 1;
1439 Visit_Node (N, "", ' ');
1441 Next_Serial_Number := 1;
1443 Visit_Node (N, "", ' ');
1446 end Print_Node_Subtree;
1452 procedure Print_Str (S : String) is
1454 if Phase = Printing then
1459 --------------------------
1460 -- Print_Str_Mixed_Case --
1461 --------------------------
1463 procedure Print_Str_Mixed_Case (S : String) is
1467 if Phase = Printing then
1470 for J in S'Range loop
1474 Write_Char (Fold_Lower (S (J)));
1477 Ucase := (S (J) = '_');
1480 end Print_Str_Mixed_Case;
1486 procedure Print_Term is
1487 procedure Free is new Unchecked_Deallocation
1488 (Hash_Table_Type, Access_Hash_Table_Type);
1494 ---------------------
1495 -- Print_Tree_Elist --
1496 ---------------------
1498 procedure Print_Tree_Elist (E : Elist_Id) is
1502 Printing_Descendants := False;
1505 Print_Elist_Ref (E);
1508 M := First_Elmt (E);
1511 Print_Str ("<empty element list>");
1518 exit when No (Next_Elmt (M));
1519 Print_Node (Node (M), "", '|');
1523 Print_Node (Node (M), "", ' ');
1526 end Print_Tree_Elist;
1528 ---------------------
1529 -- Print_Tree_List --
1530 ---------------------
1532 procedure Print_Tree_List (L : List_Id) is
1536 Printing_Descendants := False;
1540 Print_Str (" List_Id=");
1541 Print_Int (Int (L));
1547 Print_Str ("<empty node list>");
1554 exit when Next (N) = Empty;
1555 Print_Node (N, "", '|');
1559 Print_Node (N, "", ' ');
1562 end Print_Tree_List;
1564 ---------------------
1565 -- Print_Tree_Node --
1566 ---------------------
1568 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1570 Printing_Descendants := False;
1572 Print_Node (N, Label, ' ');
1573 end Print_Tree_Node;
1579 procedure pt (N : Node_Id) is
1581 Print_Node_Subtree (N);
1588 procedure ppp (N : Node_Id) is
1597 -- The hashing algorithm is to use the remainder of the ID value divided
1598 -- by the hash table length as the starting point in the table, and then
1599 -- handle collisions by serial searching wrapping at the end of the table.
1602 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1603 -- to save the slot that should be used if Set_Serial_Number is called.
1605 function Serial_Number (Id : Int) return Nat is
1606 H : Int := Id mod Hash_Table_Len;
1609 while Hash_Table (H).Serial /= 0 loop
1611 if Id = Hash_Table (H).Id then
1612 return Hash_Table (H).Serial;
1617 if H > Hash_Table'Last then
1622 -- Entry was not found, save slot number for possible subsequent call
1623 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1624 -- in case of such a call (the Id field is never read if the serial
1625 -- number of the slot is zero, so this is harmless in the case where
1626 -- Set_Serial_Number is not subsequently called).
1629 Hash_Table (H).Id := Id;
1634 -----------------------
1635 -- Set_Serial_Number --
1636 -----------------------
1638 procedure Set_Serial_Number is
1640 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1641 Next_Serial_Number := Next_Serial_Number + 1;
1642 end Set_Serial_Number;
1648 procedure Tree_Dump is
1649 procedure Underline;
1650 -- Put underline under string we just printed
1652 procedure Underline is
1653 Col : constant Int := Column;
1658 while Col > Column loop
1665 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1666 -- flags immediately, before starting the dump. This avoids generating two
1667 -- copies of the dump if an abort occurs after printing the dump, and more
1668 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1670 -- Note: unlike in the source print case (in Sprint), we do not output
1671 -- separate trees for each unit. Instead the -df debug switch causes the
1672 -- tree that is output from the main unit to trace references into other
1673 -- units (normally such references are not traced). Since all other units
1674 -- are linked to the main unit by at least one reference, this causes all
1675 -- tree nodes to be included in the output tree.
1678 if Debug_Flag_Y then
1679 Debug_Flag_Y := False;
1681 Write_Str ("Tree created for Standard (spec) ");
1683 Print_Node_Subtree (Standard_Package_Node);
1687 if Debug_Flag_T then
1688 Debug_Flag_T := False;
1691 Write_Str ("Tree created for ");
1692 Write_Unit_Name (Unit_Name (Main_Unit));
1694 Print_Node_Subtree (Cunit (Main_Unit));
1704 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1707 S : constant Nat := Serial_Number (Int (E));
1710 -- In marking phase, return if already marked, otherwise set next
1711 -- serial number in hash table for later reference.
1713 if Phase = Marking then
1715 return; -- already visited
1720 -- In printing phase, if already printed, then return, otherwise we
1721 -- are printing the next item, so increment the serial number.
1724 if S < Next_Serial_Number then
1725 return; -- already printed
1727 Next_Serial_Number := Next_Serial_Number + 1;
1731 -- Now process the list (Print calls have no effect in marking phase)
1733 Print_Str (Prefix_Str);
1734 Print_Elist_Ref (E);
1737 if Is_Empty_Elmt_List (E) then
1738 Print_Str (Prefix_Str);
1739 Print_Str ("(Empty element list)");
1744 if Phase = Printing then
1745 M := First_Elmt (E);
1746 while Present (M) loop
1748 Print_Str (Prefix_Str);
1755 Print_Str (Prefix_Str);
1759 M := First_Elmt (E);
1760 while Present (M) loop
1761 Visit_Node (Node (M), Prefix_Str, ' ');
1771 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1773 S : constant Nat := Serial_Number (Int (L));
1776 -- In marking phase, return if already marked, otherwise set next
1777 -- serial number in hash table for later reference.
1779 if Phase = Marking then
1786 -- In printing phase, if already printed, then return, otherwise we
1787 -- are printing the next item, so increment the serial number.
1790 if S < Next_Serial_Number then
1791 return; -- already printed
1793 Next_Serial_Number := Next_Serial_Number + 1;
1797 -- Now process the list (Print calls have no effect in marking phase)
1799 Print_Str (Prefix_Str);
1803 Print_Str (Prefix_Str);
1804 Print_Str ("|Parent = ");
1805 Print_Node_Ref (Parent (L));
1811 Print_Str (Prefix_Str);
1812 Print_Str ("(Empty list)");
1817 Print_Str (Prefix_Str);
1821 while Next (N) /= Empty loop
1822 Visit_Node (N, Prefix_Str, '|');
1827 Visit_Node (N, Prefix_Str, ' ');
1834 procedure Visit_Node
1836 Prefix_Str : String;
1837 Prefix_Char : Character)
1839 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1840 -- Prefix string for printing referenced fields
1842 procedure Visit_Descendent
1844 No_Indent : Boolean := False);
1845 -- This procedure tests the given value of one of the Fields referenced
1846 -- by the current node to determine whether to visit it recursively.
1847 -- Normally No_Indent is false, which means that the visited node will
1848 -- be indented using New_Prefix. If No_Indent is set to True, then
1849 -- this indentation is skipped, and Prefix_Str is used for the call
1850 -- to print the descendent. No_Indent is effective only if the
1851 -- referenced descendent is a node.
1853 ----------------------
1854 -- Visit_Descendent --
1855 ----------------------
1857 procedure Visit_Descendent
1859 No_Indent : Boolean := False)
1862 -- Case of descendent is a node
1864 if D in Node_Range then
1866 -- Don't bother about Empty or Error descendents
1868 if D <= Union_Id (Empty_Or_Error) then
1873 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1876 -- Descendents in one of the standardly compiled internal
1877 -- packages are normally ignored, unless the parent is also
1878 -- in such a package (happens when Standard itself is output)
1879 -- or if the -df switch is set which causes all links to be
1880 -- followed, even into package standard.
1882 if Sloc (Nod) <= Standard_Location then
1883 if Sloc (N) > Standard_Location
1884 and then not Debug_Flag_F
1889 -- Don't bother about a descendent in a different unit than
1890 -- the node we came from unless the -df switch is set. Note
1891 -- that we know at this point that Sloc (D) > Standard_Location
1893 -- Note: the tests for No_Location here just make sure that we
1894 -- don't blow up on a node which is missing an Sloc value. This
1895 -- should not normally happen.
1898 if (Sloc (N) <= Standard_Location
1899 or else Sloc (N) = No_Location
1900 or else Sloc (Nod) = No_Location
1901 or else not In_Same_Source_Unit (Nod, N))
1902 and then not Debug_Flag_F
1908 -- Don't bother visiting a source node that has a parent which
1909 -- is not the node we came from. We prefer to trace such nodes
1910 -- from their real parents. This causes the tree to be printed
1911 -- in a more coherent order, e.g. a defining identifier listed
1912 -- next to its corresponding declaration, instead of next to
1913 -- some semantic reference.
1915 -- This test is skipped for nodes in standard packages unless
1916 -- the -dy option is set (which outputs the tree for standard)
1918 -- Also, always follow pointers to Is_Itype entities,
1919 -- since we want to list these when they are first referenced.
1921 if Parent (Nod) /= Empty
1922 and then Comes_From_Source (Nod)
1923 and then Parent (Nod) /= N
1924 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1929 -- If we successfully fall through all the above tests (which
1930 -- execute a return if the node is not to be visited), we can
1931 -- go ahead and visit the node!
1934 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1936 Visit_Node (Nod, New_Prefix, ' ');
1940 -- Case of descendent is a list
1942 elsif D in List_Range then
1944 -- Don't bother with a missing list, empty list or error list
1946 if D = Union_Id (No_List)
1947 or else D = Union_Id (Error_List)
1948 or else Is_Empty_List (List_Id (D))
1952 -- Otherwise we can visit the list. Note that we don't bother
1953 -- to do the parent test that we did for the node case, because
1954 -- it just does not happen that lists are referenced more than
1955 -- one place in the tree. We aren't counting on this being the
1956 -- case to generate valid output, it is just that we don't need
1957 -- in practice to worry about listing the list at a place that
1961 Visit_List (List_Id (D), New_Prefix);
1964 -- Case of descendent is an element list
1966 elsif D in Elist_Range then
1968 -- Don't bother with a missing list, or an empty list
1970 if D = Union_Id (No_Elist)
1971 or else Is_Empty_Elmt_List (Elist_Id (D))
1975 -- Otherwise, visit the referenced element list
1978 Visit_Elist (Elist_Id (D), New_Prefix);
1981 -- For all other kinds of descendents (strings, names, uints etc),
1982 -- there is nothing to visit (the contents of the field will be
1983 -- printed when we print the containing node, but what concerns
1984 -- us now is looking for descendents in the tree.
1989 end Visit_Descendent;
1991 -- Start of processing for Visit_Node
1998 -- Set fatal error node in case we get a blow up during the trace
2000 Current_Error_Node := N;
2002 New_Prefix (Prefix_Str'Range) := Prefix_Str;
2003 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
2004 New_Prefix (Prefix_Str'Last + 2) := ' ';
2006 -- In the marking phase, all we do is to set the serial number
2008 if Phase = Marking then
2009 if Serial_Number (Int (N)) /= 0 then
2010 return; -- already visited
2015 -- In the printing phase, we print the node
2018 if Serial_Number (Int (N)) < Next_Serial_Number then
2020 -- Here we have already visited the node, but if it is in
2021 -- a list, we still want to print the reference, so that
2022 -- it is clear that it belongs to the list.
2024 if Is_List_Member (N) then
2025 Print_Str (Prefix_Str);
2028 Print_Str (Prefix_Str);
2029 Print_Char (Prefix_Char);
2030 Print_Str ("(already output)");
2032 Print_Str (Prefix_Str);
2033 Print_Char (Prefix_Char);
2040 Print_Node (N, Prefix_Str, Prefix_Char);
2041 Print_Str (Prefix_Str);
2042 Print_Char (Prefix_Char);
2044 Next_Serial_Number := Next_Serial_Number + 1;
2048 -- Visit all descendents of this node
2050 if Nkind (N) not in N_Entity then
2051 Visit_Descendent (Field1 (N));
2052 Visit_Descendent (Field2 (N));
2053 Visit_Descendent (Field3 (N));
2054 Visit_Descendent (Field4 (N));
2055 Visit_Descendent (Field5 (N));
2057 if Has_Aspects (N) then
2058 Visit_Descendent (Union_Id (Aspect_Specifications (N)));
2064 Visit_Descendent (Field1 (N));
2065 Visit_Descendent (Field3 (N));
2066 Visit_Descendent (Field4 (N));
2067 Visit_Descendent (Field5 (N));
2068 Visit_Descendent (Field6 (N));
2069 Visit_Descendent (Field7 (N));
2070 Visit_Descendent (Field8 (N));
2071 Visit_Descendent (Field9 (N));
2072 Visit_Descendent (Field10 (N));
2073 Visit_Descendent (Field11 (N));
2074 Visit_Descendent (Field12 (N));
2075 Visit_Descendent (Field13 (N));
2076 Visit_Descendent (Field14 (N));
2077 Visit_Descendent (Field15 (N));
2078 Visit_Descendent (Field16 (N));
2079 Visit_Descendent (Field17 (N));
2080 Visit_Descendent (Field18 (N));
2081 Visit_Descendent (Field19 (N));
2082 Visit_Descendent (Field20 (N));
2083 Visit_Descendent (Field21 (N));
2084 Visit_Descendent (Field22 (N));
2085 Visit_Descendent (Field23 (N));
2087 -- Now an interesting kludge. Normally parents are always printed
2088 -- since we traverse the tree in a downwards direction. There is
2089 -- however an exception to this rule, which is the case where a
2090 -- parent is constructed by the compiler and is not referenced
2091 -- elsewhere in the tree. The following catches this case
2093 if not Comes_From_Source (N) then
2094 Visit_Descendent (Union_Id (Parent (N)));
2097 -- You may be wondering why we omitted Field2 above. The answer
2098 -- is that this is the Next_Entity field, and we want to treat
2099 -- it rather specially. Why? Because a Next_Entity link does not
2100 -- correspond to a level deeper in the tree, and we do not want
2101 -- the tree to march off to the right of the page due to bogus
2102 -- indentations coming from this effect.
2104 -- To prevent this, what we do is to control references via
2105 -- Next_Entity only from the first entity on a given scope
2106 -- chain, and we keep them all at the same level. Of course
2107 -- if an entity has already been referenced it is not printed.
2109 if Present (Next_Entity (N))
2110 and then Present (Scope (N))
2111 and then First_Entity (Scope (N)) = N
2118 while Present (Nod) loop
2119 Visit_Descendent (Union_Id (Next_Entity (Nod)));
2120 Nod := Next_Entity (Nod);