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 # Fall back to the class node if any.
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
64 # Retrieve all the attributes nodes localy definied
65 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
66 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
68 var res
= new Array[AAttrPropdef]
69 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
70 if n
== null then return res
71 for npropdef
in n
.n_propdefs
do
72 if npropdef
isa AAttrPropdef then
73 # Run the phases on it
74 toolcontext
.run_phases_on_npropdef
(npropdef
)
81 # Build the properties of `nclassdef`.
82 # REQUIRE: all superclasses are built.
83 private fun build_properties
(nclassdef
: AClassdef)
85 # Force building recursively
86 if nclassdef
.build_properties_is_done
then return
87 nclassdef
.build_properties_is_done
= true
88 var mclassdef
= nclassdef
.mclassdef
89 if mclassdef
== null then return # skip error
90 if mclassdef
.in_hierarchy
== null then return # Skip error
91 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
92 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
93 build_properties
(mclassdef2nclassdef
[superclassdef
])
96 mclassdef
.build_self_type
(self, nclassdef
)
97 for nclassdef2
in nclassdef
.all_defs
do
98 for npropdef
in nclassdef2
.n_propdefs
do
99 npropdef
.build_property
(self, mclassdef
)
101 for npropdef
in nclassdef2
.n_propdefs
do
102 npropdef
.build_signature
(self)
104 for npropdef
in nclassdef2
.n_propdefs
do
105 if not npropdef
isa ATypePropdef then continue
107 var mpropdef
= npropdef
.mpropdef
108 if mpropdef
== null then continue
109 if mpropdef
.bound
== null then continue
110 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
111 # Invalidate the bound
112 mpropdef
.is_broken
= true
113 mpropdef
.bound
= new MBottomType(mclassdef
.mmodule
.model
)
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 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
156 the_root_init_mmethod
= mprop
160 # Is there already a constructor defined?
161 var defined_init
: nullable MMethodDef = null
162 for mpropdef
in mclassdef
.mpropdefs
do
163 if not mpropdef
isa MMethodDef then continue
164 if not mpropdef
.mproperty
.is_init
then continue
165 if mpropdef
.mproperty
.is_root_init
then
166 assert defined_init
== null
167 defined_init
= mpropdef
168 else if mpropdef
.mproperty
.name
== "autoinit" then
169 # An explicit old-style init named "init", so return
174 if not nclassdef
isa AStdClassdef then return
176 # Collect undefined attributes
177 var mparameters
= new Array[MParameter]
178 var initializers
= new Array[MProperty]
179 for npropdef
in nclassdef
.n_propdefs
do
180 if npropdef
isa AMethPropdef then
181 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
182 var mpropdef
= npropdef
.mpropdef
183 if mpropdef
== null then return # Skip broken method
184 var sig
= mpropdef
.msignature
185 if sig
== null then continue # Skip broken method
187 mparameters
.add_all sig
.mparameters
188 initializers
.add
(mpropdef
.mproperty
)
189 mpropdef
.mproperty
.is_autoinit
= true
191 if npropdef
isa AAttrPropdef then
192 var mreadpropdef
= npropdef
.mreadpropdef
193 if mreadpropdef
== null then return # Skip broken attribute
194 var msignature
= mreadpropdef
.msignature
195 if msignature
== null then return # Skip broken attribute
196 if npropdef
.noinit
then continue # Skip noinit attribute
197 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
198 if atlateinit
!= null then
199 # For lateinit attributes, call the reader to force
200 # the lazy initialization of the attribute.
201 initializers
.add
(mreadpropdef
.mproperty
)
202 mreadpropdef
.mproperty
.is_autoinit
= true
205 if npropdef
.has_value
then continue
206 var paramname
= mreadpropdef
.mproperty
.name
207 var ret_type
= msignature
.return_mtype
208 if ret_type
== null then return
209 var mparameter
= new MParameter(paramname
, ret_type
, false)
210 mparameters
.add
(mparameter
)
211 var msetter
= npropdef
.mwritepropdef
212 if msetter
== null then
213 # No setter, it is a readonly attribute, so just add it
214 initializers
.add
(npropdef
.mpropdef
.mproperty
)
215 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
217 # Add the setter to the list
218 initializers
.add
(msetter
.mproperty
)
219 msetter
.mproperty
.is_autoinit
= true
224 var the_root_init_mmethod
= self.the_root_init_mmethod
225 if the_root_init_mmethod
== null then return
227 # Look for most-specific new-stype init definitions
228 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
229 if spropdefs
.is_empty
then
230 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
234 # Look at the autoinit class-annotation
235 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
236 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
237 if autoinit
!= null then
238 # Just throws the collected initializers
242 if noautoinit
!= null then
243 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
246 if autoinit
.n_args
.is_empty
then
247 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
250 # Get and check each argument
251 for narg
in autoinit
.n_args
do
254 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
258 # Search the property.
259 # To avoid bad surprises, try to get the setter first.
260 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
262 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
265 error
(narg
, "Error: unknown method `{id}`")
268 if not p
.is_autoinit
then
269 error
(narg
, "Error: `{p}` is not an autoinit method")
273 # Register the initializer and the parameters
276 if pd
isa MMethodDef then
277 # Get the signature resolved for the current receiver
278 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
279 mparameters
.add_all
(sig
.mparameters
)
286 # Search the longest-one and checks for conflict
287 var longest
= spropdefs
.first
288 if spropdefs
.length
> 1 then
289 # part 1. find the longest list
290 for spd
in spropdefs
do
291 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
294 # Check for conflict in the order of initializers
295 # Each initializer list must me a prefix of the longest list
296 # If `noautoinit` is set, just ignore conflicts
297 if noautoinit
== null then for spd
in spropdefs
do
299 for p
in spd
.initializers
do
300 if p
!= longest
.initializers
[i
] then
301 var proposal
= new ArraySet[MProperty]
302 for spd2
in spropdefs
do
303 proposal
.add_all spd2
.initializers
305 proposal
.add_all initializers
306 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(", ")}`")
307 # TODO: invalidate the initializer to avoid more errors
315 if noautoinit
!= null then
316 # If there is local or inherited initializers, then complain.
317 if initializers
.is_empty
and longest
.initializers
.is_empty
then
318 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
320 # Just clear initializers
324 # Can we just inherit?
325 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
326 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
327 mclassdef
.mclass
.root_init
= longest
331 # Combine the inherited list to what is collected
332 if longest
.initializers
.length
> 0 then
333 mparameters
.prepend longest
.new_msignature
.mparameters
334 initializers
.prepend longest
.initializers
339 # If we already have a basic init definition, then setup its initializers
340 if defined_init
!= null then
341 defined_init
.initializers
.add_all
(initializers
)
342 var msignature
= new MSignature(mparameters
, null)
343 defined_init
.new_msignature
= msignature
344 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
345 mclassdef
.mclass
.root_init
= defined_init
349 # Else create the local implicit basic init definition
350 var mprop
= the_root_init_mmethod
351 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
352 mpropdef
.has_supercall
= true
353 mpropdef
.initializers
.add_all
(initializers
)
354 var msignature
= new MSignature(mparameters
, null)
355 mpropdef
.new_msignature
= msignature
356 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
357 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
358 mclassdef
.mclass
.root_init
= mpropdef
361 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
362 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
364 var mmodule
= mpropdef
.mclassdef
.mmodule
365 var mproperty
= mpropdef
.mproperty
367 # Extract visibility information of the main part of `mtype`
368 # It is a case-by case
369 var vis_type
: nullable MVisibility = null # The own visibility of the type
370 var mmodule_type
: nullable MModule = null # The original module of the type
371 mtype
= mtype
.undecorate
372 if mtype
isa MClassType then
373 vis_type
= mtype
.mclass
.visibility
374 mmodule_type
= mtype
.mclass
.intro_mmodule
375 else if mtype
isa MVirtualType then
376 vis_type
= mtype
.mproperty
.visibility
377 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
378 else if mtype
isa MParameterType then
379 # nothing, always visible
380 else if mtype
isa MNullType then
382 else if mtype
isa MBottomType then
385 node
.debug
"Unexpected type {mtype}"
389 if vis_type
!= null then
390 assert mmodule_type
!= null
391 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
392 if mproperty
.visibility
> vis_type
then
393 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
395 else if mproperty
.visibility
> vis_module_type
then
396 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
401 # No error, try to go deeper in generic types
402 if node
isa AType then
403 for a
in node
.n_types
do
405 if t
== null then continue # Error, thus skipped
406 check_visibility
(a
, t
, mpropdef
)
408 else if mtype
isa MGenericType then
409 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
413 # Detect circularity errors for virtual types.
414 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
417 # Slow case: progress on each resolution until we visit all without getting a loop
419 # The graph used to detect loops
420 var mtype
= mproperty
.mvirtualtype
421 var poset
= new POSet[MType]
423 # The work-list of types to resolve
424 var todo
= new List[MType]
427 while not todo
.is_empty
do
431 if not t
.need_anchor
then continue
433 # Get the types derived of `t` (subtypes and bounds)
435 if t
isa MNullableType then
437 else if t
isa MGenericType then
439 else if t
isa MVirtualType then
441 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
442 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
443 if defs
.is_empty
then return false
444 nexts
= new Array[MType]
446 var next
= defs
.first
.bound
447 if next
== null then return false
450 else if t
isa MClassType then
451 # Basic type, nothing to to
453 else if t
isa MParameterType then
454 # Parameter types cannot depend on virtual types, so nothing to do
462 if poset
.has_edge
(next
, t
) then
463 if mtype
== next
then
464 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
466 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
470 poset
.add_edge
(t
, next
)
480 # Does the MPropDef contains a call to super or a call of a super-constructor?
481 # Subsequent phases of the frontend (esp. typing) set it if required
482 var has_supercall
: Bool = false is writable
485 redef class AClassdef
486 # Marker used in `ModelBuilder::build_properties`
487 private var build_properties_is_done
= false
491 # The base init of the class.
492 # Used to get the common new_msignature and initializers
494 # TODO: Where to put this information is not clear because unlike other
495 # informations, the initialisers are stable in a same class.
496 var root_init
: nullable MMethodDef = null
499 redef class MClassDef
500 # What is the `APropdef` associated to a `MProperty`?
501 # Used to check multiple definition of a property.
502 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
504 # Build the virtual type `SELF` only for introduction `MClassDef`
505 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
507 if not is_intro
then return
510 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
512 # If SELF type is declared nowherer?
513 if mprop
== null then return
515 # SELF is not a virtual type? it is weird but we ignore it
516 if not mprop
isa MVirtualTypeProp then return
518 # Is this the intro of SELF in the library?
519 var intro
= mprop
.intro
520 var intro_mclassdef
= intro
.mclassdef
521 if intro_mclassdef
== self then
522 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
524 # SELF must be declared in Object, otherwise this will create conflicts
525 if intro_mclassdef
.mclass
.name
!= "Object" then
526 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
529 # SELF must be public
530 if mprop
.visibility
!= public_visibility
then
531 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
534 # SELF must not be fixed
535 if intro
.is_fixed
then
536 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
542 # This class introduction inherits a SELF
543 # We insert an artificial property to update it
544 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
545 mpropdef
.bound
= mclass
.mclass_type
550 # The associated main model entity
551 type MPROPDEF: MPropDef
553 # The associated propdef once build by a `ModelBuilder`
554 var mpropdef
: nullable MPROPDEF is writable
556 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
557 private fun build_signature
(modelbuilder
: ModelBuilder) do end
558 private fun check_signature
(modelbuilder
: ModelBuilder) do end
559 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
561 var mvisibility
= public_visibility
562 if nvisibility
!= null then
563 mvisibility
= nvisibility
.mvisibility
564 if mvisibility
== intrude_visibility
then
565 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
566 mvisibility
= public_visibility
569 if mclassdef
.mclass
.visibility
== private_visibility
then
570 if mvisibility
== protected_visibility
then
571 assert nvisibility
!= null
572 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
573 else if mvisibility
== private_visibility
then
574 assert nvisibility
!= null
575 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
577 mvisibility
= private_visibility
582 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
584 var ndoc
= self.n_doc
586 var mdoc
= ndoc
.to_mdoc
588 mdoc
.original_mentity
= mpropdef
589 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
590 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
593 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
594 if at_deprecated
!= null then
595 if not mpropdef
.is_intro
then
596 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
598 var info
= new MDeprecationInfo
599 ndoc
= at_deprecated
.n_doc
600 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
601 mpropdef
.mproperty
.deprecation
= info
606 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
608 if nvisibility
== null then return
609 var mvisibility
= nvisibility
.mvisibility
610 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
611 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
615 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
617 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
618 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
621 if mprop
isa MMethod and mprop
.is_root_init
then return true
622 if kwredef
== null then
624 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
628 # Check for full-name conflicts in the package.
629 # A public property should have a unique qualified name `package::class::prop`.
630 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
631 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
632 if others
!= null then for other
in others
do
633 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
634 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}`.")
640 if not need_redef
then
641 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
648 # Checks for useless type in redef signatures.
649 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
652 redef class ASignature
653 # Is the model builder has correctly visited the signature
654 var is_visited
= false
655 # Names of parameters from the AST
656 # REQUIRE: is_visited
657 var param_names
= new Array[String]
658 # Types of parameters from the AST
659 # REQUIRE: is_visited
660 var param_types
= new Array[MType]
661 # Rank of the vararg (of -1 if none)
662 # REQUIRE: is_visited
663 var vararg_rank
: Int = -1
665 var ret_type
: nullable MType = null
667 # Visit and fill information about a signature
668 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
670 var mmodule
= mclassdef
.mmodule
671 var param_names
= self.param_names
672 var param_types
= self.param_types
673 for np
in self.n_params
do
674 param_names
.add
(np
.n_id
.text
)
675 var ntype
= np
.n_type
676 if ntype
!= null then
677 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
678 if mtype
== null then return false # Skip error
679 for i
in [0..param_names
.length-param_types
.length
[ do
680 param_types
.add
(mtype
)
682 if np
.n_dotdotdot
!= null then
683 if self.vararg_rank
!= -1 then
684 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
687 self.vararg_rank
= param_names
.length
- 1
692 var ntype
= self.n_type
693 if ntype
!= null then
694 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
695 if self.ret_type
== null then return false # Skip error
698 self.is_visited
= true
702 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
705 for np
in self.n_params
do
706 var ntype
= np
.n_type
707 if ntype
!= null then
708 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
713 var ntype
= self.n_type
714 if ntype
!= null then
715 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
719 if not res
then is_broken
= true
725 # The associated mparameter if any
726 var mparameter
: nullable MParameter = null
729 redef class AMethPropdef
730 redef type MPROPDEF: MMethodDef
732 # Is the method annotated `autoinit`?
733 var is_autoinit
= false
735 # Can self be used as a root init?
736 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
738 # Need the `init` keyword
739 if n_kwinit
== null then return false
740 # Need to by anonymous
741 if self.n_methid
!= null then return false
742 # No annotation on itself
743 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
745 var amod
= self.parent
.parent
.as(AModule)
746 var amoddecl
= amod
.n_moduledecl
747 if amoddecl
!= null then
748 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
749 if old
!= null then return false
752 if self.n_signature
.n_params
.length
> 0 then
753 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
756 # Cannot be private or something
757 if not self.n_visibility
isa APublicVisibility then
758 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
765 redef fun build_property
(modelbuilder
, mclassdef
)
767 var n_kwinit
= n_kwinit
768 var n_kwnew
= n_kwnew
769 var is_init
= n_kwinit
!= null or n_kwnew
!= null
771 var amethodid
= self.n_methid
773 if amethodid
== null then
777 else if n_kwinit
!= null then
780 if self.n_signature
.n_params
.not_empty
or get_single_annotation
("old_style_init", modelbuilder
) != null then
783 else if n_kwnew
!= null then
789 else if amethodid
isa AIdMethid then
790 name
= amethodid
.n_id
.text
791 name_node
= amethodid
793 # operator, bracket or assign
794 name
= amethodid
.collect_text
795 name_node
= amethodid
797 var arity
= self.n_signature
.n_params
.length
798 if name
== "+" and arity
== 0 then
800 else if name
== "-" and arity
== 0 then
802 else if name
== "~" and arity
== 0 then
805 if amethodid
.is_binary
and arity
!= 1 then
806 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
807 else if amethodid
.min_arity
> arity
then
808 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
813 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
814 var mprop
: nullable MMethod = null
815 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
816 if mprop
== null and look_like_a_root_init
then
817 mprop
= modelbuilder
.the_root_init_mmethod
819 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
820 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
823 if mprop
== null then
824 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
825 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
826 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
827 modelbuilder
.the_root_init_mmethod
= mprop
828 mprop
.is_root_init
= true
830 mprop
.is_init
= is_init
831 mprop
.is_new
= n_kwnew
!= null
832 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
833 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
834 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
835 mprop
.is_broken
= true
839 if mprop
.is_broken
then
842 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
843 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
846 # Check name conflicts in the local class for constructors.
848 for p
, n
in mclassdef
.mprop2npropdef
do
849 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
850 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
851 mprop
.is_broken
= true
859 mclassdef
.mprop2npropdef
[mprop
] = self
861 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
863 set_doc
(mpropdef
, modelbuilder
)
865 self.mpropdef
= mpropdef
866 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
867 if mpropdef
.is_intro
then
868 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
870 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
874 redef fun build_signature
(modelbuilder
)
876 var mpropdef
= self.mpropdef
877 if mpropdef
== null then return # Error thus skiped
878 var mclassdef
= mpropdef
.mclassdef
879 var mmodule
= mclassdef
.mmodule
880 var nsig
= self.n_signature
882 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
883 var root_init
= mclassdef
.mclass
.root_init
884 if root_init
!= null then
885 # Inherit the initializers by refinement
886 mpropdef
.new_msignature
= root_init
.new_msignature
887 assert mpropdef
.initializers
.is_empty
888 mpropdef
.initializers
.add_all root_init
.initializers
892 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
893 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
895 # Retrieve info from the signature AST
896 var param_names
= new Array[String] # Names of parameters from the AST
897 var param_types
= new Array[MType] # Types of parameters from the AST
899 var ret_type
: nullable MType = null # Return type from the AST
901 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
902 param_names
= nsig
.param_names
903 param_types
= nsig
.param_types
904 vararg_rank
= nsig
.vararg_rank
905 ret_type
= nsig
.ret_type
908 # Look for some signature to inherit
909 # FIXME: do not inherit from the intro, but from the most specific
910 var msignature
: nullable MSignature = null
911 if not mpropdef
.is_intro
then
912 msignature
= mpropdef
.mproperty
.intro
.msignature
913 if msignature
== null then return # Skip error
915 # The local signature is adapted to use the local formal types, if any.
916 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
918 # Check inherited signature arity
919 if param_names
.length
!= msignature
.arity
then
921 if nsig
!= null then node
= nsig
else node
= self
922 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}`.")
925 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
926 # FIXME UGLY: inherit signature from a super-constructor
927 for msupertype
in mclassdef
.supertypes
do
928 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
929 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
930 if candidate
!= null then
931 if msignature
== null then
932 msignature
= candidate
.intro
.as(MMethodDef).msignature
939 # Inherit the signature
940 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
941 # Parameters are untyped, thus inherit them
942 param_types
= new Array[MType]
943 for mparameter
in msignature
.mparameters
do
944 param_types
.add
(mparameter
.mtype
)
946 vararg_rank
= msignature
.vararg_rank
948 if msignature
!= null and ret_type
== null then
949 ret_type
= msignature
.return_mtype
952 if param_names
.length
!= param_types
.length
then
953 # Some parameters are typed, other parameters are not typed.
954 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
958 var mparameters
= new Array[MParameter]
959 for i
in [0..param_names
.length
[ do
960 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
961 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
962 mparameters
.add
(mparameter
)
965 # In `new`-factories, the return type is by default the classtype.
966 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
968 # Special checks for operator methods
969 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
970 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
972 if ret_type
== null and return_is_mandatory
then
973 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
976 msignature
= new MSignature(mparameters
, ret_type
)
977 mpropdef
.msignature
= msignature
978 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
979 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
980 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
983 var at
= self.get_single_annotation
("lazy", modelbuilder
)
984 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
986 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
987 if atautoinit
!= null then
988 if not mpropdef
.is_intro
then
989 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
990 else if not mclassdef
.is_intro
then
991 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
993 self.is_autoinit
= true
998 redef fun check_signature
(modelbuilder
)
1000 var mpropdef
= self.mpropdef
1001 if mpropdef
== null then return # Error thus skiped
1002 var mclassdef
= mpropdef
.mclassdef
1003 var mmodule
= mclassdef
.mmodule
1004 var nsig
= self.n_signature
1005 var mysignature
= mpropdef
.msignature
1006 if mysignature
== null then return # Error thus skiped
1009 if nsig
!= null then
1010 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1011 mpropdef
.msignature
= null # invalidate
1012 mpropdef
.is_broken
= true
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
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1027 mpropdef
.msignature
= null
1028 mpropdef
.is_broken
= true
1032 if mysignature
.arity
> 0 then
1033 # Check parameters types
1034 for i
in [0..mysignature
.arity
[ do
1035 var myt
= mysignature
.mparameters
[i
].mtype
1036 var prt
= msignature
.mparameters
[i
].mtype
1037 var node
= nsig
.n_params
[i
]
1038 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1039 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1040 mpropdef
.msignature
= null
1041 mpropdef
.is_broken
= true
1045 if precursor_ret_type
!= null then
1046 var node
: nullable ANode = null
1047 if nsig
!= null then node
= nsig
.n_type
1048 if node
== null then node
= self
1049 if ret_type
== null then
1050 # Inherit the return type
1051 ret_type
= precursor_ret_type
1052 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1053 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1054 mpropdef
.msignature
= null
1055 mpropdef
.is_broken
= true
1060 if nsig
!= null then
1061 # Check parameters visibility
1062 for i
in [0..mysignature
.arity
[ do
1063 var nt
= nsig
.n_params
[i
].n_type
1064 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1066 var nt
= nsig
.n_type
1067 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1069 check_repeated_types
(modelbuilder
)
1072 # For parameters, type is always useless in a redef.
1073 # For return type, type is useless if not covariant with introduction.
1074 redef fun check_repeated_types
(modelbuilder
) do
1075 var mpropdef
= self.mpropdef
1076 if mpropdef
== null then return
1077 if mpropdef
.is_intro
or n_signature
== null then return
1079 for param
in n_signature
.n_params
do
1080 if param
.n_type
!= null then
1081 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1085 var intro
= mpropdef
.mproperty
.intro
1086 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1087 if n_intro
== null or not n_intro
isa AMethPropdef then return
1089 var ret_type
= n_signature
.ret_type
1090 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1091 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1097 # Is a return required?
1099 # * True for operators and brackets.
1100 # * False for id and assignment.
1101 fun return_is_mandatory
: Bool do return true
1103 # Can the last parameter be special like a vararg?
1105 # * False for operators: the last one is in fact the only one.
1106 # * False for assignments: it is the right part of the assignment.
1107 # * True for ids and brackets.
1108 fun accept_special_last_parameter
: Bool do return false
1110 # The minimum required number of parameters.
1112 # * 1 for binary operators
1114 # * 1 for assignments
1115 # * 2 for bracket assignments
1117 fun min_arity
: Int do return 1
1119 # Is the `self` a binary operator?
1120 fun is_binary
: Bool do return true
1123 redef class AIdMethid
1124 redef fun return_is_mandatory
do return false
1125 redef fun accept_special_last_parameter
do return true
1126 redef fun min_arity
do return 0
1127 redef fun is_binary
do return false
1130 redef class ABraMethid
1131 redef fun accept_special_last_parameter
do return true
1132 redef fun is_binary
do return false
1135 redef class ABraassignMethid
1136 redef fun return_is_mandatory
do return false
1137 redef fun min_arity
do return 2
1138 redef fun is_binary
do return false
1141 redef class AAssignMethid
1142 redef fun return_is_mandatory
do return false
1143 redef fun is_binary
do return false
1146 redef class AAttrPropdef
1147 redef type MPROPDEF: MAttributeDef
1149 # The static type of the property (declared, inferred or inherited)
1150 # This attribute is also used to check if the property was analyzed and is valid.
1151 var mtype
: nullable MType
1153 # Is the node tagged `noinit`?
1156 # Is the node tagged lazy?
1159 # Has the node a default value?
1160 # Could be through `n_expr` or `n_block`
1161 var has_value
= false
1163 # The guard associated to a lazy attribute.
1164 # Because some engines does not have a working `isset`,
1165 # this additional attribute is used to guard the lazy initialization.
1166 # TODO: to remove once isset is correctly implemented
1167 var mlazypropdef
: nullable MAttributeDef
1169 # The associated getter (read accessor) if any
1170 var mreadpropdef
: nullable MMethodDef is writable
1171 # The associated setter (write accessor) if any
1172 var mwritepropdef
: nullable MMethodDef is writable
1174 redef fun build_property
(modelbuilder
, mclassdef
)
1176 var mclass
= mclassdef
.mclass
1178 var name
= nid2
.text
1180 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1181 if atabstract
== null then
1182 if not mclass
.kind
.need_init
then
1183 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1186 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1187 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1188 self.mpropdef
= mpropdef
1189 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1193 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1194 if mreadprop
== null then
1195 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1196 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1197 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1199 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1200 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1202 mclassdef
.mprop2npropdef
[mreadprop
] = self
1204 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1205 self.mreadpropdef
= mreadpropdef
1206 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1207 set_doc
(mreadpropdef
, modelbuilder
)
1208 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1209 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1211 has_value
= n_expr
!= null or n_block
!= null
1213 if atabstract
!= null and has_value
then
1214 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1218 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1219 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1220 if atnoinit
!= null then
1223 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1226 if atabstract
!= null then
1227 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1231 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1232 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1233 if atlazy
!= null or atlateinit
!= null then
1234 if atlazy
!= null and atlateinit
!= null then
1235 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1238 if not has_value
then
1239 if atlazy
!= null then
1240 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1241 else if atlateinit
!= null then
1242 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1248 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1249 mlazyprop
.is_fictive
= true
1250 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1251 mlazypropdef
.is_fictive
= true
1252 self.mlazypropdef
= mlazypropdef
1255 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1256 if atreadonly
!= null then
1257 if not has_value
then
1258 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1260 # No setter, so just leave
1264 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1265 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1268 var writename
= name
+ "="
1269 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1270 if atwritable
!= null then
1271 if not atwritable
.n_args
.is_empty
then
1272 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1275 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1276 var nwkwredef
: nullable Token = null
1277 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1278 if mwriteprop
== null then
1280 if atwritable
!= null then
1281 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1283 mvisibility
= mreadprop
.visibility
1284 # By default, use protected visibility at most
1285 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1287 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1288 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1289 mwriteprop
.deprecation
= mreadprop
.deprecation
1291 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1292 if atwritable
!= null then
1293 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1296 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1298 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1299 self.mwritepropdef
= mwritepropdef
1300 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1301 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1302 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1304 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1305 if atautoinit
!= null then
1307 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1308 else if not mwritepropdef
.is_intro
then
1309 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1310 else if not mclassdef
.is_intro
then
1311 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1312 else if atabstract
== null then
1313 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1315 else if atabstract
!= null then
1316 # By default, abstract attribute are not autoinit
1321 redef fun build_signature
(modelbuilder
)
1323 var mreadpropdef
= self.mreadpropdef
1324 var mpropdef
= self.mpropdef
1325 if mreadpropdef
== null then return # Error thus skipped
1326 var mclassdef
= mreadpropdef
.mclassdef
1327 var mmodule
= mclassdef
.mmodule
1328 var mtype
: nullable MType = null
1331 var ntype
= self.n_type
1332 if ntype
!= null then
1333 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1334 if mtype
== null then return
1337 var inherited_type
: nullable MType = null
1338 # Inherit the type from the getter (usually an abstract getter)
1339 if not mreadpropdef
.is_intro
then
1340 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1341 if msignature
== null then return # Error, thus skipped
1342 inherited_type
= msignature
.return_mtype
1343 if inherited_type
!= null then
1344 # The inherited type is adapted to use the local formal types, if any.
1345 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1346 if mtype
== null then mtype
= inherited_type
1350 var nexpr
= self.n_expr
1351 if mtype
== null then
1352 if nexpr
!= null then
1353 if nexpr
isa ANewExpr then
1354 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1355 else if nexpr
isa AAsCastExpr then
1356 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1357 else if nexpr
isa AIntegerExpr then
1358 var cla
: nullable MClass = null
1359 if nexpr
.value
isa Int then
1360 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1361 else if nexpr
.value
isa Byte then
1362 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1363 else if nexpr
.value
isa Int8 then
1364 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1365 else if nexpr
.value
isa Int16 then
1366 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1367 else if nexpr
.value
isa UInt16 then
1368 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1369 else if nexpr
.value
isa Int32 then
1370 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1371 else if nexpr
.value
isa UInt32 then
1372 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1374 # Should not happen, and should be updated as new types are added
1377 if cla
!= null then mtype
= cla
.mclass_type
1378 else if nexpr
isa AFloatExpr then
1379 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1380 if cla
!= null then mtype
= cla
.mclass_type
1381 else if nexpr
isa ACharExpr then
1382 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1383 if cla
!= null then mtype
= cla
.mclass_type
1384 else if nexpr
isa ABoolExpr then
1385 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1386 if cla
!= null then mtype
= cla
.mclass_type
1387 else if nexpr
isa ASuperstringExpr then
1388 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1389 if cla
!= null then mtype
= cla
.mclass_type
1390 else if nexpr
isa AStringFormExpr then
1391 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1392 if cla
!= null then mtype
= cla
.mclass_type
1394 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1397 if mtype
== null then return
1399 else if ntype
!= null and inherited_type
== mtype
then
1400 if nexpr
isa ANewExpr then
1401 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1402 if xmtype
== mtype
then
1403 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1408 if mtype
== null then
1409 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1415 if mpropdef
!= null then
1416 mpropdef
.static_mtype
= mtype
1420 var msignature
= new MSignature(new Array[MParameter], mtype
)
1421 mreadpropdef
.msignature
= msignature
1424 var mwritepropdef
= self.mwritepropdef
1425 if mwritepropdef
!= null then
1428 var mparameter
= new MParameter(name
, mtype
, false)
1429 var msignature
= new MSignature([mparameter
], null)
1430 mwritepropdef
.msignature
= msignature
1433 var mlazypropdef
= self.mlazypropdef
1434 if mlazypropdef
!= null then
1435 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1437 check_repeated_types
(modelbuilder
)
1440 redef fun check_signature
(modelbuilder
)
1442 var mpropdef
= self.mpropdef
1443 if mpropdef
== null then return # Error thus skipped
1444 var ntype
= self.n_type
1445 var mtype
= self.mtype
1446 if mtype
== null then return # Error thus skipped
1448 var mclassdef
= mpropdef
.mclassdef
1449 var mmodule
= mclassdef
.mmodule
1452 if ntype
!= null then
1453 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1456 if nexpr
isa ANewExpr then
1457 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1460 # Lookup for signature in the precursor
1461 # FIXME all precursors should be considered
1462 if not mpropdef
.is_intro
then
1463 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1464 if precursor_type
== null then return
1466 if mtype
!= precursor_type
then
1467 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1472 # Check getter and setter
1473 var meth
= self.mreadpropdef
1474 if meth
!= null then
1475 self.check_method_signature
(modelbuilder
, meth
)
1476 var node
: nullable ANode = ntype
1477 if node
== null then node
= self
1478 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1480 meth
= self.mwritepropdef
1481 if meth
!= null then
1482 self.check_method_signature
(modelbuilder
, meth
)
1483 var node
: nullable ANode = ntype
1484 if node
== null then node
= self
1485 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1489 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1491 var mclassdef
= mpropdef
.mclassdef
1492 var mmodule
= mclassdef
.mmodule
1493 var nsig
= self.n_type
1494 var mysignature
= mpropdef
.msignature
1495 if mysignature
== null then return # Error thus skiped
1497 # Lookup for signature in the precursor
1498 # FIXME all precursors should be considered
1499 if not mpropdef
.is_intro
then
1500 var msignature
= mpropdef
.mproperty
.intro
.msignature
1501 if msignature
== null then return
1503 if mysignature
.arity
!= msignature
.arity
then
1505 if nsig
!= null then node
= nsig
else node
= self
1506 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}`.")
1509 var precursor_ret_type
= msignature
.return_mtype
1510 var ret_type
= mysignature
.return_mtype
1511 if ret_type
!= null and precursor_ret_type
== null then
1513 if nsig
!= null then node
= nsig
else node
= self
1514 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1518 if mysignature
.arity
> 0 then
1519 # Check parameters types
1520 for i
in [0..mysignature
.arity
[ do
1521 var myt
= mysignature
.mparameters
[i
].mtype
1522 var prt
= msignature
.mparameters
[i
].mtype
1524 if nsig
!= null then node
= nsig
else node
= self
1525 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1526 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1530 if precursor_ret_type
!= null then
1532 if nsig
!= null then node
= nsig
else node
= self
1533 if ret_type
== null then
1534 # Inherit the return type
1535 ret_type
= precursor_ret_type
1536 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1537 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1543 # Type is useless if the attribute type is the same thant the intro.
1544 redef fun check_repeated_types
(modelbuilder
) do
1545 var mreadpropdef
= self.mreadpropdef
1546 if mreadpropdef
== null then return
1547 if mreadpropdef
.is_intro
or n_type
== null then return
1549 var intro
= mreadpropdef
.mproperty
.intro
1550 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1551 if n_intro
== null then return
1554 if n_intro
isa AMethPropdef then
1555 ntype
= n_intro
.n_signature
.ret_type
1556 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1557 ntype
= n_intro
.n_type
.mtype
1560 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1561 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1565 redef class ATypePropdef
1566 redef type MPROPDEF: MVirtualTypeDef
1568 redef fun build_property
(modelbuilder
, mclassdef
)
1570 var name
= self.n_qid
.n_id
.text
1571 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1572 if mprop
== null then
1573 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1574 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1575 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1576 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1580 assert mprop
isa MVirtualTypeProp
1581 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1584 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1585 self.mpropdef
= mpropdef
1586 if mpropdef
.is_intro
then
1587 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1589 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1591 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1592 mpropdef
.is_broken
=true
1594 mclassdef
.mprop2npropdef
[mprop
] = self
1595 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1596 set_doc
(mpropdef
, modelbuilder
)
1598 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1599 if atfixed
!= null then
1600 mpropdef
.is_fixed
= true
1604 redef fun build_signature
(modelbuilder
)
1606 var mpropdef
= self.mpropdef
1607 if mpropdef
== null then return # Error thus skipped
1608 var mclassdef
= mpropdef
.mclassdef
1609 var mmodule
= mclassdef
.mmodule
1610 var mtype
: nullable MType = null
1612 var ntype
= self.n_type
1613 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1614 if mtype
== null then return
1616 mpropdef
.bound
= mtype
1617 # print "{mpropdef}: {mtype}"
1620 redef fun check_signature
(modelbuilder
)
1622 var mpropdef
= self.mpropdef
1623 if mpropdef
== null then return # Error thus skipped
1625 var bound
= mpropdef
.bound
1626 if bound
== null then return # Error thus skipped
1628 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1630 var mclassdef
= mpropdef
.mclassdef
1631 var mmodule
= mclassdef
.mmodule
1632 var anchor
= mclassdef
.bound_mtype
1634 var ntype
= self.n_type
1635 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1636 mpropdef
.bound
= null
1640 # Check redefinitions
1641 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1642 var supbound
= p
.bound
1643 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1645 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1648 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1649 # Still a warning to pass existing bad code
1650 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1653 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1654 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")