2014-10-10 Robert Dewar <dewar@adacore.com>
[official-gcc.git] / gcc / ada / treepr.adb
blob0f21b9973c02454f6201eaf6c759ee248ff7c309
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-2014, 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 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. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
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;
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 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
68 -- two phases.
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
81 Serial : Nat;
82 -- Serial number for hash table entry. A value of zero means that
83 -- the entry is currently unused.
85 Id : Int;
86 -- If serial number field is non-zero, contains corresponding Id value
87 end record;
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
94 Hash_Table_Len : Nat;
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
113 Phase : Phase_Type;
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
146 -- marking phase.
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
157 procedure Print_Eol;
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
182 procedure Print_Node
183 (N : Node_Id;
184 Prefix_Str : String;
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.
201 procedure Visit_Node
202 (N : Node_Id;
203 Prefix_Str : String;
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
216 -- printed lines.
218 -------
219 -- p --
220 -------
222 function p (N : Union_Id) return Node_Or_Entity_Id is
223 begin
224 case N is
225 when List_Low_Bound .. List_High_Bound - 1 =>
226 return Nlists.Parent (List_Id (N));
228 when Node_Range =>
229 return Atree.Parent (Node_Or_Entity_Id (N));
231 when others =>
232 Write_Int (Int (N));
233 Write_Str (" is not a Node_Id or List_Id value");
234 Write_Eol;
235 return Empty;
236 end case;
237 end p;
239 ---------
240 -- par --
241 ---------
243 function par (N : Union_Id) return Node_Or_Entity_Id renames p;
245 --------
246 -- pe --
247 --------
249 procedure pe (N : Union_Id) renames pn;
251 --------
252 -- pl --
253 --------
255 procedure pl (L : Int) is
256 Lid : Int;
258 begin
259 if L < 0 then
260 Lid := L;
262 -- This is the case where we transform e.g. +36 to -99999936
264 else
265 if L <= 9 then
266 Lid := -(99999990 + L);
267 elsif L <= 99 then
268 Lid := -(99999900 + L);
269 elsif L <= 999 then
270 Lid := -(99999000 + L);
271 elsif L <= 9999 then
272 Lid := -(99990000 + L);
273 elsif L <= 99999 then
274 Lid := -(99900000 + L);
275 elsif L <= 999999 then
276 Lid := -(99000000 + L);
277 elsif L <= 9999999 then
278 Lid := -(90000000 + L);
279 else
280 Lid := -L;
281 end if;
282 end if;
284 -- Now output the list
286 Print_Tree_List (List_Id (Lid));
287 end pl;
289 --------
290 -- pn --
291 --------
293 procedure pn (N : Union_Id) is
294 begin
295 case N is
296 when List_Low_Bound .. List_High_Bound - 1 =>
297 pl (Int (N));
298 when Node_Range =>
299 Print_Tree_Node (Node_Id (N));
300 when Elist_Range =>
301 Print_Tree_Elist (Elist_Id (N));
302 when Elmt_Range =>
303 declare
304 Id : constant Elmt_Id := Elmt_Id (N);
305 begin
306 if No (Id) then
307 Write_Str ("No_Elmt");
308 Write_Eol;
309 else
310 Write_Str ("Elmt_Id --> ");
311 Print_Tree_Node (Node (Id));
312 end if;
313 end;
314 when Names_Range =>
315 Namet.wn (Name_Id (N));
316 when Strings_Range =>
317 Write_String_Table_Entry (String_Id (N));
318 when Uint_Range =>
319 Uintp.pid (From_Union (N));
320 when Ureal_Range =>
321 Urealp.pr (From_Union (N));
322 when others =>
323 Write_Str ("Invalid Union_Id: ");
324 Write_Int (Int (N));
325 Write_Eol;
326 end case;
327 end pn;
329 --------
330 -- pp --
331 --------
333 procedure pp (N : Union_Id) renames pn;
335 ---------
336 -- ppp --
337 ---------
339 procedure ppp (N : Union_Id) renames pt;
341 ----------------
342 -- Print_Char --
343 ----------------
345 procedure Print_Char (C : Character) is
346 begin
347 if Phase = Printing then
348 Write_Char (C);
349 end if;
350 end Print_Char;
352 ---------------------
353 -- Print_Elist_Ref --
354 ---------------------
356 procedure Print_Elist_Ref (E : Elist_Id) is
357 begin
358 if Phase /= Printing then
359 return;
360 end if;
362 if E = No_Elist then
363 Write_Str ("<no elist>");
365 elsif Is_Empty_Elmt_List (E) then
366 Write_Str ("Empty elist, (Elist_Id=");
367 Write_Int (Int (E));
368 Write_Char (')');
370 else
371 Write_Str ("(Elist_Id=");
372 Write_Int (Int (E));
373 Write_Char (')');
375 if Printing_Descendants then
376 Write_Str (" #");
377 Write_Int (Serial_Number (Int (E)));
378 end if;
379 end if;
380 end Print_Elist_Ref;
382 -------------------------
383 -- Print_Elist_Subtree --
384 -------------------------
386 procedure Print_Elist_Subtree (E : Elist_Id) is
387 begin
388 Print_Init;
390 Next_Serial_Number := 1;
391 Phase := Marking;
392 Visit_Elist (E, "");
394 Next_Serial_Number := 1;
395 Phase := Printing;
396 Visit_Elist (E, "");
398 Print_Term;
399 end Print_Elist_Subtree;
401 --------------------
402 -- Print_End_Span --
403 --------------------
405 procedure Print_End_Span (N : Node_Id) is
406 Val : constant Uint := End_Span (N);
408 begin
409 UI_Write (Val);
410 Write_Str (" (Uint = ");
411 Write_Int (Int (Field5 (N)));
412 Write_Str (") ");
414 if Val /= No_Uint then
415 Write_Location (End_Location (N));
416 end if;
417 end Print_End_Span;
419 -----------------------
420 -- Print_Entity_Info --
421 -----------------------
423 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
424 function Field_Present (U : Union_Id) return Boolean;
425 -- Returns False unless the value U represents a missing value
426 -- (Empty, No_Uint, No_Ureal or No_String)
428 function Field_Present (U : Union_Id) return Boolean is
429 begin
430 return
431 U /= Union_Id (Empty) and then
432 U /= To_Union (No_Uint) and then
433 U /= To_Union (No_Ureal) and then
434 U /= Union_Id (No_String);
435 end Field_Present;
437 -- Start of processing for Print_Entity_Info
439 begin
440 Print_Str (Prefix);
441 Print_Str ("Ekind = ");
442 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
443 Print_Eol;
445 Print_Str (Prefix);
446 Print_Str ("Etype = ");
447 Print_Node_Ref (Etype (Ent));
448 Print_Eol;
450 if Convention (Ent) /= Convention_Ada then
451 Print_Str (Prefix);
452 Print_Str ("Convention = ");
454 -- Print convention name skipping the Convention_ at the start
456 declare
457 S : constant String := Convention_Id'Image (Convention (Ent));
459 begin
460 Print_Str_Mixed_Case (S (12 .. S'Last));
461 Print_Eol;
462 end;
463 end if;
465 if Field_Present (Field6 (Ent)) then
466 Print_Str (Prefix);
467 Write_Field6_Name (Ent);
468 Write_Str (" = ");
469 Print_Field (Field6 (Ent));
470 Print_Eol;
471 end if;
473 if Field_Present (Field7 (Ent)) then
474 Print_Str (Prefix);
475 Write_Field7_Name (Ent);
476 Write_Str (" = ");
477 Print_Field (Field7 (Ent));
478 Print_Eol;
479 end if;
481 if Field_Present (Field8 (Ent)) then
482 Print_Str (Prefix);
483 Write_Field8_Name (Ent);
484 Write_Str (" = ");
485 Print_Field (Field8 (Ent));
486 Print_Eol;
487 end if;
489 if Field_Present (Field9 (Ent)) then
490 Print_Str (Prefix);
491 Write_Field9_Name (Ent);
492 Write_Str (" = ");
493 Print_Field (Field9 (Ent));
494 Print_Eol;
495 end if;
497 if Field_Present (Field10 (Ent)) then
498 Print_Str (Prefix);
499 Write_Field10_Name (Ent);
500 Write_Str (" = ");
501 Print_Field (Field10 (Ent));
502 Print_Eol;
503 end if;
505 if Field_Present (Field11 (Ent)) then
506 Print_Str (Prefix);
507 Write_Field11_Name (Ent);
508 Write_Str (" = ");
509 Print_Field (Field11 (Ent));
510 Print_Eol;
511 end if;
513 if Field_Present (Field12 (Ent)) then
514 Print_Str (Prefix);
515 Write_Field12_Name (Ent);
516 Write_Str (" = ");
517 Print_Field (Field12 (Ent));
518 Print_Eol;
519 end if;
521 if Field_Present (Field13 (Ent)) then
522 Print_Str (Prefix);
523 Write_Field13_Name (Ent);
524 Write_Str (" = ");
525 Print_Field (Field13 (Ent));
526 Print_Eol;
527 end if;
529 if Field_Present (Field14 (Ent)) then
530 Print_Str (Prefix);
531 Write_Field14_Name (Ent);
532 Write_Str (" = ");
533 Print_Field (Field14 (Ent));
534 Print_Eol;
535 end if;
537 if Field_Present (Field15 (Ent)) then
538 Print_Str (Prefix);
539 Write_Field15_Name (Ent);
540 Write_Str (" = ");
541 Print_Field (Field15 (Ent));
542 Print_Eol;
543 end if;
545 if Field_Present (Field16 (Ent)) then
546 Print_Str (Prefix);
547 Write_Field16_Name (Ent);
548 Write_Str (" = ");
549 Print_Field (Field16 (Ent));
550 Print_Eol;
551 end if;
553 if Field_Present (Field17 (Ent)) then
554 Print_Str (Prefix);
555 Write_Field17_Name (Ent);
556 Write_Str (" = ");
557 Print_Field (Field17 (Ent));
558 Print_Eol;
559 end if;
561 if Field_Present (Field18 (Ent)) then
562 Print_Str (Prefix);
563 Write_Field18_Name (Ent);
564 Write_Str (" = ");
565 Print_Field (Field18 (Ent));
566 Print_Eol;
567 end if;
569 if Field_Present (Field19 (Ent)) then
570 Print_Str (Prefix);
571 Write_Field19_Name (Ent);
572 Write_Str (" = ");
573 Print_Field (Field19 (Ent));
574 Print_Eol;
575 end if;
577 if Field_Present (Field20 (Ent)) then
578 Print_Str (Prefix);
579 Write_Field20_Name (Ent);
580 Write_Str (" = ");
581 Print_Field (Field20 (Ent));
582 Print_Eol;
583 end if;
585 if Field_Present (Field21 (Ent)) then
586 Print_Str (Prefix);
587 Write_Field21_Name (Ent);
588 Write_Str (" = ");
589 Print_Field (Field21 (Ent));
590 Print_Eol;
591 end if;
593 if Field_Present (Field22 (Ent)) then
594 Print_Str (Prefix);
595 Write_Field22_Name (Ent);
596 Write_Str (" = ");
598 -- Mechanism case has to be handled specially
600 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
601 declare
602 M : constant Mechanism_Type := Mechanism (Ent);
604 begin
605 case M is
606 when Default_Mechanism =>
607 Write_Str ("Default");
609 when By_Copy =>
610 Write_Str ("By_Copy");
612 when By_Reference =>
613 Write_Str ("By_Reference");
615 when 1 .. Mechanism_Type'Last =>
616 Write_Str ("By_Copy if size <= ");
617 Write_Int (Int (M));
618 end case;
619 end;
621 -- Normal case (not Mechanism)
623 else
624 Print_Field (Field22 (Ent));
625 end if;
627 Print_Eol;
628 end if;
630 if Field_Present (Field23 (Ent)) then
631 Print_Str (Prefix);
632 Write_Field23_Name (Ent);
633 Write_Str (" = ");
634 Print_Field (Field23 (Ent));
635 Print_Eol;
636 end if;
638 if Field_Present (Field24 (Ent)) then
639 Print_Str (Prefix);
640 Write_Field24_Name (Ent);
641 Write_Str (" = ");
642 Print_Field (Field24 (Ent));
643 Print_Eol;
644 end if;
646 if Field_Present (Field25 (Ent)) then
647 Print_Str (Prefix);
648 Write_Field25_Name (Ent);
649 Write_Str (" = ");
650 Print_Field (Field25 (Ent));
651 Print_Eol;
652 end if;
654 if Field_Present (Field26 (Ent)) then
655 Print_Str (Prefix);
656 Write_Field26_Name (Ent);
657 Write_Str (" = ");
658 Print_Field (Field26 (Ent));
659 Print_Eol;
660 end if;
662 if Field_Present (Field27 (Ent)) then
663 Print_Str (Prefix);
664 Write_Field27_Name (Ent);
665 Write_Str (" = ");
666 Print_Field (Field27 (Ent));
667 Print_Eol;
668 end if;
670 if Field_Present (Field28 (Ent)) then
671 Print_Str (Prefix);
672 Write_Field28_Name (Ent);
673 Write_Str (" = ");
674 Print_Field (Field28 (Ent));
675 Print_Eol;
676 end if;
678 if Field_Present (Field29 (Ent)) then
679 Print_Str (Prefix);
680 Write_Field29_Name (Ent);
681 Write_Str (" = ");
682 Print_Field (Field29 (Ent));
683 Print_Eol;
684 end if;
686 if Field_Present (Field30 (Ent)) then
687 Print_Str (Prefix);
688 Write_Field30_Name (Ent);
689 Write_Str (" = ");
690 Print_Field (Field30 (Ent));
691 Print_Eol;
692 end if;
694 if Field_Present (Field31 (Ent)) then
695 Print_Str (Prefix);
696 Write_Field31_Name (Ent);
697 Write_Str (" = ");
698 Print_Field (Field31 (Ent));
699 Print_Eol;
700 end if;
702 if Field_Present (Field32 (Ent)) then
703 Print_Str (Prefix);
704 Write_Field32_Name (Ent);
705 Write_Str (" = ");
706 Print_Field (Field32 (Ent));
707 Print_Eol;
708 end if;
710 if Field_Present (Field33 (Ent)) then
711 Print_Str (Prefix);
712 Write_Field33_Name (Ent);
713 Write_Str (" = ");
714 Print_Field (Field33 (Ent));
715 Print_Eol;
716 end if;
718 if Field_Present (Field34 (Ent)) then
719 Print_Str (Prefix);
720 Write_Field34_Name (Ent);
721 Write_Str (" = ");
722 Print_Field (Field34 (Ent));
723 Print_Eol;
724 end if;
726 if Field_Present (Field35 (Ent)) then
727 Print_Str (Prefix);
728 Write_Field35_Name (Ent);
729 Write_Str (" = ");
730 Print_Field (Field35 (Ent));
731 Print_Eol;
732 end if;
734 Write_Entity_Flags (Ent, Prefix);
735 end Print_Entity_Info;
737 ---------------
738 -- Print_Eol --
739 ---------------
741 procedure Print_Eol is
742 begin
743 if Phase = Printing then
744 Write_Eol;
745 end if;
746 end Print_Eol;
748 -----------------
749 -- Print_Field --
750 -----------------
752 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
753 begin
754 if Phase /= Printing then
755 return;
756 end if;
758 if Val in Node_Range then
759 Print_Node_Ref (Node_Id (Val));
761 elsif Val in List_Range then
762 Print_List_Ref (List_Id (Val));
764 elsif Val in Elist_Range then
765 Print_Elist_Ref (Elist_Id (Val));
767 elsif Val in Names_Range then
768 Print_Name (Name_Id (Val));
769 Write_Str (" (Name_Id=");
770 Write_Int (Int (Val));
771 Write_Char (')');
773 elsif Val in Strings_Range then
774 Write_String_Table_Entry (String_Id (Val));
775 Write_Str (" (String_Id=");
776 Write_Int (Int (Val));
777 Write_Char (')');
779 elsif Val in Uint_Range then
780 UI_Write (From_Union (Val), Format);
781 Write_Str (" (Uint = ");
782 Write_Int (Int (Val));
783 Write_Char (')');
785 elsif Val in Ureal_Range then
786 UR_Write (From_Union (Val));
787 Write_Str (" (Ureal = ");
788 Write_Int (Int (Val));
789 Write_Char (')');
791 else
792 Print_Str ("****** Incorrect value = ");
793 Print_Int (Int (Val));
794 end if;
795 end Print_Field;
797 ----------------
798 -- Print_Flag --
799 ----------------
801 procedure Print_Flag (F : Boolean) is
802 begin
803 if F then
804 Print_Str ("True");
805 else
806 Print_Str ("False");
807 end if;
808 end Print_Flag;
810 ----------------
811 -- Print_Init --
812 ----------------
814 procedure Print_Init is
815 begin
816 Printing_Descendants := True;
817 Write_Eol;
819 -- Allocate and clear serial number hash table. The size is 150% of
820 -- the maximum possible number of entries, so that the hash table
821 -- cannot get significantly overloaded.
823 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
824 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
826 for J in Hash_Table'Range loop
827 Hash_Table (J).Serial := 0;
828 end loop;
830 end Print_Init;
832 ---------------
833 -- Print_Int --
834 ---------------
836 procedure Print_Int (I : Int) is
837 begin
838 if Phase = Printing then
839 Write_Int (I);
840 end if;
841 end Print_Int;
843 --------------------
844 -- Print_List_Ref --
845 --------------------
847 procedure Print_List_Ref (L : List_Id) is
848 begin
849 if Phase /= Printing then
850 return;
851 end if;
853 if No (L) then
854 Write_Str ("<no list>");
856 elsif Is_Empty_List (L) then
857 Write_Str ("<empty list> (List_Id=");
858 Write_Int (Int (L));
859 Write_Char (')');
861 else
862 Write_Str ("List");
864 if Printing_Descendants then
865 Write_Str (" #");
866 Write_Int (Serial_Number (Int (L)));
867 end if;
869 Write_Str (" (List_Id=");
870 Write_Int (Int (L));
871 Write_Char (')');
872 end if;
873 end Print_List_Ref;
875 ------------------------
876 -- Print_List_Subtree --
877 ------------------------
879 procedure Print_List_Subtree (L : List_Id) is
880 begin
881 Print_Init;
883 Next_Serial_Number := 1;
884 Phase := Marking;
885 Visit_List (L, "");
887 Next_Serial_Number := 1;
888 Phase := Printing;
889 Visit_List (L, "");
891 Print_Term;
892 end Print_List_Subtree;
894 ----------------
895 -- Print_Name --
896 ----------------
898 procedure Print_Name (N : Name_Id) is
899 begin
900 if Phase = Printing then
901 if N = No_Name then
902 Print_Str ("<No_Name>");
904 elsif N = Error_Name then
905 Print_Str ("<Error_Name>");
907 elsif Is_Valid_Name (N) then
908 Get_Name_String (N);
909 Print_Char ('"');
910 Write_Name (N);
911 Print_Char ('"');
913 else
914 Print_Str ("<invalid name ???>");
915 end if;
916 end if;
917 end Print_Name;
919 ----------------
920 -- Print_Node --
921 ----------------
923 procedure Print_Node
924 (N : Node_Id;
925 Prefix_Str : String;
926 Prefix_Char : Character)
928 F : Fchar;
929 P : Natural := Pchar_Pos (Nkind (N));
931 Field_To_Be_Printed : Boolean;
932 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
934 Sfile : Source_File_Index;
935 Fmt : UI_Format;
937 begin
938 if Phase /= Printing then
939 return;
940 end if;
942 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
943 Fmt := Hex;
944 else
945 Fmt := Auto;
946 end if;
948 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
949 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
951 -- Print header line
953 Print_Str (Prefix_Str);
954 Print_Node_Header (N);
956 if Is_Rewrite_Substitution (N) then
957 Print_Str (Prefix_Str);
958 Print_Str (" Rewritten: original node = ");
959 Print_Node_Ref (Original_Node (N));
960 Print_Eol;
961 end if;
963 if N = Empty then
964 return;
965 end if;
967 if not Is_List_Member (N) then
968 Print_Str (Prefix_Str);
969 Print_Str (" Parent = ");
970 Print_Node_Ref (Parent (N));
971 Print_Eol;
972 end if;
974 -- Print Sloc field if it is set
976 if Sloc (N) /= No_Location then
977 Print_Str (Prefix_Str_Char);
978 Print_Str ("Sloc = ");
980 if Sloc (N) = Standard_Location then
981 Print_Str ("Standard_Location");
983 elsif Sloc (N) = Standard_ASCII_Location then
984 Print_Str ("Standard_ASCII_Location");
986 else
987 Sfile := Get_Source_File_Index (Sloc (N));
988 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
989 Write_Str (" ");
990 Write_Location (Sloc (N));
991 end if;
993 Print_Eol;
994 end if;
996 -- Print Chars field if present
998 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
999 Print_Str (Prefix_Str_Char);
1000 Print_Str ("Chars = ");
1001 Print_Name (Chars (N));
1002 Write_Str (" (Name_Id=");
1003 Write_Int (Int (Chars (N)));
1004 Write_Char (')');
1005 Print_Eol;
1006 end if;
1008 -- Special field print operations for non-entity nodes
1010 if Nkind (N) not in N_Entity then
1012 -- Deal with Left_Opnd and Right_Opnd fields
1014 if Nkind (N) in N_Op
1015 or else Nkind (N) in N_Short_Circuit
1016 or else Nkind (N) in N_Membership_Test
1017 then
1018 -- Print Left_Opnd if present
1020 if Nkind (N) not in N_Unary_Op then
1021 Print_Str (Prefix_Str_Char);
1022 Print_Str ("Left_Opnd = ");
1023 Print_Node_Ref (Left_Opnd (N));
1024 Print_Eol;
1025 end if;
1027 -- Print Right_Opnd
1029 Print_Str (Prefix_Str_Char);
1030 Print_Str ("Right_Opnd = ");
1031 Print_Node_Ref (Right_Opnd (N));
1032 Print_Eol;
1033 end if;
1035 -- Print Entity field if operator (other cases of Entity
1036 -- are in the table, so are handled in the normal circuit)
1038 if Nkind (N) in N_Op and then Present (Entity (N)) then
1039 Print_Str (Prefix_Str_Char);
1040 Print_Str ("Entity = ");
1041 Print_Node_Ref (Entity (N));
1042 Print_Eol;
1043 end if;
1045 -- Print special fields if we have a subexpression
1047 if Nkind (N) in N_Subexpr then
1049 if Assignment_OK (N) then
1050 Print_Str (Prefix_Str_Char);
1051 Print_Str ("Assignment_OK = True");
1052 Print_Eol;
1053 end if;
1055 if Do_Range_Check (N) then
1056 Print_Str (Prefix_Str_Char);
1057 Print_Str ("Do_Range_Check = True");
1058 Print_Eol;
1059 end if;
1061 if Has_Dynamic_Length_Check (N) then
1062 Print_Str (Prefix_Str_Char);
1063 Print_Str ("Has_Dynamic_Length_Check = True");
1064 Print_Eol;
1065 end if;
1067 if Has_Aspects (N) then
1068 Print_Str (Prefix_Str_Char);
1069 Print_Str ("Has_Aspects = True");
1070 Print_Eol;
1071 end if;
1073 if Has_Dynamic_Range_Check (N) then
1074 Print_Str (Prefix_Str_Char);
1075 Print_Str ("Has_Dynamic_Range_Check = True");
1076 Print_Eol;
1077 end if;
1079 if Is_Controlling_Actual (N) then
1080 Print_Str (Prefix_Str_Char);
1081 Print_Str ("Is_Controlling_Actual = True");
1082 Print_Eol;
1083 end if;
1085 if Is_Overloaded (N) then
1086 Print_Str (Prefix_Str_Char);
1087 Print_Str ("Is_Overloaded = True");
1088 Print_Eol;
1089 end if;
1091 if Is_Static_Expression (N) then
1092 Print_Str (Prefix_Str_Char);
1093 Print_Str ("Is_Static_Expression = True");
1094 Print_Eol;
1095 end if;
1097 if Must_Not_Freeze (N) then
1098 Print_Str (Prefix_Str_Char);
1099 Print_Str ("Must_Not_Freeze = True");
1100 Print_Eol;
1101 end if;
1103 if Paren_Count (N) /= 0 then
1104 Print_Str (Prefix_Str_Char);
1105 Print_Str ("Paren_Count = ");
1106 Print_Int (Int (Paren_Count (N)));
1107 Print_Eol;
1108 end if;
1110 if Raises_Constraint_Error (N) then
1111 Print_Str (Prefix_Str_Char);
1112 Print_Str ("Raise_Constraint_Error = True");
1113 Print_Eol;
1114 end if;
1116 end if;
1118 -- Print Do_Overflow_Check field if present
1120 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
1121 Print_Str (Prefix_Str_Char);
1122 Print_Str ("Do_Overflow_Check = True");
1123 Print_Eol;
1124 end if;
1126 -- Print Etype field if present (printing of this field for entities
1127 -- is handled by the Print_Entity_Info procedure).
1129 if Nkind (N) in N_Has_Etype and then Present (Etype (N)) then
1130 Print_Str (Prefix_Str_Char);
1131 Print_Str ("Etype = ");
1132 Print_Node_Ref (Etype (N));
1133 Print_Eol;
1134 end if;
1135 end if;
1137 -- Loop to print fields included in Pchars array
1139 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1140 F := Pchars (P);
1141 P := P + 1;
1143 -- Check for case of False flag, which we never print, or
1144 -- an Empty field, which is also never printed
1146 case F is
1147 when F_Field1 =>
1148 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1150 when F_Field2 =>
1151 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1153 when F_Field3 =>
1154 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1156 when F_Field4 =>
1157 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1159 when F_Field5 =>
1160 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1162 when F_Flag1 => Field_To_Be_Printed := Flag1 (N);
1163 when F_Flag2 => Field_To_Be_Printed := Flag2 (N);
1164 when F_Flag3 => Field_To_Be_Printed := Flag3 (N);
1165 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1166 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1167 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1168 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1169 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1170 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1171 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1172 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1173 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1174 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1175 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1176 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1177 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1178 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1179 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1180 end case;
1182 -- Print field if it is to be printed
1184 if Field_To_Be_Printed then
1185 Print_Str (Prefix_Str_Char);
1187 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1188 and then Pchars (P) not in Fchar
1189 loop
1190 Print_Char (Pchars (P));
1191 P := P + 1;
1192 end loop;
1194 Print_Str (" = ");
1196 case F is
1197 when F_Field1 => Print_Field (Field1 (N), Fmt);
1198 when F_Field2 => Print_Field (Field2 (N), Fmt);
1199 when F_Field3 => Print_Field (Field3 (N), Fmt);
1200 when F_Field4 => Print_Field (Field4 (N), Fmt);
1202 -- Special case End_Span = Uint5
1204 when F_Field5 =>
1205 if Nkind_In (N, N_Case_Statement, N_If_Statement) then
1206 Print_End_Span (N);
1207 else
1208 Print_Field (Field5 (N), Fmt);
1209 end if;
1211 when F_Flag1 => Print_Flag (Flag1 (N));
1212 when F_Flag2 => Print_Flag (Flag2 (N));
1213 when F_Flag3 => Print_Flag (Flag3 (N));
1214 when F_Flag4 => Print_Flag (Flag4 (N));
1215 when F_Flag5 => Print_Flag (Flag5 (N));
1216 when F_Flag6 => Print_Flag (Flag6 (N));
1217 when F_Flag7 => Print_Flag (Flag7 (N));
1218 when F_Flag8 => Print_Flag (Flag8 (N));
1219 when F_Flag9 => Print_Flag (Flag9 (N));
1220 when F_Flag10 => Print_Flag (Flag10 (N));
1221 when F_Flag11 => Print_Flag (Flag11 (N));
1222 when F_Flag12 => Print_Flag (Flag12 (N));
1223 when F_Flag13 => Print_Flag (Flag13 (N));
1224 when F_Flag14 => Print_Flag (Flag14 (N));
1225 when F_Flag15 => Print_Flag (Flag15 (N));
1226 when F_Flag16 => Print_Flag (Flag16 (N));
1227 when F_Flag17 => Print_Flag (Flag17 (N));
1228 when F_Flag18 => Print_Flag (Flag18 (N));
1229 end case;
1231 Print_Eol;
1233 -- Field is not to be printed (False flag field)
1235 else
1236 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1237 and then Pchars (P) not in Fchar
1238 loop
1239 P := P + 1;
1240 end loop;
1241 end if;
1242 end loop;
1244 -- Print aspects if present
1246 if Has_Aspects (N) then
1247 Print_Str (Prefix_Str_Char);
1248 Print_Str ("Aspect_Specifications = ");
1249 Print_Field (Union_Id (Aspect_Specifications (N)));
1250 Print_Eol;
1251 end if;
1253 -- Print entity information for entities
1255 if Nkind (N) in N_Entity then
1256 Print_Entity_Info (N, Prefix_Str_Char);
1257 end if;
1259 -- Print the SCIL node (if available)
1261 if Present (Get_SCIL_Node (N)) then
1262 Print_Str (Prefix_Str_Char);
1263 Print_Str ("SCIL_Node = ");
1264 Print_Node_Ref (Get_SCIL_Node (N));
1265 Print_Eol;
1266 end if;
1267 end Print_Node;
1269 ------------------------
1270 -- Print_Node_Briefly --
1271 ------------------------
1273 procedure Print_Node_Briefly (N : Node_Id) is
1274 begin
1275 Printing_Descendants := False;
1276 Phase := Printing;
1277 Print_Node_Header (N);
1278 end Print_Node_Briefly;
1280 -----------------------
1281 -- Print_Node_Header --
1282 -----------------------
1284 procedure Print_Node_Header (N : Node_Id) is
1285 Notes : Boolean := False;
1287 begin
1288 Print_Node_Ref (N);
1290 if N > Atree_Private_Part.Nodes.Last then
1291 Print_Str (" (no such node)");
1292 Print_Eol;
1293 return;
1294 end if;
1296 if Comes_From_Source (N) then
1297 Notes := True;
1298 Print_Str (" (source");
1299 end if;
1301 if Analyzed (N) then
1302 if not Notes then
1303 Notes := True;
1304 Print_Str (" (");
1305 else
1306 Print_Str (",");
1307 end if;
1309 Print_Str ("analyzed");
1310 end if;
1312 if Error_Posted (N) then
1313 if not Notes then
1314 Notes := True;
1315 Print_Str (" (");
1316 else
1317 Print_Str (",");
1318 end if;
1320 Print_Str ("posted");
1321 end if;
1323 if Notes then
1324 Print_Char (')');
1325 end if;
1327 Print_Eol;
1328 end Print_Node_Header;
1330 ---------------------
1331 -- Print_Node_Kind --
1332 ---------------------
1334 procedure Print_Node_Kind (N : Node_Id) is
1335 Ucase : Boolean;
1336 S : constant String := Node_Kind'Image (Nkind (N));
1338 begin
1339 if Phase = Printing then
1340 Ucase := True;
1342 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1343 -- bug of 'Image returning lower case instead of upper case.
1345 for J in S'Range loop
1346 if Ucase then
1347 Write_Char (Fold_Upper (S (J)));
1348 else
1349 Write_Char (Fold_Lower (S (J)));
1350 end if;
1352 Ucase := (S (J) = '_');
1353 end loop;
1354 end if;
1355 end Print_Node_Kind;
1357 --------------------
1358 -- Print_Node_Ref --
1359 --------------------
1361 procedure Print_Node_Ref (N : Node_Id) is
1362 S : Nat;
1364 begin
1365 if Phase /= Printing then
1366 return;
1367 end if;
1369 if N = Empty then
1370 Write_Str ("<empty>");
1372 elsif N = Error then
1373 Write_Str ("<error>");
1375 else
1376 if Printing_Descendants then
1377 S := Serial_Number (Int (N));
1379 if S /= 0 then
1380 Write_Str ("Node");
1381 Write_Str (" #");
1382 Write_Int (S);
1383 Write_Char (' ');
1384 end if;
1385 end if;
1387 Print_Node_Kind (N);
1389 if Nkind (N) in N_Has_Chars then
1390 Write_Char (' ');
1391 Print_Name (Chars (N));
1392 end if;
1394 if Nkind (N) in N_Entity then
1395 Write_Str (" (Entity_Id=");
1396 else
1397 Write_Str (" (Node_Id=");
1398 end if;
1400 Write_Int (Int (N));
1402 if Sloc (N) <= Standard_Location then
1403 Write_Char ('s');
1404 end if;
1406 Write_Char (')');
1408 end if;
1409 end Print_Node_Ref;
1411 ------------------------
1412 -- Print_Node_Subtree --
1413 ------------------------
1415 procedure Print_Node_Subtree (N : Node_Id) is
1416 begin
1417 Print_Init;
1419 Next_Serial_Number := 1;
1420 Phase := Marking;
1421 Visit_Node (N, "", ' ');
1423 Next_Serial_Number := 1;
1424 Phase := Printing;
1425 Visit_Node (N, "", ' ');
1427 Print_Term;
1428 end Print_Node_Subtree;
1430 ---------------
1431 -- Print_Str --
1432 ---------------
1434 procedure Print_Str (S : String) is
1435 begin
1436 if Phase = Printing then
1437 Write_Str (S);
1438 end if;
1439 end Print_Str;
1441 --------------------------
1442 -- Print_Str_Mixed_Case --
1443 --------------------------
1445 procedure Print_Str_Mixed_Case (S : String) is
1446 Ucase : Boolean;
1448 begin
1449 if Phase = Printing then
1450 Ucase := True;
1452 for J in S'Range loop
1453 if Ucase then
1454 Write_Char (S (J));
1455 else
1456 Write_Char (Fold_Lower (S (J)));
1457 end if;
1459 Ucase := (S (J) = '_');
1460 end loop;
1461 end if;
1462 end Print_Str_Mixed_Case;
1464 ----------------
1465 -- Print_Term --
1466 ----------------
1468 procedure Print_Term is
1469 procedure Free is new Unchecked_Deallocation
1470 (Hash_Table_Type, Access_Hash_Table_Type);
1472 begin
1473 Free (Hash_Table);
1474 end Print_Term;
1476 ---------------------
1477 -- Print_Tree_Elist --
1478 ---------------------
1480 procedure Print_Tree_Elist (E : Elist_Id) is
1481 M : Elmt_Id;
1483 begin
1484 Printing_Descendants := False;
1485 Phase := Printing;
1487 Print_Elist_Ref (E);
1488 Print_Eol;
1490 M := First_Elmt (E);
1492 if No (M) then
1493 Print_Str ("<empty element list>");
1494 Print_Eol;
1496 else
1497 loop
1498 Print_Char ('|');
1499 Print_Eol;
1500 exit when No (Next_Elmt (M));
1501 Print_Node (Node (M), "", '|');
1502 Next_Elmt (M);
1503 end loop;
1505 Print_Node (Node (M), "", ' ');
1506 Print_Eol;
1507 end if;
1508 end Print_Tree_Elist;
1510 ---------------------
1511 -- Print_Tree_List --
1512 ---------------------
1514 procedure Print_Tree_List (L : List_Id) is
1515 N : Node_Id;
1517 begin
1518 Printing_Descendants := False;
1519 Phase := Printing;
1521 Print_List_Ref (L);
1522 Print_Str (" List_Id=");
1523 Print_Int (Int (L));
1524 Print_Eol;
1526 N := First (L);
1528 if N = Empty then
1529 Print_Str ("<empty node list>");
1530 Print_Eol;
1532 else
1533 loop
1534 Print_Char ('|');
1535 Print_Eol;
1536 exit when Next (N) = Empty;
1537 Print_Node (N, "", '|');
1538 Next (N);
1539 end loop;
1541 Print_Node (N, "", ' ');
1542 Print_Eol;
1543 end if;
1544 end Print_Tree_List;
1546 ---------------------
1547 -- Print_Tree_Node --
1548 ---------------------
1550 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1551 begin
1552 Printing_Descendants := False;
1553 Phase := Printing;
1554 Print_Node (N, Label, ' ');
1555 end Print_Tree_Node;
1557 --------
1558 -- pt --
1559 --------
1561 procedure pt (N : Union_Id) is
1562 begin
1563 case N is
1564 when List_Low_Bound .. List_High_Bound - 1 =>
1565 Print_List_Subtree (List_Id (N));
1566 when Node_Range =>
1567 Print_Node_Subtree (Node_Id (N));
1568 when Elist_Range =>
1569 Print_Elist_Subtree (Elist_Id (N));
1570 when others =>
1571 pp (N);
1572 end case;
1573 end pt;
1575 -------------------
1576 -- Serial_Number --
1577 -------------------
1579 -- The hashing algorithm is to use the remainder of the ID value divided
1580 -- by the hash table length as the starting point in the table, and then
1581 -- handle collisions by serial searching wrapping at the end of the table.
1583 Hash_Slot : Nat;
1584 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1585 -- to save the slot that should be used if Set_Serial_Number is called.
1587 function Serial_Number (Id : Int) return Nat is
1588 H : Int := Id mod Hash_Table_Len;
1590 begin
1591 while Hash_Table (H).Serial /= 0 loop
1593 if Id = Hash_Table (H).Id then
1594 return Hash_Table (H).Serial;
1595 end if;
1597 H := H + 1;
1599 if H > Hash_Table'Last then
1600 H := 0;
1601 end if;
1602 end loop;
1604 -- Entry was not found, save slot number for possible subsequent call
1605 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1606 -- in case of such a call (the Id field is never read if the serial
1607 -- number of the slot is zero, so this is harmless in the case where
1608 -- Set_Serial_Number is not subsequently called).
1610 Hash_Slot := H;
1611 Hash_Table (H).Id := Id;
1612 return 0;
1614 end Serial_Number;
1616 -----------------------
1617 -- Set_Serial_Number --
1618 -----------------------
1620 procedure Set_Serial_Number is
1621 begin
1622 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1623 Next_Serial_Number := Next_Serial_Number + 1;
1624 end Set_Serial_Number;
1626 ---------------
1627 -- Tree_Dump --
1628 ---------------
1630 procedure Tree_Dump is
1631 procedure Underline;
1632 -- Put underline under string we just printed
1634 procedure Underline is
1635 Col : constant Int := Column;
1637 begin
1638 Write_Eol;
1640 while Col > Column loop
1641 Write_Char ('-');
1642 end loop;
1644 Write_Eol;
1645 end Underline;
1647 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1648 -- flags immediately, before starting the dump. This avoids generating two
1649 -- copies of the dump if an abort occurs after printing the dump, and more
1650 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1652 -- Note: unlike in the source print case (in Sprint), we do not output
1653 -- separate trees for each unit. Instead the -df debug switch causes the
1654 -- tree that is output from the main unit to trace references into other
1655 -- units (normally such references are not traced). Since all other units
1656 -- are linked to the main unit by at least one reference, this causes all
1657 -- tree nodes to be included in the output tree.
1659 begin
1660 if Debug_Flag_Y then
1661 Debug_Flag_Y := False;
1662 Write_Eol;
1663 Write_Str ("Tree created for Standard (spec) ");
1664 Underline;
1665 Print_Node_Subtree (Standard_Package_Node);
1666 Write_Eol;
1667 end if;
1669 if Debug_Flag_T then
1670 Debug_Flag_T := False;
1672 Write_Eol;
1673 Write_Str ("Tree created for ");
1674 Write_Unit_Name (Unit_Name (Main_Unit));
1675 Underline;
1676 Print_Node_Subtree (Cunit (Main_Unit));
1677 Write_Eol;
1678 end if;
1679 end Tree_Dump;
1681 -----------------
1682 -- Visit_Elist --
1683 -----------------
1685 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1686 M : Elmt_Id;
1687 N : Node_Id;
1688 S : constant Nat := Serial_Number (Int (E));
1690 begin
1691 -- In marking phase, return if already marked, otherwise set next
1692 -- serial number in hash table for later reference.
1694 if Phase = Marking then
1695 if S /= 0 then
1696 return; -- already visited
1697 else
1698 Set_Serial_Number;
1699 end if;
1701 -- In printing phase, if already printed, then return, otherwise we
1702 -- are printing the next item, so increment the serial number.
1704 else
1705 if S < Next_Serial_Number then
1706 return; -- already printed
1707 else
1708 Next_Serial_Number := Next_Serial_Number + 1;
1709 end if;
1710 end if;
1712 -- Now process the list (Print calls have no effect in marking phase)
1714 Print_Str (Prefix_Str);
1715 Print_Elist_Ref (E);
1716 Print_Eol;
1718 if Is_Empty_Elmt_List (E) then
1719 Print_Str (Prefix_Str);
1720 Print_Str ("(Empty element list)");
1721 Print_Eol;
1722 Print_Eol;
1724 else
1725 if Phase = Printing then
1726 M := First_Elmt (E);
1727 while Present (M) loop
1728 N := Node (M);
1729 Print_Str (Prefix_Str);
1730 Print_Str (" ");
1731 Print_Node_Ref (N);
1732 Print_Eol;
1733 Next_Elmt (M);
1734 end loop;
1736 Print_Str (Prefix_Str);
1737 Print_Eol;
1738 end if;
1740 M := First_Elmt (E);
1741 while Present (M) loop
1742 Visit_Node (Node (M), Prefix_Str, ' ');
1743 Next_Elmt (M);
1744 end loop;
1745 end if;
1746 end Visit_Elist;
1748 ----------------
1749 -- Visit_List --
1750 ----------------
1752 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1753 N : Node_Id;
1754 S : constant Nat := Serial_Number (Int (L));
1756 begin
1757 -- In marking phase, return if already marked, otherwise set next
1758 -- serial number in hash table for later reference.
1760 if Phase = Marking then
1761 if S /= 0 then
1762 return;
1763 else
1764 Set_Serial_Number;
1765 end if;
1767 -- In printing phase, if already printed, then return, otherwise we
1768 -- are printing the next item, so increment the serial number.
1770 else
1771 if S < Next_Serial_Number then
1772 return; -- already printed
1773 else
1774 Next_Serial_Number := Next_Serial_Number + 1;
1775 end if;
1776 end if;
1778 -- Now process the list (Print calls have no effect in marking phase)
1780 Print_Str (Prefix_Str);
1781 Print_List_Ref (L);
1782 Print_Eol;
1784 Print_Str (Prefix_Str);
1785 Print_Str ("|Parent = ");
1786 Print_Node_Ref (Parent (L));
1787 Print_Eol;
1789 N := First (L);
1791 if N = Empty then
1792 Print_Str (Prefix_Str);
1793 Print_Str ("(Empty list)");
1794 Print_Eol;
1795 Print_Eol;
1797 else
1798 Print_Str (Prefix_Str);
1799 Print_Char ('|');
1800 Print_Eol;
1802 while Next (N) /= Empty loop
1803 Visit_Node (N, Prefix_Str, '|');
1804 Next (N);
1805 end loop;
1806 end if;
1808 Visit_Node (N, Prefix_Str, ' ');
1809 end Visit_List;
1811 ----------------
1812 -- Visit_Node --
1813 ----------------
1815 procedure Visit_Node
1816 (N : Node_Id;
1817 Prefix_Str : String;
1818 Prefix_Char : Character)
1820 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1821 -- Prefix string for printing referenced fields
1823 procedure Visit_Descendent
1824 (D : Union_Id;
1825 No_Indent : Boolean := False);
1826 -- This procedure tests the given value of one of the Fields referenced
1827 -- by the current node to determine whether to visit it recursively.
1828 -- Normally No_Indent is false, which means that the visited node will
1829 -- be indented using New_Prefix. If No_Indent is set to True, then
1830 -- this indentation is skipped, and Prefix_Str is used for the call
1831 -- to print the descendent. No_Indent is effective only if the
1832 -- referenced descendent is a node.
1834 ----------------------
1835 -- Visit_Descendent --
1836 ----------------------
1838 procedure Visit_Descendent
1839 (D : Union_Id;
1840 No_Indent : Boolean := False)
1842 begin
1843 -- Case of descendent is a node
1845 if D in Node_Range then
1847 -- Don't bother about Empty or Error descendents
1849 if D <= Union_Id (Empty_Or_Error) then
1850 return;
1851 end if;
1853 declare
1854 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1856 begin
1857 -- Descendents in one of the standardly compiled internal
1858 -- packages are normally ignored, unless the parent is also
1859 -- in such a package (happens when Standard itself is output)
1860 -- or if the -df switch is set which causes all links to be
1861 -- followed, even into package standard.
1863 if Sloc (Nod) <= Standard_Location then
1864 if Sloc (N) > Standard_Location
1865 and then not Debug_Flag_F
1866 then
1867 return;
1868 end if;
1870 -- Don't bother about a descendent in a different unit than
1871 -- the node we came from unless the -df switch is set. Note
1872 -- that we know at this point that Sloc (D) > Standard_Location
1874 -- Note: the tests for No_Location here just make sure that we
1875 -- don't blow up on a node which is missing an Sloc value. This
1876 -- should not normally happen.
1878 else
1879 if (Sloc (N) <= Standard_Location
1880 or else Sloc (N) = No_Location
1881 or else Sloc (Nod) = No_Location
1882 or else not In_Same_Source_Unit (Nod, N))
1883 and then not Debug_Flag_F
1884 then
1885 return;
1886 end if;
1887 end if;
1889 -- Don't bother visiting a source node that has a parent which
1890 -- is not the node we came from. We prefer to trace such nodes
1891 -- from their real parents. This causes the tree to be printed
1892 -- in a more coherent order, e.g. a defining identifier listed
1893 -- next to its corresponding declaration, instead of next to
1894 -- some semantic reference.
1896 -- This test is skipped for nodes in standard packages unless
1897 -- the -dy option is set (which outputs the tree for standard)
1899 -- Also, always follow pointers to Is_Itype entities,
1900 -- since we want to list these when they are first referenced.
1902 if Parent (Nod) /= Empty
1903 and then Comes_From_Source (Nod)
1904 and then Parent (Nod) /= N
1905 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1906 then
1907 return;
1908 end if;
1910 -- If we successfully fall through all the above tests (which
1911 -- execute a return if the node is not to be visited), we can
1912 -- go ahead and visit the node.
1914 if No_Indent then
1915 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1916 else
1917 Visit_Node (Nod, New_Prefix, ' ');
1918 end if;
1919 end;
1921 -- Case of descendent is a list
1923 elsif D in List_Range then
1925 -- Don't bother with a missing list, empty list or error list
1927 if D = Union_Id (No_List)
1928 or else D = Union_Id (Error_List)
1929 or else Is_Empty_List (List_Id (D))
1930 then
1931 return;
1933 -- Otherwise we can visit the list. Note that we don't bother to
1934 -- do the parent test that we did for the node case, because it
1935 -- just does not happen that lists are referenced more than one
1936 -- place in the tree. We aren't counting on this being the case
1937 -- to generate valid output, it is just that we don't need in
1938 -- practice to worry about listing the list at a place that is
1939 -- inconvenient.
1941 else
1942 Visit_List (List_Id (D), New_Prefix);
1943 end if;
1945 -- Case of descendent is an element list
1947 elsif D in Elist_Range then
1949 -- Don't bother with a missing list, or an empty list
1951 if D = Union_Id (No_Elist)
1952 or else Is_Empty_Elmt_List (Elist_Id (D))
1953 then
1954 return;
1956 -- Otherwise, visit the referenced element list
1958 else
1959 Visit_Elist (Elist_Id (D), New_Prefix);
1960 end if;
1962 -- For all other kinds of descendents (strings, names, uints etc),
1963 -- there is nothing to visit (the contents of the field will be
1964 -- printed when we print the containing node, but what concerns
1965 -- us now is looking for descendents in the tree.
1967 else
1968 null;
1969 end if;
1970 end Visit_Descendent;
1972 -- Start of processing for Visit_Node
1974 begin
1975 if N = Empty then
1976 return;
1977 end if;
1979 -- Set fatal error node in case we get a blow up during the trace
1981 Current_Error_Node := N;
1983 New_Prefix (Prefix_Str'Range) := Prefix_Str;
1984 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
1985 New_Prefix (Prefix_Str'Last + 2) := ' ';
1987 -- In the marking phase, all we do is to set the serial number
1989 if Phase = Marking then
1990 if Serial_Number (Int (N)) /= 0 then
1991 return; -- already visited
1992 else
1993 Set_Serial_Number;
1994 end if;
1996 -- In the printing phase, we print the node
1998 else
1999 if Serial_Number (Int (N)) < Next_Serial_Number then
2001 -- Here we have already visited the node, but if it is in a list,
2002 -- we still want to print the reference, so that it is clear that
2003 -- it belongs to the list.
2005 if Is_List_Member (N) then
2006 Print_Str (Prefix_Str);
2007 Print_Node_Ref (N);
2008 Print_Eol;
2009 Print_Str (Prefix_Str);
2010 Print_Char (Prefix_Char);
2011 Print_Str ("(already output)");
2012 Print_Eol;
2013 Print_Str (Prefix_Str);
2014 Print_Char (Prefix_Char);
2015 Print_Eol;
2016 end if;
2018 return;
2020 else
2021 Print_Node (N, Prefix_Str, Prefix_Char);
2022 Print_Str (Prefix_Str);
2023 Print_Char (Prefix_Char);
2024 Print_Eol;
2025 Next_Serial_Number := Next_Serial_Number + 1;
2026 end if;
2027 end if;
2029 -- Visit all descendents of this node
2031 if Nkind (N) not in N_Entity then
2032 Visit_Descendent (Field1 (N));
2033 Visit_Descendent (Field2 (N));
2034 Visit_Descendent (Field3 (N));
2035 Visit_Descendent (Field4 (N));
2036 Visit_Descendent (Field5 (N));
2038 if Has_Aspects (N) then
2039 Visit_Descendent (Union_Id (Aspect_Specifications (N)));
2040 end if;
2042 -- Entity case
2044 else
2045 Visit_Descendent (Field1 (N));
2046 Visit_Descendent (Field3 (N));
2047 Visit_Descendent (Field4 (N));
2048 Visit_Descendent (Field5 (N));
2049 Visit_Descendent (Field6 (N));
2050 Visit_Descendent (Field7 (N));
2051 Visit_Descendent (Field8 (N));
2052 Visit_Descendent (Field9 (N));
2053 Visit_Descendent (Field10 (N));
2054 Visit_Descendent (Field11 (N));
2055 Visit_Descendent (Field12 (N));
2056 Visit_Descendent (Field13 (N));
2057 Visit_Descendent (Field14 (N));
2058 Visit_Descendent (Field15 (N));
2059 Visit_Descendent (Field16 (N));
2060 Visit_Descendent (Field17 (N));
2061 Visit_Descendent (Field18 (N));
2062 Visit_Descendent (Field19 (N));
2063 Visit_Descendent (Field20 (N));
2064 Visit_Descendent (Field21 (N));
2065 Visit_Descendent (Field22 (N));
2066 Visit_Descendent (Field23 (N));
2068 -- Now an interesting special case. Normally parents are always
2069 -- printed since we traverse the tree in a downwards direction.
2070 -- However, there is an exception to this rule, which is the
2071 -- case where a parent is constructed by the compiler and is not
2072 -- referenced elsewhere in the tree. The following catches this case.
2074 if not Comes_From_Source (N) then
2075 Visit_Descendent (Union_Id (Parent (N)));
2076 end if;
2078 -- You may be wondering why we omitted Field2 above. The answer
2079 -- is that this is the Next_Entity field, and we want to treat
2080 -- it rather specially. Why? Because a Next_Entity link does not
2081 -- correspond to a level deeper in the tree, and we do not want
2082 -- the tree to march off to the right of the page due to bogus
2083 -- indentations coming from this effect.
2085 -- To prevent this, what we do is to control references via
2086 -- Next_Entity only from the first entity on a given scope chain,
2087 -- and we keep them all at the same level. Of course if an entity
2088 -- has already been referenced it is not printed.
2090 if Present (Next_Entity (N))
2091 and then Present (Scope (N))
2092 and then First_Entity (Scope (N)) = N
2093 then
2094 declare
2095 Nod : Node_Id;
2097 begin
2098 Nod := N;
2099 while Present (Nod) loop
2100 Visit_Descendent (Union_Id (Next_Entity (Nod)));
2101 Nod := Next_Entity (Nod);
2102 end loop;
2103 end;
2104 end if;
2105 end if;
2106 end Visit_Node;
2108 end Treepr;