?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
merge with trunk @ 139506
[official-gcc.git] / gcc / ada / treepr.adb
blob5fb53ae339ea1b15ab76939bf91cc695d3bbee1b
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-2008, 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 ------------------------------------------------------------------------------
25
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
31 with Lib; use Lib;
32 with Namet; use Namet;
33 with Nlists; use Nlists;
34 with Output; use Output;
35 with Sem_Mech; use Sem_Mech;
36 with Sinfo; use Sinfo;
37 with Snames; use Snames;
38 with Sinput; use Sinput;
39 with Stand; use Stand;
40 with Stringt; use Stringt;
41 with Treeprs; use Treeprs;
42 with Uintp; use Uintp;
43 with Urealp; use Urealp;
44 with Uname; use Uname;
45 with Unchecked_Deallocation;
46
47 package body Treepr is
48
49 use Atree.Unchecked_Access;
50 -- This module uses the unchecked access functions in package Atree
51 -- since it does an untyped traversal of the tree (we do not want to
52 -- count on the structure of the tree being correct in this routine!)
53
54 ----------------------------------
55 -- Approach Used for Tree Print --
56 ----------------------------------
57
58 -- When a complete subtree is being printed, a trace phase first marks
59 -- the nodes and lists to be printed. This trace phase allocates logical
60 -- numbers corresponding to the order in which the nodes and lists will
61 -- be printed. The Node_Id, List_Id and Elist_Id values are mapped to
62 -- logical node numbers using a hash table. Output is done using a set
63 -- of Print_xxx routines, which are similar to the Write_xxx routines
64 -- with the same name, except that they do not generate any output in
65 -- the marking phase. This allows identical logic to be used in the
66 -- two phases.
67
68 -- Note that the hash table not only holds the serial numbers, but also
69 -- acts as a record of which nodes have already been visited. In the
70 -- marking phase, a node has been visited if it is already in the hash
71 -- table, and in the printing phase, we can tell whether a node has
72 -- already been printed by looking at the value of the serial number.
73
74 ----------------------
75 -- Global Variables --
76 ----------------------
77
78 type Hash_Record is record
79 Serial : Nat;
80 -- Serial number for hash table entry. A value of zero means that
81 -- the entry is currently unused.
82
83 Id : Int;
84 -- If serial number field is non-zero, contains corresponding Id value
85 end record;
86
87 type Hash_Table_Type is array (Nat range <>) of Hash_Record;
88 type Access_Hash_Table_Type is access Hash_Table_Type;
89 Hash_Table : Access_Hash_Table_Type;
90 -- The hash table itself, see Serial_Number function for details of use
91
92 Hash_Table_Len : Nat;
93 -- Range of Hash_Table is from 0 .. Hash_Table_Len - 1 so that dividing
94 -- by Hash_Table_Len gives a remainder that is in Hash_Table'Range.
95
96 Next_Serial_Number : Nat;
97 -- Number of last visited node or list. Used during the marking phase to
98 -- set proper node numbers in the hash table, and during the printing
99 -- phase to make sure that a given node is not printed more than once.
100 -- (nodes are printed in order during the printing phase, that's the
101 -- point of numbering them in the first place!)
102
103 Printing_Descendants : Boolean;
104 -- True if descendants are being printed, False if not. In the false case,
105 -- only node Id's are printed. In the true case, node numbers as well as
106 -- node Id's are printed, as described above.
107
108 type Phase_Type is (Marking, Printing);
109 -- Type for Phase variable
110
111 Phase : Phase_Type;
112 -- When an entire tree is being printed, the traversal operates in two
113 -- phases. The first phase marks the nodes in use by installing node
114 -- numbers in the node number table. The second phase prints the nodes.
115 -- This variable indicates the current phase.
116
117 ----------------------
118 -- Local Procedures --
119 ----------------------
120
121 procedure Print_End_Span (N : Node_Id);
122 -- Special routine to print contents of End_Span field of node N.
123 -- The format includes the implicit source location as well as the
124 -- value of the field.
125
126 procedure Print_Init;
127 -- Initialize for printing of tree with descendents
128
129 procedure Print_Term;
130 -- Clean up after printing of tree with descendents
131
132 procedure Print_Char (C : Character);
133 -- Print character C if currently in print phase, noop if in marking phase
134
135 procedure Print_Name (N : Name_Id);
136 -- Print name from names table if currently in print phase, noop if in
137 -- marking phase. Note that the name is output in mixed case mode.
138
139 procedure Print_Node_Kind (N : Node_Id);
140 -- Print node kind name in mixed case if in print phase, noop if in
141 -- marking phase.
142
143 procedure Print_Str (S : String);
144 -- Print string S if currently in print phase, noop if in marking phase
145
146 procedure Print_Str_Mixed_Case (S : String);
147 -- Like Print_Str, except that the string is printed in mixed case mode
148
149 procedure Print_Int (I : Int);
150 -- Print integer I if currently in print phase, noop if in marking phase
151
152 procedure Print_Eol;
153 -- Print end of line if currently in print phase, noop if in marking phase
154
155 procedure Print_Node_Ref (N : Node_Id);
156 -- Print "<empty>", "<error>" or "Node #nnn" with additional information
157 -- in the latter case, including the Id and the Nkind of the node.
158
159 procedure Print_List_Ref (L : List_Id);
160 -- Print "<no list>", or "<empty node list>" or "Node list #nnn"
161
162 procedure Print_Elist_Ref (E : Elist_Id);
163 -- Print "<no elist>", or "<empty element list>" or "Element list #nnn"
164
165 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String);
166 -- Called if the node being printed is an entity. Prints fields from the
167 -- extension, using routines in Einfo to get the field names and flags.
168
169 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto);
170 -- Print representation of Field value (name, tree, string, uint, charcode)
171 -- The format parameter controls the format of printing in the case of an
172 -- integer value (see UI_Write for details).
173
174 procedure Print_Flag (F : Boolean);
175 -- Print True or False
176
177 procedure Print_Node
178 (N : Node_Id;
179 Prefix_Str : String;
180 Prefix_Char : Character);
181 -- This is the internal routine used to print a single node. Each line of
182 -- output is preceded by Prefix_Str (which is used to set the indentation
183 -- level and the bars used to link list elements). In addition, for lines
184 -- other than the first, an additional character Prefix_Char is output.
185
186 function Serial_Number (Id : Int) return Nat;
187 -- Given a Node_Id, List_Id or Elist_Id, returns the previously assigned
188 -- serial number, or zero if no serial number has yet been assigned.
189
190 procedure Set_Serial_Number;
191 -- Can be called only immediately following a call to Serial_Number that
192 -- returned a value of zero. Causes the value of Next_Serial_Number to be
193 -- placed in the hash table (corresponding to the Id argument used in the
194 -- Serial_Number call), and increments Next_Serial_Number.
195
196 procedure Visit_Node
197 (N : Node_Id;
198 Prefix_Str : String;
199 Prefix_Char : Character);
200 -- Called to process a single node in the case where descendents are to
201 -- be printed before every line, and Prefix_Char added to all lines
202 -- except the header line for the node.
203
204 procedure Visit_List (L : List_Id; Prefix_Str : String);
205 -- Visit_List is called to process a list in the case where descendents
206 -- are to be printed. Prefix_Str is to be added to all printed lines.
207
208 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String);
209 -- Visit_Elist is called to process an element list in the case where
210 -- descendents are to be printed. Prefix_Str is to be added to all
211 -- printed lines.
212
213 --------
214 -- pe --
215 --------
216
217 procedure pe (E : Elist_Id) is
218 begin
219 Print_Tree_Elist (E);
220 end pe;
221
222 --------
223 -- pl --
224 --------
225
226 procedure pl (L : Int) is
227 Lid : Int;
228
229 begin
230 if L < 0 then
231 Lid := L;
232
233 -- This is the case where we transform e.g. +36 to -99999936
234
235 else
236 if L <= 9 then
237 Lid := -(99999990 + L);
238 elsif L <= 99 then
239 Lid := -(99999900 + L);
240 elsif L <= 999 then
241 Lid := -(99999000 + L);
242 elsif L <= 9999 then
243 Lid := -(99990000 + L);
244 elsif L <= 99999 then
245 Lid := -(99900000 + L);
246 elsif L <= 999999 then
247 Lid := -(99000000 + L);
248 elsif L <= 9999999 then
249 Lid := -(90000000 + L);
250 else
251 Lid := -L;
252 end if;
253 end if;
254
255 -- Now output the list
256
257 Print_Tree_List (List_Id (Lid));
258 end pl;
259
260 --------
261 -- pn --
262 --------
263
264 procedure pn (N : Node_Id) is
265 begin
266 Print_Tree_Node (N);
267 end pn;
268
269 ----------------
270 -- Print_Char --
271 ----------------
272
273 procedure Print_Char (C : Character) is
274 begin
275 if Phase = Printing then
276 Write_Char (C);
277 end if;
278 end Print_Char;
279
280 ---------------------
281 -- Print_Elist_Ref --
282 ---------------------
283
284 procedure Print_Elist_Ref (E : Elist_Id) is
285 begin
286 if Phase /= Printing then
287 return;
288 end if;
289
290 if E = No_Elist then
291 Write_Str ("<no elist>");
292
293 elsif Is_Empty_Elmt_List (E) then
294 Write_Str ("Empty elist, (Elist_Id=");
295 Write_Int (Int (E));
296 Write_Char (')');
297
298 else
299 Write_Str ("(Elist_Id=");
300 Write_Int (Int (E));
301 Write_Char (')');
302
303 if Printing_Descendants then
304 Write_Str (" #");
305 Write_Int (Serial_Number (Int (E)));
306 end if;
307 end if;
308 end Print_Elist_Ref;
309
310 -------------------------
311 -- Print_Elist_Subtree --
312 -------------------------
313
314 procedure Print_Elist_Subtree (E : Elist_Id) is
315 begin
316 Print_Init;
317
318 Next_Serial_Number := 1;
319 Phase := Marking;
320 Visit_Elist (E, "");
321
322 Next_Serial_Number := 1;
323 Phase := Printing;
324 Visit_Elist (E, "");
325
326 Print_Term;
327 end Print_Elist_Subtree;
328
329 --------------------
330 -- Print_End_Span --
331 --------------------
332
333 procedure Print_End_Span (N : Node_Id) is
334 Val : constant Uint := End_Span (N);
335
336 begin
337 UI_Write (Val);
338 Write_Str (" (Uint = ");
339 Write_Int (Int (Field5 (N)));
340 Write_Str (") ");
341
342 if Val /= No_Uint then
343 Write_Location (End_Location (N));
344 end if;
345 end Print_End_Span;
346
347 -----------------------
348 -- Print_Entity_Info --
349 -----------------------
350
351 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
352 function Field_Present (U : Union_Id) return Boolean;
353 -- Returns False unless the value U represents a missing value
354 -- (Empty, No_Uint, No_Ureal or No_String)
355
356 function Field_Present (U : Union_Id) return Boolean is
357 begin
358 return
359 U /= Union_Id (Empty) and then
360 U /= To_Union (No_Uint) and then
361 U /= To_Union (No_Ureal) and then
362 U /= Union_Id (No_String);
363 end Field_Present;
364
365 -- Start of processing for Print_Entity_Info
366
367 begin
368 Print_Str (Prefix);
369 Print_Str ("Ekind = ");
370 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
371 Print_Eol;
372
373 Print_Str (Prefix);
374 Print_Str ("Etype = ");
375 Print_Node_Ref (Etype (Ent));
376 Print_Eol;
377
378 if Convention (Ent) /= Convention_Ada then
379 Print_Str (Prefix);
380 Print_Str ("Convention = ");
381
382 -- Print convention name skipping the Convention_ at the start
383
384 declare
385 S : constant String := Convention_Id'Image (Convention (Ent));
386
387 begin
388 Print_Str_Mixed_Case (S (12 .. S'Last));
389 Print_Eol;
390 end;
391 end if;
392
393 if Field_Present (Field6 (Ent)) then
394 Print_Str (Prefix);
395 Write_Field6_Name (Ent);
396 Write_Str (" = ");
397 Print_Field (Field6 (Ent));
398 Print_Eol;
399 end if;
400
401 if Field_Present (Field7 (Ent)) then
402 Print_Str (Prefix);
403 Write_Field7_Name (Ent);
404 Write_Str (" = ");
405 Print_Field (Field7 (Ent));
406 Print_Eol;
407 end if;
408
409 if Field_Present (Field8 (Ent)) then
410 Print_Str (Prefix);
411 Write_Field8_Name (Ent);
412 Write_Str (" = ");
413 Print_Field (Field8 (Ent));
414 Print_Eol;
415 end if;
416
417 if Field_Present (Field9 (Ent)) then
418 Print_Str (Prefix);
419 Write_Field9_Name (Ent);
420 Write_Str (" = ");
421 Print_Field (Field9 (Ent));
422 Print_Eol;
423 end if;
424
425 if Field_Present (Field10 (Ent)) then
426 Print_Str (Prefix);
427 Write_Field10_Name (Ent);
428 Write_Str (" = ");
429 Print_Field (Field10 (Ent));
430 Print_Eol;
431 end if;
432
433 if Field_Present (Field11 (Ent)) then
434 Print_Str (Prefix);
435 Write_Field11_Name (Ent);
436 Write_Str (" = ");
437 Print_Field (Field11 (Ent));
438 Print_Eol;
439 end if;
440
441 if Field_Present (Field12 (Ent)) then
442 Print_Str (Prefix);
443 Write_Field12_Name (Ent);
444 Write_Str (" = ");
445 Print_Field (Field12 (Ent));
446 Print_Eol;
447 end if;
448
449 if Field_Present (Field13 (Ent)) then
450 Print_Str (Prefix);
451 Write_Field13_Name (Ent);
452 Write_Str (" = ");
453 Print_Field (Field13 (Ent));
454 Print_Eol;
455 end if;
456
457 if Field_Present (Field14 (Ent)) then
458 Print_Str (Prefix);
459 Write_Field14_Name (Ent);
460 Write_Str (" = ");
461 Print_Field (Field14 (Ent));
462 Print_Eol;
463 end if;
464
465 if Field_Present (Field15 (Ent)) then
466 Print_Str (Prefix);
467 Write_Field15_Name (Ent);
468 Write_Str (" = ");
469 Print_Field (Field15 (Ent));
470 Print_Eol;
471 end if;
472
473 if Field_Present (Field16 (Ent)) then
474 Print_Str (Prefix);
475 Write_Field16_Name (Ent);
476 Write_Str (" = ");
477 Print_Field (Field16 (Ent));
478 Print_Eol;
479 end if;
480
481 if Field_Present (Field17 (Ent)) then
482 Print_Str (Prefix);
483 Write_Field17_Name (Ent);
484 Write_Str (" = ");
485 Print_Field (Field17 (Ent));
486 Print_Eol;
487 end if;
488
489 if Field_Present (Field18 (Ent)) then
490 Print_Str (Prefix);
491 Write_Field18_Name (Ent);
492 Write_Str (" = ");
493 Print_Field (Field18 (Ent));
494 Print_Eol;
495 end if;
496
497 if Field_Present (Field19 (Ent)) then
498 Print_Str (Prefix);
499 Write_Field19_Name (Ent);
500 Write_Str (" = ");
501 Print_Field (Field19 (Ent));
502 Print_Eol;
503 end if;
504
505 if Field_Present (Field20 (Ent)) then
506 Print_Str (Prefix);
507 Write_Field20_Name (Ent);
508 Write_Str (" = ");
509 Print_Field (Field20 (Ent));
510 Print_Eol;
511 end if;
512
513 if Field_Present (Field21 (Ent)) then
514 Print_Str (Prefix);
515 Write_Field21_Name (Ent);
516 Write_Str (" = ");
517 Print_Field (Field21 (Ent));
518 Print_Eol;
519 end if;
520
521 if Field_Present (Field22 (Ent)) then
522 Print_Str (Prefix);
523 Write_Field22_Name (Ent);
524 Write_Str (" = ");
525
526 -- Mechanism case has to be handled specially
527
528 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
529 declare
530 M : constant Mechanism_Type := Mechanism (Ent);
531
532 begin
533 case M is
534 when Default_Mechanism
535 => Write_Str ("Default");
536 when By_Copy
537 => Write_Str ("By_Copy");
538 when By_Reference
539 => Write_Str ("By_Reference");
540 when By_Descriptor
541 => Write_Str ("By_Descriptor");
542 when By_Descriptor_UBS
543 => Write_Str ("By_Descriptor_UBS");
544 when By_Descriptor_UBSB
545 => Write_Str ("By_Descriptor_UBSB");
546 when By_Descriptor_UBA
547 => Write_Str ("By_Descriptor_UBA");
548 when By_Descriptor_S
549 => Write_Str ("By_Descriptor_S");
550 when By_Descriptor_SB
551 => Write_Str ("By_Descriptor_SB");
552 when By_Descriptor_A
553 => Write_Str ("By_Descriptor_A");
554 when By_Descriptor_NCA
555 => Write_Str ("By_Descriptor_NCA");
556 when By_Short_Descriptor
557 => Write_Str ("By_Short_Descriptor");
558 when By_Short_Descriptor_UBS
559 => Write_Str ("By_Short_Descriptor_UBS");
560 when By_Short_Descriptor_UBSB
561 => Write_Str ("By_Short_Descriptor_UBSB");
562 when By_Short_Descriptor_UBA
563 => Write_Str ("By_Short_Descriptor_UBA");
564 when By_Short_Descriptor_S
565 => Write_Str ("By_Short_Descriptor_S");
566 when By_Short_Descriptor_SB
567 => Write_Str ("By_Short_Descriptor_SB");
568 when By_Short_Descriptor_A
569 => Write_Str ("By_Short_Descriptor_A");
570 when By_Short_Descriptor_NCA
571 => Write_Str ("By_Short_Descriptor_NCA");
572
573 when 1 .. Mechanism_Type'Last =>
574 Write_Str ("By_Copy if size <= ");
575 Write_Int (Int (M));
576
577 end case;
578 end;
579
580 -- Normal case (not Mechanism)
581
582 else
583 Print_Field (Field22 (Ent));
584 end if;
585
586 Print_Eol;
587 end if;
588
589 if Field_Present (Field23 (Ent)) then
590 Print_Str (Prefix);
591 Write_Field23_Name (Ent);
592 Write_Str (" = ");
593 Print_Field (Field23 (Ent));
594 Print_Eol;
595 end if;
596
597 if Field_Present (Field24 (Ent)) then
598 Print_Str (Prefix);
599 Write_Field24_Name (Ent);
600 Write_Str (" = ");
601 Print_Field (Field24 (Ent));
602 Print_Eol;
603 end if;
604
605 if Field_Present (Field25 (Ent)) then
606 Print_Str (Prefix);
607 Write_Field25_Name (Ent);
608 Write_Str (" = ");
609 Print_Field (Field25 (Ent));
610 Print_Eol;
611 end if;
612
613 if Field_Present (Field26 (Ent)) then
614 Print_Str (Prefix);
615 Write_Field26_Name (Ent);
616 Write_Str (" = ");
617 Print_Field (Field26 (Ent));
618 Print_Eol;
619 end if;
620
621 if Field_Present (Field27 (Ent)) then
622 Print_Str (Prefix);
623 Write_Field27_Name (Ent);
624 Write_Str (" = ");
625 Print_Field (Field27 (Ent));
626 Print_Eol;
627 end if;
628
629 Write_Entity_Flags (Ent, Prefix);
630 end Print_Entity_Info;
631
632 ---------------
633 -- Print_Eol --
634 ---------------
635
636 procedure Print_Eol is
637 begin
638 if Phase = Printing then
639 Write_Eol;
640 end if;
641 end Print_Eol;
642
643 -----------------
644 -- Print_Field --
645 -----------------
646
647 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
648 begin
649 if Phase /= Printing then
650 return;
651 end if;
652
653 if Val in Node_Range then
654 Print_Node_Ref (Node_Id (Val));
655
656 elsif Val in List_Range then
657 Print_List_Ref (List_Id (Val));
658
659 elsif Val in Elist_Range then
660 Print_Elist_Ref (Elist_Id (Val));
661
662 elsif Val in Names_Range then
663 Print_Name (Name_Id (Val));
664 Write_Str (" (Name_Id=");
665 Write_Int (Int (Val));
666 Write_Char (')');
667
668 elsif Val in Strings_Range then
669 Write_String_Table_Entry (String_Id (Val));
670 Write_Str (" (String_Id=");
671 Write_Int (Int (Val));
672 Write_Char (')');
673
674 elsif Val in Uint_Range then
675 UI_Write (From_Union (Val), Format);
676 Write_Str (" (Uint = ");
677 Write_Int (Int (Val));
678 Write_Char (')');
679
680 elsif Val in Ureal_Range then
681 UR_Write (From_Union (Val));
682 Write_Str (" (Ureal = ");
683 Write_Int (Int (Val));
684 Write_Char (')');
685
686 else
687 Print_Str ("****** Incorrect value = ");
688 Print_Int (Int (Val));
689 end if;
690 end Print_Field;
691
692 ----------------
693 -- Print_Flag --
694 ----------------
695
696 procedure Print_Flag (F : Boolean) is
697 begin
698 if F then
699 Print_Str ("True");
700 else
701 Print_Str ("False");
702 end if;
703 end Print_Flag;
704
705 ----------------
706 -- Print_Init --
707 ----------------
708
709 procedure Print_Init is
710 begin
711 Printing_Descendants := True;
712 Write_Eol;
713
714 -- Allocate and clear serial number hash table. The size is 150% of
715 -- the maximum possible number of entries, so that the hash table
716 -- cannot get significantly overloaded.
717
718 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
719 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
720
721 for J in Hash_Table'Range loop
722 Hash_Table (J).Serial := 0;
723 end loop;
724
725 end Print_Init;
726
727 ---------------
728 -- Print_Int --
729 ---------------
730
731 procedure Print_Int (I : Int) is
732 begin
733 if Phase = Printing then
734 Write_Int (I);
735 end if;
736 end Print_Int;
737
738 --------------------
739 -- Print_List_Ref --
740 --------------------
741
742 procedure Print_List_Ref (L : List_Id) is
743 begin
744 if Phase /= Printing then
745 return;
746 end if;
747
748 if No (L) then
749 Write_Str ("<no list>");
750
751 elsif Is_Empty_List (L) then
752 Write_Str ("<empty list> (List_Id=");
753 Write_Int (Int (L));
754 Write_Char (')');
755
756 else
757 Write_Str ("List");
758
759 if Printing_Descendants then
760 Write_Str (" #");
761 Write_Int (Serial_Number (Int (L)));
762 end if;
763
764 Write_Str (" (List_Id=");
765 Write_Int (Int (L));
766 Write_Char (')');
767 end if;
768 end Print_List_Ref;
769
770 ------------------------
771 -- Print_List_Subtree --
772 ------------------------
773
774 procedure Print_List_Subtree (L : List_Id) is
775 begin
776 Print_Init;
777
778 Next_Serial_Number := 1;
779 Phase := Marking;
780 Visit_List (L, "");
781
782 Next_Serial_Number := 1;
783 Phase := Printing;
784 Visit_List (L, "");
785
786 Print_Term;
787 end Print_List_Subtree;
788
789 ----------------
790 -- Print_Name --
791 ----------------
792
793 procedure Print_Name (N : Name_Id) is
794 begin
795 if Phase = Printing then
796 if N = No_Name then
797 Print_Str ("<No_Name>");
798
799 elsif N = Error_Name then
800 Print_Str ("<Error_Name>");
801
802 elsif Is_Valid_Name (N) then
803 Get_Name_String (N);
804 Print_Char ('"');
805 Write_Name (N);
806 Print_Char ('"');
807
808 else
809 Print_Str ("<invalid name ???>");
810 end if;
811 end if;
812 end Print_Name;
813
814 ----------------
815 -- Print_Node --
816 ----------------
817
818 procedure Print_Node
819 (N : Node_Id;
820 Prefix_Str : String;
821 Prefix_Char : Character)
822 is
823 F : Fchar;
824 P : Natural := Pchar_Pos (Nkind (N));
825
826 Field_To_Be_Printed : Boolean;
827 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
828
829 Sfile : Source_File_Index;
830 Notes : Boolean;
831 Fmt : UI_Format;
832
833 begin
834 if Phase /= Printing then
835 return;
836 end if;
837
838 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
839 Fmt := Hex;
840 else
841 Fmt := Auto;
842 end if;
843
844 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
845 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
846
847 -- Print header line
848
849 Print_Str (Prefix_Str);
850 Print_Node_Ref (N);
851
852 Notes := False;
853
854 if N > Atree_Private_Part.Nodes.Last then
855 Print_Str (" (no such node)");
856 Print_Eol;
857 return;
858 end if;
859
860 if Comes_From_Source (N) then
861 Notes := True;
862 Print_Str (" (source");
863 end if;
864
865 if Analyzed (N) then
866 if not Notes then
867 Notes := True;
868 Print_Str (" (");
869 else
870 Print_Str (",");
871 end if;
872
873 Print_Str ("analyzed");
874 end if;
875
876 if Error_Posted (N) then
877 if not Notes then
878 Notes := True;
879 Print_Str (" (");
880 else
881 Print_Str (",");
882 end if;
883
884 Print_Str ("posted");
885 end if;
886
887 if Notes then
888 Print_Char (')');
889 end if;
890
891 Print_Eol;
892
893 if Is_Rewrite_Substitution (N) then
894 Print_Str (Prefix_Str);
895 Print_Str (" Rewritten: original node = ");
896 Print_Node_Ref (Original_Node (N));
897 Print_Eol;
898 end if;
899
900 if N = Empty then
901 return;
902 end if;
903
904 if not Is_List_Member (N) then
905 Print_Str (Prefix_Str);
906 Print_Str (" Parent = ");
907 Print_Node_Ref (Parent (N));
908 Print_Eol;
909 end if;
910
911 -- Print Sloc field if it is set
912
913 if Sloc (N) /= No_Location then
914 Print_Str (Prefix_Str_Char);
915 Print_Str ("Sloc = ");
916
917 if Sloc (N) = Standard_Location then
918 Print_Str ("Standard_Location");
919
920 elsif Sloc (N) = Standard_ASCII_Location then
921 Print_Str ("Standard_ASCII_Location");
922
923 else
924 Sfile := Get_Source_File_Index (Sloc (N));
925 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
926 Write_Str (" ");
927 Write_Location (Sloc (N));
928 end if;
929
930 Print_Eol;
931 end if;
932
933 -- Print Chars field if present
934
935 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
936 Print_Str (Prefix_Str_Char);
937 Print_Str ("Chars = ");
938 Print_Name (Chars (N));
939 Write_Str (" (Name_Id=");
940 Write_Int (Int (Chars (N)));
941 Write_Char (')');
942 Print_Eol;
943 end if;
944
945 -- Special field print operations for non-entity nodes
946
947 if Nkind (N) not in N_Entity then
948
949 -- Deal with Left_Opnd and Right_Opnd fields
950
951 if Nkind (N) in N_Op
952 or else Nkind (N) = N_And_Then
953 or else Nkind (N) = N_Or_Else
954 or else Nkind (N) in N_Membership_Test
955 then
956 -- Print Left_Opnd if present
957
958 if Nkind (N) not in N_Unary_Op then
959 Print_Str (Prefix_Str_Char);
960 Print_Str ("Left_Opnd = ");
961 Print_Node_Ref (Left_Opnd (N));
962 Print_Eol;
963 end if;
964
965 -- Print Right_Opnd
966
967 Print_Str (Prefix_Str_Char);
968 Print_Str ("Right_Opnd = ");
969 Print_Node_Ref (Right_Opnd (N));
970 Print_Eol;
971 end if;
972
973 -- Print Entity field if operator (other cases of Entity
974 -- are in the table, so are handled in the normal circuit)
975
976 if Nkind (N) in N_Op and then Present (Entity (N)) then
977 Print_Str (Prefix_Str_Char);
978 Print_Str ("Entity = ");
979 Print_Node_Ref (Entity (N));
980 Print_Eol;
981 end if;
982
983 -- Print special fields if we have a subexpression
984
985 if Nkind (N) in N_Subexpr then
986
987 if Assignment_OK (N) then
988 Print_Str (Prefix_Str_Char);
989 Print_Str ("Assignment_OK = True");
990 Print_Eol;
991 end if;
992
993 if Do_Range_Check (N) then
994 Print_Str (Prefix_Str_Char);
995 Print_Str ("Do_Range_Check = True");
996 Print_Eol;
997 end if;
998
999 if Has_Dynamic_Length_Check (N) then
1000 Print_Str (Prefix_Str_Char);
1001 Print_Str ("Has_Dynamic_Length_Check = True");
1002 Print_Eol;
1003 end if;
1004
1005 if Has_Dynamic_Range_Check (N) then
1006 Print_Str (Prefix_Str_Char);
1007 Print_Str ("Has_Dynamic_Range_Check = True");
1008 Print_Eol;
1009 end if;
1010
1011 if Is_Controlling_Actual (N) then
1012 Print_Str (Prefix_Str_Char);
1013 Print_Str ("Is_Controlling_Actual = True");
1014 Print_Eol;
1015 end if;
1016
1017 if Is_Overloaded (N) then
1018 Print_Str (Prefix_Str_Char);
1019 Print_Str ("Is_Overloaded = True");
1020 Print_Eol;
1021 end if;
1022
1023 if Is_Static_Expression (N) then
1024 Print_Str (Prefix_Str_Char);
1025 Print_Str ("Is_Static_Expression = True");
1026 Print_Eol;
1027 end if;
1028
1029 if Must_Not_Freeze (N) then
1030 Print_Str (Prefix_Str_Char);
1031 Print_Str ("Must_Not_Freeze = True");
1032 Print_Eol;
1033 end if;
1034
1035 if Paren_Count (N) /= 0 then
1036 Print_Str (Prefix_Str_Char);
1037 Print_Str ("Paren_Count = ");
1038 Print_Int (Int (Paren_Count (N)));
1039 Print_Eol;
1040 end if;
1041
1042 if Raises_Constraint_Error (N) then
1043 Print_Str (Prefix_Str_Char);
1044 Print_Str ("Raise_Constraint_Error = True");
1045 Print_Eol;
1046 end if;
1047
1048 end if;
1049
1050 -- Print Do_Overflow_Check field if present
1051
1052 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
1053 Print_Str (Prefix_Str_Char);
1054 Print_Str ("Do_Overflow_Check = True");
1055 Print_Eol;
1056 end if;
1057
1058 -- Print Etype field if present (printing of this field for entities
1059 -- is handled by the Print_Entity_Info procedure).
1060
1061 if Nkind (N) in N_Has_Etype and then Present (Etype (N)) then
1062 Print_Str (Prefix_Str_Char);
1063 Print_Str ("Etype = ");
1064 Print_Node_Ref (Etype (N));
1065 Print_Eol;
1066 end if;
1067 end if;
1068
1069 -- Loop to print fields included in Pchars array
1070
1071 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1072 F := Pchars (P);
1073 P := P + 1;
1074
1075 -- Check for case of False flag, which we never print, or
1076 -- an Empty field, which is also never printed
1077
1078 case F is
1079 when F_Field1 =>
1080 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1081
1082 when F_Field2 =>
1083 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1084
1085 when F_Field3 =>
1086 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1087
1088 when F_Field4 =>
1089 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1090
1091 when F_Field5 =>
1092 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1093
1094 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1095 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1096 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1097 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1098 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1099 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1100 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1101 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1102 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1103 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1104 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1105 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1106 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1107 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1108 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1109
1110 -- Flag1,2,3 are no longer used
1111
1112 when F_Flag1 => raise Program_Error;
1113 when F_Flag2 => raise Program_Error;
1114 when F_Flag3 => raise Program_Error;
1115
1116 end case;
1117
1118 -- Print field if it is to be printed
1119
1120 if Field_To_Be_Printed then
1121 Print_Str (Prefix_Str_Char);
1122
1123 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1124 and then Pchars (P) not in Fchar
1125 loop
1126 Print_Char (Pchars (P));
1127 P := P + 1;
1128 end loop;
1129
1130 Print_Str (" = ");
1131
1132 case F is
1133 when F_Field1 => Print_Field (Field1 (N), Fmt);
1134 when F_Field2 => Print_Field (Field2 (N), Fmt);
1135 when F_Field3 => Print_Field (Field3 (N), Fmt);
1136 when F_Field4 => Print_Field (Field4 (N), Fmt);
1137
1138 -- Special case End_Span = Uint5
1139
1140 when F_Field5 =>
1141 if Nkind (N) = N_Case_Statement
1142 or else Nkind (N) = N_If_Statement
1143 then
1144 Print_End_Span (N);
1145 else
1146 Print_Field (Field5 (N), Fmt);
1147 end if;
1148
1149 when F_Flag4 => Print_Flag (Flag4 (N));
1150 when F_Flag5 => Print_Flag (Flag5 (N));
1151 when F_Flag6 => Print_Flag (Flag6 (N));
1152 when F_Flag7 => Print_Flag (Flag7 (N));
1153 when F_Flag8 => Print_Flag (Flag8 (N));
1154 when F_Flag9 => Print_Flag (Flag9 (N));
1155 when F_Flag10 => Print_Flag (Flag10 (N));
1156 when F_Flag11 => Print_Flag (Flag11 (N));
1157 when F_Flag12 => Print_Flag (Flag12 (N));
1158 when F_Flag13 => Print_Flag (Flag13 (N));
1159 when F_Flag14 => Print_Flag (Flag14 (N));
1160 when F_Flag15 => Print_Flag (Flag15 (N));
1161 when F_Flag16 => Print_Flag (Flag16 (N));
1162 when F_Flag17 => Print_Flag (Flag17 (N));
1163 when F_Flag18 => Print_Flag (Flag18 (N));
1164
1165 -- Flag1,2,3 are no longer used
1166
1167 when F_Flag1 => raise Program_Error;
1168 when F_Flag2 => raise Program_Error;
1169 when F_Flag3 => raise Program_Error;
1170 end case;
1171
1172 Print_Eol;
1173
1174 -- Field is not to be printed (False flag field)
1175
1176 else
1177 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1178 and then Pchars (P) not in Fchar
1179 loop
1180 P := P + 1;
1181 end loop;
1182 end if;
1183
1184 end loop;
1185
1186 -- Print entity information for entities
1187
1188 if Nkind (N) in N_Entity then
1189 Print_Entity_Info (N, Prefix_Str_Char);
1190 end if;
1191
1192 end Print_Node;
1193
1194 ---------------------
1195 -- Print_Node_Kind --
1196 ---------------------
1197
1198 procedure Print_Node_Kind (N : Node_Id) is
1199 Ucase : Boolean;
1200 S : constant String := Node_Kind'Image (Nkind (N));
1201
1202 begin
1203 if Phase = Printing then
1204 Ucase := True;
1205
1206 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1207 -- bug of 'Image returning lower case instead of upper case.
1208
1209 for J in S'Range loop
1210 if Ucase then
1211 Write_Char (Fold_Upper (S (J)));
1212 else
1213 Write_Char (Fold_Lower (S (J)));
1214 end if;
1215
1216 Ucase := (S (J) = '_');
1217 end loop;
1218 end if;
1219 end Print_Node_Kind;
1220
1221 --------------------
1222 -- Print_Node_Ref --
1223 --------------------
1224
1225 procedure Print_Node_Ref (N : Node_Id) is
1226 S : Nat;
1227
1228 begin
1229 if Phase /= Printing then
1230 return;
1231 end if;
1232
1233 if N = Empty then
1234 Write_Str ("<empty>");
1235
1236 elsif N = Error then
1237 Write_Str ("<error>");
1238
1239 else
1240 if Printing_Descendants then
1241 S := Serial_Number (Int (N));
1242
1243 if S /= 0 then
1244 Write_Str ("Node");
1245 Write_Str (" #");
1246 Write_Int (S);
1247 Write_Char (' ');
1248 end if;
1249 end if;
1250
1251 Print_Node_Kind (N);
1252
1253 if Nkind (N) in N_Has_Chars then
1254 Write_Char (' ');
1255 Print_Name (Chars (N));
1256 end if;
1257
1258 if Nkind (N) in N_Entity then
1259 Write_Str (" (Entity_Id=");
1260 else
1261 Write_Str (" (Node_Id=");
1262 end if;
1263
1264 Write_Int (Int (N));
1265
1266 if Sloc (N) <= Standard_Location then
1267 Write_Char ('s');
1268 end if;
1269
1270 Write_Char (')');
1271
1272 end if;
1273 end Print_Node_Ref;
1274
1275 ------------------------
1276 -- Print_Node_Subtree --
1277 ------------------------
1278
1279 procedure Print_Node_Subtree (N : Node_Id) is
1280 begin
1281 Print_Init;
1282
1283 Next_Serial_Number := 1;
1284 Phase := Marking;
1285 Visit_Node (N, "", ' ');
1286
1287 Next_Serial_Number := 1;
1288 Phase := Printing;
1289 Visit_Node (N, "", ' ');
1290
1291 Print_Term;
1292 end Print_Node_Subtree;
1293
1294 ---------------
1295 -- Print_Str --
1296 ---------------
1297
1298 procedure Print_Str (S : String) is
1299 begin
1300 if Phase = Printing then
1301 Write_Str (S);
1302 end if;
1303 end Print_Str;
1304
1305 --------------------------
1306 -- Print_Str_Mixed_Case --
1307 --------------------------
1308
1309 procedure Print_Str_Mixed_Case (S : String) is
1310 Ucase : Boolean;
1311
1312 begin
1313 if Phase = Printing then
1314 Ucase := True;
1315
1316 for J in S'Range loop
1317 if Ucase then
1318 Write_Char (S (J));
1319 else
1320 Write_Char (Fold_Lower (S (J)));
1321 end if;
1322
1323 Ucase := (S (J) = '_');
1324 end loop;
1325 end if;
1326 end Print_Str_Mixed_Case;
1327
1328 ----------------
1329 -- Print_Term --
1330 ----------------
1331
1332 procedure Print_Term is
1333 procedure Free is new Unchecked_Deallocation
1334 (Hash_Table_Type, Access_Hash_Table_Type);
1335
1336 begin
1337 Free (Hash_Table);
1338 end Print_Term;
1339
1340 ---------------------
1341 -- Print_Tree_Elist --
1342 ---------------------
1343
1344 procedure Print_Tree_Elist (E : Elist_Id) is
1345 M : Elmt_Id;
1346
1347 begin
1348 Printing_Descendants := False;
1349 Phase := Printing;
1350
1351 Print_Elist_Ref (E);
1352 Print_Eol;
1353
1354 M := First_Elmt (E);
1355
1356 if No (M) then
1357 Print_Str ("<empty element list>");
1358 Print_Eol;
1359
1360 else
1361 loop
1362 Print_Char ('|');
1363 Print_Eol;
1364 exit when No (Next_Elmt (M));
1365 Print_Node (Node (M), "", '|');
1366 Next_Elmt (M);
1367 end loop;
1368
1369 Print_Node (Node (M), "", ' ');
1370 Print_Eol;
1371 end if;
1372 end Print_Tree_Elist;
1373
1374 ---------------------
1375 -- Print_Tree_List --
1376 ---------------------
1377
1378 procedure Print_Tree_List (L : List_Id) is
1379 N : Node_Id;
1380
1381 begin
1382 Printing_Descendants := False;
1383 Phase := Printing;
1384
1385 Print_List_Ref (L);
1386 Print_Str (" List_Id=");
1387 Print_Int (Int (L));
1388 Print_Eol;
1389
1390 N := First (L);
1391
1392 if N = Empty then
1393 Print_Str ("<empty node list>");
1394 Print_Eol;
1395
1396 else
1397 loop
1398 Print_Char ('|');
1399 Print_Eol;
1400 exit when Next (N) = Empty;
1401 Print_Node (N, "", '|');
1402 Next (N);
1403 end loop;
1404
1405 Print_Node (N, "", ' ');
1406 Print_Eol;
1407 end if;
1408 end Print_Tree_List;
1409
1410 ---------------------
1411 -- Print_Tree_Node --
1412 ---------------------
1413
1414 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1415 begin
1416 Printing_Descendants := False;
1417 Phase := Printing;
1418 Print_Node (N, Label, ' ');
1419 end Print_Tree_Node;
1420
1421 --------
1422 -- pt --
1423 --------
1424
1425 procedure pt (N : Node_Id) is
1426 begin
1427 Print_Node_Subtree (N);
1428 end pt;
1429
1430 -------------------
1431 -- Serial_Number --
1432 -------------------
1433
1434 -- The hashing algorithm is to use the remainder of the ID value divided
1435 -- by the hash table length as the starting point in the table, and then
1436 -- handle collisions by serial searching wrapping at the end of the table.
1437
1438 Hash_Slot : Nat;
1439 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1440 -- to save the slot that should be used if Set_Serial_Number is called.
1441
1442 function Serial_Number (Id : Int) return Nat is
1443 H : Int := Id mod Hash_Table_Len;
1444
1445 begin
1446 while Hash_Table (H).Serial /= 0 loop
1447
1448 if Id = Hash_Table (H).Id then
1449 return Hash_Table (H).Serial;
1450 end if;
1451
1452 H := H + 1;
1453
1454 if H > Hash_Table'Last then
1455 H := 0;
1456 end if;
1457 end loop;
1458
1459 -- Entry was not found, save slot number for possible subsequent call
1460 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1461 -- in case of such a call (the Id field is never read if the serial
1462 -- number of the slot is zero, so this is harmless in the case where
1463 -- Set_Serial_Number is not subsequently called).
1464
1465 Hash_Slot := H;
1466 Hash_Table (H).Id := Id;
1467 return 0;
1468
1469 end Serial_Number;
1470
1471 -----------------------
1472 -- Set_Serial_Number --
1473 -----------------------
1474
1475 procedure Set_Serial_Number is
1476 begin
1477 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1478 Next_Serial_Number := Next_Serial_Number + 1;
1479 end Set_Serial_Number;
1480
1481 ---------------
1482 -- Tree_Dump --
1483 ---------------
1484
1485 procedure Tree_Dump is
1486 procedure Underline;
1487 -- Put underline under string we just printed
1488
1489 procedure Underline is
1490 Col : constant Int := Column;
1491
1492 begin
1493 Write_Eol;
1494
1495 while Col > Column loop
1496 Write_Char ('-');
1497 end loop;
1498
1499 Write_Eol;
1500 end Underline;
1501
1502 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1503 -- flags immediately, before starting the dump. This avoids generating two
1504 -- copies of the dump if an abort occurs after printing the dump, and more
1505 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1506
1507 -- Note: unlike in the source print case (in Sprint), we do not output
1508 -- separate trees for each unit. Instead the -df debug switch causes the
1509 -- tree that is output from the main unit to trace references into other
1510 -- units (normally such references are not traced). Since all other units
1511 -- are linked to the main unit by at least one reference, this causes all
1512 -- tree nodes to be included in the output tree.
1513
1514 begin
1515 if Debug_Flag_Y then
1516 Debug_Flag_Y := False;
1517 Write_Eol;
1518 Write_Str ("Tree created for Standard (spec) ");
1519 Underline;
1520 Print_Node_Subtree (Standard_Package_Node);
1521 Write_Eol;
1522 end if;
1523
1524 if Debug_Flag_T then
1525 Debug_Flag_T := False;
1526
1527 Write_Eol;
1528 Write_Str ("Tree created for ");
1529 Write_Unit_Name (Unit_Name (Main_Unit));
1530 Underline;
1531 Print_Node_Subtree (Cunit (Main_Unit));
1532 Write_Eol;
1533 end if;
1534
1535 end Tree_Dump;
1536
1537 -----------------
1538 -- Visit_Elist --
1539 -----------------
1540
1541 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1542 M : Elmt_Id;
1543 N : Node_Id;
1544 S : constant Nat := Serial_Number (Int (E));
1545
1546 begin
1547 -- In marking phase, return if already marked, otherwise set next
1548 -- serial number in hash table for later reference.
1549
1550 if Phase = Marking then
1551 if S /= 0 then
1552 return; -- already visited
1553 else
1554 Set_Serial_Number;
1555 end if;
1556
1557 -- In printing phase, if already printed, then return, otherwise we
1558 -- are printing the next item, so increment the serial number.
1559
1560 else
1561 if S < Next_Serial_Number then
1562 return; -- already printed
1563 else
1564 Next_Serial_Number := Next_Serial_Number + 1;
1565 end if;
1566 end if;
1567
1568 -- Now process the list (Print calls have no effect in marking phase)
1569
1570 Print_Str (Prefix_Str);
1571 Print_Elist_Ref (E);
1572 Print_Eol;
1573
1574 if Is_Empty_Elmt_List (E) then
1575 Print_Str (Prefix_Str);
1576 Print_Str ("(Empty element list)");
1577 Print_Eol;
1578 Print_Eol;
1579
1580 else
1581 if Phase = Printing then
1582 M := First_Elmt (E);
1583 while Present (M) loop
1584 N := Node (M);
1585 Print_Str (Prefix_Str);
1586 Print_Str (" ");
1587 Print_Node_Ref (N);
1588 Print_Eol;
1589 Next_Elmt (M);
1590 end loop;
1591
1592 Print_Str (Prefix_Str);
1593 Print_Eol;
1594 end if;
1595
1596 M := First_Elmt (E);
1597 while Present (M) loop
1598 Visit_Node (Node (M), Prefix_Str, ' ');
1599 Next_Elmt (M);
1600 end loop;
1601 end if;
1602 end Visit_Elist;
1603
1604 ----------------
1605 -- Visit_List --
1606 ----------------
1607
1608 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1609 N : Node_Id;
1610 S : constant Nat := Serial_Number (Int (L));
1611
1612 begin
1613 -- In marking phase, return if already marked, otherwise set next
1614 -- serial number in hash table for later reference.
1615
1616 if Phase = Marking then
1617 if S /= 0 then
1618 return;
1619 else
1620 Set_Serial_Number;
1621 end if;
1622
1623 -- In printing phase, if already printed, then return, otherwise we
1624 -- are printing the next item, so increment the serial number.
1625
1626 else
1627 if S < Next_Serial_Number then
1628 return; -- already printed
1629 else
1630 Next_Serial_Number := Next_Serial_Number + 1;
1631 end if;
1632 end if;
1633
1634 -- Now process the list (Print calls have no effect in marking phase)
1635
1636 Print_Str (Prefix_Str);
1637 Print_List_Ref (L);
1638 Print_Eol;
1639
1640 Print_Str (Prefix_Str);
1641 Print_Str ("|Parent = ");
1642 Print_Node_Ref (Parent (L));
1643 Print_Eol;
1644
1645 N := First (L);
1646
1647 if N = Empty then
1648 Print_Str (Prefix_Str);
1649 Print_Str ("(Empty list)");
1650 Print_Eol;
1651 Print_Eol;
1652
1653 else
1654 Print_Str (Prefix_Str);
1655 Print_Char ('|');
1656 Print_Eol;
1657
1658 while Next (N) /= Empty loop
1659 Visit_Node (N, Prefix_Str, '|');
1660 Next (N);
1661 end loop;
1662 end if;
1663
1664 Visit_Node (N, Prefix_Str, ' ');
1665 end Visit_List;
1666
1667 ----------------
1668 -- Visit_Node --
1669 ----------------
1670
1671 procedure Visit_Node
1672 (N : Node_Id;
1673 Prefix_Str : String;
1674 Prefix_Char : Character)
1675 is
1676 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1677 -- Prefix string for printing referenced fields
1678
1679 procedure Visit_Descendent
1680 (D : Union_Id;
1681 No_Indent : Boolean := False);
1682 -- This procedure tests the given value of one of the Fields referenced
1683 -- by the current node to determine whether to visit it recursively.
1684 -- Normally No_Indent is false, which means that the visited node will
1685 -- be indented using New_Prefix. If No_Indent is set to True, then
1686 -- this indentation is skipped, and Prefix_Str is used for the call
1687 -- to print the descendent. No_Indent is effective only if the
1688 -- referenced descendent is a node.
1689
1690 ----------------------
1691 -- Visit_Descendent --
1692 ----------------------
1693
1694 procedure Visit_Descendent
1695 (D : Union_Id;
1696 No_Indent : Boolean := False)
1697 is
1698 begin
1699 -- Case of descendent is a node
1700
1701 if D in Node_Range then
1702
1703 -- Don't bother about Empty or Error descendents
1704
1705 if D <= Union_Id (Empty_Or_Error) then
1706 return;
1707 end if;
1708
1709 declare
1710 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1711
1712 begin
1713 -- Descendents in one of the standardly compiled internal
1714 -- packages are normally ignored, unless the parent is also
1715 -- in such a package (happens when Standard itself is output)
1716 -- or if the -df switch is set which causes all links to be
1717 -- followed, even into package standard.
1718
1719 if Sloc (Nod) <= Standard_Location then
1720 if Sloc (N) > Standard_Location
1721 and then not Debug_Flag_F
1722 then
1723 return;
1724 end if;
1725
1726 -- Don't bother about a descendent in a different unit than
1727 -- the node we came from unless the -df switch is set. Note
1728 -- that we know at this point that Sloc (D) > Standard_Location
1729
1730 -- Note: the tests for No_Location here just make sure that we
1731 -- don't blow up on a node which is missing an Sloc value. This
1732 -- should not normally happen.
1733
1734 else
1735 if (Sloc (N) <= Standard_Location
1736 or else Sloc (N) = No_Location
1737 or else Sloc (Nod) = No_Location
1738 or else not In_Same_Source_Unit (Nod, N))
1739 and then not Debug_Flag_F
1740 then
1741 return;
1742 end if;
1743 end if;
1744
1745 -- Don't bother visiting a source node that has a parent which
1746 -- is not the node we came from. We prefer to trace such nodes
1747 -- from their real parents. This causes the tree to be printed
1748 -- in a more coherent order, e.g. a defining identifier listed
1749 -- next to its corresponding declaration, instead of next to
1750 -- some semantic reference.
1751
1752 -- This test is skipped for nodes in standard packages unless
1753 -- the -dy option is set (which outputs the tree for standard)
1754
1755 -- Also, always follow pointers to Is_Itype entities,
1756 -- since we want to list these when they are first referenced.
1757
1758 if Parent (Nod) /= Empty
1759 and then Comes_From_Source (Nod)
1760 and then Parent (Nod) /= N
1761 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1762 then
1763 return;
1764 end if;
1765
1766 -- If we successfully fall through all the above tests (which
1767 -- execute a return if the node is not to be visited), we can
1768 -- go ahead and visit the node!
1769
1770 if No_Indent then
1771 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1772 else
1773 Visit_Node (Nod, New_Prefix, ' ');
1774 end if;
1775 end;
1776
1777 -- Case of descendent is a list
1778
1779 elsif D in List_Range then
1780
1781 -- Don't bother with a missing list, empty list or error list
1782
1783 if D = Union_Id (No_List)
1784 or else D = Union_Id (Error_List)
1785 or else Is_Empty_List (List_Id (D))
1786 then
1787 return;
1788
1789 -- Otherwise we can visit the list. Note that we don't bother
1790 -- to do the parent test that we did for the node case, because
1791 -- it just does not happen that lists are referenced more than
1792 -- one place in the tree. We aren't counting on this being the
1793 -- case to generate valid output, it is just that we don't need
1794 -- in practice to worry about listing the list at a place that
1795 -- is inconvenient.
1796
1797 else
1798 Visit_List (List_Id (D), New_Prefix);
1799 end if;
1800
1801 -- Case of descendent is an element list
1802
1803 elsif D in Elist_Range then
1804
1805 -- Don't bother with a missing list, or an empty list
1806
1807 if D = Union_Id (No_Elist)
1808 or else Is_Empty_Elmt_List (Elist_Id (D))
1809 then
1810 return;
1811
1812 -- Otherwise, visit the referenced element list
1813
1814 else
1815 Visit_Elist (Elist_Id (D), New_Prefix);
1816 end if;
1817
1818 -- For all other kinds of descendents (strings, names, uints etc),
1819 -- there is nothing to visit (the contents of the field will be
1820 -- printed when we print the containing node, but what concerns
1821 -- us now is looking for descendents in the tree.
1822
1823 else
1824 null;
1825 end if;
1826 end Visit_Descendent;
1827
1828 -- Start of processing for Visit_Node
1829
1830 begin
1831 if N = Empty then
1832 return;
1833 end if;
1834
1835 -- Set fatal error node in case we get a blow up during the trace
1836
1837 Current_Error_Node := N;
1838
1839 New_Prefix (Prefix_Str'Range) := Prefix_Str;
1840 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
1841 New_Prefix (Prefix_Str'Last + 2) := ' ';
1842
1843 -- In the marking phase, all we do is to set the serial number
1844
1845 if Phase = Marking then
1846 if Serial_Number (Int (N)) /= 0 then
1847 return; -- already visited
1848 else
1849 Set_Serial_Number;
1850 end if;
1851
1852 -- In the printing phase, we print the node
1853
1854 else
1855 if Serial_Number (Int (N)) < Next_Serial_Number then
1856
1857 -- Here we have already visited the node, but if it is in
1858 -- a list, we still want to print the reference, so that
1859 -- it is clear that it belongs to the list.
1860
1861 if Is_List_Member (N) then
1862 Print_Str (Prefix_Str);
1863 Print_Node_Ref (N);
1864 Print_Eol;
1865 Print_Str (Prefix_Str);
1866 Print_Char (Prefix_Char);
1867 Print_Str ("(already output)");
1868 Print_Eol;
1869 Print_Str (Prefix_Str);
1870 Print_Char (Prefix_Char);
1871 Print_Eol;
1872 end if;
1873
1874 return;
1875
1876 else
1877 Print_Node (N, Prefix_Str, Prefix_Char);
1878 Print_Str (Prefix_Str);
1879 Print_Char (Prefix_Char);
1880 Print_Eol;
1881 Next_Serial_Number := Next_Serial_Number + 1;
1882 end if;
1883 end if;
1884
1885 -- Visit all descendents of this node
1886
1887 if Nkind (N) not in N_Entity then
1888 Visit_Descendent (Field1 (N));
1889 Visit_Descendent (Field2 (N));
1890 Visit_Descendent (Field3 (N));
1891 Visit_Descendent (Field4 (N));
1892 Visit_Descendent (Field5 (N));
1893
1894 -- Entity case
1895
1896 else
1897 Visit_Descendent (Field1 (N));
1898 Visit_Descendent (Field3 (N));
1899 Visit_Descendent (Field4 (N));
1900 Visit_Descendent (Field5 (N));
1901 Visit_Descendent (Field6 (N));
1902 Visit_Descendent (Field7 (N));
1903 Visit_Descendent (Field8 (N));
1904 Visit_Descendent (Field9 (N));
1905 Visit_Descendent (Field10 (N));
1906 Visit_Descendent (Field11 (N));
1907 Visit_Descendent (Field12 (N));
1908 Visit_Descendent (Field13 (N));
1909 Visit_Descendent (Field14 (N));
1910 Visit_Descendent (Field15 (N));
1911 Visit_Descendent (Field16 (N));
1912 Visit_Descendent (Field17 (N));
1913 Visit_Descendent (Field18 (N));
1914 Visit_Descendent (Field19 (N));
1915 Visit_Descendent (Field20 (N));
1916 Visit_Descendent (Field21 (N));
1917 Visit_Descendent (Field22 (N));
1918 Visit_Descendent (Field23 (N));
1919
1920 -- Now an interesting kludge. Normally parents are always printed
1921 -- since we traverse the tree in a downwards direction. There is
1922 -- however an exception to this rule, which is the case where a
1923 -- parent is constructed by the compiler and is not referenced
1924 -- elsewhere in the tree. The following catches this case
1925
1926 if not Comes_From_Source (N) then
1927 Visit_Descendent (Union_Id (Parent (N)));
1928 end if;
1929
1930 -- You may be wondering why we omitted Field2 above. The answer
1931 -- is that this is the Next_Entity field, and we want to treat
1932 -- it rather specially. Why? Because a Next_Entity link does not
1933 -- correspond to a level deeper in the tree, and we do not want
1934 -- the tree to march off to the right of the page due to bogus
1935 -- indentations coming from this effect.
1936
1937 -- To prevent this, what we do is to control references via
1938 -- Next_Entity only from the first entity on a given scope
1939 -- chain, and we keep them all at the same level. Of course
1940 -- if an entity has already been referenced it is not printed.
1941
1942 if Present (Next_Entity (N))
1943 and then Present (Scope (N))
1944 and then First_Entity (Scope (N)) = N
1945 then
1946 declare
1947 Nod : Node_Id;
1948
1949 begin
1950 Nod := N;
1951 while Present (Nod) loop
1952 Visit_Descendent (Union_Id (Next_Entity (Nod)));
1953 Nod := Next_Entity (Nod);
1954 end loop;
1955 end;
1956 end if;
1957 end if;
1958 end Visit_Node;
1959
1960 end Treepr;
Mirror of the offical gcc git repository hosted at gcc.gnu.org