1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 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 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.bound
= mclassdef
.mmodule
.model
.null_type
116 for npropdef
in nclassdef2
.n_propdefs
do
117 # Check ATypePropdef first since they may be required for the other properties
118 if not npropdef
isa ATypePropdef then continue
119 npropdef
.check_signature
(self)
122 for npropdef
in nclassdef2
.n_propdefs
do
123 if npropdef
isa ATypePropdef then continue
124 npropdef
.check_signature
(self)
127 process_default_constructors
(nclassdef
)
130 # the root init of the Object class
131 # Is usually implicitly defined
132 # Then explicit or implicit definitions of root-init are attached to it
133 var the_root_init_mmethod
: nullable MMethod
135 # Introduce or inherit default constructor
136 # This is the last part of `build_properties`.
137 private fun process_default_constructors
(nclassdef
: AClassdef)
139 var mclassdef
= nclassdef
.mclassdef
.as(not null)
141 # Are we a refinement
142 if not mclassdef
.is_intro
then return
144 # Look for the init in Object, or create it
145 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
146 # Create the implicit root-init method
147 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
148 mprop
.is_root_init
= true
149 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
150 var mparameters
= new Array[MParameter]
151 var msignature
= new MSignature(mparameters
, null)
152 mpropdef
.msignature
= msignature
153 mpropdef
.new_msignature
= msignature
155 nclassdef
.mfree_init
= mpropdef
156 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
157 the_root_init_mmethod
= mprop
161 # Is there already a constructor defined?
162 var defined_init
: nullable MMethodDef = null
163 for mpropdef
in mclassdef
.mpropdefs
do
164 if not mpropdef
isa MMethodDef then continue
165 if not mpropdef
.mproperty
.is_init
then continue
166 if mpropdef
.mproperty
.is_root_init
then
167 assert defined_init
== null
168 defined_init
= mpropdef
169 else if mpropdef
.mproperty
.name
== "init" then
170 # An explicit old-style init named "init", so return
175 if not nclassdef
isa AStdClassdef then return
177 # Collect undefined attributes
178 var mparameters
= new Array[MParameter]
179 var initializers
= new Array[MProperty]
180 for npropdef
in nclassdef
.n_propdefs
do
181 if npropdef
isa AMethPropdef then
182 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
183 if npropdef
.mpropdef
== null then return # Skip broken method
184 var sig
= npropdef
.mpropdef
.msignature
185 if sig
== null then continue # Skip broken method
187 for param
in sig
.mparameters
do
188 var ret_type
= param
.mtype
189 var mparameter
= new MParameter(param
.name
, ret_type
, false, ret_type
isa MNullableType)
190 mparameters
.add
(mparameter
)
192 initializers
.add
(npropdef
.mpropdef
.mproperty
)
193 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
195 if npropdef
isa AAttrPropdef then
196 var mreadpropdef
= npropdef
.mreadpropdef
197 if mreadpropdef
== null or mreadpropdef
.msignature
== null then return # Skip broken attribute
198 if npropdef
.noinit
then continue # Skip noinit attribute
199 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
200 if atlateinit
!= null then
201 # For lateinit attributes, call the reader to force
202 # the lazy initialization of the attribute.
203 initializers
.add
(mreadpropdef
.mproperty
)
204 mreadpropdef
.mproperty
.is_autoinit
= true
207 if npropdef
.has_value
then continue
208 var paramname
= mreadpropdef
.mproperty
.name
209 var ret_type
= mreadpropdef
.msignature
.return_mtype
210 if ret_type
== null then return
211 var mparameter
= new MParameter(paramname
, ret_type
, false, ret_type
isa MNullableType)
212 mparameters
.add
(mparameter
)
213 var msetter
= npropdef
.mwritepropdef
214 if msetter
== null then
215 # No setter, it is a readonly attribute, so just add it
216 initializers
.add
(npropdef
.mpropdef
.mproperty
)
217 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
219 # Add the setter to the list
220 initializers
.add
(msetter
.mproperty
)
221 msetter
.mproperty
.is_autoinit
= true
226 if the_root_init_mmethod
== null then return
228 # Look for most-specific new-stype init definitions
229 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
230 if spropdefs
.is_empty
then
231 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
235 # Look at the autoinit class-annotation
236 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
237 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
238 if autoinit
!= null then
239 # Just throws the collected initializers
243 if noautoinit
!= null then
244 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
247 if autoinit
.n_args
.is_empty
then
248 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
251 # Get and check each argument
252 for narg
in autoinit
.n_args
do
255 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
259 # Search the property.
260 # To avoid bad surprises, try to get the setter first.
261 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
263 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
266 error
(narg
, "Error: unknown method `{id}`")
269 if not p
.is_autoinit
then
270 error
(narg
, "Error: `{p}` is not an autoinit method")
274 # Register the initializer and the parameters
277 if pd
isa MMethodDef then
278 # Get the signature resolved for the current receiver
279 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
280 # Because the last parameter of setters is never default, try to default them for the autoinit.
281 for param
in sig
.mparameters
do
282 if not param
.is_default
and param
.mtype
isa MNullableType then
283 param
= new MParameter(param
.name
, param
.mtype
, param
.is_vararg
, true)
285 mparameters
.add
(param
)
293 # Search the longest-one and checks for conflict
294 var longest
= spropdefs
.first
295 if spropdefs
.length
> 1 then
296 # part 1. find the longest list
297 for spd
in spropdefs
do
298 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
301 # Check for conflict in the order of initializers
302 # Each initializer list must me a prefix of the longest list
303 # If `noautoinit` is set, just ignore conflicts
304 if noautoinit
== null then for spd
in spropdefs
do
306 for p
in spd
.initializers
do
307 if p
!= longest
.initializers
[i
] then
308 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
309 # TODO: invalidate the initializer to avoid more errors
317 if noautoinit
!= null then
318 # If there is local or inherited initializers, then complain.
319 if initializers
.is_empty
and longest
.initializers
.is_empty
then
320 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
322 # Just clear initializers
326 # Can we just inherit?
327 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
328 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
329 mclassdef
.mclass
.root_init
= longest
333 # Combine the inherited list to what is collected
334 if longest
.initializers
.length
> 0 then
335 mparameters
.prepend longest
.new_msignature
.mparameters
336 initializers
.prepend longest
.initializers
341 # If we already have a basic init definition, then setup its initializers
342 if defined_init
!= null then
343 defined_init
.initializers
.add_all
(initializers
)
344 var msignature
= new MSignature(mparameters
, null)
345 defined_init
.new_msignature
= msignature
346 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
347 mclassdef
.mclass
.root_init
= defined_init
351 # Else create the local implicit basic init definition
352 var mprop
= the_root_init_mmethod
.as(not null)
353 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
354 mpropdef
.has_supercall
= true
355 mpropdef
.initializers
.add_all
(initializers
)
356 var msignature
= new MSignature(mparameters
, null)
357 mpropdef
.new_msignature
= msignature
358 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
359 nclassdef
.mfree_init
= mpropdef
360 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
361 mclassdef
.mclass
.root_init
= mpropdef
364 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
365 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
367 var mmodule
= mpropdef
.mclassdef
.mmodule
368 var mproperty
= mpropdef
.mproperty
370 # Extract visibility information of the main part of `mtype`
371 # It is a case-by case
372 var vis_type
: nullable MVisibility = null # The own visibility of the type
373 var mmodule_type
: nullable MModule = null # The original module of the type
374 mtype
= mtype
.undecorate
375 if mtype
isa MClassType then
376 vis_type
= mtype
.mclass
.visibility
377 mmodule_type
= mtype
.mclass
.intro
.mmodule
378 else if mtype
isa MVirtualType then
379 vis_type
= mtype
.mproperty
.visibility
380 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
381 else if mtype
isa MParameterType then
382 # nothing, always visible
383 else if mtype
isa MNullType then
386 node
.debug
"Unexpected type {mtype}"
390 if vis_type
!= null then
391 assert mmodule_type
!= null
392 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
393 if mproperty
.visibility
> vis_type
then
394 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
396 else if mproperty
.visibility
> vis_module_type
then
397 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
402 # No error, try to go deeper in generic types
403 if node
isa AType then
404 for a
in node
.n_types
do
406 if t
== null then continue # Error, thus skipped
407 check_visibility
(a
, t
, mpropdef
)
409 else if mtype
isa MGenericType then
410 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
414 # Detect circularity errors for virtual types.
415 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
418 # Slow case: progress on each resolution until we visit all without getting a loop
420 # The graph used to detect loops
421 var mtype
= mproperty
.mvirtualtype
422 var poset
= new POSet[MType]
424 # The work-list of types to resolve
425 var todo
= new List[MType]
428 while not todo
.is_empty
do
432 if not t
.need_anchor
then continue
434 # Get the types derived of `t` (subtypes and bounds)
436 if t
isa MNullableType then
438 else if t
isa MGenericType then
440 else if t
isa MVirtualType then
442 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
443 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
444 # TODO something to manage correctly bound conflicts
445 assert not defs
.is_empty
446 nexts
= new Array[MType]
448 var next
= defs
.first
.bound
449 if next
== null then return false
452 else if t
isa MClassType then
453 # Basic type, nothing to to
455 else if t
isa MParameterType then
456 # Parameter types cannot depend on virtual types, so nothing to do
464 if poset
.has_edge
(next
, t
) then
465 if mtype
== next
then
466 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
468 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
472 poset
.add_edge
(t
, next
)
482 # Does the MPropDef contains a call to super or a call of a super-constructor?
483 # Subsequent phases of the frontend (esp. typing) set it if required
484 var has_supercall
: Bool = false is writable
487 redef class AClassdef
488 # Marker used in `ModelBuilder::build_properties`
489 private var build_properties_is_done
= false
491 # The free init (implicitely constructed by the class if required)
492 var mfree_init
: nullable MMethodDef = null
496 # The base init of the class.
497 # Used to get the common new_msignature and initializers
499 # TODO: Where to put this information is not clear because unlike other
500 # informations, the initialisers are stable in a same class.
501 var root_init
: nullable MMethodDef = null
504 redef class MClassDef
505 # What is the `APropdef` associated to a `MProperty`?
506 # Used to check multiple definition of a property.
507 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
509 # Build the virtual type `SELF` only for introduction `MClassDef`
510 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
512 if not is_intro
then return
515 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
517 # If SELF type is declared nowherer?
518 if mprop
== null then return
520 # SELF is not a virtual type? it is weird but we ignore it
521 if not mprop
isa MVirtualTypeProp then return
523 # Is this the intro of SELF in the library?
524 var intro
= mprop
.intro
525 var intro_mclassdef
= intro
.mclassdef
526 if intro_mclassdef
== self then
527 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
529 # SELF must be declared in Object, otherwise this will create conflicts
530 if intro_mclassdef
.mclass
.name
!= "Object" then
531 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
534 # SELF must be public
535 if mprop
.visibility
!= public_visibility
then
536 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
539 # SELF must not be fixed
540 if intro
.is_fixed
then
541 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
547 # This class introduction inherits a SELF
548 # We insert an artificial property to update it
549 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
550 mpropdef
.bound
= mclass
.mclass_type
555 # The associated main model entity
556 type MPROPDEF: MPropDef
558 # The associated propdef once build by a `ModelBuilder`
559 var mpropdef
: nullable MPROPDEF is writable
561 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
562 private fun build_signature
(modelbuilder
: ModelBuilder) do end
563 private fun check_signature
(modelbuilder
: ModelBuilder) do end
564 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
566 var mvisibility
= public_visibility
567 if nvisibility
!= null then
568 mvisibility
= nvisibility
.mvisibility
569 if mvisibility
== intrude_visibility
then
570 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
571 mvisibility
= public_visibility
574 if mclassdef
.mclass
.visibility
== private_visibility
then
575 if mvisibility
== protected_visibility
then
576 assert nvisibility
!= null
577 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
578 else if mvisibility
== private_visibility
then
579 assert nvisibility
!= null
580 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
582 mvisibility
= private_visibility
587 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
589 var ndoc
= self.n_doc
591 var mdoc
= ndoc
.to_mdoc
593 mdoc
.original_mentity
= mpropdef
594 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
595 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
598 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
599 if at_deprecated
!= null then
600 if not mpropdef
.is_intro
then
601 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
603 var info
= new MDeprecationInfo
604 ndoc
= at_deprecated
.n_doc
605 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
606 mpropdef
.mproperty
.deprecation
= info
611 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
613 if nvisibility
== null then return
614 var mvisibility
= nvisibility
.mvisibility
615 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
616 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
620 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
622 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
623 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
626 if mprop
isa MMethod and mprop
.is_root_init
then return true
627 if kwredef
== null then
629 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
633 # Check for full-name conflicts in the project.
634 # A public property should have a unique qualified name `project::class::prop`.
635 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
636 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
637 if others
!= null then for other
in others
do
638 if other
!= mprop
and other
.intro_mclassdef
.mmodule
.mgroup
!= null and other
.intro_mclassdef
.mmodule
.mgroup
.mproject
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mproject
and other
.intro_mclassdef
.mclass
.name
== mprop
.intro_mclassdef
.mclass
.name
and other
.visibility
>= protected_visibility
then
639 modelbuilder
.advice
(self, "full-name-conflict", "Warning: A property named `{other.full_name}` is already defined in module `{other.intro_mclassdef.mmodule}` for the class `{other.intro_mclassdef.mclass.name}`.")
645 if not need_redef
then
646 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
653 # Checks for useless type in redef signatures.
654 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
657 redef class ASignature
658 # Is the model builder has correctly visited the signature
659 var is_visited
= false
660 # Names of parameters from the AST
661 # REQUIRE: is_visited
662 var param_names
= new Array[String]
663 # Types of parameters from the AST
664 # REQUIRE: is_visited
665 var param_types
= new Array[MType]
666 # Rank of the vararg (of -1 if none)
667 # REQUIRE: is_visited
668 var vararg_rank
: Int = -1
670 var ret_type
: nullable MType = null
672 # Visit and fill information about a signature
673 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
675 var mmodule
= mclassdef
.mmodule
676 var param_names
= self.param_names
677 var param_types
= self.param_types
678 for np
in self.n_params
do
679 param_names
.add
(np
.n_id
.text
)
680 var ntype
= np
.n_type
681 if ntype
!= null then
682 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
683 if mtype
== null then return false # Skip error
684 for i
in [0..param_names
.length-param_types
.length
[ do
685 param_types
.add
(mtype
)
687 if np
.n_dotdotdot
!= null then
688 if self.vararg_rank
!= -1 then
689 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
692 self.vararg_rank
= param_names
.length
- 1
697 var ntype
= self.n_type
698 if ntype
!= null then
699 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
700 if self.ret_type
== null then return false # Skip error
703 self.is_visited
= true
707 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
710 for np
in self.n_params
do
711 var ntype
= np
.n_type
712 if ntype
!= null then
713 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
718 var ntype
= self.n_type
719 if ntype
!= null then
720 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
729 # The associated mparameter if any
730 var mparameter
: nullable MParameter = null
733 redef class AMethPropdef
734 redef type MPROPDEF: MMethodDef
736 # Is the method annotated `autoinit`?
737 var is_autoinit
= false
739 # Can self be used as a root init?
740 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
742 # Need the `init` keyword
743 if n_kwinit
== null then return false
744 # Need to by anonymous
745 if self.n_methid
!= null then return false
746 # No annotation on itself
747 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
749 var amod
= self.parent
.parent
.as(AModule)
750 var amoddecl
= amod
.n_moduledecl
751 if amoddecl
!= null then
752 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
753 if old
!= null then return false
756 if self.n_signature
.n_params
.length
> 0 then
757 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
760 # Cannot be private or something
761 if not self.n_visibility
isa APublicVisibility then
762 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
769 redef fun build_property
(modelbuilder
, mclassdef
)
771 var n_kwinit
= n_kwinit
772 var n_kwnew
= n_kwnew
773 var is_init
= n_kwinit
!= null or n_kwnew
!= null
775 var amethodid
= self.n_methid
777 if amethodid
== null then
781 else if n_kwinit
!= null then
784 else if n_kwnew
!= null then
790 else if amethodid
isa AIdMethid then
791 name
= amethodid
.n_id
.text
792 name_node
= amethodid
794 # operator, bracket or assign
795 name
= amethodid
.collect_text
796 name_node
= amethodid
798 var arity
= self.n_signature
.n_params
.length
799 if name
== "+" and arity
== 0 then
801 else if name
== "-" and arity
== 0 then
803 else if name
== "~" and arity
== 0 then
806 if amethodid
.is_binary
and arity
!= 1 then
807 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
808 else if amethodid
.min_arity
> arity
then
809 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
814 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
815 var mprop
: nullable MMethod = null
816 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
817 if mprop
== null and look_like_a_root_init
then
818 mprop
= modelbuilder
.the_root_init_mmethod
820 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
821 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
824 if mprop
== null then
825 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
826 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
827 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
828 modelbuilder
.the_root_init_mmethod
= mprop
829 mprop
.is_root_init
= true
831 mprop
.is_init
= is_init
832 mprop
.is_new
= n_kwnew
!= null
833 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
834 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
835 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
837 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
838 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
841 # Check name conflicts in the local class for constructors.
843 for p
, n
in mclassdef
.mprop2npropdef
do
844 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
845 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
851 mclassdef
.mprop2npropdef
[mprop
] = self
853 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
855 set_doc
(mpropdef
, modelbuilder
)
857 self.mpropdef
= mpropdef
858 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
859 if mpropdef
.is_intro
then
860 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
862 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
866 redef fun build_signature
(modelbuilder
)
868 var mpropdef
= self.mpropdef
869 if mpropdef
== null then return # Error thus skiped
870 var mclassdef
= mpropdef
.mclassdef
871 var mmodule
= mclassdef
.mmodule
872 var nsig
= self.n_signature
874 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
875 var root_init
= mclassdef
.mclass
.root_init
876 if root_init
!= null then
877 # Inherit the initializers by refinement
878 mpropdef
.new_msignature
= root_init
.new_msignature
879 assert mpropdef
.initializers
.is_empty
880 mpropdef
.initializers
.add_all root_init
.initializers
884 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
885 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
887 # Retrieve info from the signature AST
888 var param_names
= new Array[String] # Names of parameters from the AST
889 var param_types
= new Array[MType] # Types of parameters from the AST
891 var ret_type
: nullable MType = null # Return type from the AST
893 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
894 param_names
= nsig
.param_names
895 param_types
= nsig
.param_types
896 vararg_rank
= nsig
.vararg_rank
897 ret_type
= nsig
.ret_type
900 # Look for some signature to inherit
901 # FIXME: do not inherit from the intro, but from the most specific
902 var msignature
: nullable MSignature = null
903 if not mpropdef
.is_intro
then
904 msignature
= mpropdef
.mproperty
.intro
.msignature
905 if msignature
== null then return # Skip error
907 # The local signature is adapted to use the local formal types, if any.
908 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
910 # Check inherited signature arity
911 if param_names
.length
!= msignature
.arity
then
913 if nsig
!= null then node
= nsig
else node
= self
914 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mpropdef.mproperty.name}{msignature}`; got {param_names.length}. See introduction at `{mpropdef.mproperty.full_name}`.")
917 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
918 # FIXME UGLY: inherit signature from a super-constructor
919 for msupertype
in mclassdef
.supertypes
do
920 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
921 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
922 if candidate
!= null then
923 if msignature
== null then
924 msignature
= candidate
.intro
.as(MMethodDef).msignature
931 # Inherit the signature
932 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
933 # Parameters are untyped, thus inherit them
934 param_types
= new Array[MType]
935 for mparameter
in msignature
.mparameters
do
936 param_types
.add
(mparameter
.mtype
)
938 vararg_rank
= msignature
.vararg_rank
940 if msignature
!= null and ret_type
== null then
941 ret_type
= msignature
.return_mtype
944 if param_names
.length
!= param_types
.length
then
945 # Some parameters are typed, other parameters are not typed.
946 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
950 var mparameters
= new Array[MParameter]
951 for i
in [0..param_names
.length
[ do
952 var is_default
= false
953 if vararg_rank
== -1 and param_types
[i
] isa MNullableType then
954 if i
< param_names
.length-1
or accept_special_last_parameter
then
958 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
, is_default
)
959 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
960 mparameters
.add
(mparameter
)
963 # In `new`-factories, the return type is by default the classtype.
964 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
966 # Special checks for operator methods
967 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
968 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
970 if ret_type
== null and return_is_mandatory
then
971 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
974 msignature
= new MSignature(mparameters
, ret_type
)
975 mpropdef
.msignature
= msignature
976 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
977 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
978 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
981 var at
= self.get_single_annotation
("lazy", modelbuilder
)
982 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
984 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
985 if atautoinit
!= null then
986 if not mpropdef
.is_intro
then
987 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
988 else if not mclassdef
.is_intro
then
989 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
991 self.is_autoinit
= true
996 redef fun check_signature
(modelbuilder
)
998 var mpropdef
= self.mpropdef
999 if mpropdef
== null then return # Error thus skiped
1000 var mclassdef
= mpropdef
.mclassdef
1001 var mmodule
= mclassdef
.mmodule
1002 var nsig
= self.n_signature
1003 var mysignature
= self.mpropdef
.msignature
1004 if mysignature
== null then return # Error thus skiped
1007 if nsig
!= null then
1008 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1009 self.mpropdef
.msignature
= null # invalidate
1010 return # Forward error
1014 # Lookup for signature in the precursor
1015 # FIXME all precursors should be considered
1016 if not mpropdef
.is_intro
then
1017 var msignature
= mpropdef
.mproperty
.intro
.msignature
1018 if msignature
== null then return
1020 var precursor_ret_type
= msignature
.return_mtype
1021 var ret_type
= mysignature
.return_mtype
1022 if ret_type
!= null and precursor_ret_type
== null then
1023 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1024 self.mpropdef
.msignature
= null
1028 if mysignature
.arity
> 0 then
1029 # Check parameters types
1030 for i
in [0..mysignature
.arity
[ do
1031 var myt
= mysignature
.mparameters
[i
].mtype
1032 var prt
= msignature
.mparameters
[i
].mtype
1033 var node
= nsig
.n_params
[i
]
1034 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1035 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1036 self.mpropdef
.msignature
= null
1040 if precursor_ret_type
!= null then
1041 var node
: nullable ANode = null
1042 if nsig
!= null then node
= nsig
.n_type
1043 if node
== null then node
= self
1044 if ret_type
== null then
1045 # Inherit the return type
1046 ret_type
= precursor_ret_type
1047 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1048 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1049 self.mpropdef
.msignature
= null
1054 if mysignature
.arity
> 0 then
1055 # Check parameters visibility
1056 for i
in [0..mysignature
.arity
[ do
1057 var nt
= nsig
.n_params
[i
].n_type
1058 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1060 var nt
= nsig
.n_type
1061 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1063 check_repeated_types
(modelbuilder
)
1066 # For parameters, type is always useless in a redef.
1067 # For return type, type is useless if not covariant with introduction.
1068 redef fun check_repeated_types
(modelbuilder
) do
1069 if mpropdef
.is_intro
or n_signature
== null then return
1071 for param
in n_signature
.n_params
do
1072 if param
.n_type
!= null then
1073 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1077 var intro
= mpropdef
.mproperty
.intro
1078 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1079 if n_intro
== null or not n_intro
isa AMethPropdef then return
1081 var ret_type
= n_signature
.ret_type
1082 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1083 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1089 # Is a return required?
1091 # * True for operators and brackets.
1092 # * False for id and assignment.
1093 fun return_is_mandatory
: Bool do return true
1095 # Can the last parameter be special like a vararg?
1097 # * False for operators: the last one is in fact the only one.
1098 # * False for assignments: it is the right part of the assignment.
1099 # * True for ids and brackets.
1100 fun accept_special_last_parameter
: Bool do return false
1102 # The minimum required number of parameters.
1104 # * 1 for binary operators
1106 # * 1 for assignments
1107 # * 2 for bracket assignments
1109 fun min_arity
: Int do return 1
1111 # Is the `self` a binary operator?
1112 fun is_binary
: Bool do return true
1115 redef class AIdMethid
1116 redef fun return_is_mandatory
do return false
1117 redef fun accept_special_last_parameter
do return true
1118 redef fun min_arity
do return 0
1119 redef fun is_binary
do return false
1122 redef class ABraMethid
1123 redef fun accept_special_last_parameter
do return true
1124 redef fun is_binary
do return false
1127 redef class ABraassignMethid
1128 redef fun return_is_mandatory
do return false
1129 redef fun min_arity
do return 2
1130 redef fun is_binary
do return false
1133 redef class AAssignMethid
1134 redef fun return_is_mandatory
do return false
1135 redef fun is_binary
do return false
1138 redef class AAttrPropdef
1139 redef type MPROPDEF: MAttributeDef
1141 # The static type of the property (declared, inferred or inherited)
1142 # This attribute is also used to check if the property was analyzed and is valid.
1143 var mtype
: nullable MType
1145 # Is the node tagged `noinit`?
1148 # Is the node tagged lazy?
1151 # Has the node a default value?
1152 # Could be through `n_expr` or `n_block`
1153 var has_value
= false
1155 # The guard associated to a lazy attribute.
1156 # Because some engines does not have a working `isset`,
1157 # this additional attribute is used to guard the lazy initialization.
1158 # TODO: to remove once isset is correctly implemented
1159 var mlazypropdef
: nullable MAttributeDef
1161 # The associated getter (read accessor) if any
1162 var mreadpropdef
: nullable MMethodDef is writable
1163 # The associated setter (write accessor) if any
1164 var mwritepropdef
: nullable MMethodDef is writable
1166 redef fun build_property
(modelbuilder
, mclassdef
)
1168 var mclass
= mclassdef
.mclass
1170 var name
= nid2
.text
1172 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1173 if atabstract
== null then
1174 if not mclass
.kind
.need_init
then
1175 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1178 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1179 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1180 self.mpropdef
= mpropdef
1181 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1185 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1186 if mreadprop
== null then
1187 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1188 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1189 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1191 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1192 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1194 mclassdef
.mprop2npropdef
[mreadprop
] = self
1196 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1197 self.mreadpropdef
= mreadpropdef
1198 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1199 set_doc
(mreadpropdef
, modelbuilder
)
1200 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1201 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1203 has_value
= n_expr
!= null or n_block
!= null
1205 if atabstract
!= null and has_value
then
1206 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1210 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1211 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1212 if atnoinit
!= null then
1215 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1218 if atabstract
!= null then
1219 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1223 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1224 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1225 if atlazy
!= null or atlateinit
!= null then
1226 if atlazy
!= null and atlateinit
!= null then
1227 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1230 if not has_value
then
1231 if atlazy
!= null then
1232 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1233 else if atlateinit
!= null then
1234 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1240 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1241 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1242 self.mlazypropdef
= mlazypropdef
1245 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1246 if atreadonly
!= null then
1247 if not has_value
then
1248 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1250 # No setter, so just leave
1254 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1255 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1258 var writename
= name
+ "="
1259 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1260 if atwritable
!= null then
1261 if not atwritable
.n_args
.is_empty
then
1262 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1265 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1266 var nwkwredef
: nullable Token = null
1267 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1268 if mwriteprop
== null then
1270 if atwritable
!= null then
1271 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1273 mvisibility
= mreadprop
.visibility
1274 # By default, use protected visibility at most
1275 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1277 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1278 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1279 mwriteprop
.deprecation
= mreadprop
.deprecation
1281 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1282 if atwritable
!= null then
1283 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1286 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1288 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1289 self.mwritepropdef
= mwritepropdef
1290 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1291 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1292 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1294 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1295 if atautoinit
!= null then
1297 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1298 else if not mwritepropdef
.is_intro
then
1299 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1300 else if not mclassdef
.is_intro
then
1301 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1302 else if atabstract
== null then
1303 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1305 else if atabstract
!= null then
1306 # By default, abstract attribute are not autoinit
1311 redef fun build_signature
(modelbuilder
)
1313 var mreadpropdef
= self.mreadpropdef
1314 var mpropdef
= self.mpropdef
1315 if mreadpropdef
== null then return # Error thus skipped
1316 var mclassdef
= mreadpropdef
.mclassdef
1317 var mmodule
= mclassdef
.mmodule
1318 var mtype
: nullable MType = null
1321 var ntype
= self.n_type
1322 if ntype
!= null then
1323 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1324 if mtype
== null then return
1327 var inherited_type
: nullable MType = null
1328 # Inherit the type from the getter (usually an abstract getter)
1329 if not mreadpropdef
.is_intro
then
1330 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1331 if msignature
== null then return # Error, thus skipped
1332 inherited_type
= msignature
.return_mtype
1333 if inherited_type
!= null then
1334 # The inherited type is adapted to use the local formal types, if any.
1335 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1336 if mtype
== null then mtype
= inherited_type
1340 var nexpr
= self.n_expr
1341 if mtype
== null then
1342 if nexpr
!= null then
1343 if nexpr
isa ANewExpr then
1344 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1345 else if nexpr
isa AIntExpr then
1346 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1347 if cla
!= null then mtype
= cla
.mclass_type
1348 else if nexpr
isa AByteExpr then
1349 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1350 if cla
!= null then mtype
= cla
.mclass_type
1351 else if nexpr
isa AFloatExpr then
1352 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1353 if cla
!= null then mtype
= cla
.mclass_type
1354 else if nexpr
isa ACharExpr then
1355 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1356 if cla
!= null then mtype
= cla
.mclass_type
1357 else if nexpr
isa ABoolExpr then
1358 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1359 if cla
!= null then mtype
= cla
.mclass_type
1360 else if nexpr
isa ASuperstringExpr then
1361 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1362 if cla
!= null then mtype
= cla
.mclass_type
1363 else if nexpr
isa AStringFormExpr then
1364 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1365 if cla
!= null then mtype
= cla
.mclass_type
1367 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1370 if mtype
== null then return
1372 else if ntype
!= null and inherited_type
== mtype
then
1373 if nexpr
isa ANewExpr then
1374 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1375 if xmtype
== mtype
then
1376 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1381 if mtype
== null then
1382 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1388 if mpropdef
!= null then
1389 mpropdef
.static_mtype
= mtype
1393 var msignature
= new MSignature(new Array[MParameter], mtype
)
1394 mreadpropdef
.msignature
= msignature
1397 var mwritepropdef
= self.mwritepropdef
1398 if mwritepropdef
!= null then
1401 var mparameter
= new MParameter(name
, mtype
, false, false)
1402 var msignature
= new MSignature([mparameter
], null)
1403 mwritepropdef
.msignature
= msignature
1406 var mlazypropdef
= self.mlazypropdef
1407 if mlazypropdef
!= null then
1408 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1410 check_repeated_types
(modelbuilder
)
1413 redef fun check_signature
(modelbuilder
)
1415 var mpropdef
= self.mpropdef
1416 if mpropdef
== null then return # Error thus skipped
1417 var ntype
= self.n_type
1418 var mtype
= self.mtype
1419 if mtype
== null then return # Error thus skipped
1421 var mclassdef
= mpropdef
.mclassdef
1422 var mmodule
= mclassdef
.mmodule
1425 if ntype
!= null then
1426 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1429 if nexpr
isa ANewExpr then
1430 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1433 # Lookup for signature in the precursor
1434 # FIXME all precursors should be considered
1435 if not mpropdef
.is_intro
then
1436 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1437 if precursor_type
== null then return
1439 if mtype
!= precursor_type
then
1440 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1445 # Check getter and setter
1446 var meth
= self.mreadpropdef
1447 if meth
!= null then
1448 self.check_method_signature
(modelbuilder
, meth
)
1449 var node
: nullable ANode = ntype
1450 if node
== null then node
= self
1451 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1453 meth
= self.mwritepropdef
1454 if meth
!= null then
1455 self.check_method_signature
(modelbuilder
, meth
)
1456 var node
: nullable ANode = ntype
1457 if node
== null then node
= self
1458 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1462 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1464 var mclassdef
= mpropdef
.mclassdef
1465 var mmodule
= mclassdef
.mmodule
1466 var nsig
= self.n_type
1467 var mysignature
= mpropdef
.msignature
1468 if mysignature
== null then return # Error thus skiped
1470 # Lookup for signature in the precursor
1471 # FIXME all precursors should be considered
1472 if not mpropdef
.is_intro
then
1473 var msignature
= mpropdef
.mproperty
.intro
.msignature
1474 if msignature
== null then return
1476 if mysignature
.arity
!= msignature
.arity
then
1478 if nsig
!= null then node
= nsig
else node
= self
1479 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mpropdef.mproperty.name}{msignature}`; got {mysignature.arity}. See introduction at `{mpropdef.mproperty.full_name}`.")
1482 var precursor_ret_type
= msignature
.return_mtype
1483 var ret_type
= mysignature
.return_mtype
1484 if ret_type
!= null and precursor_ret_type
== null then
1486 if nsig
!= null then node
= nsig
else node
= self
1487 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1491 if mysignature
.arity
> 0 then
1492 # Check parameters types
1493 for i
in [0..mysignature
.arity
[ do
1494 var myt
= mysignature
.mparameters
[i
].mtype
1495 var prt
= msignature
.mparameters
[i
].mtype
1497 if nsig
!= null then node
= nsig
else node
= self
1498 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1499 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1503 if precursor_ret_type
!= null then
1505 if nsig
!= null then node
= nsig
else node
= self
1506 if ret_type
== null then
1507 # Inherit the return type
1508 ret_type
= precursor_ret_type
1509 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1510 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1516 # Type is useless if the attribute type is the same thant the intro.
1517 redef fun check_repeated_types
(modelbuilder
) do
1518 if mreadpropdef
.is_intro
or n_type
== null then return
1520 var intro
= mreadpropdef
.mproperty
.intro
1521 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1522 if n_intro
== null then return
1525 if n_intro
isa AMethPropdef then
1526 ntype
= n_intro
.n_signature
.ret_type
1527 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1528 ntype
= n_intro
.n_type
.mtype
1531 if ntype
==null or ntype
!= n_type
.mtype
then return
1532 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1536 redef class ATypePropdef
1537 redef type MPROPDEF: MVirtualTypeDef
1539 redef fun build_property
(modelbuilder
, mclassdef
)
1541 var name
= self.n_id
.text
1542 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1543 if mprop
== null then
1544 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1545 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1546 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1547 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1550 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1552 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1553 assert mprop
isa MVirtualTypeProp
1554 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1556 mclassdef
.mprop2npropdef
[mprop
] = self
1558 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1559 self.mpropdef
= mpropdef
1560 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1561 if mpropdef
.is_intro
then
1562 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1564 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1566 set_doc
(mpropdef
, modelbuilder
)
1568 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1569 if atfixed
!= null then
1570 mpropdef
.is_fixed
= true
1574 redef fun build_signature
(modelbuilder
)
1576 var mpropdef
= self.mpropdef
1577 if mpropdef
== null then return # Error thus skipped
1578 var mclassdef
= mpropdef
.mclassdef
1579 var mmodule
= mclassdef
.mmodule
1580 var mtype
: nullable MType = null
1582 var ntype
= self.n_type
1583 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1584 if mtype
== null then return
1586 mpropdef
.bound
= mtype
1587 # print "{mpropdef}: {mtype}"
1590 redef fun check_signature
(modelbuilder
)
1592 var mpropdef
= self.mpropdef
1593 if mpropdef
== null then return # Error thus skipped
1595 var bound
= mpropdef
.bound
1596 if bound
== null then return # Error thus skipped
1598 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1600 var mclassdef
= mpropdef
.mclassdef
1601 var mmodule
= mclassdef
.mmodule
1602 var anchor
= mclassdef
.bound_mtype
1604 var ntype
= self.n_type
1605 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1606 mpropdef
.bound
= null
1610 # Check redefinitions
1611 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1612 var supbound
= p
.bound
1613 if supbound
== null then break # broken super bound, skip error
1615 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1618 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1619 # Still a warning to pass existing bad code
1620 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1623 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1624 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")