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