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, MMLocalProperty]
71 init(mod
: MMSrcModule, n
: Symbol, cla
: PClassdef, a
: Int)
75 _src_local_properties
= new HashMap[Symbol, MMLocalProperty]
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 redef class MMLocalProperty
103 # The attached node (if any)
104 meth node
: PNode do return null
106 # Is the concrete method defined as init
107 meth is_init
: Bool do return false
110 # Concrete NIT source attribute
113 redef readable attr _node
: AAttrPropdef
114 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
121 # Concrete NIT source method
126 # Concrete NIT source method for an automatic accesor
127 class MMAttrImplementationMethod
129 redef readable attr _node
: AAttrPropdef
130 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
137 # Concrete NIT source method for an automatic read accesor
138 class MMReadImplementationMethod
139 special MMAttrImplementationMethod
140 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
146 # Concrete NIT source method for an automatic write accesor
147 class MMWriteImplementationMethod
148 special MMAttrImplementationMethod
149 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
155 # Concrete NIT source method for an explicit method
156 class MMMethSrcMethod
158 redef meth is_init
do return _node
isa AConcreteInitPropdef
159 redef readable attr _node
: AMethPropdef
160 init(name
: Symbol, cla
: MMLocalClass, n
: AMethPropdef)
167 # Concrete NIT source virtual type
168 class MMSrcTypeProperty
169 special MMLocalProperty
170 special MMTypeProperty
171 redef readable attr _node
: ATypePropdef
172 init(name
: Symbol, cla
: MMLocalClass, n
: ATypePropdef)
179 # Concrete NIT implicit constructor
181 special MMMethSrcMethod
182 redef meth is_init
do return true
183 readable attr _unassigned_attributes
: Array[MMSrcAttribute]
184 readable attr _super_inits
: Array[MMLocalProperty]
185 init(cla
: MMLocalClass, unassigned_attributes
: Array[MMSrcAttribute], super_inits
: Array[MMLocalProperty])
187 super(once
"init".to_symbol
, cla
, null)
188 _unassigned_attributes
= unassigned_attributes
189 _super_inits
= super_inits
194 abstract class Variable
195 # Name of the variable
196 readable attr _name
: Symbol
198 # Declaration AST node
199 readable attr _decl
: PNode
202 readable writable attr _stype
: MMType
204 redef meth to_s
do return _name
.to_s
206 meth kind
: String is abstract
208 init(n
: Symbol, d
: PNode)
217 # Variable declared with 'var'
220 redef meth kind
do return once
"variable"
221 init(n
: Symbol, d
: PNode) do super
224 # Parameter of method (declared in signature)
227 redef meth kind
do return once
"parameter"
228 init(n
: Symbol, d
: PNode) do super
231 # Automatic variable (like in the 'for' statement)
234 redef meth kind
do return once
"automatic variable"
235 init(n
: Symbol, d
: PNode) do super
238 # False variable corresponding to closures declared in signatures
239 # Lives in the same namespace than variables
240 class ClosureVariable
242 redef meth kind
do return once
"closure"
244 # The signature of the closure
245 readable attr _closure
: MMClosure
247 init(n
: Symbol, d
: PNode, c
: MMClosure)
254 ###############################################################################
256 # Visitor used during the syntax analysis
257 class AbsSyntaxVisitor
259 # The root type Object
260 meth type_object
: MMType
262 return _module
.class_by_name
(once
("Object".to_symbol
)).get_type
265 # The primitive type Bool
266 meth type_bool
: MMType
268 return _module
.class_by_name
(once
("Bool".to_symbol
)).get_type
271 # The primitive type Int
272 meth type_int
: MMType
274 return _module
.class_by_name
(once
("Int".to_symbol
)).get_type
277 # The primitive type Float
278 meth type_float
: MMType
280 return _module
.class_by_name
(once
("Float".to_symbol
)).get_type
283 # The primitive type Char
284 meth type_char
: MMType
286 return _module
.class_by_name
(once
("Char".to_symbol
)).get_type
289 # The primitive type String
290 meth type_string
: MMType
292 return _module
.class_by_name
(once
("String".to_symbol
)).get_type
295 # The primitive type Collection[Object]
296 meth type_collection
: MMType
298 return _module
.class_by_name
(once
("Collection".to_symbol
)).get_type
301 # The primitive type Array[?]
302 meth type_array
(stype
: MMType): MMType
304 return _module
.class_by_name
(once
("Array".to_symbol
)).get_instantiate_type
([stype
])
307 # The primitive type Discrete
308 meth type_discrete
: MMType
310 return _module
.class_by_name
(once
("Discrete".to_symbol
)).get_type
313 # The primitive type Range[?]
314 meth type_range
(stype
: MMType): MMType
316 return _module
.class_by_name
(once
("Range".to_symbol
)).get_instantiate_type
([stype
])
319 # The primitive type of null
320 meth type_none
: MMType
322 return _module
.type_none
326 readable writable attr _module
: MMSrcModule
329 readable writable attr _local_class
: MMSrcLocalClass
331 # The current property
332 readable writable attr _local_property
: MMLocalProperty
334 # The current tool configuration/status
335 readable attr _tc
: ToolContext
337 # Display an error for a given syntax node
338 meth error
(n
: PNode, s
: String)
340 _tc
.error
("{locate(n)}: {s}")
343 # Display a warning for a given syntax node
344 meth warning
(n
: PNode, s
: String)
346 _tc
.warning
("{locate(n)}: {s}")
350 meth locate
(n
: PNode): String
352 if n
!= null then return n
.locate
353 return _module
.filename
356 # Check conformity and display error
357 meth check_conform
(n
: PNode, subtype
: MMType, stype
: MMType): Bool
359 if stype
== null or subtype
== null then
362 if subtype
< stype
then
365 #error(n, "Type error: expected {stype}'{stype.module}, got {subtype}'{subtype.module}")
367 error
(n
, "Type error: expected {stype}, got {subtype}")
371 # Check that an expression has a static type and that
372 # Display an error and return false if n is a statement
373 # Require that the static type of n is known
374 meth check_expr
(n
: PExpr): Bool
376 # FIXME: The tc.error_count is a workaround since currently there is no way
377 # to distingate statements from buggy expressions: both have a null stype
378 if tc
.error_count
== 0 and n
.stype
== null then
379 error
(n
, "Type error: expected expression.")
385 # Combine check_conform and check_expr
386 meth check_conform_expr
(n
: PExpr, stype
: MMType): Bool
388 if check_expr
(n
) then return check_conform
(n
, n
.stype
, stype
) else return false
391 # Check conformance between multiple expressions and a static type
392 # Conformance is granted if among them there is a most general type
393 # Return the most general type if a conformance is found
394 # Display an error and return null if no conformance is found
395 # @param stype is a possible additional type (without node)
397 # Int, Int, Object => return Object
398 # Int, Float => display error, return null
399 meth check_conform_multiexpr
(stype
: MMType, nodes
: Collection[PExpr]): MMType
401 var node
: PExpr = null # candidate node
403 if not check_expr
(n
) then return null
405 if stype
== null or (ntype
!= null and stype
< ntype
) then
411 if not n
.stype
< stype
then
413 error
(n
, "Type error: no most general type. Got {n.stype} and {stype}.")
415 error
(n
, "Type error: no most general type. Got {n.stype} and {stype} at {node.locate}.")
423 protected init(tc
: ToolContext, module: MMSrcModule)
430 ###############################################################################
433 protected meth accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
439 # Symbol associated with the text
441 meth to_symbol
: Symbol
452 redef class PClassdef
453 # Associated class (MM entity)
454 meth local_class
: MMSrcLocalClass is abstract
457 redef class AAttrPropdef
458 # Associated attribute (MM entity)
459 meth prop
: MMSrcAttribute is abstract
461 # Associated read accessor (MM entity)
462 meth readmethod
: MMSrcMethod is abstract
464 # Associated write accessor (MM entity)
465 meth writemethod
: MMSrcMethod is abstract
468 redef class AMethPropdef
469 # Associated method (MM entity)
470 meth method
: MMMethSrcMethod is abstract
472 # Associated 'self' variable
473 meth self_var
: ParamVariable is abstract
476 redef class ATypePropdef
477 # Associated formal type (MM entity)
478 meth prop
: MMSrcTypeProperty is abstract
482 # Position in the signature
483 meth position
: Int is abstract
485 # Associated local variable
486 meth variable
: ParamVariable is abstract
489 redef class PClosureDecl
490 # Associated closure variable
491 meth variable
: ClosureVariable is abstract
495 # Retrieve the local class corresponding to the type.
496 # Display an error and return null if there is no class
497 # Display an error and return null if the type is not class based (formal one)
498 meth get_local_class
(v
: AbsSyntaxVisitor): MMLocalClass is abstract
500 # Retrieve corresponding static type.
501 # Display an error and return null if there is a problem
502 meth get_stype
(v
: AbsSyntaxVisitor): MMType is abstract
504 # Retrieve corresponding static type.
505 # Display an error and return null if there is a problem
506 # But do not performs any subtype check.
507 # get_unchecked_stype should be called to check that the static type is fully valid
508 meth get_unchecked_stype
(v
: AbsSyntaxVisitor): MMType is abstract
510 # Check that a static definition type is conform with regard to formal types
511 # Useful with get_unchecked_stype
512 # Remember that conformance check need that ancestors are totaly computed
513 meth check_conform
(v
: AbsSyntaxVisitor) is abstract
517 attr _stype_cache
: MMType
518 attr _stype_cached
: Bool = false
520 redef meth get_local_class
(v
)
522 var name
= n_id
.to_symbol
524 var cla
= v
.local_class
526 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
527 v
.error
(n_id
, "Type error: {name} is a formal type")
532 if not mod
.has_global_class_named
(name
) then
533 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
538 var local_class
= mod
.class_by_name
(name
)
539 local_class
.global
.check_visibility
(v
, self, mod
)
543 redef meth get_unchecked_stype
(v
)
545 if _stype_cached
then return _stype_cache
548 var name
= n_id
.to_symbol
550 var cla
= v
.local_class
552 if cla
.formal_dict
.has_key
(name
) then
553 if n_types
.length
> 0 then
554 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
557 var formal
= cla
.formal_dict
[name
]
558 _stype_cache
= formal
562 if cla
.global_properties
!= null and cla
.has_global_property_by_name
(name
) then
563 if n_types
.length
> 0 then
564 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
567 var t
= cla
.get_type
.local_class
.select_virtual_type
(name
).stype_for
(cla
.get_type
)
569 v
.error
(self, "Type error: circular definition in formal type {name}.")
576 var local_class
= get_local_class
(v
)
577 if local_class
== null then return null
579 var arity
= n_types
.length
580 if local_class
.arity
!= arity
then
581 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters which differs from the {arity} params.")
586 var tab
= new Array[MMType]
588 tab
.add
(p
.get_unchecked_stype
(v
))
590 var t
= local_class
.get_instantiate_type
(tab
)
594 var t
= local_class
.get_type
600 redef meth get_stype
(v
)
602 var t
= get_unchecked_stype
(v
)
603 if t
!= null then check_conform
(v
)
607 redef meth check_conform
(v
)
609 var st
= get_unchecked_stype
(v
)
610 if st
== null then return
611 var local_class
= st
.local_class
612 var arity
= n_types
.length
614 for i
in [0..arity
[ do
616 var pt
= p
.get_stype
(v
)
617 var bt
= local_class
.get_formal
(i
).bound
618 if bt
== null then return
619 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
620 v
.check_conform
(p
, pt
, bt
)
628 # Is null for statement and for erronus expression
629 meth stype
: MMType is abstract
632 redef class AVardeclExpr
633 # Assiociated local variable
634 readable writable attr _variable
: VarVariable
638 # Associated automatic local variable
639 readable writable attr _variable
: AutoVariable
642 redef class ASelfExpr
643 # Associated local variable
644 readable writable attr _variable
: ParamVariable
647 redef class AVarFormExpr
648 # Associated local variable
649 readable writable attr _variable
: Variable
652 redef class AClosureCallExpr
653 # Associated closure variable
654 readable writable attr _variable
: ClosureVariable
657 redef class PClosureDef
659 readable writable attr _closure
: MMClosure
661 # Automatic variables
662 readable writable attr _variables
: Array[AutoVariable]