1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.bound
= mclassdef
.mmodule
.model
.null_type
116 for npropdef
in nclassdef2
.n_propdefs
do
117 # Check ATypePropdef first since they may be required for the other properties
118 if not npropdef
isa ATypePropdef then continue
119 npropdef
.check_signature
(self)
122 for npropdef
in nclassdef2
.n_propdefs
do
123 if npropdef
isa ATypePropdef then continue
124 npropdef
.check_signature
(self)
127 process_default_constructors
(nclassdef
)
130 # the root init of the Object class
131 # Is usually implicitly defined
132 # Then explicit or implicit definitions of root-init are attached to it
133 var the_root_init_mmethod
: nullable MMethod
135 # Introduce or inherit default constructor
136 # This is the last part of `build_properties`.
137 private fun process_default_constructors
(nclassdef
: AClassdef)
139 var mclassdef
= nclassdef
.mclassdef
.as(not null)
141 # Are we a refinement
142 if not mclassdef
.is_intro
then return
144 # Look for the init in Object, or create it
145 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
146 # Create the implicit root-init method
147 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
148 mprop
.is_root_init
= true
149 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
150 var mparameters
= new Array[MParameter]
151 var msignature
= new MSignature(mparameters
, null)
152 mpropdef
.msignature
= msignature
153 mpropdef
.new_msignature
= msignature
155 nclassdef
.mfree_init
= mpropdef
156 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
157 the_root_init_mmethod
= mprop
161 # Is there already a constructor defined?
162 var defined_init
: nullable MMethodDef = null
163 for mpropdef
in mclassdef
.mpropdefs
do
164 if not mpropdef
isa MMethodDef then continue
165 if not mpropdef
.mproperty
.is_init
then continue
166 if mpropdef
.mproperty
.is_root_init
then
167 assert defined_init
== null
168 defined_init
= mpropdef
169 else if mpropdef
.mproperty
.name
== "init" then
170 # An explicit old-style init named "init", so return
175 if not nclassdef
isa AStdClassdef then return
177 # Collect undefined attributes
178 var mparameters
= new Array[MParameter]
179 var initializers
= new Array[MProperty]
180 for npropdef
in nclassdef
.n_propdefs
do
181 if npropdef
isa AMethPropdef then
182 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
183 if npropdef
.mpropdef
== null then return # Skip broken method
184 var sig
= npropdef
.mpropdef
.msignature
185 if sig
== null then continue # Skip broken method
187 for param
in sig
.mparameters
do
188 var ret_type
= param
.mtype
189 var mparameter
= new MParameter(param
.name
, ret_type
, false)
190 mparameters
.add
(mparameter
)
192 initializers
.add
(npropdef
.mpropdef
.mproperty
)
193 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
195 if npropdef
isa AAttrPropdef then
196 var mreadpropdef
= npropdef
.mreadpropdef
197 if mreadpropdef
== null or mreadpropdef
.msignature
== null then return # Skip broken attribute
198 if npropdef
.noinit
then continue # Skip noinit attribute
199 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
200 if atlateinit
!= null then
201 # For lateinit attributes, call the reader to force
202 # the lazy initialization of the attribute.
203 initializers
.add
(mreadpropdef
.mproperty
)
204 mreadpropdef
.mproperty
.is_autoinit
= true
207 if npropdef
.has_value
then continue
208 var paramname
= mreadpropdef
.mproperty
.name
209 var ret_type
= mreadpropdef
.msignature
.return_mtype
210 if ret_type
== null then return
211 var mparameter
= new MParameter(paramname
, ret_type
, false)
212 mparameters
.add
(mparameter
)
213 var msetter
= npropdef
.mwritepropdef
214 if msetter
== null then
215 # No setter, it is a readonly attribute, so just add it
216 initializers
.add
(npropdef
.mpropdef
.mproperty
)
217 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
219 # Add the setter to the list
220 initializers
.add
(msetter
.mproperty
)
221 msetter
.mproperty
.is_autoinit
= true
226 if the_root_init_mmethod
== null then return
228 # Look for most-specific new-stype init definitions
229 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
230 if spropdefs
.is_empty
then
231 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
235 # Look at the autoinit class-annotation
236 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
237 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
238 if autoinit
!= null then
239 # Just throws the collected initializers
243 if noautoinit
!= null then
244 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
247 if autoinit
.n_args
.is_empty
then
248 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
251 # Get and check each argument
252 for narg
in autoinit
.n_args
do
255 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
259 # Search the property.
260 # To avoid bad surprises, try to get the setter first.
261 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
263 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
266 error
(narg
, "Error: unknown method `{id}`")
269 if not p
.is_autoinit
then
270 error
(narg
, "Error: `{p}` is not an autoinit method")
274 # Register the initializer and the parameters
277 if pd
isa MMethodDef then
278 # Get the signature resolved for the current receiver
279 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
280 mparameters
.add_all
(sig
.mparameters
)
287 # Search the longest-one and checks for conflict
288 var longest
= spropdefs
.first
289 if spropdefs
.length
> 1 then
290 # part 1. find the longest list
291 for spd
in spropdefs
do
292 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
295 # Check for conflict in the order of initializers
296 # Each initializer list must me a prefix of the longest list
297 # If `noautoinit` is set, just ignore conflicts
298 if noautoinit
== null then for spd
in spropdefs
do
300 for p
in spd
.initializers
do
301 if p
!= longest
.initializers
[i
] then
302 var proposal
= new ArraySet[MProperty]
303 for spd2
in spropdefs
do
304 proposal
.add_all spd2
.initializers
306 proposal
.add_all initializers
307 self.error
(nclassdef
, "Error: cannot generate automatic init for class {mclassdef.mclass}. Conflict in the order in inherited initializers {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")}). Use `autoinit` to order initializers. eg `autoinit {proposal.join(", ")}`")
308 # TODO: invalidate the initializer to avoid more errors
316 if noautoinit
!= null then
317 # If there is local or inherited initializers, then complain.
318 if initializers
.is_empty
and longest
.initializers
.is_empty
then
319 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
321 # Just clear initializers
325 # Can we just inherit?
326 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
327 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
328 mclassdef
.mclass
.root_init
= longest
332 # Combine the inherited list to what is collected
333 if longest
.initializers
.length
> 0 then
334 mparameters
.prepend longest
.new_msignature
.mparameters
335 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 package.
633 # A public property should have a unique qualified name `package::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
.mpackage
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mpackage
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.")
652 # Checks for useless type in redef signatures.
653 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
656 redef class ASignature
657 # Is the model builder has correctly visited the signature
658 var is_visited
= false
659 # Names of parameters from the AST
660 # REQUIRE: is_visited
661 var param_names
= new Array[String]
662 # Types of parameters from the AST
663 # REQUIRE: is_visited
664 var param_types
= new Array[MType]
665 # Rank of the vararg (of -1 if none)
666 # REQUIRE: is_visited
667 var vararg_rank
: Int = -1
669 var ret_type
: nullable MType = null
671 # Visit and fill information about a signature
672 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
674 var mmodule
= mclassdef
.mmodule
675 var param_names
= self.param_names
676 var param_types
= self.param_types
677 for np
in self.n_params
do
678 param_names
.add
(np
.n_id
.text
)
679 var ntype
= np
.n_type
680 if ntype
!= null then
681 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
682 if mtype
== null then return false # Skip error
683 for i
in [0..param_names
.length-param_types
.length
[ do
684 param_types
.add
(mtype
)
686 if np
.n_dotdotdot
!= null then
687 if self.vararg_rank
!= -1 then
688 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
691 self.vararg_rank
= param_names
.length
- 1
696 var ntype
= self.n_type
697 if ntype
!= null then
698 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
699 if self.ret_type
== null then return false # Skip error
702 self.is_visited
= true
706 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
709 for np
in self.n_params
do
710 var ntype
= np
.n_type
711 if ntype
!= null then
712 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
717 var ntype
= self.n_type
718 if ntype
!= null then
719 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
728 # The associated mparameter if any
729 var mparameter
: nullable MParameter = null
732 redef class AMethPropdef
733 redef type MPROPDEF: MMethodDef
735 # Is the method annotated `autoinit`?
736 var is_autoinit
= false
738 # Can self be used as a root init?
739 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
741 # Need the `init` keyword
742 if n_kwinit
== null then return false
743 # Need to by anonymous
744 if self.n_methid
!= null then return false
745 # No annotation on itself
746 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
748 var amod
= self.parent
.parent
.as(AModule)
749 var amoddecl
= amod
.n_moduledecl
750 if amoddecl
!= null then
751 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
752 if old
!= null then return false
755 if self.n_signature
.n_params
.length
> 0 then
756 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
759 # Cannot be private or something
760 if not self.n_visibility
isa APublicVisibility then
761 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
768 redef fun build_property
(modelbuilder
, mclassdef
)
770 var n_kwinit
= n_kwinit
771 var n_kwnew
= n_kwnew
772 var is_init
= n_kwinit
!= null or n_kwnew
!= null
774 var amethodid
= self.n_methid
776 if amethodid
== null then
780 else if n_kwinit
!= null then
783 else if n_kwnew
!= null then
789 else if amethodid
isa AIdMethid then
790 name
= amethodid
.n_id
.text
791 name_node
= amethodid
793 # operator, bracket or assign
794 name
= amethodid
.collect_text
795 name_node
= amethodid
797 var arity
= self.n_signature
.n_params
.length
798 if name
== "+" and arity
== 0 then
800 else if name
== "-" and arity
== 0 then
802 else if name
== "~" and arity
== 0 then
805 if amethodid
.is_binary
and arity
!= 1 then
806 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
807 else if amethodid
.min_arity
> arity
then
808 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
813 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
814 var mprop
: nullable MMethod = null
815 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
816 if mprop
== null and look_like_a_root_init
then
817 mprop
= modelbuilder
.the_root_init_mmethod
819 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
820 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
823 if mprop
== null then
824 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
825 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
826 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
827 modelbuilder
.the_root_init_mmethod
= mprop
828 mprop
.is_root_init
= true
830 mprop
.is_init
= is_init
831 mprop
.is_new
= n_kwnew
!= null
832 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
833 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
834 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
836 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
837 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
840 # Check name conflicts in the local class for constructors.
842 for p
, n
in mclassdef
.mprop2npropdef
do
843 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
844 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
850 mclassdef
.mprop2npropdef
[mprop
] = self
852 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
854 set_doc
(mpropdef
, modelbuilder
)
856 self.mpropdef
= mpropdef
857 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
858 if mpropdef
.is_intro
then
859 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
861 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
865 redef fun build_signature
(modelbuilder
)
867 var mpropdef
= self.mpropdef
868 if mpropdef
== null then return # Error thus skiped
869 var mclassdef
= mpropdef
.mclassdef
870 var mmodule
= mclassdef
.mmodule
871 var nsig
= self.n_signature
873 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
874 var root_init
= mclassdef
.mclass
.root_init
875 if root_init
!= null then
876 # Inherit the initializers by refinement
877 mpropdef
.new_msignature
= root_init
.new_msignature
878 assert mpropdef
.initializers
.is_empty
879 mpropdef
.initializers
.add_all root_init
.initializers
883 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
884 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
886 # Retrieve info from the signature AST
887 var param_names
= new Array[String] # Names of parameters from the AST
888 var param_types
= new Array[MType] # Types of parameters from the AST
890 var ret_type
: nullable MType = null # Return type from the AST
892 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
893 param_names
= nsig
.param_names
894 param_types
= nsig
.param_types
895 vararg_rank
= nsig
.vararg_rank
896 ret_type
= nsig
.ret_type
899 # Look for some signature to inherit
900 # FIXME: do not inherit from the intro, but from the most specific
901 var msignature
: nullable MSignature = null
902 if not mpropdef
.is_intro
then
903 msignature
= mpropdef
.mproperty
.intro
.msignature
904 if msignature
== null then return # Skip error
906 # The local signature is adapted to use the local formal types, if any.
907 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
909 # Check inherited signature arity
910 if param_names
.length
!= msignature
.arity
then
912 if nsig
!= null then node
= nsig
else node
= self
913 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}`.")
916 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
917 # FIXME UGLY: inherit signature from a super-constructor
918 for msupertype
in mclassdef
.supertypes
do
919 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
920 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
921 if candidate
!= null then
922 if msignature
== null then
923 msignature
= candidate
.intro
.as(MMethodDef).msignature
930 # Inherit the signature
931 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
932 # Parameters are untyped, thus inherit them
933 param_types
= new Array[MType]
934 for mparameter
in msignature
.mparameters
do
935 param_types
.add
(mparameter
.mtype
)
937 vararg_rank
= msignature
.vararg_rank
939 if msignature
!= null and ret_type
== null then
940 ret_type
= msignature
.return_mtype
943 if param_names
.length
!= param_types
.length
then
944 # Some parameters are typed, other parameters are not typed.
945 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
949 var mparameters
= new Array[MParameter]
950 for i
in [0..param_names
.length
[ do
951 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
952 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
953 mparameters
.add
(mparameter
)
956 # In `new`-factories, the return type is by default the classtype.
957 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
959 # Special checks for operator methods
960 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
961 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
963 if ret_type
== null and return_is_mandatory
then
964 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
967 msignature
= new MSignature(mparameters
, ret_type
)
968 mpropdef
.msignature
= msignature
969 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
970 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
971 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
974 var at
= self.get_single_annotation
("lazy", modelbuilder
)
975 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
977 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
978 if atautoinit
!= null then
979 if not mpropdef
.is_intro
then
980 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
981 else if not mclassdef
.is_intro
then
982 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
984 self.is_autoinit
= true
989 redef fun check_signature
(modelbuilder
)
991 var mpropdef
= self.mpropdef
992 if mpropdef
== null then return # Error thus skiped
993 var mclassdef
= mpropdef
.mclassdef
994 var mmodule
= mclassdef
.mmodule
995 var nsig
= self.n_signature
996 var mysignature
= self.mpropdef
.msignature
997 if mysignature
== null then return # Error thus skiped
1000 if nsig
!= null then
1001 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1002 self.mpropdef
.msignature
= null # invalidate
1003 return # Forward error
1007 # Lookup for signature in the precursor
1008 # FIXME all precursors should be considered
1009 if not mpropdef
.is_intro
then
1010 var msignature
= mpropdef
.mproperty
.intro
.msignature
1011 if msignature
== null then return
1013 var precursor_ret_type
= msignature
.return_mtype
1014 var ret_type
= mysignature
.return_mtype
1015 if ret_type
!= null and precursor_ret_type
== null then
1016 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1017 self.mpropdef
.msignature
= null
1021 if mysignature
.arity
> 0 then
1022 # Check parameters types
1023 for i
in [0..mysignature
.arity
[ do
1024 var myt
= mysignature
.mparameters
[i
].mtype
1025 var prt
= msignature
.mparameters
[i
].mtype
1026 var node
= nsig
.n_params
[i
]
1027 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1028 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1029 self.mpropdef
.msignature
= null
1033 if precursor_ret_type
!= null then
1034 var node
: nullable ANode = null
1035 if nsig
!= null then node
= nsig
.n_type
1036 if node
== null then node
= self
1037 if ret_type
== null then
1038 # Inherit the return type
1039 ret_type
= precursor_ret_type
1040 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1041 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1042 self.mpropdef
.msignature
= null
1047 if mysignature
.arity
> 0 then
1048 # Check parameters visibility
1049 for i
in [0..mysignature
.arity
[ do
1050 var nt
= nsig
.n_params
[i
].n_type
1051 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1053 var nt
= nsig
.n_type
1054 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1056 check_repeated_types
(modelbuilder
)
1059 # For parameters, type is always useless in a redef.
1060 # For return type, type is useless if not covariant with introduction.
1061 redef fun check_repeated_types
(modelbuilder
) do
1062 if mpropdef
.is_intro
or n_signature
== null then return
1064 for param
in n_signature
.n_params
do
1065 if param
.n_type
!= null then
1066 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1070 var intro
= mpropdef
.mproperty
.intro
1071 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1072 if n_intro
== null or not n_intro
isa AMethPropdef then return
1074 var ret_type
= n_signature
.ret_type
1075 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1076 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1082 # Is a return required?
1084 # * True for operators and brackets.
1085 # * False for id and assignment.
1086 fun return_is_mandatory
: Bool do return true
1088 # Can the last parameter be special like a vararg?
1090 # * False for operators: the last one is in fact the only one.
1091 # * False for assignments: it is the right part of the assignment.
1092 # * True for ids and brackets.
1093 fun accept_special_last_parameter
: Bool do return false
1095 # The minimum required number of parameters.
1097 # * 1 for binary operators
1099 # * 1 for assignments
1100 # * 2 for bracket assignments
1102 fun min_arity
: Int do return 1
1104 # Is the `self` a binary operator?
1105 fun is_binary
: Bool do return true
1108 redef class AIdMethid
1109 redef fun return_is_mandatory
do return false
1110 redef fun accept_special_last_parameter
do return true
1111 redef fun min_arity
do return 0
1112 redef fun is_binary
do return false
1115 redef class ABraMethid
1116 redef fun accept_special_last_parameter
do return true
1117 redef fun is_binary
do return false
1120 redef class ABraassignMethid
1121 redef fun return_is_mandatory
do return false
1122 redef fun min_arity
do return 2
1123 redef fun is_binary
do return false
1126 redef class AAssignMethid
1127 redef fun return_is_mandatory
do return false
1128 redef fun is_binary
do return false
1131 redef class AAttrPropdef
1132 redef type MPROPDEF: MAttributeDef
1134 # The static type of the property (declared, inferred or inherited)
1135 # This attribute is also used to check if the property was analyzed and is valid.
1136 var mtype
: nullable MType
1138 # Is the node tagged `noinit`?
1141 # Is the node tagged lazy?
1144 # Has the node a default value?
1145 # Could be through `n_expr` or `n_block`
1146 var has_value
= false
1148 # The guard associated to a lazy attribute.
1149 # Because some engines does not have a working `isset`,
1150 # this additional attribute is used to guard the lazy initialization.
1151 # TODO: to remove once isset is correctly implemented
1152 var mlazypropdef
: nullable MAttributeDef
1154 # The associated getter (read accessor) if any
1155 var mreadpropdef
: nullable MMethodDef is writable
1156 # The associated setter (write accessor) if any
1157 var mwritepropdef
: nullable MMethodDef is writable
1159 redef fun build_property
(modelbuilder
, mclassdef
)
1161 var mclass
= mclassdef
.mclass
1163 var name
= nid2
.text
1165 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1166 if atabstract
== null then
1167 if not mclass
.kind
.need_init
then
1168 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1171 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1172 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1173 self.mpropdef
= mpropdef
1174 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1178 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1179 if mreadprop
== null then
1180 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1181 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1182 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1184 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1185 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1187 mclassdef
.mprop2npropdef
[mreadprop
] = self
1189 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1190 self.mreadpropdef
= mreadpropdef
1191 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1192 set_doc
(mreadpropdef
, modelbuilder
)
1193 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1194 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1196 has_value
= n_expr
!= null or n_block
!= null
1198 if atabstract
!= null and has_value
then
1199 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1203 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1204 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1205 if atnoinit
!= null then
1208 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1211 if atabstract
!= null then
1212 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1216 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1217 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1218 if atlazy
!= null or atlateinit
!= null then
1219 if atlazy
!= null and atlateinit
!= null then
1220 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1223 if not has_value
then
1224 if atlazy
!= null then
1225 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1226 else if atlateinit
!= null then
1227 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1233 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1234 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1235 self.mlazypropdef
= mlazypropdef
1238 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1239 if atreadonly
!= null then
1240 if not has_value
then
1241 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1243 # No setter, so just leave
1247 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1248 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1251 var writename
= name
+ "="
1252 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1253 if atwritable
!= null then
1254 if not atwritable
.n_args
.is_empty
then
1255 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1258 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1259 var nwkwredef
: nullable Token = null
1260 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1261 if mwriteprop
== null then
1263 if atwritable
!= null then
1264 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1266 mvisibility
= mreadprop
.visibility
1267 # By default, use protected visibility at most
1268 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1270 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1271 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1272 mwriteprop
.deprecation
= mreadprop
.deprecation
1274 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1275 if atwritable
!= null then
1276 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1279 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1281 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1282 self.mwritepropdef
= mwritepropdef
1283 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1284 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1285 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1287 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1288 if atautoinit
!= null then
1290 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1291 else if not mwritepropdef
.is_intro
then
1292 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1293 else if not mclassdef
.is_intro
then
1294 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1295 else if atabstract
== null then
1296 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1298 else if atabstract
!= null then
1299 # By default, abstract attribute are not autoinit
1304 redef fun build_signature
(modelbuilder
)
1306 var mreadpropdef
= self.mreadpropdef
1307 var mpropdef
= self.mpropdef
1308 if mreadpropdef
== null then return # Error thus skipped
1309 var mclassdef
= mreadpropdef
.mclassdef
1310 var mmodule
= mclassdef
.mmodule
1311 var mtype
: nullable MType = null
1314 var ntype
= self.n_type
1315 if ntype
!= null then
1316 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1317 if mtype
== null then return
1320 var inherited_type
: nullable MType = null
1321 # Inherit the type from the getter (usually an abstract getter)
1322 if not mreadpropdef
.is_intro
then
1323 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1324 if msignature
== null then return # Error, thus skipped
1325 inherited_type
= msignature
.return_mtype
1326 if inherited_type
!= null then
1327 # The inherited type is adapted to use the local formal types, if any.
1328 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1329 if mtype
== null then mtype
= inherited_type
1333 var nexpr
= self.n_expr
1334 if mtype
== null then
1335 if nexpr
!= null then
1336 if nexpr
isa ANewExpr then
1337 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1338 else if nexpr
isa AIntegerExpr then
1339 var cla
: nullable MClass = null
1340 if nexpr
.value
isa Int then
1341 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1342 else if nexpr
.value
isa Byte then
1343 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1344 else if nexpr
.value
isa Int8 then
1345 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1346 else if nexpr
.value
isa Int16 then
1347 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1348 else if nexpr
.value
isa UInt16 then
1349 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1350 else if nexpr
.value
isa Int32 then
1351 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1352 else if nexpr
.value
isa UInt32 then
1353 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1355 # Should not happen, and should be updated as new types are added
1358 if cla
!= null then mtype
= cla
.mclass_type
1359 else if nexpr
isa AFloatExpr then
1360 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1361 if cla
!= null then mtype
= cla
.mclass_type
1362 else if nexpr
isa ACharExpr then
1363 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1364 if cla
!= null then mtype
= cla
.mclass_type
1365 else if nexpr
isa ABoolExpr then
1366 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1367 if cla
!= null then mtype
= cla
.mclass_type
1368 else if nexpr
isa ASuperstringExpr then
1369 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1370 if cla
!= null then mtype
= cla
.mclass_type
1371 else if nexpr
isa AStringFormExpr then
1372 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1373 if cla
!= null then mtype
= cla
.mclass_type
1375 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1378 if mtype
== null then return
1380 else if ntype
!= null and inherited_type
== mtype
then
1381 if nexpr
isa ANewExpr then
1382 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1383 if xmtype
== mtype
then
1384 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1389 if mtype
== null then
1390 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1396 if mpropdef
!= null then
1397 mpropdef
.static_mtype
= mtype
1401 var msignature
= new MSignature(new Array[MParameter], mtype
)
1402 mreadpropdef
.msignature
= msignature
1405 var mwritepropdef
= self.mwritepropdef
1406 if mwritepropdef
!= null then
1409 var mparameter
= new MParameter(name
, mtype
, false)
1410 var msignature
= new MSignature([mparameter
], null)
1411 mwritepropdef
.msignature
= msignature
1414 var mlazypropdef
= self.mlazypropdef
1415 if mlazypropdef
!= null then
1416 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1418 check_repeated_types
(modelbuilder
)
1421 redef fun check_signature
(modelbuilder
)
1423 var mpropdef
= self.mpropdef
1424 if mpropdef
== null then return # Error thus skipped
1425 var ntype
= self.n_type
1426 var mtype
= self.mtype
1427 if mtype
== null then return # Error thus skipped
1429 var mclassdef
= mpropdef
.mclassdef
1430 var mmodule
= mclassdef
.mmodule
1433 if ntype
!= null then
1434 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1437 if nexpr
isa ANewExpr then
1438 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1441 # Lookup for signature in the precursor
1442 # FIXME all precursors should be considered
1443 if not mpropdef
.is_intro
then
1444 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1445 if precursor_type
== null then return
1447 if mtype
!= precursor_type
then
1448 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1453 # Check getter and setter
1454 var meth
= self.mreadpropdef
1455 if meth
!= null then
1456 self.check_method_signature
(modelbuilder
, meth
)
1457 var node
: nullable ANode = ntype
1458 if node
== null then node
= self
1459 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1461 meth
= self.mwritepropdef
1462 if meth
!= null then
1463 self.check_method_signature
(modelbuilder
, meth
)
1464 var node
: nullable ANode = ntype
1465 if node
== null then node
= self
1466 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1470 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1472 var mclassdef
= mpropdef
.mclassdef
1473 var mmodule
= mclassdef
.mmodule
1474 var nsig
= self.n_type
1475 var mysignature
= mpropdef
.msignature
1476 if mysignature
== null then return # Error thus skiped
1478 # Lookup for signature in the precursor
1479 # FIXME all precursors should be considered
1480 if not mpropdef
.is_intro
then
1481 var msignature
= mpropdef
.mproperty
.intro
.msignature
1482 if msignature
== null then return
1484 if mysignature
.arity
!= msignature
.arity
then
1486 if nsig
!= null then node
= nsig
else node
= self
1487 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}`.")
1490 var precursor_ret_type
= msignature
.return_mtype
1491 var ret_type
= mysignature
.return_mtype
1492 if ret_type
!= null and precursor_ret_type
== null then
1494 if nsig
!= null then node
= nsig
else node
= self
1495 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1499 if mysignature
.arity
> 0 then
1500 # Check parameters types
1501 for i
in [0..mysignature
.arity
[ do
1502 var myt
= mysignature
.mparameters
[i
].mtype
1503 var prt
= msignature
.mparameters
[i
].mtype
1505 if nsig
!= null then node
= nsig
else node
= self
1506 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1507 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1511 if precursor_ret_type
!= null then
1513 if nsig
!= null then node
= nsig
else node
= self
1514 if ret_type
== null then
1515 # Inherit the return type
1516 ret_type
= precursor_ret_type
1517 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1518 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1524 # Type is useless if the attribute type is the same thant the intro.
1525 redef fun check_repeated_types
(modelbuilder
) do
1526 if mreadpropdef
.is_intro
or n_type
== null then return
1528 var intro
= mreadpropdef
.mproperty
.intro
1529 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1530 if n_intro
== null then return
1533 if n_intro
isa AMethPropdef then
1534 ntype
= n_intro
.n_signature
.ret_type
1535 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1536 ntype
= n_intro
.n_type
.mtype
1539 if ntype
==null or ntype
!= n_type
.mtype
then return
1540 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1544 redef class ATypePropdef
1545 redef type MPROPDEF: MVirtualTypeDef
1547 redef fun build_property
(modelbuilder
, mclassdef
)
1549 var name
= self.n_id
.text
1550 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1551 if mprop
== null then
1552 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1553 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1554 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1555 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1558 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1560 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1561 assert mprop
isa MVirtualTypeProp
1562 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1564 mclassdef
.mprop2npropdef
[mprop
] = self
1566 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1567 self.mpropdef
= mpropdef
1568 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1569 if mpropdef
.is_intro
then
1570 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1572 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1574 set_doc
(mpropdef
, modelbuilder
)
1576 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1577 if atfixed
!= null then
1578 mpropdef
.is_fixed
= true
1582 redef fun build_signature
(modelbuilder
)
1584 var mpropdef
= self.mpropdef
1585 if mpropdef
== null then return # Error thus skipped
1586 var mclassdef
= mpropdef
.mclassdef
1587 var mmodule
= mclassdef
.mmodule
1588 var mtype
: nullable MType = null
1590 var ntype
= self.n_type
1591 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1592 if mtype
== null then return
1594 mpropdef
.bound
= mtype
1595 # print "{mpropdef}: {mtype}"
1598 redef fun check_signature
(modelbuilder
)
1600 var mpropdef
= self.mpropdef
1601 if mpropdef
== null then return # Error thus skipped
1603 var bound
= mpropdef
.bound
1604 if bound
== null then return # Error thus skipped
1606 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1608 var mclassdef
= mpropdef
.mclassdef
1609 var mmodule
= mclassdef
.mmodule
1610 var anchor
= mclassdef
.bound_mtype
1612 var ntype
= self.n_type
1613 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1614 mpropdef
.bound
= null
1618 # Check redefinitions
1619 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1620 var supbound
= p
.bound
1621 if supbound
== null then break # broken super bound, skip error
1623 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1626 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1627 # Still a warning to pass existing bad code
1628 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1631 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1632 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")