gcc/ada/sprint.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                               S P R I N T                                --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2023, 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 --  This package (source print) contains routines for printing the source
  27 --  program corresponding to a specified syntax tree. These routines are
  28 --  intended for debugging use in the compiler (not as a user level pretty
  29 --  print tool). Only information present in the tree is output (e.g. no
  30 --  comments are present in the output), and as far as possible we avoid
  31 --  making any assumptions about the correctness of the tree, so a bad
  32 --  tree may either blow up on a debugging check, or list incorrect source.
  33
  34 with Types; use Types;
  35
  36 package Sprint is
  37
  38    -----------------------
  39    -- Syntax Extensions --
  40    -----------------------
  41
  42    --  When the generated tree is printed, it contains constructs that are not
  43    --  pure Ada. For convenience, syntactic extensions to Ada have been defined
  44    --  purely for the purposes of this printout (they are not recognized by the
  45    --  parser).
  46
  47    --  Could use more documentation for all of these ???
  48
  49    --    Allocator                           new xxx [storage_pool = xxx]
  50    --    Cleanup action                      at end procedure name;
  51    --    Convert wi Conversion_OK            target?(source)
  52    --    Convert wi Float_Truncate           target^(source)
  53    --    Convert wi Rounded_Result           target@(source)
  54    --    Divide wi Rounded_Result            x @/ y
  55    --    Expression with actions             do action; .. action; in expr end
  56    --    Expression with range check         {expression}
  57    --    Free statement                      free expr [storage_pool = xxx]
  58    --    Freeze entity with freeze actions   freeze entityname [ actions ]
  59    --    Freeze generic entity               freeze_generic entityname
  60    --    Implicit call to run time routine   $routine-name
  61    --    Implicit exportation                $pragma import (...)
  62    --    Implicit importation                $pragma export (...)
  63    --    Interpretation                      interpretation type [, entity]
  64    --    Intrinsic calls                     function-name!(arg, arg, arg)
  65    --    Itype declaration                   [(sub)type declaration without ;]
  66    --    Itype reference                     reference itype
  67    --    Label declaration                   labelname : label
  68    --    Multiple concatenation              expr && expr && expr ... && expr
  69    --    Multiply wi Rounded_Result          x @* y
  70    --    Operator with overflow check        {operator} (e.g. {+})
  71    --    Others choice for cleanup           when all others
  72    --    Pop exception label                 %pop_xxx_exception_label
  73    --    Push exception label                %push_xxx_exception_label (label)
  74    --    Raise xxx error                     [xxx_error [when cond]]
  75    --    Raise xxx error with msg            [xxx_error [when cond], "msg"]
  76    --    Rational literal                    [expression]
  77    --    Reference                           expression'reference
  78    --    Shift nodes                         shift_name!(expr, count)
  79    --    Static declaration                  name : static xxx
  80    --    Unchecked conversion                target_type!(source_expression)
  81    --    Unchecked expression                `(expression)
  82    --    Validate_Unchecked_Conversion       validate unchecked_conversion
  83    --                                                  (src-type, target-typ);
  84
  85    --  Note: the storage_pool parameters for allocators and the free node are
  86    --  omitted if the Storage_Pool field is Empty, indicating use of the
  87    --  standard default pool.
  88
  89    -----------------
  90    -- Subprograms --
  91    -----------------
  92
  93    procedure Source_Dump;
  94    --  This routine is called from the GNAT main program to dump source as
  95    --  requested by debug options. The relevant debug options are:
  96    --    -ds  print source from tree, both original and generated code
  97    --    -dg  print source from tree, including only the generated code
  98    --    -do  print source from tree, including only the original code
  99    --    -df  modify the above to include all units, not just the main unit
 100    --    -dz  print source from tree for package Standard
 101
 102    procedure Sprint_Comma_List (List : List_Id);
 103    --  Prints the nodes in a list, with separating commas. If the list is empty
 104    --  then no output is generated.
 105
 106    procedure Sprint_Paren_Comma_List (List : List_Id);
 107    --  Prints the nodes in a list, surrounded by parentheses, and separated by
 108    --  commas. If the list is empty, then no output is generated. A blank is
 109    --  output before the initial left parenthesis.
 110
 111    procedure Sprint_Opt_Paren_Comma_List (List : List_Id);
 112    --  Same as normal Sprint_Paren_Comma_List procedure, except that an extra
 113    --  blank is output if List is non-empty, and nothing at all is printed it
 114    --  the argument is No_List.
 115
 116    procedure Sprint_Node_List (List : List_Id; New_Lines : Boolean := False);
 117    --  Prints the nodes in a list with no separating characters. This is used
 118    --  in the case of lists of items which are printed on separate lines using
 119    --  the current indentation amount. New_Lines controls the generation of
 120    --  New_Line calls. If False, no New_Line calls are generated. If True,
 121    --  then New_Line calls are generated as needed to ensure that each list
 122    --  item starts at the beginning of a line.
 123
 124    procedure Sprint_Opt_Node_List (List : List_Id);
 125    --  Like Sprint_Node_List, but prints nothing if List = No_List
 126
 127    procedure Sprint_Indented_List (List : List_Id);
 128    --  Like Sprint_Line_List, except that the indentation level is increased
 129    --  before outputting the list of items, and then decremented (back to its
 130    --  original level) before returning to the caller.
 131
 132    procedure Sprint_Node (Node : Node_Id);
 133    --  Prints a single node. No new lines are output, except as required for
 134    --  splitting lines that are too long to fit on a single physical line.
 135    --  No output is generated at all if Node is Empty. No trailing or leading
 136    --  blank characters are generated.
 137
 138    procedure Sprint_Opt_Node (Node : Node_Id);
 139    --  Same as normal Sprint_Node procedure, except that one leading blank is
 140    --  output before the node if it is non-empty.
 141
 142    procedure pg (Arg : Union_Id);
 143    pragma Export (Ada, pg);
 144    --  Print generated source for argument N (like -gnatdg output). Intended
 145    --  only for use from gdb for debugging purposes. Currently, Arg may be a
 146    --  List_Id or a Node_Id (anything else outputs a blank line).
 147
 148    procedure po (Arg : Union_Id);
 149    pragma Export (Ada, po);
 150    --  Like pg, but prints original source for the argument (like -gnatdo
 151    --  output). Intended only for use from gdb for debugging purposes. In
 152    --  the list case, an end of line is output to separate list elements.
 153
 154    procedure ps (Arg : Union_Id);
 155    pragma Export (Ada, ps);
 156    --  Like pg, but prints generated and original source for the argument (like
 157    --  -gnatds output). Intended only for use from gdb for debugging purposes.
 158    --  In the list case, an end of line is output to separate list elements.
 159
 160 end Sprint;