1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2004 Free Software Foundation, Inc --
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. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 -- This package implements services for Project-aware tools, mostly related
28 -- to the environment (configuration pragma files, path files, mapping files).
30 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
35 -- Called by Prj.Initialize to perform required initialization
36 -- steps for this package.
38 procedure Print_Sources
;
39 -- Output the list of sources, after Project files have been scanned
41 procedure Create_Mapping_File
42 (Project
: Project_Id
;
44 -- Create a temporary mapping file for project Project. For each unit
45 -- in the closure of immediate sources of Project, put the mapping of
46 -- its spec and or body to its file name and path name in this file.
48 procedure Set_Mapping_File_Initial_State_To_Empty
;
49 -- When creating a mapping file, create an empty map. This case occurs
50 -- when run time source files are found in the project files.
52 procedure Create_Config_Pragmas_File
53 (For_Project
: Project_Id
;
54 Main_Project
: Project_Id
;
55 Include_Config_Files
: Boolean := True);
56 -- If there needs to have SFN pragmas, either for non standard naming
57 -- schemes or for individual units, or (when Include_Config_Files is True)
58 -- if Global_Configuration_Pragmas has been specified in package gnatmake
59 -- of the main project, or if Local_Configuration_Pragmas has been
60 -- specified in package Compiler of the main project, build (if needed)
61 -- a temporary file that contains all configuration pragmas, and specify
62 -- the configuration pragmas file in the project data.
64 function Ada_Include_Path
(Project
: Project_Id
) return String_Access
;
65 -- Get the ADA_INCLUDE_PATH of a Project file. For the first call, compute
68 function Ada_Include_Path
69 (Project
: Project_Id
;
70 Recursive
: Boolean) return String;
71 -- Get the ADA_INCLUDE_PATH of a Project file. If Recursive it True,
72 -- get all the source directories of the imported and modified project
73 -- files (recursively). If Recursive is False, just get the path for the
74 -- source directories of Project. Note: the resulting String may be empty
75 -- if there is no source directory in the project file.
77 function Ada_Objects_Path
78 (Project
: Project_Id
;
79 Including_Libraries
: Boolean := True) return String_Access
;
80 -- Get the ADA_OBJECTS_PATH of a Project file. For the first call, compute
81 -- it and cache it. When Including_Libraries is False, do not include the
82 -- object directories of the library projects, and do not cache the result.
84 procedure Set_Ada_Paths
85 (Project
: Project_Id
;
86 Including_Libraries
: Boolean);
87 -- Set the env vars for additional project path files, after
88 -- creating the path files if necessary.
90 procedure Delete_All_Path_Files
;
91 -- Delete all temporary path files that have been created by
92 -- calls to Set_Ada_Paths.
94 function Path_Name_Of_Library_Unit_Body
96 Project
: Project_Id
) return String;
97 -- Returns the Path of a library unit
99 function File_Name_Of_Library_Unit_Body
101 Project
: Project_Id
;
102 Main_Project_Only
: Boolean := True;
103 Full_Path
: Boolean := False) return String;
104 -- Returns the file name of a library unit, in canonical case. Name may or
105 -- may not have an extension (corresponding to the naming scheme of the
106 -- project). If there is no body with this name, but there is a spec, the
107 -- name of the spec is returned.
109 -- If Full_Path is False (the default), the simple file name is returned.
111 -- If Full_Path is True, the absolute path name is returned.
113 -- If neither a body nor a spec can be found, an empty string is returned.
114 -- If Main_Project_Only is True, the unit must be an immediate source of
115 -- Project. If it is False, it may be a source of one of its imported
120 Main_Project
: Project_Id
) return Project_Id
;
121 -- Get the project of a source. The source file name may be truncated
122 -- (".adb" or ".ads" may be missing). If the source is in a project being
123 -- extended, return the ultimate extending project. If it is not a source
124 -- of any project, return No_Project.
126 procedure Get_Reference
127 (Source_File_Name
: String;
128 Project
: out Project_Id
;
130 -- Returns the project of a source and its path in displayable form
133 with procedure Action
(Path
: String);
134 procedure For_All_Source_Dirs
(Project
: Project_Id
);
135 -- Iterate through all the source directories of a project,
136 -- including those of imported or modified projects.
139 with procedure Action
(Path
: String);
140 procedure For_All_Object_Dirs
(Project
: Project_Id
);
141 -- Iterate through all the object directories of a project,
142 -- including those of imported or modified projects.