1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
------------------------------------------------------------------------------
-- --
-- ASIS UTILITY LIBRARY COMPONENTS --
-- --
-- A S I S _ U L . P R O J E C T S . A G G R E G A T E --
-- --
-- S p e c --
-- --
-- Copyright (C) 2018-2019, AdaCore --
-- --
-- Asis Utility Library (ASIS UL) is free software; you can redistribute it --
-- and/or modify it under terms of the GNU General Public License as --
-- published by the Free Software Foundation; either version 3, or (at your --
-- option) any later version. ASIS UL is distributed in the hope that it --
-- will be useful, but WITHOUT ANY WARRANTY; without even the implied --
-- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the --
-- GNU General Public License for more details. You should have received a --
-- copy of the GNU General Public License distributed with GNAT; see file --
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license. --
-- --
-- ASIS UL is maintained by AdaCore (http://www.adacore.com). --
-- --
------------------------------------------------------------------------------
-- This package contains high-level interfaces to project files needed to
-- process aggregate projects.
--
-- There are two different cases here:
--
-- * Simple case - aggregate project aggregates only one (non-aggregate)
-- project that has sources. This case from the point of a
-- tool does not differ from processing of non-aggregate
-- project, except that when processing a project file, a
-- tool should unload an aggregate project and load (the
-- only) project with sources
--
-- * Complex case - aggregate project aggregates more than one project that
-- has (or, more precisely, may have) sources. Processing of
-- this case is described in the body of this package.
pragma Ada_2012;
package ASIS_UL.Projects.Aggregate is
procedure Store_Aggregated_Project (S : String);
function Get_Aggregated_Project return String;
-- Stores and returns the name of the aggregated project file passed as an
-- actual for '-A ' option.
procedure Collect_Aggregated_Projects (P : Project_Type);
-- Stores (in internal data structures) the full paths to the
-- (non-aggregate!) projects that have been aggregated by P
function Num_Of_Aggregated_Projects return Natural;
-- Returns the number of (non-aggregate) projects being aggregated. We
-- need to know this because the case when an aggregate project aggregates
-- only one project is a useful special case.
function Get_Aggregated_Prj_Src return Virtual_File with
Pre => Num_Of_Aggregated_Projects = 1;
-- Returns the (single!) aggregate project source file
-----------------------
-- Project iterator --
-----------------------
-- This iterator should be used when all the (non-aggregate) projects are
-- stored in internal data structures. This iterator is to be used to
-- iterate through these projects, each of these projects is loaded and
-- analyzed, and all the extracted data is stored in internal database.
procedure Start_Prj_Iterator with
Pre => Num_Of_Aggregated_Projects > 1;
-- Initializes the iterator and sets it to the first project stored in the
-- database
function Next_Prj_Name return Filesystem_String_Access;
-- Gets the full name of the project file the iterator points onto
procedure Prj_Iterator_Next;
-- Moves iterator forward.
function Prj_Iterator_Done return Boolean;
-- Tells that iterator has passed through all the projects stored in the
-- database
-- The routines below updates or queries the information related to the
-- project being accessed during iteration
procedure Process_Aggregated_Projects
(My_Project : Arg_Project_Type'Class) with
Pre => Num_Of_Aggregated_Projects > 1;
-- Iterates through the projects being aggregated and spawns the tool
-- for each of them
--
-- Currently this procedure is gnatcheck-specific - tt creates report files
-- that are specific for gnatcheck tool (one specific report for each
-- project being aggregated and an umbrella report that lists all the
-- (non-aggregate) project that have been processed and corresponding
-- report files.
------------
-- Debug --
------------
procedure Aggregated_Projects_Debug_Image;
-- Prints out the debug image of the storage for aggregated projects
end ASIS_UL.Projects.Aggregate;
|
