1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                              P R J . P A R S                             --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2000-2011, 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--  General wrapper for the parsing of project files
27
28with Prj.Tree;
29
30package Prj.Pars is
31
32   procedure Set_Verbosity (To : Verbosity);
33   --  Set the verbosity when parsing the project files
34
35   procedure Parse
36     (In_Tree           : Project_Tree_Ref;
37      Project           : out Project_Id;
38      Project_File_Name : String;
39      Packages_To_Check : String_List_Access;
40      Reset_Tree        : Boolean := True;
41      In_Node_Tree      : Prj.Tree.Project_Node_Tree_Ref := null;
42      Env               : in out Prj.Tree.Environment);
43   --  Parse and process a project files and all its imported project files, in
44   --  the project tree In_Tree.
45   --
46   --  All the project files are parsed (through Prj.Tree) to create a tree in
47   --  memory. That tree is then processed (through Prj.Proc) to create a
48   --  expanded representation of the tree based on the current external
49   --  references. This function is only a convenient wrapper over other
50   --  services provided in the Prj.* package hierarchy.
51   --
52   --  If parsing is successful, Project is the project ID of the root project
53   --  file; otherwise, Project_Id is set to No_Project. Project_Node_Tree is
54   --  set to the tree (unprocessed) representation of the project file. This
55   --  tree is permanently correct, whereas Project will need to be recomputed
56   --  if the external references change.
57   --
58   --  Packages_To_Check indicates the packages where any unknown attribute
59   --  produces an error. For other packages, an unknown attribute produces a
60   --  warning.
61   --
62   --  When Reset_Tree is True, all the project data are removed from the
63   --  project table before processing.
64   --
65   --  In_Node_Tree (if given) must have been Initialized. The main reason to
66   --  pass an existing tree, is to pass the external references that will then
67   --  be used to process the tree.
68
69end Prj.Pars;
70