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 attribute
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)
200 mparameters
.add
(mparameter
)
202 initializers
.add
(npropdef
.mpropdef
.mproperty
)
203 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
205 if npropdef
isa AAttrPropdef then
206 if npropdef
.mpropdef
== null then return # Skip broken attribute
207 if npropdef
.noinit
then continue # Skip noinit attribute
208 var atautoinit
= npropdef
.get_single_annotation
("autoinit", self)
209 if atautoinit
!= null then
210 # For autoinit attributes, call the reader to force
211 # the lazy initialization of the attribute.
212 initializers
.add
(npropdef
.mreadpropdef
.mproperty
)
213 npropdef
.mreadpropdef
.mproperty
.is_autoinit
= true
216 if npropdef
.has_value
then continue
217 var paramname
= npropdef
.mpropdef
.mproperty
.name
.substring_from
(1)
218 var ret_type
= npropdef
.mpropdef
.static_mtype
219 if ret_type
== null then return
220 var mparameter
= new MParameter(paramname
, ret_type
, false)
221 mparameters
.add
(mparameter
)
222 var msetter
= npropdef
.mwritepropdef
223 if msetter
== null then
224 # No setter, it is a old-style attribute, so just add it
225 initializers
.add
(npropdef
.mpropdef
.mproperty
)
226 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
228 # Add the setter to the list
229 initializers
.add
(msetter
.mproperty
)
230 msetter
.mproperty
.is_autoinit
= true
235 if the_root_init_mmethod
== null then return
237 # Look for most-specific new-stype init definitions
238 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
239 if spropdefs
.is_empty
then
240 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
244 # Look at the autoinit class-annotation
245 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
246 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
247 if autoinit
!= null then
248 # Just throws the collected initializers
252 if noautoinit
!= null then
253 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
256 if autoinit
.n_args
.is_empty
then
257 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
260 # Get and check each argument
261 for narg
in autoinit
.n_args
do
264 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
268 # Search the property.
269 # To avoid bad surprises, try to get the setter first.
270 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
272 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
275 error
(narg
, "Error: unknown method `{id}`")
278 if not p
.is_autoinit
then
279 error
(narg
, "Error: `{p}` is not an autoinit method")
283 # Register the initializer and the parameters
286 if pd
isa MMethodDef then
287 # Get the signature resolved for the current receiver
288 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
289 mparameters
.add_all sig
.mparameters
295 else if noautoinit
!= null then
296 if initializers
.is_empty
then
297 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
299 # Just clear initializers
303 # Search the longest-one and checks for conflict
304 var longest
= spropdefs
.first
305 if spropdefs
.length
> 1 then
306 # Check for conflict in the order of initializers
307 # Each initializer list must me a prefix of the longest list
308 # part 1. find the longest list
309 for spd
in spropdefs
do
310 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
313 for spd
in spropdefs
do
315 for p
in spd
.initializers
do
316 if p
!= longest
.initializers
[i
] then
317 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
318 # TODO: invalidate the initializer to avoid more errors
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
340 # If we already have a basic init definition, then setup its initializers
341 if defined_init
!= null then
342 defined_init
.initializers
.add_all
(initializers
)
343 var msignature
= new MSignature(mparameters
, null)
344 defined_init
.new_msignature
= msignature
345 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
346 mclassdef
.mclass
.root_init
= defined_init
350 # Else create the local implicit basic init definition
351 var mprop
= the_root_init_mmethod
.as(not null)
352 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
353 mpropdef
.has_supercall
= true
354 mpropdef
.initializers
.add_all
(initializers
)
355 var msignature
= new MSignature(mparameters
, null)
356 mpropdef
.new_msignature
= msignature
357 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
358 nclassdef
.mfree_init
= mpropdef
359 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
360 mclassdef
.mclass
.root_init
= mpropdef
363 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
364 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
366 var mmodule
= mpropdef
.mclassdef
.mmodule
367 var mproperty
= mpropdef
.mproperty
369 # Extract visibility information of the main part of `mtype`
370 # It is a case-by case
371 var vis_type
: nullable MVisibility = null # The own visibility of the type
372 var mmodule_type
: nullable MModule = null # The original module of the type
373 mtype
= mtype
.undecorate
374 if mtype
isa MClassType then
375 vis_type
= mtype
.mclass
.visibility
376 mmodule_type
= mtype
.mclass
.intro
.mmodule
377 else if mtype
isa MVirtualType then
378 vis_type
= mtype
.mproperty
.visibility
379 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
380 else if mtype
isa MParameterType then
381 # nothing, always visible
382 else if mtype
isa MNullType then
385 node
.debug
"Unexpected type {mtype}"
389 if vis_type
!= null then
390 assert mmodule_type
!= null
391 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
392 if mproperty
.visibility
> vis_type
then
393 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
395 else if mproperty
.visibility
> vis_module_type
then
396 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
401 # No error, try to go deeper in generic types
402 if node
isa AType then
403 for a
in node
.n_types
do
405 if t
== null then continue # Error, thus skipped
406 check_visibility
(a
, t
, mpropdef
)
408 else if mtype
isa MGenericType then
409 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
413 # Detect circularity errors for virtual types.
414 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
417 # Slow case: progress on each resolution until we visit all without getting a loop
419 # The graph used to detect loops
420 var mtype
= mproperty
.mvirtualtype
421 var poset
= new POSet[MType]
423 # The work-list of types to resolve
424 var todo
= new List[MType]
427 while not todo
.is_empty
do
431 if not t
.need_anchor
then continue
433 # Get the types derived of `t` (subtypes and bounds)
435 if t
isa MNullableType then
437 else if t
isa MGenericType then
439 else if t
isa MVirtualType then
441 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
442 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
443 # TODO something to manage correctly bound conflicts
444 assert not defs
.is_empty
445 nexts
= new Array[MType]
447 var next
= defs
.first
.bound
448 if next
== null then return false
451 else if t
isa MClassType then
452 # Basic type, nothing to to
454 else if t
isa MParameterType then
455 # Parameter types cannot depend on virtual types, so nothing to do
463 if poset
.has_edge
(next
, t
) then
464 if mtype
== next
then
465 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
467 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
471 poset
.add_edge
(t
, next
)
481 # Does the MPropDef contains a call to super or a call of a super-constructor?
482 # Subsequent phases of the frontend (esp. typing) set it if required
483 var has_supercall
: Bool = false is writable
486 redef class AClassdef
487 # Marker used in `ModelBuilder::build_properties`
488 private var build_properties_is_done
= false
490 # The free init (implicitely constructed by the class if required)
491 var mfree_init
: nullable MMethodDef = null
495 # The base init of the class.
496 # Used to get the common new_msignature and initializers
498 # TODO: Where to put this information is not clear because unlike other
499 # informations, the initialisers are stable in a same class.
500 var root_init
: nullable MMethodDef = null
503 redef class MClassDef
504 # What is the `APropdef` associated to a `MProperty`?
505 # Used to check multiple definition of a property.
506 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
508 # Build the virtual type `SELF` only for introduction `MClassDef`
509 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
511 if not is_intro
then return
514 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
516 # If SELF type is declared nowherer?
517 if mprop
== null then return
519 # SELF is not a virtual type? it is weird but we ignore it
520 if not mprop
isa MVirtualTypeProp then return
522 # Is this the intro of SELF in the library?
523 var intro
= mprop
.intro
524 var intro_mclassdef
= intro
.mclassdef
525 if intro_mclassdef
== self then
526 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
528 # SELF must be declared in Object, otherwise this will create conflicts
529 if intro_mclassdef
.mclass
.name
!= "Object" then
530 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
533 # SELF must be public
534 if mprop
.visibility
!= public_visibility
then
535 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
538 # SELF must not be fixed
539 if intro
.is_fixed
then
540 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
546 # This class introduction inherits a SELF
547 # We insert an artificial property to update it
548 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
549 mpropdef
.bound
= mclass
.mclass_type
554 # The associated main model entity
555 type MPROPDEF: MPropDef
557 # The associated propdef once build by a `ModelBuilder`
558 var mpropdef
: nullable MPROPDEF is writable
560 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
561 private fun build_signature
(modelbuilder
: ModelBuilder) do end
562 private fun check_signature
(modelbuilder
: ModelBuilder) do end
563 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
565 var mvisibility
= public_visibility
566 if nvisibility
!= null then
567 mvisibility
= nvisibility
.mvisibility
568 if mvisibility
== intrude_visibility
then
569 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
570 mvisibility
= public_visibility
573 if mclassdef
.mclass
.visibility
== private_visibility
then
574 if mvisibility
== protected_visibility
then
575 assert nvisibility
!= null
576 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
577 else if mvisibility
== private_visibility
then
578 assert nvisibility
!= null
579 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
581 mvisibility
= private_visibility
586 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
588 var ndoc
= self.n_doc
590 var mdoc
= ndoc
.to_mdoc
592 mdoc
.original_mentity
= mpropdef
593 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
594 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
597 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
598 if at_deprecated
!= null then
599 if not mpropdef
.is_intro
then
600 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
602 var info
= new MDeprecationInfo
603 ndoc
= at_deprecated
.n_doc
604 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
605 mpropdef
.mproperty
.deprecation
= info
610 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
612 if nvisibility
== null then return
613 var mvisibility
= nvisibility
.mvisibility
614 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
615 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
619 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
621 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
622 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
625 if mprop
isa MMethod and mprop
.is_root_init
then return true
626 if kwredef
== null then
628 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
632 # Check for full-name conflicts in the project.
633 # A public property should have a unique qualified name `project::class::prop`.
634 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
635 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
636 if others
!= null then for other
in others
do
637 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
638 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}`.")
644 if not need_redef
then
645 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
654 redef class ASignature
655 # Is the model builder has correctly visited the signature
656 var is_visited
= false
657 # Names of parameters from the AST
658 # REQUIRE: is_visited
659 var param_names
= new Array[String]
660 # Types of parameters from the AST
661 # REQUIRE: is_visited
662 var param_types
= new Array[MType]
663 # Rank of the vararg (of -1 if none)
664 # REQUIRE: is_visited
665 var vararg_rank
: Int = -1
667 var ret_type
: nullable MType = null
669 # Visit and fill information about a signature
670 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
672 var mmodule
= mclassdef
.mmodule
673 var param_names
= self.param_names
674 var param_types
= self.param_types
675 for np
in self.n_params
do
676 param_names
.add
(np
.n_id
.text
)
677 var ntype
= np
.n_type
678 if ntype
!= null then
679 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
680 if mtype
== null then return false # Skip error
681 for i
in [0..param_names
.length-param_types
.length
[ do
682 param_types
.add
(mtype
)
684 if np
.n_dotdotdot
!= null then
685 if self.vararg_rank
!= -1 then
686 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
689 self.vararg_rank
= param_names
.length
- 1
694 var ntype
= self.n_type
695 if ntype
!= null then
696 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
697 if self.ret_type
== null then return false # Skip error
700 self.is_visited
= true
704 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
707 for np
in self.n_params
do
708 var ntype
= np
.n_type
709 if ntype
!= null then
710 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
715 var ntype
= self.n_type
716 if ntype
!= null then
717 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
726 # The associated mparameter if any
727 var mparameter
: nullable MParameter = null
730 redef class AMethPropdef
731 redef type MPROPDEF: MMethodDef
734 # Can self be used as a root init?
735 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
737 # Need the `init` keyword
738 if n_kwinit
== null then return false
739 # Need to by anonymous
740 if self.n_methid
!= null then return false
741 # No annotation on itself
742 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
744 var amod
= self.parent
.parent
.as(AModule)
745 var amoddecl
= amod
.n_moduledecl
746 if amoddecl
!= null then
747 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
748 if old
!= null then return false
751 if self.n_signature
.n_params
.length
> 0 then
752 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
755 # Cannot be private or something
756 if not self.n_visibility
isa APublicVisibility then
757 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
764 redef fun build_property
(modelbuilder
, mclassdef
)
766 var n_kwinit
= n_kwinit
767 var n_kwnew
= n_kwnew
768 var is_init
= n_kwinit
!= null or n_kwnew
!= null
770 var amethodid
= self.n_methid
772 if amethodid
== null then
776 else if n_kwinit
!= null then
779 else if n_kwnew
!= null then
785 else if amethodid
isa AIdMethid then
786 name
= amethodid
.n_id
.text
787 name_node
= amethodid
789 # operator, bracket or assign
790 name
= amethodid
.collect_text
791 name_node
= amethodid
793 if name
== "+" and self.n_signature
.n_params
.length
== 0 then
796 if name
== "-" and self.n_signature
.n_params
.length
== 0 then
801 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
802 var mprop
: nullable MMethod = null
803 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
804 if mprop
== null and look_like_a_root_init
then
805 mprop
= modelbuilder
.the_root_init_mmethod
807 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
808 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
811 if mprop
== null then
812 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
813 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
814 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
815 modelbuilder
.the_root_init_mmethod
= mprop
816 mprop
.is_root_init
= true
818 mprop
.is_init
= is_init
819 mprop
.is_new
= n_kwnew
!= null
820 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
821 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
822 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
824 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
825 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
828 # Check name conflicts in the local class for constructors.
830 for p
, n
in mclassdef
.mprop2npropdef
do
831 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
832 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
838 mclassdef
.mprop2npropdef
[mprop
] = self
840 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
842 set_doc
(mpropdef
, modelbuilder
)
844 self.mpropdef
= mpropdef
845 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
846 if mpropdef
.is_intro
then
847 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
849 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
853 redef fun build_signature
(modelbuilder
)
855 var mpropdef
= self.mpropdef
856 if mpropdef
== null then return # Error thus skiped
857 var mclassdef
= mpropdef
.mclassdef
858 var mmodule
= mclassdef
.mmodule
859 var nsig
= self.n_signature
861 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
862 var root_init
= mclassdef
.mclass
.root_init
863 if root_init
!= null then
864 # Inherit the initializers by refinement
865 mpropdef
.new_msignature
= root_init
.new_msignature
866 assert mpropdef
.initializers
.is_empty
867 mpropdef
.initializers
.add_all root_init
.initializers
871 # Retrieve info from the signature AST
872 var param_names
= new Array[String] # Names of parameters from the AST
873 var param_types
= new Array[MType] # Types of parameters from the AST
875 var ret_type
: nullable MType = null # Return type from the AST
877 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
878 param_names
= nsig
.param_names
879 param_types
= nsig
.param_types
880 vararg_rank
= nsig
.vararg_rank
881 ret_type
= nsig
.ret_type
884 # Look for some signature to inherit
885 # FIXME: do not inherit from the intro, but from the most specific
886 var msignature
: nullable MSignature = null
887 if not mpropdef
.is_intro
then
888 msignature
= mpropdef
.mproperty
.intro
.msignature
889 if msignature
== null then return # Skip error
891 # The local signature is adapted to use the local formal types, if any.
892 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
894 # Check inherited signature arity
895 if param_names
.length
!= msignature
.arity
then
897 if nsig
!= null then node
= nsig
else node
= self
898 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}`.")
901 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
902 # FIXME UGLY: inherit signature from a super-constructor
903 for msupertype
in mclassdef
.supertypes
do
904 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
905 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
906 if candidate
!= null then
907 if msignature
== null then
908 msignature
= candidate
.intro
.as(MMethodDef).msignature
915 # Inherit the signature
916 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
917 # Parameters are untyped, thus inherit them
918 param_types
= new Array[MType]
919 for mparameter
in msignature
.mparameters
do
920 param_types
.add
(mparameter
.mtype
)
922 vararg_rank
= msignature
.vararg_rank
924 if msignature
!= null and ret_type
== null then
925 ret_type
= msignature
.return_mtype
928 if param_names
.length
!= param_types
.length
then
929 # Some parameters are typed, other parameters are not typed.
930 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
934 var mparameters
= new Array[MParameter]
935 for i
in [0..param_names
.length
[ do
936 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
937 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
938 mparameters
.add
(mparameter
)
941 # In `new`-factories, the return type is by default the classtype.
942 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
944 msignature
= new MSignature(mparameters
, ret_type
)
945 mpropdef
.msignature
= msignature
946 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
947 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
948 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
951 var at
= self.get_single_annotation
("lazy", modelbuilder
)
952 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
955 redef fun check_signature
(modelbuilder
)
957 var mpropdef
= self.mpropdef
958 if mpropdef
== null then return # Error thus skiped
959 var mclassdef
= mpropdef
.mclassdef
960 var mmodule
= mclassdef
.mmodule
961 var nsig
= self.n_signature
962 var mysignature
= self.mpropdef
.msignature
963 if mysignature
== null then return # Error thus skiped
967 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
968 self.mpropdef
.msignature
= null # invalidate
969 return # Forward error
973 # Lookup for signature in the precursor
974 # FIXME all precursors should be considered
975 if not mpropdef
.is_intro
then
976 var msignature
= mpropdef
.mproperty
.intro
.msignature
977 if msignature
== null then return
979 var precursor_ret_type
= msignature
.return_mtype
980 var ret_type
= mysignature
.return_mtype
981 if ret_type
!= null and precursor_ret_type
== null then
982 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
983 self.mpropdef
.msignature
= null
987 if mysignature
.arity
> 0 then
988 # Check parameters types
989 for i
in [0..mysignature
.arity
[ do
990 var myt
= mysignature
.mparameters
[i
].mtype
991 var prt
= msignature
.mparameters
[i
].mtype
992 var node
= nsig
.n_params
[i
]
993 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
994 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
995 self.mpropdef
.msignature
= null
999 if precursor_ret_type
!= null then
1000 var node
: nullable ANode = null
1001 if nsig
!= null then node
= nsig
.n_type
1002 if node
== null then node
= self
1003 if ret_type
== null then
1004 # Inherit the return type
1005 ret_type
= precursor_ret_type
1006 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1007 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1008 self.mpropdef
.msignature
= null
1013 if mysignature
.arity
> 0 then
1014 # Check parameters visibility
1015 for i
in [0..mysignature
.arity
[ do
1016 var nt
= nsig
.n_params
[i
].n_type
1017 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1019 var nt
= nsig
.n_type
1020 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1025 redef class AAttrPropdef
1026 redef type MPROPDEF: MAttributeDef
1028 # Is the node tagged `noinit`?
1031 # Is the node tagged lazy?
1034 # Has the node a default value?
1035 # Could be through `n_expr` or `n_block`
1036 var has_value
= false
1038 # The guard associated to a lazy attribute.
1039 # Because some engines does not have a working `isset`,
1040 # this additional attribute is used to guard the lazy initialization.
1041 # TODO: to remove once isset is correctly implemented
1042 var mlazypropdef
: nullable MAttributeDef
1044 # The associated getter (read accessor) if any
1045 var mreadpropdef
: nullable MMethodDef is writable
1046 # The associated setter (write accessor) if any
1047 var mwritepropdef
: nullable MMethodDef is writable
1049 redef fun build_property
(modelbuilder
, mclassdef
)
1051 var mclass
= mclassdef
.mclass
1053 var name
= nid2
.text
1055 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1056 if atabstract
== null then
1057 if not mclass
.kind
.need_init
then
1058 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1061 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1062 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1063 self.mpropdef
= mpropdef
1064 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1068 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1069 if mreadprop
== null then
1070 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1071 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1072 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1074 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1075 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1077 mclassdef
.mprop2npropdef
[mreadprop
] = self
1079 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1080 self.mreadpropdef
= mreadpropdef
1081 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1082 set_doc
(mreadpropdef
, modelbuilder
)
1083 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1084 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1086 has_value
= n_expr
!= null or n_block
!= null
1088 if atabstract
!= null and has_value
then
1089 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1093 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1094 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1095 if atnoinit
!= null then
1098 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1101 if atabstract
!= null then
1102 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot be abstract.")
1107 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1108 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1109 if atlazy
!= null or atautoinit
!= null then
1110 if atlazy
!= null and atautoinit
!= null then
1111 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `autoinit`.")
1114 if not has_value
then
1115 if atlazy
!= null then
1116 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1117 else if atautoinit
!= null then
1118 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes need a value.")
1124 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1125 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1126 self.mlazypropdef
= mlazypropdef
1129 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1130 if atreadonly
!= null then
1131 if not has_value
then
1132 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1134 # No setter, so just leave
1138 var writename
= name
+ "="
1139 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1140 if atwritable
!= null then
1141 if not atwritable
.n_args
.is_empty
then
1142 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1145 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1146 var nwkwredef
: nullable Token = null
1147 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1148 if mwriteprop
== null then
1150 if atwritable
!= null then
1151 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1153 mvisibility
= private_visibility
1155 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1156 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1157 mwriteprop
.deprecation
= mreadprop
.deprecation
1159 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1160 if atwritable
!= null then
1161 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1164 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1166 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1167 self.mwritepropdef
= mwritepropdef
1168 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1169 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1170 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1173 redef fun build_signature
(modelbuilder
)
1175 var mreadpropdef
= self.mreadpropdef
1176 var mpropdef
= self.mpropdef
1177 if mreadpropdef
== null then return # Error thus skipped
1178 var mclassdef
= mreadpropdef
.mclassdef
1179 var mmodule
= mclassdef
.mmodule
1180 var mtype
: nullable MType = null
1183 var ntype
= self.n_type
1184 if ntype
!= null then
1185 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1186 if mtype
== null then return
1189 var inherited_type
: nullable MType = null
1190 # Inherit the type from the getter (usually an abstract getter)
1191 if not mreadpropdef
.is_intro
then
1192 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1193 if msignature
== null then return # Error, thus skipped
1194 inherited_type
= msignature
.return_mtype
1195 if inherited_type
!= null then
1196 # The inherited type is adapted to use the local formal types, if any.
1197 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1198 if mtype
== null then mtype
= inherited_type
1202 var nexpr
= self.n_expr
1203 if mtype
== null then
1204 if nexpr
!= null then
1205 if nexpr
isa ANewExpr then
1206 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1207 else if nexpr
isa AIntExpr then
1208 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1209 if cla
!= null then mtype
= cla
.mclass_type
1210 else if nexpr
isa AFloatExpr then
1211 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1212 if cla
!= null then mtype
= cla
.mclass_type
1213 else if nexpr
isa ACharExpr then
1214 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1215 if cla
!= null then mtype
= cla
.mclass_type
1216 else if nexpr
isa ABoolExpr then
1217 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1218 if cla
!= null then mtype
= cla
.mclass_type
1219 else if nexpr
isa ASuperstringExpr then
1220 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1221 if cla
!= null then mtype
= cla
.mclass_type
1222 else if nexpr
isa AStringFormExpr then
1223 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1224 if cla
!= null then mtype
= cla
.mclass_type
1226 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1229 if mtype
== null then return
1231 else if ntype
!= null and inherited_type
== mtype
then
1232 if nexpr
isa ANewExpr then
1233 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1234 if xmtype
== mtype
then
1235 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1240 if mtype
== null then
1241 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1245 if mpropdef
!= null then
1246 mpropdef
.static_mtype
= mtype
1250 var msignature
= new MSignature(new Array[MParameter], mtype
)
1251 mreadpropdef
.msignature
= msignature
1254 var mwritepropdef
= self.mwritepropdef
1255 if mwritepropdef
!= null then
1258 var mparameter
= new MParameter(name
, mtype
, false)
1259 var msignature
= new MSignature([mparameter
], null)
1260 mwritepropdef
.msignature
= msignature
1263 var mlazypropdef
= self.mlazypropdef
1264 if mlazypropdef
!= null then
1265 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1269 redef fun check_signature
(modelbuilder
)
1271 var mpropdef
= self.mpropdef
1272 if mpropdef
== null then return # Error thus skipped
1273 var ntype
= self.n_type
1274 var mtype
= self.mpropdef
.static_mtype
1275 if mtype
== null then return # Error thus skipped
1277 var mclassdef
= mpropdef
.mclassdef
1278 var mmodule
= mclassdef
.mmodule
1281 if ntype
!= null then
1282 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1285 if nexpr
isa ANewExpr then
1286 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1289 # Lookup for signature in the precursor
1290 # FIXME all precursors should be considered
1291 if not mpropdef
.is_intro
then
1292 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1293 if precursor_type
== null then return
1295 if mtype
!= precursor_type
then
1296 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1301 # Check getter and setter
1302 var meth
= self.mreadpropdef
1303 if meth
!= null then
1304 self.check_method_signature
(modelbuilder
, meth
)
1305 var node
: nullable ANode = ntype
1306 if node
== null then node
= self
1307 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1309 meth
= self.mwritepropdef
1310 if meth
!= null then
1311 self.check_method_signature
(modelbuilder
, meth
)
1312 var node
: nullable ANode = ntype
1313 if node
== null then node
= self
1314 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1318 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1320 var mclassdef
= mpropdef
.mclassdef
1321 var mmodule
= mclassdef
.mmodule
1322 var nsig
= self.n_type
1323 var mysignature
= mpropdef
.msignature
1324 if mysignature
== null then return # Error thus skiped
1326 # Lookup for signature in the precursor
1327 # FIXME all precursors should be considered
1328 if not mpropdef
.is_intro
then
1329 var msignature
= mpropdef
.mproperty
.intro
.msignature
1330 if msignature
== null then return
1332 if mysignature
.arity
!= msignature
.arity
then
1334 if nsig
!= null then node
= nsig
else node
= self
1335 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}`.")
1338 var precursor_ret_type
= msignature
.return_mtype
1339 var ret_type
= mysignature
.return_mtype
1340 if ret_type
!= null and precursor_ret_type
== null then
1342 if nsig
!= null then node
= nsig
else node
= self
1343 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1347 if mysignature
.arity
> 0 then
1348 # Check parameters types
1349 for i
in [0..mysignature
.arity
[ do
1350 var myt
= mysignature
.mparameters
[i
].mtype
1351 var prt
= msignature
.mparameters
[i
].mtype
1353 if nsig
!= null then node
= nsig
else node
= self
1354 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1355 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1359 if precursor_ret_type
!= null then
1361 if nsig
!= null then node
= nsig
else node
= self
1362 if ret_type
== null then
1363 # Inherit the return type
1364 ret_type
= precursor_ret_type
1365 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1366 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1373 redef class ATypePropdef
1374 redef type MPROPDEF: MVirtualTypeDef
1376 redef fun build_property
(modelbuilder
, mclassdef
)
1378 var name
= self.n_id
.text
1379 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1380 if mprop
== null then
1381 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1382 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1383 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1384 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1387 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1389 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1390 assert mprop
isa MVirtualTypeProp
1391 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1393 mclassdef
.mprop2npropdef
[mprop
] = self
1395 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1396 self.mpropdef
= mpropdef
1397 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1398 if mpropdef
.is_intro
then
1399 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1401 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1403 set_doc
(mpropdef
, modelbuilder
)
1405 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1406 if atfixed
!= null then
1407 mpropdef
.is_fixed
= true
1411 redef fun build_signature
(modelbuilder
)
1413 var mpropdef
= self.mpropdef
1414 if mpropdef
== null then return # Error thus skipped
1415 var mclassdef
= mpropdef
.mclassdef
1416 var mmodule
= mclassdef
.mmodule
1417 var mtype
: nullable MType = null
1419 var ntype
= self.n_type
1420 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1421 if mtype
== null then return
1423 mpropdef
.bound
= mtype
1424 # print "{mpropdef}: {mtype}"
1427 redef fun check_signature
(modelbuilder
)
1429 var mpropdef
= self.mpropdef
1430 if mpropdef
== null then return # Error thus skipped
1432 var bound
= mpropdef
.bound
1433 if bound
== null then return # Error thus skipped
1435 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1437 var mclassdef
= mpropdef
.mclassdef
1438 var mmodule
= mclassdef
.mmodule
1439 var anchor
= mclassdef
.bound_mtype
1441 var ntype
= self.n_type
1442 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1443 mpropdef
.bound
= null
1447 # Check redefinitions
1448 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1449 var supbound
= p
.bound
1450 if supbound
== null then break # broken super bound, skip error
1452 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1455 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1456 # Still a warning to pass existing bad code
1457 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1460 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1461 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")