1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2008 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Common syntax structures for syntax analysis of NIT AST.
23 # Concrete NIT source module
26 # The related AST node
27 readable attr _node
: AModule
29 # Concrete NIT source local classs by name
30 readable attr _src_local_classes
: Map[Symbol, MMSrcLocalClass]
32 init(c
: MMContext, source
: AModule, dir
: MMDirectory, name
: Symbol)
36 _src_local_classes
= new HashMap[Symbol, MMSrcLocalClass]
40 redef class MMGlobalClass
41 # Check that a module can access a class
42 meth check_visibility
(v
: AbsSyntaxVisitor, n
: PNode, cm
: MMSrcModule): Bool do
44 assert pm
isa MMSrcModule
45 var vpm
= cm
.visibility_for
(pm
)
49 v
.error
(n
, "Visibility error: Class {self} comes from the hidden module {cm}.") # TODO: should not occur
51 else if visibility_level
>= 3 then
52 v
.error
(n
, "Visibility error: Class {self} is private.")
59 # Concrete NIT source local classes
61 special MMConcreteClass
62 # The related AST nodes
63 readable attr _nodes
: Array[PClassdef]
65 # Concrete NIT source generic formal parameter by name
66 readable writable attr _formal_dict
: Map[Symbol, MMTypeFormalParameter]
68 # Concrete NIT source properties by name
69 readable attr _src_local_properties
: Map[Symbol, MMSrcLocalProperty]
71 init(n
: Symbol, cla
: PClassdef, a
: Int)
75 _src_local_properties
= new HashMap[Symbol, MMSrcLocalProperty]
79 redef class MMGlobalProperty
80 # Check that a module can access a property
81 meth check_visibility
(v
: AbsSyntaxVisitor, n
: PNode, cm
: MMSrcModule, allows_protected
: Bool): Bool do
82 var pm
= local_class
.module
83 assert pm
isa MMSrcModule
84 var vpm
= cm
.visibility_for
(pm
)
88 # TODO: should not occurs
89 v
.error
(n
, "Visibility error: Property {self} comes from the hidden module {cm}.")
91 else if visibility_level
>= 3 then
92 v
.error
(n
, "Visibility error: Property {self} is private.")
94 else if visibility_level
>= 2 and not allows_protected
then
95 v
.error
(n
, "Visibility error: Property {self} is protected and can only acceded by self.")
102 # Concrete NIT source local property
103 class MMSrcLocalProperty
104 special MMConcreteProperty
105 # Type of the related AST node
108 # The related AST node
109 readable attr _node
: NODE
112 # Concrete NIT source attribute
114 special MMSrcLocalProperty
116 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
118 super(name
, cla
, self)
123 # Concrete NIT source method
125 special MMSrcLocalProperty
129 # Concrete NIT source method for an automatic accesor
130 class MMAttrImplementationMethod
132 redef type NODE: AAttrPropdef
135 # Concrete NIT source method for an automatic read accesor
136 class MMReadImplementationMethod
137 special MMAttrImplementationMethod
139 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
141 super(name
, cla
, self)
146 # Concrete NIT source method for an automatic write accesor
147 class MMWriteImplementationMethod
148 special MMAttrImplementationMethod
150 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
152 super(name
, cla
, self)
157 # Concrete NIT source method for an explicit method
158 class MMMethSrcMethod
160 redef type NODE: AMethPropdef
162 init(name
: Symbol, cla
: MMLocalClass, n
: AMethPropdef)
164 super(name
, cla
, self)
169 # Concrete NIT source virtual type
170 class MMSrcTypeProperty
171 special MMSrcLocalProperty
172 special MMTypeProperty
173 init(name
: Symbol, cla
: MMLocalClass, n
: ATypePropdef)
175 super(name
, cla
, self)
181 # Local variable and method parameter
183 # Name of the variable
184 readable attr _name
: Symbol
186 # Declaration AST node
187 readable attr _decl
: PNode
190 readable writable attr _stype
: MMType
192 init(n
: Symbol, d
: PNode)
201 ###############################################################################
203 # Visitor used during the syntax analysis
204 class AbsSyntaxVisitor
206 # The primitive type Bool
207 meth type_bool
: MMType
209 return _module
.class_by_name
(once
("Bool".to_symbol
)).get_type
212 # The primitive type Int
213 meth type_int
: MMType
215 return _module
.class_by_name
(once
("Int".to_symbol
)).get_type
218 # The primitive type Float
219 meth type_float
: MMType
221 return _module
.class_by_name
(once
("Float".to_symbol
)).get_type
224 # The primitive type Char
225 meth type_char
: MMType
227 return _module
.class_by_name
(once
("Char".to_symbol
)).get_type
230 # The primitive type String
231 meth type_string
: MMType
233 return _module
.class_by_name
(once
("String".to_symbol
)).get_type
236 # The primitive type Collection[Object]
237 meth type_collection
: MMType
239 return _module
.class_by_name
(once
("Collection".to_symbol
)).get_type
242 # The primitive type Array[?]
243 meth type_array
(stype
: MMType): MMType
245 return _module
.class_by_name
(once
("Array".to_symbol
)).get_instantiate_type
([stype
])
248 # The primitive type Discrete
249 meth type_discrete
: MMType
251 return _module
.class_by_name
(once
("Discrete".to_symbol
)).get_type
254 # The primitive type Range[?]
255 meth type_range
(stype
: MMType): MMType
257 return _module
.class_by_name
(once
("Range".to_symbol
)).get_instantiate_type
([stype
])
260 # The primitive type of null
261 meth type_none
: MMType
263 return _module
.type_none
267 readable writable attr _module
: MMSrcModule
270 readable writable attr _local_class
: MMSrcLocalClass
272 # The current property
273 readable writable attr _local_property
: MMSrcLocalProperty
275 # The current tool configuration/status
276 readable attr _tc
: ToolContext
278 # Display an error for a given syntax node
279 meth error
(n
: PNode, s
: String)
281 _tc
.error
("{n.locate}: {s}")
284 # Display a warning for a given syntax node
285 meth warning
(n
: PNode, s
: String)
287 _tc
.warning
("{n.locate}: {s}")
290 # Check conformity and display error
291 meth check_conform
(n
: PNode, subtype
: MMType, stype
: MMType): Bool
293 if stype
== null or subtype
== null then
296 if subtype
< stype
then
299 error
(n
, "Type error: expected {stype}, got {subtype}")
304 protected init(tc
: ToolContext, module: MMSrcModule)
311 ###############################################################################
314 protected meth accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
320 # Symbol associated with the text
322 meth to_symbol
: Symbol
333 redef class PClassdef
334 # Associated class (MM entity)
335 meth local_class
: MMSrcLocalClass is abstract
338 redef class AAttrPropdef
339 # Associated attribute (MM entity)
340 meth prop
: MMSrcAttribute is abstract
342 # Associated read accessor (MM entity)
343 meth readmethod
: MMSrcMethod is abstract
345 # Associated write accessor (MM entity)
346 meth writemethod
: MMSrcMethod is abstract
349 redef class AMethPropdef
350 # Associated method (MM entity)
351 meth method
: MMMethSrcMethod is abstract
354 redef class ATypePropdef
355 # Associated formal type (MM entity)
356 meth prop
: MMSrcTypeProperty is abstract
360 # Position in the signature
361 meth position
: Int is abstract
363 # Associated local variable
364 meth variable
: Variable is abstract
368 # Retrieve the local class corresponding to the type.
369 # Display an error and return null if there is no class
370 # Display an error and return null if the type is not class based (formal one)
371 meth get_local_class
(v
: AbsSyntaxVisitor): MMLocalClass is abstract
373 # Retrieve corresponding static type.
374 # Display an error and return null if there is a problem
375 meth get_stype
(v
: AbsSyntaxVisitor): MMType is abstract
377 # Retrieve corresponding static type.
378 # Display an error and return null if there is a problem
379 # But do not performs any subtype check.
380 # get_unchecked_stype should be called to check that the static type is fully valid
381 meth get_unchecked_stype
(v
: AbsSyntaxVisitor): MMType is abstract
383 # Check that a static definition type is conform with regard to formal types
384 # Useful with get_unchecked_stype
385 # Remember that conformance check need that ancestors are totaly computed
386 meth check_conform
(v
: AbsSyntaxVisitor) is abstract
390 attr _stype_cache
: MMType
391 attr _stype_cached
: Bool
393 redef meth get_local_class
(v
)
395 var name
= n_id
.to_symbol
397 var cla
= v
.local_class
399 if (cla
.formal_dict
!= null and cla
.formal_dict
.has_key
(name
)) or (cla
.global_properties
!= null and cla
.has_global_property_by_name
(name
)) then
400 v
.error
(n_id
, "Type error: {name} is a formal type")
405 if not mod
.has_global_class_named
(name
) then
406 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
411 var local_class
= mod
.class_by_name
(name
)
412 local_class
.global
.check_visibility
(v
, self, mod
)
416 redef meth get_unchecked_stype
(v
)
418 if _stype_cached
then return _stype_cache
421 var name
= n_id
.to_symbol
423 var cla
= v
.local_class
425 if cla
.formal_dict
.has_key
(name
) then
426 if n_types
.length
> 0 then
427 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
430 var formal
= cla
.formal_dict
[name
]
431 _stype_cache
= formal
435 if cla
.global_properties
!= null and cla
.has_global_property_by_name
(name
) then
436 if n_types
.length
> 0 then
437 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
440 var t
= cla
.get_type
.select_virtual_type
(name
).stype
442 v
.error
(self, "Type error: circular definition in formal type {name}.")
449 var local_class
= get_local_class
(v
)
450 if local_class
== null then return null
452 var arity
= n_types
.length
453 if local_class
.arity
!= arity
then
454 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters which differs from the {arity} params.")
459 var tab
= new Array[MMType]
461 tab
.add
(p
.get_unchecked_stype
(v
))
463 var t
= local_class
.get_instantiate_type
(tab
)
467 var t
= local_class
.get_type
473 redef meth get_stype
(v
)
475 var t
= get_unchecked_stype
(v
)
476 if t
!= null then check_conform
(v
)
480 redef meth check_conform
(v
)
482 var st
= get_unchecked_stype
(v
)
483 if st
== null then return
484 var local_class
= st
.local_class
485 var arity
= n_types
.length
487 for i
in [0..arity
[ do
489 var pt
= p
.get_stype
(v
)
490 var bt
= local_class
.get_formal
(i
).bound
491 if bt
== null then return
492 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
493 v
.check_conform
(p
, pt
, bt
)
501 # Is null for statement and for erronus expression
502 meth stype
: MMType is abstract