gcc/ada/aspects.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              A S P E C T S                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2010-2014, Free Software Foundation, Inc.         --
  10 --                                                                          --
  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.                                     --
  17 --                                                                          --
  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.               --
  21 --                                                                          --
  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/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  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.
  36
  37 ------------------------
  38 -- Adding New Aspects --
  39 ------------------------
  40
  41 --  In general, each aspect should have a corresponding pragma, so that the
  42 --  newly developed functionality is available for Ada versions < Ada 2012.
  43 --  When both are defined, it is convenient to first transform the aspect into
  44 --  an equivalent pragma in Sem_Ch13.Analyze_Aspect_Specifications, and then
  45 --  analyze the pragma in Sem_Prag.Analyze_Pragma.
  46
  47 --  To add a new aspect, you need to do the following
  48
  49 --    1. Create a name in snames.ads-tmpl
  50
  51 --    2. Create a value in type Aspect_Id in this unit
  52
  53 --    3. Add a value for the aspect in the global arrays defined in this unit
  54
  55 --    4. Add code for the aspect in Sem_Ch13.Analyze_Aspect_Specifications.
  56 --       This may involve adding some nodes to the tree to perform additional
  57 --       treatments later.
  58
  59 --    5. If the semantic analysis of expressions/names in the aspect should not
  60 --       occur at the point the aspect is defined, add code in the adequate
  61 --       semantic analysis procedure for the aspect. For example, this is the
  62 --       case for aspects Pre and Post on subprograms, which are pre-analyzed
  63 --       at the end of the declaration list to which the subprogram belongs,
  64 --       and fully analyzed (possibly with expansion) during the semantic
  65 --       analysis of subprogram bodies.
  66
  67 with Namet;   use Namet;
  68 with Snames;  use Snames;
  69 with Types;   use Types;
  70
  71 package Aspects is
  72
  73    --  Type defining recognized aspects
  74
  75    type Aspect_Id is
  76      (No_Aspect,                            -- Dummy entry for no aspect
  77       Aspect_Abstract_State,                -- GNAT
  78       Aspect_Address,
  79       Aspect_Alignment,
  80       Aspect_Annotate,                      -- GNAT
  81       Aspect_Attach_Handler,
  82       Aspect_Bit_Order,
  83       Aspect_Component_Size,
  84       Aspect_Constant_Indexing,
  85       Aspect_Contract_Cases,                -- GNAT
  86       Aspect_Convention,
  87       Aspect_CPU,
  88       Aspect_Default_Component_Value,
  89       Aspect_Default_Initial_Condition,     -- GNAT
  90       Aspect_Default_Iterator,
  91       Aspect_Default_Value,
  92       Aspect_Depends,                       -- GNAT
  93       Aspect_Dimension,                     -- GNAT
  94       Aspect_Dimension_System,              -- GNAT
  95       Aspect_Dispatching_Domain,
  96       Aspect_Dynamic_Predicate,
  97       Aspect_External_Name,
  98       Aspect_External_Tag,
  99       Aspect_Global,                        -- GNAT
 100       Aspect_Implicit_Dereference,
 101       Aspect_Initial_Condition,             -- GNAT
 102       Aspect_Initializes,                   -- GNAT
 103       Aspect_Input,
 104       Aspect_Interrupt_Priority,
 105       Aspect_Invariant,                     -- GNAT
 106       Aspect_Iterator_Element,
 107       Aspect_Iterable,                      -- GNAT
 108       Aspect_Link_Name,
 109       Aspect_Linker_Section,                -- GNAT
 110       Aspect_Machine_Radix,
 111       Aspect_Object_Size,                   -- GNAT
 112       Aspect_Obsolescent,                   -- GNAT
 113       Aspect_Output,
 114       Aspect_Part_Of,                       -- GNAT
 115       Aspect_Post,
 116       Aspect_Postcondition,
 117       Aspect_Pre,
 118       Aspect_Precondition,
 119       Aspect_Predicate,                     -- GNAT
 120       Aspect_Priority,
 121       Aspect_Read,
 122       Aspect_Refined_Depends,               -- GNAT
 123       Aspect_Refined_Global,                -- GNAT
 124       Aspect_Refined_Post,                  -- GNAT
 125       Aspect_Refined_State,                 -- GNAT
 126       Aspect_Relative_Deadline,
 127       Aspect_Scalar_Storage_Order,          -- GNAT
 128       Aspect_Simple_Storage_Pool,           -- GNAT
 129       Aspect_Size,
 130       Aspect_Small,
 131       Aspect_SPARK_Mode,                    -- GNAT
 132       Aspect_Static_Predicate,
 133       Aspect_Storage_Pool,
 134       Aspect_Storage_Size,
 135       Aspect_Stream_Size,
 136       Aspect_Suppress,
 137       Aspect_Synchronization,
 138       Aspect_Test_Case,                     -- GNAT
 139       Aspect_Type_Invariant,
 140       Aspect_Unsuppress,
 141       Aspect_Value_Size,                    -- GNAT
 142       Aspect_Variable_Indexing,
 143       Aspect_Warnings,                      -- GNAT
 144       Aspect_Write,
 145
 146       --  The following aspects correspond to library unit pragmas
 147
 148       Aspect_All_Calls_Remote,
 149       Aspect_Elaborate_Body,
 150       Aspect_No_Elaboration_Code_All,       -- GNAT
 151       Aspect_Preelaborate,
 152       Aspect_Pure,
 153       Aspect_Remote_Call_Interface,
 154       Aspect_Remote_Types,
 155       Aspect_Shared_Passive,
 156       Aspect_Universal_Data,                -- GNAT
 157
 158       --  Remaining aspects have a static boolean value that turns the aspect
 159       --  on or off. They all correspond to pragmas, but are only converted to
 160       --  the pragmas where the value is True. A value of False normally means
 161       --  that the aspect is ignored, except in the case of derived types where
 162       --  the aspect value is inherited from the parent, in which case, we do
 163       --  not allow False if we inherit a True value from the parent.
 164
 165       Aspect_Async_Readers,                 -- GNAT
 166       Aspect_Async_Writers,                 -- GNAT
 167       Aspect_Asynchronous,
 168       Aspect_Atomic,
 169       Aspect_Atomic_Components,
 170       Aspect_Discard_Names,
 171       Aspect_Effective_Reads,               -- GNAT
 172       Aspect_Effective_Writes,              -- GNAT
 173       Aspect_Export,
 174       Aspect_Favor_Top_Level,               -- GNAT
 175       Aspect_Independent,
 176       Aspect_Independent_Components,
 177       Aspect_Import,
 178       Aspect_Inline,
 179       Aspect_Inline_Always,                 -- GNAT
 180       Aspect_Interrupt_Handler,
 181       Aspect_Lock_Free,                     -- GNAT
 182       Aspect_No_Return,
 183       Aspect_Pack,
 184       Aspect_Persistent_BSS,                -- GNAT
 185       Aspect_Preelaborable_Initialization,
 186       Aspect_Pure_Function,                 -- GNAT
 187       Aspect_Remote_Access_Type,            -- GNAT
 188       Aspect_Shared,                        -- GNAT (equivalent to Atomic)
 189       Aspect_Simple_Storage_Pool_Type,      -- GNAT
 190       Aspect_Suppress_Debug_Info,           -- GNAT
 191       Aspect_Suppress_Initialization,       -- GNAT
 192       Aspect_Thread_Local_Storage,          -- GNAT
 193       Aspect_Unchecked_Union,
 194       Aspect_Universal_Aliasing,            -- GNAT
 195       Aspect_Unmodified,                    -- GNAT
 196       Aspect_Unreferenced,                  -- GNAT
 197       Aspect_Unreferenced_Objects,          -- GNAT
 198       Aspect_Volatile,
 199       Aspect_Volatile_Components);
 200
 201    subtype Aspect_Id_Exclude_No_Aspect is
 202      Aspect_Id range Aspect_Id'Succ (No_Aspect) .. Aspect_Id'Last;
 203    --  Aspect_Id's excluding No_Aspect
 204
 205    --  The following array indicates aspects that accept 'Class
 206
 207    Class_Aspect_OK : constant array (Aspect_Id) of Boolean :=
 208      (Aspect_Input          => True,
 209       Aspect_Invariant      => True,
 210       Aspect_Output         => True,
 211       Aspect_Pre            => True,
 212       Aspect_Predicate      => True,
 213       Aspect_Post           => True,
 214       Aspect_Read           => True,
 215       Aspect_Write          => True,
 216       Aspect_Type_Invariant => True,
 217       others                => False);
 218
 219    --  The following array identifies all implementation defined aspects
 220
 221    Implementation_Defined_Aspect : constant array (Aspect_Id) of Boolean :=
 222      (Aspect_Abstract_State           => True,
 223       Aspect_Annotate                 => True,
 224       Aspect_Async_Readers            => True,
 225       Aspect_Async_Writers            => True,
 226       Aspect_Contract_Cases           => True,
 227       Aspect_Depends                  => True,
 228       Aspect_Dimension                => True,
 229       Aspect_Dimension_System         => True,
 230       Aspect_Effective_Reads          => True,
 231       Aspect_Effective_Writes         => True,
 232       Aspect_Favor_Top_Level          => True,
 233       Aspect_Global                   => True,
 234       Aspect_Inline_Always            => True,
 235       Aspect_Invariant                => True,
 236       Aspect_Lock_Free                => True,
 237       Aspect_Object_Size              => True,
 238       Aspect_Persistent_BSS           => True,
 239       Aspect_Predicate                => True,
 240       Aspect_Pure_Function            => True,
 241       Aspect_Remote_Access_Type       => True,
 242       Aspect_Scalar_Storage_Order     => True,
 243       Aspect_Shared                   => True,
 244       Aspect_Simple_Storage_Pool      => True,
 245       Aspect_Simple_Storage_Pool_Type => True,
 246       Aspect_Suppress_Debug_Info      => True,
 247       Aspect_Suppress_Initialization  => True,
 248       Aspect_Thread_Local_Storage     => True,
 249       Aspect_Test_Case                => True,
 250       Aspect_Universal_Aliasing       => True,
 251       Aspect_Universal_Data           => True,
 252       Aspect_Unmodified               => True,
 253       Aspect_Unreferenced             => True,
 254       Aspect_Unreferenced_Objects     => True,
 255       Aspect_Value_Size               => True,
 256       Aspect_Warnings                 => True,
 257       others                          => False);
 258
 259    --  The following array indicates aspects for which multiple occurrences of
 260    --  the same aspect attached to the same declaration are allowed.
 261
 262    No_Duplicates_Allowed : constant array (Aspect_Id) of Boolean :=
 263      (Aspect_Annotate  => False,
 264       Aspect_Test_Case => False,
 265       others           => True);
 266
 267    --  The following subtype defines aspects corresponding to library unit
 268    --  pragmas, these can only validly appear as aspects for library units,
 269    --  and result in a corresponding pragma being inserted immediately after
 270    --  the occurrence of the aspect.
 271
 272    subtype Library_Unit_Aspects is
 273      Aspect_Id range Aspect_All_Calls_Remote .. Aspect_Universal_Data;
 274
 275    --  The following subtype defines aspects accepting an optional static
 276    --  boolean parameter indicating if the aspect should be active or
 277    --  cancelling. If the parameter is missing the effective value is True,
 278    --  enabling the aspect. If the parameter is present it must be a static
 279    --  expression of type Standard.Boolean. If the value is True, then the
 280    --  aspect is enabled. If it is False, the aspect is disabled.
 281
 282    subtype Boolean_Aspects is
 283      Aspect_Id range Aspect_Async_Readers .. Aspect_Id'Last;
 284
 285    subtype Pre_Post_Aspects is
 286      Aspect_Id range Aspect_Post .. Aspect_Precondition;
 287
 288    --  The following type is used for indicating allowed expression forms
 289
 290    type Aspect_Expression is
 291      (Expression,             -- Required expression
 292       Name,                   -- Required name
 293       Optional_Expression,    -- Optional boolean expression
 294       Optional_Name);         -- Optional name
 295
 296    --  The following array indicates what argument type is required
 297
 298    Aspect_Argument : constant array (Aspect_Id) of Aspect_Expression :=
 299      (No_Aspect                        => Optional_Expression,
 300       Aspect_Abstract_State            => Expression,
 301       Aspect_Address                   => Expression,
 302       Aspect_Alignment                 => Expression,
 303       Aspect_Annotate                  => Expression,
 304       Aspect_Attach_Handler            => Expression,
 305       Aspect_Bit_Order                 => Expression,
 306       Aspect_Component_Size            => Expression,
 307       Aspect_Constant_Indexing         => Name,
 308       Aspect_Contract_Cases            => Expression,
 309       Aspect_Convention                => Name,
 310       Aspect_CPU                       => Expression,
 311       Aspect_Default_Component_Value   => Expression,
 312       Aspect_Default_Initial_Condition => Optional_Expression,
 313       Aspect_Default_Iterator          => Name,
 314       Aspect_Default_Value             => Expression,
 315       Aspect_Depends                   => Expression,
 316       Aspect_Dimension                 => Expression,
 317       Aspect_Dimension_System          => Expression,
 318       Aspect_Dispatching_Domain        => Expression,
 319       Aspect_Dynamic_Predicate         => Expression,
 320       Aspect_External_Name             => Expression,
 321       Aspect_External_Tag              => Expression,
 322       Aspect_Global                    => Expression,
 323       Aspect_Implicit_Dereference      => Name,
 324       Aspect_Initial_Condition         => Expression,
 325       Aspect_Initializes               => Expression,
 326       Aspect_Input                     => Name,
 327       Aspect_Interrupt_Priority        => Expression,
 328       Aspect_Invariant                 => Expression,
 329       Aspect_Iterable                  => Expression,
 330       Aspect_Iterator_Element          => Name,
 331       Aspect_Link_Name                 => Expression,
 332       Aspect_Linker_Section            => Expression,
 333       Aspect_Machine_Radix             => Expression,
 334       Aspect_Object_Size               => Expression,
 335       Aspect_Obsolescent               => Optional_Expression,
 336       Aspect_Output                    => Name,
 337       Aspect_Part_Of                   => Expression,
 338       Aspect_Post                      => Expression,
 339       Aspect_Postcondition             => Expression,
 340       Aspect_Pre                       => Expression,
 341       Aspect_Precondition              => Expression,
 342       Aspect_Predicate                 => Expression,
 343       Aspect_Priority                  => Expression,
 344       Aspect_Read                      => Name,
 345       Aspect_Refined_Depends           => Expression,
 346       Aspect_Refined_Global            => Expression,
 347       Aspect_Refined_Post              => Expression,
 348       Aspect_Refined_State             => Expression,
 349       Aspect_Relative_Deadline         => Expression,
 350       Aspect_Scalar_Storage_Order      => Expression,
 351       Aspect_Simple_Storage_Pool       => Name,
 352       Aspect_Size                      => Expression,
 353       Aspect_Small                     => Expression,
 354       Aspect_SPARK_Mode                => Optional_Name,
 355       Aspect_Static_Predicate          => Expression,
 356       Aspect_Storage_Pool              => Name,
 357       Aspect_Storage_Size              => Expression,
 358       Aspect_Stream_Size               => Expression,
 359       Aspect_Suppress                  => Name,
 360       Aspect_Synchronization           => Name,
 361       Aspect_Test_Case                 => Expression,
 362       Aspect_Type_Invariant            => Expression,
 363       Aspect_Unsuppress                => Name,
 364       Aspect_Value_Size                => Expression,
 365       Aspect_Variable_Indexing         => Name,
 366       Aspect_Warnings                  => Name,
 367       Aspect_Write                     => Name,
 368
 369       Boolean_Aspects                  => Optional_Expression,
 370       Library_Unit_Aspects             => Optional_Expression);
 371
 372    -----------------------------------------
 373    -- Table Linking Names and Aspect_Id's --
 374    -----------------------------------------
 375
 376    --  Table linking aspect names and id's
 377
 378    Aspect_Names : constant array (Aspect_Id) of Name_Id :=
 379      (No_Aspect                           => No_Name,
 380       Aspect_Abstract_State               => Name_Abstract_State,
 381       Aspect_Address                      => Name_Address,
 382       Aspect_Alignment                    => Name_Alignment,
 383       Aspect_All_Calls_Remote             => Name_All_Calls_Remote,
 384       Aspect_Annotate                     => Name_Annotate,
 385       Aspect_Async_Readers                => Name_Async_Readers,
 386       Aspect_Async_Writers                => Name_Async_Writers,
 387       Aspect_Asynchronous                 => Name_Asynchronous,
 388       Aspect_Atomic                       => Name_Atomic,
 389       Aspect_Atomic_Components            => Name_Atomic_Components,
 390       Aspect_Attach_Handler               => Name_Attach_Handler,
 391       Aspect_Bit_Order                    => Name_Bit_Order,
 392       Aspect_Component_Size               => Name_Component_Size,
 393       Aspect_Constant_Indexing            => Name_Constant_Indexing,
 394       Aspect_Contract_Cases               => Name_Contract_Cases,
 395       Aspect_Convention                   => Name_Convention,
 396       Aspect_CPU                          => Name_CPU,
 397       Aspect_Default_Component_Value      => Name_Default_Component_Value,
 398       Aspect_Default_Initial_Condition    => Name_Default_Initial_Condition,
 399       Aspect_Default_Iterator             => Name_Default_Iterator,
 400       Aspect_Default_Value                => Name_Default_Value,
 401       Aspect_Depends                      => Name_Depends,
 402       Aspect_Dimension                    => Name_Dimension,
 403       Aspect_Dimension_System             => Name_Dimension_System,
 404       Aspect_Discard_Names                => Name_Discard_Names,
 405       Aspect_Dispatching_Domain           => Name_Dispatching_Domain,
 406       Aspect_Dynamic_Predicate            => Name_Dynamic_Predicate,
 407       Aspect_Effective_Reads              => Name_Effective_Reads,
 408       Aspect_Effective_Writes             => Name_Effective_Writes,
 409       Aspect_Elaborate_Body               => Name_Elaborate_Body,
 410       Aspect_External_Name                => Name_External_Name,
 411       Aspect_External_Tag                 => Name_External_Tag,
 412       Aspect_Export                       => Name_Export,
 413       Aspect_Favor_Top_Level              => Name_Favor_Top_Level,
 414       Aspect_Global                       => Name_Global,
 415       Aspect_Implicit_Dereference         => Name_Implicit_Dereference,
 416       Aspect_Import                       => Name_Import,
 417       Aspect_Independent                  => Name_Independent,
 418       Aspect_Independent_Components       => Name_Independent_Components,
 419       Aspect_Inline                       => Name_Inline,
 420       Aspect_Inline_Always                => Name_Inline_Always,
 421       Aspect_Initial_Condition            => Name_Initial_Condition,
 422       Aspect_Initializes                  => Name_Initializes,
 423       Aspect_Input                        => Name_Input,
 424       Aspect_Interrupt_Handler            => Name_Interrupt_Handler,
 425       Aspect_Interrupt_Priority           => Name_Interrupt_Priority,
 426       Aspect_Invariant                    => Name_Invariant,
 427       Aspect_Iterator_Element             => Name_Iterator_Element,
 428       Aspect_Iterable                     => Name_Iterable,
 429       Aspect_Link_Name                    => Name_Link_Name,
 430       Aspect_Linker_Section               => Name_Linker_Section,
 431       Aspect_Lock_Free                    => Name_Lock_Free,
 432       Aspect_Machine_Radix                => Name_Machine_Radix,
 433       Aspect_No_Elaboration_Code_All      => Name_No_Elaboration_Code_All,
 434       Aspect_No_Return                    => Name_No_Return,
 435       Aspect_Object_Size                  => Name_Object_Size,
 436       Aspect_Obsolescent                  => Name_Obsolescent,
 437       Aspect_Output                       => Name_Output,
 438       Aspect_Pack                         => Name_Pack,
 439       Aspect_Part_Of                      => Name_Part_Of,
 440       Aspect_Persistent_BSS               => Name_Persistent_BSS,
 441       Aspect_Post                         => Name_Post,
 442       Aspect_Postcondition                => Name_Postcondition,
 443       Aspect_Pre                          => Name_Pre,
 444       Aspect_Precondition                 => Name_Precondition,
 445       Aspect_Predicate                    => Name_Predicate,
 446       Aspect_Preelaborable_Initialization => Name_Preelaborable_Initialization,
 447       Aspect_Preelaborate                 => Name_Preelaborate,
 448       Aspect_Priority                     => Name_Priority,
 449       Aspect_Pure                         => Name_Pure,
 450       Aspect_Pure_Function                => Name_Pure_Function,
 451       Aspect_Read                         => Name_Read,
 452       Aspect_Refined_Depends              => Name_Refined_Depends,
 453       Aspect_Refined_Global               => Name_Refined_Global,
 454       Aspect_Refined_Post                 => Name_Refined_Post,
 455       Aspect_Refined_State                => Name_Refined_State,
 456       Aspect_Relative_Deadline            => Name_Relative_Deadline,
 457       Aspect_Remote_Access_Type           => Name_Remote_Access_Type,
 458       Aspect_Remote_Call_Interface        => Name_Remote_Call_Interface,
 459       Aspect_Remote_Types                 => Name_Remote_Types,
 460       Aspect_Scalar_Storage_Order         => Name_Scalar_Storage_Order,
 461       Aspect_Shared                       => Name_Shared,
 462       Aspect_Shared_Passive               => Name_Shared_Passive,
 463       Aspect_Simple_Storage_Pool          => Name_Simple_Storage_Pool,
 464       Aspect_Simple_Storage_Pool_Type     => Name_Simple_Storage_Pool_Type,
 465       Aspect_Size                         => Name_Size,
 466       Aspect_Small                        => Name_Small,
 467       Aspect_SPARK_Mode                   => Name_SPARK_Mode,
 468       Aspect_Static_Predicate             => Name_Static_Predicate,
 469       Aspect_Storage_Pool                 => Name_Storage_Pool,
 470       Aspect_Storage_Size                 => Name_Storage_Size,
 471       Aspect_Stream_Size                  => Name_Stream_Size,
 472       Aspect_Suppress                     => Name_Suppress,
 473       Aspect_Suppress_Debug_Info          => Name_Suppress_Debug_Info,
 474       Aspect_Suppress_Initialization      => Name_Suppress_Initialization,
 475       Aspect_Thread_Local_Storage         => Name_Thread_Local_Storage,
 476       Aspect_Synchronization              => Name_Synchronization,
 477       Aspect_Test_Case                    => Name_Test_Case,
 478       Aspect_Type_Invariant               => Name_Type_Invariant,
 479       Aspect_Unchecked_Union              => Name_Unchecked_Union,
 480       Aspect_Universal_Aliasing           => Name_Universal_Aliasing,
 481       Aspect_Universal_Data               => Name_Universal_Data,
 482       Aspect_Unmodified                   => Name_Unmodified,
 483       Aspect_Unreferenced                 => Name_Unreferenced,
 484       Aspect_Unreferenced_Objects         => Name_Unreferenced_Objects,
 485       Aspect_Unsuppress                   => Name_Unsuppress,
 486       Aspect_Value_Size                   => Name_Value_Size,
 487       Aspect_Variable_Indexing            => Name_Variable_Indexing,
 488       Aspect_Volatile                     => Name_Volatile,
 489       Aspect_Volatile_Components          => Name_Volatile_Components,
 490       Aspect_Warnings                     => Name_Warnings,
 491       Aspect_Write                        => Name_Write);
 492
 493    function Get_Aspect_Id (Name : Name_Id) return Aspect_Id;
 494    pragma Inline (Get_Aspect_Id);
 495    --  Given a name Nam, returns the corresponding aspect id value. If the name
 496    --  does not match any aspect, then No_Aspect is returned as the result.
 497
 498    function Get_Aspect_Id (Aspect : Node_Id) return Aspect_Id;
 499    pragma Inline (Get_Aspect_Id);
 500    --  Given an aspect specification, return the corresponding aspect_id value.
 501    --  If the name does not match any aspect, return No_Aspect.
 502
 503    ------------------------------------
 504    -- Delaying Evaluation of Aspects --
 505    ------------------------------------
 506
 507    --  The RM requires that all language defined aspects taking an expression
 508    --  delay evaluation of the expression till the freeze point of the entity
 509    --  to which the aspect applies. This allows forward references, and is of
 510    --  use for example in connection with preconditions and postconditions
 511    --  where the requirement of making all references in contracts to local
 512    --  functions be backwards references would be onerous.
 513
 514    --  For consistency, even attributes like Size are delayed, so we can do:
 515
 516    --    type A is range 1 .. 10
 517    --      with Size => Not_Defined_Yet;
 518    --    ..
 519    --    Not_Defined_Yet : constant := 64;
 520
 521    --  Resulting in A having a size of 64, which gets set when A is frozen.
 522    --  Furthermore, we can have a situation like
 523
 524    --    type A is range 1 .. 10
 525    --      with Size => Not_Defined_Yet;
 526    --    ..
 527    --    type B is new A;
 528    --    ..
 529    --    Not_Defined_Yet : constant := 64;
 530
 531    --  where the Size of A is considered to have been previously specified at
 532    --  the point of derivation, even though the actual value of the size is
 533    --  not known yet, and in this example B inherits the size value of 64.
 534
 535    --  Our normal implementation model (prior to Ada 2012) was simply to copy
 536    --  inheritable attributes at the point of derivation. Then any subsequent
 537    --  representation items apply either to the parent type, not affecting the
 538    --  derived type, or to the derived type, not affecting the parent type.
 539
 540    --  To deal with the delayed aspect case, we use two flags. The first is
 541    --  set on the parent type if it has delayed representation aspects. This
 542    --  flag Has_Delayed_Rep_Aspects indicates that if we derive from this type
 543    --  we have to worry about making sure we inherit any delayed aspects. The
 544    --  second flag is set on a derived type: May_Have_Inherited_Rep_Aspects
 545    --  is set if the parent type has Has_Delayed_Rep_Aspects set.
 546
 547    --  When we freeze a derived type, if the May_Have_Inherited_Rep_Aspects
 548    --  flag is set, then we call Freeze.Inherit_Delayed_Rep_Aspects when
 549    --  the derived type is frozen, which deals with the necessary copying of
 550    --  information from the parent type, which must be frozen at that point
 551    --  (since freezing the derived type first freezes the parent type).
 552
 553    --  SPARK 2014 aspects do not follow the general delay mechanism as they
 554    --  act as annotations and cannot modify the attributes of their related
 555    --  constructs. To handle forward references in such aspects, the compiler
 556    --  delays the analysis of their respective pragmas by collecting them in
 557    --  N_Contract nodes. The pragmas are then analyzed at the end of the
 558    --  declarative region which contains the related construct. For details,
 559    --  see routines Analyze_xxx_In_Decl_Part.
 560
 561    --  The following shows which aspects are delayed. There are three cases:
 562
 563    type Delay_Type is
 564      (Always_Delay,
 565       --  This aspect is not a representation aspect that can be inherited and
 566       --  is always delayed, as required by the language definition.
 567
 568       Never_Delay,
 569       --  There are two cases. There are language defined aspects like
 570       --  Convention where the "expression" is simply an uninterpreted
 571       --  identifier, and there is no issue of evaluating it and thus no
 572       --  issue of delaying the evaluation. The second case is implementation
 573       --  defined aspects where we have decided that we don't want to allow
 574       --  delays (and for our own aspects we can do what we like).
 575
 576       Rep_Aspect);
 577       --  These are the cases of representation aspects that are in general
 578       --  delayed, and where there is a potential issue of derived types that
 579       --  inherit delayed representation values.
 580
 581    --  Note: even if this table indicates that an aspect is delayed, we never
 582    --  delay Boolean aspects that have a missing expression (taken as True),
 583    --  or expressions for delayed rep items that consist of an integer literal
 584    --  (most cases of Size etc. in practice), since in these cases we know we
 585    --  can get the value of the expression without delay. Note that we still
 586    --  need to delay Boolean aspects that are specifically set to True:
 587
 588    --     type R is array (0 .. 31) of Boolean
 589    --       with Pack => True;
 590    --     True : constant Boolean := False;
 591
 592    --  This is nonsense, but we need to make it work and result in R not
 593    --  being packed, and if we have something like:
 594
 595    --     type R is array (0 .. 31) of Boolean
 596    --       with Pack => True;
 597    --     RR : R;
 598    --     True : constant Boolean := False;
 599
 600    --  This is illegal because the visibility of True changes after the freeze
 601    --  point, which is not allowed, and we need the delay mechanism to properly
 602    --  diagnose this error.
 603
 604    Aspect_Delay : constant array (Aspect_Id) of Delay_Type :=
 605      (No_Aspect                           => Always_Delay,
 606       Aspect_Address                      => Always_Delay,
 607       Aspect_All_Calls_Remote             => Always_Delay,
 608       Aspect_Asynchronous                 => Always_Delay,
 609       Aspect_Attach_Handler               => Always_Delay,
 610       Aspect_Constant_Indexing            => Always_Delay,
 611       Aspect_CPU                          => Always_Delay,
 612       Aspect_Default_Iterator             => Always_Delay,
 613       Aspect_Default_Value                => Always_Delay,
 614       Aspect_Default_Component_Value      => Always_Delay,
 615       Aspect_Discard_Names                => Always_Delay,
 616       Aspect_Dispatching_Domain           => Always_Delay,
 617       Aspect_Dynamic_Predicate            => Always_Delay,
 618       Aspect_Elaborate_Body               => Always_Delay,
 619       Aspect_External_Name                => Always_Delay,
 620       Aspect_External_Tag                 => Always_Delay,
 621       Aspect_Export                       => Always_Delay,
 622       Aspect_Favor_Top_Level              => Always_Delay,
 623       Aspect_Implicit_Dereference         => Always_Delay,
 624       Aspect_Import                       => Always_Delay,
 625       Aspect_Independent                  => Always_Delay,
 626       Aspect_Independent_Components       => Always_Delay,
 627       Aspect_Inline                       => Always_Delay,
 628       Aspect_Inline_Always                => Always_Delay,
 629       Aspect_Input                        => Always_Delay,
 630       Aspect_Interrupt_Handler            => Always_Delay,
 631       Aspect_Interrupt_Priority           => Always_Delay,
 632       Aspect_Invariant                    => Always_Delay,
 633       Aspect_Iterable                     => Always_Delay,
 634       Aspect_Iterator_Element             => Always_Delay,
 635       Aspect_Link_Name                    => Always_Delay,
 636       Aspect_Linker_Section               => Always_Delay,
 637       Aspect_Lock_Free                    => Always_Delay,
 638       Aspect_No_Return                    => Always_Delay,
 639       Aspect_Output                       => Always_Delay,
 640       Aspect_Persistent_BSS               => Always_Delay,
 641       Aspect_Post                         => Always_Delay,
 642       Aspect_Postcondition                => Always_Delay,
 643       Aspect_Pre                          => Always_Delay,
 644       Aspect_Precondition                 => Always_Delay,
 645       Aspect_Predicate                    => Always_Delay,
 646       Aspect_Preelaborable_Initialization => Always_Delay,
 647       Aspect_Preelaborate                 => Always_Delay,
 648       Aspect_Priority                     => Always_Delay,
 649       Aspect_Pure                         => Always_Delay,
 650       Aspect_Pure_Function                => Always_Delay,
 651       Aspect_Read                         => Always_Delay,
 652       Aspect_Relative_Deadline            => Always_Delay,
 653       Aspect_Remote_Access_Type           => Always_Delay,
 654       Aspect_Remote_Call_Interface        => Always_Delay,
 655       Aspect_Remote_Types                 => Always_Delay,
 656       Aspect_Shared                       => Always_Delay,
 657       Aspect_Shared_Passive               => Always_Delay,
 658       Aspect_Simple_Storage_Pool          => Always_Delay,
 659       Aspect_Simple_Storage_Pool_Type     => Always_Delay,
 660       Aspect_Static_Predicate             => Always_Delay,
 661       Aspect_Storage_Pool                 => Always_Delay,
 662       Aspect_Stream_Size                  => Always_Delay,
 663       Aspect_Suppress                     => Always_Delay,
 664       Aspect_Suppress_Debug_Info          => Always_Delay,
 665       Aspect_Suppress_Initialization      => Always_Delay,
 666       Aspect_Thread_Local_Storage         => Always_Delay,
 667       Aspect_Type_Invariant               => Always_Delay,
 668       Aspect_Unchecked_Union              => Always_Delay,
 669       Aspect_Universal_Aliasing           => Always_Delay,
 670       Aspect_Universal_Data               => Always_Delay,
 671       Aspect_Unmodified                   => Always_Delay,
 672       Aspect_Unreferenced                 => Always_Delay,
 673       Aspect_Unreferenced_Objects         => Always_Delay,
 674       Aspect_Unsuppress                   => Always_Delay,
 675       Aspect_Variable_Indexing            => Always_Delay,
 676       Aspect_Write                        => Always_Delay,
 677
 678       Aspect_Abstract_State               => Never_Delay,
 679       Aspect_Annotate                     => Never_Delay,
 680       Aspect_Async_Readers                => Never_Delay,
 681       Aspect_Async_Writers                => Never_Delay,
 682       Aspect_Contract_Cases               => Never_Delay,
 683       Aspect_Convention                   => Never_Delay,
 684       Aspect_Default_Initial_Condition    => Never_Delay,
 685       Aspect_Depends                      => Never_Delay,
 686       Aspect_Dimension                    => Never_Delay,
 687       Aspect_Dimension_System             => Never_Delay,
 688       Aspect_Effective_Reads              => Never_Delay,
 689       Aspect_Effective_Writes             => Never_Delay,
 690       Aspect_Global                       => Never_Delay,
 691       Aspect_Initial_Condition            => Never_Delay,
 692       Aspect_Initializes                  => Never_Delay,
 693       Aspect_No_Elaboration_Code_All      => Never_Delay,
 694       Aspect_Obsolescent                  => Never_Delay,
 695       Aspect_Part_Of                      => Never_Delay,
 696       Aspect_Refined_Depends              => Never_Delay,
 697       Aspect_Refined_Global               => Never_Delay,
 698       Aspect_Refined_Post                 => Never_Delay,
 699       Aspect_Refined_State                => Never_Delay,
 700       Aspect_SPARK_Mode                   => Never_Delay,
 701       Aspect_Synchronization              => Never_Delay,
 702       Aspect_Test_Case                    => Never_Delay,
 703       Aspect_Warnings                     => Never_Delay,
 704
 705       Aspect_Alignment                    => Rep_Aspect,
 706       Aspect_Atomic                       => Rep_Aspect,
 707       Aspect_Atomic_Components            => Rep_Aspect,
 708       Aspect_Bit_Order                    => Rep_Aspect,
 709       Aspect_Component_Size               => Rep_Aspect,
 710       Aspect_Machine_Radix                => Rep_Aspect,
 711       Aspect_Object_Size                  => Rep_Aspect,
 712       Aspect_Pack                         => Rep_Aspect,
 713       Aspect_Scalar_Storage_Order         => Rep_Aspect,
 714       Aspect_Size                         => Rep_Aspect,
 715       Aspect_Small                        => Rep_Aspect,
 716       Aspect_Storage_Size                 => Rep_Aspect,
 717       Aspect_Value_Size                   => Rep_Aspect,
 718       Aspect_Volatile                     => Rep_Aspect,
 719       Aspect_Volatile_Components          => Rep_Aspect);
 720
 721    ------------------------------------------------
 722    -- Handling of Aspect Specifications on Stubs --
 723    ------------------------------------------------
 724
 725    --  Aspects that appear on the following stub nodes
 726
 727    --    N_Package_Body_Stub
 728    --    N_Protected_Body_Stub
 729    --    N_Subprogram_Body_Stub
 730    --    N_Task_Body_Stub
 731
 732    --  are treated as if they apply to the corresponding proper body. Their
 733    --  analysis is postponed until the analysis of the proper body takes place
 734    --  (see Analyze_Proper_Body). The delay is required because the analysis
 735    --  may generate extra code which would be harder to relocate to the body.
 736    --  If the proper body is present, the aspect specifications are relocated
 737    --  to the corresponding body node:
 738
 739    --    N_Package_Body
 740    --    N_Protected_Body
 741    --    N_Subprogram_Body
 742    --    N_Task_Body
 743
 744    --  The subsequent analysis takes care of the aspect-to-pragma conversions
 745    --  and verification of pragma legality. In the case where the proper body
 746    --  is not available, the aspect specifications are analyzed on the spot
 747    --  (see Analyze_Proper_Body) to catch potential errors.
 748
 749    --  The following table lists all aspects that can apply to a subprogram
 750    --  body [stub]. For instance, the following example is legal:
 751
 752    --    package P with SPARK_Mode ...;
 753    --    package body P with SPARK_Mode is ...;
 754
 755    --  The table should be synchronized with Pragma_On_Body_Or_Stub_OK in unit
 756    --  Sem_Prag if the aspects below are implemented by a pragma.
 757
 758    Aspect_On_Body_Or_Stub_OK : constant array (Aspect_Id) of Boolean :=
 759      (Aspect_Refined_Depends              => True,
 760       Aspect_Refined_Global               => True,
 761       Aspect_Refined_Post                 => True,
 762       Aspect_SPARK_Mode                   => True,
 763       Aspect_Warnings                     => True,
 764       others                              => False);
 765
 766    ---------------------------------------------------
 767    -- Handling of Aspect Specifications in the Tree --
 768    ---------------------------------------------------
 769
 770    --  Several kinds of declaration node permit aspect specifications in Ada
 771    --  2012 mode. If there was room in all the corresponding declaration nodes,
 772    --  we could just have a field Aspect_Specifications pointing to a list of
 773    --  nodes for the aspects (N_Aspect_Specification nodes). But there isn't
 774    --  room, so we adopt a different approach.
 775
 776    --  The following subprograms provide access to a specialized interface
 777    --  implemented internally with a hash table in the body, that provides
 778    --  access to aspect specifications.
 779
 780    function Aspect_Specifications (N : Node_Id) return List_Id;
 781    --  Given a node N, returns the list of N_Aspect_Specification nodes that
 782    --  are attached to this declaration node. If the node is in the class of
 783    --  declaration nodes that permit aspect specifications, as defined by the
 784    --  predicate above, and if their Has_Aspects flag is set to True, then this
 785    --  will always be a non-empty list. If this flag is set to False, then
 786    --  No_List is returned. Normally, the only nodes that have Has_Aspects set
 787    --  True are the nodes for which Permits_Aspect_Specifications would return
 788    --  True (i.e. the declaration nodes defined in the RM as permitting the
 789    --  presence of Aspect_Specifications). However, it is possible for the
 790    --  flag Has_Aspects to be set on other nodes as a result of Rewrite and
 791    --  Replace calls, and this function may be used to retrieve the aspect
 792    --  specifications for the original rewritten node in such cases.
 793
 794    function Aspects_On_Body_Or_Stub_OK (N : Node_Id) return Boolean;
 795    --  N denotes a body [stub] with aspects. Determine whether all aspects of N
 796    --  are allowed to appear on a body [stub].
 797
 798    procedure Exchange_Aspects (N1 : Node_Id; N2 : Node_Id);
 799    --  Exchange the aspect specifications of two nodes. If either node lacks an
 800    --  aspect specification list, the routine has no effect. It is assumed that
 801    --  both nodes can support aspects.
 802
 803    function Find_Aspect (Id : Entity_Id; A : Aspect_Id) return Node_Id;
 804    --  Find the aspect specification of aspect A associated with entity I.
 805    --  Return Empty if Id does not have the requested aspect.
 806
 807    function Find_Value_Of_Aspect
 808      (Id : Entity_Id;
 809       A  : Aspect_Id) return Node_Id;
 810    --  Find the value of aspect A associated with entity Id. Return Empty if
 811    --  Id does not have the requested aspect.
 812
 813    function Has_Aspect (Id : Entity_Id; A : Aspect_Id) return Boolean;
 814    --  Determine whether entity Id has aspect A
 815
 816    procedure Move_Aspects (From : Node_Id; To : Node_Id);
 817    --  Relocate the aspect specifications of node From to node To. On entry it
 818    --  is assumed that To does not have aspect specifications. If From has no
 819    --  aspects, the routine has no effect.
 820
 821    procedure Move_Or_Merge_Aspects (From : Node_Id; To : Node_Id);
 822    --  Relocate the aspect specifications of node From to node To. If To has
 823    --  aspects, the aspects of From are added to the aspects of To. If From has
 824    --  no aspects, the routine has no effect. When From denotes a subprogram
 825    --  body stub that also acts as a spec, the only aspects relocated to node
 826    --  To are those from table Aspect_On_Body_Or_Stub_OK and preconditions.
 827
 828    function Permits_Aspect_Specifications (N : Node_Id) return Boolean;
 829    --  Returns True if the node N is a declaration node that permits aspect
 830    --  specifications in the grammar. It is possible for other nodes to have
 831    --  aspect specifications as a result of Rewrite or Replace calls.
 832
 833    procedure Remove_Aspects (N : Node_Id);
 834    --  Delete the aspect specifications associated with node N. If the node has
 835    --  no aspects, the routine has no effect.
 836
 837    function Same_Aspect (A1 : Aspect_Id; A2 : Aspect_Id) return Boolean;
 838    --  Returns True if A1 and A2 are (essentially) the same aspect. This is not
 839    --  a simple equality test because e.g. Post and Postcondition are the same.
 840    --  This is used for detecting duplicate aspects.
 841
 842    procedure Set_Aspect_Specifications (N : Node_Id; L : List_Id);
 843    --  The node N must be in the class of declaration nodes that permit aspect
 844    --  specifications and the Has_Aspects flag must be False on entry. L must
 845    --  be a non-empty list of N_Aspect_Specification nodes. This procedure sets
 846    --  the Has_Aspects flag to True, and makes an entry that can be retrieved
 847    --  by a subsequent Aspect_Specifications call. It is an error to call this
 848    --  procedure with a node that does not permit aspect specifications, or a
 849    --  node that has its Has_Aspects flag set True on entry, or with L being an
 850    --  empty list or No_List.
 851
 852    procedure Tree_Read;
 853    --  Reads contents of Aspect_Specifications hash table from the tree file
 854
 855    procedure Tree_Write;
 856    --  Writes contents of Aspect_Specifications hash table to the tree file
 857
 858 end Aspects;