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(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 primitive type Bool
260 meth type_bool
: MMType
262 return _module
.class_by_name
(once
("Bool".to_symbol
)).get_type
265 # The primitive type Int
266 meth type_int
: MMType
268 return _module
.class_by_name
(once
("Int".to_symbol
)).get_type
271 # The primitive type Float
272 meth type_float
: MMType
274 return _module
.class_by_name
(once
("Float".to_symbol
)).get_type
277 # The primitive type Char
278 meth type_char
: MMType
280 return _module
.class_by_name
(once
("Char".to_symbol
)).get_type
283 # The primitive type String
284 meth type_string
: MMType
286 return _module
.class_by_name
(once
("String".to_symbol
)).get_type
289 # The primitive type Collection[Object]
290 meth type_collection
: MMType
292 return _module
.class_by_name
(once
("Collection".to_symbol
)).get_type
295 # The primitive type Array[?]
296 meth type_array
(stype
: MMType): MMType
298 return _module
.class_by_name
(once
("Array".to_symbol
)).get_instantiate_type
([stype
])
301 # The primitive type Discrete
302 meth type_discrete
: MMType
304 return _module
.class_by_name
(once
("Discrete".to_symbol
)).get_type
307 # The primitive type Range[?]
308 meth type_range
(stype
: MMType): MMType
310 return _module
.class_by_name
(once
("Range".to_symbol
)).get_instantiate_type
([stype
])
313 # The primitive type of null
314 meth type_none
: MMType
316 return _module
.type_none
320 readable writable attr _module
: MMSrcModule
323 readable writable attr _local_class
: MMSrcLocalClass
325 # The current property
326 readable writable attr _local_property
: MMLocalProperty
328 # The current tool configuration/status
329 readable attr _tc
: ToolContext
331 # Display an error for a given syntax node
332 meth error
(n
: PNode, s
: String)
334 _tc
.error
("{locate(n)}: {s}")
337 # Display a warning for a given syntax node
338 meth warning
(n
: PNode, s
: String)
340 _tc
.warning
("{locate(n)}: {s}")
344 meth locate
(n
: PNode): String
346 if n
!= null then return n
.locate
347 return _module
.filename
350 # Check conformity and display error
351 meth check_conform
(n
: PNode, subtype
: MMType, stype
: MMType): Bool
353 if stype
== null or subtype
== null then
356 if subtype
< stype
then
359 #error(n, "Type error: expected {stype}'{stype.module}, got {subtype}'{subtype.module}")
361 error
(n
, "Type error: expected {stype}, got {subtype}")
365 # Check that an expression has a static type and that
366 # Display an error and return false if n is a statement
367 # Require that the static type of n is known
368 meth check_expr
(n
: PExpr): Bool
370 # FIXME: The tc.error_count is a workaround since currently there is no way
371 # to distingate statements from buggy expressions: both have a null stype
372 if tc
.error_count
== 0 and n
.stype
== null then
373 error
(n
, "Type error: expected expression.")
379 # Combine check_conform and check_expr
380 meth check_conform_expr
(n
: PExpr, stype
: MMType): Bool
382 if check_expr
(n
) then return check_conform
(n
, n
.stype
, stype
) else return false
386 protected init(tc
: ToolContext, module: MMSrcModule)
393 ###############################################################################
396 protected meth accept_abs_syntax_visitor
(v
: AbsSyntaxVisitor) do visit_all
(v
)
402 # Symbol associated with the text
404 meth to_symbol
: Symbol
415 redef class PClassdef
416 # Associated class (MM entity)
417 meth local_class
: MMSrcLocalClass is abstract
420 redef class AAttrPropdef
421 # Associated attribute (MM entity)
422 meth prop
: MMSrcAttribute is abstract
424 # Associated read accessor (MM entity)
425 meth readmethod
: MMSrcMethod is abstract
427 # Associated write accessor (MM entity)
428 meth writemethod
: MMSrcMethod is abstract
431 redef class AMethPropdef
432 # Associated method (MM entity)
433 meth method
: MMMethSrcMethod is abstract
435 # Associated 'self' variable
436 meth self_var
: ParamVariable is abstract
439 redef class ATypePropdef
440 # Associated formal type (MM entity)
441 meth prop
: MMSrcTypeProperty is abstract
445 # Position in the signature
446 meth position
: Int is abstract
448 # Associated local variable
449 meth variable
: ParamVariable is abstract
452 redef class PClosureDecl
453 # Associated closure variable
454 meth variable
: ClosureVariable is abstract
458 # Retrieve the local class corresponding to the type.
459 # Display an error and return null if there is no class
460 # Display an error and return null if the type is not class based (formal one)
461 meth get_local_class
(v
: AbsSyntaxVisitor): MMLocalClass is abstract
463 # Retrieve corresponding static type.
464 # Display an error and return null if there is a problem
465 meth get_stype
(v
: AbsSyntaxVisitor): MMType is abstract
467 # Retrieve corresponding static type.
468 # Display an error and return null if there is a problem
469 # But do not performs any subtype check.
470 # get_unchecked_stype should be called to check that the static type is fully valid
471 meth get_unchecked_stype
(v
: AbsSyntaxVisitor): MMType is abstract
473 # Check that a static definition type is conform with regard to formal types
474 # Useful with get_unchecked_stype
475 # Remember that conformance check need that ancestors are totaly computed
476 meth check_conform
(v
: AbsSyntaxVisitor) is abstract
480 attr _stype_cache
: MMType
481 attr _stype_cached
: Bool = false
483 redef meth get_local_class
(v
)
485 var name
= n_id
.to_symbol
487 var cla
= v
.local_class
489 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
490 v
.error
(n_id
, "Type error: {name} is a formal type")
495 if not mod
.has_global_class_named
(name
) then
496 v
.error
(n_id
, "Type error: class {name} not found in module {mod}.")
501 var local_class
= mod
.class_by_name
(name
)
502 local_class
.global
.check_visibility
(v
, self, mod
)
506 redef meth get_unchecked_stype
(v
)
508 if _stype_cached
then return _stype_cache
511 var name
= n_id
.to_symbol
513 var cla
= v
.local_class
515 if cla
.formal_dict
.has_key
(name
) then
516 if n_types
.length
> 0 then
517 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
520 var formal
= cla
.formal_dict
[name
]
521 _stype_cache
= formal
525 if cla
.global_properties
!= null and cla
.has_global_property_by_name
(name
) then
526 if n_types
.length
> 0 then
527 v
.error
(self, "Type error: formal type {name} cannot have formal parameters.")
530 var t
= cla
.get_type
.local_class
.select_virtual_type
(name
).stype_for
(cla
.get_type
)
532 v
.error
(self, "Type error: circular definition in formal type {name}.")
539 var local_class
= get_local_class
(v
)
540 if local_class
== null then return null
542 var arity
= n_types
.length
543 if local_class
.arity
!= arity
then
544 v
.error
(self, "Type error: '{local_class}' has {local_class.arity} parameters which differs from the {arity} params.")
549 var tab
= new Array[MMType]
551 tab
.add
(p
.get_unchecked_stype
(v
))
553 var t
= local_class
.get_instantiate_type
(tab
)
557 var t
= local_class
.get_type
563 redef meth get_stype
(v
)
565 var t
= get_unchecked_stype
(v
)
566 if t
!= null then check_conform
(v
)
570 redef meth check_conform
(v
)
572 var st
= get_unchecked_stype
(v
)
573 if st
== null then return
574 var local_class
= st
.local_class
575 var arity
= n_types
.length
577 for i
in [0..arity
[ do
579 var pt
= p
.get_stype
(v
)
580 var bt
= local_class
.get_formal
(i
).bound
581 if bt
== null then return
582 bt
= bt
.adapt_to
(st
) # We need to abapt because of F-genericity
583 v
.check_conform
(p
, pt
, bt
)
591 # Is null for statement and for erronus expression
592 meth stype
: MMType is abstract
595 redef class AVardeclExpr
596 # Assiociated local variable
597 readable writable attr _variable
: VarVariable
600 redef class AForVardeclExpr
601 # Associated automatic local variable
602 readable writable attr _variable
: AutoVariable
605 redef class ASelfExpr
606 # Associated local variable
607 readable writable attr _variable
: ParamVariable
610 redef class AVarFormExpr
611 # Associated local variable
612 readable writable attr _variable
: Variable
615 redef class AClosureCallExpr
616 # Associated closure variable
617 readable writable attr _variable
: ClosureVariable
620 redef class PClosureDef
622 readable writable attr _closure
: MMClosure
624 # Automatic variables
625 readable writable attr _variables
: Array[AutoVariable]