OSDN Git Service

* gcc-interface/Make-lang.in: Update dependencies.
[pf3gnuchains/gcc-fork.git] / gcc / ada / sem_ch3.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                              S E M _ C H 3                               --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2009, 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 with Nlists; use Nlists;
27 with Types;  use Types;
28
29 package Sem_Ch3 is
30    procedure Analyze_Component_Declaration         (N : Node_Id);
31    procedure Analyze_Incomplete_Type_Decl          (N : Node_Id);
32    procedure Analyze_Itype_Reference               (N : Node_Id);
33    procedure Analyze_Number_Declaration            (N : Node_Id);
34    procedure Analyze_Object_Declaration            (N : Node_Id);
35    procedure Analyze_Others_Choice                 (N : Node_Id);
36    procedure Analyze_Private_Extension_Declaration (N : Node_Id);
37    procedure Analyze_Subtype_Indication            (N : Node_Id);
38    procedure Analyze_Type_Declaration              (N : Node_Id);
39    procedure Analyze_Variant_Part                  (N : Node_Id);
40
41    procedure Analyze_Subtype_Declaration
42      (N    : Node_Id;
43       Skip : Boolean := False);
44    --  Called to analyze a subtype declaration. The parameter Skip is used for
45    --  Ada 2005 (AI-412). We set to True in order to avoid reentering the
46    --  defining identifier of N when analyzing a rewritten incomplete subtype
47    --  declaration.
48
49    function Access_Definition
50      (Related_Nod : Node_Id;
51       N           : Node_Id) return Entity_Id;
52    --  An access definition defines a general access type for a formal
53    --  parameter. The procedure is called when processing formals, when
54    --  the current scope is the subprogram. The Implicit type is attached
55    --  to the Related_Nod put into the enclosing scope, so that the only
56    --  entities defined in the spec are the formals themselves.
57
58    procedure Access_Subprogram_Declaration
59      (T_Name : Entity_Id;
60       T_Def  : Node_Id);
61    --  The subprogram specification yields the signature of an implicit
62    --  type, whose Ekind is Access_Subprogram_Type. This implicit type is
63    --  the designated type of the declared access type. In subprogram calls,
64    --  the signature of the implicit type works like the profile of a regular
65    --  subprogram.
66
67    procedure Analyze_Declarations (L : List_Id);
68    --  Called to analyze a list of declarations (in what context ???). Also
69    --  performs necessary freezing actions (more description needed ???)
70
71    procedure Analyze_Interface_Declaration (T : Entity_Id; Def : Node_Id);
72    --  Analyze an interface declaration or a formal interface declaration
73
74    procedure Array_Type_Declaration (T : in out Entity_Id; Def : Node_Id);
75    --  Process an array type declaration. If the array is constrained, we
76    --  create an implicit parent array type, with the same index types and
77    --  component type.
78
79    procedure Access_Type_Declaration (T : Entity_Id; Def : Node_Id);
80    --  Process an access type declaration
81
82    procedure Build_Itype_Reference
83      (Ityp : Entity_Id;
84       Nod  : Node_Id);
85    --  Create a reference to an internal type, for use by Gigi. The back-end
86    --  elaborates itypes on demand, i.e. when their first use is seen. This
87    --  can lead to scope anomalies if the first use is within a scope that is
88    --  nested within the scope that contains  the point of definition of the
89    --  itype. The Itype_Reference node forces the elaboration of the itype
90    --  in the proper scope. The node is inserted after Nod, which is the
91    --  enclosing declaration that generated Ityp.
92    --
93    --  A related mechanism is used during expansion, for itypes created in
94    --  branches of conditionals. See Ensure_Defined in exp_util.
95    --  Could both mechanisms be merged ???
96
97    procedure Check_Abstract_Overriding (T : Entity_Id);
98    --  Check that all abstract subprograms inherited from T's parent type
99    --  have been overridden as required, and that nonabstract subprograms
100    --  have not been incorrectly overridden with an abstract subprogram.
101
102    procedure Check_Aliased_Component_Types (T : Entity_Id);
103    --  Given an array type or record type T, check that if the type is
104    --  nonlimited, then the nominal subtype of any components of T
105    --  that have discriminants must be constrained.
106
107    procedure Check_Completion (Body_Id : Node_Id := Empty);
108    --  At the end of a declarative part, verify that all entities that
109    --  require completion have received one. If Body_Id is absent, the
110    --  error indicating a missing completion is placed on the declaration
111    --  that needs completion. If Body_Id is present, it is the defining
112    --  identifier of a package body, and errors are posted on that node,
113    --  rather than on the declarations that require completion in the package
114    --  declaration.
115
116    procedure Derive_Subprogram
117      (New_Subp     : in out Entity_Id;
118       Parent_Subp  : Entity_Id;
119       Derived_Type : Entity_Id;
120       Parent_Type  : Entity_Id;
121       Actual_Subp  : Entity_Id := Empty);
122    --  Derive the subprogram Parent_Subp from Parent_Type, and replace the
123    --  subsidiary subtypes with the derived type to build the specification
124    --  of the inherited subprogram (returned in New_Subp). For tagged types,
125    --  the derived subprogram is aliased to that of the actual (in the
126    --  case where Actual_Subp is nonempty) rather than to the corresponding
127    --  subprogram of the parent type.
128
129    procedure Derive_Subprograms
130      (Parent_Type    : Entity_Id;
131       Derived_Type   : Entity_Id;
132       Generic_Actual : Entity_Id := Empty);
133    --  To complete type derivation, collect/retrieve the primitive operations
134    --  of the parent type, and replace the subsidiary subtypes with the derived
135    --  type, to build the specs of the inherited ops. For generic actuals, the
136    --  mapping of the primitive operations to those of the parent type is also
137    --  done by rederiving the operations within the instance. For tagged types,
138    --  the derived subprograms are aliased to those of the actual, not those of
139    --  the ancestor.
140    --
141    --  Note: one might expect this to be private to the package body, but
142    --  there is one rather unusual usage in package Exp_Dist.
143
144    function Find_Hidden_Interface
145      (Src  : Elist_Id;
146       Dest : Elist_Id) return Entity_Id;
147    --  Ada 2005: Determine whether the interfaces in list Src are all present
148    --  in the list Dest. Return the first differing interface, or Empty
149    --  otherwise.
150
151    function Find_Type_Of_Subtype_Indic (S : Node_Id) return Entity_Id;
152    --  Given a subtype indication S (which is really an N_Subtype_Indication
153    --  node or a plain N_Identifier), find the type of the subtype mark.
154
155    function Find_Type_Name (N : Node_Id) return Entity_Id;
156    --  Enter the identifier in a type definition, or find the entity already
157    --  declared, in the case of the full declaration of an incomplete or
158    --  private type.
159
160    function Get_Discriminant_Value
161      (Discriminant       : Entity_Id;
162       Typ_For_Constraint : Entity_Id;
163       Constraint         : Elist_Id) return Node_Id;
164    --  ??? MORE DOCUMENTATION
165    --  Given a discriminant somewhere in the Typ_For_Constraint tree
166    --  and a Constraint, return the value of that discriminant.
167
168    function Is_Null_Extension (T : Entity_Id) return Boolean;
169    --  Returns True if the tagged type T has an N_Full_Type_Declaration that
170    --  is a null extension, meaning that it has an extension part without any
171    --  components and does not have a known discriminant part.
172
173    function Is_Visible_Component (C : Entity_Id) return Boolean;
174    --  Determines if a record component C is visible in the present context.
175    --  Note that even though component C could appear in the entity chain
176    --  of a record type, C may not be visible in the current context. For
177    --  instance, C may be a component inherited in the full view of a private
178    --  extension which is not visible in the current context.
179
180    procedure Make_Index
181      (I            : Node_Id;
182       Related_Nod  : Node_Id;
183       Related_Id   : Entity_Id := Empty;
184       Suffix_Index : Nat := 1);
185    --  Process an index that is given in an array declaration, an entry
186    --  family declaration or a loop iteration. The index is given by an
187    --  index declaration (a 'box'), or by a discrete range. The later can
188    --  be the name of a discrete type, or a subtype indication.
189    --
190    --  Related_Nod is the node where the potential generated implicit types
191    --  will be inserted. The 2 last parameters are used for creating the name.
192
193    procedure Make_Class_Wide_Type (T : Entity_Id);
194    --  A Class_Wide_Type is created for each tagged type definition. The
195    --  attributes of a class-wide type are inherited from those of the type T.
196    --  If T is introduced by a private declaration, the corresponding class
197    --  wide type is created at the same time, and therefore there is a private
198    --  and a full declaration for the class-wide type as well.
199
200    function OK_For_Limited_Init_In_05
201      (Typ : Entity_Id;
202       Exp : Node_Id) return Boolean;
203    --  Presuming Exp is an expression of an inherently limited type Typ,
204    --  returns True if the expression is allowed in an initialization context
205    --  by the rules of Ada 2005. We use the rule in RM-7.5(2.1/2), "...it is an
206    --  aggregate, a function_call, or a parenthesized expression or qualified
207    --  expression whose operand is permitted...". Note that in Ada 95 mode,
208    --  we sometimes wish to give warnings based on whether the program _would_
209    --  be legal in Ada 2005. Note that Exp must already have been resolved,
210    --  so we can know whether it's a function call (as opposed to an indexed
211    --  component, for example). In the case where Typ is a limited interface's
212    --  class-wide type, then the expression is allowed to be of any kind if its
213    --  type is a nonlimited descendant of the interface.
214
215    function OK_For_Limited_Init
216      (Typ : Entity_Id;
217       Exp : Node_Id) return Boolean;
218    --  Always False in Ada 95 mode. Equivalent to OK_For_Limited_Init_In_05 in
219    --  Ada 2005 mode.
220
221    procedure Preanalyze_Spec_Expression (N : Node_Id; T : Entity_Id);
222    --  Default and per object expressions do not freeze their components, and
223    --  must be analyzed and resolved accordingly. The analysis is done by
224    --  calling the Preanalyze_And_Resolve routine and setting the global
225    --  In_Default_Expression flag. See the documentation section entitled
226    --  "Handling of Default and Per-Object Expressions" in sem.ads for full
227    --  details. N is the expression to be analyzed, T is the expected type.
228
229    procedure Process_Full_View (N : Node_Id; Full_T, Priv_T : Entity_Id);
230    --  Process some semantic actions when the full view of a private type is
231    --  encountered and analyzed. The first action is to create the full views
232    --  of the dependant private subtypes. The second action is to recopy the
233    --  primitive operations of the private view (in the tagged case).
234    --  N is the N_Full_Type_Declaration node.
235
236    --    Full_T is the full view of the type whose full declaration is in N.
237    --
238    --    Priv_T is the private view of the type whose full declaration is in N.
239
240    procedure Process_Range_Expr_In_Decl
241      (R           : Node_Id;
242       T           : Entity_Id;
243       Check_List  : List_Id := Empty_List;
244       R_Check_Off : Boolean := False);
245    --  Process a range expression that appears in a declaration context. The
246    --  range is analyzed and resolved with the base type of the given type,
247    --  and an appropriate check for expressions in non-static contexts made
248    --  on the bounds. R is analyzed and resolved using T, so the caller should
249    --  if necessary link R into the tree before the call, and in particular in
250    --  the case of a subtype declaration, it is appropriate to set the parent
251    --  pointer of R so that the types get properly frozen. The Check_List
252    --  parameter is used when the subprogram is called from
253    --  Build_Record_Init_Proc and is used to return a set of constraint
254    --  checking statements generated by the Checks package. R_Check_Off is set
255    --  to True when the call to Range_Check is to be skipped.
256
257    function Process_Subtype
258      (S           : Node_Id;
259       Related_Nod : Node_Id;
260       Related_Id  : Entity_Id := Empty;
261       Suffix      : Character := ' ') return Entity_Id;
262    --  Process a subtype indication S and return corresponding entity.
263    --  Related_Nod is the node where the potential generated implicit types
264    --  will be inserted. The Related_Id and Suffix parameters are used to
265    --  build the associated Implicit type name.
266
267    procedure Process_Discriminants
268      (N    : Node_Id;
269       Prev : Entity_Id := Empty);
270    --  Process the discriminants contained in an N_Full_Type_Declaration or
271    --  N_Incomplete_Type_Decl node N. If the declaration is a completion,
272    --  Prev is entity on the partial view, on which references are posted.
273
274    function Replace_Anonymous_Access_To_Protected_Subprogram
275      (N : Node_Id) return Entity_Id;
276    --  Ada 2005 (AI-254): Create and decorate an internal full type declaration
277    --  for an anonymous access to protected subprogram. For a record component
278    --  declaration, the type is created in the enclosing scope, for an array
279    --  type declaration or an object declaration it is simply placed ahead of
280    --  this declaration.
281
282    procedure Set_Completion_Referenced (E : Entity_Id);
283    --  If E is the completion of a private or incomplete  type declaration,
284    --  or the completion of a deferred constant declaration, mark the entity
285    --  as referenced. Warnings on unused entities, if needed, go on the
286    --  partial view.
287
288 end Sem_Ch3;