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 # A source module can locate AST nodes of related MM entities
27 # Once a source module AST is no more needed, _nodes is set to null
28 # See ToolContext::keep_ast property in syntax.nit for details
29 var _nodes
: nullable HashMap[Object, nullable ANode] = new HashMap[Object, nullable ANode]
32 fun clear_ast
do _nodes
= null
34 # The related AST node
35 fun node
: AModule do return nodes
(self).as(AModule)
37 # Concrete NIT source local classs by name
38 readable var _src_local_classes
: Map[Symbol, MMSrcLocalClass]
40 init(c
: MMContext, source
: AModule, dir
: MMDirectory, name
: Symbol, loc
: Location)
42 super(name
, dir
, c
, loc
)
44 _src_local_classes
= new HashMap[Symbol, MMSrcLocalClass]
47 redef fun nodes
(o
: Object): nullable ANode
49 if _nodes
!= null and _nodes
.has_key
(o
) then return _nodes
[o
] else return null
51 redef fun nodes
=(o
: Object, n
: nullable ANode)
53 assert not _nodes
.has_key
(o
)
59 # The AST node of some entity
60 private fun nodes
(o
: Object): nullable ANode do return null
61 # The AST node of some entity
62 private fun nodes
=(o
: Object, n
: nullable ANode) do abort
65 redef class MMGlobalClass
66 # Check that a module can access a class
67 fun check_visibility
(v
: AbsSyntaxVisitor, n
: ANode, cm
: MMSrcModule): Bool do
69 assert pm
isa MMSrcModule
70 var vpm
= cm
.visibility_for
(pm
)
74 v
.error
(n
, "Visibility error: Class {self} comes from the hidden module {cm}.") # TODO: should not occur
76 else if visibility_level
>= 3 then
77 v
.error
(n
, "Visibility error: Class {self} is private.")
84 # Concrete NIT source local classes
86 special MMConcreteClass
87 # The first related AST node (if any)
88 fun node
: nullable AClassdef do return module.nodes
(self).as(nullable AClassdef)
90 # Concrete NIT source generic formal parameter by name
91 readable var _formal_dict
: Map[Symbol, MMTypeFormalParameter] = new HashMap[Symbol, MMTypeFormalParameter]
93 # Concrete NIT source properties by name
94 readable var _src_local_properties
: Map[Symbol, MMLocalProperty]
96 init(mod
: MMSrcModule, n
: Symbol, cla
: nullable AClassdef, a
: Int)
100 _src_local_properties
= new HashMap[Symbol, MMLocalProperty]
104 redef class MMGlobalProperty
105 # Check that a module can access a property
106 fun check_visibility
(v
: AbsSyntaxVisitor, n
: ANode, cm
: MMSrcModule, allows_protected
: Bool): Bool do
107 var pm
= local_class
.module
108 assert pm
isa MMSrcModule
109 var vpm
= cm
.visibility_for
(pm
)
112 else if vpm
== 0 then
113 # TODO: should not occurs
114 v
.error
(n
, "Visibility error: Property {self} comes from the hidden module {cm}.")
116 else if visibility_level
>= 3 then
117 v
.error
(n
, "Visibility error: Property {self} is private.")
119 else if visibility_level
>= 2 and not allows_protected
then
120 v
.error
(n
, "Visibility error: Property {self} is protected and can only acceded by self.")
127 redef class MMLocalProperty
128 # The attached node (if any)
129 fun node
: nullable ANode do return null
131 # Is the concrete method defined as init
132 fun is_init
: Bool do return false
135 # Concrete NIT source attribute
138 redef fun node
: nullable AAttrPropdef do return module.nodes
(self).as(nullable AAttrPropdef)
139 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
142 cla
.module.nodes
(self) = n
146 # Concrete NIT source method
149 redef fun is_intern
do return false
150 redef fun is_abstract
do return false
153 # Concrete NIT source method for an automatic accesor
154 class MMAttrImplementationMethod
156 redef fun node
: nullable AAttrPropdef do return module.nodes
(self).as(nullable AAttrPropdef)
157 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
160 cla
.module.nodes
(self) = n
164 # Concrete NIT source method for an automatic read accesor
165 class MMReadImplementationMethod
166 special MMAttrImplementationMethod
167 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
173 # Concrete NIT source method for an automatic write accesor
174 class MMWriteImplementationMethod
175 special MMAttrImplementationMethod
176 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
182 # Concrete NIT source method for an explicit method
183 class MMMethSrcMethod
185 redef readable var _is_init
: Bool
186 redef readable var _is_intern
: Bool
187 redef readable var _is_abstract
: Bool
188 redef fun node
: nullable AMethPropdef do return module.nodes
(self).as(nullable AMethPropdef)
189 init(name
: Symbol, cla
: MMLocalClass, n
: nullable AMethPropdef)
192 cla
.module.nodes
(self) = n
193 _is_init
= node
isa AConcreteInitPropdef
194 _is_intern
= node
isa AInternMethPropdef
195 _is_abstract
= node
isa ADeferredMethPropdef
199 # Concrete NIT source virtual type
200 class MMSrcTypeProperty
201 special MMLocalProperty
202 special MMTypeProperty
203 init(name
: Symbol, cla
: MMLocalClass, n
: ATypePropdef)
209 # Concrete NIT implicit constructor
211 special MMMethSrcMethod
212 fun super_init
: nullable MMLocalProperty is abstract
213 redef fun is_init
do return true
214 readable var _unassigned_attributes
: Array[MMSrcAttribute]
215 readable var _super_inits
: Array[MMLocalProperty]
216 init(cla
: MMLocalClass, unassigned_attributes
: Array[MMSrcAttribute], super_inits
: Array[MMLocalProperty])
218 super(once
"init".to_symbol
, cla
, null)
219 _unassigned_attributes
= unassigned_attributes
220 _super_inits
= super_inits
225 abstract class Variable
226 # Name of the variable
227 readable var _name
: Symbol
229 # Declaration AST node
230 readable var _decl
: nullable ANode
233 readable writable var _stype
: nullable MMType
235 redef fun to_s
do return _name
.to_s
237 fun kind
: String is abstract
239 init(n
: Symbol, d
: nullable ANode)
246 # Variable declared with 'var'
249 redef fun kind
do return once
"variable"
250 init(n
: Symbol, d
: ANode) do super
253 # Parameter of method (declared in signature)
256 redef fun kind
do return once
"parameter"
257 init(n
: Symbol, d
: nullable ANode) do super
260 # Automatic variable (like in the 'for' statement)
263 redef fun kind
do return once
"automatic variable"
264 init(n
: Symbol, d
: ANode) do super
267 # False variable corresponding to closures declared in signatures
268 # Lives in the same namespace than variables
269 class ClosureVariable
271 redef fun kind
do return once
"closure"
273 # The signature of the closure
274 readable var _closure
: MMClosure
276 init(n
: Symbol, d
: ANode, c
: MMClosure)
283 ###############################################################################
285 # Visitor used during the syntax analysis
286 class AbsSyntaxVisitor
288 fun get_type_by_name
(clsname
: Symbol): MMType
290 var cls
= _module
.class_by_name
(clsname
)
294 fun get_instantiated_type_by_name
(clsname
: Symbol, vtype
: Array[MMType]): MMType
296 var cls
= _module
.class_by_name
(clsname
)
297 return cls
.get_instantiate_type
(vtype
)
300 # The root type Object
301 fun type_object
: MMType
303 return get_type_by_name
(once
("Object".to_symbol
))
306 # The primitive type Bool
307 fun type_bool
: MMType
309 return get_type_by_name
(once
("Bool".to_symbol
))
312 # The primitive type Int
315 return get_type_by_name
(once
("Int".to_symbol
))
318 # The primitive type Float
319 fun type_float
: MMType
321 return get_type_by_name
(once
("Float".to_symbol
))
324 # The primitive type Char
325 fun type_char
: MMType
327 return get_type_by_name
(once
("Char".to_symbol
))
330 # The primitive type String
331 fun type_string
: MMType
333 return get_type_by_name
(once
("String".to_symbol
))
336 # The primitive type Collection[nullable Object]
337 fun type_collection
: MMType
339 return get_instantiated_type_by_name
(once
("Collection".to_symbol
), [type_object
.as_nullable
])
342 # The primitive type NativeString
343 fun type_nativestring
: MMType
345 return get_type_by_name
(once
("NativeString".to_symbol
))
348 # The primitive type Array[?]
349 fun type_array
(stype
: MMType): MMType
351 return get_instantiated_type_by_name
(once
("Array".to_symbol
), [stype
])
354 # The primitive type Discrete
355 fun type_discrete
: MMType
357 return get_type_by_name
(once
("Discrete".to_symbol
))
360 # The primitive type Range[?]
361 fun type_range
(stype
: MMType): MMType
363 return get_instantiated_type_by_name
(once
("Range".to_symbol
), [stype
])
366 # The primitive type of null
367 fun type_none
: MMType
369 return _module
.type_none
372 fun get_method
(recv
: MMType, name
: Symbol): MMMethod
374 if not recv
.local_class
.has_global_property_by_name
(name
) then
375 error
(current_node
, "Fatal Error: {recv} must have a property named {name}.")
378 return recv
.local_class
.select_method
(name
)
382 readable var _module
: MMSrcModule
385 fun local_class
: MMSrcLocalClass do return _local_class
.as(not null)
386 writable var _local_class
: nullable MMSrcLocalClass
388 # The current property
389 fun local_property
: MMLocalProperty do return _local_property
.as(not null)
390 writable var _local_property
: nullable MMLocalProperty
392 # The current tool configuration/status
393 readable var _tc
: ToolContext
395 # Display an error for a given syntax node
396 fun error
(n
: nullable ANode, s
: String)
398 _tc
.error
(if n
== null then null else n
.location
, s
)
401 # Add an error, show errors and quit
402 fun fatal_error
(n
: nullable ANode, s
: String)
404 _tc
.fatal_error
(if n
== null then null else n
.location
, s
)
407 # Display a warning for a given syntax node
408 fun warning
(n
: nullable ANode, s
: String)
410 _tc
.warning
(if n
== null then null else n
.location
, s
)
413 # Check conformity and display error
414 fun check_conform
(n
: ANode, subtype
: nullable MMType, stype
: nullable MMType): Bool
416 if stype
== null or subtype
== null then
419 if subtype
< stype
then
422 error
(n
, "Type error: expected {stype}, got {subtype}")
426 # Check that an expression has a static type and that
427 # Display an error and return false if n is a statement
428 # Require that the static type of n is known
429 fun check_expr
(n
: AExpr): Bool
431 if not n
.is_typed
then
432 if tc
.error_count
== 0 then
435 print
("Unknown node not typed but not error")
437 print
("{loc} not typed but not error")
441 # An error occured in a sub node,
442 # sillently cascade fail
444 else if n
.is_statement
then
445 error
(n
, "Type error: expected expression.")
451 # Combine check_conform and check_expr
452 fun check_conform_expr
(n
: AExpr, stype
: nullable MMType): Bool
454 if stype
== null then return false
455 if check_expr
(n
) then return check_conform
(n
, n
.stype
, stype
) else return false
458 # Check conformance between multiple expressions and a static type
459 # Conformance is granted if among them there is a most general type
460 # Return the most general type if a conformance is found
461 # Display an error and return null if no conformance is found
462 # The only allowed combinaison is with the nullable marker
463 # @param stype is a possible additional type (without node)
465 # Int, Int, Object => return Object
466 # Int, Float => display error, return null
467 # nullable Int, Object => return nullable Object
468 fun check_conform_multiexpr
(stype
: nullable MMType, nodes
: Collection[AExpr]): nullable MMType
470 var node
: nullable AExpr = null # candidate node
472 if not check_expr
(n
) then return null
474 if stype
!= null and stype
.is_nullable
!= ntype
.is_nullable
then
475 # nullable combinaison: if one of them is nulable, considers that both are
476 stype
= stype
.as_nullable
477 ntype
= ntype
.as_nullable
479 if stype
== null or stype
< ntype
then
485 if not n
.stype
< stype
.as(not null) then
487 error
(n
, "Type error: no most general type. Got {n.stype} and {stype}.")
489 var loc
= node
.location
491 error
(n
, "Type error: no most general type. Got {n.stype} and {stype} at ????.")
493 error
(n
, "Type error: no most general type. Got {n.stype} and {stype} at {loc.relative_to(n.location)}.")
502 protected init(tc
: ToolContext, module: MMSrcModule)
509 ###############################################################################
512 protected fun accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
516 var _symbol_cache
: nullable Symbol
518 # Symbol associated with the text
520 fun to_symbol
: Symbol
522 var s
= _symbol_cache
531 redef class AClassdef
532 # Associated class (MM entity)
533 fun local_class
: MMSrcLocalClass is abstract
535 # Next AClassdef of the same class (if any)
536 readable writable var _next_node
: nullable AClassdef = null
540 # Associated 'self' variable
541 fun self_var
: ParamVariable is abstract
544 redef class AAttrPropdef
545 # Associated attribute (MM entity)
546 fun prop
: MMSrcAttribute is abstract
548 # Associated read accessor (MM entity)
549 fun readmethod
: nullable MMSrcMethod is abstract
551 # Associated write accessor (MM entity)
552 fun writemethod
: nullable MMSrcMethod is abstract
555 redef class AConcreteInitPropdef
556 readable var _super_init_calls
: Array[MMMethod] = new Array[MMMethod]
557 readable var _explicit_super_init_calls
: Array[MMMethod] = new Array[MMMethod]
560 redef class AMethPropdef
561 # Associated method (MM entity)
562 fun method
: MMMethSrcMethod is abstract
565 redef class ATypePropdef
566 # Associated formal type (MM entity)
567 fun prop
: MMSrcTypeProperty is abstract
571 # Position in the signature
572 fun position
: Int is abstract
574 # Associated local variable
575 fun variable
: ParamVariable is abstract
578 redef class AClosureDecl
579 # Position in the signature
580 fun position
: Int is abstract
582 # Associated closure variable
583 fun variable
: ClosureVariable is abstract
587 # Is the node correcly typed
588 # Return false if typed was not yet computed or
589 # if an error occured during the typing computation
590 fun is_typed
: Bool is abstract
592 # Return corresponding static type. (require is_typed)
593 fun stype
: MMType is abstract
595 var _stype_cache
: nullable MMType = null
596 var _stype_cached
: Bool = false
598 # Retrieve the local class corresponding to the type.
599 # Display an error and return null if there is no class
600 # Display an error and return null if the type is not class based (formal one)
601 fun get_local_class
(v
: AbsSyntaxVisitor): nullable MMLocalClass
603 var name
= n_id
.to_symbol
605 var cla
= v
.local_class
607 if cla
.formal_dict
.has_key
(name
) or cla
.has_global_property_by_name
(name
) then
608 v
.error
(n_id
, "Type error: {name} is a formal type")
613 if not mod
.has_global_class_named
(name
) then
614 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
619 var local_class
= mod
.class_by_name
(name
)
620 local_class
.global
.check_visibility
(v
, self, mod
)
624 # Retrieve corresponding static type.
625 # Display an error and return null if there is a problem
626 # But do not performs any subtype check.
627 # get_unchecked_stype should be called to check that the static type is fully valid
628 fun get_unchecked_stype
(v
: AbsSyntaxVisitor): nullable MMType
630 if _stype_cached
then return _stype_cache
633 var name
= n_id
.to_symbol
635 var cla
= v
.local_class
636 var t
: nullable MMType
638 if cla
.formal_dict
.has_key
(name
) then
639 if n_types
.length
> 0 then
640 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
643 t
= cla
.formal_dict
[name
]
644 if n_kwnullable
!= null then t
= t
.as_nullable
649 if cla
.has_global_property_by_name
(name
) then
650 if n_types
.length
> 0 then
651 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
654 t
= cla
.get_type
.local_class
.select_virtual_type
(name
).stype_for
(cla
.get_type
)
656 v
.error
(self, "Type error: circular definition in formal type {name}.")
659 if n_kwnullable
!= null then t
= t
.as_nullable
664 var local_class
= get_local_class
(v
)
665 if local_class
== null then return null
667 var arity
= n_types
.length
668 if local_class
.arity
!= arity
then
670 v
.error
(self, "Type error: '{local_class}' is a generic class.")
671 else if local_class
.arity
== 0 then
672 v
.error
(self, "Type error: '{local_class}' is not a generic class.")
674 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters ({arity} are provided).")
680 var tab
= new Array[MMType]
682 var t2
= p
.get_unchecked_stype
(v
)
683 if t2
== null then return null
686 t
= local_class
.get_instantiate_type
(tab
)
688 t
= local_class
.get_type
690 if n_kwnullable
!= null then t
= t
.as_nullable
695 # Retrieve corresponding static type.
696 # Display an error and return null if there is a problem
697 fun get_stype
(v
: AbsSyntaxVisitor): nullable MMType
699 var t
= get_unchecked_stype
(v
)
700 if t
== null then return null
701 if not t
.is_valid
then return null
706 # Check that a static definition type is conform with regard to formal types
707 # Useful with get_unchecked_stype
708 # Remember that conformance check need that ancestors are totaly computed
709 fun check_conform
(v
: AbsSyntaxVisitor)
711 var st
= get_unchecked_stype
(v
)
712 if st
== null then return
713 var local_class
= st
.local_class
714 var arity
= n_types
.length
716 for i
in [0..arity
[ do
718 var pt
= p
.get_stype
(v
)
719 var b
= local_class
.get_formal
(i
)
720 if not b
.is_valid
then return
722 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
723 v
.check_conform
(p
, pt
, bt
)
730 # Is the expression node correcly typed
731 # Return false if typed was not yet computed or
732 # if an error occured during the typing computation
733 fun is_typed
: Bool is abstract
735 # Is the expression node a statement? (ie has no return value)
737 fun is_statement
: Bool is abstract
739 # The static type of the expression
740 # require: is_typed and not is_statement
741 fun stype
: MMType is abstract
744 class AAbsAbsSendExpr
746 # The signature of the called property (require is_typed)
747 fun prop_signature
: MMSignature is abstract
749 # The real arguments used (after star transformation) (require is_typed)
750 fun arguments
: Array[AExpr] is abstract
754 special AAbsAbsSendExpr
755 # The invoked method (require is_typed)
756 fun prop
: MMMethod is abstract
758 # The return type (if any) (once computed)
759 fun return_type
: nullable MMType is abstract
766 redef class ASuperExpr
767 special ASuperInitCall
768 fun init_in_superclass
: nullable MMMethod is abstract
775 redef class ASendExpr
776 special ASuperInitCall
777 # Closure definitions
778 fun closure_defs
: nullable Array[AClosureDef] is abstract
781 redef class AReassignFormExpr
782 # Method used through the reassigment operator (require is_typed)
783 fun assign_method
: MMMethod is abstract
786 class ASendReassignExpr
788 special AReassignFormExpr
789 # The invoked method used to read (require is_typed)
790 # prop is the method used to write
791 fun read_prop
: MMMethod is abstract
794 redef class ACallReassignExpr
795 special ASendReassignExpr
798 redef class ABraReassignExpr
799 special ASendReassignExpr
802 redef class AAttrFormExpr
803 # Attribute accessed (require is_typed)
804 fun prop
: MMAttribute is abstract
806 # Attribute type of the acceded attribute (require is_typed)
807 fun attr_type
: MMType is abstract
810 redef class ASuperstringExpr
811 fun atype
: MMType is abstract
814 redef class AVardeclExpr
815 # Assiociated local variable
816 fun variable
: VarVariable is abstract
817 #readable writable var _variable: nullable VarVariable
821 # Associated automatic local variable
822 fun variable
: AutoVariable is abstract
825 redef class ASelfExpr
826 # Associated local variable
827 fun variable
: ParamVariable is abstract
830 redef class AVarFormExpr
831 # Associated local variable
832 fun variable
: Variable is abstract
835 redef class AClosureCallExpr
836 special AAbsAbsSendExpr
837 # Associated closure variable
838 fun variable
: ClosureVariable is abstract
841 redef class AClosureDef
843 fun closure
: MMClosure is abstract
845 # Automatic variables
846 readable writable var _variables
: nullable Array[AutoVariable]