1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.is_broken
= true
114 mpropdef
.bound
= new MBottomType(mclassdef
.mmodule
.model
)
117 for npropdef
in nclassdef2
.n_propdefs
do
118 # Check ATypePropdef first since they may be required for the other properties
119 if not npropdef
isa ATypePropdef then continue
120 npropdef
.check_signature
(self)
123 for npropdef
in nclassdef2
.n_propdefs
do
124 if npropdef
isa ATypePropdef then continue
125 npropdef
.check_signature
(self)
128 process_default_constructors
(nclassdef
)
131 # the root init of the Object class
132 # Is usually implicitly defined
133 # Then explicit or implicit definitions of root-init are attached to it
134 var the_root_init_mmethod
: nullable MMethod
136 # Introduce or inherit default constructor
137 # This is the last part of `build_properties`.
138 private fun process_default_constructors
(nclassdef
: AClassdef)
140 var mclassdef
= nclassdef
.mclassdef
.as(not null)
142 # Are we a refinement
143 if not mclassdef
.is_intro
then return
145 # Look for the init in Object, or create it
146 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
147 # Create the implicit root-init method
148 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
149 mprop
.is_root_init
= true
150 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
151 var mparameters
= new Array[MParameter]
152 var msignature
= new MSignature(mparameters
, null)
153 mpropdef
.msignature
= msignature
154 mpropdef
.new_msignature
= msignature
156 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
157 the_root_init_mmethod
= mprop
161 # Is there already a constructor defined?
162 var defined_init
: nullable MMethodDef = null
163 for mpropdef
in mclassdef
.mpropdefs
do
164 if not mpropdef
isa MMethodDef then continue
165 if not mpropdef
.mproperty
.is_init
then continue
166 if mpropdef
.mproperty
.is_root_init
then
167 assert defined_init
== null
168 defined_init
= mpropdef
169 else if mpropdef
.mproperty
.name
== "init" then
170 # An explicit old-style init named "init", so return
175 if not nclassdef
isa AStdClassdef then return
177 # Collect undefined attributes
178 var mparameters
= new Array[MParameter]
179 var initializers
= new Array[MProperty]
180 for npropdef
in nclassdef
.n_propdefs
do
181 if npropdef
isa AMethPropdef then
182 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
183 var mpropdef
= npropdef
.mpropdef
184 if mpropdef
== null then return # Skip broken method
185 var sig
= mpropdef
.msignature
186 if sig
== null then continue # Skip broken method
188 mparameters
.add_all sig
.mparameters
189 initializers
.add
(mpropdef
.mproperty
)
190 mpropdef
.mproperty
.is_autoinit
= true
192 if npropdef
isa AAttrPropdef then
193 var mreadpropdef
= npropdef
.mreadpropdef
194 if mreadpropdef
== null then return # Skip broken attribute
195 var msignature
= mreadpropdef
.msignature
196 if msignature
== null then return # Skip broken attribute
197 if npropdef
.noinit
then continue # Skip noinit attribute
198 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
199 if atlateinit
!= null then
200 # For lateinit attributes, call the reader to force
201 # the lazy initialization of the attribute.
202 initializers
.add
(mreadpropdef
.mproperty
)
203 mreadpropdef
.mproperty
.is_autoinit
= true
206 if npropdef
.has_value
then continue
207 var paramname
= mreadpropdef
.mproperty
.name
208 var ret_type
= msignature
.return_mtype
209 if ret_type
== null then return
210 var mparameter
= new MParameter(paramname
, ret_type
, false)
211 mparameters
.add
(mparameter
)
212 var msetter
= npropdef
.mwritepropdef
213 if msetter
== null then
214 # No setter, it is a readonly attribute, so just add it
215 initializers
.add
(npropdef
.mpropdef
.mproperty
)
216 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
218 # Add the setter to the list
219 initializers
.add
(msetter
.mproperty
)
220 msetter
.mproperty
.is_autoinit
= true
225 var the_root_init_mmethod
= self.the_root_init_mmethod
226 if the_root_init_mmethod
== null then return
228 # Look for most-specific new-stype init definitions
229 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
230 if spropdefs
.is_empty
then
231 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
235 # Look at the autoinit class-annotation
236 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
237 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
238 if autoinit
!= null then
239 # Just throws the collected initializers
243 if noautoinit
!= null then
244 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
247 if autoinit
.n_args
.is_empty
then
248 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
251 # Get and check each argument
252 for narg
in autoinit
.n_args
do
255 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
259 # Search the property.
260 # To avoid bad surprises, try to get the setter first.
261 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
263 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
266 error
(narg
, "Error: unknown method `{id}`")
269 if not p
.is_autoinit
then
270 error
(narg
, "Error: `{p}` is not an autoinit method")
274 # Register the initializer and the parameters
277 if pd
isa MMethodDef then
278 # Get the signature resolved for the current receiver
279 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
280 mparameters
.add_all
(sig
.mparameters
)
287 # Search the longest-one and checks for conflict
288 var longest
= spropdefs
.first
289 if spropdefs
.length
> 1 then
290 # part 1. find the longest list
291 for spd
in spropdefs
do
292 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
295 # Check for conflict in the order of initializers
296 # Each initializer list must me a prefix of the longest list
297 # If `noautoinit` is set, just ignore conflicts
298 if noautoinit
== null then for spd
in spropdefs
do
300 for p
in spd
.initializers
do
301 if p
!= longest
.initializers
[i
] then
302 var proposal
= new ArraySet[MProperty]
303 for spd2
in spropdefs
do
304 proposal
.add_all spd2
.initializers
306 proposal
.add_all initializers
307 self.error
(nclassdef
, "Error: cannot generate automatic init for class {mclassdef.mclass}. Conflict in the order in inherited initializers {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")}). Use `autoinit` to order initializers. eg `autoinit {proposal.join(", ")}`")
308 # TODO: invalidate the initializer to avoid more errors
316 if noautoinit
!= null then
317 # If there is local or inherited initializers, then complain.
318 if initializers
.is_empty
and longest
.initializers
.is_empty
then
319 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
321 # Just clear initializers
325 # Can we just inherit?
326 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
327 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
328 mclassdef
.mclass
.root_init
= longest
332 # Combine the inherited list to what is collected
333 if longest
.initializers
.length
> 0 then
334 mparameters
.prepend longest
.new_msignature
.mparameters
335 initializers
.prepend longest
.initializers
340 # If we already have a basic init definition, then setup its initializers
341 if defined_init
!= null then
342 defined_init
.initializers
.add_all
(initializers
)
343 var msignature
= new MSignature(mparameters
, null)
344 defined_init
.new_msignature
= msignature
345 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
346 mclassdef
.mclass
.root_init
= defined_init
350 # Else create the local implicit basic init definition
351 var mprop
= the_root_init_mmethod
352 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
353 mpropdef
.has_supercall
= true
354 mpropdef
.initializers
.add_all
(initializers
)
355 var msignature
= new MSignature(mparameters
, null)
356 mpropdef
.new_msignature
= msignature
357 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
358 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
359 mclassdef
.mclass
.root_init
= mpropdef
362 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
363 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
365 var mmodule
= mpropdef
.mclassdef
.mmodule
366 var mproperty
= mpropdef
.mproperty
368 # Extract visibility information of the main part of `mtype`
369 # It is a case-by case
370 var vis_type
: nullable MVisibility = null # The own visibility of the type
371 var mmodule_type
: nullable MModule = null # The original module of the type
372 mtype
= mtype
.undecorate
373 if mtype
isa MClassType then
374 vis_type
= mtype
.mclass
.visibility
375 mmodule_type
= mtype
.mclass
.intro_mmodule
376 else if mtype
isa MVirtualType then
377 vis_type
= mtype
.mproperty
.visibility
378 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
379 else if mtype
isa MParameterType then
380 # nothing, always visible
381 else if mtype
isa MNullType then
383 else if mtype
isa MBottomType then
386 node
.debug
"Unexpected type {mtype}"
390 if vis_type
!= null then
391 assert mmodule_type
!= null
392 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
393 if mproperty
.visibility
> vis_type
then
394 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
396 else if mproperty
.visibility
> vis_module_type
then
397 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
402 # No error, try to go deeper in generic types
403 if node
isa AType then
404 for a
in node
.n_types
do
406 if t
== null then continue # Error, thus skipped
407 check_visibility
(a
, t
, mpropdef
)
409 else if mtype
isa MGenericType then
410 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
414 # Detect circularity errors for virtual types.
415 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
418 # Slow case: progress on each resolution until we visit all without getting a loop
420 # The graph used to detect loops
421 var mtype
= mproperty
.mvirtualtype
422 var poset
= new POSet[MType]
424 # The work-list of types to resolve
425 var todo
= new List[MType]
428 while not todo
.is_empty
do
432 if not t
.need_anchor
then continue
434 # Get the types derived of `t` (subtypes and bounds)
436 if t
isa MNullableType then
438 else if t
isa MGenericType then
440 else if t
isa MVirtualType then
442 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
443 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
444 if defs
.is_empty
then return false
445 nexts
= new Array[MType]
447 var next
= defs
.first
.bound
448 if next
== null then return false
451 else if t
isa MClassType then
452 # Basic type, nothing to to
454 else if t
isa MParameterType then
455 # Parameter types cannot depend on virtual types, so nothing to do
463 if poset
.has_edge
(next
, t
) then
464 if mtype
== next
then
465 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
467 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
471 poset
.add_edge
(t
, next
)
481 # Does the MPropDef contains a call to super or a call of a super-constructor?
482 # Subsequent phases of the frontend (esp. typing) set it if required
483 var has_supercall
: Bool = false is writable
486 redef class AClassdef
487 # Marker used in `ModelBuilder::build_properties`
488 private var build_properties_is_done
= false
492 # The base init of the class.
493 # Used to get the common new_msignature and initializers
495 # TODO: Where to put this information is not clear because unlike other
496 # informations, the initialisers are stable in a same class.
497 var root_init
: nullable MMethodDef = null
500 redef class MClassDef
501 # What is the `APropdef` associated to a `MProperty`?
502 # Used to check multiple definition of a property.
503 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
505 # Build the virtual type `SELF` only for introduction `MClassDef`
506 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
508 if not is_intro
then return
511 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
513 # If SELF type is declared nowherer?
514 if mprop
== null then return
516 # SELF is not a virtual type? it is weird but we ignore it
517 if not mprop
isa MVirtualTypeProp then return
519 # Is this the intro of SELF in the library?
520 var intro
= mprop
.intro
521 var intro_mclassdef
= intro
.mclassdef
522 if intro_mclassdef
== self then
523 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
525 # SELF must be declared in Object, otherwise this will create conflicts
526 if intro_mclassdef
.mclass
.name
!= "Object" then
527 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
530 # SELF must be public
531 if mprop
.visibility
!= public_visibility
then
532 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
535 # SELF must not be fixed
536 if intro
.is_fixed
then
537 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
543 # This class introduction inherits a SELF
544 # We insert an artificial property to update it
545 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
546 mpropdef
.bound
= mclass
.mclass_type
551 # The associated main model entity
552 type MPROPDEF: MPropDef
554 # The associated propdef once build by a `ModelBuilder`
555 var mpropdef
: nullable MPROPDEF is writable
557 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
558 private fun build_signature
(modelbuilder
: ModelBuilder) do end
559 private fun check_signature
(modelbuilder
: ModelBuilder) do end
560 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
562 var mvisibility
= public_visibility
563 if nvisibility
!= null then
564 mvisibility
= nvisibility
.mvisibility
565 if mvisibility
== intrude_visibility
then
566 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
567 mvisibility
= public_visibility
570 if mclassdef
.mclass
.visibility
== private_visibility
then
571 if mvisibility
== protected_visibility
then
572 assert nvisibility
!= null
573 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
574 else if mvisibility
== private_visibility
then
575 assert nvisibility
!= null
576 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
578 mvisibility
= private_visibility
583 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
585 var ndoc
= self.n_doc
587 var mdoc
= ndoc
.to_mdoc
589 mdoc
.original_mentity
= mpropdef
590 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
591 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
594 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
595 if at_deprecated
!= null then
596 if not mpropdef
.is_intro
then
597 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
599 var info
= new MDeprecationInfo
600 ndoc
= at_deprecated
.n_doc
601 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
602 mpropdef
.mproperty
.deprecation
= info
607 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
609 if nvisibility
== null then return
610 var mvisibility
= nvisibility
.mvisibility
611 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
612 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
616 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
618 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
619 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
622 if mprop
isa MMethod and mprop
.is_root_init
then return true
623 if kwredef
== null then
625 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
629 # Check for full-name conflicts in the package.
630 # A public property should have a unique qualified name `package::class::prop`.
631 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
632 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
633 if others
!= null then for other
in others
do
634 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
635 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}`.")
641 if not need_redef
then
642 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
649 # Checks for useless type in redef signatures.
650 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
653 redef class ASignature
654 # Is the model builder has correctly visited the signature
655 var is_visited
= false
656 # Names of parameters from the AST
657 # REQUIRE: is_visited
658 var param_names
= new Array[String]
659 # Types of parameters from the AST
660 # REQUIRE: is_visited
661 var param_types
= new Array[MType]
662 # Rank of the vararg (of -1 if none)
663 # REQUIRE: is_visited
664 var vararg_rank
: Int = -1
666 var ret_type
: nullable MType = null
668 # Visit and fill information about a signature
669 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
671 var mmodule
= mclassdef
.mmodule
672 var param_names
= self.param_names
673 var param_types
= self.param_types
674 for np
in self.n_params
do
675 param_names
.add
(np
.n_id
.text
)
676 var ntype
= np
.n_type
677 if ntype
!= null then
678 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
679 if mtype
== null then return false # Skip error
680 for i
in [0..param_names
.length-param_types
.length
[ do
681 param_types
.add
(mtype
)
683 if np
.n_dotdotdot
!= null then
684 if self.vararg_rank
!= -1 then
685 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
688 self.vararg_rank
= param_names
.length
- 1
693 var ntype
= self.n_type
694 if ntype
!= null then
695 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
696 if self.ret_type
== null then return false # Skip error
699 self.is_visited
= true
703 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
706 for np
in self.n_params
do
707 var ntype
= np
.n_type
708 if ntype
!= null then
709 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
714 var ntype
= self.n_type
715 if ntype
!= null then
716 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
720 if not res
then is_broken
= true
726 # The associated mparameter if any
727 var mparameter
: nullable MParameter = null
730 redef class AMethPropdef
731 redef type MPROPDEF: MMethodDef
733 # Is the method annotated `autoinit`?
734 var is_autoinit
= false
736 # Can self be used as a root init?
737 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
739 # Need the `init` keyword
740 if n_kwinit
== null then return false
741 # Need to by anonymous
742 if self.n_methid
!= null then return false
743 # No annotation on itself
744 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
746 var amod
= self.parent
.parent
.as(AModule)
747 var amoddecl
= amod
.n_moduledecl
748 if amoddecl
!= null then
749 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
750 if old
!= null then return false
753 if self.n_signature
.n_params
.length
> 0 then
754 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
757 # Cannot be private or something
758 if not self.n_visibility
isa APublicVisibility then
759 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
766 redef fun build_property
(modelbuilder
, mclassdef
)
768 var n_kwinit
= n_kwinit
769 var n_kwnew
= n_kwnew
770 var is_init
= n_kwinit
!= null or n_kwnew
!= null
772 var amethodid
= self.n_methid
774 if amethodid
== null then
778 else if n_kwinit
!= null then
781 else if n_kwnew
!= null then
787 else if amethodid
isa AIdMethid then
788 name
= amethodid
.n_id
.text
789 name_node
= amethodid
791 # operator, bracket or assign
792 name
= amethodid
.collect_text
793 name_node
= amethodid
795 var arity
= self.n_signature
.n_params
.length
796 if name
== "+" and arity
== 0 then
798 else if name
== "-" and arity
== 0 then
800 else if name
== "~" and arity
== 0 then
803 if amethodid
.is_binary
and arity
!= 1 then
804 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
805 else if amethodid
.min_arity
> arity
then
806 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
811 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
812 var mprop
: nullable MMethod = null
813 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
814 if mprop
== null and look_like_a_root_init
then
815 mprop
= modelbuilder
.the_root_init_mmethod
817 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
818 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
821 if mprop
== null then
822 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
823 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
824 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
825 modelbuilder
.the_root_init_mmethod
= mprop
826 mprop
.is_root_init
= true
828 mprop
.is_init
= is_init
829 mprop
.is_new
= n_kwnew
!= null
830 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
831 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
832 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
833 mprop
.is_broken
= true
837 if mprop
.is_broken
then
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 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
849 mprop
.is_broken
= true
857 mclassdef
.mprop2npropdef
[mprop
] = self
859 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
861 set_doc
(mpropdef
, modelbuilder
)
863 self.mpropdef
= mpropdef
864 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
865 if mpropdef
.is_intro
then
866 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
868 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
872 redef fun build_signature
(modelbuilder
)
874 var mpropdef
= self.mpropdef
875 if mpropdef
== null then return # Error thus skiped
876 var mclassdef
= mpropdef
.mclassdef
877 var mmodule
= mclassdef
.mmodule
878 var nsig
= self.n_signature
880 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
881 var root_init
= mclassdef
.mclass
.root_init
882 if root_init
!= null then
883 # Inherit the initializers by refinement
884 mpropdef
.new_msignature
= root_init
.new_msignature
885 assert mpropdef
.initializers
.is_empty
886 mpropdef
.initializers
.add_all root_init
.initializers
890 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
891 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
893 # Retrieve info from the signature AST
894 var param_names
= new Array[String] # Names of parameters from the AST
895 var param_types
= new Array[MType] # Types of parameters from the AST
897 var ret_type
: nullable MType = null # Return type from the AST
899 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
900 param_names
= nsig
.param_names
901 param_types
= nsig
.param_types
902 vararg_rank
= nsig
.vararg_rank
903 ret_type
= nsig
.ret_type
906 # Look for some signature to inherit
907 # FIXME: do not inherit from the intro, but from the most specific
908 var msignature
: nullable MSignature = null
909 if not mpropdef
.is_intro
then
910 msignature
= mpropdef
.mproperty
.intro
.msignature
911 if msignature
== null then return # Skip error
913 # The local signature is adapted to use the local formal types, if any.
914 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
916 # Check inherited signature arity
917 if param_names
.length
!= msignature
.arity
then
919 if nsig
!= null then node
= nsig
else node
= self
920 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}`.")
923 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
924 # FIXME UGLY: inherit signature from a super-constructor
925 for msupertype
in mclassdef
.supertypes
do
926 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
927 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
928 if candidate
!= null then
929 if msignature
== null then
930 msignature
= candidate
.intro
.as(MMethodDef).msignature
937 # Inherit the signature
938 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
939 # Parameters are untyped, thus inherit them
940 param_types
= new Array[MType]
941 for mparameter
in msignature
.mparameters
do
942 param_types
.add
(mparameter
.mtype
)
944 vararg_rank
= msignature
.vararg_rank
946 if msignature
!= null and ret_type
== null then
947 ret_type
= msignature
.return_mtype
950 if param_names
.length
!= param_types
.length
then
951 # Some parameters are typed, other parameters are not typed.
952 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
956 var mparameters
= new Array[MParameter]
957 for i
in [0..param_names
.length
[ do
958 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
959 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
960 mparameters
.add
(mparameter
)
963 # In `new`-factories, the return type is by default the classtype.
964 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
966 # Special checks for operator methods
967 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
968 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
970 if ret_type
== null and return_is_mandatory
then
971 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
974 msignature
= new MSignature(mparameters
, ret_type
)
975 mpropdef
.msignature
= msignature
976 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
977 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
978 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
981 var at
= self.get_single_annotation
("lazy", modelbuilder
)
982 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
984 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
985 if atautoinit
!= null then
986 if not mpropdef
.is_intro
then
987 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
988 else if not mclassdef
.is_intro
then
989 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
991 self.is_autoinit
= true
996 redef fun check_signature
(modelbuilder
)
998 var mpropdef
= self.mpropdef
999 if mpropdef
== null then return # Error thus skiped
1000 var mclassdef
= mpropdef
.mclassdef
1001 var mmodule
= mclassdef
.mmodule
1002 var nsig
= self.n_signature
1003 var mysignature
= mpropdef
.msignature
1004 if mysignature
== null then return # Error thus skiped
1007 if nsig
!= null then
1008 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1009 mpropdef
.msignature
= null # invalidate
1010 mpropdef
.is_broken
= true
1011 return # Forward error
1015 # Lookup for signature in the precursor
1016 # FIXME all precursors should be considered
1017 if not mpropdef
.is_intro
then
1018 var msignature
= mpropdef
.mproperty
.intro
.msignature
1019 if msignature
== null then return
1021 var precursor_ret_type
= msignature
.return_mtype
1022 var ret_type
= mysignature
.return_mtype
1023 if ret_type
!= null and precursor_ret_type
== null then
1024 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1025 mpropdef
.msignature
= null
1026 mpropdef
.is_broken
= true
1030 if mysignature
.arity
> 0 then
1031 # Check parameters types
1032 for i
in [0..mysignature
.arity
[ do
1033 var myt
= mysignature
.mparameters
[i
].mtype
1034 var prt
= msignature
.mparameters
[i
].mtype
1035 var node
= nsig
.n_params
[i
]
1036 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1037 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1038 mpropdef
.msignature
= null
1039 mpropdef
.is_broken
= true
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 mpropdef
.msignature
= null
1053 mpropdef
.is_broken
= true
1058 if nsig
!= null then
1059 # Check parameters visibility
1060 for i
in [0..mysignature
.arity
[ do
1061 var nt
= nsig
.n_params
[i
].n_type
1062 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1064 var nt
= nsig
.n_type
1065 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1067 check_repeated_types
(modelbuilder
)
1070 # For parameters, type is always useless in a redef.
1071 # For return type, type is useless if not covariant with introduction.
1072 redef fun check_repeated_types
(modelbuilder
) do
1073 var mpropdef
= self.mpropdef
1074 if mpropdef
== null then return
1075 if mpropdef
.is_intro
or n_signature
== null then return
1077 for param
in n_signature
.n_params
do
1078 if param
.n_type
!= null then
1079 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1083 var intro
= mpropdef
.mproperty
.intro
1084 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1085 if n_intro
== null or not n_intro
isa AMethPropdef then return
1087 var ret_type
= n_signature
.ret_type
1088 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1089 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1095 # Is a return required?
1097 # * True for operators and brackets.
1098 # * False for id and assignment.
1099 fun return_is_mandatory
: Bool do return true
1101 # Can the last parameter be special like a vararg?
1103 # * False for operators: the last one is in fact the only one.
1104 # * False for assignments: it is the right part of the assignment.
1105 # * True for ids and brackets.
1106 fun accept_special_last_parameter
: Bool do return false
1108 # The minimum required number of parameters.
1110 # * 1 for binary operators
1112 # * 1 for assignments
1113 # * 2 for bracket assignments
1115 fun min_arity
: Int do return 1
1117 # Is the `self` a binary operator?
1118 fun is_binary
: Bool do return true
1121 redef class AIdMethid
1122 redef fun return_is_mandatory
do return false
1123 redef fun accept_special_last_parameter
do return true
1124 redef fun min_arity
do return 0
1125 redef fun is_binary
do return false
1128 redef class ABraMethid
1129 redef fun accept_special_last_parameter
do return true
1130 redef fun is_binary
do return false
1133 redef class ABraassignMethid
1134 redef fun return_is_mandatory
do return false
1135 redef fun min_arity
do return 2
1136 redef fun is_binary
do return false
1139 redef class AAssignMethid
1140 redef fun return_is_mandatory
do return false
1141 redef fun is_binary
do return false
1144 redef class AAttrPropdef
1145 redef type MPROPDEF: MAttributeDef
1147 # The static type of the property (declared, inferred or inherited)
1148 # This attribute is also used to check if the property was analyzed and is valid.
1149 var mtype
: nullable MType
1151 # Is the node tagged `noinit`?
1154 # Is the node tagged lazy?
1157 # Has the node a default value?
1158 # Could be through `n_expr` or `n_block`
1159 var has_value
= false
1161 # The guard associated to a lazy attribute.
1162 # Because some engines does not have a working `isset`,
1163 # this additional attribute is used to guard the lazy initialization.
1164 # TODO: to remove once isset is correctly implemented
1165 var mlazypropdef
: nullable MAttributeDef
1167 # The associated getter (read accessor) if any
1168 var mreadpropdef
: nullable MMethodDef is writable
1169 # The associated setter (write accessor) if any
1170 var mwritepropdef
: nullable MMethodDef is writable
1172 redef fun build_property
(modelbuilder
, mclassdef
)
1174 var mclass
= mclassdef
.mclass
1176 var name
= nid2
.text
1178 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1179 if atabstract
== null then
1180 if not mclass
.kind
.need_init
then
1181 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1184 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1185 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1186 self.mpropdef
= mpropdef
1187 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1191 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1192 if mreadprop
== null then
1193 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1194 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1195 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1197 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1198 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1200 mclassdef
.mprop2npropdef
[mreadprop
] = self
1202 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1203 self.mreadpropdef
= mreadpropdef
1204 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1205 set_doc
(mreadpropdef
, modelbuilder
)
1206 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1207 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1209 has_value
= n_expr
!= null or n_block
!= null
1211 if atabstract
!= null and has_value
then
1212 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1216 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1217 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1218 if atnoinit
!= null then
1221 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1224 if atabstract
!= null then
1225 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1229 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1230 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1231 if atlazy
!= null or atlateinit
!= null then
1232 if atlazy
!= null and atlateinit
!= null then
1233 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1236 if not has_value
then
1237 if atlazy
!= null then
1238 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1239 else if atlateinit
!= null then
1240 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1246 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1247 mlazyprop
.is_fictive
= true
1248 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1249 mlazypropdef
.is_fictive
= true
1250 self.mlazypropdef
= mlazypropdef
1253 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1254 if atreadonly
!= null then
1255 if not has_value
then
1256 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1258 # No setter, so just leave
1262 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1263 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1266 var writename
= name
+ "="
1267 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1268 if atwritable
!= null then
1269 if not atwritable
.n_args
.is_empty
then
1270 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1273 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1274 var nwkwredef
: nullable Token = null
1275 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1276 if mwriteprop
== null then
1278 if atwritable
!= null then
1279 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1281 mvisibility
= mreadprop
.visibility
1282 # By default, use protected visibility at most
1283 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1285 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1286 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1287 mwriteprop
.deprecation
= mreadprop
.deprecation
1289 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1290 if atwritable
!= null then
1291 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1294 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1296 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1297 self.mwritepropdef
= mwritepropdef
1298 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1299 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1300 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1302 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1303 if atautoinit
!= null then
1305 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1306 else if not mwritepropdef
.is_intro
then
1307 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1308 else if not mclassdef
.is_intro
then
1309 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1310 else if atabstract
== null then
1311 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1313 else if atabstract
!= null then
1314 # By default, abstract attribute are not autoinit
1319 redef fun build_signature
(modelbuilder
)
1321 var mreadpropdef
= self.mreadpropdef
1322 var mpropdef
= self.mpropdef
1323 if mreadpropdef
== null then return # Error thus skipped
1324 var mclassdef
= mreadpropdef
.mclassdef
1325 var mmodule
= mclassdef
.mmodule
1326 var mtype
: nullable MType = null
1329 var ntype
= self.n_type
1330 if ntype
!= null then
1331 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1332 if mtype
== null then return
1335 var inherited_type
: nullable MType = null
1336 # Inherit the type from the getter (usually an abstract getter)
1337 if not mreadpropdef
.is_intro
then
1338 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1339 if msignature
== null then return # Error, thus skipped
1340 inherited_type
= msignature
.return_mtype
1341 if inherited_type
!= null then
1342 # The inherited type is adapted to use the local formal types, if any.
1343 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1344 if mtype
== null then mtype
= inherited_type
1348 var nexpr
= self.n_expr
1349 if mtype
== null then
1350 if nexpr
!= null then
1351 if nexpr
isa ANewExpr then
1352 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1353 else if nexpr
isa AAsCastExpr then
1354 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1355 else if nexpr
isa AIntegerExpr then
1356 var cla
: nullable MClass = null
1357 if nexpr
.value
isa Int then
1358 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1359 else if nexpr
.value
isa Byte then
1360 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1361 else if nexpr
.value
isa Int8 then
1362 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1363 else if nexpr
.value
isa Int16 then
1364 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1365 else if nexpr
.value
isa UInt16 then
1366 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1367 else if nexpr
.value
isa Int32 then
1368 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1369 else if nexpr
.value
isa UInt32 then
1370 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1372 # Should not happen, and should be updated as new types are added
1375 if cla
!= null then mtype
= cla
.mclass_type
1376 else if nexpr
isa AFloatExpr then
1377 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1378 if cla
!= null then mtype
= cla
.mclass_type
1379 else if nexpr
isa ACharExpr then
1380 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1381 if cla
!= null then mtype
= cla
.mclass_type
1382 else if nexpr
isa ABoolExpr then
1383 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1384 if cla
!= null then mtype
= cla
.mclass_type
1385 else if nexpr
isa ASuperstringExpr then
1386 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1387 if cla
!= null then mtype
= cla
.mclass_type
1388 else if nexpr
isa AStringFormExpr then
1389 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1390 if cla
!= null then mtype
= cla
.mclass_type
1392 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1395 if mtype
== null then return
1397 else if ntype
!= null and inherited_type
== mtype
then
1398 if nexpr
isa ANewExpr then
1399 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1400 if xmtype
== mtype
then
1401 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1406 if mtype
== null then
1407 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1413 if mpropdef
!= null then
1414 mpropdef
.static_mtype
= mtype
1418 var msignature
= new MSignature(new Array[MParameter], mtype
)
1419 mreadpropdef
.msignature
= msignature
1422 var mwritepropdef
= self.mwritepropdef
1423 if mwritepropdef
!= null then
1426 var mparameter
= new MParameter(name
, mtype
, false)
1427 var msignature
= new MSignature([mparameter
], null)
1428 mwritepropdef
.msignature
= msignature
1431 var mlazypropdef
= self.mlazypropdef
1432 if mlazypropdef
!= null then
1433 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1435 check_repeated_types
(modelbuilder
)
1438 redef fun check_signature
(modelbuilder
)
1440 var mpropdef
= self.mpropdef
1441 if mpropdef
== null then return # Error thus skipped
1442 var ntype
= self.n_type
1443 var mtype
= self.mtype
1444 if mtype
== null then return # Error thus skipped
1446 var mclassdef
= mpropdef
.mclassdef
1447 var mmodule
= mclassdef
.mmodule
1450 if ntype
!= null then
1451 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1454 if nexpr
isa ANewExpr then
1455 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1458 # Lookup for signature in the precursor
1459 # FIXME all precursors should be considered
1460 if not mpropdef
.is_intro
then
1461 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1462 if precursor_type
== null then return
1464 if mtype
!= precursor_type
then
1465 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1470 # Check getter and setter
1471 var meth
= self.mreadpropdef
1472 if meth
!= null then
1473 self.check_method_signature
(modelbuilder
, meth
)
1474 var node
: nullable ANode = ntype
1475 if node
== null then node
= self
1476 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1478 meth
= self.mwritepropdef
1479 if meth
!= null then
1480 self.check_method_signature
(modelbuilder
, meth
)
1481 var node
: nullable ANode = ntype
1482 if node
== null then node
= self
1483 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1487 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1489 var mclassdef
= mpropdef
.mclassdef
1490 var mmodule
= mclassdef
.mmodule
1491 var nsig
= self.n_type
1492 var mysignature
= mpropdef
.msignature
1493 if mysignature
== null then return # Error thus skiped
1495 # Lookup for signature in the precursor
1496 # FIXME all precursors should be considered
1497 if not mpropdef
.is_intro
then
1498 var msignature
= mpropdef
.mproperty
.intro
.msignature
1499 if msignature
== null then return
1501 if mysignature
.arity
!= msignature
.arity
then
1503 if nsig
!= null then node
= nsig
else node
= self
1504 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}`.")
1507 var precursor_ret_type
= msignature
.return_mtype
1508 var ret_type
= mysignature
.return_mtype
1509 if ret_type
!= null and precursor_ret_type
== null then
1511 if nsig
!= null then node
= nsig
else node
= self
1512 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1516 if mysignature
.arity
> 0 then
1517 # Check parameters types
1518 for i
in [0..mysignature
.arity
[ do
1519 var myt
= mysignature
.mparameters
[i
].mtype
1520 var prt
= msignature
.mparameters
[i
].mtype
1522 if nsig
!= null then node
= nsig
else node
= self
1523 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1524 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1528 if precursor_ret_type
!= null then
1530 if nsig
!= null then node
= nsig
else node
= self
1531 if ret_type
== null then
1532 # Inherit the return type
1533 ret_type
= precursor_ret_type
1534 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1535 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1541 # Type is useless if the attribute type is the same thant the intro.
1542 redef fun check_repeated_types
(modelbuilder
) do
1543 var mreadpropdef
= self.mreadpropdef
1544 if mreadpropdef
== null then return
1545 if mreadpropdef
.is_intro
or n_type
== null then return
1547 var intro
= mreadpropdef
.mproperty
.intro
1548 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1549 if n_intro
== null then return
1552 if n_intro
isa AMethPropdef then
1553 ntype
= n_intro
.n_signature
.ret_type
1554 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1555 ntype
= n_intro
.n_type
.mtype
1558 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1559 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1563 redef class ATypePropdef
1564 redef type MPROPDEF: MVirtualTypeDef
1566 redef fun build_property
(modelbuilder
, mclassdef
)
1568 var name
= self.n_qid
.n_id
.text
1569 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1570 if mprop
== null then
1571 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1572 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1573 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1574 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1578 assert mprop
isa MVirtualTypeProp
1579 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1582 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1583 self.mpropdef
= mpropdef
1584 if mpropdef
.is_intro
then
1585 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1587 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1589 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1590 mpropdef
.is_broken
=true
1592 mclassdef
.mprop2npropdef
[mprop
] = self
1593 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1594 set_doc
(mpropdef
, modelbuilder
)
1596 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1597 if atfixed
!= null then
1598 mpropdef
.is_fixed
= true
1602 redef fun build_signature
(modelbuilder
)
1604 var mpropdef
= self.mpropdef
1605 if mpropdef
== null then return # Error thus skipped
1606 var mclassdef
= mpropdef
.mclassdef
1607 var mmodule
= mclassdef
.mmodule
1608 var mtype
: nullable MType = null
1610 var ntype
= self.n_type
1611 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1612 if mtype
== null then return
1614 mpropdef
.bound
= mtype
1615 # print "{mpropdef}: {mtype}"
1618 redef fun check_signature
(modelbuilder
)
1620 var mpropdef
= self.mpropdef
1621 if mpropdef
== null then return # Error thus skipped
1623 var bound
= mpropdef
.bound
1624 if bound
== null then return # Error thus skipped
1626 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1628 var mclassdef
= mpropdef
.mclassdef
1629 var mmodule
= mclassdef
.mmodule
1630 var anchor
= mclassdef
.bound_mtype
1632 var ntype
= self.n_type
1633 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1634 mpropdef
.bound
= null
1638 # Check redefinitions
1639 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1640 var supbound
= p
.bound
1641 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1643 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1646 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1647 # Still a warning to pass existing bad code
1648 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1651 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1652 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")