gcc/ada/sem_prag.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             S E M _ P R A G                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2023, 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.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  Pragma handling is isolated in a separate package
  27 --  (logically this processing belongs in chapter 4)
  28
  29 with Namet;  use Namet;
  30 with Opt;    use Opt;
  31 with Snames; use Snames;
  32 with Types;  use Types;
  33
  34 package Sem_Prag is
  35
  36    --  The following table lists all pragmas that emulate an Ada 2012 aspect
  37
  38    Aspect_Specifying_Pragma : constant array (Pragma_Id) of Boolean :=
  39      (Pragma_Abstract_State               => True,
  40       Pragma_All_Calls_Remote             => True,
  41       Pragma_Always_Terminates            => True,
  42       Pragma_Annotate                     => True,
  43       Pragma_Async_Readers                => True,
  44       Pragma_Async_Writers                => True,
  45       Pragma_Asynchronous                 => True,
  46       Pragma_Atomic                       => True,
  47       Pragma_Atomic_Components            => True,
  48       Pragma_Attach_Handler               => True,
  49       Pragma_Constant_After_Elaboration   => True,
  50       Pragma_Contract_Cases               => True,
  51       Pragma_Convention                   => True,
  52       Pragma_CPU                          => True,
  53       Pragma_CUDA_Device                  => True,
  54       Pragma_CUDA_Global                  => True,
  55       Pragma_Default_Initial_Condition    => True,
  56       Pragma_Default_Storage_Pool         => True,
  57       Pragma_Depends                      => True,
  58       Pragma_Discard_Names                => True,
  59       Pragma_Dispatching_Domain           => True,
  60       Pragma_Effective_Reads              => True,
  61       Pragma_Effective_Writes             => True,
  62       Pragma_Elaborate_Body               => True,
  63       Pragma_Exceptional_Cases            => True,
  64       Pragma_Export                       => True,
  65       Pragma_Extensions_Visible           => True,
  66       Pragma_Favor_Top_Level              => True,
  67       Pragma_Ghost                        => True,
  68       Pragma_Global                       => True,
  69       Pragma_GNAT_Annotate                => True,
  70       Pragma_Import                       => True,
  71       Pragma_Independent                  => True,
  72       Pragma_Independent_Components       => True,
  73       Pragma_Initial_Condition            => True,
  74       Pragma_Initializes                  => True,
  75       Pragma_Inline                       => True,
  76       Pragma_Inline_Always                => True,
  77       Pragma_Interrupt_Handler            => True,
  78       Pragma_Interrupt_Priority           => True,
  79       Pragma_Invariant                    => True,
  80       Pragma_Linker_Section               => True,
  81       Pragma_Lock_Free                    => True,
  82       Pragma_No_Elaboration_Code_All      => True,
  83       Pragma_No_Return                    => True,
  84       Pragma_Obsolescent                  => True,
  85       Pragma_Pack                         => True,
  86       Pragma_Part_Of                      => True,
  87       Pragma_Persistent_BSS               => True,
  88       Pragma_Post                         => True,
  89       Pragma_Post_Class                   => True,
  90       Pragma_Postcondition                => True,
  91       Pragma_Pre                          => True,
  92       Pragma_Pre_Class                    => True,
  93       Pragma_Precondition                 => True,
  94       Pragma_Predicate                    => True,
  95       Pragma_Preelaborable_Initialization => True,
  96       Pragma_Preelaborate                 => True,
  97       Pragma_Priority                     => True,
  98       Pragma_Pure                         => True,
  99       Pragma_Pure_Function                => True,
 100       Pragma_Refined_Depends              => True,
 101       Pragma_Refined_Global               => True,
 102       Pragma_Refined_Post                 => True,
 103       Pragma_Refined_State                => True,
 104       Pragma_Relative_Deadline            => True,
 105       Pragma_Remote_Access_Type           => True,
 106       Pragma_Remote_Call_Interface        => True,
 107       Pragma_Remote_Types                 => True,
 108       Pragma_Secondary_Stack_Size         => True,
 109       Pragma_Shared                       => True,
 110       Pragma_Shared_Passive               => True,
 111       Pragma_Simple_Storage_Pool_Type     => True,
 112       Pragma_SPARK_Mode                   => True,
 113       Pragma_Storage_Size                 => True,
 114       Pragma_Subprogram_Variant           => True,
 115       Pragma_Suppress                     => True,
 116       Pragma_Suppress_Debug_Info          => True,
 117       Pragma_Suppress_Initialization      => True,
 118       Pragma_Test_Case                    => True,
 119       Pragma_Thread_Local_Storage         => True,
 120       Pragma_Type_Invariant               => True,
 121       Pragma_Unchecked_Union              => True,
 122       Pragma_Universal_Aliasing           => True,
 123       Pragma_Unmodified                   => True,
 124       Pragma_Unreferenced                 => True,
 125       Pragma_Unreferenced_Objects         => True,
 126       Pragma_Unsuppress                   => True,
 127       Pragma_Volatile                     => True,
 128       Pragma_Volatile_Components          => True,
 129       Pragma_Volatile_Full_Access         => True,
 130       Pragma_Warnings                     => True,
 131       others                              => False);
 132
 133    --  The following table lists all pragmas that act as an assertion
 134    --  expression.
 135
 136    Assertion_Expression_Pragma : constant array (Pragma_Id) of Boolean :=
 137      (Pragma_Always_Terminates         => True,
 138       Pragma_Assert                    => True,
 139       Pragma_Assert_And_Cut            => True,
 140       Pragma_Assume                    => True,
 141       Pragma_Check                     => True,
 142       Pragma_Compile_Time_Error        => True,
 143       Pragma_Contract_Cases            => True,
 144       Pragma_Default_Initial_Condition => True,
 145       Pragma_Exceptional_Cases         => True,
 146       Pragma_Initial_Condition         => True,
 147       Pragma_Invariant                 => True,
 148       Pragma_Loop_Invariant            => True,
 149       Pragma_Loop_Variant              => True,
 150       Pragma_Post                      => True,
 151       Pragma_Post_Class                => True,
 152       Pragma_Postcondition             => True,
 153       Pragma_Pre                       => True,
 154       Pragma_Pre_Class                 => True,
 155       Pragma_Precondition              => True,
 156       Pragma_Predicate                 => True,
 157       Pragma_Refined_Post              => True,
 158       Pragma_Subprogram_Variant        => True,
 159       Pragma_Test_Case                 => True,
 160       Pragma_Type_Invariant            => True,
 161       Pragma_Type_Invariant_Class      => True,
 162       others                           => False);
 163
 164    --  Should to following constant arrays be renamed to better suit their
 165    --  use as a predicate (e.g. Is_Pragma_*) ???
 166
 167    --  The following table lists all the implementation-defined pragmas that
 168    --  should apply to the anonymous object produced by the analysis of a
 169    --  single protected or task type. The table should be synchronized with
 170    --  Aspect_On_Anonymous_Object_OK in unit Aspects.
 171
 172    Pragma_On_Anonymous_Object_OK : constant array (Pragma_Id) of Boolean :=
 173      (Pragma_Depends => True,
 174       Pragma_Global  => True,
 175       Pragma_Part_Of => True,
 176       others         => False);
 177
 178    --  The following table lists all the implementation-defined pragmas that
 179    --  may apply to a body stub (no language defined pragmas apply). The table
 180    --  should be synchronized with Aspect_On_Body_Or_Stub_OK in unit Aspects.
 181
 182    Pragma_On_Body_Or_Stub_OK : constant array (Pragma_Id) of Boolean :=
 183      (Pragma_Refined_Depends => True,
 184       Pragma_Refined_Global  => True,
 185       Pragma_Refined_Post    => True,
 186       Pragma_SPARK_Mode      => True,
 187       Pragma_Warnings        => True,
 188       others                 => False);
 189
 190    --  The following table lists all pragmas which are significant in SPARK and
 191    --  as a result get translated into verification conditions. The table is an
 192    --  amalgamation of the pragmas listed in SPARK RM 16.1 and internally added
 193    --  entries.
 194
 195    Pragma_Significant_In_SPARK : constant array (Pragma_Id) of Boolean :=
 196      (Pragma_All_Calls_Remote              => False,
 197       Pragma_Asynchronous                  => False,
 198       Pragma_Default_Storage_Pool          => False,
 199       Pragma_Discard_Names                 => False,
 200       Pragma_Dispatching_Domain            => False,
 201       Pragma_Priority_Specific_Dispatching => False,
 202       Pragma_Remote_Call_Interface         => False,
 203       Pragma_Remote_Types                  => False,
 204       Pragma_Shared_Passive                => False,
 205       Pragma_Task_Dispatching_Policy       => False,
 206       Pragma_Unmodified                    => False,
 207       Pragma_Unreferenced                  => False,
 208       Pragma_Warnings                      => False,
 209       others                               => True);
 210
 211    --  The following table lists all pragmas which are relevant to the analysis
 212    --  of subprogram bodies.
 213
 214    Pragma_Significant_To_Subprograms : constant array (Pragma_Id) of Boolean :=
 215      (Pragma_Always_Terminates  => True,
 216       Pragma_Contract_Cases     => True,
 217       Pragma_Depends            => True,
 218       Pragma_Exceptional_Cases  => True,
 219       Pragma_Ghost              => True,
 220       Pragma_Global             => True,
 221       Pragma_Inline             => True,
 222       Pragma_Inline_Always      => True,
 223       Pragma_Post               => True,
 224       Pragma_Post_Class         => True,
 225       Pragma_Postcondition      => True,
 226       Pragma_Pre                => True,
 227       Pragma_Pre_Class          => True,
 228       Pragma_Precondition       => True,
 229       Pragma_Pure               => True,
 230       Pragma_Pure_Function      => True,
 231       Pragma_Refined_Depends    => True,
 232       Pragma_Refined_Global     => True,
 233       Pragma_Refined_Post       => True,
 234       Pragma_Refined_State      => True,
 235       Pragma_Subprogram_Variant => True,
 236       Pragma_Volatile           => True,
 237       Pragma_Volatile_Function  => True,
 238       others                    => False);
 239
 240    -----------------
 241    -- Subprograms --
 242    -----------------
 243
 244    procedure Analyze_Pragma (N : Node_Id);
 245    --  Analyze procedure for pragma reference node N
 246
 247    procedure Analyze_Always_Terminates_In_Decl_Part
 248      (N         : Node_Id;
 249       Freeze_Id : Entity_Id := Empty);
 250    --  Perform full analysis of delayed pragma Always_Terminates. Freeze_Id is
 251    --  the entity of [generic] package body or [generic] subprogram body which
 252    --  caused "freezing" of the related contract where the pragma resides.
 253
 254    procedure Analyze_Contract_Cases_In_Decl_Part
 255      (N         : Node_Id;
 256       Freeze_Id : Entity_Id := Empty);
 257    --  Perform full analysis of delayed pragma Contract_Cases. Freeze_Id is the
 258    --  entity of [generic] package body or [generic] subprogram body which
 259    --  caused "freezing" of the related contract where the pragma resides.
 260
 261    procedure Analyze_Depends_In_Decl_Part (N : Node_Id);
 262    --  Perform full analysis of delayed pragma Depends. This routine is also
 263    --  capable of performing basic analysis of pragma Refined_Depends.
 264
 265    procedure Analyze_Exceptional_Cases_In_Decl_Part
 266      (N         : Node_Id;
 267       Freeze_Id : Entity_Id := Empty);
 268    --  Perform full analysis of delayed pragma Exceptional_Cases. Freeze_Id is
 269    --  the entity of [generic] package body or [generic] subprogram body which
 270    --  caused "freezing" of the related contract where the pragma resides.
 271
 272    procedure Analyze_External_Property_In_Decl_Part
 273      (N        : Node_Id;
 274       Expr_Val : out Boolean);
 275    --  Perform full analysis of delayed pragmas Async_Readers, Async_Writers,
 276    --  Effective_Reads, Effective_Writes and No_Caching. Flag Expr_Val contains
 277    --  the Boolean argument of the pragma or a default True if no argument
 278    --  is present.
 279
 280    procedure Analyze_Global_In_Decl_Part (N : Node_Id);
 281    --  Perform full analysis of delayed pragma Global. This routine is also
 282    --  capable of performing basic analysis of pragma Refined_Global.
 283
 284    procedure Analyze_Initial_Condition_In_Decl_Part (N : Node_Id);
 285    --  Perform full analysis of delayed pragma Initial_Condition
 286
 287    procedure Analyze_Initializes_In_Decl_Part (N : Node_Id);
 288    --  Perform full analysis of delayed pragma Initializes
 289
 290    procedure Analyze_Part_Of_In_Decl_Part
 291      (N         : Node_Id;
 292       Freeze_Id : Entity_Id := Empty);
 293    --  Perform full analysis of delayed pragma Part_Of. Freeze_Id is the entity
 294    --  of [generic] package body or [generic] subprogram body which caused the
 295    --  "freezing" of the related contract where the pragma resides.
 296
 297    procedure Analyze_Pre_Post_Condition_In_Decl_Part
 298      (N         : Node_Id;
 299       Freeze_Id : Entity_Id := Empty);
 300    --  Perform full analysis of pragmas Precondition and Postcondition.
 301    --  Freeze_Id denotes the entity of [generic] package body or [generic]
 302    --  subprogram body which caused "freezing" of the related contract where
 303    --  the pragma resides.
 304
 305    procedure Analyze_Refined_Depends_In_Decl_Part (N : Node_Id);
 306    --  Preform full analysis of delayed pragma Refined_Depends. This routine
 307    --  uses Analyze_Depends_In_Decl_Part as a starting point, then performs
 308    --  various consistency checks between Depends and Refined_Depends.
 309
 310    procedure Analyze_Refined_Global_In_Decl_Part (N : Node_Id);
 311    --  Perform full analysis of delayed pragma Refined_Global. This routine
 312    --  uses Analyze_Global_In_Decl_Part as a starting point, then performs
 313    --  various consistency checks between Global and Refined_Global.
 314
 315    procedure Analyze_Refined_State_In_Decl_Part
 316      (N         : Node_Id;
 317       Freeze_Id : Entity_Id := Empty);
 318    --  Perform full analysis of delayed pragma Refined_State. Freeze_Id denotes
 319    --  the entity of [generic] package body or [generic] subprogram body which
 320    --  caused "freezing" of the related contract where the pragma resides.
 321
 322    procedure Analyze_Subprogram_Variant_In_Decl_Part
 323      (N         : Node_Id;
 324       Freeze_Id : Entity_Id := Empty);
 325    --  Perform full analysis of delayed pragma Subprogram_Variant. Freeze_Id is
 326    --  the entity of [generic] package body or [generic] subprogram body which
 327    --  caused "freezing" of the related contract where the pragma resides.
 328
 329    procedure Analyze_Test_Case_In_Decl_Part (N : Node_Id);
 330    --  Perform preanalysis of pragma Test_Case
 331
 332    function Build_Pragma_Check_Equivalent
 333      (Prag           : Node_Id;
 334       Subp_Id        : Entity_Id := Empty;
 335       Inher_Id       : Entity_Id := Empty;
 336       Keep_Pragma_Id : Boolean := False) return Node_Id;
 337    --  Transform a pre- or [refined] postcondition denoted by Prag into an
 338    --  equivalent pragma Check. When the pre- or postcondition is inherited,
 339    --  the routine replaces the references of all formals of Inher_Id
 340    --  and primitive operations of its controlling type by references
 341    --  to the corresponding entities of Subp_Id and the descendant type.
 342    --  Keep_Pragma_Id is True when the newly created pragma should be
 343    --  in fact of the same kind as the source pragma Prag. This is used
 344    --  in GNATprove_Mode to generate the inherited pre- and postconditions.
 345
 346    procedure Check_Applicable_Policy (N : Node_Id);
 347    --  N is either an N_Aspect or an N_Pragma node. There are two cases. If
 348    --  the name of the aspect or pragma is not one of those recognized as
 349    --  an assertion kind by an Assertion_Policy pragma, then the call has
 350    --  no effect. Note that in the case of a pragma derived from an aspect,
 351    --  the name we use for the purpose of this procedure is the aspect name,
 352    --  which may be different from the pragma name (e.g. Precondition for
 353    --  Pre aspect). In addition, 'Class aspects are recognized (and the
 354    --  corresponding special names used in the processing).
 355    --
 356    --  If the name is a valid assertion kind name, then the Check_Policy pragma
 357    --  chain is checked for a matching entry (or for an Assertion entry which
 358    --  matches all possibilities). If a matching entry is found then the policy
 359    --  is checked. If it is On or Check, then the Is_Checked flag is set in
 360    --  the aspect or pragma node. If it is Off, Ignore, or Disable, then the
 361    --  Is_Ignored flag is set in the aspect or pragma node. Additionally for
 362    --  policy Disable, the Is_Disabled flag is set.
 363    --
 364    --  If no matching Check_Policy pragma is found then the effect depends on
 365    --  whether -gnata was used, if so, then the call has no effect, otherwise
 366    --  Is_Ignored (but not Is_Disabled) is set True.
 367
 368    procedure Check_External_Properties
 369      (Item : Node_Id;
 370       AR   : Boolean;
 371       AW   : Boolean;
 372       ER   : Boolean;
 373       EW   : Boolean);
 374    --  Flags AR, AW, ER and EW denote the static values of external properties
 375    --  Async_Readers, Async_Writers, Effective_Reads and Effective_Writes. Item
 376    --  is the related variable or state. Ensure legality of the combination and
 377    --  issue an error for an illegal combination.
 378
 379    function Check_Kind (Nam : Name_Id) return Name_Id;
 380    --  This function is used in connection with pragmas Assert, Check,
 381    --  and assertion aspects and pragmas, to determine if Check pragmas
 382    --  (or corresponding assertion aspects or pragmas) are currently active
 383    --  as determined by the presence of -gnata on the command line (which
 384    --  sets the default), and the appearance of pragmas Check_Policy and
 385    --  Assertion_Policy as configuration pragmas either in a configuration
 386    --  pragma file, or at the start of the current unit, or locally given
 387    --  Check_Policy and Assertion_Policy pragmas that are currently active.
 388    --
 389    --  The value returned is one of the names Check, Ignore, Disable (On
 390    --  returns Check, and Off returns Ignore).
 391    --
 392    --  Note: for assertion kinds Pre'Class, Post'Class, Invariant'Class,
 393    --  and Type_Invariant'Class, the name passed is Name_uPre, Name_uPost,
 394    --  Name_uInvariant, or Name_uType_Invariant, which corresponds to _Pre,
 395    --  _Post, _Invariant, or _Type_Invariant, which are special names used
 396    --  in identifiers to represent these attribute references.
 397
 398    procedure Check_Missing_Part_Of (Item_Id : Entity_Id);
 399    --  Determine whether the placement within the state space of an abstract
 400    --  state, variable or package instantiation denoted by Item_Id requires the
 401    --  use of indicator/option Part_Of. If this is the case, emit an error.
 402
 403    procedure Collect_Inherited_Class_Wide_Conditions (Subp : Entity_Id);
 404    --  In GNATprove mode, when analyzing an overriding subprogram, check
 405    --  whether the overridden operations have class-wide pre/postconditions,
 406    --  and generate the corresponding pragmas. The pragmas are inserted after
 407    --  the subprogram declaration, together with those generated for other
 408    --  aspects of the subprogram.
 409
 410    procedure Collect_Subprogram_Inputs_Outputs
 411      (Subp_Id      : Entity_Id;
 412       Synthesize   : Boolean := False;
 413       Subp_Inputs  : in out Elist_Id;
 414       Subp_Outputs : in out Elist_Id;
 415       Global_Seen  : out Boolean);
 416    --  Subsidiary to the analysis of pragmas Depends, Global, Refined_Depends
 417    --  and Refined_Global. Collect all inputs and outputs of subprogram Subp_Id
 418    --  in lists Subp_Inputs (inputs) and Subp_Outputs (outputs). The inputs and
 419    --  outputs are gathered from:
 420    --    1) The formal parameters of the subprogram
 421    --    2) The generic formal parameters of the generic subprogram
 422    --    3) The current instance of a concurrent type
 423    --    4) The items of pragma [Refined_]Global
 424    --         or
 425    --    5) The items of pragma [Refined_]Depends if there is no pragma
 426    --       [Refined_]Global present and flag Synthesize is set to True.
 427    --  If the subprogram has no inputs and/or outputs, then the returned list
 428    --  is No_Elist. Flag Global_Seen is set when the related subprogram has
 429    --  pragma [Refined_]Global.
 430
 431    function Delay_Config_Pragma_Analyze (N : Node_Id) return Boolean;
 432    --  N is a pragma appearing in a configuration pragma file. Most such
 433    --  pragmas are analyzed when the file is read, before parsing and analyzing
 434    --  the main unit. However, the analysis of certain pragmas results in
 435    --  adding information to the compiled main unit, and this cannot be done
 436    --  till the main unit is processed. Such pragmas return True from this
 437    --  function and in Frontend pragmas where Delay_Config_Pragma_Analyze is
 438    --  True have their analysis delayed until after the main program is parsed
 439    --  and analyzed.
 440
 441    function Find_Related_Package_Or_Body
 442      (Prag      : Node_Id;
 443       Do_Checks : Boolean := False) return Node_Id;
 444    --  Subsidiary to the analysis of pragmas
 445    --    Abstract_State
 446    --    Initial_Condition
 447    --    Initializes
 448    --    Refined_State
 449    --  Find the declaration of the related package [body] subject to pragma
 450    --  Prag. The return value is either N_Package_Declaration, N_Package_Body,
 451    --  or Empty if the placement of the pragma is illegal. If flag Do_Checks is
 452    --  set, the routine reports duplicate pragmas.
 453
 454    function Find_Related_Declaration_Or_Body
 455      (Prag      : Node_Id;
 456       Do_Checks : Boolean := False) return Node_Id;
 457    --  Subsidiary to the analysis of pragmas
 458    --    Always_Terminates
 459    --    Contract_Cases
 460    --    Depends
 461    --    Exceptional_Cases
 462    --    Extensions_Visible
 463    --    Global
 464    --    Initializes
 465    --    Max_Entry_Queue_Depth
 466    --    Max_Entry_Queue_Length
 467    --    Max_Queue_Length
 468    --    Post
 469    --    Post_Class
 470    --    Postcondition
 471    --    Pre
 472    --    Pre_Class
 473    --    Precondition
 474    --    Refined_Depends
 475    --    Refined_Global
 476    --    Refined_Post
 477    --    Refined_State
 478    --    Subprogram_Variant
 479    --    Test_Case
 480    --    Volatile_Function
 481    --  as well as attributes 'Old and 'Result. Find the declaration of the
 482    --  related entry, subprogram or task type [body] subject to pragma Prag.
 483    --  If flag Do_Checks is set, the routine reports duplicate pragmas and
 484    --  detects improper use of refinement pragmas in stand alone expression
 485    --  functions.
 486
 487    function Get_Argument
 488      (Prag       : Node_Id;
 489       Context_Id : Entity_Id := Empty) return Node_Id;
 490    --  Obtain the argument of pragma Prag depending on context and the nature
 491    --  of the pragma. The argument is extracted in the following manner:
 492    --
 493    --    When the pragma is generated from an aspect, return the corresponding
 494    --    aspect when Context_Id denotes a generic unit.
 495    --
 496    --    Otherwise return the first argument of Prag
 497    --
 498    --  Context denotes the entity of the function, package or procedure where
 499    --  Prag resides.
 500
 501    function Get_SPARK_Mode_From_Annotation
 502      (N : Node_Id) return SPARK_Mode_Type;
 503    --  Given an aspect or pragma SPARK_Mode node, return corresponding mode id
 504
 505    procedure Initialize;
 506    --  Initializes data structures used for pragma processing. Must be called
 507    --  before analyzing each new main source program.
 508
 509    function Is_Config_Static_String (Arg : Node_Id) return Boolean;
 510    --  This is called for a configuration pragma that requires either string
 511    --  literal or a concatenation of string literals. We cannot use normal
 512    --  static string processing because it is too early in the case of the
 513    --  pragma appearing in a configuration pragmas file. If Arg is of an
 514    --  appropriate form, then this call obtains the string (doing any necessary
 515    --  concatenations) and places it in Name_Buffer, setting Name_Len to its
 516    --  length, and then returns True. If it is not of the correct form, then an
 517    --  appropriate error message is posted, and False is returned.
 518
 519    function Is_Elaboration_SPARK_Mode (N : Node_Id) return Boolean;
 520    --  Determine whether pragma SPARK_Mode appears in the statement part of a
 521    --  package body.
 522
 523    function Is_Enabled_Pragma (Prag : Node_Id) return Boolean;
 524    --  Determine whether a Boolean-like SPARK pragma Prag is enabled. To be
 525    --  considered enabled, the pragma must either:
 526    --    * Appear without its Boolean expression
 527    --    * The Boolean expression evaluates to "True"
 528    --
 529    --  Boolean-like SPARK pragmas differ from pure Boolean Ada pragmas in that
 530    --  their optional Boolean expression must be static and cannot benefit from
 531    --  forward references. The following are Boolean-like SPARK pragmas:
 532    --    Async_Readers
 533    --    Async_Writers
 534    --    Constant_After_Elaboration
 535    --    Effective_Reads
 536    --    Effective_Writes
 537    --    Extensions_Visible
 538    --    Volatile_Function
 539
 540    function Is_Non_Significant_Pragma_Reference (N : Node_Id) return Boolean;
 541    --  The node N is a node for an entity and the issue is whether the
 542    --  occurrence is a reference for the purposes of giving warnings about
 543    --  unreferenced variables. This function returns True if the reference is
 544    --  not a reference from this point of view (e.g. the occurrence in a pragma
 545    --  Pack) and False if it is a real reference (e.g. the occurrence in a
 546    --  pragma Export);
 547
 548    function Is_Pragma_String_Literal (Par : Node_Id) return Boolean;
 549    --  Given an N_Pragma_Argument_Association node, Par, which has the form of
 550    --  an operator symbol, determines whether or not it should be treated as an
 551    --  string literal. This is called by Sem_Ch6.Analyze_Operator_Symbol. If
 552    --  True is returned, the argument is converted to a string literal. If
 553    --  False is returned, then the argument is treated as an entity reference
 554    --  to the operator.
 555
 556    function Is_Private_SPARK_Mode (N : Node_Id) return Boolean;
 557    --  Determine whether pragma SPARK_Mode appears in the private part of a
 558    --  package.
 559
 560    function Is_Valid_Assertion_Kind (Nam : Name_Id) return Boolean;
 561    --  Returns True if Nam is one of the names recognized as a valid assertion
 562    --  kind by the Assertion_Policy pragma. Note that the 'Class cases are
 563    --  represented by the corresponding special names Name_uPre, Name_uPost,
 564    --  Name_uInvariant, and Name_uType_Invariant (_Pre, _Post, _Invariant,
 565    --  and _Type_Invariant).
 566
 567    procedure Process_Compilation_Unit_Pragmas (N : Node_Id);
 568    --  Called at the start of processing compilation unit N to deal with any
 569    --  special issues regarding pragmas. In particular, we have to deal with
 570    --  Suppress_All at this stage, since it can appear after the unit instead
 571    --  of before (actually we allow it to appear anywhere).
 572
 573    procedure Relocate_Pragmas_To_Anonymous_Object
 574      (Typ_Decl : Node_Id;
 575       Obj_Decl : Node_Id);
 576    --  Relocate all pragmas that appear in the visible declarations of task or
 577    --  protected type declaration Typ_Decl after the declaration of anonymous
 578    --  object Obj_Decl. Table Pragmas_On_Anonymous_Object_OK contains the list
 579    --  of candidate pragmas.
 580
 581    procedure Relocate_Pragmas_To_Body
 582      (Subp_Body   : Node_Id;
 583       Target_Body : Node_Id := Empty);
 584    --  Resocate all pragmas that follow and apply to subprogram body Subp_Body
 585    --  to its own declaration list. Candidate pragmas are classified in table
 586    --  Pragma_On_Body_Or_Stub_OK. If Target_Body is set, the pragma are moved
 587    --  to the declarations of Target_Body. This formal should be set when
 588    --  dealing with subprogram body stubs or expression functions.
 589
 590    procedure Set_Encoded_Interface_Name (E : Entity_Id; S : Node_Id);
 591    --  This routine is used to set an encoded interface name. The node S is
 592    --  an N_String_Literal node for the external name to be set, and E is an
 593    --  entity whose Interface_Name field is to be set. In the normal case where
 594    --  S contains a name that is a valid C identifier, then S is simply set as
 595    --  the value of the Interface_Name. Otherwise it is encoded as needed by
 596    --  particular operating systems. See the body for details of the encoding.
 597
 598    procedure Set_Overflow_Mode (N : Node_Id);
 599    --  Sets Sem.Scope_Suppress according to the overflow modes specified in
 600    --  the pragma Overflow_Mode passed in argument. This should only be called
 601    --  after N has been successfully analyzed.
 602
 603    function Test_Case_Arg
 604      (Prag        : Node_Id;
 605       Arg_Nam     : Name_Id;
 606       From_Aspect : Boolean := False) return Node_Id;
 607    --  Obtain argument "Name", "Mode", "Ensures" or "Requires" from Test_Case
 608    --  pragma Prag as denoted by Arg_Nam. When From_Aspect is set, an attempt
 609    --  is made to retrieve the argument from the corresponding aspect if there
 610    --  is one. The returned argument has several formats:
 611    --
 612    --    N_Pragma_Argument_Association if retrieved directly from the pragma
 613    --
 614    --    N_Component_Association if retrieved from the corresponding aspect and
 615    --    the argument appears in a named association form.
 616    --
 617    --    An arbitrary expression if retrieved from the corresponding aspect and
 618    --    the argument appears in positional form.
 619    --
 620    --    Empty if there is no such argument
 621
 622    procedure Validate_Compile_Time_Warning_Errors;
 623    --  This routine is called after calling the back end to validate pragmas
 624    --  Compile_Time_Error and Compile_Time_Warning for size and alignment
 625    --  appropriateness. The reason it is called that late is to take advantage
 626    --  of any back-annotation of size and alignment performed by the back end.
 627
 628 end Sem_Prag;