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
.is_broken
= true
114 mpropdef
.bound
= mclassdef
.mmodule
.model
.null_type
117 for npropdef
in nclassdef2
.n_propdefs
do
118 # Check ATypePropdef first since they may be required for the other properties
119 if not npropdef
isa ATypePropdef then continue
120 npropdef
.check_signature
(self)
123 for npropdef
in nclassdef2
.n_propdefs
do
124 if npropdef
isa ATypePropdef then continue
125 npropdef
.check_signature
(self)
128 process_default_constructors
(nclassdef
)
131 # the root init of the Object class
132 # Is usually implicitly defined
133 # Then explicit or implicit definitions of root-init are attached to it
134 var the_root_init_mmethod
: nullable MMethod
136 # Introduce or inherit default constructor
137 # This is the last part of `build_properties`.
138 private fun process_default_constructors
(nclassdef
: AClassdef)
140 var mclassdef
= nclassdef
.mclassdef
.as(not null)
142 # Are we a refinement
143 if not mclassdef
.is_intro
then return
145 # Look for the init in Object, or create it
146 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
147 # Create the implicit root-init method
148 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
149 mprop
.is_root_init
= true
150 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
151 var mparameters
= new Array[MParameter]
152 var msignature
= new MSignature(mparameters
, null)
153 mpropdef
.msignature
= msignature
154 mpropdef
.new_msignature
= msignature
156 nclassdef
.mfree_init
= mpropdef
157 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
158 the_root_init_mmethod
= mprop
162 # Is there already a constructor defined?
163 var defined_init
: nullable MMethodDef = null
164 for mpropdef
in mclassdef
.mpropdefs
do
165 if not mpropdef
isa MMethodDef then continue
166 if not mpropdef
.mproperty
.is_init
then continue
167 if mpropdef
.mproperty
.is_root_init
then
168 assert defined_init
== null
169 defined_init
= mpropdef
170 else if mpropdef
.mproperty
.name
== "init" then
171 # An explicit old-style init named "init", so return
176 if not nclassdef
isa AStdClassdef then return
178 # Collect undefined attributes
179 var mparameters
= new Array[MParameter]
180 var initializers
= new Array[MProperty]
181 for npropdef
in nclassdef
.n_propdefs
do
182 if npropdef
isa AMethPropdef then
183 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
184 var mpropdef
= npropdef
.mpropdef
185 if mpropdef
== null then return # Skip broken method
186 var sig
= mpropdef
.msignature
187 if sig
== null then continue # Skip broken method
189 for param
in sig
.mparameters
do
190 var ret_type
= param
.mtype
191 var mparameter
= new MParameter(param
.name
, ret_type
, false)
192 mparameters
.add
(mparameter
)
194 initializers
.add
(mpropdef
.mproperty
)
195 mpropdef
.mproperty
.is_autoinit
= true
197 if npropdef
isa AAttrPropdef then
198 var mreadpropdef
= npropdef
.mreadpropdef
199 if mreadpropdef
== null then return # Skip broken attribute
200 var msignature
= mreadpropdef
.msignature
201 if msignature
== null then return # Skip broken attribute
202 if npropdef
.noinit
then continue # Skip noinit attribute
203 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
204 if atlateinit
!= null then
205 # For lateinit attributes, call the reader to force
206 # the lazy initialization of the attribute.
207 initializers
.add
(mreadpropdef
.mproperty
)
208 mreadpropdef
.mproperty
.is_autoinit
= true
211 if npropdef
.has_value
then continue
212 var paramname
= mreadpropdef
.mproperty
.name
213 var ret_type
= msignature
.return_mtype
214 if ret_type
== null then return
215 var mparameter
= new MParameter(paramname
, ret_type
, false)
216 mparameters
.add
(mparameter
)
217 var msetter
= npropdef
.mwritepropdef
218 if msetter
== null then
219 # No setter, it is a readonly attribute, so just add it
220 initializers
.add
(npropdef
.mpropdef
.mproperty
)
221 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
223 # Add the setter to the list
224 initializers
.add
(msetter
.mproperty
)
225 msetter
.mproperty
.is_autoinit
= true
230 var the_root_init_mmethod
= self.the_root_init_mmethod
231 if the_root_init_mmethod
== null then return
233 # Look for most-specific new-stype init definitions
234 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
235 if spropdefs
.is_empty
then
236 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
240 # Look at the autoinit class-annotation
241 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
242 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
243 if autoinit
!= null then
244 # Just throws the collected initializers
248 if noautoinit
!= null then
249 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
252 if autoinit
.n_args
.is_empty
then
253 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
256 # Get and check each argument
257 for narg
in autoinit
.n_args
do
260 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
264 # Search the property.
265 # To avoid bad surprises, try to get the setter first.
266 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
268 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
271 error
(narg
, "Error: unknown method `{id}`")
274 if not p
.is_autoinit
then
275 error
(narg
, "Error: `{p}` is not an autoinit method")
279 # Register the initializer and the parameters
282 if pd
isa MMethodDef then
283 # Get the signature resolved for the current receiver
284 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
285 mparameters
.add_all
(sig
.mparameters
)
292 # Search the longest-one and checks for conflict
293 var longest
= spropdefs
.first
294 if spropdefs
.length
> 1 then
295 # part 1. find the longest list
296 for spd
in spropdefs
do
297 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
300 # Check for conflict in the order of initializers
301 # Each initializer list must me a prefix of the longest list
302 # If `noautoinit` is set, just ignore conflicts
303 if noautoinit
== null then for spd
in spropdefs
do
305 for p
in spd
.initializers
do
306 if p
!= longest
.initializers
[i
] then
307 var proposal
= new ArraySet[MProperty]
308 for spd2
in spropdefs
do
309 proposal
.add_all spd2
.initializers
311 proposal
.add_all initializers
312 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(", ")}`")
313 # TODO: invalidate the initializer to avoid more errors
321 if noautoinit
!= null then
322 # If there is local or inherited initializers, then complain.
323 if initializers
.is_empty
and longest
.initializers
.is_empty
then
324 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
326 # Just clear initializers
330 # Can we just inherit?
331 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
332 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
333 mclassdef
.mclass
.root_init
= longest
337 # Combine the inherited list to what is collected
338 if longest
.initializers
.length
> 0 then
339 mparameters
.prepend longest
.new_msignature
.mparameters
340 initializers
.prepend longest
.initializers
345 # If we already have a basic init definition, then setup its initializers
346 if defined_init
!= null then
347 defined_init
.initializers
.add_all
(initializers
)
348 var msignature
= new MSignature(mparameters
, null)
349 defined_init
.new_msignature
= msignature
350 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
351 mclassdef
.mclass
.root_init
= defined_init
355 # Else create the local implicit basic init definition
356 var mprop
= the_root_init_mmethod
357 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
358 mpropdef
.has_supercall
= true
359 mpropdef
.initializers
.add_all
(initializers
)
360 var msignature
= new MSignature(mparameters
, null)
361 mpropdef
.new_msignature
= msignature
362 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
363 nclassdef
.mfree_init
= mpropdef
364 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
365 mclassdef
.mclass
.root_init
= mpropdef
368 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
369 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
371 var mmodule
= mpropdef
.mclassdef
.mmodule
372 var mproperty
= mpropdef
.mproperty
374 # Extract visibility information of the main part of `mtype`
375 # It is a case-by case
376 var vis_type
: nullable MVisibility = null # The own visibility of the type
377 var mmodule_type
: nullable MModule = null # The original module of the type
378 mtype
= mtype
.undecorate
379 if mtype
isa MClassType then
380 vis_type
= mtype
.mclass
.visibility
381 mmodule_type
= mtype
.mclass
.intro_mmodule
382 else if mtype
isa MVirtualType then
383 vis_type
= mtype
.mproperty
.visibility
384 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
385 else if mtype
isa MParameterType then
386 # nothing, always visible
387 else if mtype
isa MNullType then
390 node
.debug
"Unexpected type {mtype}"
394 if vis_type
!= null then
395 assert mmodule_type
!= null
396 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
397 if mproperty
.visibility
> vis_type
then
398 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
400 else if mproperty
.visibility
> vis_module_type
then
401 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
406 # No error, try to go deeper in generic types
407 if node
isa AType then
408 for a
in node
.n_types
do
410 if t
== null then continue # Error, thus skipped
411 check_visibility
(a
, t
, mpropdef
)
413 else if mtype
isa MGenericType then
414 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
418 # Detect circularity errors for virtual types.
419 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
422 # Slow case: progress on each resolution until we visit all without getting a loop
424 # The graph used to detect loops
425 var mtype
= mproperty
.mvirtualtype
426 var poset
= new POSet[MType]
428 # The work-list of types to resolve
429 var todo
= new List[MType]
432 while not todo
.is_empty
do
436 if not t
.need_anchor
then continue
438 # Get the types derived of `t` (subtypes and bounds)
440 if t
isa MNullableType then
442 else if t
isa MGenericType then
444 else if t
isa MVirtualType then
446 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
447 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
448 # TODO something to manage correctly bound conflicts
449 assert not defs
.is_empty
450 nexts
= new Array[MType]
452 var next
= defs
.first
.bound
453 if next
== null then return false
456 else if t
isa MClassType then
457 # Basic type, nothing to to
459 else if t
isa MParameterType then
460 # Parameter types cannot depend on virtual types, so nothing to do
468 if poset
.has_edge
(next
, t
) then
469 if mtype
== next
then
470 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
472 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
476 poset
.add_edge
(t
, next
)
486 # Does the MPropDef contains a call to super or a call of a super-constructor?
487 # Subsequent phases of the frontend (esp. typing) set it if required
488 var has_supercall
: Bool = false is writable
491 redef class AClassdef
492 # Marker used in `ModelBuilder::build_properties`
493 private var build_properties_is_done
= false
495 # The free init (implicitely constructed by the class if required)
496 var mfree_init
: nullable MMethodDef = null
500 # The base init of the class.
501 # Used to get the common new_msignature and initializers
503 # TODO: Where to put this information is not clear because unlike other
504 # informations, the initialisers are stable in a same class.
505 var root_init
: nullable MMethodDef = null
508 redef class MClassDef
509 # What is the `APropdef` associated to a `MProperty`?
510 # Used to check multiple definition of a property.
511 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
513 # Build the virtual type `SELF` only for introduction `MClassDef`
514 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
516 if not is_intro
then return
519 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
521 # If SELF type is declared nowherer?
522 if mprop
== null then return
524 # SELF is not a virtual type? it is weird but we ignore it
525 if not mprop
isa MVirtualTypeProp then return
527 # Is this the intro of SELF in the library?
528 var intro
= mprop
.intro
529 var intro_mclassdef
= intro
.mclassdef
530 if intro_mclassdef
== self then
531 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
533 # SELF must be declared in Object, otherwise this will create conflicts
534 if intro_mclassdef
.mclass
.name
!= "Object" then
535 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
538 # SELF must be public
539 if mprop
.visibility
!= public_visibility
then
540 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
543 # SELF must not be fixed
544 if intro
.is_fixed
then
545 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
551 # This class introduction inherits a SELF
552 # We insert an artificial property to update it
553 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
554 mpropdef
.bound
= mclass
.mclass_type
559 # The associated main model entity
560 type MPROPDEF: MPropDef
562 # The associated propdef once build by a `ModelBuilder`
563 var mpropdef
: nullable MPROPDEF is writable
565 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
566 private fun build_signature
(modelbuilder
: ModelBuilder) do end
567 private fun check_signature
(modelbuilder
: ModelBuilder) do end
568 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
570 var mvisibility
= public_visibility
571 if nvisibility
!= null then
572 mvisibility
= nvisibility
.mvisibility
573 if mvisibility
== intrude_visibility
then
574 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
575 mvisibility
= public_visibility
578 if mclassdef
.mclass
.visibility
== private_visibility
then
579 if mvisibility
== protected_visibility
then
580 assert nvisibility
!= null
581 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
582 else if mvisibility
== private_visibility
then
583 assert nvisibility
!= null
584 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
586 mvisibility
= private_visibility
591 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
593 var ndoc
= self.n_doc
595 var mdoc
= ndoc
.to_mdoc
597 mdoc
.original_mentity
= mpropdef
598 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
599 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
602 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
603 if at_deprecated
!= null then
604 if not mpropdef
.is_intro
then
605 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
607 var info
= new MDeprecationInfo
608 ndoc
= at_deprecated
.n_doc
609 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
610 mpropdef
.mproperty
.deprecation
= info
615 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
617 if nvisibility
== null then return
618 var mvisibility
= nvisibility
.mvisibility
619 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
620 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
624 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
626 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
627 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
630 if mprop
isa MMethod and mprop
.is_root_init
then return true
631 if kwredef
== null then
633 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
637 # Check for full-name conflicts in the package.
638 # A public property should have a unique qualified name `package::class::prop`.
639 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
640 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
641 if others
!= null then for other
in others
do
642 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
643 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}`.")
649 if not need_redef
then
650 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
657 # Checks for useless type in redef signatures.
658 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
661 redef class ASignature
662 # Is the model builder has correctly visited the signature
663 var is_visited
= false
664 # Names of parameters from the AST
665 # REQUIRE: is_visited
666 var param_names
= new Array[String]
667 # Types of parameters from the AST
668 # REQUIRE: is_visited
669 var param_types
= new Array[MType]
670 # Rank of the vararg (of -1 if none)
671 # REQUIRE: is_visited
672 var vararg_rank
: Int = -1
674 var ret_type
: nullable MType = null
676 # Visit and fill information about a signature
677 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
679 var mmodule
= mclassdef
.mmodule
680 var param_names
= self.param_names
681 var param_types
= self.param_types
682 for np
in self.n_params
do
683 param_names
.add
(np
.n_id
.text
)
684 var ntype
= np
.n_type
685 if ntype
!= null then
686 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
687 if mtype
== null then return false # Skip error
688 for i
in [0..param_names
.length-param_types
.length
[ do
689 param_types
.add
(mtype
)
691 if np
.n_dotdotdot
!= null then
692 if self.vararg_rank
!= -1 then
693 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
696 self.vararg_rank
= param_names
.length
- 1
701 var ntype
= self.n_type
702 if ntype
!= null then
703 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
704 if self.ret_type
== null then return false # Skip error
707 self.is_visited
= true
711 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
714 for np
in self.n_params
do
715 var ntype
= np
.n_type
716 if ntype
!= null then
717 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
722 var ntype
= self.n_type
723 if ntype
!= null then
724 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
728 if not res
then is_broken
= true
734 # The associated mparameter if any
735 var mparameter
: nullable MParameter = null
738 redef class AMethPropdef
739 redef type MPROPDEF: MMethodDef
741 # Is the method annotated `autoinit`?
742 var is_autoinit
= false
744 # Can self be used as a root init?
745 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
747 # Need the `init` keyword
748 if n_kwinit
== null then return false
749 # Need to by anonymous
750 if self.n_methid
!= null then return false
751 # No annotation on itself
752 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
754 var amod
= self.parent
.parent
.as(AModule)
755 var amoddecl
= amod
.n_moduledecl
756 if amoddecl
!= null then
757 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
758 if old
!= null then return false
761 if self.n_signature
.n_params
.length
> 0 then
762 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
765 # Cannot be private or something
766 if not self.n_visibility
isa APublicVisibility then
767 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
774 redef fun build_property
(modelbuilder
, mclassdef
)
776 var n_kwinit
= n_kwinit
777 var n_kwnew
= n_kwnew
778 var is_init
= n_kwinit
!= null or n_kwnew
!= null
780 var amethodid
= self.n_methid
782 if amethodid
== null then
786 else if n_kwinit
!= null then
789 else if n_kwnew
!= null then
795 else if amethodid
isa AIdMethid then
796 name
= amethodid
.n_id
.text
797 name_node
= amethodid
799 # operator, bracket or assign
800 name
= amethodid
.collect_text
801 name_node
= amethodid
803 var arity
= self.n_signature
.n_params
.length
804 if name
== "+" and arity
== 0 then
806 else if name
== "-" and arity
== 0 then
808 else if name
== "~" and arity
== 0 then
811 if amethodid
.is_binary
and arity
!= 1 then
812 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
813 else if amethodid
.min_arity
> arity
then
814 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
819 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
820 var mprop
: nullable MMethod = null
821 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
822 if mprop
== null and look_like_a_root_init
then
823 mprop
= modelbuilder
.the_root_init_mmethod
825 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
826 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
829 if mprop
== null then
830 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
831 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
832 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
833 modelbuilder
.the_root_init_mmethod
= mprop
834 mprop
.is_root_init
= true
836 mprop
.is_init
= is_init
837 mprop
.is_new
= n_kwnew
!= null
838 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
839 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
840 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
841 mprop
.is_broken
= true
845 if mprop
.is_broken
then
848 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
849 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
852 # Check name conflicts in the local class for constructors.
854 for p
, n
in mclassdef
.mprop2npropdef
do
855 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
856 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
857 mprop
.is_broken
= true
865 mclassdef
.mprop2npropdef
[mprop
] = self
867 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
869 set_doc
(mpropdef
, modelbuilder
)
871 self.mpropdef
= mpropdef
872 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
873 if mpropdef
.is_intro
then
874 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
876 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
880 redef fun build_signature
(modelbuilder
)
882 var mpropdef
= self.mpropdef
883 if mpropdef
== null then return # Error thus skiped
884 var mclassdef
= mpropdef
.mclassdef
885 var mmodule
= mclassdef
.mmodule
886 var nsig
= self.n_signature
888 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
889 var root_init
= mclassdef
.mclass
.root_init
890 if root_init
!= null then
891 # Inherit the initializers by refinement
892 mpropdef
.new_msignature
= root_init
.new_msignature
893 assert mpropdef
.initializers
.is_empty
894 mpropdef
.initializers
.add_all root_init
.initializers
898 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
899 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
901 # Retrieve info from the signature AST
902 var param_names
= new Array[String] # Names of parameters from the AST
903 var param_types
= new Array[MType] # Types of parameters from the AST
905 var ret_type
: nullable MType = null # Return type from the AST
907 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
908 param_names
= nsig
.param_names
909 param_types
= nsig
.param_types
910 vararg_rank
= nsig
.vararg_rank
911 ret_type
= nsig
.ret_type
914 # Look for some signature to inherit
915 # FIXME: do not inherit from the intro, but from the most specific
916 var msignature
: nullable MSignature = null
917 if not mpropdef
.is_intro
then
918 msignature
= mpropdef
.mproperty
.intro
.msignature
919 if msignature
== null then return # Skip error
921 # The local signature is adapted to use the local formal types, if any.
922 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
924 # Check inherited signature arity
925 if param_names
.length
!= msignature
.arity
then
927 if nsig
!= null then node
= nsig
else node
= self
928 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}`.")
931 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
932 # FIXME UGLY: inherit signature from a super-constructor
933 for msupertype
in mclassdef
.supertypes
do
934 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
935 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
936 if candidate
!= null then
937 if msignature
== null then
938 msignature
= candidate
.intro
.as(MMethodDef).msignature
945 # Inherit the signature
946 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
947 # Parameters are untyped, thus inherit them
948 param_types
= new Array[MType]
949 for mparameter
in msignature
.mparameters
do
950 param_types
.add
(mparameter
.mtype
)
952 vararg_rank
= msignature
.vararg_rank
954 if msignature
!= null and ret_type
== null then
955 ret_type
= msignature
.return_mtype
958 if param_names
.length
!= param_types
.length
then
959 # Some parameters are typed, other parameters are not typed.
960 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
964 var mparameters
= new Array[MParameter]
965 for i
in [0..param_names
.length
[ do
966 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
967 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
968 mparameters
.add
(mparameter
)
971 # In `new`-factories, the return type is by default the classtype.
972 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
974 # Special checks for operator methods
975 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
976 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
978 if ret_type
== null and return_is_mandatory
then
979 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
982 msignature
= new MSignature(mparameters
, ret_type
)
983 mpropdef
.msignature
= msignature
984 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
985 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
986 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
989 var at
= self.get_single_annotation
("lazy", modelbuilder
)
990 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
992 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
993 if atautoinit
!= null then
994 if not mpropdef
.is_intro
then
995 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
996 else if not mclassdef
.is_intro
then
997 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
999 self.is_autoinit
= true
1004 redef fun check_signature
(modelbuilder
)
1006 var mpropdef
= self.mpropdef
1007 if mpropdef
== null then return # Error thus skiped
1008 var mclassdef
= mpropdef
.mclassdef
1009 var mmodule
= mclassdef
.mmodule
1010 var nsig
= self.n_signature
1011 var mysignature
= mpropdef
.msignature
1012 if mysignature
== null then return # Error thus skiped
1015 if nsig
!= null then
1016 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1017 mpropdef
.msignature
= null # invalidate
1018 mpropdef
.is_broken
= true
1019 return # Forward error
1023 # Lookup for signature in the precursor
1024 # FIXME all precursors should be considered
1025 if not mpropdef
.is_intro
then
1026 var msignature
= mpropdef
.mproperty
.intro
.msignature
1027 if msignature
== null then return
1029 var precursor_ret_type
= msignature
.return_mtype
1030 var ret_type
= mysignature
.return_mtype
1031 if ret_type
!= null and precursor_ret_type
== null then
1032 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1033 mpropdef
.msignature
= null
1034 mpropdef
.is_broken
= true
1038 if mysignature
.arity
> 0 then
1039 # Check parameters types
1040 for i
in [0..mysignature
.arity
[ do
1041 var myt
= mysignature
.mparameters
[i
].mtype
1042 var prt
= msignature
.mparameters
[i
].mtype
1043 var node
= nsig
.n_params
[i
]
1044 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1045 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1046 mpropdef
.msignature
= null
1047 mpropdef
.is_broken
= true
1051 if precursor_ret_type
!= null then
1052 var node
: nullable ANode = null
1053 if nsig
!= null then node
= nsig
.n_type
1054 if node
== null then node
= self
1055 if ret_type
== null then
1056 # Inherit the return type
1057 ret_type
= precursor_ret_type
1058 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1059 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1060 mpropdef
.msignature
= null
1061 mpropdef
.is_broken
= true
1066 if mysignature
.arity
> 0 then
1067 # Check parameters visibility
1068 for i
in [0..mysignature
.arity
[ do
1069 var nt
= nsig
.n_params
[i
].n_type
1070 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1072 var nt
= nsig
.n_type
1073 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1075 check_repeated_types
(modelbuilder
)
1078 # For parameters, type is always useless in a redef.
1079 # For return type, type is useless if not covariant with introduction.
1080 redef fun check_repeated_types
(modelbuilder
) do
1081 var mpropdef
= self.mpropdef
1082 if mpropdef
== null then return
1083 if mpropdef
.is_intro
or n_signature
== null then return
1085 for param
in n_signature
.n_params
do
1086 if param
.n_type
!= null then
1087 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1091 var intro
= mpropdef
.mproperty
.intro
1092 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1093 if n_intro
== null or not n_intro
isa AMethPropdef then return
1095 var ret_type
= n_signature
.ret_type
1096 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1097 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1103 # Is a return required?
1105 # * True for operators and brackets.
1106 # * False for id and assignment.
1107 fun return_is_mandatory
: Bool do return true
1109 # Can the last parameter be special like a vararg?
1111 # * False for operators: the last one is in fact the only one.
1112 # * False for assignments: it is the right part of the assignment.
1113 # * True for ids and brackets.
1114 fun accept_special_last_parameter
: Bool do return false
1116 # The minimum required number of parameters.
1118 # * 1 for binary operators
1120 # * 1 for assignments
1121 # * 2 for bracket assignments
1123 fun min_arity
: Int do return 1
1125 # Is the `self` a binary operator?
1126 fun is_binary
: Bool do return true
1129 redef class AIdMethid
1130 redef fun return_is_mandatory
do return false
1131 redef fun accept_special_last_parameter
do return true
1132 redef fun min_arity
do return 0
1133 redef fun is_binary
do return false
1136 redef class ABraMethid
1137 redef fun accept_special_last_parameter
do return true
1138 redef fun is_binary
do return false
1141 redef class ABraassignMethid
1142 redef fun return_is_mandatory
do return false
1143 redef fun min_arity
do return 2
1144 redef fun is_binary
do return false
1147 redef class AAssignMethid
1148 redef fun return_is_mandatory
do return false
1149 redef fun is_binary
do return false
1152 redef class AAttrPropdef
1153 redef type MPROPDEF: MAttributeDef
1155 # The static type of the property (declared, inferred or inherited)
1156 # This attribute is also used to check if the property was analyzed and is valid.
1157 var mtype
: nullable MType
1159 # Is the node tagged `noinit`?
1162 # Is the node tagged lazy?
1165 # Has the node a default value?
1166 # Could be through `n_expr` or `n_block`
1167 var has_value
= false
1169 # The guard associated to a lazy attribute.
1170 # Because some engines does not have a working `isset`,
1171 # this additional attribute is used to guard the lazy initialization.
1172 # TODO: to remove once isset is correctly implemented
1173 var mlazypropdef
: nullable MAttributeDef
1175 # The associated getter (read accessor) if any
1176 var mreadpropdef
: nullable MMethodDef is writable
1177 # The associated setter (write accessor) if any
1178 var mwritepropdef
: nullable MMethodDef is writable
1180 redef fun build_property
(modelbuilder
, mclassdef
)
1182 var mclass
= mclassdef
.mclass
1184 var name
= nid2
.text
1186 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1187 if atabstract
== null then
1188 if not mclass
.kind
.need_init
then
1189 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1192 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1193 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1194 self.mpropdef
= mpropdef
1195 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1199 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1200 if mreadprop
== null then
1201 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1202 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1203 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1205 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1206 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1208 mclassdef
.mprop2npropdef
[mreadprop
] = self
1210 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1211 self.mreadpropdef
= mreadpropdef
1212 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1213 set_doc
(mreadpropdef
, modelbuilder
)
1214 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1215 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1217 has_value
= n_expr
!= null or n_block
!= null
1219 if atabstract
!= null and has_value
then
1220 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1224 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1225 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1226 if atnoinit
!= null then
1229 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1232 if atabstract
!= null then
1233 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1237 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1238 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1239 if atlazy
!= null or atlateinit
!= null then
1240 if atlazy
!= null and atlateinit
!= null then
1241 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1244 if not has_value
then
1245 if atlazy
!= null then
1246 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1247 else if atlateinit
!= null then
1248 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1254 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1255 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1256 self.mlazypropdef
= mlazypropdef
1259 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1260 if atreadonly
!= null then
1261 if not has_value
then
1262 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1264 # No setter, so just leave
1268 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1269 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1272 var writename
= name
+ "="
1273 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1274 if atwritable
!= null then
1275 if not atwritable
.n_args
.is_empty
then
1276 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1279 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1280 var nwkwredef
: nullable Token = null
1281 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1282 if mwriteprop
== null then
1284 if atwritable
!= null then
1285 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1287 mvisibility
= mreadprop
.visibility
1288 # By default, use protected visibility at most
1289 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1291 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1292 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1293 mwriteprop
.deprecation
= mreadprop
.deprecation
1295 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1296 if atwritable
!= null then
1297 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1300 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1302 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1303 self.mwritepropdef
= mwritepropdef
1304 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1305 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1306 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1308 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1309 if atautoinit
!= null then
1311 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1312 else if not mwritepropdef
.is_intro
then
1313 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1314 else if not mclassdef
.is_intro
then
1315 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1316 else if atabstract
== null then
1317 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1319 else if atabstract
!= null then
1320 # By default, abstract attribute are not autoinit
1325 redef fun build_signature
(modelbuilder
)
1327 var mreadpropdef
= self.mreadpropdef
1328 var mpropdef
= self.mpropdef
1329 if mreadpropdef
== null then return # Error thus skipped
1330 var mclassdef
= mreadpropdef
.mclassdef
1331 var mmodule
= mclassdef
.mmodule
1332 var mtype
: nullable MType = null
1335 var ntype
= self.n_type
1336 if ntype
!= null then
1337 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1338 if mtype
== null then return
1341 var inherited_type
: nullable MType = null
1342 # Inherit the type from the getter (usually an abstract getter)
1343 if not mreadpropdef
.is_intro
then
1344 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1345 if msignature
== null then return # Error, thus skipped
1346 inherited_type
= msignature
.return_mtype
1347 if inherited_type
!= null then
1348 # The inherited type is adapted to use the local formal types, if any.
1349 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1350 if mtype
== null then mtype
= inherited_type
1354 var nexpr
= self.n_expr
1355 if mtype
== null then
1356 if nexpr
!= null then
1357 if nexpr
isa ANewExpr then
1358 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1359 else if nexpr
isa AIntegerExpr then
1360 var cla
: nullable MClass = null
1361 if nexpr
.value
isa Int then
1362 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1363 else if nexpr
.value
isa Byte then
1364 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1365 else if nexpr
.value
isa Int8 then
1366 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1367 else if nexpr
.value
isa Int16 then
1368 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1369 else if nexpr
.value
isa UInt16 then
1370 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1371 else if nexpr
.value
isa Int32 then
1372 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1373 else if nexpr
.value
isa UInt32 then
1374 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1376 # Should not happen, and should be updated as new types are added
1379 if cla
!= null then mtype
= cla
.mclass_type
1380 else if nexpr
isa AFloatExpr then
1381 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1382 if cla
!= null then mtype
= cla
.mclass_type
1383 else if nexpr
isa ACharExpr then
1384 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1385 if cla
!= null then mtype
= cla
.mclass_type
1386 else if nexpr
isa ABoolExpr then
1387 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1388 if cla
!= null then mtype
= cla
.mclass_type
1389 else if nexpr
isa ASuperstringExpr then
1390 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1391 if cla
!= null then mtype
= cla
.mclass_type
1392 else if nexpr
isa AStringFormExpr then
1393 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1394 if cla
!= null then mtype
= cla
.mclass_type
1396 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1399 if mtype
== null then return
1401 else if ntype
!= null and inherited_type
== mtype
then
1402 if nexpr
isa ANewExpr then
1403 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1404 if xmtype
== mtype
then
1405 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1410 if mtype
== null then
1411 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1417 if mpropdef
!= null then
1418 mpropdef
.static_mtype
= mtype
1422 var msignature
= new MSignature(new Array[MParameter], mtype
)
1423 mreadpropdef
.msignature
= msignature
1426 var mwritepropdef
= self.mwritepropdef
1427 if mwritepropdef
!= null then
1430 var mparameter
= new MParameter(name
, mtype
, false)
1431 var msignature
= new MSignature([mparameter
], null)
1432 mwritepropdef
.msignature
= msignature
1435 var mlazypropdef
= self.mlazypropdef
1436 if mlazypropdef
!= null then
1437 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1439 check_repeated_types
(modelbuilder
)
1442 redef fun check_signature
(modelbuilder
)
1444 var mpropdef
= self.mpropdef
1445 if mpropdef
== null then return # Error thus skipped
1446 var ntype
= self.n_type
1447 var mtype
= self.mtype
1448 if mtype
== null then return # Error thus skipped
1450 var mclassdef
= mpropdef
.mclassdef
1451 var mmodule
= mclassdef
.mmodule
1454 if ntype
!= null then
1455 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1458 if nexpr
isa ANewExpr then
1459 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1462 # Lookup for signature in the precursor
1463 # FIXME all precursors should be considered
1464 if not mpropdef
.is_intro
then
1465 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1466 if precursor_type
== null then return
1468 if mtype
!= precursor_type
then
1469 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1474 # Check getter and setter
1475 var meth
= self.mreadpropdef
1476 if meth
!= null then
1477 self.check_method_signature
(modelbuilder
, meth
)
1478 var node
: nullable ANode = ntype
1479 if node
== null then node
= self
1480 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1482 meth
= self.mwritepropdef
1483 if meth
!= null then
1484 self.check_method_signature
(modelbuilder
, meth
)
1485 var node
: nullable ANode = ntype
1486 if node
== null then node
= self
1487 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1491 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1493 var mclassdef
= mpropdef
.mclassdef
1494 var mmodule
= mclassdef
.mmodule
1495 var nsig
= self.n_type
1496 var mysignature
= mpropdef
.msignature
1497 if mysignature
== null then return # Error thus skiped
1499 # Lookup for signature in the precursor
1500 # FIXME all precursors should be considered
1501 if not mpropdef
.is_intro
then
1502 var msignature
= mpropdef
.mproperty
.intro
.msignature
1503 if msignature
== null then return
1505 if mysignature
.arity
!= msignature
.arity
then
1507 if nsig
!= null then node
= nsig
else node
= self
1508 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}`.")
1511 var precursor_ret_type
= msignature
.return_mtype
1512 var ret_type
= mysignature
.return_mtype
1513 if ret_type
!= null and precursor_ret_type
== null then
1515 if nsig
!= null then node
= nsig
else node
= self
1516 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1520 if mysignature
.arity
> 0 then
1521 # Check parameters types
1522 for i
in [0..mysignature
.arity
[ do
1523 var myt
= mysignature
.mparameters
[i
].mtype
1524 var prt
= msignature
.mparameters
[i
].mtype
1526 if nsig
!= null then node
= nsig
else node
= self
1527 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1528 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1532 if precursor_ret_type
!= null then
1534 if nsig
!= null then node
= nsig
else node
= self
1535 if ret_type
== null then
1536 # Inherit the return type
1537 ret_type
= precursor_ret_type
1538 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1539 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1545 # Type is useless if the attribute type is the same thant the intro.
1546 redef fun check_repeated_types
(modelbuilder
) do
1547 var mreadpropdef
= self.mreadpropdef
1548 if mreadpropdef
== null then return
1549 if mreadpropdef
.is_intro
or n_type
== null then return
1551 var intro
= mreadpropdef
.mproperty
.intro
1552 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1553 if n_intro
== null then return
1556 if n_intro
isa AMethPropdef then
1557 ntype
= n_intro
.n_signature
.ret_type
1558 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1559 ntype
= n_intro
.n_type
.mtype
1562 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1563 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1567 redef class ATypePropdef
1568 redef type MPROPDEF: MVirtualTypeDef
1570 redef fun build_property
(modelbuilder
, mclassdef
)
1572 var name
= self.n_id
.text
1573 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1574 if mprop
== null then
1575 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1576 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1577 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1578 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1581 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1583 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1584 assert mprop
isa MVirtualTypeProp
1585 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1587 mclassdef
.mprop2npropdef
[mprop
] = self
1589 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1590 self.mpropdef
= mpropdef
1591 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1592 if mpropdef
.is_intro
then
1593 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1595 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1597 set_doc
(mpropdef
, modelbuilder
)
1599 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1600 if atfixed
!= null then
1601 mpropdef
.is_fixed
= true
1605 redef fun build_signature
(modelbuilder
)
1607 var mpropdef
= self.mpropdef
1608 if mpropdef
== null then return # Error thus skipped
1609 var mclassdef
= mpropdef
.mclassdef
1610 var mmodule
= mclassdef
.mmodule
1611 var mtype
: nullable MType = null
1613 var ntype
= self.n_type
1614 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1615 if mtype
== null then return
1617 mpropdef
.bound
= mtype
1618 # print "{mpropdef}: {mtype}"
1621 redef fun check_signature
(modelbuilder
)
1623 var mpropdef
= self.mpropdef
1624 if mpropdef
== null then return # Error thus skipped
1626 var bound
= mpropdef
.bound
1627 if bound
== null then return # Error thus skipped
1629 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1631 var mclassdef
= mpropdef
.mclassdef
1632 var mmodule
= mclassdef
.mmodule
1633 var anchor
= mclassdef
.bound_mtype
1635 var ntype
= self.n_type
1636 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1637 mpropdef
.bound
= null
1641 # Check redefinitions
1642 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1643 var supbound
= p
.bound
1644 if supbound
== null then break # broken super bound, skip error
1646 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1649 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1650 # Still a warning to pass existing bad code
1651 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1654 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1655 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")