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