Daily bump.
[official-gcc.git] / gcc / ada / treepr.adb
blob4de6b8529f1df5b5b91fb4def4d23bafe29f8cd4
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-2013, 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 -- pe --
241 --------
243 procedure pe (E : Elist_Id) is
244 begin
245 Print_Tree_Elist (E);
246 end pe;
248 --------
249 -- pl --
250 --------
252 procedure pl (L : Int) is
253 Lid : Int;
255 begin
256 if L < 0 then
257 Lid := L;
259 -- This is the case where we transform e.g. +36 to -99999936
261 else
262 if L <= 9 then
263 Lid := -(99999990 + L);
264 elsif L <= 99 then
265 Lid := -(99999900 + L);
266 elsif L <= 999 then
267 Lid := -(99999000 + L);
268 elsif L <= 9999 then
269 Lid := -(99990000 + L);
270 elsif L <= 99999 then
271 Lid := -(99900000 + L);
272 elsif L <= 999999 then
273 Lid := -(99000000 + L);
274 elsif L <= 9999999 then
275 Lid := -(90000000 + L);
276 else
277 Lid := -L;
278 end if;
279 end if;
281 -- Now output the list
283 Print_Tree_List (List_Id (Lid));
284 end pl;
286 --------
287 -- pn --
288 --------
290 procedure pn (N : Union_Id) is
291 begin
292 case N is
293 when List_Low_Bound .. List_High_Bound - 1 =>
294 pl (Int (N));
295 when Node_Range =>
296 Print_Tree_Node (Node_Id (N));
297 when Elist_Range =>
298 Print_Tree_Elist (Elist_Id (N));
299 when Elmt_Range =>
300 declare
301 Id : constant Elmt_Id := Elmt_Id (N);
302 begin
303 if No (Id) then
304 Write_Str ("No_Elmt");
305 Write_Eol;
306 else
307 Write_Str ("Elmt_Id --> ");
308 Print_Tree_Node (Node (Id));
309 end if;
310 end;
311 when Names_Range =>
312 Namet.wn (Name_Id (N));
313 when Strings_Range =>
314 Write_String_Table_Entry (String_Id (N));
315 when Uint_Range =>
316 Uintp.pid (From_Union (N));
317 when Ureal_Range =>
318 Urealp.pr (From_Union (N));
319 when others =>
320 Write_Str ("Invalid Union_Id: ");
321 Write_Int (Int (N));
322 Write_Eol;
323 end case;
324 end pn;
326 --------
327 -- pp --
328 --------
330 procedure pp (N : Union_Id) is
331 begin
332 pn (N);
333 end pp;
335 ----------------
336 -- Print_Char --
337 ----------------
339 procedure Print_Char (C : Character) is
340 begin
341 if Phase = Printing then
342 Write_Char (C);
343 end if;
344 end Print_Char;
346 ---------------------
347 -- Print_Elist_Ref --
348 ---------------------
350 procedure Print_Elist_Ref (E : Elist_Id) is
351 begin
352 if Phase /= Printing then
353 return;
354 end if;
356 if E = No_Elist then
357 Write_Str ("<no elist>");
359 elsif Is_Empty_Elmt_List (E) then
360 Write_Str ("Empty elist, (Elist_Id=");
361 Write_Int (Int (E));
362 Write_Char (')');
364 else
365 Write_Str ("(Elist_Id=");
366 Write_Int (Int (E));
367 Write_Char (')');
369 if Printing_Descendants then
370 Write_Str (" #");
371 Write_Int (Serial_Number (Int (E)));
372 end if;
373 end if;
374 end Print_Elist_Ref;
376 -------------------------
377 -- Print_Elist_Subtree --
378 -------------------------
380 procedure Print_Elist_Subtree (E : Elist_Id) is
381 begin
382 Print_Init;
384 Next_Serial_Number := 1;
385 Phase := Marking;
386 Visit_Elist (E, "");
388 Next_Serial_Number := 1;
389 Phase := Printing;
390 Visit_Elist (E, "");
392 Print_Term;
393 end Print_Elist_Subtree;
395 --------------------
396 -- Print_End_Span --
397 --------------------
399 procedure Print_End_Span (N : Node_Id) is
400 Val : constant Uint := End_Span (N);
402 begin
403 UI_Write (Val);
404 Write_Str (" (Uint = ");
405 Write_Int (Int (Field5 (N)));
406 Write_Str (") ");
408 if Val /= No_Uint then
409 Write_Location (End_Location (N));
410 end if;
411 end Print_End_Span;
413 -----------------------
414 -- Print_Entity_Info --
415 -----------------------
417 procedure Print_Entity_Info (Ent : Entity_Id; Prefix : String) is
418 function Field_Present (U : Union_Id) return Boolean;
419 -- Returns False unless the value U represents a missing value
420 -- (Empty, No_Uint, No_Ureal or No_String)
422 function Field_Present (U : Union_Id) return Boolean is
423 begin
424 return
425 U /= Union_Id (Empty) and then
426 U /= To_Union (No_Uint) and then
427 U /= To_Union (No_Ureal) and then
428 U /= Union_Id (No_String);
429 end Field_Present;
431 -- Start of processing for Print_Entity_Info
433 begin
434 Print_Str (Prefix);
435 Print_Str ("Ekind = ");
436 Print_Str_Mixed_Case (Entity_Kind'Image (Ekind (Ent)));
437 Print_Eol;
439 Print_Str (Prefix);
440 Print_Str ("Etype = ");
441 Print_Node_Ref (Etype (Ent));
442 Print_Eol;
444 if Convention (Ent) /= Convention_Ada then
445 Print_Str (Prefix);
446 Print_Str ("Convention = ");
448 -- Print convention name skipping the Convention_ at the start
450 declare
451 S : constant String := Convention_Id'Image (Convention (Ent));
453 begin
454 Print_Str_Mixed_Case (S (12 .. S'Last));
455 Print_Eol;
456 end;
457 end if;
459 if Field_Present (Field6 (Ent)) then
460 Print_Str (Prefix);
461 Write_Field6_Name (Ent);
462 Write_Str (" = ");
463 Print_Field (Field6 (Ent));
464 Print_Eol;
465 end if;
467 if Field_Present (Field7 (Ent)) then
468 Print_Str (Prefix);
469 Write_Field7_Name (Ent);
470 Write_Str (" = ");
471 Print_Field (Field7 (Ent));
472 Print_Eol;
473 end if;
475 if Field_Present (Field8 (Ent)) then
476 Print_Str (Prefix);
477 Write_Field8_Name (Ent);
478 Write_Str (" = ");
479 Print_Field (Field8 (Ent));
480 Print_Eol;
481 end if;
483 if Field_Present (Field9 (Ent)) then
484 Print_Str (Prefix);
485 Write_Field9_Name (Ent);
486 Write_Str (" = ");
487 Print_Field (Field9 (Ent));
488 Print_Eol;
489 end if;
491 if Field_Present (Field10 (Ent)) then
492 Print_Str (Prefix);
493 Write_Field10_Name (Ent);
494 Write_Str (" = ");
495 Print_Field (Field10 (Ent));
496 Print_Eol;
497 end if;
499 if Field_Present (Field11 (Ent)) then
500 Print_Str (Prefix);
501 Write_Field11_Name (Ent);
502 Write_Str (" = ");
503 Print_Field (Field11 (Ent));
504 Print_Eol;
505 end if;
507 if Field_Present (Field12 (Ent)) then
508 Print_Str (Prefix);
509 Write_Field12_Name (Ent);
510 Write_Str (" = ");
511 Print_Field (Field12 (Ent));
512 Print_Eol;
513 end if;
515 if Field_Present (Field13 (Ent)) then
516 Print_Str (Prefix);
517 Write_Field13_Name (Ent);
518 Write_Str (" = ");
519 Print_Field (Field13 (Ent));
520 Print_Eol;
521 end if;
523 if Field_Present (Field14 (Ent)) then
524 Print_Str (Prefix);
525 Write_Field14_Name (Ent);
526 Write_Str (" = ");
527 Print_Field (Field14 (Ent));
528 Print_Eol;
529 end if;
531 if Field_Present (Field15 (Ent)) then
532 Print_Str (Prefix);
533 Write_Field15_Name (Ent);
534 Write_Str (" = ");
535 Print_Field (Field15 (Ent));
536 Print_Eol;
537 end if;
539 if Field_Present (Field16 (Ent)) then
540 Print_Str (Prefix);
541 Write_Field16_Name (Ent);
542 Write_Str (" = ");
543 Print_Field (Field16 (Ent));
544 Print_Eol;
545 end if;
547 if Field_Present (Field17 (Ent)) then
548 Print_Str (Prefix);
549 Write_Field17_Name (Ent);
550 Write_Str (" = ");
551 Print_Field (Field17 (Ent));
552 Print_Eol;
553 end if;
555 if Field_Present (Field18 (Ent)) then
556 Print_Str (Prefix);
557 Write_Field18_Name (Ent);
558 Write_Str (" = ");
559 Print_Field (Field18 (Ent));
560 Print_Eol;
561 end if;
563 if Field_Present (Field19 (Ent)) then
564 Print_Str (Prefix);
565 Write_Field19_Name (Ent);
566 Write_Str (" = ");
567 Print_Field (Field19 (Ent));
568 Print_Eol;
569 end if;
571 if Field_Present (Field20 (Ent)) then
572 Print_Str (Prefix);
573 Write_Field20_Name (Ent);
574 Write_Str (" = ");
575 Print_Field (Field20 (Ent));
576 Print_Eol;
577 end if;
579 if Field_Present (Field21 (Ent)) then
580 Print_Str (Prefix);
581 Write_Field21_Name (Ent);
582 Write_Str (" = ");
583 Print_Field (Field21 (Ent));
584 Print_Eol;
585 end if;
587 if Field_Present (Field22 (Ent)) then
588 Print_Str (Prefix);
589 Write_Field22_Name (Ent);
590 Write_Str (" = ");
592 -- Mechanism case has to be handled specially
594 if Ekind (Ent) = E_Function or else Is_Formal (Ent) then
595 declare
596 M : constant Mechanism_Type := Mechanism (Ent);
598 begin
599 case M is
600 when Default_Mechanism
601 => Write_Str ("Default");
602 when By_Copy
603 => Write_Str ("By_Copy");
604 when By_Reference
605 => Write_Str ("By_Reference");
606 when By_Descriptor
607 => Write_Str ("By_Descriptor");
608 when By_Descriptor_UBS
609 => Write_Str ("By_Descriptor_UBS");
610 when By_Descriptor_UBSB
611 => Write_Str ("By_Descriptor_UBSB");
612 when By_Descriptor_UBA
613 => Write_Str ("By_Descriptor_UBA");
614 when By_Descriptor_S
615 => Write_Str ("By_Descriptor_S");
616 when By_Descriptor_SB
617 => Write_Str ("By_Descriptor_SB");
618 when By_Descriptor_A
619 => Write_Str ("By_Descriptor_A");
620 when By_Descriptor_NCA
621 => Write_Str ("By_Descriptor_NCA");
622 when By_Short_Descriptor
623 => Write_Str ("By_Short_Descriptor");
624 when By_Short_Descriptor_UBS
625 => Write_Str ("By_Short_Descriptor_UBS");
626 when By_Short_Descriptor_UBSB
627 => Write_Str ("By_Short_Descriptor_UBSB");
628 when By_Short_Descriptor_UBA
629 => Write_Str ("By_Short_Descriptor_UBA");
630 when By_Short_Descriptor_S
631 => Write_Str ("By_Short_Descriptor_S");
632 when By_Short_Descriptor_SB
633 => Write_Str ("By_Short_Descriptor_SB");
634 when By_Short_Descriptor_A
635 => Write_Str ("By_Short_Descriptor_A");
636 when By_Short_Descriptor_NCA
637 => Write_Str ("By_Short_Descriptor_NCA");
639 when 1 .. Mechanism_Type'Last =>
640 Write_Str ("By_Copy if size <= ");
641 Write_Int (Int (M));
643 end case;
644 end;
646 -- Normal case (not Mechanism)
648 else
649 Print_Field (Field22 (Ent));
650 end if;
652 Print_Eol;
653 end if;
655 if Field_Present (Field23 (Ent)) then
656 Print_Str (Prefix);
657 Write_Field23_Name (Ent);
658 Write_Str (" = ");
659 Print_Field (Field23 (Ent));
660 Print_Eol;
661 end if;
663 if Field_Present (Field24 (Ent)) then
664 Print_Str (Prefix);
665 Write_Field24_Name (Ent);
666 Write_Str (" = ");
667 Print_Field (Field24 (Ent));
668 Print_Eol;
669 end if;
671 if Field_Present (Field25 (Ent)) then
672 Print_Str (Prefix);
673 Write_Field25_Name (Ent);
674 Write_Str (" = ");
675 Print_Field (Field25 (Ent));
676 Print_Eol;
677 end if;
679 if Field_Present (Field26 (Ent)) then
680 Print_Str (Prefix);
681 Write_Field26_Name (Ent);
682 Write_Str (" = ");
683 Print_Field (Field26 (Ent));
684 Print_Eol;
685 end if;
687 if Field_Present (Field27 (Ent)) then
688 Print_Str (Prefix);
689 Write_Field27_Name (Ent);
690 Write_Str (" = ");
691 Print_Field (Field27 (Ent));
692 Print_Eol;
693 end if;
695 if Field_Present (Field28 (Ent)) then
696 Print_Str (Prefix);
697 Write_Field28_Name (Ent);
698 Write_Str (" = ");
699 Print_Field (Field28 (Ent));
700 Print_Eol;
701 end if;
703 if Field_Present (Field29 (Ent)) then
704 Print_Str (Prefix);
705 Write_Field29_Name (Ent);
706 Write_Str (" = ");
707 Print_Field (Field29 (Ent));
708 Print_Eol;
709 end if;
711 if Field_Present (Field30 (Ent)) then
712 Print_Str (Prefix);
713 Write_Field30_Name (Ent);
714 Write_Str (" = ");
715 Print_Field (Field30 (Ent));
716 Print_Eol;
717 end if;
719 if Field_Present (Field31 (Ent)) then
720 Print_Str (Prefix);
721 Write_Field31_Name (Ent);
722 Write_Str (" = ");
723 Print_Field (Field31 (Ent));
724 Print_Eol;
725 end if;
727 if Field_Present (Field32 (Ent)) then
728 Print_Str (Prefix);
729 Write_Field32_Name (Ent);
730 Write_Str (" = ");
731 Print_Field (Field32 (Ent));
732 Print_Eol;
733 end if;
735 if Field_Present (Field33 (Ent)) then
736 Print_Str (Prefix);
737 Write_Field33_Name (Ent);
738 Write_Str (" = ");
739 Print_Field (Field33 (Ent));
740 Print_Eol;
741 end if;
743 if Field_Present (Field34 (Ent)) then
744 Print_Str (Prefix);
745 Write_Field34_Name (Ent);
746 Write_Str (" = ");
747 Print_Field (Field34 (Ent));
748 Print_Eol;
749 end if;
751 if Field_Present (Field35 (Ent)) then
752 Print_Str (Prefix);
753 Write_Field35_Name (Ent);
754 Write_Str (" = ");
755 Print_Field (Field35 (Ent));
756 Print_Eol;
757 end if;
759 Write_Entity_Flags (Ent, Prefix);
760 end Print_Entity_Info;
762 ---------------
763 -- Print_Eol --
764 ---------------
766 procedure Print_Eol is
767 begin
768 if Phase = Printing then
769 Write_Eol;
770 end if;
771 end Print_Eol;
773 -----------------
774 -- Print_Field --
775 -----------------
777 procedure Print_Field (Val : Union_Id; Format : UI_Format := Auto) is
778 begin
779 if Phase /= Printing then
780 return;
781 end if;
783 if Val in Node_Range then
784 Print_Node_Ref (Node_Id (Val));
786 elsif Val in List_Range then
787 Print_List_Ref (List_Id (Val));
789 elsif Val in Elist_Range then
790 Print_Elist_Ref (Elist_Id (Val));
792 elsif Val in Names_Range then
793 Print_Name (Name_Id (Val));
794 Write_Str (" (Name_Id=");
795 Write_Int (Int (Val));
796 Write_Char (')');
798 elsif Val in Strings_Range then
799 Write_String_Table_Entry (String_Id (Val));
800 Write_Str (" (String_Id=");
801 Write_Int (Int (Val));
802 Write_Char (')');
804 elsif Val in Uint_Range then
805 UI_Write (From_Union (Val), Format);
806 Write_Str (" (Uint = ");
807 Write_Int (Int (Val));
808 Write_Char (')');
810 elsif Val in Ureal_Range then
811 UR_Write (From_Union (Val));
812 Write_Str (" (Ureal = ");
813 Write_Int (Int (Val));
814 Write_Char (')');
816 else
817 Print_Str ("****** Incorrect value = ");
818 Print_Int (Int (Val));
819 end if;
820 end Print_Field;
822 ----------------
823 -- Print_Flag --
824 ----------------
826 procedure Print_Flag (F : Boolean) is
827 begin
828 if F then
829 Print_Str ("True");
830 else
831 Print_Str ("False");
832 end if;
833 end Print_Flag;
835 ----------------
836 -- Print_Init --
837 ----------------
839 procedure Print_Init is
840 begin
841 Printing_Descendants := True;
842 Write_Eol;
844 -- Allocate and clear serial number hash table. The size is 150% of
845 -- the maximum possible number of entries, so that the hash table
846 -- cannot get significantly overloaded.
848 Hash_Table_Len := (150 * (Num_Nodes + Num_Lists + Num_Elists)) / 100;
849 Hash_Table := new Hash_Table_Type (0 .. Hash_Table_Len - 1);
851 for J in Hash_Table'Range loop
852 Hash_Table (J).Serial := 0;
853 end loop;
855 end Print_Init;
857 ---------------
858 -- Print_Int --
859 ---------------
861 procedure Print_Int (I : Int) is
862 begin
863 if Phase = Printing then
864 Write_Int (I);
865 end if;
866 end Print_Int;
868 --------------------
869 -- Print_List_Ref --
870 --------------------
872 procedure Print_List_Ref (L : List_Id) is
873 begin
874 if Phase /= Printing then
875 return;
876 end if;
878 if No (L) then
879 Write_Str ("<no list>");
881 elsif Is_Empty_List (L) then
882 Write_Str ("<empty list> (List_Id=");
883 Write_Int (Int (L));
884 Write_Char (')');
886 else
887 Write_Str ("List");
889 if Printing_Descendants then
890 Write_Str (" #");
891 Write_Int (Serial_Number (Int (L)));
892 end if;
894 Write_Str (" (List_Id=");
895 Write_Int (Int (L));
896 Write_Char (')');
897 end if;
898 end Print_List_Ref;
900 ------------------------
901 -- Print_List_Subtree --
902 ------------------------
904 procedure Print_List_Subtree (L : List_Id) is
905 begin
906 Print_Init;
908 Next_Serial_Number := 1;
909 Phase := Marking;
910 Visit_List (L, "");
912 Next_Serial_Number := 1;
913 Phase := Printing;
914 Visit_List (L, "");
916 Print_Term;
917 end Print_List_Subtree;
919 ----------------
920 -- Print_Name --
921 ----------------
923 procedure Print_Name (N : Name_Id) is
924 begin
925 if Phase = Printing then
926 if N = No_Name then
927 Print_Str ("<No_Name>");
929 elsif N = Error_Name then
930 Print_Str ("<Error_Name>");
932 elsif Is_Valid_Name (N) then
933 Get_Name_String (N);
934 Print_Char ('"');
935 Write_Name (N);
936 Print_Char ('"');
938 else
939 Print_Str ("<invalid name ???>");
940 end if;
941 end if;
942 end Print_Name;
944 ----------------
945 -- Print_Node --
946 ----------------
948 procedure Print_Node
949 (N : Node_Id;
950 Prefix_Str : String;
951 Prefix_Char : Character)
953 F : Fchar;
954 P : Natural := Pchar_Pos (Nkind (N));
956 Field_To_Be_Printed : Boolean;
957 Prefix_Str_Char : String (Prefix_Str'First .. Prefix_Str'Last + 1);
959 Sfile : Source_File_Index;
960 Fmt : UI_Format;
962 begin
963 if Phase /= Printing then
964 return;
965 end if;
967 if Nkind (N) = N_Integer_Literal and then Print_In_Hex (N) then
968 Fmt := Hex;
969 else
970 Fmt := Auto;
971 end if;
973 Prefix_Str_Char (Prefix_Str'Range) := Prefix_Str;
974 Prefix_Str_Char (Prefix_Str'Last + 1) := Prefix_Char;
976 -- Print header line
978 Print_Str (Prefix_Str);
979 Print_Node_Header (N);
981 if Is_Rewrite_Substitution (N) then
982 Print_Str (Prefix_Str);
983 Print_Str (" Rewritten: original node = ");
984 Print_Node_Ref (Original_Node (N));
985 Print_Eol;
986 end if;
988 if N = Empty then
989 return;
990 end if;
992 if not Is_List_Member (N) then
993 Print_Str (Prefix_Str);
994 Print_Str (" Parent = ");
995 Print_Node_Ref (Parent (N));
996 Print_Eol;
997 end if;
999 -- Print Sloc field if it is set
1001 if Sloc (N) /= No_Location then
1002 Print_Str (Prefix_Str_Char);
1003 Print_Str ("Sloc = ");
1005 if Sloc (N) = Standard_Location then
1006 Print_Str ("Standard_Location");
1008 elsif Sloc (N) = Standard_ASCII_Location then
1009 Print_Str ("Standard_ASCII_Location");
1011 else
1012 Sfile := Get_Source_File_Index (Sloc (N));
1013 Print_Int (Int (Sloc (N)) - Int (Source_Text (Sfile)'First));
1014 Write_Str (" ");
1015 Write_Location (Sloc (N));
1016 end if;
1018 Print_Eol;
1019 end if;
1021 -- Print Chars field if present
1023 if Nkind (N) in N_Has_Chars and then Chars (N) /= No_Name then
1024 Print_Str (Prefix_Str_Char);
1025 Print_Str ("Chars = ");
1026 Print_Name (Chars (N));
1027 Write_Str (" (Name_Id=");
1028 Write_Int (Int (Chars (N)));
1029 Write_Char (')');
1030 Print_Eol;
1031 end if;
1033 -- Special field print operations for non-entity nodes
1035 if Nkind (N) not in N_Entity then
1037 -- Deal with Left_Opnd and Right_Opnd fields
1039 if Nkind (N) in N_Op
1040 or else Nkind (N) in N_Short_Circuit
1041 or else Nkind (N) in N_Membership_Test
1042 then
1043 -- Print Left_Opnd if present
1045 if Nkind (N) not in N_Unary_Op then
1046 Print_Str (Prefix_Str_Char);
1047 Print_Str ("Left_Opnd = ");
1048 Print_Node_Ref (Left_Opnd (N));
1049 Print_Eol;
1050 end if;
1052 -- Print Right_Opnd
1054 Print_Str (Prefix_Str_Char);
1055 Print_Str ("Right_Opnd = ");
1056 Print_Node_Ref (Right_Opnd (N));
1057 Print_Eol;
1058 end if;
1060 -- Print Entity field if operator (other cases of Entity
1061 -- are in the table, so are handled in the normal circuit)
1063 if Nkind (N) in N_Op and then Present (Entity (N)) then
1064 Print_Str (Prefix_Str_Char);
1065 Print_Str ("Entity = ");
1066 Print_Node_Ref (Entity (N));
1067 Print_Eol;
1068 end if;
1070 -- Print special fields if we have a subexpression
1072 if Nkind (N) in N_Subexpr then
1074 if Assignment_OK (N) then
1075 Print_Str (Prefix_Str_Char);
1076 Print_Str ("Assignment_OK = True");
1077 Print_Eol;
1078 end if;
1080 if Do_Range_Check (N) then
1081 Print_Str (Prefix_Str_Char);
1082 Print_Str ("Do_Range_Check = True");
1083 Print_Eol;
1084 end if;
1086 if Has_Dynamic_Length_Check (N) then
1087 Print_Str (Prefix_Str_Char);
1088 Print_Str ("Has_Dynamic_Length_Check = True");
1089 Print_Eol;
1090 end if;
1092 if Has_Aspects (N) then
1093 Print_Str (Prefix_Str_Char);
1094 Print_Str ("Has_Aspects = True");
1095 Print_Eol;
1096 end if;
1098 if Has_Dynamic_Range_Check (N) then
1099 Print_Str (Prefix_Str_Char);
1100 Print_Str ("Has_Dynamic_Range_Check = True");
1101 Print_Eol;
1102 end if;
1104 if Is_Controlling_Actual (N) then
1105 Print_Str (Prefix_Str_Char);
1106 Print_Str ("Is_Controlling_Actual = True");
1107 Print_Eol;
1108 end if;
1110 if Is_Overloaded (N) then
1111 Print_Str (Prefix_Str_Char);
1112 Print_Str ("Is_Overloaded = True");
1113 Print_Eol;
1114 end if;
1116 if Is_Static_Expression (N) then
1117 Print_Str (Prefix_Str_Char);
1118 Print_Str ("Is_Static_Expression = True");
1119 Print_Eol;
1120 end if;
1122 if Must_Not_Freeze (N) then
1123 Print_Str (Prefix_Str_Char);
1124 Print_Str ("Must_Not_Freeze = True");
1125 Print_Eol;
1126 end if;
1128 if Paren_Count (N) /= 0 then
1129 Print_Str (Prefix_Str_Char);
1130 Print_Str ("Paren_Count = ");
1131 Print_Int (Int (Paren_Count (N)));
1132 Print_Eol;
1133 end if;
1135 if Raises_Constraint_Error (N) then
1136 Print_Str (Prefix_Str_Char);
1137 Print_Str ("Raise_Constraint_Error = True");
1138 Print_Eol;
1139 end if;
1141 end if;
1143 -- Print Do_Overflow_Check field if present
1145 if Nkind (N) in N_Op and then Do_Overflow_Check (N) then
1146 Print_Str (Prefix_Str_Char);
1147 Print_Str ("Do_Overflow_Check = True");
1148 Print_Eol;
1149 end if;
1151 -- Print Etype field if present (printing of this field for entities
1152 -- is handled by the Print_Entity_Info procedure).
1154 if Nkind (N) in N_Has_Etype and then Present (Etype (N)) then
1155 Print_Str (Prefix_Str_Char);
1156 Print_Str ("Etype = ");
1157 Print_Node_Ref (Etype (N));
1158 Print_Eol;
1159 end if;
1160 end if;
1162 -- Loop to print fields included in Pchars array
1164 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N))) loop
1165 F := Pchars (P);
1166 P := P + 1;
1168 -- Check for case of False flag, which we never print, or
1169 -- an Empty field, which is also never printed
1171 case F is
1172 when F_Field1 =>
1173 Field_To_Be_Printed := Field1 (N) /= Union_Id (Empty);
1175 when F_Field2 =>
1176 Field_To_Be_Printed := Field2 (N) /= Union_Id (Empty);
1178 when F_Field3 =>
1179 Field_To_Be_Printed := Field3 (N) /= Union_Id (Empty);
1181 when F_Field4 =>
1182 Field_To_Be_Printed := Field4 (N) /= Union_Id (Empty);
1184 when F_Field5 =>
1185 Field_To_Be_Printed := Field5 (N) /= Union_Id (Empty);
1187 -- Flag3 is obsolete, so this probably gets removed ???
1189 when F_Flag3 => Field_To_Be_Printed := Has_Aspects (N);
1191 when F_Flag4 => Field_To_Be_Printed := Flag4 (N);
1192 when F_Flag5 => Field_To_Be_Printed := Flag5 (N);
1193 when F_Flag6 => Field_To_Be_Printed := Flag6 (N);
1194 when F_Flag7 => Field_To_Be_Printed := Flag7 (N);
1195 when F_Flag8 => Field_To_Be_Printed := Flag8 (N);
1196 when F_Flag9 => Field_To_Be_Printed := Flag9 (N);
1197 when F_Flag10 => Field_To_Be_Printed := Flag10 (N);
1198 when F_Flag11 => Field_To_Be_Printed := Flag11 (N);
1199 when F_Flag12 => Field_To_Be_Printed := Flag12 (N);
1200 when F_Flag13 => Field_To_Be_Printed := Flag13 (N);
1201 when F_Flag14 => Field_To_Be_Printed := Flag14 (N);
1202 when F_Flag15 => Field_To_Be_Printed := Flag15 (N);
1203 when F_Flag16 => Field_To_Be_Printed := Flag16 (N);
1204 when F_Flag17 => Field_To_Be_Printed := Flag17 (N);
1205 when F_Flag18 => Field_To_Be_Printed := Flag18 (N);
1207 -- Flag1,2 are no longer used
1209 when F_Flag1 => raise Program_Error;
1210 when F_Flag2 => raise Program_Error;
1211 end case;
1213 -- Print field if it is to be printed
1215 if Field_To_Be_Printed then
1216 Print_Str (Prefix_Str_Char);
1218 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1219 and then Pchars (P) not in Fchar
1220 loop
1221 Print_Char (Pchars (P));
1222 P := P + 1;
1223 end loop;
1225 Print_Str (" = ");
1227 case F is
1228 when F_Field1 => Print_Field (Field1 (N), Fmt);
1229 when F_Field2 => Print_Field (Field2 (N), Fmt);
1230 when F_Field3 => Print_Field (Field3 (N), Fmt);
1231 when F_Field4 => Print_Field (Field4 (N), Fmt);
1233 -- Special case End_Span = Uint5
1235 when F_Field5 =>
1236 if Nkind (N) = N_Case_Statement
1237 or else Nkind (N) = N_If_Statement
1238 then
1239 Print_End_Span (N);
1240 else
1241 Print_Field (Field5 (N), Fmt);
1242 end if;
1244 when F_Flag4 => Print_Flag (Flag4 (N));
1245 when F_Flag5 => Print_Flag (Flag5 (N));
1246 when F_Flag6 => Print_Flag (Flag6 (N));
1247 when F_Flag7 => Print_Flag (Flag7 (N));
1248 when F_Flag8 => Print_Flag (Flag8 (N));
1249 when F_Flag9 => Print_Flag (Flag9 (N));
1250 when F_Flag10 => Print_Flag (Flag10 (N));
1251 when F_Flag11 => Print_Flag (Flag11 (N));
1252 when F_Flag12 => Print_Flag (Flag12 (N));
1253 when F_Flag13 => Print_Flag (Flag13 (N));
1254 when F_Flag14 => Print_Flag (Flag14 (N));
1255 when F_Flag15 => Print_Flag (Flag15 (N));
1256 when F_Flag16 => Print_Flag (Flag16 (N));
1257 when F_Flag17 => Print_Flag (Flag17 (N));
1258 when F_Flag18 => Print_Flag (Flag18 (N));
1260 -- Flag1,2 are no longer used
1262 when F_Flag1 => raise Program_Error;
1263 when F_Flag2 => raise Program_Error;
1265 -- Not clear why we need the following ???
1267 when F_Flag3 => Print_Flag (Has_Aspects (N));
1268 end case;
1270 Print_Eol;
1272 -- Field is not to be printed (False flag field)
1274 else
1275 while P < Pchar_Pos (Node_Kind'Succ (Nkind (N)))
1276 and then Pchars (P) not in Fchar
1277 loop
1278 P := P + 1;
1279 end loop;
1280 end if;
1281 end loop;
1283 -- Print aspects if present
1285 if Has_Aspects (N) then
1286 Print_Str (Prefix_Str_Char);
1287 Print_Str ("Aspect_Specifications = ");
1288 Print_Field (Union_Id (Aspect_Specifications (N)));
1289 Print_Eol;
1290 end if;
1292 -- Print entity information for entities
1294 if Nkind (N) in N_Entity then
1295 Print_Entity_Info (N, Prefix_Str_Char);
1296 end if;
1298 -- Print the SCIL node (if available)
1300 if Present (Get_SCIL_Node (N)) then
1301 Print_Str (Prefix_Str_Char);
1302 Print_Str ("SCIL_Node = ");
1303 Print_Node_Ref (Get_SCIL_Node (N));
1304 Print_Eol;
1305 end if;
1306 end Print_Node;
1308 ------------------------
1309 -- Print_Node_Briefly --
1310 ------------------------
1312 procedure Print_Node_Briefly (N : Node_Id) is
1313 begin
1314 Printing_Descendants := False;
1315 Phase := Printing;
1316 Print_Node_Header (N);
1317 end Print_Node_Briefly;
1319 -----------------------
1320 -- Print_Node_Header --
1321 -----------------------
1323 procedure Print_Node_Header (N : Node_Id) is
1324 Notes : Boolean := False;
1326 begin
1327 Print_Node_Ref (N);
1329 if N > Atree_Private_Part.Nodes.Last then
1330 Print_Str (" (no such node)");
1331 Print_Eol;
1332 return;
1333 end if;
1335 if Comes_From_Source (N) then
1336 Notes := True;
1337 Print_Str (" (source");
1338 end if;
1340 if Analyzed (N) then
1341 if not Notes then
1342 Notes := True;
1343 Print_Str (" (");
1344 else
1345 Print_Str (",");
1346 end if;
1348 Print_Str ("analyzed");
1349 end if;
1351 if Error_Posted (N) then
1352 if not Notes then
1353 Notes := True;
1354 Print_Str (" (");
1355 else
1356 Print_Str (",");
1357 end if;
1359 Print_Str ("posted");
1360 end if;
1362 if Notes then
1363 Print_Char (')');
1364 end if;
1366 Print_Eol;
1367 end Print_Node_Header;
1369 ---------------------
1370 -- Print_Node_Kind --
1371 ---------------------
1373 procedure Print_Node_Kind (N : Node_Id) is
1374 Ucase : Boolean;
1375 S : constant String := Node_Kind'Image (Nkind (N));
1377 begin
1378 if Phase = Printing then
1379 Ucase := True;
1381 -- Note: the call to Fold_Upper in this loop is to get past the GNAT
1382 -- bug of 'Image returning lower case instead of upper case.
1384 for J in S'Range loop
1385 if Ucase then
1386 Write_Char (Fold_Upper (S (J)));
1387 else
1388 Write_Char (Fold_Lower (S (J)));
1389 end if;
1391 Ucase := (S (J) = '_');
1392 end loop;
1393 end if;
1394 end Print_Node_Kind;
1396 --------------------
1397 -- Print_Node_Ref --
1398 --------------------
1400 procedure Print_Node_Ref (N : Node_Id) is
1401 S : Nat;
1403 begin
1404 if Phase /= Printing then
1405 return;
1406 end if;
1408 if N = Empty then
1409 Write_Str ("<empty>");
1411 elsif N = Error then
1412 Write_Str ("<error>");
1414 else
1415 if Printing_Descendants then
1416 S := Serial_Number (Int (N));
1418 if S /= 0 then
1419 Write_Str ("Node");
1420 Write_Str (" #");
1421 Write_Int (S);
1422 Write_Char (' ');
1423 end if;
1424 end if;
1426 Print_Node_Kind (N);
1428 if Nkind (N) in N_Has_Chars then
1429 Write_Char (' ');
1430 Print_Name (Chars (N));
1431 end if;
1433 if Nkind (N) in N_Entity then
1434 Write_Str (" (Entity_Id=");
1435 else
1436 Write_Str (" (Node_Id=");
1437 end if;
1439 Write_Int (Int (N));
1441 if Sloc (N) <= Standard_Location then
1442 Write_Char ('s');
1443 end if;
1445 Write_Char (')');
1447 end if;
1448 end Print_Node_Ref;
1450 ------------------------
1451 -- Print_Node_Subtree --
1452 ------------------------
1454 procedure Print_Node_Subtree (N : Node_Id) is
1455 begin
1456 Print_Init;
1458 Next_Serial_Number := 1;
1459 Phase := Marking;
1460 Visit_Node (N, "", ' ');
1462 Next_Serial_Number := 1;
1463 Phase := Printing;
1464 Visit_Node (N, "", ' ');
1466 Print_Term;
1467 end Print_Node_Subtree;
1469 ---------------
1470 -- Print_Str --
1471 ---------------
1473 procedure Print_Str (S : String) is
1474 begin
1475 if Phase = Printing then
1476 Write_Str (S);
1477 end if;
1478 end Print_Str;
1480 --------------------------
1481 -- Print_Str_Mixed_Case --
1482 --------------------------
1484 procedure Print_Str_Mixed_Case (S : String) is
1485 Ucase : Boolean;
1487 begin
1488 if Phase = Printing then
1489 Ucase := True;
1491 for J in S'Range loop
1492 if Ucase then
1493 Write_Char (S (J));
1494 else
1495 Write_Char (Fold_Lower (S (J)));
1496 end if;
1498 Ucase := (S (J) = '_');
1499 end loop;
1500 end if;
1501 end Print_Str_Mixed_Case;
1503 ----------------
1504 -- Print_Term --
1505 ----------------
1507 procedure Print_Term is
1508 procedure Free is new Unchecked_Deallocation
1509 (Hash_Table_Type, Access_Hash_Table_Type);
1511 begin
1512 Free (Hash_Table);
1513 end Print_Term;
1515 ---------------------
1516 -- Print_Tree_Elist --
1517 ---------------------
1519 procedure Print_Tree_Elist (E : Elist_Id) is
1520 M : Elmt_Id;
1522 begin
1523 Printing_Descendants := False;
1524 Phase := Printing;
1526 Print_Elist_Ref (E);
1527 Print_Eol;
1529 M := First_Elmt (E);
1531 if No (M) then
1532 Print_Str ("<empty element list>");
1533 Print_Eol;
1535 else
1536 loop
1537 Print_Char ('|');
1538 Print_Eol;
1539 exit when No (Next_Elmt (M));
1540 Print_Node (Node (M), "", '|');
1541 Next_Elmt (M);
1542 end loop;
1544 Print_Node (Node (M), "", ' ');
1545 Print_Eol;
1546 end if;
1547 end Print_Tree_Elist;
1549 ---------------------
1550 -- Print_Tree_List --
1551 ---------------------
1553 procedure Print_Tree_List (L : List_Id) is
1554 N : Node_Id;
1556 begin
1557 Printing_Descendants := False;
1558 Phase := Printing;
1560 Print_List_Ref (L);
1561 Print_Str (" List_Id=");
1562 Print_Int (Int (L));
1563 Print_Eol;
1565 N := First (L);
1567 if N = Empty then
1568 Print_Str ("<empty node list>");
1569 Print_Eol;
1571 else
1572 loop
1573 Print_Char ('|');
1574 Print_Eol;
1575 exit when Next (N) = Empty;
1576 Print_Node (N, "", '|');
1577 Next (N);
1578 end loop;
1580 Print_Node (N, "", ' ');
1581 Print_Eol;
1582 end if;
1583 end Print_Tree_List;
1585 ---------------------
1586 -- Print_Tree_Node --
1587 ---------------------
1589 procedure Print_Tree_Node (N : Node_Id; Label : String := "") is
1590 begin
1591 Printing_Descendants := False;
1592 Phase := Printing;
1593 Print_Node (N, Label, ' ');
1594 end Print_Tree_Node;
1596 --------
1597 -- pt --
1598 --------
1600 procedure pt (N : Node_Id) is
1601 begin
1602 Print_Node_Subtree (N);
1603 end pt;
1605 ---------
1606 -- ppp --
1607 ---------
1609 procedure ppp (N : Node_Id) is
1610 begin
1611 pt (N);
1612 end ppp;
1614 -------------------
1615 -- Serial_Number --
1616 -------------------
1618 -- The hashing algorithm is to use the remainder of the ID value divided
1619 -- by the hash table length as the starting point in the table, and then
1620 -- handle collisions by serial searching wrapping at the end of the table.
1622 Hash_Slot : Nat;
1623 -- Set by an unsuccessful call to Serial_Number (one which returns zero)
1624 -- to save the slot that should be used if Set_Serial_Number is called.
1626 function Serial_Number (Id : Int) return Nat is
1627 H : Int := Id mod Hash_Table_Len;
1629 begin
1630 while Hash_Table (H).Serial /= 0 loop
1632 if Id = Hash_Table (H).Id then
1633 return Hash_Table (H).Serial;
1634 end if;
1636 H := H + 1;
1638 if H > Hash_Table'Last then
1639 H := 0;
1640 end if;
1641 end loop;
1643 -- Entry was not found, save slot number for possible subsequent call
1644 -- to Set_Serial_Number, and unconditionally save the Id in this slot
1645 -- in case of such a call (the Id field is never read if the serial
1646 -- number of the slot is zero, so this is harmless in the case where
1647 -- Set_Serial_Number is not subsequently called).
1649 Hash_Slot := H;
1650 Hash_Table (H).Id := Id;
1651 return 0;
1653 end Serial_Number;
1655 -----------------------
1656 -- Set_Serial_Number --
1657 -----------------------
1659 procedure Set_Serial_Number is
1660 begin
1661 Hash_Table (Hash_Slot).Serial := Next_Serial_Number;
1662 Next_Serial_Number := Next_Serial_Number + 1;
1663 end Set_Serial_Number;
1665 ---------------
1666 -- Tree_Dump --
1667 ---------------
1669 procedure Tree_Dump is
1670 procedure Underline;
1671 -- Put underline under string we just printed
1673 procedure Underline is
1674 Col : constant Int := Column;
1676 begin
1677 Write_Eol;
1679 while Col > Column loop
1680 Write_Char ('-');
1681 end loop;
1683 Write_Eol;
1684 end Underline;
1686 -- Start of processing for Tree_Dump. Note that we turn off the tree dump
1687 -- flags immediately, before starting the dump. This avoids generating two
1688 -- copies of the dump if an abort occurs after printing the dump, and more
1689 -- importantly, avoids an infinite loop if an abort occurs during the dump.
1691 -- Note: unlike in the source print case (in Sprint), we do not output
1692 -- separate trees for each unit. Instead the -df debug switch causes the
1693 -- tree that is output from the main unit to trace references into other
1694 -- units (normally such references are not traced). Since all other units
1695 -- are linked to the main unit by at least one reference, this causes all
1696 -- tree nodes to be included in the output tree.
1698 begin
1699 if Debug_Flag_Y then
1700 Debug_Flag_Y := False;
1701 Write_Eol;
1702 Write_Str ("Tree created for Standard (spec) ");
1703 Underline;
1704 Print_Node_Subtree (Standard_Package_Node);
1705 Write_Eol;
1706 end if;
1708 if Debug_Flag_T then
1709 Debug_Flag_T := False;
1711 Write_Eol;
1712 Write_Str ("Tree created for ");
1713 Write_Unit_Name (Unit_Name (Main_Unit));
1714 Underline;
1715 Print_Node_Subtree (Cunit (Main_Unit));
1716 Write_Eol;
1717 end if;
1719 end Tree_Dump;
1721 -----------------
1722 -- Visit_Elist --
1723 -----------------
1725 procedure Visit_Elist (E : Elist_Id; Prefix_Str : String) is
1726 M : Elmt_Id;
1727 N : Node_Id;
1728 S : constant Nat := Serial_Number (Int (E));
1730 begin
1731 -- In marking phase, return if already marked, otherwise set next
1732 -- serial number in hash table for later reference.
1734 if Phase = Marking then
1735 if S /= 0 then
1736 return; -- already visited
1737 else
1738 Set_Serial_Number;
1739 end if;
1741 -- In printing phase, if already printed, then return, otherwise we
1742 -- are printing the next item, so increment the serial number.
1744 else
1745 if S < Next_Serial_Number then
1746 return; -- already printed
1747 else
1748 Next_Serial_Number := Next_Serial_Number + 1;
1749 end if;
1750 end if;
1752 -- Now process the list (Print calls have no effect in marking phase)
1754 Print_Str (Prefix_Str);
1755 Print_Elist_Ref (E);
1756 Print_Eol;
1758 if Is_Empty_Elmt_List (E) then
1759 Print_Str (Prefix_Str);
1760 Print_Str ("(Empty element list)");
1761 Print_Eol;
1762 Print_Eol;
1764 else
1765 if Phase = Printing then
1766 M := First_Elmt (E);
1767 while Present (M) loop
1768 N := Node (M);
1769 Print_Str (Prefix_Str);
1770 Print_Str (" ");
1771 Print_Node_Ref (N);
1772 Print_Eol;
1773 Next_Elmt (M);
1774 end loop;
1776 Print_Str (Prefix_Str);
1777 Print_Eol;
1778 end if;
1780 M := First_Elmt (E);
1781 while Present (M) loop
1782 Visit_Node (Node (M), Prefix_Str, ' ');
1783 Next_Elmt (M);
1784 end loop;
1785 end if;
1786 end Visit_Elist;
1788 ----------------
1789 -- Visit_List --
1790 ----------------
1792 procedure Visit_List (L : List_Id; Prefix_Str : String) is
1793 N : Node_Id;
1794 S : constant Nat := Serial_Number (Int (L));
1796 begin
1797 -- In marking phase, return if already marked, otherwise set next
1798 -- serial number in hash table for later reference.
1800 if Phase = Marking then
1801 if S /= 0 then
1802 return;
1803 else
1804 Set_Serial_Number;
1805 end if;
1807 -- In printing phase, if already printed, then return, otherwise we
1808 -- are printing the next item, so increment the serial number.
1810 else
1811 if S < Next_Serial_Number then
1812 return; -- already printed
1813 else
1814 Next_Serial_Number := Next_Serial_Number + 1;
1815 end if;
1816 end if;
1818 -- Now process the list (Print calls have no effect in marking phase)
1820 Print_Str (Prefix_Str);
1821 Print_List_Ref (L);
1822 Print_Eol;
1824 Print_Str (Prefix_Str);
1825 Print_Str ("|Parent = ");
1826 Print_Node_Ref (Parent (L));
1827 Print_Eol;
1829 N := First (L);
1831 if N = Empty then
1832 Print_Str (Prefix_Str);
1833 Print_Str ("(Empty list)");
1834 Print_Eol;
1835 Print_Eol;
1837 else
1838 Print_Str (Prefix_Str);
1839 Print_Char ('|');
1840 Print_Eol;
1842 while Next (N) /= Empty loop
1843 Visit_Node (N, Prefix_Str, '|');
1844 Next (N);
1845 end loop;
1846 end if;
1848 Visit_Node (N, Prefix_Str, ' ');
1849 end Visit_List;
1851 ----------------
1852 -- Visit_Node --
1853 ----------------
1855 procedure Visit_Node
1856 (N : Node_Id;
1857 Prefix_Str : String;
1858 Prefix_Char : Character)
1860 New_Prefix : String (Prefix_Str'First .. Prefix_Str'Last + 2);
1861 -- Prefix string for printing referenced fields
1863 procedure Visit_Descendent
1864 (D : Union_Id;
1865 No_Indent : Boolean := False);
1866 -- This procedure tests the given value of one of the Fields referenced
1867 -- by the current node to determine whether to visit it recursively.
1868 -- Normally No_Indent is false, which means that the visited node will
1869 -- be indented using New_Prefix. If No_Indent is set to True, then
1870 -- this indentation is skipped, and Prefix_Str is used for the call
1871 -- to print the descendent. No_Indent is effective only if the
1872 -- referenced descendent is a node.
1874 ----------------------
1875 -- Visit_Descendent --
1876 ----------------------
1878 procedure Visit_Descendent
1879 (D : Union_Id;
1880 No_Indent : Boolean := False)
1882 begin
1883 -- Case of descendent is a node
1885 if D in Node_Range then
1887 -- Don't bother about Empty or Error descendents
1889 if D <= Union_Id (Empty_Or_Error) then
1890 return;
1891 end if;
1893 declare
1894 Nod : constant Node_Or_Entity_Id := Node_Or_Entity_Id (D);
1896 begin
1897 -- Descendents in one of the standardly compiled internal
1898 -- packages are normally ignored, unless the parent is also
1899 -- in such a package (happens when Standard itself is output)
1900 -- or if the -df switch is set which causes all links to be
1901 -- followed, even into package standard.
1903 if Sloc (Nod) <= Standard_Location then
1904 if Sloc (N) > Standard_Location
1905 and then not Debug_Flag_F
1906 then
1907 return;
1908 end if;
1910 -- Don't bother about a descendent in a different unit than
1911 -- the node we came from unless the -df switch is set. Note
1912 -- that we know at this point that Sloc (D) > Standard_Location
1914 -- Note: the tests for No_Location here just make sure that we
1915 -- don't blow up on a node which is missing an Sloc value. This
1916 -- should not normally happen.
1918 else
1919 if (Sloc (N) <= Standard_Location
1920 or else Sloc (N) = No_Location
1921 or else Sloc (Nod) = No_Location
1922 or else not In_Same_Source_Unit (Nod, N))
1923 and then not Debug_Flag_F
1924 then
1925 return;
1926 end if;
1927 end if;
1929 -- Don't bother visiting a source node that has a parent which
1930 -- is not the node we came from. We prefer to trace such nodes
1931 -- from their real parents. This causes the tree to be printed
1932 -- in a more coherent order, e.g. a defining identifier listed
1933 -- next to its corresponding declaration, instead of next to
1934 -- some semantic reference.
1936 -- This test is skipped for nodes in standard packages unless
1937 -- the -dy option is set (which outputs the tree for standard)
1939 -- Also, always follow pointers to Is_Itype entities,
1940 -- since we want to list these when they are first referenced.
1942 if Parent (Nod) /= Empty
1943 and then Comes_From_Source (Nod)
1944 and then Parent (Nod) /= N
1945 and then (Sloc (N) > Standard_Location or else Debug_Flag_Y)
1946 then
1947 return;
1948 end if;
1950 -- If we successfully fall through all the above tests (which
1951 -- execute a return if the node is not to be visited), we can
1952 -- go ahead and visit the node!
1954 if No_Indent then
1955 Visit_Node (Nod, Prefix_Str, Prefix_Char);
1956 else
1957 Visit_Node (Nod, New_Prefix, ' ');
1958 end if;
1959 end;
1961 -- Case of descendent is a list
1963 elsif D in List_Range then
1965 -- Don't bother with a missing list, empty list or error list
1967 if D = Union_Id (No_List)
1968 or else D = Union_Id (Error_List)
1969 or else Is_Empty_List (List_Id (D))
1970 then
1971 return;
1973 -- Otherwise we can visit the list. Note that we don't bother
1974 -- to do the parent test that we did for the node case, because
1975 -- it just does not happen that lists are referenced more than
1976 -- one place in the tree. We aren't counting on this being the
1977 -- case to generate valid output, it is just that we don't need
1978 -- in practice to worry about listing the list at a place that
1979 -- is inconvenient.
1981 else
1982 Visit_List (List_Id (D), New_Prefix);
1983 end if;
1985 -- Case of descendent is an element list
1987 elsif D in Elist_Range then
1989 -- Don't bother with a missing list, or an empty list
1991 if D = Union_Id (No_Elist)
1992 or else Is_Empty_Elmt_List (Elist_Id (D))
1993 then
1994 return;
1996 -- Otherwise, visit the referenced element list
1998 else
1999 Visit_Elist (Elist_Id (D), New_Prefix);
2000 end if;
2002 -- For all other kinds of descendents (strings, names, uints etc),
2003 -- there is nothing to visit (the contents of the field will be
2004 -- printed when we print the containing node, but what concerns
2005 -- us now is looking for descendents in the tree.
2007 else
2008 null;
2009 end if;
2010 end Visit_Descendent;
2012 -- Start of processing for Visit_Node
2014 begin
2015 if N = Empty then
2016 return;
2017 end if;
2019 -- Set fatal error node in case we get a blow up during the trace
2021 Current_Error_Node := N;
2023 New_Prefix (Prefix_Str'Range) := Prefix_Str;
2024 New_Prefix (Prefix_Str'Last + 1) := Prefix_Char;
2025 New_Prefix (Prefix_Str'Last + 2) := ' ';
2027 -- In the marking phase, all we do is to set the serial number
2029 if Phase = Marking then
2030 if Serial_Number (Int (N)) /= 0 then
2031 return; -- already visited
2032 else
2033 Set_Serial_Number;
2034 end if;
2036 -- In the printing phase, we print the node
2038 else
2039 if Serial_Number (Int (N)) < Next_Serial_Number then
2041 -- Here we have already visited the node, but if it is in
2042 -- a list, we still want to print the reference, so that
2043 -- it is clear that it belongs to the list.
2045 if Is_List_Member (N) then
2046 Print_Str (Prefix_Str);
2047 Print_Node_Ref (N);
2048 Print_Eol;
2049 Print_Str (Prefix_Str);
2050 Print_Char (Prefix_Char);
2051 Print_Str ("(already output)");
2052 Print_Eol;
2053 Print_Str (Prefix_Str);
2054 Print_Char (Prefix_Char);
2055 Print_Eol;
2056 end if;
2058 return;
2060 else
2061 Print_Node (N, Prefix_Str, Prefix_Char);
2062 Print_Str (Prefix_Str);
2063 Print_Char (Prefix_Char);
2064 Print_Eol;
2065 Next_Serial_Number := Next_Serial_Number + 1;
2066 end if;
2067 end if;
2069 -- Visit all descendents of this node
2071 if Nkind (N) not in N_Entity then
2072 Visit_Descendent (Field1 (N));
2073 Visit_Descendent (Field2 (N));
2074 Visit_Descendent (Field3 (N));
2075 Visit_Descendent (Field4 (N));
2076 Visit_Descendent (Field5 (N));
2078 if Has_Aspects (N) then
2079 Visit_Descendent (Union_Id (Aspect_Specifications (N)));
2080 end if;
2082 -- Entity case
2084 else
2085 Visit_Descendent (Field1 (N));
2086 Visit_Descendent (Field3 (N));
2087 Visit_Descendent (Field4 (N));
2088 Visit_Descendent (Field5 (N));
2089 Visit_Descendent (Field6 (N));
2090 Visit_Descendent (Field7 (N));
2091 Visit_Descendent (Field8 (N));
2092 Visit_Descendent (Field9 (N));
2093 Visit_Descendent (Field10 (N));
2094 Visit_Descendent (Field11 (N));
2095 Visit_Descendent (Field12 (N));
2096 Visit_Descendent (Field13 (N));
2097 Visit_Descendent (Field14 (N));
2098 Visit_Descendent (Field15 (N));
2099 Visit_Descendent (Field16 (N));
2100 Visit_Descendent (Field17 (N));
2101 Visit_Descendent (Field18 (N));
2102 Visit_Descendent (Field19 (N));
2103 Visit_Descendent (Field20 (N));
2104 Visit_Descendent (Field21 (N));
2105 Visit_Descendent (Field22 (N));
2106 Visit_Descendent (Field23 (N));
2108 -- Now an interesting kludge. Normally parents are always printed
2109 -- since we traverse the tree in a downwards direction. There is
2110 -- however an exception to this rule, which is the case where a
2111 -- parent is constructed by the compiler and is not referenced
2112 -- elsewhere in the tree. The following catches this case
2114 if not Comes_From_Source (N) then
2115 Visit_Descendent (Union_Id (Parent (N)));
2116 end if;
2118 -- You may be wondering why we omitted Field2 above. The answer
2119 -- is that this is the Next_Entity field, and we want to treat
2120 -- it rather specially. Why? Because a Next_Entity link does not
2121 -- correspond to a level deeper in the tree, and we do not want
2122 -- the tree to march off to the right of the page due to bogus
2123 -- indentations coming from this effect.
2125 -- To prevent this, what we do is to control references via
2126 -- Next_Entity only from the first entity on a given scope
2127 -- chain, and we keep them all at the same level. Of course
2128 -- if an entity has already been referenced it is not printed.
2130 if Present (Next_Entity (N))
2131 and then Present (Scope (N))
2132 and then First_Entity (Scope (N)) = N
2133 then
2134 declare
2135 Nod : Node_Id;
2137 begin
2138 Nod := N;
2139 while Present (Nod) loop
2140 Visit_Descendent (Union_Id (Next_Entity (Nod)));
2141 Nod := Next_Entity (Nod);
2142 end loop;
2143 end;
2144 end if;
2145 end if;
2146 end Visit_Node;
2148 end Treepr;