1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2010-2011, 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. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
30 ------------------------------------------------------------------------------
32 -- This package defines the aspects that are recognized by GNAT in aspect
33 -- specifications. It also contains the subprograms for storing/retrieving
34 -- aspect specifications from the tree. The semantic processing for aspect
35 -- specifications is found in Sem_Ch13.Analyze_Aspect_Specifications.
37 with Namet; use Namet;
38 with Snames; use Snames;
39 with Types; use Types;
43 -- Type defining recognized aspects
46 (No_Aspect, -- Dummy entry for no aspect
50 Aspect_Component_Size,
51 Aspect_Constant_Indexing,
52 Aspect_Default_Component_Value,
53 Aspect_Default_Iterator,
55 Aspect_Dynamic_Predicate,
57 Aspect_Implicit_Dereference,
60 Aspect_Iterator_Element,
62 Aspect_Object_Size, -- GNAT
68 Aspect_Predicate, -- GNAT
71 Aspect_Static_Predicate,
76 Aspect_Test_Case, -- GNAT
77 Aspect_Type_Invariant,
79 Aspect_Value_Size, -- GNAT
80 Aspect_Variable_Indexing,
84 -- The following aspects correspond to library unit pragmas
86 Aspect_All_Calls_Remote,
87 Aspect_Compiler_Unit, -- GNAT
88 Aspect_Elaborate_Body,
90 Aspect_Preelaborate_05, -- GNAT
92 Aspect_Pure_05, -- GNAT
93 Aspect_Remote_Call_Interface,
95 Aspect_Shared_Passive,
96 Aspect_Universal_Data, -- GNAT
98 -- Remaining aspects have a static boolean value that turns the aspect
99 -- on or off. They all correspond to pragmas, but are only converted to
100 -- the pragmas where the value is True. A value of False normally means
101 -- that the aspect is ignored, except in the case of derived types where
102 -- the aspect value is inherited from the parent, in which case, we do
103 -- not allow False if we inherit a True value from the parent.
105 Aspect_Ada_2005, -- GNAT
106 Aspect_Ada_2012, -- GNAT
108 Aspect_Atomic_Components,
109 Aspect_Discard_Names,
110 Aspect_Favor_Top_Level, -- GNAT
112 Aspect_Inline_Always, -- GNAT
115 Aspect_Persistent_BSS, -- GNAT
116 Aspect_Preelaborable_Initialization,
117 Aspect_Pure_Function, -- GNAT
118 Aspect_Shared, -- GNAT (equivalent to Atomic)
119 Aspect_Suppress_Debug_Info, -- GNAT
120 Aspect_Unchecked_Union,
121 Aspect_Universal_Aliasing, -- GNAT
122 Aspect_Unmodified, -- GNAT
123 Aspect_Unreferenced, -- GNAT
124 Aspect_Unreferenced_Objects, -- GNAT
126 Aspect_Volatile_Components);
128 -- The following array indicates aspects that accept 'Class
130 Class_Aspect_OK : constant array (Aspect_Id) of Boolean :=
131 (Aspect_Invariant => True,
133 Aspect_Predicate => True,
137 -- The following array indicates aspects for which multiple occurrences of
138 -- the same aspect attached to the same declaration are allowed.
140 No_Duplicates_Allowed : constant array (Aspect_Id) of Boolean :=
141 (Aspect_Test_Case => False,
144 -- The following subtype defines aspects corresponding to library unit
145 -- pragmas, these can only validly appear as aspects for library units,
146 -- and result in a corresponding pragma being inserted immediately after
147 -- the occurrence of the aspect.
149 subtype Library_Unit_Aspects is
150 Aspect_Id range Aspect_All_Calls_Remote .. Aspect_Universal_Data;
152 -- The following subtype defines aspects accepting an optional static
153 -- boolean parameter indicating if the aspect should be active or
154 -- cancelling. If the parameter is missing the effective value is True,
155 -- enabling the aspect. If the parameter is present it must be a static
156 -- expression of type Standard.Boolean. If the value is True, then the
157 -- aspect is enabled. If it is False, the aspect is disabled.
159 subtype Boolean_Aspects is
160 Aspect_Id range Aspect_Ada_2005 .. Aspect_Id'Last;
162 subtype Pre_Post_Aspects is
163 Aspect_Id range Aspect_Post .. Aspect_Precondition;
165 -- The following type is used for indicating allowed expression forms
167 type Aspect_Expression is
168 (Optional, -- Optional boolean expression
169 Expression, -- Required non-boolean expression
170 Name); -- Required name
172 -- The following array indicates what argument type is required
174 Aspect_Argument : constant array (Aspect_Id) of Aspect_Expression :=
175 (No_Aspect => Optional,
176 Aspect_Address => Expression,
177 Aspect_Alignment => Expression,
178 Aspect_Bit_Order => Expression,
179 Aspect_Component_Size => Expression,
180 Aspect_Constant_Indexing => Name,
181 Aspect_Default_Component_Value => Expression,
182 Aspect_Default_Iterator => Name,
183 Aspect_Default_Value => Expression,
184 Aspect_Dynamic_Predicate => Expression,
185 Aspect_External_Tag => Expression,
186 Aspect_Implicit_Dereference => Name,
187 Aspect_Input => Name,
188 Aspect_Invariant => Expression,
189 Aspect_Iterator_Element => Name,
190 Aspect_Machine_Radix => Expression,
191 Aspect_Object_Size => Expression,
192 Aspect_Output => Name,
193 Aspect_Post => Expression,
194 Aspect_Postcondition => Expression,
195 Aspect_Pre => Expression,
196 Aspect_Precondition => Expression,
197 Aspect_Predicate => Expression,
199 Aspect_Size => Expression,
200 Aspect_Static_Predicate => Expression,
201 Aspect_Storage_Pool => Name,
202 Aspect_Storage_Size => Expression,
203 Aspect_Stream_Size => Expression,
204 Aspect_Suppress => Name,
205 Aspect_Test_Case => Expression,
206 Aspect_Type_Invariant => Expression,
207 Aspect_Unsuppress => Name,
208 Aspect_Value_Size => Expression,
209 Aspect_Variable_Indexing => Name,
210 Aspect_Warnings => Name,
211 Aspect_Write => Name,
213 Library_Unit_Aspects => Optional,
214 Boolean_Aspects => Optional);
216 -----------------------------------------
217 -- Table Linking Names and Aspect_Id's --
218 -----------------------------------------
220 -- Table linking aspect names and id's
222 Aspect_Names : constant array (Aspect_Id) of Name_Id := (
223 No_Aspect => No_Name,
224 Aspect_Ada_2005 => Name_Ada_2005,
225 Aspect_Ada_2012 => Name_Ada_2012,
226 Aspect_Address => Name_Address,
227 Aspect_Alignment => Name_Alignment,
228 Aspect_All_Calls_Remote => Name_All_Calls_Remote,
229 Aspect_Atomic => Name_Atomic,
230 Aspect_Atomic_Components => Name_Atomic_Components,
231 Aspect_Bit_Order => Name_Bit_Order,
232 Aspect_Compiler_Unit => Name_Compiler_Unit,
233 Aspect_Component_Size => Name_Component_Size,
234 Aspect_Constant_Indexing => Name_Constant_Indexing,
235 Aspect_Default_Iterator => Name_Default_Iterator,
236 Aspect_Default_Value => Name_Default_Value,
237 Aspect_Default_Component_Value => Name_Default_Component_Value,
238 Aspect_Discard_Names => Name_Discard_Names,
239 Aspect_Dynamic_Predicate => Name_Dynamic_Predicate,
240 Aspect_Elaborate_Body => Name_Elaborate_Body,
241 Aspect_External_Tag => Name_External_Tag,
242 Aspect_Favor_Top_Level => Name_Favor_Top_Level,
243 Aspect_Implicit_Dereference => Name_Implicit_Dereference,
244 Aspect_Inline => Name_Inline,
245 Aspect_Inline_Always => Name_Inline_Always,
246 Aspect_Input => Name_Input,
247 Aspect_Invariant => Name_Invariant,
248 Aspect_Iterator_Element => Name_Iterator_Element,
249 Aspect_Machine_Radix => Name_Machine_Radix,
250 Aspect_No_Return => Name_No_Return,
251 Aspect_Object_Size => Name_Object_Size,
252 Aspect_Output => Name_Output,
253 Aspect_Pack => Name_Pack,
254 Aspect_Persistent_BSS => Name_Persistent_BSS,
255 Aspect_Post => Name_Post,
256 Aspect_Postcondition => Name_Postcondition,
257 Aspect_Pre => Name_Pre,
258 Aspect_Precondition => Name_Precondition,
259 Aspect_Predicate => Name_Predicate,
260 Aspect_Preelaborable_Initialization => Name_Preelaborable_Initialization,
261 Aspect_Preelaborate => Name_Preelaborate,
262 Aspect_Preelaborate_05 => Name_Preelaborate_05,
263 Aspect_Pure => Name_Pure,
264 Aspect_Pure_05 => Name_Pure_05,
265 Aspect_Pure_Function => Name_Pure_Function,
266 Aspect_Read => Name_Read,
267 Aspect_Remote_Call_Interface => Name_Remote_Call_Interface,
268 Aspect_Remote_Types => Name_Remote_Types,
269 Aspect_Shared => Name_Shared,
270 Aspect_Shared_Passive => Name_Shared_Passive,
271 Aspect_Size => Name_Size,
272 Aspect_Static_Predicate => Name_Static_Predicate,
273 Aspect_Storage_Pool => Name_Storage_Pool,
274 Aspect_Storage_Size => Name_Storage_Size,
275 Aspect_Stream_Size => Name_Stream_Size,
276 Aspect_Suppress => Name_Suppress,
277 Aspect_Suppress_Debug_Info => Name_Suppress_Debug_Info,
278 Aspect_Test_Case => Name_Test_Case,
279 Aspect_Type_Invariant => Name_Type_Invariant,
280 Aspect_Unchecked_Union => Name_Unchecked_Union,
281 Aspect_Universal_Aliasing => Name_Universal_Aliasing,
282 Aspect_Universal_Data => Name_Universal_Data,
283 Aspect_Unmodified => Name_Unmodified,
284 Aspect_Unreferenced => Name_Unreferenced,
285 Aspect_Unreferenced_Objects => Name_Unreferenced_Objects,
286 Aspect_Unsuppress => Name_Unsuppress,
287 Aspect_Value_Size => Name_Value_Size,
288 Aspect_Variable_Indexing => Name_Variable_Indexing,
289 Aspect_Volatile => Name_Volatile,
290 Aspect_Volatile_Components => Name_Volatile_Components,
291 Aspect_Warnings => Name_Warnings,
292 Aspect_Write => Name_Write);
294 function Get_Aspect_Id (Name : Name_Id) return Aspect_Id;
295 pragma Inline (Get_Aspect_Id);
296 -- Given a name Nam, returns the corresponding aspect id value. If the name
297 -- does not match any aspect, then No_Aspect is returned as the result.
299 ---------------------------------------------------
300 -- Handling of Aspect Specifications in the Tree --
301 ---------------------------------------------------
303 -- Several kinds of declaration node permit aspect specifications in Ada
304 -- 2012 mode. If there was room in all the corresponding declaration nodes,
305 -- we could just have a field Aspect_Specifications pointing to a list of
306 -- nodes for the aspects (N_Aspect_Specification nodes). But there isn't
307 -- room, so we adopt a different approach.
309 -- The following subprograms provide access to a specialized interface
310 -- implemented internally with a hash table in the body, that provides
311 -- access to aspect specifications.
313 function Permits_Aspect_Specifications (N : Node_Id) return Boolean;
314 -- Returns True if the node N is a declaration node that permits aspect
315 -- specifications in the grammar. It is possible for other nodes to have
316 -- aspect specifications as a result of Rewrite or Replace calls.
318 function Aspect_Specifications (N : Node_Id) return List_Id;
319 -- Given a node N, returns the list of N_Aspect_Specification nodes that
320 -- are attached to this declaration node. If the node is in the class of
321 -- declaration nodes that permit aspect specifications, as defined by the
322 -- predicate above, and if their Has_Aspects flag is set to True, then this
323 -- will always be a non-empty list. If this flag is set to False, then
324 -- No_List is returned. Normally, the only nodes that have Has_Aspects set
325 -- True are the nodes for which Permits_Aspect_Specifications would return
326 -- True (i.e. the declaration nodes defined in the RM as permitting the
327 -- presence of Aspect_Specifications). However, it is possible for the
328 -- flag Has_Aspects to be set on other nodes as a result of Rewrite and
329 -- Replace calls, and this function may be used to retrieve the aspect
330 -- specifications for the original rewritten node in such cases.
332 procedure Set_Aspect_Specifications (N : Node_Id; L : List_Id);
333 -- The node N must be in the class of declaration nodes that permit aspect
334 -- specifications and the Has_Aspects flag must be False on entry. L must
335 -- be a non-empty list of N_Aspect_Specification nodes. This procedure sets
336 -- the Has_Aspects flag to True, and makes an entry that can be retrieved
337 -- by a subsequent Aspect_Specifications call. It is an error to call this
338 -- procedure with a node that does not permit aspect specifications, or a
339 -- node that has its Has_Aspects flag set True on entry, or with L being an
340 -- empty list or No_List.
342 procedure Move_Aspects (From : Node_Id; To : Node_Id);
343 -- Moves aspects from 'From' node to 'To' node. Has_Aspects (To) must be
344 -- False on entry. If Has_Aspects (From) is False, the call has no effect.
345 -- Otherwise the aspects are moved and on return Has_Aspects (To) is True,
346 -- and Has_Aspects (From) is False.
348 function Same_Aspect (A1 : Aspect_Id; A2 : Aspect_Id) return Boolean;
349 -- Returns True if A1 and A2 are (essentially) the same aspect. This is not
350 -- a simple equality test because e.g. Post and Postcondition are the same.
351 -- This is used for detecting duplicate aspects.
353 procedure Tree_Write;
354 -- Writes contents of Aspect_Specifications hash table to the tree file
357 -- Reads contents of Aspect_Specifications hash table from the tree file