PR ada/18819
[official-gcc.git] / gcc / ada / treepr.adb
blob492451c60c8f810cae0f21896e76175de5e125b8
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- T R E E P R --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2006, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 -- --
25 ------------------------------------------------------------------------------
27 with Atree; use Atree;
28 with Csets; use Csets;
29 with Debug; use Debug;
30 with Einfo; use Einfo;
31 with Elists; use Elists;
32 with Lib; use Lib;
33 with Namet; use Namet;
34 with Nlists; use Nlists;
35 with Output; use Output;
36 with Sem_Mech; use Sem_Mech;
37 with Sinfo; use Sinfo;
38 with Snames; use Snames;
39 with Sinput; use Sinput;
40 with Stand; use Stand;
41 with Stringt; use Stringt;
42 with Treeprs; use Treeprs;
43 with Uintp; use Uintp;
44 with Urealp; use Urealp;
45 with Uname; use Uname;
46 with Unchecked_Deallocation;
48 package body Treepr is
50 use Atree.Unchecked_Access;
51 -- This module uses the unchecked access functions in package Atree
52 -- since it does an untyped traversal of the tree (we do not want to
53 -- count on the structure of the tree being correct in this routine!)
55 ----------------------------------
56 -- Approach Used for Tree Print --
57 ----------------------------------
59 -- When a complete subtree is being printed, a trace phase first marks
60 -- the nodes and lists to be printed. This trace phase allocates logical
61 -- numbers corresponding to the order in which the nodes and lists will
62 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
63 -- logical node numbers using a hash table. Output is done using a set
64 -- of Print_xxx routines, which are similar to the Write_xxx routines
65 -- with the same name, except that they do not generate any output in
66 -- the marking phase. This allows identical logic to be used in the
67 -- two phases.
69 -- Note that the hash table not only holds the serial numbers, but also
70 -- acts as a record of which nodes have already been visited. In the
71 -- marking phase, a node has been visited if it is already in the hash
72 -- table, and in the printing phase, we can tell whether a node has
73 -- already been printed by looking at the value of the serial number.
75 ----------------------
76 -- Global Variables --
77 ----------------------
79 type Hash_Record is record
80 Serial : Nat;
81 -- Serial number for hash table entry. A value of zero means that
82 -- the entry is currently unused.
84 Id : Int;
85 -- If serial number field is non-zero, contains corresponding Id value
86 end record;
88 type Hash_Table_Type is array (Nat range <>) of Hash_Record;
89 type Access_Hash_Table_Type is access Hash_Table_Type;
90 Hash_Table : Access_Hash_Table_Type;
91 -- The hash table itself, see Serial_Number function for details of use
93 Hash_Table_Len : Nat;
94 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
95 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
97 Next_Serial_Number : Nat;
98 -- Number of last visited node or list. Used during the marking phase to
99 -- set proper node numbers in the hash table, and during the printing
100 -- phase to make sure that a given node is not printed more than once.
101 -- (nodes are printed in order during the printing phase, that's the
102 -- point of numbering them in the first place!)
104 Printing_Descendants : Boolean;
105 -- True if descendants are being printed, False if not. In the false case,
106 -- only node Id's are printed. In the true case, node numbers as well as
107 -- node Id's are printed, as described above.
109 type Phase_Type is (Marking, Printing);
110 -- Type for Phase variable
112 Phase : Phase_Type;
113 -- When an entire tree is being printed, the traversal operates in two
114 -- phases. The first phase marks the nodes in use by installing node
115 -- numbers in the node number table. The second phase prints the nodes.
116 -- This variable indicates the current phase.
118 ----------------------
119 -- Local Procedures --
120 ----------------------
122 procedure Print_End_Span (N : Node_Id);
123 -- Special routine to print contents of End_Span field of node N.
124 -- The format includes the implicit source location as well as the
125 -- value of the field.
127 procedure Print_Init;
128 -- Initialize for printing of tree with descendents
130 procedure Print_Term;
131 -- Clean up after printing of tree with descendents
133 procedure Print_Char (C : Character);
134 -- Print character C if currently in print phase, noop if in marking phase
136 procedure Print_Name (N : Name_Id);
137 -- Print name from names table if currently in print phase, noop if in
138 -- marking phase. Note that the name is output in mixed case mode.
140 procedure Print_Node_Kind (N : Node_Id);
141 -- Print node kind name in mixed case if in print phase, noop if in
142 -- marking phase.
144 procedure Print_Str (S : String);
145 -- Print string S if currently in print phase, noop if in marking phase
147 procedure Print_Str_Mixed_Case (S : String);
148 -- Like Print_Str, except that the string is printed in mixed case mode
150 procedure Print_Int (I : Int);
151 -- Print integer I if currently in print phase, noop if in marking phase
153 procedure Print_Eol;
154 -- Print end of line if currently in print phase, noop if in marking phase
156 procedure Print_Node_Ref (N : Node_Id);
157 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
158 -- in the latter case, including the Id and the Nkind of the node.
160 procedure Print_List_Ref (L : List_Id);
161 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
163 procedure Print_Elist_Ref (E : Elist_Id);
164 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
166 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String);
167 -- Called if the node being printed is an entity. Prints fields from the
168 -- extension, using routines in Einfo to get the field names and flags.
170 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto);
171 -- Print representation of Field value (name, tree, string, uint, charcode)
172 -- The format parameter controls the format of printing in the case of an
173 -- integer value (see UI_Write for details).
175 procedure Print_Flag (F : Boolean);
176 -- Print True or False
178 procedure Print_Node
179 (N : Node_Id;
180 Prefix_Str : String;
181 Prefix_Char : Character);
182 -- This is the internal routine used to print a single node. Each line of
183 -- output is preceded by Prefix_Str (which is used to set the indentation
184 -- level and the bars used to link list elements). In addition, for lines
185 -- other than the first, an additional character Prefix_Char is output.
187 function Serial_Number (Id : Int) return Nat;
188 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
189 -- serial number, or zero if no serial number has yet been assigned.
191 procedure Set_Serial_Number;
192 -- Can be called only immediately following a call to Serial_Number that
193 -- returned a value of zero. Causes the value of Next_Serial_Number to be
194 -- placed in the hash table (corresponding to the Id argument used in the
195 -- Serial_Number call), and increments Next_Serial_Number.
197 procedure Visit_Node
198 (N : Node_Id;
199 Prefix_Str : String;
200 Prefix_Char : Character);
201 -- Called to process a single node in the case where descendents are to
202 -- be printed before every line, and Prefix_Char added to all lines
203 -- except the header line for the node.
205 procedure Visit_List (L : List_Id; Prefix_Str : String);
206 -- Visit_List is called to process a list in the case where descendents
207 -- are to be printed. Prefix_Str is to be added to all printed lines.
209 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String);
210 -- Visit_Elist is called to process an element list in the case where
211 -- descendents are to be printed. Prefix_Str is to be added to all
212 -- printed lines.
214 --------
215 -- pe --
216 --------
218 procedure pe (E : Elist_Id) is
219 begin
220 Print_Tree_Elist (E);
221 end pe;
223 --------
224 -- pl --
225 --------
227 procedure pl (L : List_Id) is
228 begin
229 Print_Tree_List (L);
230 end pl;
232 --------
233 -- pn --
234 --------
236 procedure pn (N : Node_Id) is
237 begin
238 Print_Tree_Node (N);
239 end pn;
241 ----------------
242 -- Print_Char --
243 ----------------
245 procedure Print_Char (C : Character) is
246 begin
247 if Phase = Printing then
248 Write_Char (C);
249 end if;
250 end Print_Char;
252 ---------------------
253 -- Print_Elist_Ref --
254 ---------------------
256 procedure Print_Elist_Ref (E : Elist_Id) is
257 begin
258 if Phase /= Printing then
259 return;
260 end if;
262 if E = No_Elist then
263 Write_Str ("<no elist>");
265 elsif Is_Empty_Elmt_List (E) then
266 Write_Str ("Empty elist, (Elist_Id=");
267 Write_Int (Int (E));
268 Write_Char (')');
270 else
271 Write_Str ("(Elist_Id=");
272 Write_Int (Int (E));
273 Write_Char (')');
275 if Printing_Descendants then
276 Write_Str (" #");
277 Write_Int (Serial_Number (Int (E)));
278 end if;
279 end if;
280 end Print_Elist_Ref;
282 -------------------------
283 -- Print_Elist_Subtree --
284 -------------------------
286 procedure Print_Elist_Subtree (E : Elist_Id) is
287 begin
288 Print_Init;
290 Next_Serial_Number := 1;
291 Phase := Marking;
292 Visit_Elist (E, "");
294 Next_Serial_Number := 1;
295 Phase := Printing;
296 Visit_Elist (E, "");
298 Print_Term;
299 end Print_Elist_Subtree;
301 --------------------
302 -- Print_End_Span --
303 --------------------
305 procedure Print_End_Span (N : Node_Id) is
306 Val : constant Uint := End_Span (N);
308 begin
309 UI_Write (Val);
310 Write_Str (" (Uint = ");
311 Write_Int (Int (Field5 (N)));
312 Write_Str (") ");
314 if Val /= No_Uint then
315 Write_Location (End_Location (N));
316 end if;
317 end Print_End_Span;
319 -----------------------
320 -- Print_Entity_Info --
321 -----------------------
323 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
324 function Field_Present (U : Union_Id) return Boolean;
325 -- Returns False unless the value U represents a missing value
326 -- (Empty, No_Uint, No_Ureal or No_String)
328 function Field_Present (U : Union_Id) return Boolean is
329 begin
330 return
331 U /= Union_Id (Empty) and then
332 U /= To_Union (No_Uint) and then
333 U /= To_Union (No_Ureal) and then
334 U /= Union_Id (No_String);
335 end Field_Present;
337 -- Start of processing for Print_Entity_Info
339 begin
340 Print_Str (Prefix);
341 Print_Str ("Ekind = ");
342 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
343 Print_Eol;
345 Print_Str (Prefix);
346 Print_Str ("Etype = ");
347 Print_Node_Ref (Etype (Ent));
348 Print_Eol;
350 if Convention (Ent) /= Convention_Ada then
351 Print_Str (Prefix);
352 Print_Str ("Convention = ");
354 -- Print convention name skipping the Convention_ at the start
356 declare
357 S : constant String := Convention_Id'Image (Convention (Ent));
359 begin
360 Print_Str_Mixed_Case (S (12 .. S'Last));
361 Print_Eol;
362 end;
363 end if;
365 if Field_Present (Field6 (Ent)) then
366 Print_Str (Prefix);
367 Write_Field6_Name (Ent);
368 Write_Str (" = ");
369 Print_Field (Field6 (Ent));
370 Print_Eol;
371 end if;
373 if Field_Present (Field7 (Ent)) then
374 Print_Str (Prefix);
375 Write_Field7_Name (Ent);
376 Write_Str (" = ");
377 Print_Field (Field7 (Ent));
378 Print_Eol;
379 end if;
381 if Field_Present (Field8 (Ent)) then
382 Print_Str (Prefix);
383 Write_Field8_Name (Ent);
384 Write_Str (" = ");
385 Print_Field (Field8 (Ent));
386 Print_Eol;
387 end if;
389 if Field_Present (Field9 (Ent)) then
390 Print_Str (Prefix);
391 Write_Field9_Name (Ent);
392 Write_Str (" = ");
393 Print_Field (Field9 (Ent));
394 Print_Eol;
395 end if;
397 if Field_Present (Field10 (Ent)) then
398 Print_Str (Prefix);
399 Write_Field10_Name (Ent);
400 Write_Str (" = ");
401 Print_Field (Field10 (Ent));
402 Print_Eol;
403 end if;
405 if Field_Present (Field11 (Ent)) then
406 Print_Str (Prefix);
407 Write_Field11_Name (Ent);
408 Write_Str (" = ");
409 Print_Field (Field11 (Ent));
410 Print_Eol;
411 end if;
413 if Field_Present (Field12 (Ent)) then
414 Print_Str (Prefix);
415 Write_Field12_Name (Ent);
416 Write_Str (" = ");
417 Print_Field (Field12 (Ent));
418 Print_Eol;
419 end if;
421 if Field_Present (Field13 (Ent)) then
422 Print_Str (Prefix);
423 Write_Field13_Name (Ent);
424 Write_Str (" = ");
425 Print_Field (Field13 (Ent));
426 Print_Eol;
427 end if;
429 if Field_Present (Field14 (Ent)) then
430 Print_Str (Prefix);
431 Write_Field14_Name (Ent);
432 Write_Str (" = ");
433 Print_Field (Field14 (Ent));
434 Print_Eol;
435 end if;
437 if Field_Present (Field15 (Ent)) then
438 Print_Str (Prefix);
439 Write_Field15_Name (Ent);
440 Write_Str (" = ");
441 Print_Field (Field15 (Ent));
442 Print_Eol;
443 end if;
445 if Field_Present (Field16 (Ent)) then
446 Print_Str (Prefix);
447 Write_Field16_Name (Ent);
448 Write_Str (" = ");
449 Print_Field (Field16 (Ent));
450 Print_Eol;
451 end if;
453 if Field_Present (Field17 (Ent)) then
454 Print_Str (Prefix);
455 Write_Field17_Name (Ent);
456 Write_Str (" = ");
457 Print_Field (Field17 (Ent));
458 Print_Eol;
459 end if;
461 if Field_Present (Field18 (Ent)) then
462 Print_Str (Prefix);
463 Write_Field18_Name (Ent);
464 Write_Str (" = ");
465 Print_Field (Field18 (Ent));
466 Print_Eol;
467 end if;
469 if Field_Present (Field19 (Ent)) then
470 Print_Str (Prefix);
471 Write_Field19_Name (Ent);
472 Write_Str (" = ");
473 Print_Field (Field19 (Ent));
474 Print_Eol;
475 end if;
477 if Field_Present (Field20 (Ent)) then
478 Print_Str (Prefix);
479 Write_Field20_Name (Ent);
480 Write_Str (" = ");
481 Print_Field (Field20 (Ent));
482 Print_Eol;
483 end if;
485 if Field_Present (Field21 (Ent)) then
486 Print_Str (Prefix);
487 Write_Field21_Name (Ent);
488 Write_Str (" = ");
489 Print_Field (Field21 (Ent));
490 Print_Eol;
491 end if;
493 if Field_Present (Field22 (Ent)) then
494 Print_Str (Prefix);
495 Write_Field22_Name (Ent);
496 Write_Str (" = ");
498 -- Mechanism case has to be handled specially
500 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
501 declare
502 M : constant Mechanism_Type := Mechanism (Ent);
504 begin
505 case M is
506 when Default_Mechanism => Write_Str ("Default");
507 when By_Copy => Write_Str ("By_Copy");
508 when By_Reference => Write_Str ("By_Reference");
509 when By_Descriptor => Write_Str ("By_Descriptor");
510 when By_Descriptor_UBS => Write_Str ("By_Descriptor_UBS");
511 when By_Descriptor_UBSB => Write_Str ("By_Descriptor_UBSB");
512 when By_Descriptor_UBA => Write_Str ("By_Descriptor_UBA");
513 when By_Descriptor_S => Write_Str ("By_Descriptor_S");
514 when By_Descriptor_SB => Write_Str ("By_Descriptor_SB");
515 when By_Descriptor_A => Write_Str ("By_Descriptor_A");
516 when By_Descriptor_NCA => Write_Str ("By_Descriptor_NCA");
518 when 1 .. Mechanism_Type'Last =>
519 Write_Str ("By_Copy if size <= ");
520 Write_Int (Int (M));
522 end case;
523 end;
525 -- Normal case (not Mechanism)
527 else
528 Print_Field (Field22 (Ent));
529 end if;
531 Print_Eol;
532 end if;
534 if Field_Present (Field23 (Ent)) then
535 Print_Str (Prefix);
536 Write_Field23_Name (Ent);
537 Write_Str (" = ");
538 Print_Field (Field23 (Ent));
539 Print_Eol;
540 end if;
542 if Field_Present (Field24 (Ent)) then
543 Print_Str (Prefix);
544 Write_Field24_Name (Ent);
545 Write_Str (" = ");
546 Print_Field (Field24 (Ent));
547 Print_Eol;
548 end if;
550 if Field_Present (Field25 (Ent)) then
551 Print_Str (Prefix);
552 Write_Field25_Name (Ent);
553 Write_Str (" = ");
554 Print_Field (Field25 (Ent));
555 Print_Eol;
556 end if;
558 if Field_Present (Field26 (Ent)) then
559 Print_Str (Prefix);
560 Write_Field26_Name (Ent);
561 Write_Str (" = ");
562 Print_Field (Field26 (Ent));
563 Print_Eol;
564 end if;
566 if Field_Present (Field27 (Ent)) then
567 Print_Str (Prefix);
568 Write_Field27_Name (Ent);
569 Write_Str (" = ");
570 Print_Field (Field27 (Ent));
571 Print_Eol;
572 end if;
574 Write_Entity_Flags (Ent, Prefix);
575 end Print_Entity_Info;
577 ---------------
578 -- Print_Eol --
579 ---------------
581 procedure Print_Eol is
582 begin
583 if Phase = Printing then
584 Write_Eol;
585 end if;
586 end Print_Eol;
588 -----------------
589 -- Print_Field --
590 -----------------
592 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
593 begin
594 if Phase /= Printing then
595 return;
596 end if;
598 if Val in Node_Range then
599 Print_Node_Ref (Node_Id (Val));
601 elsif Val in List_Range then
602 Print_List_Ref (List_Id (Val));
604 elsif Val in Elist_Range then
605 Print_Elist_Ref (Elist_Id (Val));
607 elsif Val in Names_Range then
608 Print_Name (Name_Id (Val));
609 Write_Str (" (Name_Id=");
610 Write_Int (Int (Val));
611 Write_Char (')');
613 elsif Val in Strings_Range then
614 Write_String_Table_Entry (String_Id (Val));
615 Write_Str (" (String_Id=");
616 Write_Int (Int (Val));
617 Write_Char (')');
619 elsif Val in Uint_Range then
620 UI_Write (From_Union (Val), Format);
621 Write_Str (" (Uint = ");
622 Write_Int (Int (Val));
623 Write_Char (')');
625 elsif Val in Ureal_Range then
626 UR_Write (From_Union (Val));
627 Write_Str (" (Ureal = ");
628 Write_Int (Int (Val));
629 Write_Char (')');
631 else
632 Print_Str ("****** Incorrect value = ");
633 Print_Int (Int (Val));
634 end if;
635 end Print_Field;
637 ----------------
638 -- Print_Flag --
639 ----------------
641 procedure Print_Flag (F : Boolean) is
642 begin
643 if F then
644 Print_Str ("True");
645 else
646 Print_Str ("False");
647 end if;
648 end Print_Flag;
650 ----------------
651 -- Print_Init --
652 ----------------
654 procedure Print_Init is
655 begin
656 Printing_Descendants := True;
657 Write_Eol;
659 -- Allocate and clear serial number hash table. The size is 150% of
660 -- the maximum possible number of entries, so that the hash table
661 -- cannot get significantly overloaded.
663 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
664 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
666 for J in Hash_Table'Range loop
667 Hash_Table (J).Serial := 0;
668 end loop;
670 end Print_Init;
672 ---------------
673 -- Print_Int --
674 ---------------
676 procedure Print_Int (I : Int) is
677 begin
678 if Phase = Printing then
679 Write_Int (I);
680 end if;
681 end Print_Int;
683 --------------------
684 -- Print_List_Ref --
685 --------------------
687 procedure Print_List_Ref (L : List_Id) is
688 begin
689 if Phase /= Printing then
690 return;
691 end if;
693 if No (L) then
694 Write_Str ("<no list>");
696 elsif Is_Empty_List (L) then
697 Write_Str ("<empty list> (List_Id=");
698 Write_Int (Int (L));
699 Write_Char (')');
701 else
702 Write_Str ("List");
704 if Printing_Descendants then
705 Write_Str (" #");
706 Write_Int (Serial_Number (Int (L)));
707 end if;
709 Write_Str (" (List_Id=");
710 Write_Int (Int (L));
711 Write_Char (')');
712 end if;
713 end Print_List_Ref;
715 ------------------------
716 -- Print_List_Subtree --
717 ------------------------
719 procedure Print_List_Subtree (L : List_Id) is
720 begin
721 Print_Init;
723 Next_Serial_Number := 1;
724 Phase := Marking;
725 Visit_List (L, "");
727 Next_Serial_Number := 1;
728 Phase := Printing;
729 Visit_List (L, "");
731 Print_Term;
732 end Print_List_Subtree;
734 ----------------
735 -- Print_Name --
736 ----------------
738 procedure Print_Name (N : Name_Id) is
739 begin
740 if Phase = Printing then
741 if N = No_Name then
742 Print_Str ("<No_Name>");
744 elsif N = Error_Name then
745 Print_Str ("<Error_Name>");
747 else
748 Get_Name_String (N);
749 Print_Char ('"');
750 Write_Name (N);
751 Print_Char ('"');
752 end if;
753 end if;
754 end Print_Name;
756 ----------------
757 -- Print_Node --
758 ----------------
760 procedure Print_Node
761 (N : Node_Id;
762 Prefix_Str : String;
763 Prefix_Char : Character)
765 F : Fchar;
766 P : Natural := Pchar_Pos (Nkind (N));
768 Field_To_Be_Printed : Boolean;
769 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
771 Sfile : Source_File_Index;
772 Notes : Boolean;
773 Fmt : UI_Format;
775 begin
776 if Phase /= Printing then
777 return;
778 end if;
780 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
781 Fmt := Hex;
782 else
783 Fmt := Auto;
784 end if;
786 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
787 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
789 -- Print header line
791 Print_Str (Prefix_Str);
792 Print_Node_Ref (N);
794 Notes := False;
796 if Comes_From_Source (N) then
797 Notes := True;
798 Print_Str (" (source");
799 end if;
801 if Analyzed (N) then
802 if not Notes then
803 Notes := True;
804 Print_Str (" (");
805 else
806 Print_Str (",");
807 end if;
809 Print_Str ("analyzed");
810 end if;
812 if Error_Posted (N) then
813 if not Notes then
814 Notes := True;
815 Print_Str (" (");
816 else
817 Print_Str (",");
818 end if;
820 Print_Str ("posted");
821 end if;
823 if Notes then
824 Print_Char (')');
825 end if;
827 Print_Eol;
829 if Is_Rewrite_Substitution (N) then
830 Print_Str (Prefix_Str);
831 Print_Str (" Rewritten: original node = ");
832 Print_Node_Ref (Original_Node (N));
833 Print_Eol;
834 end if;
836 if N = Empty then
837 return;
838 end if;
840 if not Is_List_Member (N) then
841 Print_Str (Prefix_Str);
842 Print_Str (" Parent = ");
843 Print_Node_Ref (Parent (N));
844 Print_Eol;
845 end if;
847 -- Print Sloc field if it is set
849 if Sloc (N) /= No_Location then
850 Print_Str (Prefix_Str_Char);
851 Print_Str ("Sloc = ");
853 if Sloc (N) = Standard_Location then
854 Print_Str ("Standard_Location");
856 elsif Sloc (N) = Standard_ASCII_Location then
857 Print_Str ("Standard_ASCII_Location");
859 else
860 Sfile := Get_Source_File_Index (Sloc (N));
861 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
862 Write_Str (" ");
863 Write_Location (Sloc (N));
864 end if;
866 Print_Eol;
867 end if;
869 -- Print Chars field if present
871 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
872 Print_Str (Prefix_Str_Char);
873 Print_Str ("Chars = ");
874 Print_Name (Chars (N));
875 Write_Str (" (Name_Id=");
876 Write_Int (Int (Chars (N)));
877 Write_Char (')');
878 Print_Eol;
879 end if;
881 -- Special field print operations for non-entity nodes
883 if Nkind (N) not in N_Entity then
885 -- Deal with Left_Opnd and Right_Opnd fields
887 if Nkind (N) in N_Op
888 or else Nkind (N) = N_And_Then
889 or else Nkind (N) = N_Or_Else
890 or else Nkind (N) in N_Membership_Test
891 then
892 -- Print Left_Opnd if present
894 if Nkind (N) not in N_Unary_Op then
895 Print_Str (Prefix_Str_Char);
896 Print_Str ("Left_Opnd = ");
897 Print_Node_Ref (Left_Opnd (N));
898 Print_Eol;
899 end if;
901 -- Print Right_Opnd
903 Print_Str (Prefix_Str_Char);
904 Print_Str ("Right_Opnd = ");
905 Print_Node_Ref (Right_Opnd (N));
906 Print_Eol;
907 end if;
909 -- Print Entity field if operator (other cases of Entity
910 -- are in the table, so are handled in the normal circuit)
912 if Nkind (N) in N_Op and then Present (Entity (N)) then
913 Print_Str (Prefix_Str_Char);
914 Print_Str ("Entity = ");
915 Print_Node_Ref (Entity (N));
916 Print_Eol;
917 end if;
919 -- Print special fields if we have a subexpression
921 if Nkind (N) in N_Subexpr then
923 if Assignment_OK (N) then
924 Print_Str (Prefix_Str_Char);
925 Print_Str ("Assignment_OK = True");
926 Print_Eol;
927 end if;
929 if Do_Range_Check (N) then
930 Print_Str (Prefix_Str_Char);
931 Print_Str ("Do_Range_Check = True");
932 Print_Eol;
933 end if;
935 if Has_Dynamic_Length_Check (N) then
936 Print_Str (Prefix_Str_Char);
937 Print_Str ("Has_Dynamic_Length_Check = True");
938 Print_Eol;
939 end if;
941 if Has_Dynamic_Range_Check (N) then
942 Print_Str (Prefix_Str_Char);
943 Print_Str ("Has_Dynamic_Range_Check = True");
944 Print_Eol;
945 end if;
947 if Is_Controlling_Actual (N) then
948 Print_Str (Prefix_Str_Char);
949 Print_Str ("Is_Controlling_Actual = True");
950 Print_Eol;
951 end if;
953 if Is_Overloaded (N) then
954 Print_Str (Prefix_Str_Char);
955 Print_Str ("Is_Overloaded = True");
956 Print_Eol;
957 end if;
959 if Is_Static_Expression (N) then
960 Print_Str (Prefix_Str_Char);
961 Print_Str ("Is_Static_Expression = True");
962 Print_Eol;
963 end if;
965 if Must_Not_Freeze (N) then
966 Print_Str (Prefix_Str_Char);
967 Print_Str ("Must_Not_Freeze = True");
968 Print_Eol;
969 end if;
971 if Paren_Count (N) /= 0 then
972 Print_Str (Prefix_Str_Char);
973 Print_Str ("Paren_Count = ");
974 Print_Int (Int (Paren_Count (N)));
975 Print_Eol;
976 end if;
978 if Raises_Constraint_Error (N) then
979 Print_Str (Prefix_Str_Char);
980 Print_Str ("Raise_Constraint_Error = True");
981 Print_Eol;
982 end if;
984 end if;
986 -- Print Do_Overflow_Check field if present
988 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
989 Print_Str (Prefix_Str_Char);
990 Print_Str ("Do_Overflow_Check = True");
991 Print_Eol;
992 end if;
994 -- Print Etype field if present (printing of this field for entities
995 -- is handled by the Print_Entity_Info procedure).
997 if Nkind (N) in N_Has_Etype
998 and then Present (Etype (N))
999 then
1000 Print_Str (Prefix_Str_Char);
1001 Print_Str ("Etype = ");
1002 Print_Node_Ref (Etype (N));
1003 Print_Eol;
1004 end if;
1005 end if;
1007 -- Loop to print fields included in Pchars array
1009 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1010 F := Pchars (P);
1011 P := P + 1;
1013 -- Check for case of False flag, which we never print, or
1014 -- an Empty field, which is also never printed
1016 case F is
1017 when F_Field1 =>
1018 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1020 when F_Field2 =>
1021 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1023 when F_Field3 =>
1024 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1026 when F_Field4 =>
1027 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1029 when F_Field5 =>
1030 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1032 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1033 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1034 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1035 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1036 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1037 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1038 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1039 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1040 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1041 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1042 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1043 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1044 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1045 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1046 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1048 -- Flag1,2,3 are no longer used
1050 when F_Flag1 => raise Program_Error;
1051 when F_Flag2 => raise Program_Error;
1052 when F_Flag3 => raise Program_Error;
1054 end case;
1056 -- Print field if it is to be printed
1058 if Field_To_Be_Printed then
1059 Print_Str (Prefix_Str_Char);
1061 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1062 and then Pchars (P) not in Fchar
1063 loop
1064 Print_Char (Pchars (P));
1065 P := P + 1;
1066 end loop;
1068 Print_Str (" = ");
1070 case F is
1071 when F_Field1 => Print_Field (Field1 (N), Fmt);
1072 when F_Field2 => Print_Field (Field2 (N), Fmt);
1073 when F_Field3 => Print_Field (Field3 (N), Fmt);
1074 when F_Field4 => Print_Field (Field4 (N), Fmt);
1076 -- Special case End_Span = Uint5
1078 when F_Field5 =>
1079 if Nkind (N) = N_Case_Statement
1080 or else Nkind (N) = N_If_Statement
1081 then
1082 Print_End_Span (N);
1083 else
1084 Print_Field (Field5 (N), Fmt);
1085 end if;
1087 when F_Flag4 => Print_Flag (Flag4 (N));
1088 when F_Flag5 => Print_Flag (Flag5 (N));
1089 when F_Flag6 => Print_Flag (Flag6 (N));
1090 when F_Flag7 => Print_Flag (Flag7 (N));
1091 when F_Flag8 => Print_Flag (Flag8 (N));
1092 when F_Flag9 => Print_Flag (Flag9 (N));
1093 when F_Flag10 => Print_Flag (Flag10 (N));
1094 when F_Flag11 => Print_Flag (Flag11 (N));
1095 when F_Flag12 => Print_Flag (Flag12 (N));
1096 when F_Flag13 => Print_Flag (Flag13 (N));
1097 when F_Flag14 => Print_Flag (Flag14 (N));
1098 when F_Flag15 => Print_Flag (Flag15 (N));
1099 when F_Flag16 => Print_Flag (Flag16 (N));
1100 when F_Flag17 => Print_Flag (Flag17 (N));
1101 when F_Flag18 => Print_Flag (Flag18 (N));
1103 -- Flag1,2,3 are no longer used
1105 when F_Flag1 => raise Program_Error;
1106 when F_Flag2 => raise Program_Error;
1107 when F_Flag3 => raise Program_Error;
1108 end case;
1110 Print_Eol;
1112 -- Field is not to be printed (False flag field)
1114 else
1115 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1116 and then Pchars (P) not in Fchar
1117 loop
1118 P := P + 1;
1119 end loop;
1120 end if;
1122 end loop;
1124 -- Print entity information for entities
1126 if Nkind (N) in N_Entity then
1127 Print_Entity_Info (N, Prefix_Str_Char);
1128 end if;
1130 end Print_Node;
1132 ---------------------
1133 -- Print_Node_Kind --
1134 ---------------------
1136 procedure Print_Node_Kind (N : Node_Id) is
1137 Ucase : Boolean;
1138 S : constant String := Node_Kind'Image (Nkind (N));
1140 begin
1141 if Phase = Printing then
1142 Ucase := True;
1144 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1145 -- bug of 'Image returning lower case instead of upper case.
1147 for J in S'Range loop
1148 if Ucase then
1149 Write_Char (Fold_Upper (S (J)));
1150 else
1151 Write_Char (Fold_Lower (S (J)));
1152 end if;
1154 Ucase := (S (J) = '_');
1155 end loop;
1156 end if;
1157 end Print_Node_Kind;
1159 --------------------
1160 -- Print_Node_Ref --
1161 --------------------
1163 procedure Print_Node_Ref (N : Node_Id) is
1164 S : Nat;
1166 begin
1167 if Phase /= Printing then
1168 return;
1169 end if;
1171 if N = Empty then
1172 Write_Str ("<empty>");
1174 elsif N = Error then
1175 Write_Str ("<error>");
1177 else
1178 if Printing_Descendants then
1179 S := Serial_Number (Int (N));
1181 if S /= 0 then
1182 Write_Str ("Node");
1183 Write_Str (" #");
1184 Write_Int (S);
1185 Write_Char (' ');
1186 end if;
1187 end if;
1189 Print_Node_Kind (N);
1191 if Nkind (N) in N_Has_Chars then
1192 Write_Char (' ');
1193 Print_Name (Chars (N));
1194 end if;
1196 if Nkind (N) in N_Entity then
1197 Write_Str (" (Entity_Id=");
1198 else
1199 Write_Str (" (Node_Id=");
1200 end if;
1202 Write_Int (Int (N));
1204 if Sloc (N) <= Standard_Location then
1205 Write_Char ('s');
1206 end if;
1208 Write_Char (')');
1210 end if;
1211 end Print_Node_Ref;
1213 ------------------------
1214 -- Print_Node_Subtree --
1215 ------------------------
1217 procedure Print_Node_Subtree (N : Node_Id) is
1218 begin
1219 Print_Init;
1221 Next_Serial_Number := 1;
1222 Phase := Marking;
1223 Visit_Node (N, "", ' ');
1225 Next_Serial_Number := 1;
1226 Phase := Printing;
1227 Visit_Node (N, "", ' ');
1229 Print_Term;
1230 end Print_Node_Subtree;
1232 ---------------
1233 -- Print_Str --
1234 ---------------
1236 procedure Print_Str (S : String) is
1237 begin
1238 if Phase = Printing then
1239 Write_Str (S);
1240 end if;
1241 end Print_Str;
1243 --------------------------
1244 -- Print_Str_Mixed_Case --
1245 --------------------------
1247 procedure Print_Str_Mixed_Case (S : String) is
1248 Ucase : Boolean;
1250 begin
1251 if Phase = Printing then
1252 Ucase := True;
1254 for J in S'Range loop
1255 if Ucase then
1256 Write_Char (S (J));
1257 else
1258 Write_Char (Fold_Lower (S (J)));
1259 end if;
1261 Ucase := (S (J) = '_');
1262 end loop;
1263 end if;
1264 end Print_Str_Mixed_Case;
1266 ----------------
1267 -- Print_Term --
1268 ----------------
1270 procedure Print_Term is
1271 procedure Free is new Unchecked_Deallocation
1272 (Hash_Table_Type, Access_Hash_Table_Type);
1274 begin
1275 Free (Hash_Table);
1276 end Print_Term;
1278 ---------------------
1279 -- Print_Tree_Elist --
1280 ---------------------
1282 procedure Print_Tree_Elist (E : Elist_Id) is
1283 M : Elmt_Id;
1285 begin
1286 Printing_Descendants := False;
1287 Phase := Printing;
1289 Print_Elist_Ref (E);
1290 Print_Eol;
1292 M := First_Elmt (E);
1294 if No (M) then
1295 Print_Str ("<empty element list>");
1296 Print_Eol;
1298 else
1299 loop
1300 Print_Char ('|');
1301 Print_Eol;
1302 exit when No (Next_Elmt (M));
1303 Print_Node (Node (M), "", '|');
1304 Next_Elmt (M);
1305 end loop;
1307 Print_Node (Node (M), "", ' ');
1308 Print_Eol;
1309 end if;
1310 end Print_Tree_Elist;
1312 ---------------------
1313 -- Print_Tree_List --
1314 ---------------------
1316 procedure Print_Tree_List (L : List_Id) is
1317 N : Node_Id;
1319 begin
1320 Printing_Descendants := False;
1321 Phase := Printing;
1323 Print_List_Ref (L);
1324 Print_Str (" List_Id=");
1325 Print_Int (Int (L));
1326 Print_Eol;
1328 N := First (L);
1330 if N = Empty then
1331 Print_Str ("<empty node list>");
1332 Print_Eol;
1334 else
1335 loop
1336 Print_Char ('|');
1337 Print_Eol;
1338 exit when Next (N) = Empty;
1339 Print_Node (N, "", '|');
1340 Next (N);
1341 end loop;
1343 Print_Node (N, "", ' ');
1344 Print_Eol;
1345 end if;
1346 end Print_Tree_List;
1348 ---------------------
1349 -- Print_Tree_Node --
1350 ---------------------
1352 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1353 begin
1354 Printing_Descendants := False;
1355 Phase := Printing;
1356 Print_Node (N, Label, ' ');
1357 end Print_Tree_Node;
1359 --------
1360 -- pt --
1361 --------
1363 procedure pt (N : Node_Id) is
1364 begin
1365 Print_Node_Subtree (N);
1366 end pt;
1368 -------------------
1369 -- Serial_Number --
1370 -------------------
1372 -- The hashing algorithm is to use the remainder of the ID value divided
1373 -- by the hash table length as the starting point in the table, and then
1374 -- handle collisions by serial searching wrapping at the end of the table.
1376 Hash_Slot : Nat;
1377 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1378 -- to save the slot that should be used if Set_Serial_Number is called.
1380 function Serial_Number (Id : Int) return Nat is
1381 H : Int := Id mod Hash_Table_Len;
1383 begin
1384 while Hash_Table (H).Serial /= 0 loop
1386 if Id = Hash_Table (H).Id then
1387 return Hash_Table (H).Serial;
1388 end if;
1390 H := H + 1;
1392 if H > Hash_Table'Last then
1393 H := 0;
1394 end if;
1395 end loop;
1397 -- Entry was not found, save slot number for possible subsequent call
1398 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1399 -- in case of such a call (the Id field is never read if the serial
1400 -- number of the slot is zero, so this is harmless in the case where
1401 -- Set_Serial_Number is not subsequently called).
1403 Hash_Slot := H;
1404 Hash_Table (H).Id := Id;
1405 return 0;
1407 end Serial_Number;
1409 -----------------------
1410 -- Set_Serial_Number --
1411 -----------------------
1413 procedure Set_Serial_Number is
1414 begin
1415 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1416 Next_Serial_Number := Next_Serial_Number + 1;
1417 end Set_Serial_Number;
1419 ---------------
1420 -- Tree_Dump --
1421 ---------------
1423 procedure Tree_Dump is
1424 procedure Underline;
1425 -- Put underline under string we just printed
1427 procedure Underline is
1428 Col : constant Int := Column;
1430 begin
1431 Write_Eol;
1433 while Col > Column loop
1434 Write_Char ('-');
1435 end loop;
1437 Write_Eol;
1438 end Underline;
1440 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1441 -- flags immediately, before starting the dump. This avoids generating two
1442 -- copies of the dump if an abort occurs after printing the dump, and more
1443 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1445 -- Note: unlike in the source print case (in Sprint), we do not output
1446 -- separate trees for each unit. Instead the -df debug switch causes the
1447 -- tree that is output from the main unit to trace references into other
1448 -- units (normally such references are not traced). Since all other units
1449 -- are linked to the main unit by at least one reference, this causes all
1450 -- tree nodes to be included in the output tree.
1452 begin
1453 if Debug_Flag_Y then
1454 Debug_Flag_Y := False;
1455 Write_Eol;
1456 Write_Str ("Tree created for Standard (spec) ");
1457 Underline;
1458 Print_Node_Subtree (Standard_Package_Node);
1459 Write_Eol;
1460 end if;
1462 if Debug_Flag_T then
1463 Debug_Flag_T := False;
1465 Write_Eol;
1466 Write_Str ("Tree created for ");
1467 Write_Unit_Name (Unit_Name (Main_Unit));
1468 Underline;
1469 Print_Node_Subtree (Cunit (Main_Unit));
1470 Write_Eol;
1471 end if;
1473 end Tree_Dump;
1475 -----------------
1476 -- Visit_Elist --
1477 -----------------
1479 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1480 M : Elmt_Id;
1481 N : Node_Id;
1482 S : constant Nat := Serial_Number (Int (E));
1484 begin
1485 -- In marking phase, return if already marked, otherwise set next
1486 -- serial number in hash table for later reference.
1488 if Phase = Marking then
1489 if S /= 0 then
1490 return; -- already visited
1491 else
1492 Set_Serial_Number;
1493 end if;
1495 -- In printing phase, if already printed, then return, otherwise we
1496 -- are printing the next item, so increment the serial number.
1498 else
1499 if S < Next_Serial_Number then
1500 return; -- already printed
1501 else
1502 Next_Serial_Number := Next_Serial_Number + 1;
1503 end if;
1504 end if;
1506 -- Now process the list (Print calls have no effect in marking phase)
1508 Print_Str (Prefix_Str);
1509 Print_Elist_Ref (E);
1510 Print_Eol;
1512 if Is_Empty_Elmt_List (E) then
1513 Print_Str (Prefix_Str);
1514 Print_Str ("(Empty element list)");
1515 Print_Eol;
1516 Print_Eol;
1518 else
1519 if Phase = Printing then
1520 M := First_Elmt (E);
1521 while Present (M) loop
1522 N := Node (M);
1523 Print_Str (Prefix_Str);
1524 Print_Str (" ");
1525 Print_Node_Ref (N);
1526 Print_Eol;
1527 Next_Elmt (M);
1528 end loop;
1530 Print_Str (Prefix_Str);
1531 Print_Eol;
1532 end if;
1534 M := First_Elmt (E);
1535 while Present (M) loop
1536 Visit_Node (Node (M), Prefix_Str, ' ');
1537 Next_Elmt (M);
1538 end loop;
1539 end if;
1540 end Visit_Elist;
1542 ----------------
1543 -- Visit_List --
1544 ----------------
1546 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1547 N : Node_Id;
1548 S : constant Nat := Serial_Number (Int (L));
1550 begin
1551 -- In marking phase, return if already marked, otherwise set next
1552 -- serial number in hash table for later reference.
1554 if Phase = Marking then
1555 if S /= 0 then
1556 return;
1557 else
1558 Set_Serial_Number;
1559 end if;
1561 -- In printing phase, if already printed, then return, otherwise we
1562 -- are printing the next item, so increment the serial number.
1564 else
1565 if S < Next_Serial_Number then
1566 return; -- already printed
1567 else
1568 Next_Serial_Number := Next_Serial_Number + 1;
1569 end if;
1570 end if;
1572 -- Now process the list (Print calls have no effect in marking phase)
1574 Print_Str (Prefix_Str);
1575 Print_List_Ref (L);
1576 Print_Eol;
1578 Print_Str (Prefix_Str);
1579 Print_Str ("|Parent = ");
1580 Print_Node_Ref (Parent (L));
1581 Print_Eol;
1583 N := First (L);
1585 if N = Empty then
1586 Print_Str (Prefix_Str);
1587 Print_Str ("(Empty list)");
1588 Print_Eol;
1589 Print_Eol;
1591 else
1592 Print_Str (Prefix_Str);
1593 Print_Char ('|');
1594 Print_Eol;
1596 while Next (N) /= Empty loop
1597 Visit_Node (N, Prefix_Str, '|');
1598 Next (N);
1599 end loop;
1600 end if;
1602 Visit_Node (N, Prefix_Str, ' ');
1603 end Visit_List;
1605 ----------------
1606 -- Visit_Node --
1607 ----------------
1609 procedure Visit_Node
1610 (N : Node_Id;
1611 Prefix_Str : String;
1612 Prefix_Char : Character)
1614 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1615 -- Prefix string for printing referenced fields
1617 procedure Visit_Descendent
1618 (D : Union_Id;
1619 No_Indent : Boolean := False);
1620 -- This procedure tests the given value of one of the Fields referenced
1621 -- by the current node to determine whether to visit it recursively.
1622 -- Normally No_Indent is false, which means tha the visited node will
1623 -- be indented using New_Prefix. If No_Indent is set to True, then
1624 -- this indentation is skipped, and Prefix_Str is used for the call
1625 -- to print the descendent. No_Indent is effective only if the
1626 -- referenced descendent is a node.
1628 ----------------------
1629 -- Visit_Descendent --
1630 ----------------------
1632 procedure Visit_Descendent
1633 (D : Union_Id;
1634 No_Indent : Boolean := False)
1636 begin
1637 -- Case of descendent is a node
1639 if D in Node_Range then
1641 -- Don't bother about Empty or Error descendents
1643 if D <= Union_Id (Empty_Or_Error) then
1644 return;
1645 end if;
1647 declare
1648 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1650 begin
1651 -- Descendents in one of the standardly compiled internal
1652 -- packages are normally ignored, unless the parent is also
1653 -- in such a package (happens when Standard itself is output)
1654 -- or if the -df switch is set which causes all links to be
1655 -- followed, even into package standard.
1657 if Sloc (Nod) <= Standard_Location then
1658 if Sloc (N) > Standard_Location
1659 and then not Debug_Flag_F
1660 then
1661 return;
1662 end if;
1664 -- Don't bother about a descendent in a different unit than
1665 -- the node we came from unless the -df switch is set. Note
1666 -- that we know at this point that Sloc (D) > Standard_Location
1668 -- Note: the tests for No_Location here just make sure that we
1669 -- don't blow up on a node which is missing an Sloc value. This
1670 -- should not normally happen.
1672 else
1673 if (Sloc (N) <= Standard_Location
1674 or else Sloc (N) = No_Location
1675 or else Sloc (Nod) = No_Location
1676 or else not In_Same_Source_Unit (Nod, N))
1677 and then not Debug_Flag_F
1678 then
1679 return;
1680 end if;
1681 end if;
1683 -- Don't bother visiting a source node that has a parent which
1684 -- is not the node we came from. We prefer to trace such nodes
1685 -- from their real parents. This causes the tree to be printed
1686 -- in a more coherent order, e.g. a defining identifier listed
1687 -- next to its corresponding declaration, instead of next to
1688 -- some semantic reference.
1690 -- This test is skipped for nodes in standard packages unless
1691 -- the -dy option is set (which outputs the tree for standard)
1693 -- Also, always follow pointers to Is_Itype entities,
1694 -- since we want to list these when they are first referenced.
1696 if Parent (Nod) /= Empty
1697 and then Comes_From_Source (Nod)
1698 and then Parent (Nod) /= N
1699 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1700 then
1701 return;
1702 end if;
1704 -- If we successfully fall through all the above tests (which
1705 -- execute a return if the node is not to be visited), we can
1706 -- go ahead and visit the node!
1708 if No_Indent then
1709 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1710 else
1711 Visit_Node (Nod, New_Prefix, ' ');
1712 end if;
1713 end;
1715 -- Case of descendent is a list
1717 elsif D in List_Range then
1719 -- Don't bother with a missing list, empty list or error list
1721 if D = Union_Id (No_List)
1722 or else D = Union_Id (Error_List)
1723 or else Is_Empty_List (List_Id (D))
1724 then
1725 return;
1727 -- Otherwise we can visit the list. Note that we don't bother
1728 -- to do the parent test that we did for the node case, because
1729 -- it just does not happen that lists are referenced more than
1730 -- one place in the tree. We aren't counting on this being the
1731 -- case to generate valid output, it is just that we don't need
1732 -- in practice to worry about listing the list at a place that
1733 -- is inconvenient.
1735 else
1736 Visit_List (List_Id (D), New_Prefix);
1737 end if;
1739 -- Case of descendent is an element list
1741 elsif D in Elist_Range then
1743 -- Don't bother with a missing list, or an empty list
1745 if D = Union_Id (No_Elist)
1746 or else Is_Empty_Elmt_List (Elist_Id (D))
1747 then
1748 return;
1750 -- Otherwise, visit the referenced element list
1752 else
1753 Visit_Elist (Elist_Id (D), New_Prefix);
1754 end if;
1756 -- For all other kinds of descendents (strings, names, uints etc),
1757 -- there is nothing to visit (the contents of the field will be
1758 -- printed when we print the containing node, but what concerns
1759 -- us now is looking for descendents in the tree.
1761 else
1762 null;
1763 end if;
1764 end Visit_Descendent;
1766 -- Start of processing for Visit_Node
1768 begin
1769 if N = Empty then
1770 return;
1771 end if;
1773 -- Set fatal error node in case we get a blow up during the trace
1775 Current_Error_Node := N;
1777 New_Prefix (Prefix_Str'Range) := Prefix_Str;
1778 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
1779 New_Prefix (Prefix_Str'Last + 2) := ' ';
1781 -- In the marking phase, all we do is to set the serial number
1783 if Phase = Marking then
1784 if Serial_Number (Int (N)) /= 0 then
1785 return; -- already visited
1786 else
1787 Set_Serial_Number;
1788 end if;
1790 -- In the printing phase, we print the node
1792 else
1793 if Serial_Number (Int (N)) < Next_Serial_Number then
1795 -- Here we have already visited the node, but if it is in
1796 -- a list, we still want to print the reference, so that
1797 -- it is clear that it belongs to the list.
1799 if Is_List_Member (N) then
1800 Print_Str (Prefix_Str);
1801 Print_Node_Ref (N);
1802 Print_Eol;
1803 Print_Str (Prefix_Str);
1804 Print_Char (Prefix_Char);
1805 Print_Str ("(already output)");
1806 Print_Eol;
1807 Print_Str (Prefix_Str);
1808 Print_Char (Prefix_Char);
1809 Print_Eol;
1810 end if;
1812 return;
1814 else
1815 Print_Node (N, Prefix_Str, Prefix_Char);
1816 Print_Str (Prefix_Str);
1817 Print_Char (Prefix_Char);
1818 Print_Eol;
1819 Next_Serial_Number := Next_Serial_Number + 1;
1820 end if;
1821 end if;
1823 -- Visit all descendents of this node
1825 if Nkind (N) not in N_Entity then
1826 Visit_Descendent (Field1 (N));
1827 Visit_Descendent (Field2 (N));
1828 Visit_Descendent (Field3 (N));
1829 Visit_Descendent (Field4 (N));
1830 Visit_Descendent (Field5 (N));
1832 -- Entity case
1834 else
1835 Visit_Descendent (Field1 (N));
1836 Visit_Descendent (Field3 (N));
1837 Visit_Descendent (Field4 (N));
1838 Visit_Descendent (Field5 (N));
1839 Visit_Descendent (Field6 (N));
1840 Visit_Descendent (Field7 (N));
1841 Visit_Descendent (Field8 (N));
1842 Visit_Descendent (Field9 (N));
1843 Visit_Descendent (Field10 (N));
1844 Visit_Descendent (Field11 (N));
1845 Visit_Descendent (Field12 (N));
1846 Visit_Descendent (Field13 (N));
1847 Visit_Descendent (Field14 (N));
1848 Visit_Descendent (Field15 (N));
1849 Visit_Descendent (Field16 (N));
1850 Visit_Descendent (Field17 (N));
1851 Visit_Descendent (Field18 (N));
1852 Visit_Descendent (Field19 (N));
1853 Visit_Descendent (Field20 (N));
1854 Visit_Descendent (Field21 (N));
1855 Visit_Descendent (Field22 (N));
1856 Visit_Descendent (Field23 (N));
1858 -- Now an interesting kludge. Normally parents are always printed
1859 -- since we traverse the tree in a downwards direction. There is
1860 -- however an exception to this rule, which is the case where a
1861 -- parent is constructed by the compiler and is not referenced
1862 -- elsewhere in the tree. The following catches this case
1864 if not Comes_From_Source (N) then
1865 Visit_Descendent (Union_Id (Parent (N)));
1866 end if;
1868 -- You may be wondering why we omitted Field2 above. The answer
1869 -- is that this is the Next_Entity field, and we want to treat
1870 -- it rather specially. Why? Because a Next_Entity link does not
1871 -- correspond to a level deeper in the tree, and we do not want
1872 -- the tree to march off to the right of the page due to bogus
1873 -- indentations coming from this effect.
1875 -- To prevent this, what we do is to control references via
1876 -- Next_Entity only from the first entity on a given scope
1877 -- chain, and we keep them all at the same level. Of course
1878 -- if an entity has already been referenced it is not printed.
1880 if Present (Next_Entity (N))
1881 and then Present (Scope (N))
1882 and then First_Entity (Scope (N)) = N
1883 then
1884 declare
1885 Nod : Node_Id;
1887 begin
1888 Nod := N;
1889 while Present (Nod) loop
1890 Visit_Descendent (Union_Id (Next_Entity (Nod)));
1891 Nod := Next_Entity (Nod);
1892 end loop;
1893 end;
1894 end if;
1895 end if;
1896 end Visit_Node;
1898 end Treepr;