gcc/ada/prj-pp.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                               P R J . P P                                --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --             Copyright (C) 2001-2005 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,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, 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 --  This package is the Project File Pretty Printer.
  28 --  It is used to output a project file from a project file tree.
  29 --  It is used by gnatname to update or create project files.
  30 --  It is also used GPS to display project file trees.
  31 --  It can also be used for debugging purposes for tools that create project
  32 --  file trees.
  33
  34 with Prj.Tree;
  35
  36 package Prj.PP is
  37
  38    --  The following access to procedure types are used
  39    --  to redirect output when calling Pretty_Print.
  40
  41    type Write_Char_Ap is access procedure (C : Character);
  42
  43    type Write_Eol_Ap  is access procedure;
  44
  45    type Write_Str_Ap is access procedure (S : String);
  46
  47    procedure Pretty_Print
  48      (Project                            : Prj.Tree.Project_Node_Id;
  49       In_Tree                            : Prj.Tree.Project_Node_Tree_Ref;
  50       Increment                          : Positive      := 3;
  51       Eliminate_Empty_Case_Constructions : Boolean       := False;
  52       Minimize_Empty_Lines               : Boolean       := False;
  53       W_Char                             : Write_Char_Ap := null;
  54       W_Eol                              : Write_Eol_Ap  := null;
  55       W_Str                              : Write_Str_Ap  := null;
  56       Backward_Compatibility             : Boolean);
  57    --  Output a project file, using either the default output
  58    --  routines, or the ones specified by W_Char, W_Eol and W_Str.
  59    --
  60    --  Increment is the number of spaces for each indentation level.
  61    --
  62    --  W_Char, W_Eol and W_Str can be used to change the default output
  63    --  procedures. The default values force the output to Standard_Output.
  64    --
  65    --  If Eliminate_Empty_Case_Constructions is True, then case constructions
  66    --  and case items that do not include any declarations will not be output.
  67    --
  68    --  If Minimize_Empty_Lines is True, empty lines will be output only
  69    --  after the last with clause, after the line declaring the project name,
  70    --  after the last declarative item of the project and before each
  71    --  package declaration. Otherwise, more empty lines are output.
  72    --
  73    --  If Backward_Compatibility is True, then new attributes (Spec,
  74    --  Spec_Suffix, Body, Body_Suffix) will be replaced by obsolete ones
  75    --  (Specification, Specification_Suffix, Implementation,
  76    --  Implementation_Suffix).
  77
  78 private
  79
  80    procedure Output_Statistics;
  81    --  This procedure can be used after one or more calls to Pretty_Print
  82    --  to display what Project_Node_Kinds have not been exercised by the
  83    --  call(s) to Pretty_Print. It is used only for testing purposes.
  84
  85 end Prj.PP;