1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                              P R J . E N V                               --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--             Copyright (C) 2001-2003 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 implements services for Project-aware tools, related
28--  to the environment (gnat.adc, ADA_INCLUDE_PATH, ADA_OBJECTS_PATH)
29
30with GNAT.OS_Lib; use GNAT.OS_Lib;
31
32package Prj.Env is
33
34   procedure Initialize;
35   --  Put Standard_Naming_Data into Namings table (called by Prj.Initialize)
36
37   procedure Print_Sources;
38   --  Output the list of sources, after Project files have been scanned
39
40   procedure Create_Mapping_File
41     (Project : Project_Id;
42      Name    : out Name_Id);
43   --  Create a temporary mapping file for project Project. For each unit
44   --  in the closure of immediate sources of Project, put the mapping of
45   --  its spec and or body to its file name and path name in this file.
46
47   procedure Set_Mapping_File_Initial_State_To_Empty;
48   --  When creating a mapping file, create an empty map. This case occurs
49   --  when run time source files are found in the project files.
50
51   procedure Create_Config_Pragmas_File
52     (For_Project          : Project_Id;
53      Main_Project         : Project_Id;
54      Include_Config_Files : Boolean := True);
55   --  If there needs to have SFN pragmas, either for non standard naming
56   --  schemes or for individual units, or (when Include_Config_Files is True)
57   --  if Global_Configuration_Pragmas has been specified in package gnatmake
58   --  of the main project, or if Local_Configuration_Pragmas has been
59   --  specified in package Compiler of the main project, build (if needed)
60   --  a temporary file that contains all configuration pragmas, and specify
61   --  the configuration pragmas file in the project data.
62
63   function Ada_Include_Path (Project : Project_Id) return String_Access;
64   --  Get the ADA_INCLUDE_PATH of a Project file. For the first call, compute
65   --  it and cache it.
66
67   function Ada_Include_Path
68     (Project   : Project_Id;
69      Recursive : Boolean) return String;
70   --  Get the ADA_INCLUDE_PATH of a Project file. If Recursive it True,
71   --  get all the source directories of the imported and modified project
72   --  files (recursively). If Recursive is False, just get the path for the
73   --  source directories of Project. Note: the resulting String may be empty
74   --  if there is no source directory in the project file.
75
76   function Ada_Objects_Path
77     (Project             : Project_Id;
78      Including_Libraries : Boolean := True) return String_Access;
79   --  Get the ADA_OBJECTS_PATH of a Project file. For the first call, compute
80   --  it and cache it. When Including_Libraries is False, do not include the
81   --  object directories of the library projects, and do not cache the result.
82
83   procedure Set_Ada_Paths
84     (Project             : Project_Id;
85      Including_Libraries : Boolean);
86   --  Set the env vars for additional project path files, after
87   --  creating the path files if necessary.
88
89   procedure Delete_All_Path_Files;
90   --  Delete all temporary path files that have been created by
91   --  calls to Set_Ada_Paths.
92
93   function Path_Name_Of_Library_Unit_Body
94     (Name    : String;
95      Project : Project_Id) return String;
96   --  Returns the Path of a library unit
97
98   function File_Name_Of_Library_Unit_Body
99     (Name              : String;
100      Project           : Project_Id;
101      Main_Project_Only : Boolean := True;
102      Full_Path         : Boolean := False) return String;
103   --  Returns the file name of a library unit, in canonical case. Name may or
104   --  may not have an extension (corresponding to the naming scheme of the
105   --  project). If there is no body with this name, but there is a spec, the
106   --  name of the spec is returned.
107   --
108   --  If Full_Path is False (the default), the simple file name is returned.
109   --
110   --  If Full_Path is True, the absolute path name is returned.
111   --
112   --  If neither a body nor a spec can be found, an empty string is returned.
113   --  If Main_Project_Only is True, the unit must be an immediate source of
114   --  Project. If it is False, it may be a source of one of its imported
115   --  projects.
116
117   function Project_Of
118     (Name         : String;
119      Main_Project : Project_Id) return Project_Id;
120   --  Get the project of a source. The source file name may be truncated
121   --  (".adb" or ".ads" may be missing). If the source is in a project being
122   --  extended, return the ultimate extending project. If it is not a source
123   --  of any project, return No_Project.
124
125   procedure Get_Reference
126     (Source_File_Name : String;
127      Project          : out Project_Id;
128      Path             : out Name_Id);
129   --  Returns the project of a source and its path in displayable form
130
131   generic
132      with procedure Action (Path : String);
133   procedure For_All_Source_Dirs (Project : Project_Id);
134   --  Iterate through all the source directories of a project,
135   --  including those of imported or modified projects.
136
137   generic
138      with procedure Action (Path : String);
139   procedure For_All_Object_Dirs (Project : Project_Id);
140   --  Iterate through all the object directories of a project,
141   --  including those of imported or modified projects.
142
143end Prj.Env;
144