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
154 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
155 the_root_init_mmethod
= mprop
158 # Is there already a constructor defined?
159 var defined_init
: nullable MMethodDef = null
160 for mpropdef
in mclassdef
.mpropdefs
do
161 if not mpropdef
isa MMethodDef then continue
162 if not mpropdef
.mproperty
.is_init
then continue
163 if mpropdef
.mproperty
.is_root_init
then
164 assert defined_init
== null
165 defined_init
= mpropdef
166 else if mpropdef
.mproperty
.name
== "autoinit" then
167 # An explicit old-style init named "init", so return
172 if mclassdef
.auto_init
!= null then
176 if not nclassdef
isa AStdClassdef then return
178 # Collect undefined attributes
179 var mparameters
= new Array[MParameter]
180 var initializers
= new Array[MProperty]
181 for npropdef
in nclassdef
.n_propdefs
do
182 if npropdef
isa AMethPropdef then
183 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
184 var mpropdef
= npropdef
.mpropdef
185 if mpropdef
== null then return # Skip broken method
186 var sig
= mpropdef
.msignature
187 if sig
== null then continue # Skip broken method
189 mparameters
.add_all sig
.mparameters
190 initializers
.add
(mpropdef
.mproperty
)
191 mpropdef
.mproperty
.is_autoinit
= true
193 if npropdef
isa AAttrPropdef then
194 var mreadpropdef
= npropdef
.mreadpropdef
195 if mreadpropdef
== null then return # Skip broken attribute
196 var msignature
= mreadpropdef
.msignature
197 if msignature
== null then return # Skip broken attribute
198 if npropdef
.noinit
then continue # Skip noinit attribute
199 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
200 if atlateinit
!= null then
201 # For lateinit attributes, call the reader to force
202 # the lazy initialization of the attribute.
203 initializers
.add
(mreadpropdef
.mproperty
)
204 mreadpropdef
.mproperty
.is_autoinit
= true
207 if npropdef
.has_value
and not npropdef
.is_optional
then continue
208 var msetter
= npropdef
.mwritepropdef
209 if msetter
== null then
210 # No setter, it is a readonly attribute, so just add it
211 var paramname
= mreadpropdef
.mproperty
.name
212 var ret_type
= msignature
.return_mtype
213 if ret_type
== null then return
214 var mparameter
= new MParameter(paramname
, ret_type
, false)
215 mparameters
.add
(mparameter
)
217 initializers
.add
(npropdef
.mpropdef
.mproperty
)
218 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
220 # Add the setter to the list
221 mparameters
.add_all msetter
.msignature
.mparameters
222 initializers
.add
(msetter
.mproperty
)
223 msetter
.mproperty
.is_autoinit
= true
228 var the_root_init_mmethod
= self.the_root_init_mmethod
229 if the_root_init_mmethod
== null then return
231 # Look for most-specific new-stype init definitions
232 var spropdefs
= new ArraySet[MMethodDef]
233 for x
in mclassdef
.in_hierarchy
.direct_greaters
do
234 var y
= x
.mclass
.intro
.auto_init
235 if y
== null then continue
236 if y
.is_broken
or y
.msignature
== null then return
240 # Look at the autoinit class-annotation
241 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
242 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
243 if autoinit
!= null then
244 # Just throws the collected initializers
248 if noautoinit
!= null then
249 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
252 if autoinit
.n_args
.is_empty
then
253 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
256 # Get and check each argument
257 for narg
in autoinit
.n_args
do
260 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
264 # Search the property.
265 # To avoid bad surprises, try to get the setter first.
266 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
268 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
271 error
(narg
, "Error: unknown method `{id}`")
274 if not p
.is_autoinit
then
275 error
(narg
, "Error: `{p}` is not an autoinit method")
279 # Register the initializer and the parameters
282 if pd
isa MMethodDef then
283 # Get the signature resolved for the current receiver
284 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
285 mparameters
.add_all
(sig
.mparameters
)
291 else if spropdefs
.not_empty
then
292 # Search for inherited manual autoinit
294 for s
in spropdefs
do
295 if mpropdef2npropdef
.has_key
(s
) then
296 self.toolcontext
.info
("{mclassdef} inherits a manual autoinit {s}", 3)
297 #mclassdef.autoinit = s
303 # Search the longest-one and checks for conflict
304 var longest
= spropdefs
.first
305 if spropdefs
.length
> 1 then
306 # part 1. find the longest list
307 for spd
in spropdefs
do
308 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
309 if spd
!= manual
and manual
!= null then
310 self.toolcontext
.info
("{mclassdef} conflict between manual autoinit {manual} and automatic autoinit {spd}.", 3)
313 # conflict with manual autoinit?
314 if longest
!= manual
and manual
!= null then
315 self.error
(nclassdef
, "Error: conflict between manual autoinit {manual} and automatic autoinit {longest}.")
318 # Check for conflict in the order of initializers
319 # Each initializer list must me a prefix of the longest list
320 # If `noautoinit` is set, just ignore conflicts
321 if noautoinit
== null then for spd
in spropdefs
do
323 for p
in spd
.initializers
do
324 if p
!= longest
.initializers
[i
] then
325 var proposal
= new ArraySet[MProperty]
326 for spd2
in spropdefs
do
327 proposal
.add_all spd2
.initializers
329 proposal
.add_all initializers
330 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(", ")}`")
331 # TODO: invalidate the initializer to avoid more errors
339 if noautoinit
!= null then
340 # If there is local or inherited initializers, then complain.
341 if initializers
.is_empty
and longest
.initializers
.is_empty
then
342 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
344 # Just clear initializers
348 # Combine the inherited list to what is collected
349 if longest
.initializers
.length
> 0 then
350 mparameters
.prepend longest
.msignature
.mparameters
351 initializers
.prepend longest
.initializers
356 # Create a specific new autoinit constructor
358 var mprop
= new MMethod(mclassdef
, "autoinit", public_visibility
)
360 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
361 mpropdef
.initializers
.add_all
(initializers
)
362 var msignature
= new MSignature(mparameters
, null)
363 mpropdef
.msignature
= msignature
364 mclassdef
.auto_init
= mpropdef
365 self.toolcontext
.info
("{mclassdef} gets a free auto constructor `{mpropdef}{msignature}`. {spropdefs}", 3)
366 #mclassdef.mclass.root_init = mpropdef
367 mclassdef
.mclass
.the_root_init_mmethod
= the_root_init_mmethod
371 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
372 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
374 var mmodule
= mpropdef
.mclassdef
.mmodule
375 var mproperty
= mpropdef
.mproperty
377 # Extract visibility information of the main part of `mtype`
378 # It is a case-by case
379 var vis_type
: nullable MVisibility = null # The own visibility of the type
380 var mmodule_type
: nullable MModule = null # The original module of the type
381 mtype
= mtype
.undecorate
382 if mtype
isa MClassType then
383 vis_type
= mtype
.mclass
.visibility
384 mmodule_type
= mtype
.mclass
.intro_mmodule
385 else if mtype
isa MVirtualType then
386 vis_type
= mtype
.mproperty
.visibility
387 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
388 else if mtype
isa MParameterType then
389 # nothing, always visible
390 else if mtype
isa MNullType then
392 else if mtype
isa MBottomType then
395 node
.debug
"Unexpected type {mtype}"
399 if vis_type
!= null then
400 assert mmodule_type
!= null
401 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
402 if mproperty
.visibility
> vis_type
then
403 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
405 else if mproperty
.visibility
> vis_module_type
then
406 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
411 # No error, try to go deeper in generic types
412 if node
isa AType then
413 for a
in node
.n_types
do
415 if t
== null then continue # Error, thus skipped
416 check_visibility
(a
, t
, mpropdef
)
418 else if mtype
isa MGenericType then
419 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
423 # Detect circularity errors for virtual types.
424 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
427 # Slow case: progress on each resolution until we visit all without getting a loop
429 # The graph used to detect loops
430 var mtype
= mproperty
.mvirtualtype
431 var poset
= new POSet[MType]
433 # The work-list of types to resolve
434 var todo
= new List[MType]
437 while not todo
.is_empty
do
441 if not t
.need_anchor
then continue
443 # Get the types derived of `t` (subtypes and bounds)
445 if t
isa MNullableType then
447 else if t
isa MGenericType then
449 else if t
isa MVirtualType then
451 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
452 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
453 if defs
.is_empty
then return false
454 nexts
= new Array[MType]
456 var next
= defs
.first
.bound
457 if next
== null then return false
460 else if t
isa MClassType then
461 # Basic type, nothing to to
463 else if t
isa MParameterType then
464 # Parameter types cannot depend on virtual types, so nothing to do
472 if poset
.has_edge
(next
, t
) then
473 if mtype
== next
then
474 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
476 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
480 poset
.add_edge
(t
, next
)
490 # Does the MPropDef contains a call to super or a call of a super-constructor?
491 # Subsequent phases of the frontend (esp. typing) set it if required
492 var has_supercall
: Bool = false is writable
495 redef class AClassdef
496 # Marker used in `ModelBuilder::build_properties`
497 private var build_properties_is_done
= false
501 # The base init of the class.
503 # TODO: Where to put this information is not clear because unlike other
504 # informations, the initialisers are stable in a same class.
505 var root_init
: nullable MMethodDef = null
507 # The base init of the class.
509 # TODO: merge with `root_init` and `ModelBuilder::the_root_init_mmethod` if possible
510 var the_root_init_mmethod
: nullable MMethod = null
513 redef class MClassDef
514 # What is the `APropdef` associated to a `MProperty`?
515 # Used to check multiple definition of a property.
516 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
518 # Build the virtual type `SELF` only for introduction `MClassDef`
519 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
521 if not is_intro
then return
524 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
526 # If SELF type is declared nowherer?
527 if mprop
== null then return
529 # SELF is not a virtual type? it is weird but we ignore it
530 if not mprop
isa MVirtualTypeProp then return
532 # Is this the intro of SELF in the library?
533 var intro
= mprop
.intro
534 var intro_mclassdef
= intro
.mclassdef
535 if intro_mclassdef
== self then
536 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
538 # SELF must be declared in Object, otherwise this will create conflicts
539 if intro_mclassdef
.mclass
.name
!= "Object" then
540 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
543 # SELF must be public
544 if mprop
.visibility
!= public_visibility
then
545 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
548 # SELF must not be fixed
549 if intro
.is_fixed
then
550 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
556 # This class introduction inherits a SELF
557 # We insert an artificial property to update it
558 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
559 mpropdef
.bound
= mclass
.mclass_type
564 # The associated main model entity
565 type MPROPDEF: MPropDef
567 # The associated propdef once build by a `ModelBuilder`
568 var mpropdef
: nullable MPROPDEF is writable
570 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
571 private fun build_signature
(modelbuilder
: ModelBuilder) do end
572 private fun check_signature
(modelbuilder
: ModelBuilder) do end
573 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
575 var mvisibility
= public_visibility
576 if nvisibility
!= null then
577 mvisibility
= nvisibility
.mvisibility
578 if mvisibility
== intrude_visibility
then
579 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
580 mvisibility
= public_visibility
583 if mclassdef
.mclass
.visibility
== private_visibility
then
584 if mvisibility
== protected_visibility
then
585 assert nvisibility
!= null
586 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
587 else if mvisibility
== private_visibility
then
588 assert nvisibility
!= null
589 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
591 mvisibility
= private_visibility
596 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
598 var ndoc
= self.n_doc
600 var mdoc
= ndoc
.to_mdoc
602 mdoc
.original_mentity
= mpropdef
603 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
and mpropdef
.name
!= "new" then
604 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
607 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
608 if at_deprecated
!= null then
609 if not mpropdef
.is_intro
then
610 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
612 var info
= new MDeprecationInfo
613 ndoc
= at_deprecated
.n_doc
614 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
615 mpropdef
.mproperty
.deprecation
= info
620 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
622 if nvisibility
== null then return
623 var mvisibility
= nvisibility
.mvisibility
624 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
625 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
629 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
631 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
632 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
635 if mprop
isa MMethod and mprop
.is_root_init
then return true
636 if kwredef
== null then
638 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
642 # Check for full-name conflicts in the package.
643 # A public property should have a unique qualified name `package::class::prop`.
644 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
645 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
646 if others
!= null then for other
in others
do
647 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
648 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}`.")
654 if not need_redef
then
655 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
662 # Checks for useless type in redef signatures.
663 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
666 redef class ASignature
667 # Is the model builder has correctly visited the signature
668 var is_visited
= false
669 # Names of parameters from the AST
670 # REQUIRE: is_visited
671 var param_names
= new Array[String]
672 # Types of parameters from the AST
673 # REQUIRE: is_visited
674 var param_types
= new Array[MType]
675 # Rank of the vararg (of -1 if none)
676 # REQUIRE: is_visited
677 var vararg_rank
: Int = -1
679 var ret_type
: nullable MType = null
681 # Visit and fill information about a signature
682 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
684 var mmodule
= mclassdef
.mmodule
685 var param_names
= self.param_names
686 var param_types
= self.param_types
687 for np
in self.n_params
do
688 param_names
.add
(np
.n_id
.text
)
689 var ntype
= np
.n_type
690 if ntype
!= null then
691 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
692 if mtype
== null then return false # Skip error
693 for i
in [0..param_names
.length-param_types
.length
[ do
694 param_types
.add
(mtype
)
696 if np
.n_dotdotdot
!= null then
697 if self.vararg_rank
!= -1 then
698 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
701 self.vararg_rank
= param_names
.length
- 1
706 var ntype
= self.n_type
707 if ntype
!= null then
708 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
709 if self.ret_type
== null then return false # Skip error
712 self.is_visited
= true
716 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
719 for np
in self.n_params
do
720 var ntype
= np
.n_type
721 if ntype
!= null then
722 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
727 var ntype
= self.n_type
728 if ntype
!= null then
729 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
733 if not res
then is_broken
= true
739 # The associated mparameter if any
740 var mparameter
: nullable MParameter = null
743 redef class AMethPropdef
744 redef type MPROPDEF: MMethodDef
746 # Is the method annotated `autoinit`?
747 var is_autoinit
= false
749 # Can self be used as a root init?
750 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
752 # Need the `init` keyword
753 if n_kwinit
== null then return false
754 # Need to by anonymous
755 if self.n_methid
!= null then return false
756 # No annotation on itself
757 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
759 var amod
= self.parent
.parent
.as(AModule)
760 var amoddecl
= amod
.n_moduledecl
761 if amoddecl
!= null then
762 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
763 if old
!= null then return false
766 if self.n_signature
.n_params
.length
> 0 then
767 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
770 # Cannot be private or something
771 if not self.n_visibility
isa APublicVisibility then
772 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
779 redef fun build_property
(modelbuilder
, mclassdef
)
781 var n_kwinit
= n_kwinit
782 var n_kwnew
= n_kwnew
783 var is_init
= n_kwinit
!= null or n_kwnew
!= null
785 var amethodid
= self.n_methid
787 if amethodid
== null then
791 else if n_kwinit
!= null then
794 if self.n_signature
.n_params
.not_empty
or get_single_annotation
("old_style_init", modelbuilder
) != null then
797 else if n_kwnew
!= null then
803 else if amethodid
isa AIdMethid then
804 name
= amethodid
.n_id
.text
805 name_node
= amethodid
807 # operator, bracket or assign
808 name
= amethodid
.collect_text
809 name_node
= amethodid
811 var arity
= self.n_signature
.n_params
.length
812 if name
== "+" and arity
== 0 then
814 else if name
== "-" and arity
== 0 then
816 else if name
== "~" and arity
== 0 then
819 if amethodid
.is_binary
and arity
!= 1 then
820 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
821 else if amethodid
.min_arity
> arity
then
822 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
827 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
828 var mprop
: nullable MMethod = null
829 if not is_init
or n_kwredef
!= null or look_like_a_root_init
then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
830 if mprop
== null and look_like_a_root_init
then
831 mprop
= modelbuilder
.the_root_init_mmethod
833 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
834 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
837 if mprop
== null then
838 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
839 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
840 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
841 modelbuilder
.the_root_init_mmethod
= mprop
842 mprop
.is_root_init
= true
844 mprop
.is_init
= is_init
845 mprop
.is_new
= n_kwnew
!= null
846 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
847 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
848 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
849 mprop
.is_broken
= true
853 if mprop
.is_broken
then
856 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
857 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
860 # Check name conflicts in the local class for constructors.
862 for p
, n
in mclassdef
.mprop2npropdef
do
863 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
864 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
865 mprop
.is_broken
= true
873 mclassdef
.mprop2npropdef
[mprop
] = self
875 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
876 if mprop
.name
== "autoinit" and mclassdef
.is_intro
then
877 assert mclassdef
.auto_init
== null
878 mclassdef
.auto_init
= mpropdef
879 if mpropdef
.is_intro
then
880 mpropdef
.initializers
.add mprop
881 mpropdef
.is_calling_init
= true
885 set_doc
(mpropdef
, modelbuilder
)
887 self.mpropdef
= mpropdef
888 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
889 if mpropdef
.is_intro
then
890 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
892 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
896 redef fun build_signature
(modelbuilder
)
898 var mpropdef
= self.mpropdef
899 if mpropdef
== null then return # Error thus skiped
900 var mclassdef
= mpropdef
.mclassdef
901 var mmodule
= mclassdef
.mmodule
902 var nsig
= self.n_signature
904 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
905 var root_init
= mclassdef
.mclass
.root_init
906 if root_init
!= null then
907 # Inherit the initializers by refinement
908 assert mpropdef
.initializers
.is_empty
909 mpropdef
.initializers
.add_all root_init
.initializers
913 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
914 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
916 # Retrieve info from the signature AST
917 var param_names
= new Array[String] # Names of parameters from the AST
918 var param_types
= new Array[MType] # Types of parameters from the AST
920 var ret_type
: nullable MType = null # Return type from the AST
922 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
923 param_names
= nsig
.param_names
924 param_types
= nsig
.param_types
925 vararg_rank
= nsig
.vararg_rank
926 ret_type
= nsig
.ret_type
929 # Look for some signature to inherit
930 # FIXME: do not inherit from the intro, but from the most specific
931 var msignature
: nullable MSignature = null
932 if not mpropdef
.is_intro
then
933 msignature
= mpropdef
.mproperty
.intro
.msignature
934 if msignature
== null then return # Skip error
936 # The local signature is adapted to use the local formal types, if any.
937 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
939 # Check inherited signature arity
940 if param_names
.length
!= msignature
.arity
then
942 if nsig
!= null then node
= nsig
else node
= self
943 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}`.")
946 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
947 # FIXME UGLY: inherit signature from a super-constructor
948 for msupertype
in mclassdef
.supertypes
do
949 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
950 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
951 if candidate
!= null then
952 if msignature
== null then
953 msignature
= candidate
.intro
.as(MMethodDef).msignature
960 # Inherit the signature
961 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
962 # Parameters are untyped, thus inherit them
963 param_types
= new Array[MType]
964 for mparameter
in msignature
.mparameters
do
965 param_types
.add
(mparameter
.mtype
)
967 vararg_rank
= msignature
.vararg_rank
969 if msignature
!= null and ret_type
== null then
970 ret_type
= msignature
.return_mtype
973 if param_names
.length
!= param_types
.length
then
974 # Some parameters are typed, other parameters are not typed.
975 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
979 var mparameters
= new Array[MParameter]
980 for i
in [0..param_names
.length
[ do
981 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
982 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
983 mparameters
.add
(mparameter
)
986 # In `new`-factories, the return type is by default the classtype.
987 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
989 # Special checks for operator methods
990 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
991 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
993 if ret_type
== null and return_is_mandatory
then
994 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
997 msignature
= new MSignature(mparameters
, ret_type
)
998 mpropdef
.msignature
= msignature
999 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
1000 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
1001 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
1004 var at
= self.get_single_annotation
("lazy", modelbuilder
)
1005 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
1007 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1008 if atautoinit
!= null then
1009 if not mpropdef
.is_intro
then
1010 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
1011 else if not mclassdef
.is_intro
then
1012 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1014 self.is_autoinit
= true
1019 redef fun check_signature
(modelbuilder
)
1021 var mpropdef
= self.mpropdef
1022 if mpropdef
== null then return # Error thus skiped
1023 var mclassdef
= mpropdef
.mclassdef
1024 var mmodule
= mclassdef
.mmodule
1025 var nsig
= self.n_signature
1026 var mysignature
= mpropdef
.msignature
1027 if mysignature
== null then return # Error thus skiped
1030 if nsig
!= null then
1031 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1032 mpropdef
.msignature
= null # invalidate
1033 mpropdef
.is_broken
= true
1034 return # Forward error
1038 # Lookup for signature in the precursor
1039 # FIXME all precursors should be considered
1040 if not mpropdef
.is_intro
then
1041 var msignature
= mpropdef
.mproperty
.intro
.msignature
1042 if msignature
== null then return
1044 var precursor_ret_type
= msignature
.return_mtype
1045 var ret_type
= mysignature
.return_mtype
1046 if ret_type
!= null and precursor_ret_type
== null then
1047 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1048 mpropdef
.msignature
= null
1049 mpropdef
.is_broken
= true
1053 if mysignature
.arity
> 0 then
1054 # Check parameters types
1055 for i
in [0..mysignature
.arity
[ do
1056 var myt
= mysignature
.mparameters
[i
].mtype
1057 var prt
= msignature
.mparameters
[i
].mtype
1058 var node
= nsig
.n_params
[i
]
1059 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1060 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1061 mpropdef
.msignature
= null
1062 mpropdef
.is_broken
= true
1066 if precursor_ret_type
!= null then
1067 var node
: nullable ANode = null
1068 if nsig
!= null then node
= nsig
.n_type
1069 if node
== null then node
= self
1070 if ret_type
== null then
1071 # Inherit the return type
1072 ret_type
= precursor_ret_type
1073 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1074 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1075 mpropdef
.msignature
= null
1076 mpropdef
.is_broken
= true
1081 if nsig
!= null then
1082 # Check parameters visibility
1083 for i
in [0..mysignature
.arity
[ do
1084 var nt
= nsig
.n_params
[i
].n_type
1085 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1087 var nt
= nsig
.n_type
1088 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1090 check_repeated_types
(modelbuilder
)
1093 # For parameters, type is always useless in a redef.
1094 # For return type, type is useless if not covariant with introduction.
1095 redef fun check_repeated_types
(modelbuilder
) do
1096 var mpropdef
= self.mpropdef
1097 if mpropdef
== null then return
1098 if mpropdef
.is_intro
or n_signature
== null then return
1100 for param
in n_signature
.n_params
do
1101 if param
.n_type
!= null then
1102 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1106 var intro
= mpropdef
.mproperty
.intro
1107 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1108 if n_intro
== null or not n_intro
isa AMethPropdef then return
1110 var ret_type
= n_signature
.ret_type
1111 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1112 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1118 # Is a return required?
1120 # * True for operators and brackets.
1121 # * False for id and assignment.
1122 fun return_is_mandatory
: Bool do return true
1124 # Can the last parameter be special like a vararg?
1126 # * False for operators: the last one is in fact the only one.
1127 # * False for assignments: it is the right part of the assignment.
1128 # * True for ids and brackets.
1129 fun accept_special_last_parameter
: Bool do return false
1131 # The minimum required number of parameters.
1133 # * 1 for binary operators
1135 # * 1 for assignments
1136 # * 2 for bracket assignments
1138 fun min_arity
: Int do return 1
1140 # Is the `self` a binary operator?
1141 fun is_binary
: Bool do return true
1144 redef class AIdMethid
1145 redef fun return_is_mandatory
do return false
1146 redef fun accept_special_last_parameter
do return true
1147 redef fun min_arity
do return 0
1148 redef fun is_binary
do return false
1151 redef class ABraMethid
1152 redef fun accept_special_last_parameter
do return true
1153 redef fun is_binary
do return false
1156 redef class ABraassignMethid
1157 redef fun return_is_mandatory
do return false
1158 redef fun min_arity
do return 2
1159 redef fun is_binary
do return false
1162 redef class AAssignMethid
1163 redef fun return_is_mandatory
do return false
1164 redef fun is_binary
do return false
1167 redef class AAttrPropdef
1168 redef type MPROPDEF: MAttributeDef
1170 # The static type of the property (declared, inferred or inherited)
1171 # This attribute is also used to check if the property was analyzed and is valid.
1172 var mtype
: nullable MType
1174 # Is the node tagged `noinit`?
1177 # Is the node tagged lazy?
1180 # Is the node tagged optional?
1181 var is_optional
= false
1183 # Has the node a default value?
1184 # Could be through `n_expr` or `n_block`
1185 var has_value
= false
1187 # The guard associated to a lazy attribute.
1188 # Because some engines does not have a working `isset`,
1189 # this additional attribute is used to guard the lazy initialization.
1190 # TODO: to remove once isset is correctly implemented
1191 var mlazypropdef
: nullable MAttributeDef
1193 # The associated getter (read accessor) if any
1194 var mreadpropdef
: nullable MMethodDef is writable
1195 # The associated setter (write accessor) if any
1196 var mwritepropdef
: nullable MMethodDef is writable
1198 redef fun build_property
(modelbuilder
, mclassdef
)
1200 var mclass
= mclassdef
.mclass
1202 var name
= nid2
.text
1204 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1205 if atabstract
== null then
1206 if not mclass
.kind
.need_init
then
1207 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1210 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1211 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1212 self.mpropdef
= mpropdef
1213 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1217 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1218 if mreadprop
== null then
1219 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1220 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1221 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1223 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1224 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1226 mclassdef
.mprop2npropdef
[mreadprop
] = self
1228 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1229 self.mreadpropdef
= mreadpropdef
1230 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1231 set_doc
(mreadpropdef
, modelbuilder
)
1232 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1233 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1235 has_value
= n_expr
!= null or n_block
!= null
1237 if atabstract
!= null and has_value
then
1238 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1242 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1243 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1244 if atnoinit
!= null then
1247 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1250 if atabstract
!= null then
1251 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1255 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1256 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1257 if atlazy
!= null or atlateinit
!= null then
1258 if atlazy
!= null and atlateinit
!= null then
1259 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1262 if not has_value
then
1263 if atlazy
!= null then
1264 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1265 else if atlateinit
!= null then
1266 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1272 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1273 mlazyprop
.is_fictive
= true
1274 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1275 mlazypropdef
.is_fictive
= true
1276 self.mlazypropdef
= mlazypropdef
1279 var atoptional
= self.get_single_annotation
("optional", modelbuilder
)
1280 if atoptional
!= null then
1281 if not has_value
then
1282 modelbuilder
.error
(atoptional
, "Error: `optional` attributes need a default value.")
1287 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1288 if atreadonly
!= null then
1289 if not has_value
then
1290 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1292 # No setter, so just leave
1296 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1297 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1300 var writename
= name
+ "="
1301 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1302 if atwritable
!= null then
1303 if not atwritable
.n_args
.is_empty
then
1304 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1307 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1308 var nwkwredef
: nullable Token = null
1309 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1310 if mwriteprop
== null then
1312 if atwritable
!= null then
1313 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1315 mvisibility
= mreadprop
.visibility
1316 # By default, use protected visibility at most
1317 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1319 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1320 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1321 mwriteprop
.deprecation
= mreadprop
.deprecation
1323 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1324 if atwritable
!= null then
1325 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1328 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1330 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1331 self.mwritepropdef
= mwritepropdef
1332 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1333 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1334 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1336 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1337 if atautoinit
!= null then
1339 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1340 else if not mwritepropdef
.is_intro
then
1341 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1342 else if not mclassdef
.is_intro
then
1343 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1344 else if atabstract
== null then
1345 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1347 else if atabstract
!= null then
1348 # By default, abstract attribute are not autoinit
1353 redef fun build_signature
(modelbuilder
)
1355 var mreadpropdef
= self.mreadpropdef
1356 var mpropdef
= self.mpropdef
1357 if mreadpropdef
== null then return # Error thus skipped
1358 var mclassdef
= mreadpropdef
.mclassdef
1359 var mmodule
= mclassdef
.mmodule
1360 var mtype
: nullable MType = null
1363 var ntype
= self.n_type
1364 if ntype
!= null then
1365 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1366 if mtype
== null then return
1369 var inherited_type
: nullable MType = null
1370 # Inherit the type from the getter (usually an abstract getter)
1371 if not mreadpropdef
.is_intro
then
1372 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1373 if msignature
== null then return # Error, thus skipped
1374 inherited_type
= msignature
.return_mtype
1375 if inherited_type
!= null then
1376 # The inherited type is adapted to use the local formal types, if any.
1377 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1378 if mtype
== null then mtype
= inherited_type
1382 var nexpr
= self.n_expr
1383 if mtype
== null then
1384 if nexpr
!= null then
1385 if nexpr
isa ANewExpr then
1386 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1387 else if nexpr
isa AAsCastExpr then
1388 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1389 else if nexpr
isa AIntegerExpr then
1390 var cla
: nullable MClass = null
1391 if nexpr
.value
isa Int then
1392 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1393 else if nexpr
.value
isa Byte then
1394 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1395 else if nexpr
.value
isa Int8 then
1396 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1397 else if nexpr
.value
isa Int16 then
1398 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1399 else if nexpr
.value
isa UInt16 then
1400 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1401 else if nexpr
.value
isa Int32 then
1402 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1403 else if nexpr
.value
isa UInt32 then
1404 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1406 # Should not happen, and should be updated as new types are added
1409 if cla
!= null then mtype
= cla
.mclass_type
1410 else if nexpr
isa AFloatExpr then
1411 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1412 if cla
!= null then mtype
= cla
.mclass_type
1413 else if nexpr
isa ACharExpr then
1414 var cla
: nullable MClass
1415 if nexpr
.is_ascii
then
1416 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1417 else if nexpr
.is_code_point
then
1418 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1420 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1422 if cla
!= null then mtype
= cla
.mclass_type
1423 else if nexpr
isa ABoolExpr then
1424 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1425 if cla
!= null then mtype
= cla
.mclass_type
1426 else if nexpr
isa ASuperstringExpr then
1427 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1428 if cla
!= null then mtype
= cla
.mclass_type
1429 else if nexpr
isa AStringFormExpr then
1430 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1431 if cla
!= null then mtype
= cla
.mclass_type
1433 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1436 if mtype
== null then return
1438 else if ntype
!= null and inherited_type
== mtype
then
1439 if nexpr
isa ANewExpr then
1440 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1441 if xmtype
== mtype
then
1442 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1447 if mtype
== null then
1448 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1454 if mpropdef
!= null then
1455 mpropdef
.static_mtype
= mtype
1459 var msignature
= new MSignature(new Array[MParameter], mtype
)
1460 mreadpropdef
.msignature
= msignature
1463 var mwritepropdef
= self.mwritepropdef
1464 if mwritepropdef
!= null then
1465 var mwritetype
= mtype
1467 mwritetype
= mwritetype
.as_nullable
1471 var mparameter
= new MParameter(name
, mwritetype
, false)
1472 var msignature
= new MSignature([mparameter
], null)
1473 mwritepropdef
.msignature
= msignature
1476 var mlazypropdef
= self.mlazypropdef
1477 if mlazypropdef
!= null then
1478 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1480 check_repeated_types
(modelbuilder
)
1483 redef fun check_signature
(modelbuilder
)
1485 var mpropdef
= self.mpropdef
1486 if mpropdef
== null then return # Error thus skipped
1487 var ntype
= self.n_type
1488 var mtype
= self.mtype
1489 if mtype
== null then return # Error thus skipped
1491 var mclassdef
= mpropdef
.mclassdef
1492 var mmodule
= mclassdef
.mmodule
1495 if ntype
!= null then
1496 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1499 if nexpr
isa ANewExpr then
1500 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1503 # Lookup for signature in the precursor
1504 # FIXME all precursors should be considered
1505 if not mpropdef
.is_intro
then
1506 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1507 if precursor_type
== null then return
1509 if mtype
!= precursor_type
then
1510 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1515 # Check getter and setter
1516 var meth
= self.mreadpropdef
1517 if meth
!= null then
1518 self.check_method_signature
(modelbuilder
, meth
)
1519 var node
: nullable ANode = ntype
1520 if node
== null then node
= self
1521 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1523 meth
= self.mwritepropdef
1524 if meth
!= null then
1525 self.check_method_signature
(modelbuilder
, meth
)
1526 var node
: nullable ANode = ntype
1527 if node
== null then node
= self
1528 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1532 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1534 var mclassdef
= mpropdef
.mclassdef
1535 var mmodule
= mclassdef
.mmodule
1536 var nsig
= self.n_type
1537 var mysignature
= mpropdef
.msignature
1538 if mysignature
== null then return # Error thus skiped
1540 # Lookup for signature in the precursor
1541 # FIXME all precursors should be considered
1542 if not mpropdef
.is_intro
then
1543 var msignature
= mpropdef
.mproperty
.intro
.msignature
1544 if msignature
== null then return
1546 if mysignature
.arity
!= msignature
.arity
then
1548 if nsig
!= null then node
= nsig
else node
= self
1549 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}`.")
1552 var precursor_ret_type
= msignature
.return_mtype
1553 var ret_type
= mysignature
.return_mtype
1554 if ret_type
!= null and precursor_ret_type
== null then
1556 if nsig
!= null then node
= nsig
else node
= self
1557 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1561 if mysignature
.arity
> 0 then
1562 # Check parameters types
1563 for i
in [0..mysignature
.arity
[ do
1564 var myt
= mysignature
.mparameters
[i
].mtype
1565 var prt
= msignature
.mparameters
[i
].mtype
1567 if nsig
!= null then node
= nsig
else node
= self
1568 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1569 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1573 if precursor_ret_type
!= null then
1575 if nsig
!= null then node
= nsig
else node
= self
1576 if ret_type
== null then
1577 # Inherit the return type
1578 ret_type
= precursor_ret_type
1579 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1580 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1586 # Type is useless if the attribute type is the same thant the intro.
1587 redef fun check_repeated_types
(modelbuilder
) do
1588 var mreadpropdef
= self.mreadpropdef
1589 if mreadpropdef
== null then return
1590 if mreadpropdef
.is_intro
or n_type
== null then return
1592 var intro
= mreadpropdef
.mproperty
.intro
1593 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1594 if n_intro
== null then return
1597 if n_intro
isa AMethPropdef then
1598 ntype
= n_intro
.n_signature
.ret_type
1599 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1600 ntype
= n_intro
.n_type
.mtype
1603 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1604 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1608 redef class ATypePropdef
1609 redef type MPROPDEF: MVirtualTypeDef
1611 redef fun build_property
(modelbuilder
, mclassdef
)
1613 var name
= self.n_qid
.n_id
.text
1614 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1615 if mprop
== null then
1616 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1617 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1618 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1619 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1623 assert mprop
isa MVirtualTypeProp
1624 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1627 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1628 self.mpropdef
= mpropdef
1629 if mpropdef
.is_intro
then
1630 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1632 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1634 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1635 mpropdef
.is_broken
=true
1637 mclassdef
.mprop2npropdef
[mprop
] = self
1638 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1639 set_doc
(mpropdef
, modelbuilder
)
1641 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1642 if atfixed
!= null then
1643 mpropdef
.is_fixed
= true
1647 redef fun build_signature
(modelbuilder
)
1649 var mpropdef
= self.mpropdef
1650 if mpropdef
== null then return # Error thus skipped
1651 var mclassdef
= mpropdef
.mclassdef
1652 var mmodule
= mclassdef
.mmodule
1653 var mtype
: nullable MType = null
1655 var ntype
= self.n_type
1656 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1657 if mtype
== null then return
1659 mpropdef
.bound
= mtype
1660 # print "{mpropdef}: {mtype}"
1663 redef fun check_signature
(modelbuilder
)
1665 var mpropdef
= self.mpropdef
1666 if mpropdef
== null then return # Error thus skipped
1668 var bound
= mpropdef
.bound
1669 if bound
== null then return # Error thus skipped
1671 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1673 var mclassdef
= mpropdef
.mclassdef
1674 var mmodule
= mclassdef
.mmodule
1675 var anchor
= mclassdef
.bound_mtype
1677 var ntype
= self.n_type
1678 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1679 mpropdef
.bound
= null
1683 # Check redefinitions
1684 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1685 var supbound
= p
.bound
1686 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1688 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1691 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1692 # Still a warning to pass existing bad code
1693 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1696 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1697 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")