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