OSDN Git Service

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