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 # Associate a `npropdef` with its `mpropdef`
47 # Be careful, this method is unsafe, no checking is done when it's used.
48 # The safe way to add method it's to use the `build_property`
50 # See `mpropdef2npropdef`
51 fun unsafe_add_mpropdef2npropdef
(mpropdef
: MPropDef,npropdef
: APropdef)
53 mpropdef2npropdef
[mpropdef
] = npropdef
56 # Retrieve the associated AST node of a mpropertydef.
57 # This method is used to associate model entity with syntactic entities.
59 # If the property definition is not associated with a node, returns `null`.
60 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
63 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
65 # Run the phases on it
66 toolcontext
.run_phases_on_npropdef
(res
)
69 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
70 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
71 if res
!= null then return res
76 # Retrieve all the attributes nodes localy definied
77 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
78 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
80 var res
= new Array[AAttrPropdef]
81 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
82 if n
== null then return res
83 for npropdef
in n
.n_propdefs
do
84 if npropdef
isa AAttrPropdef then
85 # Run the phases on it
86 toolcontext
.run_phases_on_npropdef
(npropdef
)
93 # Build the properties of `nclassdef`.
94 private fun build_properties
(nclassdef
: AClassdef)
96 # Force building recursively
97 if nclassdef
.build_properties_is_done
then return
98 nclassdef
.build_properties_is_done
= true
99 var mclassdef
= nclassdef
.mclassdef
100 if mclassdef
== null then return # skip error
101 if mclassdef
.in_hierarchy
== null then return # Skip error
102 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
103 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
104 build_properties
(mclassdef2nclassdef
[superclassdef
])
107 mclassdef
.build_self_type
(self, nclassdef
)
108 for nclassdef2
in nclassdef
.all_defs
do
109 for npropdef
in nclassdef2
.n_propdefs
do
110 npropdef
.build_property
(self, mclassdef
)
112 for npropdef
in nclassdef2
.n_propdefs
do
113 npropdef
.build_signature
(self)
115 for npropdef
in nclassdef2
.n_propdefs
do
116 if not npropdef
isa ATypePropdef then continue
118 var mpropdef
= npropdef
.mpropdef
119 if mpropdef
== null then continue
120 if mpropdef
.bound
== null then continue
121 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
122 # Invalidate the bound
123 mpropdef
.is_broken
= true
124 mpropdef
.bound
= new MErrorType(mclassdef
.mmodule
.model
)
127 for npropdef
in nclassdef2
.n_propdefs
do
128 # Check ATypePropdef first since they may be required for the other properties
129 if not npropdef
isa ATypePropdef then continue
130 npropdef
.check_signature
(self)
133 for npropdef
in nclassdef2
.n_propdefs
do
134 if npropdef
isa ATypePropdef then continue
135 npropdef
.check_signature
(self)
138 process_default_constructors
(nclassdef
)
141 # the root init of the Object class
142 # Is usually implicitly defined
143 # Then explicit or implicit definitions of root-init are attached to it
144 var the_root_init_mmethod
: nullable MMethod
146 # Introduce or inherit default constructor
147 # This is the last part of `build_properties`.
148 private fun process_default_constructors
(nclassdef
: AClassdef)
150 var mclassdef
= nclassdef
.mclassdef
.as(not null)
152 # Are we a refinement
153 if not mclassdef
.is_intro
then return
155 # Look for the init in Object, or create it
156 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
157 # Create the implicit root-init method
158 var mprop
= new MMethod(mclassdef
, "init", nclassdef
.location
, mclassdef
.mclass
.visibility
)
159 mprop
.is_root_init
= true
160 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
161 var mparameters
= new Array[MParameter]
162 var msignature
= new MSignature(mparameters
, null)
163 mpropdef
.msignature
= msignature
164 mpropdef
.new_msignature
= msignature
166 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
167 the_root_init_mmethod
= mprop
171 # Is there already a constructor defined?
172 var defined_init
: nullable MMethodDef = null
173 for mpropdef
in mclassdef
.mpropdefs
do
174 if not mpropdef
isa MMethodDef then continue
175 if not mpropdef
.mproperty
.is_init
then continue
176 if mpropdef
.mproperty
.is_root_init
then
177 assert defined_init
== null
178 defined_init
= mpropdef
179 else if mpropdef
.mproperty
.name
== "init" then
180 # An explicit old-style init named "init", so return
185 if not nclassdef
isa AStdClassdef then return
187 # Collect undefined attributes
188 var mparameters
= new Array[MParameter]
189 var initializers
= new Array[MProperty]
190 for npropdef
in nclassdef
.n_propdefs
do
191 if npropdef
isa AMethPropdef then
192 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
193 var mpropdef
= npropdef
.mpropdef
194 if mpropdef
== null then return # Skip broken method
195 var sig
= mpropdef
.msignature
196 if sig
== null then continue # Skip broken method
198 mparameters
.add_all sig
.mparameters
199 initializers
.add
(mpropdef
.mproperty
)
200 mpropdef
.mproperty
.is_autoinit
= true
202 if npropdef
isa AAttrPropdef then
203 var mreadpropdef
= npropdef
.mreadpropdef
204 if mreadpropdef
== null then return # Skip broken attribute
205 var msignature
= mreadpropdef
.msignature
206 if msignature
== null then return # Skip broken attribute
207 if npropdef
.noinit
then continue # Skip noinit attribute
208 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
209 if atlateinit
!= null then
210 # For lateinit attributes, call the reader to force
211 # the lazy initialization of the attribute.
212 initializers
.add
(mreadpropdef
.mproperty
)
213 mreadpropdef
.mproperty
.is_autoinit
= true
216 if npropdef
.has_value
and not npropdef
.is_optional
then continue
217 var msetter
= npropdef
.mwritepropdef
218 if msetter
== null then
219 # No setter, it is a readonly attribute, so just add it
220 var paramname
= mreadpropdef
.mproperty
.name
221 var ret_type
= msignature
.return_mtype
222 if ret_type
== null then return
223 var mparameter
= new MParameter(paramname
, ret_type
, false)
224 mparameters
.add
(mparameter
)
226 initializers
.add
(npropdef
.mpropdef
.mproperty
)
227 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
229 # Add the setter to the list
230 mparameters
.add_all msetter
.msignature
.mparameters
231 initializers
.add
(msetter
.mproperty
)
232 msetter
.mproperty
.is_autoinit
= true
237 var the_root_init_mmethod
= self.the_root_init_mmethod
238 if the_root_init_mmethod
== null then return
240 # Look for most-specific new-stype init definitions
241 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
242 if spropdefs
.is_empty
then
243 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
247 # Look at the autoinit class-annotation
248 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
249 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
250 if autoinit
!= null then
251 # Just throws the collected initializers
255 if noautoinit
!= null then
256 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
259 if autoinit
.n_args
.is_empty
then
260 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
263 # Get and check each argument
264 for narg
in autoinit
.n_args
do
267 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
271 # Search the property.
272 # To avoid bad surprises, try to get the setter first.
273 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
275 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
278 error
(narg
, "Error: unknown method `{id}`")
281 if not p
.is_autoinit
then
282 error
(narg
, "Error: `{p}` is not an autoinit method")
286 # Register the initializer and the parameters
289 if pd
isa MMethodDef then
290 # Get the signature resolved for the current receiver
291 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
292 mparameters
.add_all
(sig
.mparameters
)
299 # Search the longest-one and checks for conflict
300 var longest
= spropdefs
.first
301 if spropdefs
.length
> 1 then
302 # part 1. find the longest list
303 for spd
in spropdefs
do
304 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
307 # Check for conflict in the order of initializers
308 # Each initializer list must me a prefix of the longest list
309 # If `noautoinit` is set, just ignore conflicts
310 if noautoinit
== null then for spd
in spropdefs
do
312 for p
in spd
.initializers
do
313 if p
!= longest
.initializers
[i
] then
314 var proposal
= new ArraySet[MProperty]
315 for spd2
in spropdefs
do
316 proposal
.add_all spd2
.initializers
318 proposal
.add_all initializers
319 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(", ")}`")
320 # TODO: invalidate the initializer to avoid more errors
328 if noautoinit
!= null then
329 # If there is local or inherited initializers, then complain.
330 if initializers
.is_empty
and longest
.initializers
.is_empty
then
331 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
333 # Just clear initializers
337 # Can we just inherit?
338 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
339 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
340 mclassdef
.mclass
.root_init
= longest
344 # Combine the inherited list to what is collected
345 if longest
.initializers
.length
> 0 then
346 mparameters
.prepend longest
.new_msignature
.mparameters
347 initializers
.prepend longest
.initializers
352 # If we already have a basic init definition, then setup its initializers
353 if defined_init
!= null then
354 defined_init
.initializers
.add_all
(initializers
)
355 var msignature
= new MSignature(mparameters
, null)
356 defined_init
.new_msignature
= msignature
357 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
358 mclassdef
.mclass
.root_init
= defined_init
362 # Else create the local implicit basic init definition
363 var mprop
= the_root_init_mmethod
364 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
365 mpropdef
.has_supercall
= true
366 mpropdef
.initializers
.add_all
(initializers
)
367 var msignature
= new MSignature(mparameters
, null)
368 mpropdef
.new_msignature
= msignature
369 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
370 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
371 mclassdef
.mclass
.root_init
= mpropdef
374 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
375 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
377 var mmodule
= mpropdef
.mclassdef
.mmodule
378 var mproperty
= mpropdef
.mproperty
380 # Extract visibility information of the main part of `mtype`
381 # It is a case-by case
382 var vis_type
: nullable MVisibility = null # The own visibility of the type
383 var mmodule_type
: nullable MModule = null # The original module of the type
384 mtype
= mtype
.undecorate
385 if mtype
isa MClassType then
386 vis_type
= mtype
.mclass
.visibility
387 mmodule_type
= mtype
.mclass
.intro_mmodule
388 else if mtype
isa MVirtualType then
389 vis_type
= mtype
.mproperty
.visibility
390 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
391 else if mtype
isa MParameterType then
392 # nothing, always visible
393 else if mtype
isa MNullType then
395 else if mtype
isa MBottomType then
397 else if mtype
isa MErrorType then
400 node
.debug
"Unexpected type {mtype}"
404 if vis_type
!= null then
405 assert mmodule_type
!= null
406 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
407 if mproperty
.visibility
> vis_type
then
408 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
410 else if mproperty
.visibility
> vis_module_type
then
411 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
416 # No error, try to go deeper in generic types
417 if node
isa AType then
418 for a
in node
.n_types
do
420 if t
== null then continue # Error, thus skipped
421 check_visibility
(a
, t
, mpropdef
)
423 else if mtype
isa MGenericType then
424 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
428 # Detect circularity errors for virtual types.
429 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
432 # Slow case: progress on each resolution until we visit all without getting a loop
434 # The graph used to detect loops
435 var mtype
= mproperty
.mvirtualtype
436 var poset
= new POSet[MType]
438 # The work-list of types to resolve
439 var todo
= new List[MType]
442 while not todo
.is_empty
do
446 if not t
.need_anchor
then continue
448 # Get the types derived of `t` (subtypes and bounds)
450 if t
isa MNullableType then
452 else if t
isa MGenericType then
454 else if t
isa MVirtualType then
456 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
457 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
458 if defs
.is_empty
then return false
459 nexts
= new Array[MType]
461 var next
= defs
.first
.bound
462 if next
== null then return false
465 else if t
isa MClassType then
466 # Basic type, nothing to to
468 else if t
isa MParameterType then
469 # Parameter types cannot depend on virtual types, so nothing to do
477 if poset
.has_edge
(next
, t
) then
478 if mtype
== next
then
479 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
481 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
485 poset
.add_edge
(t
, next
)
495 # Does the MPropDef contains a call to super or a call of a super-constructor?
496 # Subsequent phases of the frontend (esp. typing) set it if required
497 var has_supercall
: Bool = false is writable
500 redef class AClassdef
501 # Marker used in `ModelBuilder::build_properties`
502 private var build_properties_is_done
= false
506 # The base init of the class.
507 # Used to get the common new_msignature and initializers
509 # TODO: Where to put this information is not clear because unlike other
510 # informations, the initialisers are stable in a same class.
511 var root_init
: nullable MMethodDef = null
514 redef class MClassDef
515 # What is the `APropdef` associated to a `MProperty`?
516 # Used to check multiple definition of a property.
517 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
519 # Build the virtual type `SELF` only for introduction `MClassDef`
520 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
522 if not is_intro
then return
525 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
527 # If SELF type is declared nowherer?
528 if mprop
== null then return
530 # SELF is not a virtual type? it is weird but we ignore it
531 if not mprop
isa MVirtualTypeProp then return
533 # Is this the intro of SELF in the library?
534 var intro
= mprop
.intro
535 var intro_mclassdef
= intro
.mclassdef
536 if intro_mclassdef
== self then
537 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
539 # SELF must be declared in Object, otherwise this will create conflicts
540 if intro_mclassdef
.mclass
.name
!= "Object" then
541 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
544 # SELF must be public
545 if mprop
.visibility
!= public_visibility
then
546 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
549 # SELF must not be fixed
550 if intro
.is_fixed
then
551 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
557 # This class introduction inherits a SELF
558 # We insert an artificial property to update it
559 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
560 mpropdef
.bound
= mclass
.mclass_type
565 # The associated main model entity
566 type MPROPDEF: MPropDef
568 # The associated propdef once build by a `ModelBuilder`
569 var mpropdef
: nullable MPROPDEF is writable
571 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
572 private fun build_signature
(modelbuilder
: ModelBuilder) do end
573 private fun check_signature
(modelbuilder
: ModelBuilder) do end
574 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
576 var mvisibility
= public_visibility
577 if nvisibility
!= null then
578 mvisibility
= nvisibility
.mvisibility
579 if mvisibility
== intrude_visibility
then
580 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
581 mvisibility
= public_visibility
584 if mclassdef
.mclass
.visibility
== private_visibility
then
585 if mvisibility
== protected_visibility
then
586 assert nvisibility
!= null
587 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
588 else if mvisibility
== private_visibility
then
589 assert nvisibility
!= null
590 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
592 mvisibility
= private_visibility
597 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
599 var ndoc
= self.n_doc
601 var mdoc
= ndoc
.to_mdoc
603 mdoc
.original_mentity
= mpropdef
604 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
and mpropdef
.name
!= "new" then
605 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
608 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
609 if at_deprecated
!= null then
610 if not mpropdef
.is_intro
then
611 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
613 var info
= new MDeprecationInfo
614 ndoc
= at_deprecated
.n_doc
615 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
616 mpropdef
.mproperty
.deprecation
= info
621 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
623 if nvisibility
== null then return
624 var mvisibility
= nvisibility
.mvisibility
625 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
626 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
630 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
632 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
633 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
636 if mprop
isa MMethod and mprop
.is_root_init
then return true
637 if kwredef
== null then
639 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
643 # Check for full-name conflicts in the package.
644 # A public property should have a unique qualified name `package::class::prop`.
645 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
646 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
647 if others
!= null then for other
in others
do
648 if other
!= mprop
and other
.intro_mclassdef
.mmodule
.mgroup
!= null and other
.intro_mclassdef
.mmodule
.mgroup
.mpackage
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mpackage
and other
.intro_mclassdef
.mclass
.name
== mprop
.intro_mclassdef
.mclass
.name
and other
.visibility
>= protected_visibility
then
649 modelbuilder
.advice
(self, "full-name-conflict", "Warning: A property named `{other.full_name}` is already defined in module `{other.intro_mclassdef.mmodule}` for the class `{other.intro_mclassdef.mclass.name}`.")
655 if not need_redef
then
656 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
663 # Checks for useless type in redef signatures.
664 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
667 redef class ASignature
668 # Is the model builder has correctly visited the signature
669 var is_visited
= false
670 # Names of parameters from the AST
671 # REQUIRE: is_visited
672 var param_names
= new Array[String]
673 # Types of parameters from the AST
674 # REQUIRE: is_visited
675 var param_types
= new Array[MType]
676 # Rank of the vararg (of -1 if none)
677 # REQUIRE: is_visited
678 var vararg_rank
: Int = -1
680 var ret_type
: nullable MType = null
682 # Visit and fill information about a signature
683 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
685 var param_names
= self.param_names
686 var param_types
= self.param_types
687 for np
in self.n_params
do
688 param_names
.add
(np
.n_id
.text
)
689 var ntype
= np
.n_type
690 if ntype
!= null then
691 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
692 if mtype
== null then return false # Skip error
693 for i
in [0..param_names
.length-param_types
.length
[ do
694 param_types
.add
(mtype
)
696 if np
.n_dotdotdot
!= null then
697 if self.vararg_rank
!= -1 then
698 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
701 self.vararg_rank
= param_names
.length
- 1
706 var ntype
= self.n_type
707 if ntype
!= null then
708 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
709 if self.ret_type
== null then return false # Skip error
712 self.is_visited
= true
716 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
719 for np
in self.n_params
do
720 var ntype
= np
.n_type
721 if ntype
!= null then
722 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
727 var ntype
= self.n_type
728 if ntype
!= null then
729 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
733 if not res
then is_broken
= true
739 # The associated mparameter if any
740 var mparameter
: nullable MParameter = null
743 redef class AMethPropdef
744 redef type MPROPDEF: MMethodDef
746 # Is the method annotated `autoinit`?
747 var is_autoinit
= false
749 # Can self be used as a root init?
750 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
752 # Need the `init` keyword
753 if n_kwinit
== null then return false
754 # Need to by anonymous
755 if self.n_methid
!= null then return false
756 # No annotation on itself
757 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
759 var amod
= self.parent
.parent
.as(AModule)
760 var amoddecl
= amod
.n_moduledecl
761 if amoddecl
!= null then
762 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
763 if old
!= null then return false
766 if self.n_signature
.n_params
.length
> 0 then
767 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
770 # Cannot be private or something
771 if not self.n_visibility
isa APublicVisibility then
772 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
779 redef fun build_property
(modelbuilder
, mclassdef
)
781 var n_kwinit
= n_kwinit
782 var n_kwnew
= n_kwnew
783 var is_new
= n_kwnew
!= null
784 var is_init
= n_kwinit
!= null or is_new
786 var amethodid
= self.n_methid
788 if amethodid
== null then
789 if n_kwinit
!= null then
792 else if n_kwnew
!= null then
799 else if amethodid
isa AIdMethid then
800 name
= amethodid
.n_id
.text
801 name_node
= amethodid
803 # operator, bracket or assign
804 name
= amethodid
.collect_text
805 name_node
= amethodid
807 var arity
= self.n_signature
.n_params
.length
808 if name
== "+" and arity
== 0 then
810 else if name
== "-" and arity
== 0 then
812 else if name
== "~" and arity
== 0 then
815 if amethodid
.is_binary
and arity
!= 1 then
816 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
817 else if amethodid
.min_arity
> arity
then
818 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
823 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
824 var mprop
: nullable MMethod = null
825 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
826 if mprop
== null and look_like_a_root_init
then
827 mprop
= modelbuilder
.the_root_init_mmethod
829 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
830 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
833 if mprop
== null then
834 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
835 mprop
= new MMethod(mclassdef
, name
, self.location
, mvisibility
)
836 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
837 modelbuilder
.the_root_init_mmethod
= mprop
838 mprop
.is_root_init
= true
840 mprop
.is_init
= is_init
841 mprop
.is_new
= is_new
842 if is_new
then mclassdef
.mclass
.has_new_factory
= true
843 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
844 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
845 mprop
.is_broken
= true
849 if mprop
.is_broken
then return
850 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
851 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
854 # Check name conflicts in the local class for constructors.
856 for p
, n
in mclassdef
.mprop2npropdef
do
857 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
858 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
859 mprop
.is_broken
= true
867 mclassdef
.mprop2npropdef
[mprop
] = self
869 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
871 set_doc
(mpropdef
, modelbuilder
)
873 self.mpropdef
= mpropdef
874 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
875 if mpropdef
.is_intro
then
876 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
878 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
882 redef fun build_signature
(modelbuilder
)
884 var mpropdef
= self.mpropdef
885 if mpropdef
== null then return # Error thus skiped
886 var mproperty
= mpropdef
.mproperty
887 var mclassdef
= mpropdef
.mclassdef
888 var mmodule
= mclassdef
.mmodule
889 var nsig
= self.n_signature
891 if mproperty
.is_root_init
and not mclassdef
.is_intro
then
892 var root_init
= mclassdef
.mclass
.root_init
893 if root_init
!= null then
894 # Inherit the initializers by refinement
895 mpropdef
.new_msignature
= root_init
.new_msignature
896 assert mpropdef
.initializers
.is_empty
897 mpropdef
.initializers
.add_all root_init
.initializers
901 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
902 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
904 # Retrieve info from the signature AST
905 var param_names
= new Array[String] # Names of parameters from the AST
906 var param_types
= new Array[MType] # Types of parameters from the AST
908 var ret_type
: nullable MType = null # Return type from the AST
910 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
911 param_names
= nsig
.param_names
912 param_types
= nsig
.param_types
913 vararg_rank
= nsig
.vararg_rank
914 ret_type
= nsig
.ret_type
917 # Look for some signature to inherit
918 # FIXME: do not inherit from the intro, but from the most specific
919 var msignature
: nullable MSignature = null
920 if not mpropdef
.is_intro
then
921 msignature
= mproperty
.intro
.msignature
922 if msignature
== null then return # Skip error
924 # The local signature is adapted to use the local formal types, if any.
925 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
927 # Check inherited signature arity
928 if param_names
.length
!= msignature
.arity
then
930 if nsig
!= null then node
= nsig
else node
= self
931 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mproperty.name}{msignature}`; got {param_names.length}. See introduction at `{mproperty.full_name}`.")
934 else if mproperty
.is_init
and not mproperty
.is_new
then
935 # FIXME UGLY: inherit signature from a super-constructor
936 for msupertype
in mclassdef
.supertypes
do
937 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
938 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mproperty
.name
)
939 if candidate
!= null then
940 if msignature
== null then
941 msignature
= candidate
.intro
.as(MMethodDef).msignature
948 # Inherit the signature
949 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
950 # Parameters are untyped, thus inherit them
951 param_types
= new Array[MType]
952 for mparameter
in msignature
.mparameters
do
953 param_types
.add
(mparameter
.mtype
)
955 vararg_rank
= msignature
.vararg_rank
957 if msignature
!= null and ret_type
== null then
958 ret_type
= msignature
.return_mtype
961 if param_names
.length
!= param_types
.length
then
962 # Some parameters are typed, other parameters are not typed.
963 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
967 var mparameters
= new Array[MParameter]
968 for i
in [0..param_names
.length
[ do
969 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
970 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
971 mparameters
.add
(mparameter
)
974 # In `new`-factories, the return type is by default the classtype.
975 if ret_type
== null and mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
977 # Special checks for operator methods
978 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
979 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mproperty.name}`.")
981 if ret_type
== null and return_is_mandatory
then
982 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mproperty.name}`.")
985 msignature
= new MSignature(mparameters
, ret_type
)
986 mpropdef
.msignature
= msignature
987 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
988 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
989 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
992 var at
= self.get_single_annotation
("lazy", modelbuilder
)
993 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
995 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
996 if atautoinit
!= null then
997 if not mpropdef
.is_intro
then
998 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
999 else if not mclassdef
.is_intro
then
1000 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1002 self.is_autoinit
= true
1007 redef fun check_signature
(modelbuilder
)
1009 var mpropdef
= self.mpropdef
1010 if mpropdef
== null then return # Error thus skiped
1011 var mclassdef
= mpropdef
.mclassdef
1012 var mmodule
= mclassdef
.mmodule
1013 var nsig
= self.n_signature
1014 var mysignature
= mpropdef
.msignature
1015 if mysignature
== null then return # Error thus skiped
1018 if nsig
!= null then
1019 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1020 mpropdef
.msignature
= null # invalidate
1021 mpropdef
.is_broken
= true
1022 return # Forward error
1026 # Lookup for signature in the precursor
1027 # FIXME all precursors should be considered
1028 if not mpropdef
.is_intro
then
1029 var msignature
= mpropdef
.mproperty
.intro
.msignature
1030 if msignature
== null then return
1032 var precursor_ret_type
= msignature
.return_mtype
1033 var ret_type
= mysignature
.return_mtype
1034 if ret_type
!= null and precursor_ret_type
== null then
1035 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1036 mpropdef
.msignature
= null
1037 mpropdef
.is_broken
= true
1041 if mysignature
.arity
> 0 then
1042 # Check parameters types
1043 for i
in [0..mysignature
.arity
[ do
1044 var myt
= mysignature
.mparameters
[i
].mtype
1045 var prt
= msignature
.mparameters
[i
].mtype
1046 var node
= nsig
.n_params
[i
]
1047 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1048 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1049 mpropdef
.msignature
= null
1050 mpropdef
.is_broken
= true
1054 if precursor_ret_type
!= null then
1055 var node
: nullable ANode = null
1056 if nsig
!= null then node
= nsig
.n_type
1057 if node
== null then node
= self
1058 if ret_type
== null then
1059 # Inherit the return type
1060 ret_type
= precursor_ret_type
1061 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1062 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1063 mpropdef
.msignature
= null
1064 mpropdef
.is_broken
= true
1069 if nsig
!= null then
1070 # Check parameters visibility
1071 for i
in [0..mysignature
.arity
[ do
1072 var nt
= nsig
.n_params
[i
].n_type
1073 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1075 var nt
= nsig
.n_type
1076 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1078 check_repeated_types
(modelbuilder
)
1081 # For parameters, type is always useless in a redef.
1082 # For return type, type is useless if not covariant with introduction.
1083 redef fun check_repeated_types
(modelbuilder
) do
1084 var mpropdef
= self.mpropdef
1085 if mpropdef
== null then return
1086 if mpropdef
.is_intro
or n_signature
== null then return
1088 for param
in n_signature
.n_params
do
1089 if param
.n_type
!= null then
1090 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1094 var intro
= mpropdef
.mproperty
.intro
1095 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1096 if n_intro
== null or not n_intro
isa AMethPropdef then return
1098 var ret_type
= n_signature
.ret_type
1099 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1100 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1106 # Is a return required?
1108 # * True for operators and brackets.
1109 # * False for id and assignment.
1110 fun return_is_mandatory
: Bool do return true
1112 # Can the last parameter be special like a vararg?
1114 # * False for operators: the last one is in fact the only one.
1115 # * False for assignments: it is the right part of the assignment.
1116 # * True for ids and brackets.
1117 fun accept_special_last_parameter
: Bool do return false
1119 # The minimum required number of parameters.
1121 # * 1 for binary operators
1123 # * 1 for assignments
1124 # * 2 for bracket assignments
1126 fun min_arity
: Int do return 1
1128 # Is the `self` a binary operator?
1129 fun is_binary
: Bool do return true
1132 redef class AIdMethid
1133 redef fun return_is_mandatory
do return false
1134 redef fun accept_special_last_parameter
do return true
1135 redef fun min_arity
do return 0
1136 redef fun is_binary
do return false
1139 redef class ABraMethid
1140 redef fun accept_special_last_parameter
do return true
1141 redef fun is_binary
do return false
1144 redef class ABraassignMethid
1145 redef fun return_is_mandatory
do return false
1146 redef fun min_arity
do return 2
1147 redef fun is_binary
do return false
1150 redef class AAssignMethid
1151 redef fun return_is_mandatory
do return false
1152 redef fun is_binary
do return false
1155 redef class AAttrPropdef
1156 redef type MPROPDEF: MAttributeDef
1158 # The static type of the property (declared, inferred or inherited)
1159 # This attribute is also used to check if the property was analyzed and is valid.
1160 var mtype
: nullable MType
1162 # Is the node tagged `noinit`?
1165 # Is the node tagged lazy?
1168 # Is the node tagged optional?
1169 var is_optional
= false
1171 # Does the node have a default value?
1172 # Could be through `n_expr`, `n_block` or `is_lazy`
1173 var has_value
= false
1175 # The guard associated to a lazy attribute.
1176 # Because some engines does not have a working `isset`,
1177 # this additional attribute is used to guard the lazy initialization.
1178 # TODO: to remove once isset is correctly implemented
1179 var mlazypropdef
: nullable MAttributeDef
1181 # The associated getter (read accessor) if any
1182 var mreadpropdef
: nullable MMethodDef is writable
1183 # The associated setter (write accessor) if any
1184 var mwritepropdef
: nullable MMethodDef is writable
1186 redef fun build_property
(modelbuilder
, mclassdef
)
1188 var mclass
= mclassdef
.mclass
1190 var name
= nid2
.text
1192 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1193 if atabstract
== null then
1194 if not mclass
.kind
.need_init
then
1195 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1198 var mprop
= new MAttribute(mclassdef
, "_" + name
, self.location
, private_visibility
)
1199 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1200 self.mpropdef
= mpropdef
1201 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1205 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1206 if mreadprop
== null then
1207 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1208 mreadprop
= new MMethod(mclassdef
, readname
, self.location
, mvisibility
)
1209 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then
1210 mreadprop
.is_broken
= true
1214 if mreadprop
.is_broken
then return
1215 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1216 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1218 mclassdef
.mprop2npropdef
[mreadprop
] = self
1220 var attr_mpropdef
= mpropdef
1221 if attr_mpropdef
!= null then
1222 mreadprop
.getter_for
= attr_mpropdef
.mproperty
1223 attr_mpropdef
.mproperty
.getter
= mreadprop
1226 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1227 self.mreadpropdef
= mreadpropdef
1228 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1229 set_doc
(mreadpropdef
, modelbuilder
)
1230 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1231 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1233 has_value
= n_expr
!= null or n_block
!= null
1235 if atabstract
!= null and has_value
then
1236 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1240 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1241 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1242 if atnoinit
!= null then
1245 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1248 if atabstract
!= null then
1249 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1253 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1254 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1255 if atlazy
!= null or atlateinit
!= null then
1256 if atlazy
!= null and atlateinit
!= null then
1257 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1260 if not has_value
then
1261 if atlazy
!= null then
1262 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1263 else if atlateinit
!= null then
1264 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1270 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, self.location
, none_visibility
)
1271 mlazyprop
.is_fictive
= true
1272 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1273 mlazypropdef
.is_fictive
= true
1274 self.mlazypropdef
= mlazypropdef
1277 var atoptional
= self.get_single_annotation
("optional", modelbuilder
)
1278 if atoptional
!= null then
1279 if not has_value
then
1280 modelbuilder
.error
(atoptional
, "Error: `optional` attributes need a default value.")
1285 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1286 if atreadonly
!= null then
1287 if not has_value
then
1288 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1290 # No setter, so just leave
1294 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1295 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1298 var writename
= name
+ "="
1299 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1300 if atwritable
!= null then
1301 if not atwritable
.n_args
.is_empty
then
1302 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1305 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1306 var nwkwredef
: nullable Token = null
1307 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1308 if mwriteprop
== null then
1310 if atwritable
!= null then
1311 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1313 mvisibility
= mreadprop
.visibility
1314 # By default, use protected visibility at most
1315 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1317 mwriteprop
= new MMethod(mclassdef
, writename
, self.location
, mvisibility
)
1318 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then
1319 mwriteprop
.is_broken
= true
1322 mwriteprop
.deprecation
= mreadprop
.deprecation
1324 if mwriteprop
.is_broken
then return
1325 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1326 if atwritable
!= null then
1327 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1330 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1332 if attr_mpropdef
!= null then
1333 mwriteprop
.setter_for
= attr_mpropdef
.mproperty
1334 attr_mpropdef
.mproperty
.setter
= mwriteprop
1337 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1338 self.mwritepropdef
= mwritepropdef
1339 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1340 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1341 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1343 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1344 if atautoinit
!= null then
1346 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1347 else if not mwritepropdef
.is_intro
then
1348 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1349 else if not mclassdef
.is_intro
then
1350 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1351 else if atabstract
== null then
1352 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1354 else if atabstract
!= null then
1355 # By default, abstract attribute are not autoinit
1360 redef fun build_signature
(modelbuilder
)
1362 var mreadpropdef
= self.mreadpropdef
1363 var mpropdef
= self.mpropdef
1364 if mreadpropdef
== null then return # Error thus skipped
1365 var mclassdef
= mreadpropdef
.mclassdef
1366 var mmodule
= mclassdef
.mmodule
1367 var mtype
: nullable MType = null
1370 var ntype
= self.n_type
1371 if ntype
!= null then
1372 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1373 if mtype
== null then return
1376 var inherited_type
: nullable MType = null
1377 # Inherit the type from the getter (usually an abstract getter)
1378 if not mreadpropdef
.is_intro
then
1379 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1380 if msignature
== null then return # Error, thus skipped
1381 inherited_type
= msignature
.return_mtype
1382 if inherited_type
!= null then
1383 # The inherited type is adapted to use the local formal types, if any.
1384 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1385 if mtype
== null then mtype
= inherited_type
1389 var nexpr
= self.n_expr
1390 if mtype
== null then
1391 if nexpr
!= null then
1392 mtype
= infer_static_type
(modelbuilder
, nexpr
, mclassdef
, mmodule
, mreadpropdef
)
1393 if mtype
== null then return
1395 else if ntype
!= null and inherited_type
== mtype
then
1396 if nexpr
isa ANewExpr then
1397 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1398 if xmtype
== mtype
then
1399 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1404 if mtype
== null then
1405 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1411 if mpropdef
!= null then
1412 mpropdef
.static_mtype
= mtype
1416 var msignature
= new MSignature(new Array[MParameter], mtype
)
1417 mreadpropdef
.msignature
= msignature
1420 var mwritepropdef
= self.mwritepropdef
1421 if mwritepropdef
!= null then
1422 var mwritetype
= mtype
1424 mwritetype
= mwritetype
.as_nullable
1428 var mparameter
= new MParameter(name
, mwritetype
, false)
1429 var msignature
= new MSignature([mparameter
], null)
1430 mwritepropdef
.msignature
= msignature
1433 var mlazypropdef
= self.mlazypropdef
1434 if mlazypropdef
!= null then
1435 mlazypropdef
.static_mtype
= mmodule
.bool_type
1437 check_repeated_types
(modelbuilder
)
1440 # Detect the static type from the value assigned to the attribute `self`
1442 # Return the static type if it can be safely inferred.
1443 private fun infer_static_type
(modelbuilder
: ModelBuilder, nexpr
: AExpr,
1444 mclassdef
: MClassDef, mmodule
: MModule, mreadpropdef
: MPropDef): nullable MType
1447 if nexpr
isa ANewExpr then
1448 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1449 else if nexpr
isa AAsCastExpr then
1450 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1451 else if nexpr
isa AIntegerExpr then
1452 var cla
: nullable MClass = null
1453 if nexpr
.value
isa Int then
1454 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1455 else if nexpr
.value
isa Byte then
1456 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1457 else if nexpr
.value
isa Int8 then
1458 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1459 else if nexpr
.value
isa Int16 then
1460 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1461 else if nexpr
.value
isa UInt16 then
1462 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1463 else if nexpr
.value
isa Int32 then
1464 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1465 else if nexpr
.value
isa UInt32 then
1466 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1468 # Should not happen, and should be updated as new types are added
1471 if cla
!= null then mtype
= cla
.mclass_type
1472 else if nexpr
isa AFloatExpr then
1473 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1474 if cla
!= null then mtype
= cla
.mclass_type
1475 else if nexpr
isa ACharExpr then
1476 var cla
: nullable MClass
1477 if nexpr
.is_code_point
then
1478 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1480 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1482 if cla
!= null then mtype
= cla
.mclass_type
1483 else if nexpr
isa ABoolExpr then
1484 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1485 if cla
!= null then mtype
= cla
.mclass_type
1486 else if nexpr
isa ASuperstringExpr then
1487 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1488 if cla
!= null then mtype
= cla
.mclass_type
1489 else if nexpr
isa AStringFormExpr then
1490 var cla
: nullable MClass
1491 if nexpr
.is_bytestring
then
1492 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bytes")
1493 else if nexpr
.is_re
then
1494 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Regex")
1495 else if nexpr
.is_string
then
1496 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1500 if cla
!= null then mtype
= cla
.mclass_type
1501 else if nexpr
isa AArrayExpr and nexpr
.n_type
== null and nexpr
.n_exprs
.not_empty
then
1502 # Non-empty arrays without an explicit type
1504 var item_mtypes
= new Set[MType]
1506 for node
in nexpr
.n_exprs
do
1507 var item_mtype
= infer_static_type
(modelbuilder
, node
, mclassdef
, mmodule
, mreadpropdef
)
1508 if item_mtype
== null then
1511 item_mtypes
.add item_mtype
1515 if fails
then return null # Failed to infer some types
1517 if item_mtypes
.length
> 1 then
1518 modelbuilder
.error
(self, "Type Error: ambiguous array type {item_mtypes.join(" ")}")
1521 mtype
= mmodule
.array_type
(item_mtypes
.first
)
1522 else if nexpr
isa AUminusExpr and (nexpr
.n_expr
isa AIntegerExpr or nexpr
.n_expr
isa AFloatExpr) then
1523 # The Int and Float unary - is defined in `kernel`, so this may
1524 # result in an invalid behavior when using a custom kernel.
1525 # A workaround is to declare the attribute static type.
1526 # This is still very useful, especially to novice programmers.
1527 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1528 else if nexpr
isa AOnceExpr then
1529 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1531 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1536 redef fun check_signature
(modelbuilder
)
1538 var mpropdef
= self.mpropdef
1539 if mpropdef
== null then return # Error thus skipped
1540 var ntype
= self.n_type
1541 var mtype
= self.mtype
1542 if mtype
== null then return # Error thus skipped
1544 var mclassdef
= mpropdef
.mclassdef
1545 var mmodule
= mclassdef
.mmodule
1548 if ntype
!= null then
1549 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then return
1552 if nexpr
isa ANewExpr then
1553 if modelbuilder
.resolve_mtype
(mclassdef
, nexpr
.n_type
) == null then return
1556 # Lookup for signature in the precursor
1557 # FIXME all precursors should be considered
1558 if not mpropdef
.is_intro
then
1559 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1560 if precursor_type
== null then return
1562 if mtype
!= precursor_type
then
1563 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1568 # Check getter and setter
1569 var meth
= self.mreadpropdef
1570 if meth
!= null then
1571 self.check_method_signature
(modelbuilder
, meth
)
1572 var node
: nullable ANode = ntype
1573 if node
== null then node
= self
1574 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1576 meth
= self.mwritepropdef
1577 if meth
!= null then
1578 self.check_method_signature
(modelbuilder
, meth
)
1579 var node
: nullable ANode = ntype
1580 if node
== null then node
= self
1581 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1585 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1587 var mclassdef
= mpropdef
.mclassdef
1588 var mmodule
= mclassdef
.mmodule
1589 var nsig
= self.n_type
1590 var mysignature
= mpropdef
.msignature
1591 if mysignature
== null then return # Error thus skiped
1593 # Lookup for signature in the precursor
1594 # FIXME all precursors should be considered
1595 if not mpropdef
.is_intro
then
1596 var msignature
= mpropdef
.mproperty
.intro
.msignature
1597 if msignature
== null then return
1599 if mysignature
.arity
!= msignature
.arity
then
1601 if nsig
!= null then node
= nsig
else node
= self
1602 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}`.")
1605 var precursor_ret_type
= msignature
.return_mtype
1606 var ret_type
= mysignature
.return_mtype
1607 if ret_type
!= null and precursor_ret_type
== null then
1609 if nsig
!= null then node
= nsig
else node
= self
1610 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1614 if mysignature
.arity
> 0 then
1615 # Check parameters types
1616 for i
in [0..mysignature
.arity
[ do
1617 var myt
= mysignature
.mparameters
[i
].mtype
1618 var prt
= msignature
.mparameters
[i
].mtype
1620 if nsig
!= null then node
= nsig
else node
= self
1621 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1622 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1626 if precursor_ret_type
!= null then
1628 if nsig
!= null then node
= nsig
else node
= self
1629 if ret_type
== null then
1630 # Inherit the return type
1631 ret_type
= precursor_ret_type
1632 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1633 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1639 # Type is useless if the attribute type is the same thant the intro.
1640 redef fun check_repeated_types
(modelbuilder
) do
1641 var mreadpropdef
= self.mreadpropdef
1642 if mreadpropdef
== null then return
1643 if mreadpropdef
.is_intro
or n_type
== null then return
1645 var intro
= mreadpropdef
.mproperty
.intro
1646 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1647 if n_intro
== null then return
1650 if n_intro
isa AMethPropdef then
1651 ntype
= n_intro
.n_signature
.ret_type
1652 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1653 ntype
= n_intro
.n_type
.mtype
1656 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1657 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1661 redef class ATypePropdef
1662 redef type MPROPDEF: MVirtualTypeDef
1664 redef fun build_property
(modelbuilder
, mclassdef
)
1666 var name
= self.n_qid
.n_id
.text
1667 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1668 if mprop
== null then
1669 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1670 mprop
= new MVirtualTypeProp(mclassdef
, name
, self.location
, mvisibility
)
1671 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1672 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1676 if mprop
.is_broken
then return
1677 assert mprop
isa MVirtualTypeProp
1678 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1681 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1682 self.mpropdef
= mpropdef
1683 if mpropdef
.is_intro
then
1684 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1686 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1688 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1689 mpropdef
.is_broken
=true
1691 mclassdef
.mprop2npropdef
[mprop
] = self
1692 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1693 set_doc
(mpropdef
, modelbuilder
)
1695 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1696 if atfixed
!= null then
1697 mpropdef
.is_fixed
= true
1701 redef fun build_signature
(modelbuilder
)
1703 var mpropdef
= self.mpropdef
1704 if mpropdef
== null then return # Error thus skipped
1705 var mclassdef
= mpropdef
.mclassdef
1706 var mtype
: nullable MType = null
1708 var ntype
= self.n_type
1709 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1710 if mtype
== null then return
1712 mpropdef
.bound
= mtype
1713 # print "{mpropdef}: {mtype}"
1716 redef fun check_signature
(modelbuilder
)
1718 var mpropdef
= self.mpropdef
1719 if mpropdef
== null then return # Error thus skipped
1721 var bound
= mpropdef
.bound
1722 if bound
== null then return # Error thus skipped
1724 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1726 var mclassdef
= mpropdef
.mclassdef
1727 var mmodule
= mclassdef
.mmodule
1728 var anchor
= mclassdef
.bound_mtype
1730 var ntype
= self.n_type
1731 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
1732 mpropdef
.bound
= null
1736 # Check redefinitions
1737 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1738 var supbound
= p
.bound
1739 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1741 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1744 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1745 modelbuilder
.error
(n_type
, "Redef Error: a virtual type cannot be refined.")
1748 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1749 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")