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-2012, 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
29with Namet; use Namet;
30with Types; use Types;
31
32package Sem_Prag is
33
34   -----------------
35   -- Subprograms --
36   -----------------
37
38   procedure Analyze_Pragma (N : Node_Id);
39   --  Analyze procedure for pragma reference node N
40
41   procedure Analyze_CTC_In_Decl_Part (N : Node_Id; S : Entity_Id);
42   --  Special analyze routine for contract-case and test-case pragmas that
43   --  appears within a declarative part where the pragma is associated with
44   --  a subprogram specification. N is the pragma node, and S is the entity
45   --  for the related subprogram. This procedure does a preanalysis of the
46   --  expressions in the pragma as "spec expressions" (see section in Sem
47   --  "Handling of Default and Per-Object Expressions...").
48
49   procedure Analyze_PPC_In_Decl_Part (N : Node_Id; S : Entity_Id);
50   --  Special analyze routine for precondition/postcondition pragma that
51   --  appears within a declarative part where the pragma is associated
52   --  with a subprogram specification. N is the pragma node, and S is the
53   --  entity for the related subprogram. This procedure does a preanalysis
54   --  of the expressions in the pragma as "spec expressions" (see section
55   --  in Sem "Handling of Default and Per-Object Expressions...").
56
57   function Check_Disabled (Nam : Name_Id) return Boolean;
58   --  This function is used in connection with pragmas Assertion, Check,
59   --  Precondition, and Postcondition, to determine if Check pragmas (or
60   --  corresponding Assert, Precondition, or Postcondition pragmas) are
61   --  currently disabled (as set by a Check_Policy or Assertion_Policy pragma
62   --  with the Disable argument).
63
64   function Check_Enabled (Nam : Name_Id) return Boolean;
65   --  This function is used in connection with pragmas Assertion, Check,
66   --  Precondition, and Postcondition, to determine if Check pragmas (or
67   --  corresponding Assert, Precondition, or Postcondition pragmas) are
68   --  currently active, as determined by the presence of -gnata on the
69   --  command line (which sets the default), and the appearance of pragmas
70   --  Check_Policy and Assertion_Policy as configuration pragmas either in
71   --  a configuration pragma file, or at the start of the current unit.
72   --  True is returned if the specified check is enabled.
73
74   function Delay_Config_Pragma_Analyze (N : Node_Id) return Boolean;
75   --  N is a pragma appearing in a configuration pragma file. Most such
76   --  pragmas are analyzed when the file is read, before parsing and analyzing
77   --  the main unit. However, the analysis of certain pragmas results in
78   --  adding information to the compiled main unit, and this cannot be done
79   --  till the main unit is processed. Such pragmas return True from this
80   --  function and in Frontend pragmas where Delay_Config_Pragma_Analyze is
81   --  True have their analysis delayed until after the main program is parsed
82   --  and analyzed.
83
84   procedure Initialize;
85   --  Initializes data structures used for pragma processing. Must be called
86   --  before analyzing each new main source program.
87
88   function Is_Non_Significant_Pragma_Reference (N : Node_Id) return Boolean;
89   --  The node N is a node for an entity and the issue is whether the
90   --  occurrence is a reference for the purposes of giving warnings about
91   --  unreferenced variables. This function returns True if the reference is
92   --  not a reference from this point of view (e.g. the occurrence in a pragma
93   --  Pack) and False if it is a real reference (e.g. the occurrence in a
94   --  pragma Export);
95
96   function Is_Pragma_String_Literal (Par : Node_Id) return Boolean;
97   --  Given an N_Pragma_Argument_Association node, Par, which has the form of
98   --  an operator symbol, determines whether or not it should be treated as an
99   --  string literal. This is called by Sem_Ch6.Analyze_Operator_Symbol. If
100   --  True is returned, the argument is converted to a string literal. If
101   --  False is returned, then the argument is treated as an entity reference
102   --  to the operator.
103
104   function Is_Config_Static_String (Arg : Node_Id) return Boolean;
105   --  This is called for a configuration pragma that requires either string
106   --  literal or a concatenation of string literals. We cannot use normal
107   --  static string processing because it is too early in the case of the
108   --  pragma appearing in a configuration pragmas file. If Arg is of an
109   --  appropriate form, then this call obtains the string (doing any necessary
110   --  concatenations) and places it in Name_Buffer, setting Name_Len to its
111   --  length, and then returns True. If it is not of the correct form, then an
112   --  appropriate error message is posted, and False is returned.
113
114   procedure Make_Aspect_For_PPC_In_Gen_Sub_Decl (Decl : Node_Id);
115   --  This routine makes aspects from precondition or postcondition pragmas
116   --  that appear within a generic subprogram declaration. Decl is the generic
117   --  subprogram declaration node. Note that the aspects are attached to the
118   --  generic copy and also to the orginal tree.
119
120   procedure Process_Compilation_Unit_Pragmas (N : Node_Id);
121   --  Called at the start of processing compilation unit N to deal with any
122   --  special issues regarding pragmas. In particular, we have to deal with
123   --  Suppress_All at this stage, since it can appear after the unit instead
124   --  of before (actually we allow it to appear anywhere).
125
126   procedure Set_Encoded_Interface_Name (E : Entity_Id; S : Node_Id);
127   --  This routine is used to set an encoded interface name. The node S is an
128   --  N_String_Literal node for the external name to be set, and E is an
129   --  entity whose Interface_Name field is to be set. In the normal case where
130   --  S contains a name that is a valid C identifier, then S is simply set as
131   --  the value of the Interface_Name. Otherwise it is encoded. See the body
132   --  for details of the encoding. This encoding is only done on VMS systems,
133   --  since it seems pretty silly, but is needed to pass some dubious tests in
134   --  the test suite.
135
136end Sem_Prag;
137