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 if not _module
.has_global_class_named
(clsname
) then _tc
.fatal_error
(_module
.location
, "Missing necessary class: \"{clsname}\
"")
291 var cls
= _module
.class_by_name
(clsname
)
295 fun get_instantiated_type_by_name
(clsname
: Symbol, vtype
: Array[MMType]): MMType
297 if not _module
.has_global_class_named
(clsname
) then _tc
.fatal_error
(_module
.location
, "Missing necessary class: \"{clsname}\
"")
298 var cls
= _module
.class_by_name
(clsname
)
299 return cls
.get_instantiate_type
(vtype
)
302 # The root type Object
303 fun type_object
: MMType
305 return get_type_by_name
(once
("Object".to_symbol
))
308 # The primitive type Bool
309 fun type_bool
: MMType
311 return get_type_by_name
(once
("Bool".to_symbol
))
314 # The primitive type Int
317 return get_type_by_name
(once
("Int".to_symbol
))
320 # The primitive type Float
321 fun type_float
: MMType
323 return get_type_by_name
(once
("Float".to_symbol
))
326 # The primitive type Char
327 fun type_char
: MMType
329 return get_type_by_name
(once
("Char".to_symbol
))
332 # The primitive type String
333 fun type_string
: MMType
335 return get_type_by_name
(once
("String".to_symbol
))
338 # The primitive type Collection[nullable Object]
339 fun type_collection
: MMType
341 return get_instantiated_type_by_name
(once
("Collection".to_symbol
), [type_object
.as_nullable
])
344 # The primitive type NativeString
345 fun type_nativestring
: MMType
347 return get_type_by_name
(once
("NativeString".to_symbol
))
350 # The primitive type Array[?]
351 fun type_array
(stype
: MMType): MMType
353 return get_instantiated_type_by_name
(once
("Array".to_symbol
), [stype
])
356 # The primitive type Discrete
357 fun type_discrete
: MMType
359 return get_type_by_name
(once
("Discrete".to_symbol
))
362 # The primitive type Range[?]
363 fun type_range
(stype
: MMType): MMType
365 return get_instantiated_type_by_name
(once
("Range".to_symbol
), [stype
])
368 # The primitive type of null
369 fun type_none
: MMType
371 return _module
.type_none
374 fun get_method
(recv
: MMType, name
: Symbol): MMMethod
376 if not recv
.local_class
.has_global_property_by_name
(name
) then
377 error
(current_node
, "Fatal Error: {recv} must have a property named {name}.")
380 return recv
.local_class
.select_method
(name
)
384 readable var _module
: MMSrcModule
387 fun local_class
: MMSrcLocalClass do return _local_class
.as(not null)
388 writable var _local_class
: nullable MMSrcLocalClass
390 # The current property
391 fun local_property
: MMLocalProperty do return _local_property
.as(not null)
392 writable var _local_property
: nullable MMLocalProperty
394 # The current tool configuration/status
395 readable var _tc
: ToolContext
397 # Display an error for a given syntax node
398 fun error
(n
: nullable ANode, s
: String)
400 _tc
.error
(if n
== null then null else n
.location
, s
)
403 # Add an error, show errors and quit
404 fun fatal_error
(n
: nullable ANode, s
: String)
406 _tc
.fatal_error
(if n
== null then null else n
.location
, s
)
409 # Display a warning for a given syntax node
410 fun warning
(n
: nullable ANode, s
: String)
412 _tc
.warning
(if n
== null then null else n
.location
, s
)
415 # Check conformity and display error
416 fun check_conform
(n
: ANode, subtype
: nullable MMType, stype
: nullable MMType): Bool
418 if stype
== null or subtype
== null then
421 if subtype
< stype
then
424 error
(n
, "Type error: expected {stype}, got {subtype}")
428 # Check that an expression has a static type and that
429 # Display an error and return false if n is a statement
430 # Require that the static type of n is known
431 fun check_expr
(n
: AExpr): Bool
433 if not n
.is_typed
then
434 if tc
.error_count
== 0 then
435 print
("{n.location} not typed but not error")
438 # An error occured in a sub node,
439 # sillently cascade fail
441 else if n
.is_statement
then
442 error
(n
, "Type error: expected expression.")
448 # Combine check_conform and check_expr
449 fun check_conform_expr
(n
: AExpr, stype
: nullable MMType): Bool
451 if stype
== null then return false
452 if check_expr
(n
) then return check_conform
(n
, n
.stype
, stype
) else return false
455 # Check conformance between multiple expressions and a static type
456 # Conformance is granted if among them there is a most general type
457 # Return the most general type if a conformance is found
458 # Display an error and return null if no conformance is found
459 # The only allowed combinaison is with the nullable marker
460 # @param stype is a possible additional type (without node)
462 # Int, Int, Object => return Object
463 # Int, Float => display error, return null
464 # nullable Int, Object => return nullable Object
465 fun check_conform_multiexpr
(stype
: nullable MMType, nodes
: Collection[AExpr]): nullable MMType
467 var node
: nullable AExpr = null # candidate node
469 if not check_expr
(n
) then return null
471 if stype
!= null and stype
.is_nullable
!= ntype
.is_nullable
then
472 # nullable combinaison: if one of them is nulable, considers that both are
473 stype
= stype
.as_nullable
474 ntype
= ntype
.as_nullable
476 if stype
== null or stype
< ntype
then
482 if not n
.stype
< stype
.as(not null) then
484 error
(n
, "Type error: no most general type. Got {n.stype} and {stype}.")
486 error
(n
, "Type error: no most general type. Got {n.stype} and {stype} at {node.location.relative_to(n.location)}.")
494 protected init(tc
: ToolContext, module: MMSrcModule)
501 ###############################################################################
504 protected fun accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
508 var _symbol_cache
: nullable Symbol
510 # Symbol associated with the text
512 fun to_symbol
: Symbol
514 var s
= _symbol_cache
523 redef class AClassdef
524 # Associated class (MM entity)
525 fun local_class
: MMSrcLocalClass is abstract
527 # Next AClassdef of the same class (if any)
528 readable writable var _next_node
: nullable AClassdef = null
532 # Associated 'self' variable
533 fun self_var
: ParamVariable is abstract
536 redef class AAttrPropdef
537 # Associated attribute (MM entity)
538 fun prop
: MMSrcAttribute is abstract
540 # Associated read accessor (MM entity)
541 fun readmethod
: nullable MMSrcMethod is abstract
543 # Associated write accessor (MM entity)
544 fun writemethod
: nullable MMSrcMethod is abstract
547 redef class AConcreteInitPropdef
548 readable var _super_init_calls
: Array[MMMethod] = new Array[MMMethod]
549 readable var _explicit_super_init_calls
: Array[MMMethod] = new Array[MMMethod]
552 redef class AMethPropdef
553 # Associated method (MM entity)
554 fun method
: MMMethSrcMethod is abstract
557 redef class ATypePropdef
558 # Associated formal type (MM entity)
559 fun prop
: MMSrcTypeProperty is abstract
563 # Position in the signature
564 fun position
: Int is abstract
566 # Associated local variable
567 fun variable
: ParamVariable is abstract
570 redef class AClosureDecl
571 # Position in the signature
572 fun position
: Int is abstract
574 # Associated closure variable
575 fun variable
: ClosureVariable is abstract
579 # Is the node correcly typed
580 # Return false if typed was not yet computed or
581 # if an error occured during the typing computation
582 fun is_typed
: Bool is abstract
584 # Return corresponding static type. (require is_typed)
585 fun stype
: MMType is abstract
587 var _stype_cache
: nullable MMType = null
588 var _stype_cached
: Bool = false
590 # Retrieve the local class corresponding to the type.
591 # Display an error and return null if there is no class
592 # Display an error and return null if the type is not class based (formal one)
593 fun get_local_class
(v
: AbsSyntaxVisitor): nullable MMLocalClass
595 var name
= n_id
.to_symbol
597 var cla
= v
.local_class
599 if cla
.formal_dict
.has_key
(name
) or cla
.has_global_property_by_name
(name
) then
600 v
.error
(n_id
, "Type error: {name} is a formal type")
605 if not mod
.has_global_class_named
(name
) then
606 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
611 var local_class
= mod
.class_by_name
(name
)
612 local_class
.global
.check_visibility
(v
, self, mod
)
616 # Retrieve corresponding static type.
617 # Display an error and return null if there is a problem
618 # But do not performs any subtype check.
619 # get_unchecked_stype should be called to check that the static type is fully valid
620 fun get_unchecked_stype
(v
: AbsSyntaxVisitor): nullable MMType
622 if _stype_cached
then return _stype_cache
625 var name
= n_id
.to_symbol
627 var cla
= v
.local_class
628 var t
: nullable MMType
630 if cla
.formal_dict
.has_key
(name
) then
631 if n_types
.length
> 0 then
632 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
635 t
= cla
.formal_dict
[name
]
636 if n_kwnullable
!= null then t
= t
.as_nullable
641 if cla
.has_global_property_by_name
(name
) then
642 if n_types
.length
> 0 then
643 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
646 t
= cla
.get_type
.local_class
.select_virtual_type
(name
).stype_for
(cla
.get_type
)
648 v
.error
(self, "Type error: circular definition in formal type {name}.")
651 if n_kwnullable
!= null then t
= t
.as_nullable
656 var local_class
= get_local_class
(v
)
657 if local_class
== null then return null
659 var arity
= n_types
.length
660 if local_class
.arity
!= arity
then
662 v
.error
(self, "Type error: '{local_class}' is a generic class.")
663 else if local_class
.arity
== 0 then
664 v
.error
(self, "Type error: '{local_class}' is not a generic class.")
666 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters ({arity} are provided).")
672 var tab
= new Array[MMType]
674 var t2
= p
.get_unchecked_stype
(v
)
675 if t2
== null then return null
678 t
= local_class
.get_instantiate_type
(tab
)
680 t
= local_class
.get_type
682 if n_kwnullable
!= null then t
= t
.as_nullable
687 # Retrieve corresponding static type.
688 # Display an error and return null if there is a problem
689 fun get_stype
(v
: AbsSyntaxVisitor): nullable MMType
691 var t
= get_unchecked_stype
(v
)
692 if t
== null then return null
693 if not t
.is_valid
then return null
698 # Check that a static definition type is conform with regard to formal types
699 # Useful with get_unchecked_stype
700 # Remember that conformance check need that ancestors are totaly computed
701 fun check_conform
(v
: AbsSyntaxVisitor)
703 var st
= get_unchecked_stype
(v
)
704 if st
== null then return
705 var local_class
= st
.local_class
706 var arity
= n_types
.length
708 for i
in [0..arity
[ do
710 var pt
= p
.get_stype
(v
)
711 var b
= local_class
.get_formal
(i
)
712 if not b
.is_valid
then return
714 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
715 v
.check_conform
(p
, pt
, bt
)
722 # Is the expression node correcly typed
723 # Return false if typed was not yet computed or
724 # if an error occured during the typing computation
725 fun is_typed
: Bool is abstract
727 # Is the expression node a statement? (ie has no return value)
729 fun is_statement
: Bool is abstract
731 # The static type of the expression
732 # require: is_typed and not is_statement
733 fun stype
: MMType is abstract
736 class AAbsAbsSendExpr
738 # The signature of the called property (require is_typed)
739 fun prop_signature
: MMSignature is abstract
741 # The raw arguments used (without vararg transformation) (require is_typed)
742 fun raw_arguments
: Array[AExpr] is abstract
746 special AAbsAbsSendExpr
747 # The invoked method (require is_typed)
748 fun prop
: MMMethod is abstract
750 # The return type (if any) (once computed)
751 fun return_type
: nullable MMType is abstract
758 redef class ASuperExpr
759 special ASuperInitCall
760 fun init_in_superclass
: nullable MMMethod is abstract
767 redef class ASendExpr
768 special ASuperInitCall
769 # Closure definitions
770 fun closure_defs
: nullable Array[AClosureDef] is abstract
773 redef class AReassignFormExpr
774 # Method used through the reassigment operator (require is_typed)
775 fun assign_method
: MMMethod is abstract
778 class ASendReassignExpr
780 special AReassignFormExpr
781 # The invoked method used to read (require is_typed)
782 # prop is the method used to write
783 fun read_prop
: MMMethod is abstract
786 redef class ACallReassignExpr
787 special ASendReassignExpr
790 redef class ABraReassignExpr
791 special ASendReassignExpr
794 redef class AAttrFormExpr
795 # Attribute accessed (require is_typed)
796 fun prop
: MMAttribute is abstract
798 # Attribute type of the acceded attribute (require is_typed)
799 fun attr_type
: MMType is abstract
802 redef class ASuperstringExpr
803 fun atype
: MMType is abstract
806 redef class AVardeclExpr
807 # Assiociated local variable
808 fun variable
: VarVariable is abstract
809 #readable writable var _variable: nullable VarVariable
813 # Associated automatic local variable
814 fun variable
: AutoVariable is abstract
817 redef class ASelfExpr
818 # Associated local variable
819 fun variable
: ParamVariable is abstract
822 redef class AVarFormExpr
823 # Associated local variable
824 fun variable
: Variable is abstract
827 redef class AClosureCallExpr
828 special AAbsAbsSendExpr
829 # Associated closure variable
830 fun variable
: ClosureVariable is abstract
833 redef class AClosureDef
835 fun closure
: MMClosure is abstract
837 # Automatic variables
838 readable writable var _variables
: nullable Array[AutoVariable]