gcc/ada/prj-proc.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              P R J . P R O C                             --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2001-2009, 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 is used to convert a project file tree (see prj-tree.ads) to
  27 --  project file data structures (see prj.ads), taking into account the
  28 --  environment (external references).
  29
  30 with Prj.Tree;  use Prj.Tree;
  31
  32 package Prj.Proc is
  33
  34    procedure Process_Project_Tree_Phase_1
  35      (In_Tree                : Project_Tree_Ref;
  36       Project                : out Project_Id;
  37       Success                : out Boolean;
  38       From_Project_Node      : Project_Node_Id;
  39       From_Project_Node_Tree : Project_Node_Tree_Ref;
  40       Report_Error           : Put_Line_Access;
  41       Reset_Tree             : Boolean := True);
  42    --  Process a project tree (ie the direct resulting of parsing a .gpr file)
  43    --  based on the current scenario variables.
  44    --
  45    --  The result of this phase_1 is a partial project tree (Project) where
  46    --  only a few fields have been initialized (in particular the list of
  47    --  languages). These are the fields that are necessary to run gprconfig if
  48    --  needed to automatically generate a configuration file. This first phase
  49    --  of the processing does not require a configuration file.
  50    --
  51    --  If Report_Error is null, use the error reporting mechanism. Otherwise,
  52    --  report errors using Report_Error.
  53    --
  54    --  When_No_Sources indicates what should be done when no sources are found
  55    --  in a project for a specified or implied language.
  56    --
  57    --  When Reset_Tree is True, all the project data are removed from the
  58    --  project table before processing.
  59
  60    procedure Process_Project_Tree_Phase_2
  61      (In_Tree                   : Project_Tree_Ref;
  62       Project                   : Project_Id;
  63       Success                   : out Boolean;
  64       From_Project_Node         : Project_Node_Id;
  65       From_Project_Node_Tree    : Project_Node_Tree_Ref;
  66       Report_Error              : Put_Line_Access;
  67       When_No_Sources           : Error_Warning := Error;
  68       Current_Dir               : String;
  69       Is_Config_File            : Boolean;
  70       Compiler_Driver_Mandatory : Boolean);
  71    --  Perform the second phase of the processing, filling the rest of the
  72    --  project with the information extracted from the project tree. This phase
  73    --  requires that the configuration file has already been parsed (in fact
  74    --  we currently assume that the contents of the configuration file has
  75    --  been included in Project through Confgpr.Apply_Config_File). The
  76    --  parameters are the same as for phase_1, with the addition of:
  77    --
  78    --  Current_Dir is for optimization purposes, avoiding extra system calls.
  79    --
  80    --  Is_Config_File should be true if Project is a config file (.cgpr)
  81
  82    procedure Process
  83      (In_Tree                : Project_Tree_Ref;
  84       Project                : out Project_Id;
  85       Success                : out Boolean;
  86       From_Project_Node      : Project_Node_Id;
  87       From_Project_Node_Tree : Project_Node_Tree_Ref;
  88       Report_Error           : Put_Line_Access;
  89       When_No_Sources        : Error_Warning := Error;
  90       Reset_Tree             : Boolean := True;
  91       Current_Dir            : String := "";
  92       Is_Config_File         : Boolean);
  93    --  Performs the two phases of the processing
  94
  95 end Prj.Proc;