1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2009, 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 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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- This package implements services for Project-aware tools, mostly related
27 -- to the environment (configuration pragma files, path files, mapping files).
31 procedure Initialize (In_Tree : Project_Tree_Ref);
32 -- Initialize global components relative to environment variables
34 procedure Print_Sources (In_Tree : Project_Tree_Ref);
35 -- Output the list of sources, after Project files have been scanned
37 procedure Create_Mapping (In_Tree : Project_Tree_Ref);
38 -- Create in memory mapping from the sources of all the projects (in body
39 -- of package Fmap), so that Osint.Find_File will find the correct path
40 -- corresponding to a source.
42 procedure Create_Mapping_File
43 (Project : Project_Id;
45 In_Tree : Project_Tree_Ref;
46 Name : out Path_Name_Type);
47 -- Create a temporary mapping file for project Project. For each source or
48 -- template of Language in the Project, put the mapping of its file
49 -- name and path name in this file.
51 -- Implementation note: we pass a language name, not a language_index here,
52 -- since the latter would have to match exactly the index of that language
53 -- for the specified project, and that is not information available in
56 -- See fmap for a description of the format of the mapping file
58 procedure Create_Config_Pragmas_File
59 (For_Project : Project_Id;
60 In_Tree : Project_Tree_Ref);
61 -- If there needs to have SFN pragmas, either for non standard naming
62 -- schemes or for individual units.
64 procedure Create_New_Path_File
65 (In_Tree : Project_Tree_Ref;
66 Path_FD : out File_Descriptor;
67 Path_Name : out Path_Name_Type);
68 -- Create a new temporary path file. Get the file name in Path_Name.
70 function Ada_Include_Path
71 (Project : Project_Id;
72 In_Tree : Project_Tree_Ref;
73 Recursive : Boolean := False) return String;
74 -- Get the source search path of a Project file. If Recursive it True, get
75 -- all the source directories of the imported and modified project files
76 -- (recursively). If Recursive is False, just get the path for the source
77 -- directories of Project. Note: the resulting String may be empty if there
78 -- is no source directory in the project file.
80 function Ada_Objects_Path
81 (Project : Project_Id;
82 Including_Libraries : Boolean := True) return String_Access;
83 -- Get the ADA_OBJECTS_PATH of a Project file. For the first call, compute
84 -- it and cache it. When Including_Libraries is False, do not include the
85 -- object directories of the library projects, and do not cache the result.
87 procedure Set_Ada_Paths
88 (Project : Project_Id;
89 In_Tree : Project_Tree_Ref;
90 Including_Libraries : Boolean);
91 -- Set the environment variables for additional project path files, after
92 -- creating the path files if necessary.
94 function File_Name_Of_Library_Unit_Body
97 In_Tree : Project_Tree_Ref;
98 Main_Project_Only : Boolean := True;
99 Full_Path : Boolean := False) return String;
100 -- Returns the file name of a library unit, in canonical case. Name may or
101 -- may not have an extension (corresponding to the naming scheme of the
102 -- project). If there is no body with this name, but there is a spec, the
103 -- name of the spec is returned.
105 -- If Full_Path is False (the default), the simple file name is returned.
107 -- If Full_Path is True, the absolute path name is returned.
109 -- If neither a body nor a spec can be found, an empty string is returned.
110 -- If Main_Project_Only is True, the unit must be an immediate source of
111 -- Project. If it is False, it may be a source of one of its imported
116 Main_Project : Project_Id;
117 In_Tree : Project_Tree_Ref) return Project_Id;
118 -- Get the project of a source. The source file name may be truncated
119 -- (".adb" or ".ads" may be missing). If the source is in a project being
120 -- extended, return the ultimate extending project. If it is not a source
121 -- of any project, return No_Project.
123 procedure Get_Reference
124 (Source_File_Name : String;
125 In_Tree : Project_Tree_Ref;
126 Project : out Project_Id;
127 Path : out Path_Name_Type);
128 -- Returns the project of a source and its path in displayable form
131 with procedure Action (Path : String);
132 procedure For_All_Source_Dirs
133 (Project : Project_Id;
134 In_Tree : Project_Tree_Ref);
135 -- Iterate through all the source directories of a project, including those
136 -- of imported or modified projects.
137 -- Only returns those directories that potentially contain Ada sources (ie
138 -- ignore projects that have no Ada sources
141 with procedure Action (Path : String);
142 procedure For_All_Object_Dirs (Project : Project_Id);
143 -- Iterate through all the object directories of a project, including
144 -- those of imported or modified projects.