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-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 --  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 package Sprint is
  36
  37    -----------------------
  38    -- Syntax Extensions --
  39    -----------------------
  40
  41    --  When the generated tree is printed, it contains constructs that are not
  42    --  pure Ada. For convenience, syntactic extensions to Ada have been defined
  43    --  purely for the purposes of this printout (they are not recognized by the
  44    --  parser)
  45
  46    --  Could use more documentation for all of these ???
  47
  48    --    Allocator                           new xxx [storage_pool = xxx]
  49    --    Cleanup action                      at end procedure name;
  50    --    Conditional expression              (if expr then expr else expr)
  51    --    Conversion wi Float_Truncate        target^(source)
  52    --    Convert wi Conversion_OK            target?(source)
  53    --    Convert wi Rounded_Result           target@(source)
  54    --    Divide wi Treat_Fixed_As_Integer    x #/ y
  55    --    Divide wi Rounded_Result            x @/ y
  56    --    Expression with range check         {expression}
  57    --    Operator with range check           {operator} (e.g. {+})
  58    --    Free statement                      free expr [storage_pool = xxx]
  59    --    Freeze entity with freeze actions   freeze entityname [ actions ]
  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    --    Mod wi Treat_Fixed_As_Integer       x #mod y
  69    --    Multiple concatenation              expr && expr && expr ... && expr
  70    --    Multiply wi Treat_Fixed_As_Integer  x #* y
  71    --    Multiply wi Rounded_Result          x @* y
  72    --    Others choice for cleanup           when all others
  73    --    Pop exception label                 %pop_xxx_exception_label
  74    --    Push exception label                %push_xxx_exception_label (label)
  75    --    Raise xxx error                     [xxx_error [when cond]]
  76    --    Raise xxx error with msg            [xxx_error [when cond], "msg"]
  77    --    Rational literal                    See UR_Write for details
  78    --    Rem wi Treat_Fixed_As_Integer       x #rem y
  79    --    Reference                           expression'reference
  80    --    Shift nodes                         shift_name!(expr, count)
  81    --    Static declaration                  name : static xxx
  82    --    Subprogram_Info                     subprog'Subprogram_Info
  83    --    Unchecked conversion                target_type!(source_expression)
  84    --    Unchecked expression                `(expression)
  85    --    Validate_Unchecked_Conversion       validate unchecked_conversion
  86    --                                                  (src-type, target-typ);
  87
  88    --  Note: the storage_pool parameters for allocators and the free node
  89    --  are omitted if the Storage_Pool field is Empty, indicating use of
  90    --  the standard default pool.
  91
  92    -----------------
  93    -- Subprograms --
  94    -----------------
  95
  96    procedure Source_Dump;
  97    --  This routine is called from the GNAT main program to dump source as
  98    --  requested by debug options. The relevant debug options are:
  99    --    -ds  print source from tree, both original and generated code
 100    --    -dg  print source from tree, including only the generated code
 101    --    -do  print source from tree, including only the original code
 102    --    -df  modify the above to include all units, not just the main unit
 103    --    -sz  print source from tree for package Standard
 104
 105    procedure Sprint_Comma_List (List : List_Id);
 106    --  Prints the nodes in a list, with separating commas. If the list
 107    --  is empty then no output is generated.
 108
 109    procedure Sprint_Paren_Comma_List (List : List_Id);
 110    --  Prints the nodes in a list, surrounded by parentheses, and separated
 111    --  by comas. If the list is empty, then no output is generated. A blank
 112    --  is output before the initial left parenthesis.
 113
 114    procedure Sprint_Opt_Paren_Comma_List (List : List_Id);
 115    --  Same as normal Sprint_Paren_Comma_List procedure, except that
 116    --  an extra blank is output if List is non-empty, and nothing at all is
 117    --  printed it the argument is No_List.
 118
 119    procedure Sprint_Node_List (List : List_Id);
 120    --  Prints the nodes in a list with no separating characters. This is used
 121    --  in the case of lists of items which are printed on separate lines using
 122    --  the current indentation amount. Note that Sprint_Node_List itself
 123    --  does not generate any New_Line calls.
 124
 125    procedure Sprint_Opt_Node_List (List : List_Id);
 126    --  Like Sprint_Node_List, but prints nothing if List = No_List
 127
 128    procedure Sprint_Indented_List (List : List_Id);
 129    --  Like Sprint_Line_List, except that the indentation level is
 130    --  increased before outputting the list of items, and then decremented
 131    --  (back to its original level) before returning to the caller.
 132
 133    procedure Sprint_Node (Node : Node_Id);
 134    --  Prints a single node. No new lines are output, except as required for
 135    --  splitting lines that are too long to fit on a single physical line.
 136    --  No output is generated at all if Node is Empty. No trailing or leading
 137    --  blank characters are generated.
 138
 139    procedure Sprint_Opt_Node (Node : Node_Id);
 140    --  Same as normal Sprint_Node procedure, except that one leading
 141    --  blank is output before the node if it is non-empty.
 142
 143    procedure pg (Arg : Union_Id);
 144    pragma Export (Ada, pg);
 145    --  Print generated source for argument N (like -gnatdg output). Intended
 146    --  only for use from gdb for debugging purposes. Currently, Arg may be a
 147    --  List_Id or a Node_Id (anything else outputs a blank line).
 148
 149    procedure po (Arg : Union_Id);
 150    pragma Export (Ada, po);
 151    --  Like pg, but prints original source for the argument (like -gnatdo
 152    --  output). Intended only for use from gdb for debugging purposes.
 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
 159 end Sprint;