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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179 | ------------------------------------------------------------------------------
-- GNAT Documentation Generation Tool --
-- --
-- Copyright (C) 2022-2023, AdaCore --
-- --
-- This is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. This software is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY 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 this software; see file --
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license. --
------------------------------------------------------------------------------
with Ada.Containers.Hashed_Maps;
with Ada.Containers.Ordered_Sets;
with VSS.Strings.Hash;
with GNATdoc.Comments;
package GNATdoc.Entities is
type Entity_Kind is
(Undefined,
Ada_Tagged_Type,
Ada_Interface_Type,
Ada_Function,
Ada_Procedure);
type Entity_Information;
type Entity_Information_Access is access all Entity_Information;
function "<"
(Left : Entity_Information_Access;
Right : Entity_Information_Access) return Boolean;
package Entity_Information_Sets is
new Ada.Containers.Ordered_Sets (Entity_Information_Access);
package Entity_Information_Maps is
new Ada.Containers.Hashed_Maps
(VSS.Strings.Virtual_String,
Entity_Information_Access,
VSS.Strings.Hash,
VSS.Strings."=");
type Entity_Reference is record
Qualified_Name : VSS.Strings.Virtual_String;
Signature : VSS.Strings.Virtual_String;
end record;
overriding function "="
(Left : Entity_Reference;
Right : Entity_Reference) return Boolean;
function "<"
(Left : Entity_Reference;
Right : Entity_Reference) return Boolean;
package Entity_Reference_Sets is
new Ada.Containers.Ordered_Sets (Entity_Reference);
type Entity_Information is record
Location : Source_Location;
Kind : Entity_Kind := Undefined;
Name : VSS.Strings.Virtual_String;
Qualified_Name : VSS.Strings.Virtual_String;
Signature : VSS.Strings.Virtual_String;
Documentation : aliased GNATdoc.Comments.Structured_Comment;
Enclosing : VSS.Strings.Virtual_String;
-- Signature of the enclosing entity.
Is_Private : Boolean := False;
-- Private entities are excluded from the documentartion.
Is_Method : Boolean := False;
-- True means that this subprogram is a "method" of some tagged type,
-- thus, it should be documented in "class" documentation; otherwise,
-- it is documented in "unit" documentation.
RST_Profile : VSS.Strings.Virtual_String;
-- Subprogram's profile in fortmat to use by RST backend
Packages : Entity_Information_Sets.Set;
Subprograms : aliased Entity_Information_Sets.Set;
Entries : aliased Entity_Information_Sets.Set;
Generic_Instantiations : aliased Entity_Information_Sets.Set;
-- Generic_Packages
-- Generic_Subprograms
-- Package_Instantiations
-- Subprogram_Instantiations
Package_Renamings : Entity_Information_Sets.Set;
-- Renamings of the packages. Renamings of the subprograms is in
-- the Subprograms field.
Formals : aliased Entity_Information_Sets.Set;
Simple_Types : aliased Entity_Information_Sets.Set;
Array_Types : aliased Entity_Information_Sets.Set;
Record_Types : aliased Entity_Information_Sets.Set;
Interface_Types : aliased Entity_Information_Sets.Set;
Tagged_Types : aliased Entity_Information_Sets.Set;
Task_Types : aliased Entity_Information_Sets.Set;
Protected_Types : aliased Entity_Information_Sets.Set;
Access_Types : aliased Entity_Information_Sets.Set;
Subtypes : aliased Entity_Information_Sets.Set;
Constants : aliased Entity_Information_Sets.Set;
Variables : aliased Entity_Information_Sets.Set;
Exceptions : aliased Entity_Information_Sets.Set;
-- Access_Types : EInfo_List.Vector; +++
-- Generic_Formals : EInfo_List.Vector; +++
-- Interface_Types : EInfo_List.Vector; +++
-- Methods : EInfo_List.Vector; ???
-- Pkgs : EInfo_List.Vector; +++
-- -- Ordinary and generic packages.
-- Pkgs_Instances : EInfo_List.Vector; +++
-- -- Generic packages instantiations.
-- Record_Types : EInfo_List.Vector; +++
-- Simple_Types : EInfo_List.Vector; +++
-- Subprgs : EInfo_List.Vector; +++
-- -- Ordinary subprograms.
-- Subprgs_Instances : EInfo_List.Vector; +++
-- -- Generic subprograms instantiations.
-- Tagged_Types : EInfo_List.Vector; +++
-- Variables : EInfo_List.Vector; +++
-- Tasks : EInfo_List.Vector; +++
-- Protected_Objects : EInfo_List.Vector; +++
-- Entries : EInfo_List.Vector; +++
Parent_Type : Entity_Reference;
-- Reference to parent tagged type.
Progenitor_Types : aliased Entity_Reference_Sets.Set;
-- References to progenitor types.
Derived_Types : aliased Entity_Reference_Sets.Set;
-- References to known derived types.
All_Parent_Types : aliased Entity_Reference_Sets.Set;
All_Progenitor_Types : aliased Entity_Reference_Sets.Set;
All_Derived_Types : aliased Entity_Reference_Sets.Set;
-- References to all known direct or indirect parent and derived types.
Dispatching_Declared : aliased Entity_Reference_Sets.Set;
-- Displatching operations declared by the type.
Dispatching_Overrided : aliased Entity_Reference_Sets.Set;
-- Dispatching operations overrided by the type.
Dispatching_Inherited : aliased Entity_Reference_Sets.Set;
-- Dispatching operations inherited by the type.
Owner_Class : Entity_Reference;
-- Reference to the type that "declare" non dispatching subprogram.
Prefix_Callable_Declared : aliased Entity_Reference_Sets.Set;
-- Prefix callable subprograms declared by the type.
Prefix_Callable_Inherited : aliased Entity_Reference_Sets.Set;
-- Non dispatching operations inherited by the type.
end record;
Globals : aliased Entity_Information;
-- Set of all compilation units (including packages, subprograms,
-- renamings, generics and instantiations) and all nested packages
-- and generic packages.
To_Entity : Entity_Information_Maps.Map;
-- Map to lookup entity's information by entity's signature.
function All_Entities
(Self : Entity_Information) return Entity_Information_Sets.Set;
end GNATdoc.Entities;
|