home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / sprint.ads < prev    next >
Text File  |  1996-09-28  |  8KB  |  135 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                               S P R I N T                                --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.28 $                             --
  10. --                                                                          --
  11. --           Copyright (c) 1992,1993,1994 NYU, All Rights Reserved          --
  12. --                                                                          --
  13. -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14. -- terms of the  GNU General Public License as published  by the Free Soft- --
  15. -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16. -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17. -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18. -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19. -- for  more details.  You should have  received  a copy of the GNU General --
  20. -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21. -- to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. --
  22. --                                                                          --
  23. ------------------------------------------------------------------------------
  24.  
  25. --  This package (source print) contains routines for printing the source
  26. --  program corresponding to a specified syntax tree. These routines are
  27. --  intended for debugging use in the compiler (not as a user level pretty
  28. --  print tool). Only information present in the tree is output (e.g. no
  29. --  comments are present in the output), and as far as possible we avoid
  30. --  making any assumptions about the correctness of the tree, so a bad
  31. --  tree may either blow up on a debugging check, or list incorrect source.
  32.  
  33. with Types; use Types;
  34. package Sprint is
  35.  
  36.    -----------------------
  37.    -- Syntax Extensions --
  38.    -----------------------
  39.  
  40.    --  When the generated tree is printed, it contains constructs that are not
  41.    --  pure Ada. For convenience, syntactic extensions to Ada have been defined
  42.    --  purely for the purposes of this printout (they are not recognized by the
  43.    --  parser)
  44.  
  45.    --    Allocator                           new xxx [storage_pool = xxx]
  46.    --    Cleanup action                      at end procedure name;
  47.    --    Conditional expression              (if expr then expr else expr)
  48.    --    Conversion wi Float_Truncate        target^(source)
  49.    --    Convert wi Conversion_OK            target?(source)
  50.    --    Convert wi both above flags         target?^(source)
  51.    --    Divide wi Treat_Fixed_As_Integer    x #/ y
  52.    --    Expression actions                  [action; action; ...; value]
  53.    --    Free statement                      free expr [storage_pool = xxx]
  54.    --    Freeze action                       freeze typename [ actions ]
  55.    --    Implicit type                       implicit type xxx is yyy
  56.    --    Interpretation                      interpretation type [, entity]
  57.    --    Intrinsic calls                     function-name!(arg, arg, arg)
  58.    --    Label declaration                   labelname : label
  59.    --    Mod wi Treat_Fixed_As_Integer       x #mod y
  60.    --    Multiple concatenation              expr && expr && expr ... && expr
  61.    --    Multiply wi Treat_Fixed_As_Integer  x #* y
  62.    --    Raise constraint error              [constraint_error]
  63.    --    Rational literal                    See UR_Write for details
  64.    --    Rem wi Treat_Fixed_As_Integer       x #rem y
  65.    --    Reference                           expression'reference
  66.    --    Shift nodes                         shift_name!(expr, count)
  67.    --    Unchecked conversion                target_type!(source_expression)
  68.  
  69.    --  Note: the storage_pool parameters for allocators and the free node
  70.    --  are omitted if the Storage_Pool field is Empty, indicating use of
  71.    --  the standard default pool.
  72.  
  73.    -----------------
  74.    -- Subprograms --
  75.    -----------------
  76.  
  77.    procedure Source_Dump;
  78.    --  This routine is called from the GNAT main program to dump source as
  79.    --  requested by debug options. The relevant debug options are:
  80.    --    -ds  print source from tree, both original and generated code
  81.    --    -dg  print source from tree, including only the generated code
  82.    --    -do  print source from tree, including only the original code
  83.    --    -df  modify the above to include all units, not just the main unit
  84.    --    -sz  print source from tree for package Standard
  85.  
  86.    procedure Sprint_Comma_List (List : List_Id);
  87.    --  Prints the nodes in a list, with separating commas. If the list
  88.    --  is empty then no output is generated.
  89.  
  90.    procedure Sprint_Paren_Comma_List (List : List_Id);
  91.    --  Prints the nodes in a list, surrounded by parentheses, and separated
  92.    --  by comas. If the list is empty, then no output is generated. A blank
  93.    --  is output before the initial left parenthesis.
  94.  
  95.    procedure Sprint_Opt_Paren_Comma_List (List : List_Id);
  96.    --  Same as normal Sprint_Paren_Comma_List procedure, except that
  97.    --  an extra blank is output if List is non-empty, and nothing at all is
  98.    --  printed it the argument is No_List.
  99.  
  100.    procedure Sprint_Node_List (List : List_Id);
  101.    --  Prints the nodes in a list with no separating characters. This is used
  102.    --  in the case of lists of items which are printed on separate lines using
  103.    --  the current indentation amount. Note that Sprint_Node_List itself
  104.    --  does not generate any New_Line calls.
  105.  
  106.    procedure Sprint_Opt_Node_List (List : List_Id);
  107.    --  Like Sprint_Node_List, but prints nothing if List = No_List.
  108.  
  109.    procedure Sprint_Indented_List (List : List_Id);
  110.    --  Like Sprint_Line_List, except that the indentation level is
  111.    --  increased before outputting the list of items, and then decremented
  112.    --  (back to its original level) before returning to the caller.
  113.  
  114.    procedure Sprint_Node (Node : Node_Id);
  115.    --  Prints a single node. No new lines are output, except as required for
  116.    --  splitting lines that are too long to fit on a single physical line.
  117.    --  No output is generated at all if Node is Empty. No trailing or leading
  118.    --  blank characters are generated.
  119.  
  120.    procedure Sprint_Node_Pure_Ada (Node : Node_Id);
  121.    --  The tree rooted at the given node is printed in pure Ada form, i.e.
  122.    --  the output is guaranteed to be compilable. Original_Tree mode is used
  123.    --  so that any nodes inserted with Rewrite_Insert or substituted using
  124.    --  Rewrite_Substitute_Tree will not be included in the output. In addition
  125.    --  there must be no occurrences of nodes corresponding to the set of syntax
  126.    --  extensions listed earlier in this spec (except that label declarations
  127.    --  may be present, but will not be printed, since they are omitted in
  128.    --  original tree mode in any case).
  129.  
  130.    procedure Sprint_Opt_Node (Node : Node_Id);
  131.    --  Same as normal Sprint_Node procedure, except that one leading
  132.    --  blank is output before the node if it is non-empty.
  133.  
  134. end Sprint;
  135.