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
49 Aspect_Attach_Handler,
51 Aspect_Component_Size,
52 Aspect_Constant_Indexing,
53 Aspect_Default_Component_Value,
54 Aspect_Default_Iterator,
56 Aspect_Dispatching_Domain,
57 Aspect_Dynamic_Predicate,
59 Aspect_Implicit_Dereference,
61 Aspect_Interrupt_Priority,
63 Aspect_Iterator_Element,
65 Aspect_Object_Size, -- GNAT
71 Aspect_Predicate, -- GNAT
76 Aspect_Static_Predicate,
81 Aspect_Test_Case, -- GNAT
82 Aspect_Type_Invariant,
84 Aspect_Value_Size, -- GNAT
85 Aspect_Variable_Indexing,
89 -- The following aspects correspond to library unit pragmas
91 Aspect_All_Calls_Remote,
92 Aspect_Compiler_Unit, -- GNAT
93 Aspect_Elaborate_Body,
95 Aspect_Preelaborate_05, -- GNAT
97 Aspect_Pure_05, -- GNAT
98 Aspect_Remote_Call_Interface,
100 Aspect_Shared_Passive,
101 Aspect_Universal_Data, -- GNAT
103 -- Remaining aspects have a static boolean value that turns the aspect
104 -- on or off. They all correspond to pragmas, but are only converted to
105 -- the pragmas where the value is True. A value of False normally means
106 -- that the aspect is ignored, except in the case of derived types where
107 -- the aspect value is inherited from the parent, in which case, we do
108 -- not allow False if we inherit a True value from the parent.
110 Aspect_Ada_2005, -- GNAT
111 Aspect_Ada_2012, -- GNAT
114 Aspect_Atomic_Components,
115 Aspect_Discard_Names,
116 Aspect_Favor_Top_Level, -- GNAT
118 Aspect_Independent_Components,
120 Aspect_Inline_Always, -- GNAT
121 Aspect_Interrupt_Handler,
124 Aspect_Persistent_BSS, -- GNAT
125 Aspect_Preelaborable_Initialization,
126 Aspect_Pure_Function, -- GNAT
127 Aspect_Shared, -- GNAT (equivalent to Atomic)
128 Aspect_Suppress_Debug_Info, -- GNAT
129 Aspect_Unchecked_Union,
130 Aspect_Universal_Aliasing, -- GNAT
131 Aspect_Unmodified, -- GNAT
132 Aspect_Unreferenced, -- GNAT
133 Aspect_Unreferenced_Objects, -- GNAT
135 Aspect_Volatile_Components);
137 -- The following array indicates aspects that accept 'Class
139 Class_Aspect_OK : constant array (Aspect_Id) of Boolean :=
140 (Aspect_Invariant => True,
142 Aspect_Predicate => True,
146 -- The following array indicates aspects for which multiple occurrences of
147 -- the same aspect attached to the same declaration are allowed.
149 No_Duplicates_Allowed : constant array (Aspect_Id) of Boolean :=
150 (Aspect_Test_Case => False,
153 -- The following subtype defines aspects corresponding to library unit
154 -- pragmas, these can only validly appear as aspects for library units,
155 -- and result in a corresponding pragma being inserted immediately after
156 -- the occurrence of the aspect.
158 subtype Library_Unit_Aspects is
159 Aspect_Id range Aspect_All_Calls_Remote .. Aspect_Universal_Data;
161 -- The following subtype defines aspects accepting an optional static
162 -- boolean parameter indicating if the aspect should be active or
163 -- cancelling. If the parameter is missing the effective value is True,
164 -- enabling the aspect. If the parameter is present it must be a static
165 -- expression of type Standard.Boolean. If the value is True, then the
166 -- aspect is enabled. If it is False, the aspect is disabled.
168 subtype Boolean_Aspects is
169 Aspect_Id range Aspect_Ada_2005 .. Aspect_Id'Last;
171 subtype Pre_Post_Aspects is
172 Aspect_Id range Aspect_Post .. Aspect_Precondition;
174 -- The following type is used for indicating allowed expression forms
176 type Aspect_Expression is
177 (Optional, -- Optional boolean expression
178 Expression, -- Required expression
179 Name); -- Required name
181 -- The following array indicates what argument type is required
183 Aspect_Argument : constant array (Aspect_Id) of Aspect_Expression :=
184 (No_Aspect => Optional,
185 Aspect_Address => Expression,
186 Aspect_Alignment => Expression,
187 Aspect_Attach_Handler => Expression,
188 Aspect_Bit_Order => Expression,
189 Aspect_Component_Size => Expression,
190 Aspect_Constant_Indexing => Name,
191 Aspect_Default_Component_Value => Expression,
192 Aspect_Default_Iterator => Name,
193 Aspect_Default_Value => Expression,
194 Aspect_Dispatching_Domain => Expression,
195 Aspect_Dynamic_Predicate => Expression,
196 Aspect_External_Tag => Expression,
197 Aspect_Implicit_Dereference => Name,
198 Aspect_Input => Name,
199 Aspect_Interrupt_Priority => Expression,
200 Aspect_Invariant => Expression,
201 Aspect_Iterator_Element => Name,
202 Aspect_Machine_Radix => Expression,
203 Aspect_Object_Size => Expression,
204 Aspect_Output => Name,
205 Aspect_Post => Expression,
206 Aspect_Postcondition => Expression,
207 Aspect_Pre => Expression,
208 Aspect_Precondition => Expression,
209 Aspect_Predicate => Expression,
210 Aspect_Priority => Expression,
212 Aspect_Size => Expression,
213 Aspect_Small => Expression,
214 Aspect_Static_Predicate => Expression,
215 Aspect_Storage_Pool => Name,
216 Aspect_Storage_Size => Expression,
217 Aspect_Stream_Size => Expression,
218 Aspect_Suppress => Name,
219 Aspect_Test_Case => Expression,
220 Aspect_Type_Invariant => Expression,
221 Aspect_Unsuppress => Name,
222 Aspect_Value_Size => Expression,
223 Aspect_Variable_Indexing => Name,
224 Aspect_Warnings => Name,
225 Aspect_Write => Name,
227 Library_Unit_Aspects => Optional,
228 Boolean_Aspects => Optional);
230 -----------------------------------------
231 -- Table Linking Names and Aspect_Id's --
232 -----------------------------------------
234 -- Table linking aspect names and id's
236 Aspect_Names : constant array (Aspect_Id) of Name_Id := (
237 No_Aspect => No_Name,
238 Aspect_Ada_2005 => Name_Ada_2005,
239 Aspect_Ada_2012 => Name_Ada_2012,
240 Aspect_Address => Name_Address,
241 Aspect_Alignment => Name_Alignment,
242 Aspect_All_Calls_Remote => Name_All_Calls_Remote,
243 Aspect_Asynchronous => Name_Asynchronous,
244 Aspect_Atomic => Name_Atomic,
245 Aspect_Atomic_Components => Name_Atomic_Components,
246 Aspect_Attach_Handler => Name_Attach_Handler,
247 Aspect_Bit_Order => Name_Bit_Order,
248 Aspect_Compiler_Unit => Name_Compiler_Unit,
249 Aspect_Component_Size => Name_Component_Size,
250 Aspect_Constant_Indexing => Name_Constant_Indexing,
251 Aspect_Default_Iterator => Name_Default_Iterator,
252 Aspect_Default_Value => Name_Default_Value,
253 Aspect_Default_Component_Value => Name_Default_Component_Value,
254 Aspect_Discard_Names => Name_Discard_Names,
255 Aspect_Dispatching_Domain => Name_Dispatching_Domain,
256 Aspect_Dynamic_Predicate => Name_Dynamic_Predicate,
257 Aspect_Elaborate_Body => Name_Elaborate_Body,
258 Aspect_External_Tag => Name_External_Tag,
259 Aspect_Favor_Top_Level => Name_Favor_Top_Level,
260 Aspect_Implicit_Dereference => Name_Implicit_Dereference,
261 Aspect_Independent => Name_Independent,
262 Aspect_Independent_Components => Name_Independent_Components,
263 Aspect_Inline => Name_Inline,
264 Aspect_Inline_Always => Name_Inline_Always,
265 Aspect_Input => Name_Input,
266 Aspect_Interrupt_Handler => Name_Interrupt_Handler,
267 Aspect_Interrupt_Priority => Name_Interrupt_Priority,
268 Aspect_Invariant => Name_Invariant,
269 Aspect_Iterator_Element => Name_Iterator_Element,
270 Aspect_Machine_Radix => Name_Machine_Radix,
271 Aspect_No_Return => Name_No_Return,
272 Aspect_Object_Size => Name_Object_Size,
273 Aspect_Output => Name_Output,
274 Aspect_Pack => Name_Pack,
275 Aspect_Persistent_BSS => Name_Persistent_BSS,
276 Aspect_Post => Name_Post,
277 Aspect_Postcondition => Name_Postcondition,
278 Aspect_Pre => Name_Pre,
279 Aspect_Precondition => Name_Precondition,
280 Aspect_Predicate => Name_Predicate,
281 Aspect_Preelaborable_Initialization => Name_Preelaborable_Initialization,
282 Aspect_Preelaborate => Name_Preelaborate,
283 Aspect_Preelaborate_05 => Name_Preelaborate_05,
284 Aspect_Priority => Name_Priority,
285 Aspect_Pure => Name_Pure,
286 Aspect_Pure_05 => Name_Pure_05,
287 Aspect_Pure_Function => Name_Pure_Function,
288 Aspect_Read => Name_Read,
289 Aspect_Remote_Call_Interface => Name_Remote_Call_Interface,
290 Aspect_Remote_Types => Name_Remote_Types,
291 Aspect_Shared => Name_Shared,
292 Aspect_Shared_Passive => Name_Shared_Passive,
293 Aspect_Size => Name_Size,
294 Aspect_Small => Name_Small,
295 Aspect_Static_Predicate => Name_Static_Predicate,
296 Aspect_Storage_Pool => Name_Storage_Pool,
297 Aspect_Storage_Size => Name_Storage_Size,
298 Aspect_Stream_Size => Name_Stream_Size,
299 Aspect_Suppress => Name_Suppress,
300 Aspect_Suppress_Debug_Info => Name_Suppress_Debug_Info,
301 Aspect_Test_Case => Name_Test_Case,
302 Aspect_Type_Invariant => Name_Type_Invariant,
303 Aspect_Unchecked_Union => Name_Unchecked_Union,
304 Aspect_Universal_Aliasing => Name_Universal_Aliasing,
305 Aspect_Universal_Data => Name_Universal_Data,
306 Aspect_Unmodified => Name_Unmodified,
307 Aspect_Unreferenced => Name_Unreferenced,
308 Aspect_Unreferenced_Objects => Name_Unreferenced_Objects,
309 Aspect_Unsuppress => Name_Unsuppress,
310 Aspect_Value_Size => Name_Value_Size,
311 Aspect_Variable_Indexing => Name_Variable_Indexing,
312 Aspect_Volatile => Name_Volatile,
313 Aspect_Volatile_Components => Name_Volatile_Components,
314 Aspect_Warnings => Name_Warnings,
315 Aspect_Write => Name_Write);
317 function Get_Aspect_Id (Name : Name_Id) return Aspect_Id;
318 pragma Inline (Get_Aspect_Id);
319 -- Given a name Nam, returns the corresponding aspect id value. If the name
320 -- does not match any aspect, then No_Aspect is returned as the result.
322 ---------------------------------------------------
323 -- Handling of Aspect Specifications in the Tree --
324 ---------------------------------------------------
326 -- Several kinds of declaration node permit aspect specifications in Ada
327 -- 2012 mode. If there was room in all the corresponding declaration nodes,
328 -- we could just have a field Aspect_Specifications pointing to a list of
329 -- nodes for the aspects (N_Aspect_Specification nodes). But there isn't
330 -- room, so we adopt a different approach.
332 -- The following subprograms provide access to a specialized interface
333 -- implemented internally with a hash table in the body, that provides
334 -- access to aspect specifications.
336 function Permits_Aspect_Specifications (N : Node_Id) return Boolean;
337 -- Returns True if the node N is a declaration node that permits aspect
338 -- specifications in the grammar. It is possible for other nodes to have
339 -- aspect specifications as a result of Rewrite or Replace calls.
341 function Aspect_Specifications (N : Node_Id) return List_Id;
342 -- Given a node N, returns the list of N_Aspect_Specification nodes that
343 -- are attached to this declaration node. If the node is in the class of
344 -- declaration nodes that permit aspect specifications, as defined by the
345 -- predicate above, and if their Has_Aspects flag is set to True, then this
346 -- will always be a non-empty list. If this flag is set to False, then
347 -- No_List is returned. Normally, the only nodes that have Has_Aspects set
348 -- True are the nodes for which Permits_Aspect_Specifications would return
349 -- True (i.e. the declaration nodes defined in the RM as permitting the
350 -- presence of Aspect_Specifications). However, it is possible for the
351 -- flag Has_Aspects to be set on other nodes as a result of Rewrite and
352 -- Replace calls, and this function may be used to retrieve the aspect
353 -- specifications for the original rewritten node in such cases.
355 procedure Set_Aspect_Specifications (N : Node_Id; L : List_Id);
356 -- The node N must be in the class of declaration nodes that permit aspect
357 -- specifications and the Has_Aspects flag must be False on entry. L must
358 -- be a non-empty list of N_Aspect_Specification nodes. This procedure sets
359 -- the Has_Aspects flag to True, and makes an entry that can be retrieved
360 -- by a subsequent Aspect_Specifications call. It is an error to call this
361 -- procedure with a node that does not permit aspect specifications, or a
362 -- node that has its Has_Aspects flag set True on entry, or with L being an
363 -- empty list or No_List.
365 function Find_Aspect (Ent : Entity_Id; A : Aspect_Id) return Node_Id;
366 -- Find value of a given aspect from aspect list of entity
368 procedure Move_Aspects (From : Node_Id; To : Node_Id);
369 -- Moves aspects from 'From' node to 'To' node. Has_Aspects (To) must be
370 -- False on entry. If Has_Aspects (From) is False, the call has no effect.
371 -- Otherwise the aspects are moved and on return Has_Aspects (To) is True,
372 -- and Has_Aspects (From) is False.
374 function Same_Aspect (A1 : Aspect_Id; A2 : Aspect_Id) return Boolean;
375 -- Returns True if A1 and A2 are (essentially) the same aspect. This is not
376 -- a simple equality test because e.g. Post and Postcondition are the same.
377 -- This is used for detecting duplicate aspects.
379 procedure Tree_Write;
380 -- Writes contents of Aspect_Specifications hash table to the tree file
383 -- Reads contents of Aspect_Specifications hash table from the tree file