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 the class forbid constructors?
162 if not mclassdef
.mclass
.kind
.need_init
then return
164 # Is there already a constructor defined?
165 var defined_init
: nullable MMethodDef = null
166 for mpropdef
in mclassdef
.mpropdefs
do
167 if not mpropdef
isa MMethodDef then continue
168 if not mpropdef
.mproperty
.is_init
then continue
169 if mpropdef
.mproperty
.is_root_init
then
170 assert defined_init
== null
171 defined_init
= mpropdef
172 else if mpropdef
.mproperty
.name
== "init" then
173 # An explicit old-style init named "init", so return
178 if not nclassdef
isa AStdClassdef then return
180 # Collect undefined attributes
181 var mparameters
= new Array[MParameter]
182 var initializers
= new Array[MProperty]
183 for npropdef
in nclassdef
.n_propdefs
do
184 if npropdef
isa AMethPropdef then
185 if npropdef
.mpropdef
== null then return # Skip broken method
186 var at
= npropdef
.get_single_annotation
("autoinit", self)
187 if at
== null then continue # Skip non tagged init
189 var sig
= npropdef
.mpropdef
.msignature
190 if sig
== null then continue # Skip broken method
192 if not npropdef
.mpropdef
.is_intro
then
193 self.error
(at
, "Error: `autoinit` cannot be set on redefinitions.")
197 for param
in sig
.mparameters
do
198 var ret_type
= param
.mtype
199 var mparameter
= new MParameter(param
.name
, ret_type
, false, ret_type
isa MNullableType)
200 mparameters
.add
(mparameter
)
202 initializers
.add
(npropdef
.mpropdef
.mproperty
)
203 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
205 if npropdef
isa AAttrPropdef then
206 var mreadpropdef
= npropdef
.mreadpropdef
207 if mreadpropdef
== null or mreadpropdef
.msignature
== null then return # Skip broken attribute
208 if npropdef
.noinit
then continue # Skip noinit attribute
209 var atautoinit
= npropdef
.get_single_annotation
("autoinit", self)
210 if atautoinit
!= null then
211 # For autoinit attributes, call the reader to force
212 # the lazy initialization of the attribute.
213 initializers
.add
(mreadpropdef
.mproperty
)
214 mreadpropdef
.mproperty
.is_autoinit
= true
217 if npropdef
.has_value
then continue
218 var paramname
= mreadpropdef
.mproperty
.name
219 var ret_type
= mreadpropdef
.msignature
.return_mtype
220 if ret_type
== null then return
221 var mparameter
= new MParameter(paramname
, ret_type
, false, ret_type
isa MNullableType)
222 mparameters
.add
(mparameter
)
223 var msetter
= npropdef
.mwritepropdef
224 if msetter
== null then
225 # No setter, it is a readonly attribute, so just add it
226 initializers
.add
(npropdef
.mpropdef
.mproperty
)
227 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
229 # Add the setter to the list
230 initializers
.add
(msetter
.mproperty
)
231 msetter
.mproperty
.is_autoinit
= true
236 if the_root_init_mmethod
== null then return
238 # Look for most-specific new-stype init definitions
239 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
240 if spropdefs
.is_empty
then
241 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
245 # Look at the autoinit class-annotation
246 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
247 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
248 if autoinit
!= null then
249 # Just throws the collected initializers
253 if noautoinit
!= null then
254 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
257 if autoinit
.n_args
.is_empty
then
258 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
261 # Get and check each argument
262 for narg
in autoinit
.n_args
do
265 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
269 # Search the property.
270 # To avoid bad surprises, try to get the setter first.
271 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
273 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
276 error
(narg
, "Error: unknown method `{id}`")
279 if not p
.is_autoinit
then
280 error
(narg
, "Error: `{p}` is not an autoinit method")
284 # Register the initializer and the parameters
287 if pd
isa MMethodDef then
288 # Get the signature resolved for the current receiver
289 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
290 # Because the last parameter of setters is never default, try to default them for the autoinit.
291 for param
in sig
.mparameters
do
292 if not param
.is_default
and param
.mtype
isa MNullableType then
293 param
= new MParameter(param
.name
, param
.mtype
, param
.is_vararg
, true)
295 mparameters
.add
(param
)
303 # Search the longest-one and checks for conflict
304 var longest
= spropdefs
.first
305 if spropdefs
.length
> 1 then
306 # part 1. find the longest list
307 for spd
in spropdefs
do
308 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
311 # Check for conflict in the order of initializers
312 # Each initializer list must me a prefix of the longest list
313 # If `noautoinit` is set, just ignore conflicts
314 if noautoinit
== null then for spd
in spropdefs
do
316 for p
in spd
.initializers
do
317 if p
!= longest
.initializers
[i
] then
318 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
319 # TODO: invalidate the initializer to avoid more errors
327 if noautoinit
!= null then
328 # If there is local or inherited initializers, then complain.
329 if initializers
.is_empty
and longest
.initializers
.is_empty
then
330 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
332 # Just clear initializers
336 # Can we just inherit?
337 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
338 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
339 mclassdef
.mclass
.root_init
= longest
343 # Combine the inherited list to what is collected
344 if longest
.initializers
.length
> 0 then
345 mparameters
.prepend longest
.new_msignature
.mparameters
346 initializers
.prepend longest
.initializers
351 # If we already have a basic init definition, then setup its initializers
352 if defined_init
!= null then
353 defined_init
.initializers
.add_all
(initializers
)
354 var msignature
= new MSignature(mparameters
, null)
355 defined_init
.new_msignature
= msignature
356 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
357 mclassdef
.mclass
.root_init
= defined_init
361 # Else create the local implicit basic init definition
362 var mprop
= the_root_init_mmethod
.as(not null)
363 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
364 mpropdef
.has_supercall
= true
365 mpropdef
.initializers
.add_all
(initializers
)
366 var msignature
= new MSignature(mparameters
, null)
367 mpropdef
.new_msignature
= msignature
368 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
369 nclassdef
.mfree_init
= mpropdef
370 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
371 mclassdef
.mclass
.root_init
= mpropdef
374 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
375 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
377 var mmodule
= mpropdef
.mclassdef
.mmodule
378 var mproperty
= mpropdef
.mproperty
380 # Extract visibility information of the main part of `mtype`
381 # It is a case-by case
382 var vis_type
: nullable MVisibility = null # The own visibility of the type
383 var mmodule_type
: nullable MModule = null # The original module of the type
384 mtype
= mtype
.undecorate
385 if mtype
isa MClassType then
386 vis_type
= mtype
.mclass
.visibility
387 mmodule_type
= mtype
.mclass
.intro
.mmodule
388 else if mtype
isa MVirtualType then
389 vis_type
= mtype
.mproperty
.visibility
390 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
391 else if mtype
isa MParameterType then
392 # nothing, always visible
393 else if mtype
isa MNullType then
396 node
.debug
"Unexpected type {mtype}"
400 if vis_type
!= null then
401 assert mmodule_type
!= null
402 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
403 if mproperty
.visibility
> vis_type
then
404 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
406 else if mproperty
.visibility
> vis_module_type
then
407 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
412 # No error, try to go deeper in generic types
413 if node
isa AType then
414 for a
in node
.n_types
do
416 if t
== null then continue # Error, thus skipped
417 check_visibility
(a
, t
, mpropdef
)
419 else if mtype
isa MGenericType then
420 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
424 # Detect circularity errors for virtual types.
425 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
428 # Slow case: progress on each resolution until we visit all without getting a loop
430 # The graph used to detect loops
431 var mtype
= mproperty
.mvirtualtype
432 var poset
= new POSet[MType]
434 # The work-list of types to resolve
435 var todo
= new List[MType]
438 while not todo
.is_empty
do
442 if not t
.need_anchor
then continue
444 # Get the types derived of `t` (subtypes and bounds)
446 if t
isa MNullableType then
448 else if t
isa MGenericType then
450 else if t
isa MVirtualType then
452 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
453 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
454 # TODO something to manage correctly bound conflicts
455 assert not defs
.is_empty
456 nexts
= new Array[MType]
458 var next
= defs
.first
.bound
459 if next
== null then return false
462 else if t
isa MClassType then
463 # Basic type, nothing to to
465 else if t
isa MParameterType then
466 # Parameter types cannot depend on virtual types, so nothing to do
474 if poset
.has_edge
(next
, t
) then
475 if mtype
== next
then
476 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
478 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
482 poset
.add_edge
(t
, next
)
492 # Does the MPropDef contains a call to super or a call of a super-constructor?
493 # Subsequent phases of the frontend (esp. typing) set it if required
494 var has_supercall
: Bool = false is writable
497 redef class AClassdef
498 # Marker used in `ModelBuilder::build_properties`
499 private var build_properties_is_done
= false
501 # The free init (implicitely constructed by the class if required)
502 var mfree_init
: nullable MMethodDef = null
506 # The base init of the class.
507 # Used to get the common new_msignature and initializers
509 # TODO: Where to put this information is not clear because unlike other
510 # informations, the initialisers are stable in a same class.
511 var root_init
: nullable MMethodDef = null
514 redef class MClassDef
515 # What is the `APropdef` associated to a `MProperty`?
516 # Used to check multiple definition of a property.
517 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
519 # Build the virtual type `SELF` only for introduction `MClassDef`
520 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
522 if not is_intro
then return
525 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
527 # If SELF type is declared nowherer?
528 if mprop
== null then return
530 # SELF is not a virtual type? it is weird but we ignore it
531 if not mprop
isa MVirtualTypeProp then return
533 # Is this the intro of SELF in the library?
534 var intro
= mprop
.intro
535 var intro_mclassdef
= intro
.mclassdef
536 if intro_mclassdef
== self then
537 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
539 # SELF must be declared in Object, otherwise this will create conflicts
540 if intro_mclassdef
.mclass
.name
!= "Object" then
541 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
544 # SELF must be public
545 if mprop
.visibility
!= public_visibility
then
546 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
549 # SELF must not be fixed
550 if intro
.is_fixed
then
551 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
557 # This class introduction inherits a SELF
558 # We insert an artificial property to update it
559 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
560 mpropdef
.bound
= mclass
.mclass_type
565 # The associated main model entity
566 type MPROPDEF: MPropDef
568 # The associated propdef once build by a `ModelBuilder`
569 var mpropdef
: nullable MPROPDEF is writable
571 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
572 private fun build_signature
(modelbuilder
: ModelBuilder) do end
573 private fun check_signature
(modelbuilder
: ModelBuilder) do end
574 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
576 var mvisibility
= public_visibility
577 if nvisibility
!= null then
578 mvisibility
= nvisibility
.mvisibility
579 if mvisibility
== intrude_visibility
then
580 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
581 mvisibility
= public_visibility
584 if mclassdef
.mclass
.visibility
== private_visibility
then
585 if mvisibility
== protected_visibility
then
586 assert nvisibility
!= null
587 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
588 else if mvisibility
== private_visibility
then
589 assert nvisibility
!= null
590 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
592 mvisibility
= private_visibility
597 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
599 var ndoc
= self.n_doc
601 var mdoc
= ndoc
.to_mdoc
603 mdoc
.original_mentity
= mpropdef
604 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
605 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
608 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
609 if at_deprecated
!= null then
610 if not mpropdef
.is_intro
then
611 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
613 var info
= new MDeprecationInfo
614 ndoc
= at_deprecated
.n_doc
615 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
616 mpropdef
.mproperty
.deprecation
= info
621 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
623 if nvisibility
== null then return
624 var mvisibility
= nvisibility
.mvisibility
625 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
626 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
630 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
632 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
633 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
636 if mprop
isa MMethod and mprop
.is_root_init
then return true
637 if kwredef
== null then
639 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
643 # Check for full-name conflicts in the project.
644 # A public property should have a unique qualified name `project::class::prop`.
645 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
646 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
647 if others
!= null then for other
in others
do
648 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
649 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}`.")
655 if not need_redef
then
656 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
665 redef class ASignature
666 # Is the model builder has correctly visited the signature
667 var is_visited
= false
668 # Names of parameters from the AST
669 # REQUIRE: is_visited
670 var param_names
= new Array[String]
671 # Types of parameters from the AST
672 # REQUIRE: is_visited
673 var param_types
= new Array[MType]
674 # Rank of the vararg (of -1 if none)
675 # REQUIRE: is_visited
676 var vararg_rank
: Int = -1
678 var ret_type
: nullable MType = null
680 # Visit and fill information about a signature
681 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
683 var mmodule
= mclassdef
.mmodule
684 var param_names
= self.param_names
685 var param_types
= self.param_types
686 for np
in self.n_params
do
687 param_names
.add
(np
.n_id
.text
)
688 var ntype
= np
.n_type
689 if ntype
!= null then
690 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
691 if mtype
== null then return false # Skip error
692 for i
in [0..param_names
.length-param_types
.length
[ do
693 param_types
.add
(mtype
)
695 if np
.n_dotdotdot
!= null then
696 if self.vararg_rank
!= -1 then
697 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
700 self.vararg_rank
= param_names
.length
- 1
705 var ntype
= self.n_type
706 if ntype
!= null then
707 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
708 if self.ret_type
== null then return false # Skip error
711 self.is_visited
= true
715 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
718 for np
in self.n_params
do
719 var ntype
= np
.n_type
720 if ntype
!= null then
721 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
726 var ntype
= self.n_type
727 if ntype
!= null then
728 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
737 # The associated mparameter if any
738 var mparameter
: nullable MParameter = null
741 redef class AMethPropdef
742 redef type MPROPDEF: MMethodDef
745 # Can self be used as a root init?
746 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
748 # Need the `init` keyword
749 if n_kwinit
== null then return false
750 # Need to by anonymous
751 if self.n_methid
!= null then return false
752 # No annotation on itself
753 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
755 var amod
= self.parent
.parent
.as(AModule)
756 var amoddecl
= amod
.n_moduledecl
757 if amoddecl
!= null then
758 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
759 if old
!= null then return false
762 if self.n_signature
.n_params
.length
> 0 then
763 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
766 # Cannot be private or something
767 if not self.n_visibility
isa APublicVisibility then
768 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
775 redef fun build_property
(modelbuilder
, mclassdef
)
777 var n_kwinit
= n_kwinit
778 var n_kwnew
= n_kwnew
779 var is_init
= n_kwinit
!= null or n_kwnew
!= null
781 var amethodid
= self.n_methid
783 if amethodid
== null then
787 else if n_kwinit
!= null then
790 else if n_kwnew
!= null then
796 else if amethodid
isa AIdMethid then
797 name
= amethodid
.n_id
.text
798 name_node
= amethodid
800 # operator, bracket or assign
801 name
= amethodid
.collect_text
802 name_node
= amethodid
804 var arity
= self.n_signature
.n_params
.length
805 if name
== "+" and arity
== 0 then
807 else if name
== "-" and arity
== 0 then
809 else if name
== "~" and arity
== 0 then
812 if amethodid
.is_binary
and arity
!= 1 then
813 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
814 else if amethodid
.min_arity
> arity
then
815 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
820 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
821 var mprop
: nullable MMethod = null
822 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
823 if mprop
== null and look_like_a_root_init
then
824 mprop
= modelbuilder
.the_root_init_mmethod
826 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
827 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
830 if mprop
== null then
831 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
832 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
833 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
834 modelbuilder
.the_root_init_mmethod
= mprop
835 mprop
.is_root_init
= true
837 mprop
.is_init
= is_init
838 mprop
.is_new
= n_kwnew
!= null
839 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
840 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
841 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
843 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
844 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
847 # Check name conflicts in the local class for constructors.
849 for p
, n
in mclassdef
.mprop2npropdef
do
850 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
851 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
857 mclassdef
.mprop2npropdef
[mprop
] = self
859 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
861 set_doc
(mpropdef
, modelbuilder
)
863 self.mpropdef
= mpropdef
864 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
865 if mpropdef
.is_intro
then
866 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
868 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
872 redef fun build_signature
(modelbuilder
)
874 var mpropdef
= self.mpropdef
875 if mpropdef
== null then return # Error thus skiped
876 var mclassdef
= mpropdef
.mclassdef
877 var mmodule
= mclassdef
.mmodule
878 var nsig
= self.n_signature
880 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
881 var root_init
= mclassdef
.mclass
.root_init
882 if root_init
!= null then
883 # Inherit the initializers by refinement
884 mpropdef
.new_msignature
= root_init
.new_msignature
885 assert mpropdef
.initializers
.is_empty
886 mpropdef
.initializers
.add_all root_init
.initializers
890 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
891 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
893 # Retrieve info from the signature AST
894 var param_names
= new Array[String] # Names of parameters from the AST
895 var param_types
= new Array[MType] # Types of parameters from the AST
897 var ret_type
: nullable MType = null # Return type from the AST
899 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
900 param_names
= nsig
.param_names
901 param_types
= nsig
.param_types
902 vararg_rank
= nsig
.vararg_rank
903 ret_type
= nsig
.ret_type
906 # Look for some signature to inherit
907 # FIXME: do not inherit from the intro, but from the most specific
908 var msignature
: nullable MSignature = null
909 if not mpropdef
.is_intro
then
910 msignature
= mpropdef
.mproperty
.intro
.msignature
911 if msignature
== null then return # Skip error
913 # The local signature is adapted to use the local formal types, if any.
914 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
916 # Check inherited signature arity
917 if param_names
.length
!= msignature
.arity
then
919 if nsig
!= null then node
= nsig
else node
= self
920 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}`.")
923 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
924 # FIXME UGLY: inherit signature from a super-constructor
925 for msupertype
in mclassdef
.supertypes
do
926 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
927 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
928 if candidate
!= null then
929 if msignature
== null then
930 msignature
= candidate
.intro
.as(MMethodDef).msignature
937 # Inherit the signature
938 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
939 # Parameters are untyped, thus inherit them
940 param_types
= new Array[MType]
941 for mparameter
in msignature
.mparameters
do
942 param_types
.add
(mparameter
.mtype
)
944 vararg_rank
= msignature
.vararg_rank
946 if msignature
!= null and ret_type
== null then
947 ret_type
= msignature
.return_mtype
950 if param_names
.length
!= param_types
.length
then
951 # Some parameters are typed, other parameters are not typed.
952 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
956 var mparameters
= new Array[MParameter]
957 for i
in [0..param_names
.length
[ do
958 var is_default
= false
959 if vararg_rank
== -1 and param_types
[i
] isa MNullableType then
960 if i
< param_names
.length-1
or accept_special_last_parameter
then
964 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
, is_default
)
965 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
966 mparameters
.add
(mparameter
)
969 # In `new`-factories, the return type is by default the classtype.
970 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
972 # Special checks for operator methods
973 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
974 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
976 if ret_type
== null and return_is_mandatory
then
977 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
980 msignature
= new MSignature(mparameters
, ret_type
)
981 mpropdef
.msignature
= msignature
982 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
983 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
984 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
987 var at
= self.get_single_annotation
("lazy", modelbuilder
)
988 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
991 redef fun check_signature
(modelbuilder
)
993 var mpropdef
= self.mpropdef
994 if mpropdef
== null then return # Error thus skiped
995 var mclassdef
= mpropdef
.mclassdef
996 var mmodule
= mclassdef
.mmodule
997 var nsig
= self.n_signature
998 var mysignature
= self.mpropdef
.msignature
999 if mysignature
== null then return # Error thus skiped
1002 if nsig
!= null then
1003 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1004 self.mpropdef
.msignature
= null # invalidate
1005 return # Forward error
1009 # Lookup for signature in the precursor
1010 # FIXME all precursors should be considered
1011 if not mpropdef
.is_intro
then
1012 var msignature
= mpropdef
.mproperty
.intro
.msignature
1013 if msignature
== null then return
1015 var precursor_ret_type
= msignature
.return_mtype
1016 var ret_type
= mysignature
.return_mtype
1017 if ret_type
!= null and precursor_ret_type
== null then
1018 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1019 self.mpropdef
.msignature
= null
1023 if mysignature
.arity
> 0 then
1024 # Check parameters types
1025 for i
in [0..mysignature
.arity
[ do
1026 var myt
= mysignature
.mparameters
[i
].mtype
1027 var prt
= msignature
.mparameters
[i
].mtype
1028 var node
= nsig
.n_params
[i
]
1029 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1030 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1031 self.mpropdef
.msignature
= null
1035 if precursor_ret_type
!= null then
1036 var node
: nullable ANode = null
1037 if nsig
!= null then node
= nsig
.n_type
1038 if node
== null then node
= self
1039 if ret_type
== null then
1040 # Inherit the return type
1041 ret_type
= precursor_ret_type
1042 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1043 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1044 self.mpropdef
.msignature
= null
1049 if mysignature
.arity
> 0 then
1050 # Check parameters visibility
1051 for i
in [0..mysignature
.arity
[ do
1052 var nt
= nsig
.n_params
[i
].n_type
1053 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1055 var nt
= nsig
.n_type
1056 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1062 # Is a return required?
1064 # * True for operators and brackets.
1065 # * False for id and assignment.
1066 fun return_is_mandatory
: Bool do return true
1068 # Can the last parameter be special like a vararg?
1070 # * False for operators: the last one is in fact the only one.
1071 # * False for assignments: it is the right part of the assignment.
1072 # * True for ids and brackets.
1073 fun accept_special_last_parameter
: Bool do return false
1075 # The minimum required number of parameters.
1077 # * 1 for binary operators
1079 # * 1 for assignments
1080 # * 2 for bracket assignments
1082 fun min_arity
: Int do return 1
1084 # Is the `self` a binary operator?
1085 fun is_binary
: Bool do return true
1088 redef class AIdMethid
1089 redef fun return_is_mandatory
do return false
1090 redef fun accept_special_last_parameter
do return true
1091 redef fun min_arity
do return 0
1092 redef fun is_binary
do return false
1095 redef class ABraMethid
1096 redef fun accept_special_last_parameter
do return true
1097 redef fun is_binary
do return false
1100 redef class ABraassignMethid
1101 redef fun return_is_mandatory
do return false
1102 redef fun min_arity
do return 2
1103 redef fun is_binary
do return false
1106 redef class AAssignMethid
1107 redef fun return_is_mandatory
do return false
1108 redef fun is_binary
do return false
1111 redef class AAttrPropdef
1112 redef type MPROPDEF: MAttributeDef
1114 # Is the node tagged `noinit`?
1117 # Is the node tagged lazy?
1120 # Has the node a default value?
1121 # Could be through `n_expr` or `n_block`
1122 var has_value
= false
1124 # The guard associated to a lazy attribute.
1125 # Because some engines does not have a working `isset`,
1126 # this additional attribute is used to guard the lazy initialization.
1127 # TODO: to remove once isset is correctly implemented
1128 var mlazypropdef
: nullable MAttributeDef
1130 # The associated getter (read accessor) if any
1131 var mreadpropdef
: nullable MMethodDef is writable
1132 # The associated setter (write accessor) if any
1133 var mwritepropdef
: nullable MMethodDef is writable
1135 redef fun build_property
(modelbuilder
, mclassdef
)
1137 var mclass
= mclassdef
.mclass
1139 var name
= nid2
.text
1141 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1142 if atabstract
== null then
1143 if not mclass
.kind
.need_init
then
1144 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1147 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1148 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1149 self.mpropdef
= mpropdef
1150 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1154 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1155 if mreadprop
== null then
1156 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1157 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1158 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1160 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1161 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1163 mclassdef
.mprop2npropdef
[mreadprop
] = self
1165 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1166 self.mreadpropdef
= mreadpropdef
1167 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1168 set_doc
(mreadpropdef
, modelbuilder
)
1169 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1170 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1172 has_value
= n_expr
!= null or n_block
!= null
1174 if atabstract
!= null and has_value
then
1175 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1179 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1180 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1181 if atnoinit
!= null then
1184 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1187 if atabstract
!= null then
1188 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot be abstract.")
1193 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1194 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1195 if atlazy
!= null or atautoinit
!= null then
1196 if atlazy
!= null and atautoinit
!= null then
1197 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `autoinit`.")
1200 if not has_value
then
1201 if atlazy
!= null then
1202 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1203 else if atautoinit
!= null then
1204 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes need a value.")
1210 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1211 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1212 self.mlazypropdef
= mlazypropdef
1215 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1216 if atreadonly
!= null then
1217 if not has_value
then
1218 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1220 # No setter, so just leave
1224 var writename
= name
+ "="
1225 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1226 if atwritable
!= null then
1227 if not atwritable
.n_args
.is_empty
then
1228 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1231 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1232 var nwkwredef
: nullable Token = null
1233 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1234 if mwriteprop
== null then
1236 if atwritable
!= null then
1237 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1239 mvisibility
= private_visibility
1241 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1242 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1243 mwriteprop
.deprecation
= mreadprop
.deprecation
1245 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1246 if atwritable
!= null then
1247 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1250 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1252 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1253 self.mwritepropdef
= mwritepropdef
1254 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1255 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1256 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1259 redef fun build_signature
(modelbuilder
)
1261 var mreadpropdef
= self.mreadpropdef
1262 var mpropdef
= self.mpropdef
1263 if mreadpropdef
== null then return # Error thus skipped
1264 var mclassdef
= mreadpropdef
.mclassdef
1265 var mmodule
= mclassdef
.mmodule
1266 var mtype
: nullable MType = null
1269 var ntype
= self.n_type
1270 if ntype
!= null then
1271 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1272 if mtype
== null then return
1275 var inherited_type
: nullable MType = null
1276 # Inherit the type from the getter (usually an abstract getter)
1277 if not mreadpropdef
.is_intro
then
1278 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1279 if msignature
== null then return # Error, thus skipped
1280 inherited_type
= msignature
.return_mtype
1281 if inherited_type
!= null then
1282 # The inherited type is adapted to use the local formal types, if any.
1283 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1284 if mtype
== null then mtype
= inherited_type
1288 var nexpr
= self.n_expr
1289 if mtype
== null then
1290 if nexpr
!= null then
1291 if nexpr
isa ANewExpr then
1292 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1293 else if nexpr
isa AIntExpr then
1294 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1295 if cla
!= null then mtype
= cla
.mclass_type
1296 else if nexpr
isa AFloatExpr then
1297 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1298 if cla
!= null then mtype
= cla
.mclass_type
1299 else if nexpr
isa ACharExpr then
1300 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1301 if cla
!= null then mtype
= cla
.mclass_type
1302 else if nexpr
isa ABoolExpr then
1303 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1304 if cla
!= null then mtype
= cla
.mclass_type
1305 else if nexpr
isa ASuperstringExpr then
1306 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1307 if cla
!= null then mtype
= cla
.mclass_type
1308 else if nexpr
isa AStringFormExpr then
1309 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1310 if cla
!= null then mtype
= cla
.mclass_type
1312 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1315 if mtype
== null then return
1317 else if ntype
!= null and inherited_type
== mtype
then
1318 if nexpr
isa ANewExpr then
1319 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1320 if xmtype
== mtype
then
1321 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1326 if mtype
== null then
1327 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1331 if mpropdef
!= null then
1332 mpropdef
.static_mtype
= mtype
1336 var msignature
= new MSignature(new Array[MParameter], mtype
)
1337 mreadpropdef
.msignature
= msignature
1340 var mwritepropdef
= self.mwritepropdef
1341 if mwritepropdef
!= null then
1344 var mparameter
= new MParameter(name
, mtype
, false, false)
1345 var msignature
= new MSignature([mparameter
], null)
1346 mwritepropdef
.msignature
= msignature
1349 var mlazypropdef
= self.mlazypropdef
1350 if mlazypropdef
!= null then
1351 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1355 redef fun check_signature
(modelbuilder
)
1357 var mpropdef
= self.mpropdef
1358 if mpropdef
== null then return # Error thus skipped
1359 var ntype
= self.n_type
1360 var mtype
= self.mpropdef
.static_mtype
1361 if mtype
== null then return # Error thus skipped
1363 var mclassdef
= mpropdef
.mclassdef
1364 var mmodule
= mclassdef
.mmodule
1367 if ntype
!= null then
1368 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1371 if nexpr
isa ANewExpr then
1372 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1375 # Lookup for signature in the precursor
1376 # FIXME all precursors should be considered
1377 if not mpropdef
.is_intro
then
1378 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1379 if precursor_type
== null then return
1381 if mtype
!= precursor_type
then
1382 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1387 # Check getter and setter
1388 var meth
= self.mreadpropdef
1389 if meth
!= null then
1390 self.check_method_signature
(modelbuilder
, meth
)
1391 var node
: nullable ANode = ntype
1392 if node
== null then node
= self
1393 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1395 meth
= self.mwritepropdef
1396 if meth
!= null then
1397 self.check_method_signature
(modelbuilder
, meth
)
1398 var node
: nullable ANode = ntype
1399 if node
== null then node
= self
1400 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1404 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1406 var mclassdef
= mpropdef
.mclassdef
1407 var mmodule
= mclassdef
.mmodule
1408 var nsig
= self.n_type
1409 var mysignature
= mpropdef
.msignature
1410 if mysignature
== null then return # Error thus skiped
1412 # Lookup for signature in the precursor
1413 # FIXME all precursors should be considered
1414 if not mpropdef
.is_intro
then
1415 var msignature
= mpropdef
.mproperty
.intro
.msignature
1416 if msignature
== null then return
1418 if mysignature
.arity
!= msignature
.arity
then
1420 if nsig
!= null then node
= nsig
else node
= self
1421 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}`.")
1424 var precursor_ret_type
= msignature
.return_mtype
1425 var ret_type
= mysignature
.return_mtype
1426 if ret_type
!= null and precursor_ret_type
== null then
1428 if nsig
!= null then node
= nsig
else node
= self
1429 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1433 if mysignature
.arity
> 0 then
1434 # Check parameters types
1435 for i
in [0..mysignature
.arity
[ do
1436 var myt
= mysignature
.mparameters
[i
].mtype
1437 var prt
= msignature
.mparameters
[i
].mtype
1439 if nsig
!= null then node
= nsig
else node
= self
1440 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1441 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1445 if precursor_ret_type
!= null then
1447 if nsig
!= null then node
= nsig
else node
= self
1448 if ret_type
== null then
1449 # Inherit the return type
1450 ret_type
= precursor_ret_type
1451 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1452 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1459 redef class ATypePropdef
1460 redef type MPROPDEF: MVirtualTypeDef
1462 redef fun build_property
(modelbuilder
, mclassdef
)
1464 var name
= self.n_id
.text
1465 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1466 if mprop
== null then
1467 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1468 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1469 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1470 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1473 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1475 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1476 assert mprop
isa MVirtualTypeProp
1477 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1479 mclassdef
.mprop2npropdef
[mprop
] = self
1481 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1482 self.mpropdef
= mpropdef
1483 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1484 if mpropdef
.is_intro
then
1485 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1487 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1489 set_doc
(mpropdef
, modelbuilder
)
1491 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1492 if atfixed
!= null then
1493 mpropdef
.is_fixed
= true
1497 redef fun build_signature
(modelbuilder
)
1499 var mpropdef
= self.mpropdef
1500 if mpropdef
== null then return # Error thus skipped
1501 var mclassdef
= mpropdef
.mclassdef
1502 var mmodule
= mclassdef
.mmodule
1503 var mtype
: nullable MType = null
1505 var ntype
= self.n_type
1506 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1507 if mtype
== null then return
1509 mpropdef
.bound
= mtype
1510 # print "{mpropdef}: {mtype}"
1513 redef fun check_signature
(modelbuilder
)
1515 var mpropdef
= self.mpropdef
1516 if mpropdef
== null then return # Error thus skipped
1518 var bound
= mpropdef
.bound
1519 if bound
== null then return # Error thus skipped
1521 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1523 var mclassdef
= mpropdef
.mclassdef
1524 var mmodule
= mclassdef
.mmodule
1525 var anchor
= mclassdef
.bound_mtype
1527 var ntype
= self.n_type
1528 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1529 mpropdef
.bound
= null
1533 # Check redefinitions
1534 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1535 var supbound
= p
.bound
1536 if supbound
== null then break # broken super bound, skip error
1538 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1541 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1542 # Still a warning to pass existing bad code
1543 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1546 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1547 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")