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
68 var pm
= intro
.mmmodule
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
87 # The first related AST node (if any)
88 fun node
: nullable AClassdef do return mmmodule
.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
.mmmodule
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 mmmodule
.nodes
(self).as(nullable AAttrPropdef)
139 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
142 cla
.mmmodule
.nodes
(self) = n
146 # Concrete NIT source method
149 redef fun is_intern
do return false
150 redef fun is_abstract
do return false
151 redef fun extern_name
do return null
154 # Concrete NIT source method for an automatic accesor
155 class MMAttrImplementationMethod
157 redef fun node
: nullable AAttrPropdef do return mmmodule
.nodes
(self).as(nullable AAttrPropdef)
158 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
161 cla
.mmmodule
.nodes
(self) = n
165 # Concrete NIT source method for an automatic read accesor
166 class MMReadImplementationMethod
167 super MMAttrImplementationMethod
168 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
174 # Concrete NIT source method for an automatic write accesor
175 class MMWriteImplementationMethod
176 super MMAttrImplementationMethod
177 init(name
: Symbol, cla
: MMLocalClass, n
: AAttrPropdef)
183 # Concrete NIT source method for an explicit method
184 class MMMethSrcMethod
186 redef readable var _is_init
: Bool
187 redef readable var _is_intern
: Bool
188 redef readable var _is_abstract
: Bool
189 redef readable writable var _extern_name
: nullable String # Will be computed during MMBuilder
190 redef fun node
: nullable AMethPropdef do return mmmodule
.nodes
(self).as(nullable AMethPropdef)
191 init(name
: Symbol, cla
: MMLocalClass, n
: nullable AMethPropdef)
194 cla
.mmmodule
.nodes
(self) = n
195 _is_init
= node
isa AConcreteInitPropdef
196 _is_intern
= node
isa AInternMethPropdef
197 _is_abstract
= node
isa ADeferredMethPropdef
202 # Concrete NIT source virtual type
203 class MMSrcTypeProperty
204 super MMLocalProperty
206 init(name
: Symbol, cla
: MMLocalClass, n
: ATypePropdef)
212 # Concrete NIT implicit constructor
214 super MMMethSrcMethod
215 fun super_init
: nullable MMLocalProperty is abstract
216 redef fun is_init
do return true
217 readable var _unassigned_attributes
: Array[MMSrcAttribute]
218 readable var _super_inits
: Array[MMLocalProperty]
219 init(cla
: MMLocalClass, unassigned_attributes
: Array[MMSrcAttribute], super_inits
: Array[MMLocalProperty])
221 super(once
"init".to_symbol
, cla
, null)
222 _unassigned_attributes
= unassigned_attributes
223 _super_inits
= super_inits
228 abstract class Variable
229 # Name of the variable
230 readable var _name
: Symbol
232 # Declaration AST node
233 readable var _decl
: nullable ANode
236 readable writable var _stype
: nullable MMType
238 redef fun to_s
do return _name
.to_s
240 fun kind
: String is abstract
242 init(n
: Symbol, d
: nullable ANode)
249 # Variable declared with 'var'
252 redef fun kind
do return once
"variable"
253 init(n
: Symbol, d
: ANode) do super
256 # Parameter of method (declared in signature)
259 redef fun kind
do return once
"parameter"
260 init(n
: Symbol, d
: nullable ANode) do super
263 # Automatic variable (like in the 'for' statement)
266 redef fun kind
do return once
"automatic variable"
267 init(n
: Symbol, d
: ANode) do super
270 # False variable corresponding to closures declared in signatures
271 # Lives in the same namespace than variables
272 class ClosureVariable
274 redef fun kind
do return once
"closure"
276 # The signature of the closure
277 readable var _closure
: MMClosure
279 init(n
: Symbol, d
: ANode, c
: MMClosure)
286 ###############################################################################
288 # Visitor used during the syntax analysis
289 class AbsSyntaxVisitor
291 fun get_type_by_name
(clsname
: Symbol): MMType
293 if not _mmmodule
.has_global_class_named
(clsname
) then _tc
.fatal_error
(_mmmodule
.location
, "Missing necessary class: \"{clsname}\
"")
294 var cls
= _mmmodule
.class_by_name
(clsname
)
298 fun get_instantiated_type_by_name
(clsname
: Symbol, vtype
: Array[MMType]): MMType
300 if not _mmmodule
.has_global_class_named
(clsname
) then _tc
.fatal_error
(_mmmodule
.location
, "Missing necessary class: \"{clsname}\
"")
301 var cls
= _mmmodule
.class_by_name
(clsname
)
302 return cls
.get_instantiate_type
(vtype
)
305 # The root type Object
306 fun type_object
: MMType
308 return get_type_by_name
(once
("Object".to_symbol
))
311 # The primitive type Bool
312 fun type_bool
: MMType
314 return get_type_by_name
(once
("Bool".to_symbol
))
317 # The primitive type Int
320 return get_type_by_name
(once
("Int".to_symbol
))
323 # The primitive type Float
324 fun type_float
: MMType
326 return get_type_by_name
(once
("Float".to_symbol
))
329 # The primitive type Char
330 fun type_char
: MMType
332 return get_type_by_name
(once
("Char".to_symbol
))
335 # The primitive type String
336 fun type_string
: MMType
338 return get_type_by_name
(once
("String".to_symbol
))
341 # The primitive type Collection[nullable Object]
342 fun type_collection
: MMType
344 return get_instantiated_type_by_name
(once
("Collection".to_symbol
), [type_object
.as_nullable
])
347 # The primitive type NativeString
348 fun type_nativestring
: MMType
350 return get_type_by_name
(once
("NativeString".to_symbol
))
353 # The primitive type Array[?]
354 fun type_array
(stype
: MMType): MMType
356 return get_instantiated_type_by_name
(once
("Array".to_symbol
), [stype
])
359 # The primitive type Discrete
360 fun type_discrete
: MMType
362 return get_type_by_name
(once
("Discrete".to_symbol
))
365 # The primitive type Range[?]
366 fun type_range
(stype
: MMType): MMType
368 return get_instantiated_type_by_name
(once
("Range".to_symbol
), [stype
])
371 # The primitive type of null
372 fun type_none
: MMType
374 return _mmmodule
.type_none
377 fun get_method
(recv
: MMType, name
: Symbol): MMMethod
379 if not recv
.local_class
.has_global_property_by_name
(name
) then
380 fatal_error
(current_node
, "Fatal Error: {recv} must have a property named {name}.")
382 return recv
.local_class
.select_method
(name
)
386 readable var _mmmodule
: MMSrcModule
389 fun local_class
: MMSrcLocalClass do return _local_class
.as(not null)
390 writable var _local_class
: nullable MMSrcLocalClass
392 # The current property
393 fun local_property
: MMLocalProperty do return _local_property
.as(not null)
394 writable var _local_property
: nullable MMLocalProperty
396 # The current tool configuration/status
397 readable var _tc
: ToolContext
399 # Display an error for a given syntax node
400 fun error
(n
: nullable ANode, s
: String)
402 _tc
.error
(if n
== null then null else n
.location
, s
)
405 # Add an error, show errors and quit
406 fun fatal_error
(n
: nullable ANode, s
: String)
408 _tc
.fatal_error
(if n
== null then null else n
.location
, s
)
411 # Display a warning for a given syntax node
412 fun warning
(n
: nullable ANode, s
: String)
414 _tc
.warning
(if n
== null then null else n
.location
, s
)
417 # Check conformity and display error
418 fun check_conform
(n
: ANode, subtype
: nullable MMType, stype
: nullable MMType): Bool
420 if stype
== null or subtype
== null then
423 if subtype
< stype
then
426 error
(n
, "Type error: expected {stype}, got {subtype}")
430 # Check that an expression has a static type and that
431 # Display an error and return false if n is a statement
432 # Require that the static type of n is known
433 fun check_expr
(n
: AExpr): Bool
435 if not n
.is_typed
then
436 if tc
.error_count
== 0 then
437 print
("{n.location} not typed but not error")
440 # An error occured in a sub node,
441 # sillently cascade fail
443 else if n
.is_statement
then
444 error
(n
, "Type error: expected expression.")
450 # Combine check_conform and check_expr
451 fun check_conform_expr
(n
: AExpr, stype
: nullable MMType): Bool
453 if stype
== null then return false
454 if check_expr
(n
) then return check_conform
(n
, n
.stype
, stype
) else return false
457 # Check conformance between multiple expressions and a static type
458 # Conformance is granted if among them there is a most general type
459 # Return the most general type if a conformance is found
460 # Display an error and return null if no conformance is found
461 # The only allowed combinaison is with the nullable marker
462 # @param stype is a possible additional type (without node)
464 # Int, Int, Object => return Object
465 # Int, Float => display error, return null
466 # nullable Int, Object => return nullable Object
467 fun check_conform_multiexpr
(stype
: nullable MMType, nodes
: Collection[AExpr]): nullable MMType
469 var node
: nullable AExpr = null # candidate node
471 if not check_expr
(n
) then return null
473 if stype
!= null and stype
.is_nullable
!= ntype
.is_nullable
then
474 # nullable combinaison: if one of them is nulable, considers that both are
475 stype
= stype
.as_nullable
476 ntype
= ntype
.as_nullable
478 if stype
== null or stype
< ntype
then
485 if not n
.stype
< stype
then
487 error
(n
, "Type error: no most general type. Got {n.stype} and {stype}.")
489 error
(n
, "Type error: no most general type. Got {n.stype} and {stype} at {node.location.relative_to(n.location)}.")
497 protected init(tc
: ToolContext, mmmodule
: MMSrcModule)
504 ###############################################################################
507 protected fun accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
511 var _symbol_cache
: nullable Symbol
513 # Symbol associated with the text
515 fun to_symbol
: Symbol
517 var s
= _symbol_cache
526 redef class AClassdef
527 # Associated class (MM entity)
528 fun local_class
: MMSrcLocalClass is abstract
530 # Next AClassdef of the same class (if any)
531 readable writable var _next_node
: nullable AClassdef = null
535 # Associated 'self' variable
536 fun self_var
: ParamVariable is abstract
539 redef class AAttrPropdef
540 # Associated attribute (MM entity)
541 fun prop
: MMSrcAttribute is abstract
543 # Associated read accessor (MM entity)
544 fun readmethod
: nullable MMSrcMethod is abstract
546 # Associated write accessor (MM entity)
547 fun writemethod
: nullable MMSrcMethod is abstract
550 redef class AConcreteInitPropdef
551 readable var _super_init_calls
: Array[MMMethod] = new Array[MMMethod]
552 readable var _explicit_super_init_calls
: Array[MMMethod] = new Array[MMMethod]
555 redef class AMethPropdef
556 # Associated method (MM entity)
557 fun method
: MMMethSrcMethod is abstract
560 redef class ATypePropdef
561 # Associated formal type (MM entity)
562 fun prop
: MMSrcTypeProperty is abstract
566 # Position in the signature
567 fun position
: Int is abstract
569 # Associated local variable
570 fun variable
: ParamVariable is abstract
573 redef class AClosureDecl
574 # Position in the signature
575 fun position
: Int is abstract
577 # Associated closure variable
578 fun variable
: ClosureVariable is abstract
582 # Is the node correcly typed
583 # Return false if typed was not yet computed or
584 # if an error occured during the typing computation
585 fun is_typed
: Bool is abstract
587 # Return corresponding static type. (require is_typed)
588 fun stype
: MMType is abstract
590 var _stype_cache
: nullable MMType = null
591 var _stype_cached
: Bool = false
593 # Retrieve the local class corresponding to the type.
594 # Display an error and return null if there is no class
595 # Display an error and return null if the type is not class based (formal one)
596 fun get_local_class
(v
: AbsSyntaxVisitor): nullable MMLocalClass
598 var name
= n_id
.to_symbol
600 var cla
= v
.local_class
602 if cla
.formal_dict
.has_key
(name
) or cla
.has_global_property_by_name
(name
) then
603 v
.error
(n_id
, "Type error: {name} is a formal type")
608 if not mod
.has_global_class_named
(name
) then
609 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
614 var local_class
= mod
.class_by_name
(name
)
615 local_class
.global
.check_visibility
(v
, self, mod
)
619 # Retrieve corresponding static type.
620 # Display an error and return null if there is a problem
621 # But do not performs any subtype check.
622 # get_unchecked_stype should be called to check that the static type is fully valid
623 fun get_unchecked_stype
(v
: AbsSyntaxVisitor): nullable MMType
625 if _stype_cached
then return _stype_cache
628 var name
= n_id
.to_symbol
630 var cla
= v
.local_class
631 var t
: nullable MMType
633 if cla
.formal_dict
.has_key
(name
) then
634 if n_types
.length
> 0 then
635 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
638 t
= cla
.formal_dict
[name
]
639 if n_kwnullable
!= null then t
= t
.as_nullable
644 if cla
.has_global_property_by_name
(name
) then
645 if n_types
.length
> 0 then
646 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
649 t
= cla
.get_type
.local_class
.select_virtual_type
(name
).stype_for
(cla
.get_type
)
651 v
.error
(self, "Type error: circular definition in formal type {name}.")
654 if n_kwnullable
!= null then t
= t
.as_nullable
659 var local_class
= get_local_class
(v
)
660 if local_class
== null then return null
662 var arity
= n_types
.length
663 if local_class
.arity
!= arity
then
665 v
.error
(self, "Type error: '{local_class}' is a generic class.")
666 else if local_class
.arity
== 0 then
667 v
.error
(self, "Type error: '{local_class}' is not a generic class.")
669 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters ({arity} are provided).")
675 var tab
= new Array[MMType]
677 var t2
= p
.get_unchecked_stype
(v
)
678 if t2
== null then return null
681 t
= local_class
.get_instantiate_type
(tab
)
683 t
= local_class
.get_type
685 if n_kwnullable
!= null then t
= t
.as_nullable
690 # Retrieve corresponding static type.
691 # Display an error and return null if there is a problem
692 fun get_stype
(v
: AbsSyntaxVisitor): nullable MMType
694 var t
= get_unchecked_stype
(v
)
695 if t
== null then return null
696 if not t
.is_valid
then return null
701 # Check that a static definition type is conform with regard to formal types
702 # Useful with get_unchecked_stype
703 # Remember that conformance check need that ancestors are totaly computed
704 fun check_conform
(v
: AbsSyntaxVisitor)
706 var st
= get_unchecked_stype
(v
)
707 if st
== null then return
708 var local_class
= st
.local_class
709 var arity
= n_types
.length
711 for i
in [0..arity
[ do
713 var pt
= p
.get_stype
(v
)
714 var b
= local_class
.get_formal
(i
)
715 if not b
.is_valid
then return
717 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
718 v
.check_conform
(p
, pt
, bt
)
725 # Is the expression node correcly typed
726 # Return false if typed was not yet computed or
727 # if an error occured during the typing computation
728 fun is_typed
: Bool is abstract
730 # Is the expression node a statement? (ie has no return value)
732 fun is_statement
: Bool is abstract
734 # The static type of the expression
735 # require: is_typed and not is_statement
736 fun stype
: MMType is abstract
739 class AAbsAbsSendExpr
741 # The signature of the called property (require is_typed)
742 fun prop_signature
: MMSignature is abstract
744 # The raw arguments used (without vararg transformation) (require is_typed)
745 fun raw_arguments
: Array[AExpr] is abstract
749 super AAbsAbsSendExpr
750 # The invoked method (require is_typed)
751 fun prop
: MMMethod is abstract
753 # The return type (if any) (once computed)
754 fun return_type
: nullable MMType is abstract
761 redef class ASuperExpr
763 fun init_in_superclass
: nullable MMMethod is abstract
770 redef class ASendExpr
772 # Closure definitions
773 fun closure_defs
: nullable Array[AClosureDef] is abstract
776 redef class AReassignFormExpr
777 # Method used through the reassigment operator (require is_typed)
778 fun assign_method
: MMMethod is abstract
781 class ASendReassignExpr
783 super AReassignFormExpr
784 # The invoked method used to read (require is_typed)
785 # prop is the method used to write
786 fun read_prop
: MMMethod is abstract
789 redef class ACallReassignExpr
790 super ASendReassignExpr
793 redef class ABraReassignExpr
794 super ASendReassignExpr
797 redef class AAttrFormExpr
798 # Attribute accessed (require is_typed)
799 fun prop
: MMAttribute is abstract
801 # Attribute type of the acceded attribute (require is_typed)
802 fun attr_type
: MMType is abstract
805 redef class ASuperstringExpr
806 fun atype
: MMType is abstract
809 redef class AVardeclExpr
810 # Assiociated local variable
811 fun variable
: VarVariable is abstract
812 #readable writable var _variable: nullable VarVariable
816 # Associated automatic local variable
817 fun variable
: AutoVariable is abstract
820 redef class ASelfExpr
821 # Associated local variable
822 fun variable
: ParamVariable is abstract
825 redef class AVarFormExpr
826 # Associated local variable
827 fun variable
: Variable is abstract
830 redef class AClosureCallExpr
831 super AAbsAbsSendExpr
832 # Associated closure variable
833 fun variable
: ClosureVariable is abstract
836 redef class AClosureDef
838 fun closure
: MMClosure is abstract
840 # Automatic variables
841 readable writable var _variables
: nullable Array[AutoVariable]