1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2009, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
32 with Namet; use Namet;
33 with Nlists; use Nlists;
34 with Output; use Output;
35 with Sem_Mech; use Sem_Mech;
36 with Sinfo; use Sinfo;
37 with Snames; use Snames;
38 with Sinput; use Sinput;
39 with Stand; use Stand;
40 with Stringt; use Stringt;
41 with Treeprs; use Treeprs;
42 with Uintp; use Uintp;
43 with Urealp; use Urealp;
44 with Uname; use Uname;
45 with Unchecked_Deallocation;
47 package body Treepr is
49 use Atree.Unchecked_Access;
50 -- This module uses the unchecked access functions in package Atree
51 -- since it does an untyped traversal of the tree (we do not want to
52 -- count on the structure of the tree being correct in this routine!)
54 ----------------------------------
55 -- Approach Used for Tree Print --
56 ----------------------------------
58 -- When a complete subtree is being printed, a trace phase first marks
59 -- the nodes and lists to be printed. This trace phase allocates logical
60 -- numbers corresponding to the order in which the nodes and lists will
61 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
62 -- logical node numbers using a hash table. Output is done using a set
63 -- of Print_xxx routines, which are similar to the Write_xxx routines
64 -- with the same name, except that they do not generate any output in
65 -- the marking phase. This allows identical logic to be used in the
68 -- Note that the hash table not only holds the serial numbers, but also
69 -- acts as a record of which nodes have already been visited. In the
70 -- marking phase, a node has been visited if it is already in the hash
71 -- table, and in the printing phase, we can tell whether a node has
72 -- already been printed by looking at the value of the serial number.
74 ----------------------
75 -- Global Variables --
76 ----------------------
78 type Hash_Record is record
80 -- Serial number for hash table entry. A value of zero means that
81 -- the entry is currently unused.
84 -- If serial number field is non-zero, contains corresponding Id value
87 type Hash_Table_Type is array (Nat range <>) of Hash_Record;
88 type Access_Hash_Table_Type is access Hash_Table_Type;
89 Hash_Table : Access_Hash_Table_Type;
90 -- The hash table itself, see Serial_Number function for details of use
93 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
94 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
96 Next_Serial_Number : Nat;
97 -- Number of last visited node or list. Used during the marking phase to
98 -- set proper node numbers in the hash table, and during the printing
99 -- phase to make sure that a given node is not printed more than once.
100 -- (nodes are printed in order during the printing phase, that's the
101 -- point of numbering them in the first place!)
103 Printing_Descendants : Boolean;
104 -- True if descendants are being printed, False if not. In the false case,
105 -- only node Id's are printed. In the true case, node numbers as well as
106 -- node Id's are printed, as described above.
108 type Phase_Type is (Marking, Printing);
109 -- Type for Phase variable
112 -- When an entire tree is being printed, the traversal operates in two
113 -- phases. The first phase marks the nodes in use by installing node
114 -- numbers in the node number table. The second phase prints the nodes.
115 -- This variable indicates the current phase.
117 ----------------------
118 -- Local Procedures --
119 ----------------------
121 procedure Print_End_Span (N : Node_Id);
122 -- Special routine to print contents of End_Span field of node N.
123 -- The format includes the implicit source location as well as the
124 -- value of the field.
126 procedure Print_Init;
127 -- Initialize for printing of tree with descendents
129 procedure Print_Term;
130 -- Clean up after printing of tree with descendents
132 procedure Print_Char (C : Character);
133 -- Print character C if currently in print phase, noop if in marking phase
135 procedure Print_Name (N : Name_Id);
136 -- Print name from names table if currently in print phase, noop if in
137 -- marking phase. Note that the name is output in mixed case mode.
139 procedure Print_Node_Kind (N : Node_Id);
140 -- Print node kind name in mixed case if in print phase, noop if in
143 procedure Print_Str (S : String);
144 -- Print string S if currently in print phase, noop if in marking phase
146 procedure Print_Str_Mixed_Case (S : String);
147 -- Like Print_Str, except that the string is printed in mixed case mode
149 procedure Print_Int (I : Int);
150 -- Print integer I if currently in print phase, noop if in marking phase
153 -- Print end of line if currently in print phase, noop if in marking phase
155 procedure Print_Node_Ref (N : Node_Id);
156 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
157 -- in the latter case, including the Id and the Nkind of the node.
159 procedure Print_List_Ref (L : List_Id);
160 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
162 procedure Print_Elist_Ref (E : Elist_Id);
163 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
165 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String);
166 -- Called if the node being printed is an entity. Prints fields from the
167 -- extension, using routines in Einfo to get the field names and flags.
169 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto);
170 -- Print representation of Field value (name, tree, string, uint, charcode)
171 -- The format parameter controls the format of printing in the case of an
172 -- integer value (see UI_Write for details).
174 procedure Print_Flag (F : Boolean);
175 -- Print True or False
180 Prefix_Char : Character);
181 -- This is the internal routine used to print a single node. Each line of
182 -- output is preceded by Prefix_Str (which is used to set the indentation
183 -- level and the bars used to link list elements). In addition, for lines
184 -- other than the first, an additional character Prefix_Char is output.
186 function Serial_Number (Id : Int) return Nat;
187 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
188 -- serial number, or zero if no serial number has yet been assigned.
190 procedure Set_Serial_Number;
191 -- Can be called only immediately following a call to Serial_Number that
192 -- returned a value of zero. Causes the value of Next_Serial_Number to be
193 -- placed in the hash table (corresponding to the Id argument used in the
194 -- Serial_Number call), and increments Next_Serial_Number.
199 Prefix_Char : Character);
200 -- Called to process a single node in the case where descendents are to
201 -- be printed before every line, and Prefix_Char added to all lines
202 -- except the header line for the node.
204 procedure Visit_List (L : List_Id; Prefix_Str : String);
205 -- Visit_List is called to process a list in the case where descendents
206 -- are to be printed. Prefix_Str is to be added to all printed lines.
208 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String);
209 -- Visit_Elist is called to process an element list in the case where
210 -- descendents are to be printed. Prefix_Str is to be added to all
217 procedure pe (E : Elist_Id) is
219 Print_Tree_Elist (E);
226 procedure pl (L : Int) is
233 -- This is the case where we transform e.g. +36 to -99999936
237 Lid := -(99999990 + L);
239 Lid := -(99999900 + L);
241 Lid := -(99999000 + L);
243 Lid := -(99990000 + L);
244 elsif L <= 99999 then
245 Lid := -(99900000 + L);
246 elsif L <= 999999 then
247 Lid := -(99000000 + L);
248 elsif L <= 9999999 then
249 Lid := -(90000000 + L);
255 -- Now output the list
257 Print_Tree_List (List_Id (Lid));
264 procedure pn (N : Node_Id) is
273 procedure Print_Char (C : Character) is
275 if Phase = Printing then
280 ---------------------
281 -- Print_Elist_Ref --
282 ---------------------
284 procedure Print_Elist_Ref (E : Elist_Id) is
286 if Phase /= Printing then
291 Write_Str ("<no elist>");
293 elsif Is_Empty_Elmt_List (E) then
294 Write_Str ("Empty elist, (Elist_Id=");
299 Write_Str ("(Elist_Id=");
303 if Printing_Descendants then
305 Write_Int (Serial_Number (Int (E)));
310 -------------------------
311 -- Print_Elist_Subtree --
312 -------------------------
314 procedure Print_Elist_Subtree (E : Elist_Id) is
318 Next_Serial_Number := 1;
322 Next_Serial_Number := 1;
327 end Print_Elist_Subtree;
333 procedure Print_End_Span (N : Node_Id) is
334 Val : constant Uint := End_Span (N);
338 Write_Str (" (Uint = ");
339 Write_Int (Int (Field5 (N)));
342 if Val /= No_Uint then
343 Write_Location (End_Location (N));
347 -----------------------
348 -- Print_Entity_Info --
349 -----------------------
351 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
352 function Field_Present (U : Union_Id) return Boolean;
353 -- Returns False unless the value U represents a missing value
354 -- (Empty, No_Uint, No_Ureal or No_String)
356 function Field_Present (U : Union_Id) return Boolean is
359 U /= Union_Id (Empty) and then
360 U /= To_Union (No_Uint) and then
361 U /= To_Union (No_Ureal) and then
362 U /= Union_Id (No_String);
365 -- Start of processing for Print_Entity_Info
369 Print_Str ("Ekind = ");
370 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
374 Print_Str ("Etype = ");
375 Print_Node_Ref (Etype (Ent));
378 if Convention (Ent) /= Convention_Ada then
380 Print_Str ("Convention = ");
382 -- Print convention name skipping the Convention_ at the start
385 S : constant String := Convention_Id'Image (Convention (Ent));
388 Print_Str_Mixed_Case (S (12 .. S'Last));
393 if Field_Present (Field6 (Ent)) then
395 Write_Field6_Name (Ent);
397 Print_Field (Field6 (Ent));
401 if Field_Present (Field7 (Ent)) then
403 Write_Field7_Name (Ent);
405 Print_Field (Field7 (Ent));
409 if Field_Present (Field8 (Ent)) then
411 Write_Field8_Name (Ent);
413 Print_Field (Field8 (Ent));
417 if Field_Present (Field9 (Ent)) then
419 Write_Field9_Name (Ent);
421 Print_Field (Field9 (Ent));
425 if Field_Present (Field10 (Ent)) then
427 Write_Field10_Name (Ent);
429 Print_Field (Field10 (Ent));
433 if Field_Present (Field11 (Ent)) then
435 Write_Field11_Name (Ent);
437 Print_Field (Field11 (Ent));
441 if Field_Present (Field12 (Ent)) then
443 Write_Field12_Name (Ent);
445 Print_Field (Field12 (Ent));
449 if Field_Present (Field13 (Ent)) then
451 Write_Field13_Name (Ent);
453 Print_Field (Field13 (Ent));
457 if Field_Present (Field14 (Ent)) then
459 Write_Field14_Name (Ent);
461 Print_Field (Field14 (Ent));
465 if Field_Present (Field15 (Ent)) then
467 Write_Field15_Name (Ent);
469 Print_Field (Field15 (Ent));
473 if Field_Present (Field16 (Ent)) then
475 Write_Field16_Name (Ent);
477 Print_Field (Field16 (Ent));
481 if Field_Present (Field17 (Ent)) then
483 Write_Field17_Name (Ent);
485 Print_Field (Field17 (Ent));
489 if Field_Present (Field18 (Ent)) then
491 Write_Field18_Name (Ent);
493 Print_Field (Field18 (Ent));
497 if Field_Present (Field19 (Ent)) then
499 Write_Field19_Name (Ent);
501 Print_Field (Field19 (Ent));
505 if Field_Present (Field20 (Ent)) then
507 Write_Field20_Name (Ent);
509 Print_Field (Field20 (Ent));
513 if Field_Present (Field21 (Ent)) then
515 Write_Field21_Name (Ent);
517 Print_Field (Field21 (Ent));
521 if Field_Present (Field22 (Ent)) then
523 Write_Field22_Name (Ent);
526 -- Mechanism case has to be handled specially
528 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
530 M : constant Mechanism_Type := Mechanism (Ent);
534 when Default_Mechanism
535 => Write_Str ("Default");
537 => Write_Str ("By_Copy");
539 => Write_Str ("By_Reference");
541 => Write_Str ("By_Descriptor");
542 when By_Descriptor_UBS
543 => Write_Str ("By_Descriptor_UBS");
544 when By_Descriptor_UBSB
545 => Write_Str ("By_Descriptor_UBSB");
546 when By_Descriptor_UBA
547 => Write_Str ("By_Descriptor_UBA");
549 => Write_Str ("By_Descriptor_S");
550 when By_Descriptor_SB
551 => Write_Str ("By_Descriptor_SB");
553 => Write_Str ("By_Descriptor_A");
554 when By_Descriptor_NCA
555 => Write_Str ("By_Descriptor_NCA");
556 when By_Short_Descriptor
557 => Write_Str ("By_Short_Descriptor");
558 when By_Short_Descriptor_UBS
559 => Write_Str ("By_Short_Descriptor_UBS");
560 when By_Short_Descriptor_UBSB
561 => Write_Str ("By_Short_Descriptor_UBSB");
562 when By_Short_Descriptor_UBA
563 => Write_Str ("By_Short_Descriptor_UBA");
564 when By_Short_Descriptor_S
565 => Write_Str ("By_Short_Descriptor_S");
566 when By_Short_Descriptor_SB
567 => Write_Str ("By_Short_Descriptor_SB");
568 when By_Short_Descriptor_A
569 => Write_Str ("By_Short_Descriptor_A");
570 when By_Short_Descriptor_NCA
571 => Write_Str ("By_Short_Descriptor_NCA");
573 when 1 .. Mechanism_Type'Last =>
574 Write_Str ("By_Copy if size <= ");
580 -- Normal case (not Mechanism)
583 Print_Field (Field22 (Ent));
589 if Field_Present (Field23 (Ent)) then
591 Write_Field23_Name (Ent);
593 Print_Field (Field23 (Ent));
597 if Field_Present (Field24 (Ent)) then
599 Write_Field24_Name (Ent);
601 Print_Field (Field24 (Ent));
605 if Field_Present (Field25 (Ent)) then
607 Write_Field25_Name (Ent);
609 Print_Field (Field25 (Ent));
613 if Field_Present (Field26 (Ent)) then
615 Write_Field26_Name (Ent);
617 Print_Field (Field26 (Ent));
621 if Field_Present (Field27 (Ent)) then
623 Write_Field27_Name (Ent);
625 Print_Field (Field27 (Ent));
629 Write_Entity_Flags (Ent, Prefix);
630 end Print_Entity_Info;
636 procedure Print_Eol is
638 if Phase = Printing then
647 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
649 if Phase /= Printing then
653 if Val in Node_Range then
654 Print_Node_Ref (Node_Id (Val));
656 elsif Val in List_Range then
657 Print_List_Ref (List_Id (Val));
659 elsif Val in Elist_Range then
660 Print_Elist_Ref (Elist_Id (Val));
662 elsif Val in Names_Range then
663 Print_Name (Name_Id (Val));
664 Write_Str (" (Name_Id=");
665 Write_Int (Int (Val));
668 elsif Val in Strings_Range then
669 Write_String_Table_Entry (String_Id (Val));
670 Write_Str (" (String_Id=");
671 Write_Int (Int (Val));
674 elsif Val in Uint_Range then
675 UI_Write (From_Union (Val), Format);
676 Write_Str (" (Uint = ");
677 Write_Int (Int (Val));
680 elsif Val in Ureal_Range then
681 UR_Write (From_Union (Val));
682 Write_Str (" (Ureal = ");
683 Write_Int (Int (Val));
687 Print_Str ("****** Incorrect value = ");
688 Print_Int (Int (Val));
696 procedure Print_Flag (F : Boolean) is
709 procedure Print_Init is
711 Printing_Descendants := True;
714 -- Allocate and clear serial number hash table. The size is 150% of
715 -- the maximum possible number of entries, so that the hash table
716 -- cannot get significantly overloaded.
718 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
719 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
721 for J in Hash_Table'Range loop
722 Hash_Table (J).Serial := 0;
731 procedure Print_Int (I : Int) is
733 if Phase = Printing then
742 procedure Print_List_Ref (L : List_Id) is
744 if Phase /= Printing then
749 Write_Str ("<no list>");
751 elsif Is_Empty_List (L) then
752 Write_Str ("<empty list> (List_Id=");
759 if Printing_Descendants then
761 Write_Int (Serial_Number (Int (L)));
764 Write_Str (" (List_Id=");
770 ------------------------
771 -- Print_List_Subtree --
772 ------------------------
774 procedure Print_List_Subtree (L : List_Id) is
778 Next_Serial_Number := 1;
782 Next_Serial_Number := 1;
787 end Print_List_Subtree;
793 procedure Print_Name (N : Name_Id) is
795 if Phase = Printing then
797 Print_Str ("<No_Name>");
799 elsif N = Error_Name then
800 Print_Str ("<Error_Name>");
802 elsif Is_Valid_Name (N) then
809 Print_Str ("<invalid name ???>");
821 Prefix_Char : Character)
824 P : Natural := Pchar_Pos (Nkind (N));
826 Field_To_Be_Printed : Boolean;
827 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
829 Sfile : Source_File_Index;
834 if Phase /= Printing then
838 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
844 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
845 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
849 Print_Str (Prefix_Str);
854 if N > Atree_Private_Part.Nodes.Last then
855 Print_Str (" (no such node)");
860 if Comes_From_Source (N) then
862 Print_Str (" (source");
873 Print_Str ("analyzed");
876 if Error_Posted (N) then
884 Print_Str ("posted");
893 if Is_Rewrite_Substitution (N) then
894 Print_Str (Prefix_Str);
895 Print_Str (" Rewritten: original node = ");
896 Print_Node_Ref (Original_Node (N));
904 if not Is_List_Member (N) then
905 Print_Str (Prefix_Str);
906 Print_Str (" Parent = ");
907 Print_Node_Ref (Parent (N));
911 -- Print Sloc field if it is set
913 if Sloc (N) /= No_Location then
914 Print_Str (Prefix_Str_Char);
915 Print_Str ("Sloc = ");
917 if Sloc (N) = Standard_Location then
918 Print_Str ("Standard_Location");
920 elsif Sloc (N) = Standard_ASCII_Location then
921 Print_Str ("Standard_ASCII_Location");
924 Sfile := Get_Source_File_Index (Sloc (N));
925 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
927 Write_Location (Sloc (N));
933 -- Print Chars field if present
935 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
936 Print_Str (Prefix_Str_Char);
937 Print_Str ("Chars = ");
938 Print_Name (Chars (N));
939 Write_Str (" (Name_Id=");
940 Write_Int (Int (Chars (N)));
945 -- Special field print operations for non-entity nodes
947 if Nkind (N) not in N_Entity then
949 -- Deal with Left_Opnd and Right_Opnd fields
952 or else Nkind (N) in N_Short_Circuit
953 or else Nkind (N) in N_Membership_Test
955 -- Print Left_Opnd if present
957 if Nkind (N) not in N_Unary_Op then
958 Print_Str (Prefix_Str_Char);
959 Print_Str ("Left_Opnd = ");
960 Print_Node_Ref (Left_Opnd (N));
966 Print_Str (Prefix_Str_Char);
967 Print_Str ("Right_Opnd = ");
968 Print_Node_Ref (Right_Opnd (N));
972 -- Print Entity field if operator (other cases of Entity
973 -- are in the table, so are handled in the normal circuit)
975 if Nkind (N) in N_Op and then Present (Entity (N)) then
976 Print_Str (Prefix_Str_Char);
977 Print_Str ("Entity = ");
978 Print_Node_Ref (Entity (N));
982 -- Print special fields if we have a subexpression
984 if Nkind (N) in N_Subexpr then
986 if Assignment_OK (N) then
987 Print_Str (Prefix_Str_Char);
988 Print_Str ("Assignment_OK = True");
992 if Do_Range_Check (N) then
993 Print_Str (Prefix_Str_Char);
994 Print_Str ("Do_Range_Check = True");
998 if Has_Dynamic_Length_Check (N) then
999 Print_Str (Prefix_Str_Char);
1000 Print_Str ("Has_Dynamic_Length_Check = True");
1004 if Has_Dynamic_Range_Check (N) then
1005 Print_Str (Prefix_Str_Char);
1006 Print_Str ("Has_Dynamic_Range_Check = True");
1010 if Is_Controlling_Actual (N) then
1011 Print_Str (Prefix_Str_Char);
1012 Print_Str ("Is_Controlling_Actual = True");
1016 if Is_Overloaded (N) then
1017 Print_Str (Prefix_Str_Char);
1018 Print_Str ("Is_Overloaded = True");
1022 if Is_Static_Expression (N) then
1023 Print_Str (Prefix_Str_Char);
1024 Print_Str ("Is_Static_Expression = True");
1028 if Must_Not_Freeze (N) then
1029 Print_Str (Prefix_Str_Char);
1030 Print_Str ("Must_Not_Freeze = True");
1034 if Paren_Count (N) /= 0 then
1035 Print_Str (Prefix_Str_Char);
1036 Print_Str ("Paren_Count = ");
1037 Print_Int (Int (Paren_Count (N)));
1041 if Raises_Constraint_Error (N) then
1042 Print_Str (Prefix_Str_Char);
1043 Print_Str ("Raise_Constraint_Error = True");
1049 -- Print Do_Overflow_Check field if present
1051 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
1052 Print_Str (Prefix_Str_Char);
1053 Print_Str ("Do_Overflow_Check = True");
1057 -- Print Etype field if present (printing of this field for entities
1058 -- is handled by the Print_Entity_Info procedure).
1060 if Nkind (N) in N_Has_Etype and then Present (Etype (N)) then
1061 Print_Str (Prefix_Str_Char);
1062 Print_Str ("Etype = ");
1063 Print_Node_Ref (Etype (N));
1068 -- Loop to print fields included in Pchars array
1070 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1074 -- Check for case of False flag, which we never print, or
1075 -- an Empty field, which is also never printed
1079 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1082 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1085 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1088 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1091 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1093 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1094 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1095 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1096 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1097 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1098 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1099 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1100 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1101 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1102 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1103 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1104 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1105 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1106 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1107 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1109 -- Flag1,2,3 are no longer used
1111 when F_Flag1 => raise Program_Error;
1112 when F_Flag2 => raise Program_Error;
1113 when F_Flag3 => raise Program_Error;
1117 -- Print field if it is to be printed
1119 if Field_To_Be_Printed then
1120 Print_Str (Prefix_Str_Char);
1122 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1123 and then Pchars (P) not in Fchar
1125 Print_Char (Pchars (P));
1132 when F_Field1 => Print_Field (Field1 (N), Fmt);
1133 when F_Field2 => Print_Field (Field2 (N), Fmt);
1134 when F_Field3 => Print_Field (Field3 (N), Fmt);
1135 when F_Field4 => Print_Field (Field4 (N), Fmt);
1137 -- Special case End_Span = Uint5
1140 if Nkind (N) = N_Case_Statement
1141 or else Nkind (N) = N_If_Statement
1145 Print_Field (Field5 (N), Fmt);
1148 when F_Flag4 => Print_Flag (Flag4 (N));
1149 when F_Flag5 => Print_Flag (Flag5 (N));
1150 when F_Flag6 => Print_Flag (Flag6 (N));
1151 when F_Flag7 => Print_Flag (Flag7 (N));
1152 when F_Flag8 => Print_Flag (Flag8 (N));
1153 when F_Flag9 => Print_Flag (Flag9 (N));
1154 when F_Flag10 => Print_Flag (Flag10 (N));
1155 when F_Flag11 => Print_Flag (Flag11 (N));
1156 when F_Flag12 => Print_Flag (Flag12 (N));
1157 when F_Flag13 => Print_Flag (Flag13 (N));
1158 when F_Flag14 => Print_Flag (Flag14 (N));
1159 when F_Flag15 => Print_Flag (Flag15 (N));
1160 when F_Flag16 => Print_Flag (Flag16 (N));
1161 when F_Flag17 => Print_Flag (Flag17 (N));
1162 when F_Flag18 => Print_Flag (Flag18 (N));
1164 -- Flag1,2,3 are no longer used
1166 when F_Flag1 => raise Program_Error;
1167 when F_Flag2 => raise Program_Error;
1168 when F_Flag3 => raise Program_Error;
1173 -- Field is not to be printed (False flag field)
1176 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1177 and then Pchars (P) not in Fchar
1185 -- Print entity information for entities
1187 if Nkind (N) in N_Entity then
1188 Print_Entity_Info (N, Prefix_Str_Char);
1193 ---------------------
1194 -- Print_Node_Kind --
1195 ---------------------
1197 procedure Print_Node_Kind (N : Node_Id) is
1199 S : constant String := Node_Kind'Image (Nkind (N));
1202 if Phase = Printing then
1205 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1206 -- bug of 'Image returning lower case instead of upper case.
1208 for J in S'Range loop
1210 Write_Char (Fold_Upper (S (J)));
1212 Write_Char (Fold_Lower (S (J)));
1215 Ucase := (S (J) = '_');
1218 end Print_Node_Kind;
1220 --------------------
1221 -- Print_Node_Ref --
1222 --------------------
1224 procedure Print_Node_Ref (N : Node_Id) is
1228 if Phase /= Printing then
1233 Write_Str ("<empty>");
1235 elsif N = Error then
1236 Write_Str ("<error>");
1239 if Printing_Descendants then
1240 S := Serial_Number (Int (N));
1250 Print_Node_Kind (N);
1252 if Nkind (N) in N_Has_Chars then
1254 Print_Name (Chars (N));
1257 if Nkind (N) in N_Entity then
1258 Write_Str (" (Entity_Id=");
1260 Write_Str (" (Node_Id=");
1263 Write_Int (Int (N));
1265 if Sloc (N) <= Standard_Location then
1274 ------------------------
1275 -- Print_Node_Subtree --
1276 ------------------------
1278 procedure Print_Node_Subtree (N : Node_Id) is
1282 Next_Serial_Number := 1;
1284 Visit_Node (N, "", ' ');
1286 Next_Serial_Number := 1;
1288 Visit_Node (N, "", ' ');
1291 end Print_Node_Subtree;
1297 procedure Print_Str (S : String) is
1299 if Phase = Printing then
1304 --------------------------
1305 -- Print_Str_Mixed_Case --
1306 --------------------------
1308 procedure Print_Str_Mixed_Case (S : String) is
1312 if Phase = Printing then
1315 for J in S'Range loop
1319 Write_Char (Fold_Lower (S (J)));
1322 Ucase := (S (J) = '_');
1325 end Print_Str_Mixed_Case;
1331 procedure Print_Term is
1332 procedure Free is new Unchecked_Deallocation
1333 (Hash_Table_Type, Access_Hash_Table_Type);
1339 ---------------------
1340 -- Print_Tree_Elist --
1341 ---------------------
1343 procedure Print_Tree_Elist (E : Elist_Id) is
1347 Printing_Descendants := False;
1350 Print_Elist_Ref (E);
1353 M := First_Elmt (E);
1356 Print_Str ("<empty element list>");
1363 exit when No (Next_Elmt (M));
1364 Print_Node (Node (M), "", '|');
1368 Print_Node (Node (M), "", ' ');
1371 end Print_Tree_Elist;
1373 ---------------------
1374 -- Print_Tree_List --
1375 ---------------------
1377 procedure Print_Tree_List (L : List_Id) is
1381 Printing_Descendants := False;
1385 Print_Str (" List_Id=");
1386 Print_Int (Int (L));
1392 Print_Str ("<empty node list>");
1399 exit when Next (N) = Empty;
1400 Print_Node (N, "", '|');
1404 Print_Node (N, "", ' ');
1407 end Print_Tree_List;
1409 ---------------------
1410 -- Print_Tree_Node --
1411 ---------------------
1413 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1415 Printing_Descendants := False;
1417 Print_Node (N, Label, ' ');
1418 end Print_Tree_Node;
1424 procedure pt (N : Node_Id) is
1426 Print_Node_Subtree (N);
1433 -- The hashing algorithm is to use the remainder of the ID value divided
1434 -- by the hash table length as the starting point in the table, and then
1435 -- handle collisions by serial searching wrapping at the end of the table.
1438 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1439 -- to save the slot that should be used if Set_Serial_Number is called.
1441 function Serial_Number (Id : Int) return Nat is
1442 H : Int := Id mod Hash_Table_Len;
1445 while Hash_Table (H).Serial /= 0 loop
1447 if Id = Hash_Table (H).Id then
1448 return Hash_Table (H).Serial;
1453 if H > Hash_Table'Last then
1458 -- Entry was not found, save slot number for possible subsequent call
1459 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1460 -- in case of such a call (the Id field is never read if the serial
1461 -- number of the slot is zero, so this is harmless in the case where
1462 -- Set_Serial_Number is not subsequently called).
1465 Hash_Table (H).Id := Id;
1470 -----------------------
1471 -- Set_Serial_Number --
1472 -----------------------
1474 procedure Set_Serial_Number is
1476 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1477 Next_Serial_Number := Next_Serial_Number + 1;
1478 end Set_Serial_Number;
1484 procedure Tree_Dump is
1485 procedure Underline;
1486 -- Put underline under string we just printed
1488 procedure Underline is
1489 Col : constant Int := Column;
1494 while Col > Column loop
1501 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1502 -- flags immediately, before starting the dump. This avoids generating two
1503 -- copies of the dump if an abort occurs after printing the dump, and more
1504 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1506 -- Note: unlike in the source print case (in Sprint), we do not output
1507 -- separate trees for each unit. Instead the -df debug switch causes the
1508 -- tree that is output from the main unit to trace references into other
1509 -- units (normally such references are not traced). Since all other units
1510 -- are linked to the main unit by at least one reference, this causes all
1511 -- tree nodes to be included in the output tree.
1514 if Debug_Flag_Y then
1515 Debug_Flag_Y := False;
1517 Write_Str ("Tree created for Standard (spec) ");
1519 Print_Node_Subtree (Standard_Package_Node);
1523 if Debug_Flag_T then
1524 Debug_Flag_T := False;
1527 Write_Str ("Tree created for ");
1528 Write_Unit_Name (Unit_Name (Main_Unit));
1530 Print_Node_Subtree (Cunit (Main_Unit));
1540 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1543 S : constant Nat := Serial_Number (Int (E));
1546 -- In marking phase, return if already marked, otherwise set next
1547 -- serial number in hash table for later reference.
1549 if Phase = Marking then
1551 return; -- already visited
1556 -- In printing phase, if already printed, then return, otherwise we
1557 -- are printing the next item, so increment the serial number.
1560 if S < Next_Serial_Number then
1561 return; -- already printed
1563 Next_Serial_Number := Next_Serial_Number + 1;
1567 -- Now process the list (Print calls have no effect in marking phase)
1569 Print_Str (Prefix_Str);
1570 Print_Elist_Ref (E);
1573 if Is_Empty_Elmt_List (E) then
1574 Print_Str (Prefix_Str);
1575 Print_Str ("(Empty element list)");
1580 if Phase = Printing then
1581 M := First_Elmt (E);
1582 while Present (M) loop
1584 Print_Str (Prefix_Str);
1591 Print_Str (Prefix_Str);
1595 M := First_Elmt (E);
1596 while Present (M) loop
1597 Visit_Node (Node (M), Prefix_Str, ' ');
1607 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1609 S : constant Nat := Serial_Number (Int (L));
1612 -- In marking phase, return if already marked, otherwise set next
1613 -- serial number in hash table for later reference.
1615 if Phase = Marking then
1622 -- In printing phase, if already printed, then return, otherwise we
1623 -- are printing the next item, so increment the serial number.
1626 if S < Next_Serial_Number then
1627 return; -- already printed
1629 Next_Serial_Number := Next_Serial_Number + 1;
1633 -- Now process the list (Print calls have no effect in marking phase)
1635 Print_Str (Prefix_Str);
1639 Print_Str (Prefix_Str);
1640 Print_Str ("|Parent = ");
1641 Print_Node_Ref (Parent (L));
1647 Print_Str (Prefix_Str);
1648 Print_Str ("(Empty list)");
1653 Print_Str (Prefix_Str);
1657 while Next (N) /= Empty loop
1658 Visit_Node (N, Prefix_Str, '|');
1663 Visit_Node (N, Prefix_Str, ' ');
1670 procedure Visit_Node
1672 Prefix_Str : String;
1673 Prefix_Char : Character)
1675 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1676 -- Prefix string for printing referenced fields
1678 procedure Visit_Descendent
1680 No_Indent : Boolean := False);
1681 -- This procedure tests the given value of one of the Fields referenced
1682 -- by the current node to determine whether to visit it recursively.
1683 -- Normally No_Indent is false, which means that the visited node will
1684 -- be indented using New_Prefix. If No_Indent is set to True, then
1685 -- this indentation is skipped, and Prefix_Str is used for the call
1686 -- to print the descendent. No_Indent is effective only if the
1687 -- referenced descendent is a node.
1689 ----------------------
1690 -- Visit_Descendent --
1691 ----------------------
1693 procedure Visit_Descendent
1695 No_Indent : Boolean := False)
1698 -- Case of descendent is a node
1700 if D in Node_Range then
1702 -- Don't bother about Empty or Error descendents
1704 if D <= Union_Id (Empty_Or_Error) then
1709 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1712 -- Descendents in one of the standardly compiled internal
1713 -- packages are normally ignored, unless the parent is also
1714 -- in such a package (happens when Standard itself is output)
1715 -- or if the -df switch is set which causes all links to be
1716 -- followed, even into package standard.
1718 if Sloc (Nod) <= Standard_Location then
1719 if Sloc (N) > Standard_Location
1720 and then not Debug_Flag_F
1725 -- Don't bother about a descendent in a different unit than
1726 -- the node we came from unless the -df switch is set. Note
1727 -- that we know at this point that Sloc (D) > Standard_Location
1729 -- Note: the tests for No_Location here just make sure that we
1730 -- don't blow up on a node which is missing an Sloc value. This
1731 -- should not normally happen.
1734 if (Sloc (N) <= Standard_Location
1735 or else Sloc (N) = No_Location
1736 or else Sloc (Nod) = No_Location
1737 or else not In_Same_Source_Unit (Nod, N))
1738 and then not Debug_Flag_F
1744 -- Don't bother visiting a source node that has a parent which
1745 -- is not the node we came from. We prefer to trace such nodes
1746 -- from their real parents. This causes the tree to be printed
1747 -- in a more coherent order, e.g. a defining identifier listed
1748 -- next to its corresponding declaration, instead of next to
1749 -- some semantic reference.
1751 -- This test is skipped for nodes in standard packages unless
1752 -- the -dy option is set (which outputs the tree for standard)
1754 -- Also, always follow pointers to Is_Itype entities,
1755 -- since we want to list these when they are first referenced.
1757 if Parent (Nod) /= Empty
1758 and then Comes_From_Source (Nod)
1759 and then Parent (Nod) /= N
1760 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1765 -- If we successfully fall through all the above tests (which
1766 -- execute a return if the node is not to be visited), we can
1767 -- go ahead and visit the node!
1770 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1772 Visit_Node (Nod, New_Prefix, ' ');
1776 -- Case of descendent is a list
1778 elsif D in List_Range then
1780 -- Don't bother with a missing list, empty list or error list
1782 if D = Union_Id (No_List)
1783 or else D = Union_Id (Error_List)
1784 or else Is_Empty_List (List_Id (D))
1788 -- Otherwise we can visit the list. Note that we don't bother
1789 -- to do the parent test that we did for the node case, because
1790 -- it just does not happen that lists are referenced more than
1791 -- one place in the tree. We aren't counting on this being the
1792 -- case to generate valid output, it is just that we don't need
1793 -- in practice to worry about listing the list at a place that
1797 Visit_List (List_Id (D), New_Prefix);
1800 -- Case of descendent is an element list
1802 elsif D in Elist_Range then
1804 -- Don't bother with a missing list, or an empty list
1806 if D = Union_Id (No_Elist)
1807 or else Is_Empty_Elmt_List (Elist_Id (D))
1811 -- Otherwise, visit the referenced element list
1814 Visit_Elist (Elist_Id (D), New_Prefix);
1817 -- For all other kinds of descendents (strings, names, uints etc),
1818 -- there is nothing to visit (the contents of the field will be
1819 -- printed when we print the containing node, but what concerns
1820 -- us now is looking for descendents in the tree.
1825 end Visit_Descendent;
1827 -- Start of processing for Visit_Node
1834 -- Set fatal error node in case we get a blow up during the trace
1836 Current_Error_Node := N;
1838 New_Prefix (Prefix_Str'Range) := Prefix_Str;
1839 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
1840 New_Prefix (Prefix_Str'Last + 2) := ' ';
1842 -- In the marking phase, all we do is to set the serial number
1844 if Phase = Marking then
1845 if Serial_Number (Int (N)) /= 0 then
1846 return; -- already visited
1851 -- In the printing phase, we print the node
1854 if Serial_Number (Int (N)) < Next_Serial_Number then
1856 -- Here we have already visited the node, but if it is in
1857 -- a list, we still want to print the reference, so that
1858 -- it is clear that it belongs to the list.
1860 if Is_List_Member (N) then
1861 Print_Str (Prefix_Str);
1864 Print_Str (Prefix_Str);
1865 Print_Char (Prefix_Char);
1866 Print_Str ("(already output)");
1868 Print_Str (Prefix_Str);
1869 Print_Char (Prefix_Char);
1876 Print_Node (N, Prefix_Str, Prefix_Char);
1877 Print_Str (Prefix_Str);
1878 Print_Char (Prefix_Char);
1880 Next_Serial_Number := Next_Serial_Number + 1;
1884 -- Visit all descendents of this node
1886 if Nkind (N) not in N_Entity then
1887 Visit_Descendent (Field1 (N));
1888 Visit_Descendent (Field2 (N));
1889 Visit_Descendent (Field3 (N));
1890 Visit_Descendent (Field4 (N));
1891 Visit_Descendent (Field5 (N));
1896 Visit_Descendent (Field1 (N));
1897 Visit_Descendent (Field3 (N));
1898 Visit_Descendent (Field4 (N));
1899 Visit_Descendent (Field5 (N));
1900 Visit_Descendent (Field6 (N));
1901 Visit_Descendent (Field7 (N));
1902 Visit_Descendent (Field8 (N));
1903 Visit_Descendent (Field9 (N));
1904 Visit_Descendent (Field10 (N));
1905 Visit_Descendent (Field11 (N));
1906 Visit_Descendent (Field12 (N));
1907 Visit_Descendent (Field13 (N));
1908 Visit_Descendent (Field14 (N));
1909 Visit_Descendent (Field15 (N));
1910 Visit_Descendent (Field16 (N));
1911 Visit_Descendent (Field17 (N));
1912 Visit_Descendent (Field18 (N));
1913 Visit_Descendent (Field19 (N));
1914 Visit_Descendent (Field20 (N));
1915 Visit_Descendent (Field21 (N));
1916 Visit_Descendent (Field22 (N));
1917 Visit_Descendent (Field23 (N));
1919 -- Now an interesting kludge. Normally parents are always printed
1920 -- since we traverse the tree in a downwards direction. There is
1921 -- however an exception to this rule, which is the case where a
1922 -- parent is constructed by the compiler and is not referenced
1923 -- elsewhere in the tree. The following catches this case
1925 if not Comes_From_Source (N) then
1926 Visit_Descendent (Union_Id (Parent (N)));
1929 -- You may be wondering why we omitted Field2 above. The answer
1930 -- is that this is the Next_Entity field, and we want to treat
1931 -- it rather specially. Why? Because a Next_Entity link does not
1932 -- correspond to a level deeper in the tree, and we do not want
1933 -- the tree to march off to the right of the page due to bogus
1934 -- indentations coming from this effect.
1936 -- To prevent this, what we do is to control references via
1937 -- Next_Entity only from the first entity on a given scope
1938 -- chain, and we keep them all at the same level. Of course
1939 -- if an entity has already been referenced it is not printed.
1941 if Present (Next_Entity (N))
1942 and then Present (Scope (N))
1943 and then First_Entity (Scope (N)) = N
1950 while Present (Nod) loop
1951 Visit_Descendent (Union_Id (Next_Entity (Nod)));
1952 Nod := Next_Entity (Nod);