1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.bound
= mclassdef
.mmodule
.model
.null_type
116 for npropdef
in nclassdef2
.n_propdefs
do
117 # Check ATypePropdef first since they may be required for the other properties
118 if not npropdef
isa ATypePropdef then continue
119 npropdef
.check_signature
(self)
122 for npropdef
in nclassdef2
.n_propdefs
do
123 if npropdef
isa ATypePropdef then continue
124 npropdef
.check_signature
(self)
127 process_default_constructors
(nclassdef
)
130 # the root init of the Object class
131 # Is usually implicitly defined
132 # Then explicit or implicit definitions of root-init are attached to it
133 var the_root_init_mmethod
: nullable MMethod
135 # Introduce or inherit default constructor
136 # This is the last part of `build_properties`.
137 private fun process_default_constructors
(nclassdef
: AClassdef)
139 var mclassdef
= nclassdef
.mclassdef
.as(not null)
141 # Are we a refinement
142 if not mclassdef
.is_intro
then return
144 # Look for the init in Object, or create it
145 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
146 # Create the implicit root-init method
147 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
148 mprop
.is_root_init
= true
149 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
150 var mparameters
= new Array[MParameter]
151 var msignature
= new MSignature(mparameters
, null)
152 mpropdef
.msignature
= msignature
153 mpropdef
.new_msignature
= msignature
155 nclassdef
.mfree_init
= mpropdef
156 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
157 the_root_init_mmethod
= mprop
161 # Is the class forbid constructors?
162 if not mclassdef
.mclass
.kind
.need_init
then return
164 # Is there already a constructor defined?
165 var defined_init
: nullable MMethodDef = null
166 for mpropdef
in mclassdef
.mpropdefs
do
167 if not mpropdef
isa MMethodDef then continue
168 if not mpropdef
.mproperty
.is_init
then continue
169 if mpropdef
.mproperty
.is_root_init
then
170 assert defined_init
== null
171 defined_init
= mpropdef
172 else if mpropdef
.mproperty
.name
== "init" then
173 # An explicit old-style init named "init", so return
178 if not nclassdef
isa AStdClassdef then return
180 # Collect undefined attributes
181 var mparameters
= new Array[MParameter]
182 var initializers
= new Array[MProperty]
183 for npropdef
in nclassdef
.n_propdefs
do
184 if npropdef
isa AMethPropdef then
185 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
186 if npropdef
.mpropdef
== null then return # Skip broken method
187 var sig
= npropdef
.mpropdef
.msignature
188 if sig
== null then continue # Skip broken method
190 for param
in sig
.mparameters
do
191 var ret_type
= param
.mtype
192 var mparameter
= new MParameter(param
.name
, ret_type
, false, ret_type
isa MNullableType)
193 mparameters
.add
(mparameter
)
195 initializers
.add
(npropdef
.mpropdef
.mproperty
)
196 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
198 if npropdef
isa AAttrPropdef then
199 var mreadpropdef
= npropdef
.mreadpropdef
200 if mreadpropdef
== null or mreadpropdef
.msignature
== null then return # Skip broken attribute
201 if npropdef
.noinit
then continue # Skip noinit attribute
202 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
203 if atlateinit
!= null then
204 # For lateinit attributes, call the reader to force
205 # the lazy initialization of the attribute.
206 initializers
.add
(mreadpropdef
.mproperty
)
207 mreadpropdef
.mproperty
.is_autoinit
= true
210 if npropdef
.has_value
then continue
211 var paramname
= mreadpropdef
.mproperty
.name
212 var ret_type
= mreadpropdef
.msignature
.return_mtype
213 if ret_type
== null then return
214 var mparameter
= new MParameter(paramname
, ret_type
, false, ret_type
isa MNullableType)
215 mparameters
.add
(mparameter
)
216 var msetter
= npropdef
.mwritepropdef
217 if msetter
== null then
218 # No setter, it is a readonly attribute, so just add it
219 initializers
.add
(npropdef
.mpropdef
.mproperty
)
220 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
222 # Add the setter to the list
223 initializers
.add
(msetter
.mproperty
)
224 msetter
.mproperty
.is_autoinit
= true
229 if the_root_init_mmethod
== null then return
231 # Look for most-specific new-stype init definitions
232 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
233 if spropdefs
.is_empty
then
234 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
238 # Look at the autoinit class-annotation
239 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
240 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
241 if autoinit
!= null then
242 # Just throws the collected initializers
246 if noautoinit
!= null then
247 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
250 if autoinit
.n_args
.is_empty
then
251 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
254 # Get and check each argument
255 for narg
in autoinit
.n_args
do
258 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
262 # Search the property.
263 # To avoid bad surprises, try to get the setter first.
264 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
266 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
269 error
(narg
, "Error: unknown method `{id}`")
272 if not p
.is_autoinit
then
273 error
(narg
, "Error: `{p}` is not an autoinit method")
277 # Register the initializer and the parameters
280 if pd
isa MMethodDef then
281 # Get the signature resolved for the current receiver
282 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
283 # Because the last parameter of setters is never default, try to default them for the autoinit.
284 for param
in sig
.mparameters
do
285 if not param
.is_default
and param
.mtype
isa MNullableType then
286 param
= new MParameter(param
.name
, param
.mtype
, param
.is_vararg
, true)
288 mparameters
.add
(param
)
296 # Search the longest-one and checks for conflict
297 var longest
= spropdefs
.first
298 if spropdefs
.length
> 1 then
299 # part 1. find the longest list
300 for spd
in spropdefs
do
301 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
304 # Check for conflict in the order of initializers
305 # Each initializer list must me a prefix of the longest list
306 # If `noautoinit` is set, just ignore conflicts
307 if noautoinit
== null then for spd
in spropdefs
do
309 for p
in spd
.initializers
do
310 if p
!= longest
.initializers
[i
] then
311 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
312 # TODO: invalidate the initializer to avoid more errors
320 if noautoinit
!= null then
321 # If there is local or inherited initializers, then complain.
322 if initializers
.is_empty
and longest
.initializers
.is_empty
then
323 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
325 # Just clear initializers
329 # Can we just inherit?
330 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
331 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
332 mclassdef
.mclass
.root_init
= longest
336 # Combine the inherited list to what is collected
337 if longest
.initializers
.length
> 0 then
338 mparameters
.prepend longest
.new_msignature
.mparameters
339 initializers
.prepend longest
.initializers
344 # If we already have a basic init definition, then setup its initializers
345 if defined_init
!= null then
346 defined_init
.initializers
.add_all
(initializers
)
347 var msignature
= new MSignature(mparameters
, null)
348 defined_init
.new_msignature
= msignature
349 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
350 mclassdef
.mclass
.root_init
= defined_init
354 # Else create the local implicit basic init definition
355 var mprop
= the_root_init_mmethod
.as(not null)
356 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
357 mpropdef
.has_supercall
= true
358 mpropdef
.initializers
.add_all
(initializers
)
359 var msignature
= new MSignature(mparameters
, null)
360 mpropdef
.new_msignature
= msignature
361 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
362 nclassdef
.mfree_init
= mpropdef
363 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
364 mclassdef
.mclass
.root_init
= mpropdef
367 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
368 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
370 var mmodule
= mpropdef
.mclassdef
.mmodule
371 var mproperty
= mpropdef
.mproperty
373 # Extract visibility information of the main part of `mtype`
374 # It is a case-by case
375 var vis_type
: nullable MVisibility = null # The own visibility of the type
376 var mmodule_type
: nullable MModule = null # The original module of the type
377 mtype
= mtype
.undecorate
378 if mtype
isa MClassType then
379 vis_type
= mtype
.mclass
.visibility
380 mmodule_type
= mtype
.mclass
.intro
.mmodule
381 else if mtype
isa MVirtualType then
382 vis_type
= mtype
.mproperty
.visibility
383 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
384 else if mtype
isa MParameterType then
385 # nothing, always visible
386 else if mtype
isa MNullType then
389 node
.debug
"Unexpected type {mtype}"
393 if vis_type
!= null then
394 assert mmodule_type
!= null
395 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
396 if mproperty
.visibility
> vis_type
then
397 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
399 else if mproperty
.visibility
> vis_module_type
then
400 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
405 # No error, try to go deeper in generic types
406 if node
isa AType then
407 for a
in node
.n_types
do
409 if t
== null then continue # Error, thus skipped
410 check_visibility
(a
, t
, mpropdef
)
412 else if mtype
isa MGenericType then
413 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
417 # Detect circularity errors for virtual types.
418 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
421 # Slow case: progress on each resolution until we visit all without getting a loop
423 # The graph used to detect loops
424 var mtype
= mproperty
.mvirtualtype
425 var poset
= new POSet[MType]
427 # The work-list of types to resolve
428 var todo
= new List[MType]
431 while not todo
.is_empty
do
435 if not t
.need_anchor
then continue
437 # Get the types derived of `t` (subtypes and bounds)
439 if t
isa MNullableType then
441 else if t
isa MGenericType then
443 else if t
isa MVirtualType then
445 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
446 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
447 # TODO something to manage correctly bound conflicts
448 assert not defs
.is_empty
449 nexts
= new Array[MType]
451 var next
= defs
.first
.bound
452 if next
== null then return false
455 else if t
isa MClassType then
456 # Basic type, nothing to to
458 else if t
isa MParameterType then
459 # Parameter types cannot depend on virtual types, so nothing to do
467 if poset
.has_edge
(next
, t
) then
468 if mtype
== next
then
469 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
471 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
475 poset
.add_edge
(t
, next
)
485 # Does the MPropDef contains a call to super or a call of a super-constructor?
486 # Subsequent phases of the frontend (esp. typing) set it if required
487 var has_supercall
: Bool = false is writable
490 redef class AClassdef
491 # Marker used in `ModelBuilder::build_properties`
492 private var build_properties_is_done
= false
494 # The free init (implicitely constructed by the class if required)
495 var mfree_init
: nullable MMethodDef = null
499 # The base init of the class.
500 # Used to get the common new_msignature and initializers
502 # TODO: Where to put this information is not clear because unlike other
503 # informations, the initialisers are stable in a same class.
504 var root_init
: nullable MMethodDef = null
507 redef class MClassDef
508 # What is the `APropdef` associated to a `MProperty`?
509 # Used to check multiple definition of a property.
510 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
512 # Build the virtual type `SELF` only for introduction `MClassDef`
513 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
515 if not is_intro
then return
518 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
520 # If SELF type is declared nowherer?
521 if mprop
== null then return
523 # SELF is not a virtual type? it is weird but we ignore it
524 if not mprop
isa MVirtualTypeProp then return
526 # Is this the intro of SELF in the library?
527 var intro
= mprop
.intro
528 var intro_mclassdef
= intro
.mclassdef
529 if intro_mclassdef
== self then
530 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
532 # SELF must be declared in Object, otherwise this will create conflicts
533 if intro_mclassdef
.mclass
.name
!= "Object" then
534 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
537 # SELF must be public
538 if mprop
.visibility
!= public_visibility
then
539 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
542 # SELF must not be fixed
543 if intro
.is_fixed
then
544 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
550 # This class introduction inherits a SELF
551 # We insert an artificial property to update it
552 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
553 mpropdef
.bound
= mclass
.mclass_type
558 # The associated main model entity
559 type MPROPDEF: MPropDef
561 # The associated propdef once build by a `ModelBuilder`
562 var mpropdef
: nullable MPROPDEF is writable
564 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
565 private fun build_signature
(modelbuilder
: ModelBuilder) do end
566 private fun check_signature
(modelbuilder
: ModelBuilder) do end
567 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
569 var mvisibility
= public_visibility
570 if nvisibility
!= null then
571 mvisibility
= nvisibility
.mvisibility
572 if mvisibility
== intrude_visibility
then
573 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
574 mvisibility
= public_visibility
577 if mclassdef
.mclass
.visibility
== private_visibility
then
578 if mvisibility
== protected_visibility
then
579 assert nvisibility
!= null
580 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
581 else if mvisibility
== private_visibility
then
582 assert nvisibility
!= null
583 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
585 mvisibility
= private_visibility
590 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
592 var ndoc
= self.n_doc
594 var mdoc
= ndoc
.to_mdoc
596 mdoc
.original_mentity
= mpropdef
597 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
598 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
601 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
602 if at_deprecated
!= null then
603 if not mpropdef
.is_intro
then
604 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
606 var info
= new MDeprecationInfo
607 ndoc
= at_deprecated
.n_doc
608 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
609 mpropdef
.mproperty
.deprecation
= info
614 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
616 if nvisibility
== null then return
617 var mvisibility
= nvisibility
.mvisibility
618 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
619 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
623 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
625 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
626 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
629 if mprop
isa MMethod and mprop
.is_root_init
then return true
630 if kwredef
== null then
632 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
636 # Check for full-name conflicts in the project.
637 # A public property should have a unique qualified name `project::class::prop`.
638 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
639 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
640 if others
!= null then for other
in others
do
641 if other
!= mprop
and other
.intro_mclassdef
.mmodule
.mgroup
!= null and other
.intro_mclassdef
.mmodule
.mgroup
.mproject
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mproject
and other
.intro_mclassdef
.mclass
.name
== mprop
.intro_mclassdef
.mclass
.name
and other
.visibility
>= protected_visibility
then
642 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}`.")
648 if not need_redef
then
649 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
656 # Checks for useless type in redef signatures.
657 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
660 redef class ASignature
661 # Is the model builder has correctly visited the signature
662 var is_visited
= false
663 # Names of parameters from the AST
664 # REQUIRE: is_visited
665 var param_names
= new Array[String]
666 # Types of parameters from the AST
667 # REQUIRE: is_visited
668 var param_types
= new Array[MType]
669 # Rank of the vararg (of -1 if none)
670 # REQUIRE: is_visited
671 var vararg_rank
: Int = -1
673 var ret_type
: nullable MType = null
675 # Visit and fill information about a signature
676 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
678 var mmodule
= mclassdef
.mmodule
679 var param_names
= self.param_names
680 var param_types
= self.param_types
681 for np
in self.n_params
do
682 param_names
.add
(np
.n_id
.text
)
683 var ntype
= np
.n_type
684 if ntype
!= null then
685 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
686 if mtype
== null then return false # Skip error
687 for i
in [0..param_names
.length-param_types
.length
[ do
688 param_types
.add
(mtype
)
690 if np
.n_dotdotdot
!= null then
691 if self.vararg_rank
!= -1 then
692 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
695 self.vararg_rank
= param_names
.length
- 1
700 var ntype
= self.n_type
701 if ntype
!= null then
702 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
703 if self.ret_type
== null then return false # Skip error
706 self.is_visited
= true
710 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
713 for np
in self.n_params
do
714 var ntype
= np
.n_type
715 if ntype
!= null then
716 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
721 var ntype
= self.n_type
722 if ntype
!= null then
723 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
732 # The associated mparameter if any
733 var mparameter
: nullable MParameter = null
736 redef class AMethPropdef
737 redef type MPROPDEF: MMethodDef
739 # Is the method annotated `autoinit`?
740 var is_autoinit
= false
742 # Can self be used as a root init?
743 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
745 # Need the `init` keyword
746 if n_kwinit
== null then return false
747 # Need to by anonymous
748 if self.n_methid
!= null then return false
749 # No annotation on itself
750 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
752 var amod
= self.parent
.parent
.as(AModule)
753 var amoddecl
= amod
.n_moduledecl
754 if amoddecl
!= null then
755 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
756 if old
!= null then return false
759 if self.n_signature
.n_params
.length
> 0 then
760 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
763 # Cannot be private or something
764 if not self.n_visibility
isa APublicVisibility then
765 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
772 redef fun build_property
(modelbuilder
, mclassdef
)
774 var n_kwinit
= n_kwinit
775 var n_kwnew
= n_kwnew
776 var is_init
= n_kwinit
!= null or n_kwnew
!= null
778 var amethodid
= self.n_methid
780 if amethodid
== null then
784 else if n_kwinit
!= null then
787 else if n_kwnew
!= null then
793 else if amethodid
isa AIdMethid then
794 name
= amethodid
.n_id
.text
795 name_node
= amethodid
797 # operator, bracket or assign
798 name
= amethodid
.collect_text
799 name_node
= amethodid
801 var arity
= self.n_signature
.n_params
.length
802 if name
== "+" and arity
== 0 then
804 else if name
== "-" and arity
== 0 then
806 else if name
== "~" and arity
== 0 then
809 if amethodid
.is_binary
and arity
!= 1 then
810 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
811 else if amethodid
.min_arity
> arity
then
812 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
817 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
818 var mprop
: nullable MMethod = null
819 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
820 if mprop
== null and look_like_a_root_init
then
821 mprop
= modelbuilder
.the_root_init_mmethod
823 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
824 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
827 if mprop
== null then
828 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
829 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
830 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
831 modelbuilder
.the_root_init_mmethod
= mprop
832 mprop
.is_root_init
= true
834 mprop
.is_init
= is_init
835 mprop
.is_new
= n_kwnew
!= null
836 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
837 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
838 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
840 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
841 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
844 # Check name conflicts in the local class for constructors.
846 for p
, n
in mclassdef
.mprop2npropdef
do
847 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
848 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
854 mclassdef
.mprop2npropdef
[mprop
] = self
856 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
858 set_doc
(mpropdef
, modelbuilder
)
860 self.mpropdef
= mpropdef
861 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
862 if mpropdef
.is_intro
then
863 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
865 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
869 redef fun build_signature
(modelbuilder
)
871 var mpropdef
= self.mpropdef
872 if mpropdef
== null then return # Error thus skiped
873 var mclassdef
= mpropdef
.mclassdef
874 var mmodule
= mclassdef
.mmodule
875 var nsig
= self.n_signature
877 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
878 var root_init
= mclassdef
.mclass
.root_init
879 if root_init
!= null then
880 # Inherit the initializers by refinement
881 mpropdef
.new_msignature
= root_init
.new_msignature
882 assert mpropdef
.initializers
.is_empty
883 mpropdef
.initializers
.add_all root_init
.initializers
887 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
888 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
890 # Retrieve info from the signature AST
891 var param_names
= new Array[String] # Names of parameters from the AST
892 var param_types
= new Array[MType] # Types of parameters from the AST
894 var ret_type
: nullable MType = null # Return type from the AST
896 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
897 param_names
= nsig
.param_names
898 param_types
= nsig
.param_types
899 vararg_rank
= nsig
.vararg_rank
900 ret_type
= nsig
.ret_type
903 # Look for some signature to inherit
904 # FIXME: do not inherit from the intro, but from the most specific
905 var msignature
: nullable MSignature = null
906 if not mpropdef
.is_intro
then
907 msignature
= mpropdef
.mproperty
.intro
.msignature
908 if msignature
== null then return # Skip error
910 # The local signature is adapted to use the local formal types, if any.
911 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
913 # Check inherited signature arity
914 if param_names
.length
!= msignature
.arity
then
916 if nsig
!= null then node
= nsig
else node
= self
917 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}`.")
920 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
921 # FIXME UGLY: inherit signature from a super-constructor
922 for msupertype
in mclassdef
.supertypes
do
923 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
924 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
925 if candidate
!= null then
926 if msignature
== null then
927 msignature
= candidate
.intro
.as(MMethodDef).msignature
934 # Inherit the signature
935 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
936 # Parameters are untyped, thus inherit them
937 param_types
= new Array[MType]
938 for mparameter
in msignature
.mparameters
do
939 param_types
.add
(mparameter
.mtype
)
941 vararg_rank
= msignature
.vararg_rank
943 if msignature
!= null and ret_type
== null then
944 ret_type
= msignature
.return_mtype
947 if param_names
.length
!= param_types
.length
then
948 # Some parameters are typed, other parameters are not typed.
949 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
953 var mparameters
= new Array[MParameter]
954 for i
in [0..param_names
.length
[ do
955 var is_default
= false
956 if vararg_rank
== -1 and param_types
[i
] isa MNullableType then
957 if i
< param_names
.length-1
or accept_special_last_parameter
then
961 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
, is_default
)
962 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
963 mparameters
.add
(mparameter
)
966 # In `new`-factories, the return type is by default the classtype.
967 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
969 # Special checks for operator methods
970 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
971 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
973 if ret_type
== null and return_is_mandatory
then
974 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
977 msignature
= new MSignature(mparameters
, ret_type
)
978 mpropdef
.msignature
= msignature
979 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
980 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
981 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
984 var at
= self.get_single_annotation
("lazy", modelbuilder
)
985 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
987 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
988 if atautoinit
!= null then
989 if not mpropdef
.is_intro
then
990 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
991 else if not mclassdef
.is_intro
then
992 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
994 self.is_autoinit
= true
999 redef fun check_signature
(modelbuilder
)
1001 var mpropdef
= self.mpropdef
1002 if mpropdef
== null then return # Error thus skiped
1003 var mclassdef
= mpropdef
.mclassdef
1004 var mmodule
= mclassdef
.mmodule
1005 var nsig
= self.n_signature
1006 var mysignature
= self.mpropdef
.msignature
1007 if mysignature
== null then return # Error thus skiped
1010 if nsig
!= null then
1011 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1012 self.mpropdef
.msignature
= null # invalidate
1013 return # Forward error
1017 # Lookup for signature in the precursor
1018 # FIXME all precursors should be considered
1019 if not mpropdef
.is_intro
then
1020 var msignature
= mpropdef
.mproperty
.intro
.msignature
1021 if msignature
== null then return
1023 var precursor_ret_type
= msignature
.return_mtype
1024 var ret_type
= mysignature
.return_mtype
1025 if ret_type
!= null and precursor_ret_type
== null then
1026 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1027 self.mpropdef
.msignature
= null
1031 if mysignature
.arity
> 0 then
1032 # Check parameters types
1033 for i
in [0..mysignature
.arity
[ do
1034 var myt
= mysignature
.mparameters
[i
].mtype
1035 var prt
= msignature
.mparameters
[i
].mtype
1036 var node
= nsig
.n_params
[i
]
1037 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1038 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1039 self.mpropdef
.msignature
= null
1043 if precursor_ret_type
!= null then
1044 var node
: nullable ANode = null
1045 if nsig
!= null then node
= nsig
.n_type
1046 if node
== null then node
= self
1047 if ret_type
== null then
1048 # Inherit the return type
1049 ret_type
= precursor_ret_type
1050 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1051 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1052 self.mpropdef
.msignature
= null
1057 if mysignature
.arity
> 0 then
1058 # Check parameters visibility
1059 for i
in [0..mysignature
.arity
[ do
1060 var nt
= nsig
.n_params
[i
].n_type
1061 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1063 var nt
= nsig
.n_type
1064 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1066 check_repeated_types
(modelbuilder
)
1069 # For parameters, type is always useless in a redef.
1070 # For return type, type is useless if not covariant with introduction.
1071 redef fun check_repeated_types
(modelbuilder
) do
1072 if mpropdef
.is_intro
or n_signature
== null then return
1074 for param
in n_signature
.n_params
do
1075 if param
.n_type
!= null then
1076 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1080 var intro
= mpropdef
.mproperty
.intro
1081 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1082 if n_intro
== null or not n_intro
isa AMethPropdef then return
1084 var ret_type
= n_signature
.ret_type
1085 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1086 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1092 # Is a return required?
1094 # * True for operators and brackets.
1095 # * False for id and assignment.
1096 fun return_is_mandatory
: Bool do return true
1098 # Can the last parameter be special like a vararg?
1100 # * False for operators: the last one is in fact the only one.
1101 # * False for assignments: it is the right part of the assignment.
1102 # * True for ids and brackets.
1103 fun accept_special_last_parameter
: Bool do return false
1105 # The minimum required number of parameters.
1107 # * 1 for binary operators
1109 # * 1 for assignments
1110 # * 2 for bracket assignments
1112 fun min_arity
: Int do return 1
1114 # Is the `self` a binary operator?
1115 fun is_binary
: Bool do return true
1118 redef class AIdMethid
1119 redef fun return_is_mandatory
do return false
1120 redef fun accept_special_last_parameter
do return true
1121 redef fun min_arity
do return 0
1122 redef fun is_binary
do return false
1125 redef class ABraMethid
1126 redef fun accept_special_last_parameter
do return true
1127 redef fun is_binary
do return false
1130 redef class ABraassignMethid
1131 redef fun return_is_mandatory
do return false
1132 redef fun min_arity
do return 2
1133 redef fun is_binary
do return false
1136 redef class AAssignMethid
1137 redef fun return_is_mandatory
do return false
1138 redef fun is_binary
do return false
1141 redef class AAttrPropdef
1142 redef type MPROPDEF: MAttributeDef
1144 # The static type of the property (declared, inferred or inherited)
1145 # This attribute is also used to check if the property was analyzed and is valid.
1146 var mtype
: nullable MType
1148 # Is the node tagged `noinit`?
1151 # Is the node tagged lazy?
1154 # Has the node a default value?
1155 # Could be through `n_expr` or `n_block`
1156 var has_value
= false
1158 # The guard associated to a lazy attribute.
1159 # Because some engines does not have a working `isset`,
1160 # this additional attribute is used to guard the lazy initialization.
1161 # TODO: to remove once isset is correctly implemented
1162 var mlazypropdef
: nullable MAttributeDef
1164 # The associated getter (read accessor) if any
1165 var mreadpropdef
: nullable MMethodDef is writable
1166 # The associated setter (write accessor) if any
1167 var mwritepropdef
: nullable MMethodDef is writable
1169 redef fun build_property
(modelbuilder
, mclassdef
)
1171 var mclass
= mclassdef
.mclass
1173 var name
= nid2
.text
1175 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1176 if atabstract
== null then
1177 if not mclass
.kind
.need_init
then
1178 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1181 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1182 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1183 self.mpropdef
= mpropdef
1184 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1188 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1189 if mreadprop
== null then
1190 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1191 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1192 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1194 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1195 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1197 mclassdef
.mprop2npropdef
[mreadprop
] = self
1199 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1200 self.mreadpropdef
= mreadpropdef
1201 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1202 set_doc
(mreadpropdef
, modelbuilder
)
1203 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1204 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1206 has_value
= n_expr
!= null or n_block
!= null
1208 if atabstract
!= null and has_value
then
1209 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1213 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1214 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1215 if atnoinit
!= null then
1218 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1221 if atabstract
!= null then
1222 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot be abstract.")
1227 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1228 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1229 if atlazy
!= null or atlateinit
!= null then
1230 if atlazy
!= null and atlateinit
!= null then
1231 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1234 if not has_value
then
1235 if atlazy
!= null then
1236 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1237 else if atlateinit
!= null then
1238 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1244 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1245 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1246 self.mlazypropdef
= mlazypropdef
1249 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1250 if atreadonly
!= null then
1251 if not has_value
then
1252 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1254 # No setter, so just leave
1258 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1259 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1262 var writename
= name
+ "="
1263 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1264 if atwritable
!= null then
1265 if not atwritable
.n_args
.is_empty
then
1266 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1269 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1270 var nwkwredef
: nullable Token = null
1271 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1272 if mwriteprop
== null then
1274 if atwritable
!= null then
1275 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1277 mvisibility
= private_visibility
1279 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1280 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1281 mwriteprop
.deprecation
= mreadprop
.deprecation
1283 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1284 if atwritable
!= null then
1285 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1288 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1290 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1291 self.mwritepropdef
= mwritepropdef
1292 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1293 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1294 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1297 redef fun build_signature
(modelbuilder
)
1299 var mreadpropdef
= self.mreadpropdef
1300 var mpropdef
= self.mpropdef
1301 if mreadpropdef
== null then return # Error thus skipped
1302 var mclassdef
= mreadpropdef
.mclassdef
1303 var mmodule
= mclassdef
.mmodule
1304 var mtype
: nullable MType = null
1307 var ntype
= self.n_type
1308 if ntype
!= null then
1309 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1310 if mtype
== null then return
1313 var inherited_type
: nullable MType = null
1314 # Inherit the type from the getter (usually an abstract getter)
1315 if not mreadpropdef
.is_intro
then
1316 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1317 if msignature
== null then return # Error, thus skipped
1318 inherited_type
= msignature
.return_mtype
1319 if inherited_type
!= null then
1320 # The inherited type is adapted to use the local formal types, if any.
1321 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1322 if mtype
== null then mtype
= inherited_type
1326 var nexpr
= self.n_expr
1327 if mtype
== null then
1328 if nexpr
!= null then
1329 if nexpr
isa ANewExpr then
1330 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1331 else if nexpr
isa AIntExpr then
1332 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1333 if cla
!= null then mtype
= cla
.mclass_type
1334 else if nexpr
isa AByteExpr then
1335 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1336 if cla
!= null then mtype
= cla
.mclass_type
1337 else if nexpr
isa AFloatExpr then
1338 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1339 if cla
!= null then mtype
= cla
.mclass_type
1340 else if nexpr
isa ACharExpr then
1341 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1342 if cla
!= null then mtype
= cla
.mclass_type
1343 else if nexpr
isa ABoolExpr then
1344 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1345 if cla
!= null then mtype
= cla
.mclass_type
1346 else if nexpr
isa ASuperstringExpr then
1347 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1348 if cla
!= null then mtype
= cla
.mclass_type
1349 else if nexpr
isa AStringFormExpr then
1350 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1351 if cla
!= null then mtype
= cla
.mclass_type
1353 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1356 if mtype
== null then return
1358 else if ntype
!= null and inherited_type
== mtype
then
1359 if nexpr
isa ANewExpr then
1360 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1361 if xmtype
== mtype
then
1362 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1367 if mtype
== null then
1368 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1374 if mpropdef
!= null then
1375 mpropdef
.static_mtype
= mtype
1379 var msignature
= new MSignature(new Array[MParameter], mtype
)
1380 mreadpropdef
.msignature
= msignature
1383 var mwritepropdef
= self.mwritepropdef
1384 if mwritepropdef
!= null then
1387 var mparameter
= new MParameter(name
, mtype
, false, false)
1388 var msignature
= new MSignature([mparameter
], null)
1389 mwritepropdef
.msignature
= msignature
1392 var mlazypropdef
= self.mlazypropdef
1393 if mlazypropdef
!= null then
1394 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1396 check_repeated_types
(modelbuilder
)
1399 redef fun check_signature
(modelbuilder
)
1401 var mpropdef
= self.mpropdef
1402 if mpropdef
== null then return # Error thus skipped
1403 var ntype
= self.n_type
1404 var mtype
= self.mtype
1405 if mtype
== null then return # Error thus skipped
1407 var mclassdef
= mpropdef
.mclassdef
1408 var mmodule
= mclassdef
.mmodule
1411 if ntype
!= null then
1412 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1415 if nexpr
isa ANewExpr then
1416 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1419 # Lookup for signature in the precursor
1420 # FIXME all precursors should be considered
1421 if not mpropdef
.is_intro
then
1422 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1423 if precursor_type
== null then return
1425 if mtype
!= precursor_type
then
1426 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1431 # Check getter and setter
1432 var meth
= self.mreadpropdef
1433 if meth
!= null then
1434 self.check_method_signature
(modelbuilder
, meth
)
1435 var node
: nullable ANode = ntype
1436 if node
== null then node
= self
1437 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1439 meth
= self.mwritepropdef
1440 if meth
!= null then
1441 self.check_method_signature
(modelbuilder
, meth
)
1442 var node
: nullable ANode = ntype
1443 if node
== null then node
= self
1444 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1448 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1450 var mclassdef
= mpropdef
.mclassdef
1451 var mmodule
= mclassdef
.mmodule
1452 var nsig
= self.n_type
1453 var mysignature
= mpropdef
.msignature
1454 if mysignature
== null then return # Error thus skiped
1456 # Lookup for signature in the precursor
1457 # FIXME all precursors should be considered
1458 if not mpropdef
.is_intro
then
1459 var msignature
= mpropdef
.mproperty
.intro
.msignature
1460 if msignature
== null then return
1462 if mysignature
.arity
!= msignature
.arity
then
1464 if nsig
!= null then node
= nsig
else node
= self
1465 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}`.")
1468 var precursor_ret_type
= msignature
.return_mtype
1469 var ret_type
= mysignature
.return_mtype
1470 if ret_type
!= null and precursor_ret_type
== null then
1472 if nsig
!= null then node
= nsig
else node
= self
1473 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1477 if mysignature
.arity
> 0 then
1478 # Check parameters types
1479 for i
in [0..mysignature
.arity
[ do
1480 var myt
= mysignature
.mparameters
[i
].mtype
1481 var prt
= msignature
.mparameters
[i
].mtype
1483 if nsig
!= null then node
= nsig
else node
= self
1484 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1485 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1489 if precursor_ret_type
!= null then
1491 if nsig
!= null then node
= nsig
else node
= self
1492 if ret_type
== null then
1493 # Inherit the return type
1494 ret_type
= precursor_ret_type
1495 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1496 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1502 # Type is useless if the attribute type is the same thant the intro.
1503 redef fun check_repeated_types
(modelbuilder
) do
1504 if mreadpropdef
.is_intro
or n_type
== null then return
1506 var intro
= mreadpropdef
.mproperty
.intro
1507 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1508 if n_intro
== null then return
1511 if n_intro
isa AMethPropdef then
1512 ntype
= n_intro
.n_signature
.ret_type
1513 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1514 ntype
= n_intro
.n_type
.mtype
1517 if ntype
==null or ntype
!= n_type
.mtype
then return
1518 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1522 redef class ATypePropdef
1523 redef type MPROPDEF: MVirtualTypeDef
1525 redef fun build_property
(modelbuilder
, mclassdef
)
1527 var name
= self.n_id
.text
1528 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1529 if mprop
== null then
1530 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1531 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1532 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1533 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1536 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1538 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1539 assert mprop
isa MVirtualTypeProp
1540 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1542 mclassdef
.mprop2npropdef
[mprop
] = self
1544 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1545 self.mpropdef
= mpropdef
1546 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1547 if mpropdef
.is_intro
then
1548 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1550 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1552 set_doc
(mpropdef
, modelbuilder
)
1554 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1555 if atfixed
!= null then
1556 mpropdef
.is_fixed
= true
1560 redef fun build_signature
(modelbuilder
)
1562 var mpropdef
= self.mpropdef
1563 if mpropdef
== null then return # Error thus skipped
1564 var mclassdef
= mpropdef
.mclassdef
1565 var mmodule
= mclassdef
.mmodule
1566 var mtype
: nullable MType = null
1568 var ntype
= self.n_type
1569 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1570 if mtype
== null then return
1572 mpropdef
.bound
= mtype
1573 # print "{mpropdef}: {mtype}"
1576 redef fun check_signature
(modelbuilder
)
1578 var mpropdef
= self.mpropdef
1579 if mpropdef
== null then return # Error thus skipped
1581 var bound
= mpropdef
.bound
1582 if bound
== null then return # Error thus skipped
1584 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1586 var mclassdef
= mpropdef
.mclassdef
1587 var mmodule
= mclassdef
.mmodule
1588 var anchor
= mclassdef
.bound_mtype
1590 var ntype
= self.n_type
1591 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1592 mpropdef
.bound
= null
1596 # Check redefinitions
1597 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1598 var supbound
= p
.bound
1599 if supbound
== null then break # broken super bound, skip error
1601 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1604 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1605 # Still a warning to pass existing bad code
1606 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1609 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1610 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")