1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.is_broken
= true
114 mpropdef
.bound
= new MBottomType(mclassdef
.mmodule
.model
)
117 for npropdef
in nclassdef2
.n_propdefs
do
118 # Check ATypePropdef first since they may be required for the other properties
119 if not npropdef
isa ATypePropdef then continue
120 npropdef
.check_signature
(self)
123 for npropdef
in nclassdef2
.n_propdefs
do
124 if npropdef
isa ATypePropdef then continue
125 npropdef
.check_signature
(self)
128 process_default_constructors
(nclassdef
)
131 # the root init of the Object class
132 # Is usually implicitly defined
133 # Then explicit or implicit definitions of root-init are attached to it
134 var the_root_init_mmethod
: nullable MMethod
136 # Introduce or inherit default constructor
137 # This is the last part of `build_properties`.
138 private fun process_default_constructors
(nclassdef
: AClassdef)
140 var mclassdef
= nclassdef
.mclassdef
.as(not null)
142 # Are we a refinement
143 if not mclassdef
.is_intro
then return
145 # Look for the init in Object, or create it
146 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
147 # Create the implicit root-init method
148 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
149 mprop
.is_root_init
= true
150 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
151 var mparameters
= new Array[MParameter]
152 var msignature
= new MSignature(mparameters
, null)
153 mpropdef
.msignature
= msignature
154 mpropdef
.new_msignature
= msignature
156 nclassdef
.mfree_init
= mpropdef
157 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
158 the_root_init_mmethod
= mprop
162 # Is there already a constructor defined?
163 var defined_init
: nullable MMethodDef = null
164 for mpropdef
in mclassdef
.mpropdefs
do
165 if not mpropdef
isa MMethodDef then continue
166 if not mpropdef
.mproperty
.is_init
then continue
167 if mpropdef
.mproperty
.is_root_init
then
168 assert defined_init
== null
169 defined_init
= mpropdef
170 else if mpropdef
.mproperty
.name
== "init" then
171 # An explicit old-style init named "init", so return
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 for param
in sig
.mparameters
do
190 var ret_type
= param
.mtype
191 var mparameter
= new MParameter(param
.name
, ret_type
, false)
192 mparameters
.add
(mparameter
)
194 initializers
.add
(mpropdef
.mproperty
)
195 mpropdef
.mproperty
.is_autoinit
= true
197 if npropdef
isa AAttrPropdef then
198 var mreadpropdef
= npropdef
.mreadpropdef
199 if mreadpropdef
== null then return # Skip broken attribute
200 var msignature
= mreadpropdef
.msignature
201 if msignature
== null then return # Skip broken attribute
202 if npropdef
.noinit
then continue # Skip noinit attribute
203 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
204 if atlateinit
!= null then
205 # For lateinit attributes, call the reader to force
206 # the lazy initialization of the attribute.
207 initializers
.add
(mreadpropdef
.mproperty
)
208 mreadpropdef
.mproperty
.is_autoinit
= true
211 if npropdef
.has_value
then continue
212 var paramname
= mreadpropdef
.mproperty
.name
213 var ret_type
= msignature
.return_mtype
214 if ret_type
== null then return
215 var mparameter
= new MParameter(paramname
, ret_type
, false)
216 mparameters
.add
(mparameter
)
217 var msetter
= npropdef
.mwritepropdef
218 if msetter
== null then
219 # No setter, it is a readonly attribute, so just add it
220 initializers
.add
(npropdef
.mpropdef
.mproperty
)
221 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
223 # Add the setter to the list
224 initializers
.add
(msetter
.mproperty
)
225 msetter
.mproperty
.is_autoinit
= true
230 var the_root_init_mmethod
= self.the_root_init_mmethod
231 if the_root_init_mmethod
== null then return
233 # Look for most-specific new-stype init definitions
234 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
235 if spropdefs
.is_empty
then
236 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
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
)
292 # Search the longest-one and checks for conflict
293 var longest
= spropdefs
.first
294 if spropdefs
.length
> 1 then
295 # part 1. find the longest list
296 for spd
in spropdefs
do
297 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
300 # Check for conflict in the order of initializers
301 # Each initializer list must me a prefix of the longest list
302 # If `noautoinit` is set, just ignore conflicts
303 if noautoinit
== null then for spd
in spropdefs
do
305 for p
in spd
.initializers
do
306 if p
!= longest
.initializers
[i
] then
307 var proposal
= new ArraySet[MProperty]
308 for spd2
in spropdefs
do
309 proposal
.add_all spd2
.initializers
311 proposal
.add_all initializers
312 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(", ")}`")
313 # TODO: invalidate the initializer to avoid more errors
321 if noautoinit
!= null then
322 # If there is local or inherited initializers, then complain.
323 if initializers
.is_empty
and longest
.initializers
.is_empty
then
324 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
326 # Just clear initializers
330 # Can we just inherit?
331 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
332 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
333 mclassdef
.mclass
.root_init
= longest
337 # Combine the inherited list to what is collected
338 if longest
.initializers
.length
> 0 then
339 mparameters
.prepend longest
.new_msignature
.mparameters
340 initializers
.prepend longest
.initializers
345 # If we already have a basic init definition, then setup its initializers
346 if defined_init
!= null then
347 defined_init
.initializers
.add_all
(initializers
)
348 var msignature
= new MSignature(mparameters
, null)
349 defined_init
.new_msignature
= msignature
350 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
351 mclassdef
.mclass
.root_init
= defined_init
355 # Else create the local implicit basic init definition
356 var mprop
= the_root_init_mmethod
357 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
358 mpropdef
.has_supercall
= true
359 mpropdef
.initializers
.add_all
(initializers
)
360 var msignature
= new MSignature(mparameters
, null)
361 mpropdef
.new_msignature
= msignature
362 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
363 nclassdef
.mfree_init
= mpropdef
364 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
365 mclassdef
.mclass
.root_init
= mpropdef
368 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
369 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
371 var mmodule
= mpropdef
.mclassdef
.mmodule
372 var mproperty
= mpropdef
.mproperty
374 # Extract visibility information of the main part of `mtype`
375 # It is a case-by case
376 var vis_type
: nullable MVisibility = null # The own visibility of the type
377 var mmodule_type
: nullable MModule = null # The original module of the type
378 mtype
= mtype
.undecorate
379 if mtype
isa MClassType then
380 vis_type
= mtype
.mclass
.visibility
381 mmodule_type
= mtype
.mclass
.intro_mmodule
382 else if mtype
isa MVirtualType then
383 vis_type
= mtype
.mproperty
.visibility
384 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
385 else if mtype
isa MParameterType then
386 # nothing, always visible
387 else if mtype
isa MNullType then
389 else if mtype
isa MBottomType then
392 node
.debug
"Unexpected type {mtype}"
396 if vis_type
!= null then
397 assert mmodule_type
!= null
398 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
399 if mproperty
.visibility
> vis_type
then
400 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
402 else if mproperty
.visibility
> vis_module_type
then
403 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
408 # No error, try to go deeper in generic types
409 if node
isa AType then
410 for a
in node
.n_types
do
412 if t
== null then continue # Error, thus skipped
413 check_visibility
(a
, t
, mpropdef
)
415 else if mtype
isa MGenericType then
416 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
420 # Detect circularity errors for virtual types.
421 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
424 # Slow case: progress on each resolution until we visit all without getting a loop
426 # The graph used to detect loops
427 var mtype
= mproperty
.mvirtualtype
428 var poset
= new POSet[MType]
430 # The work-list of types to resolve
431 var todo
= new List[MType]
434 while not todo
.is_empty
do
438 if not t
.need_anchor
then continue
440 # Get the types derived of `t` (subtypes and bounds)
442 if t
isa MNullableType then
444 else if t
isa MGenericType then
446 else if t
isa MVirtualType then
448 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
449 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
450 # TODO something to manage correctly bound conflicts
451 assert not defs
.is_empty
452 nexts
= new Array[MType]
454 var next
= defs
.first
.bound
455 if next
== null then return false
458 else if t
isa MClassType then
459 # Basic type, nothing to to
461 else if t
isa MParameterType then
462 # Parameter types cannot depend on virtual types, so nothing to do
470 if poset
.has_edge
(next
, t
) then
471 if mtype
== next
then
472 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
474 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
478 poset
.add_edge
(t
, next
)
488 # Does the MPropDef contains a call to super or a call of a super-constructor?
489 # Subsequent phases of the frontend (esp. typing) set it if required
490 var has_supercall
: Bool = false is writable
493 redef class AClassdef
494 # Marker used in `ModelBuilder::build_properties`
495 private var build_properties_is_done
= false
497 # The free init (implicitely constructed by the class if required)
498 var mfree_init
: nullable MMethodDef = null
502 # The base init of the class.
503 # Used to get the common new_msignature and initializers
505 # TODO: Where to put this information is not clear because unlike other
506 # informations, the initialisers are stable in a same class.
507 var root_init
: nullable MMethodDef = null
510 redef class MClassDef
511 # What is the `APropdef` associated to a `MProperty`?
512 # Used to check multiple definition of a property.
513 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
515 # Build the virtual type `SELF` only for introduction `MClassDef`
516 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
518 if not is_intro
then return
521 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
523 # If SELF type is declared nowherer?
524 if mprop
== null then return
526 # SELF is not a virtual type? it is weird but we ignore it
527 if not mprop
isa MVirtualTypeProp then return
529 # Is this the intro of SELF in the library?
530 var intro
= mprop
.intro
531 var intro_mclassdef
= intro
.mclassdef
532 if intro_mclassdef
== self then
533 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
535 # SELF must be declared in Object, otherwise this will create conflicts
536 if intro_mclassdef
.mclass
.name
!= "Object" then
537 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
540 # SELF must be public
541 if mprop
.visibility
!= public_visibility
then
542 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
545 # SELF must not be fixed
546 if intro
.is_fixed
then
547 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
553 # This class introduction inherits a SELF
554 # We insert an artificial property to update it
555 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
556 mpropdef
.bound
= mclass
.mclass_type
561 # The associated main model entity
562 type MPROPDEF: MPropDef
564 # The associated propdef once build by a `ModelBuilder`
565 var mpropdef
: nullable MPROPDEF is writable
567 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
568 private fun build_signature
(modelbuilder
: ModelBuilder) do end
569 private fun check_signature
(modelbuilder
: ModelBuilder) do end
570 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
572 var mvisibility
= public_visibility
573 if nvisibility
!= null then
574 mvisibility
= nvisibility
.mvisibility
575 if mvisibility
== intrude_visibility
then
576 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
577 mvisibility
= public_visibility
580 if mclassdef
.mclass
.visibility
== private_visibility
then
581 if mvisibility
== protected_visibility
then
582 assert nvisibility
!= null
583 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
584 else if mvisibility
== private_visibility
then
585 assert nvisibility
!= null
586 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
588 mvisibility
= private_visibility
593 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
595 var ndoc
= self.n_doc
597 var mdoc
= ndoc
.to_mdoc
599 mdoc
.original_mentity
= mpropdef
600 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
601 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
604 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
605 if at_deprecated
!= null then
606 if not mpropdef
.is_intro
then
607 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
609 var info
= new MDeprecationInfo
610 ndoc
= at_deprecated
.n_doc
611 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
612 mpropdef
.mproperty
.deprecation
= info
617 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
619 if nvisibility
== null then return
620 var mvisibility
= nvisibility
.mvisibility
621 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
622 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
626 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
628 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
629 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
632 if mprop
isa MMethod and mprop
.is_root_init
then return true
633 if kwredef
== null then
635 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
639 # Check for full-name conflicts in the package.
640 # A public property should have a unique qualified name `package::class::prop`.
641 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
642 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
643 if others
!= null then for other
in others
do
644 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
645 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}`.")
651 if not need_redef
then
652 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
659 # Checks for useless type in redef signatures.
660 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
663 redef class ASignature
664 # Is the model builder has correctly visited the signature
665 var is_visited
= false
666 # Names of parameters from the AST
667 # REQUIRE: is_visited
668 var param_names
= new Array[String]
669 # Types of parameters from the AST
670 # REQUIRE: is_visited
671 var param_types
= new Array[MType]
672 # Rank of the vararg (of -1 if none)
673 # REQUIRE: is_visited
674 var vararg_rank
: Int = -1
676 var ret_type
: nullable MType = null
678 # Visit and fill information about a signature
679 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
681 var mmodule
= mclassdef
.mmodule
682 var param_names
= self.param_names
683 var param_types
= self.param_types
684 for np
in self.n_params
do
685 param_names
.add
(np
.n_id
.text
)
686 var ntype
= np
.n_type
687 if ntype
!= null then
688 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
689 if mtype
== null then return false # Skip error
690 for i
in [0..param_names
.length-param_types
.length
[ do
691 param_types
.add
(mtype
)
693 if np
.n_dotdotdot
!= null then
694 if self.vararg_rank
!= -1 then
695 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
698 self.vararg_rank
= param_names
.length
- 1
703 var ntype
= self.n_type
704 if ntype
!= null then
705 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
706 if self.ret_type
== null then return false # Skip error
709 self.is_visited
= true
713 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
716 for np
in self.n_params
do
717 var ntype
= np
.n_type
718 if ntype
!= null then
719 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
724 var ntype
= self.n_type
725 if ntype
!= null then
726 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
730 if not res
then is_broken
= true
736 # The associated mparameter if any
737 var mparameter
: nullable MParameter = null
740 redef class AMethPropdef
741 redef type MPROPDEF: MMethodDef
743 # Is the method annotated `autoinit`?
744 var is_autoinit
= false
746 # Can self be used as a root init?
747 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
749 # Need the `init` keyword
750 if n_kwinit
== null then return false
751 # Need to by anonymous
752 if self.n_methid
!= null then return false
753 # No annotation on itself
754 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
756 var amod
= self.parent
.parent
.as(AModule)
757 var amoddecl
= amod
.n_moduledecl
758 if amoddecl
!= null then
759 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
760 if old
!= null then return false
763 if self.n_signature
.n_params
.length
> 0 then
764 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
767 # Cannot be private or something
768 if not self.n_visibility
isa APublicVisibility then
769 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
776 redef fun build_property
(modelbuilder
, mclassdef
)
778 var n_kwinit
= n_kwinit
779 var n_kwnew
= n_kwnew
780 var is_init
= n_kwinit
!= null or n_kwnew
!= null
782 var amethodid
= self.n_methid
784 if amethodid
== null then
788 else if n_kwinit
!= null then
791 else if n_kwnew
!= null then
797 else if amethodid
isa AIdMethid then
798 name
= amethodid
.n_id
.text
799 name_node
= amethodid
801 # operator, bracket or assign
802 name
= amethodid
.collect_text
803 name_node
= amethodid
805 var arity
= self.n_signature
.n_params
.length
806 if name
== "+" and arity
== 0 then
808 else if name
== "-" and arity
== 0 then
810 else if name
== "~" and arity
== 0 then
813 if amethodid
.is_binary
and arity
!= 1 then
814 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
815 else if amethodid
.min_arity
> arity
then
816 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
821 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
822 var mprop
: nullable MMethod = null
823 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
824 if mprop
== null and look_like_a_root_init
then
825 mprop
= modelbuilder
.the_root_init_mmethod
827 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
828 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
831 if mprop
== null then
832 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
833 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
834 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
835 modelbuilder
.the_root_init_mmethod
= mprop
836 mprop
.is_root_init
= true
838 mprop
.is_init
= is_init
839 mprop
.is_new
= n_kwnew
!= null
840 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
841 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
842 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
843 mprop
.is_broken
= true
847 if mprop
.is_broken
then
850 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
851 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
854 # Check name conflicts in the local class for constructors.
856 for p
, n
in mclassdef
.mprop2npropdef
do
857 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
858 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
859 mprop
.is_broken
= true
867 mclassdef
.mprop2npropdef
[mprop
] = self
869 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
871 set_doc
(mpropdef
, modelbuilder
)
873 self.mpropdef
= mpropdef
874 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
875 if mpropdef
.is_intro
then
876 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
878 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
882 redef fun build_signature
(modelbuilder
)
884 var mpropdef
= self.mpropdef
885 if mpropdef
== null then return # Error thus skiped
886 var mclassdef
= mpropdef
.mclassdef
887 var mmodule
= mclassdef
.mmodule
888 var nsig
= self.n_signature
890 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
891 var root_init
= mclassdef
.mclass
.root_init
892 if root_init
!= null then
893 # Inherit the initializers by refinement
894 mpropdef
.new_msignature
= root_init
.new_msignature
895 assert mpropdef
.initializers
.is_empty
896 mpropdef
.initializers
.add_all root_init
.initializers
900 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
901 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
903 # Retrieve info from the signature AST
904 var param_names
= new Array[String] # Names of parameters from the AST
905 var param_types
= new Array[MType] # Types of parameters from the AST
907 var ret_type
: nullable MType = null # Return type from the AST
909 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
910 param_names
= nsig
.param_names
911 param_types
= nsig
.param_types
912 vararg_rank
= nsig
.vararg_rank
913 ret_type
= nsig
.ret_type
916 # Look for some signature to inherit
917 # FIXME: do not inherit from the intro, but from the most specific
918 var msignature
: nullable MSignature = null
919 if not mpropdef
.is_intro
then
920 msignature
= mpropdef
.mproperty
.intro
.msignature
921 if msignature
== null then return # Skip error
923 # The local signature is adapted to use the local formal types, if any.
924 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
926 # Check inherited signature arity
927 if param_names
.length
!= msignature
.arity
then
929 if nsig
!= null then node
= nsig
else node
= self
930 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}`.")
933 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
934 # FIXME UGLY: inherit signature from a super-constructor
935 for msupertype
in mclassdef
.supertypes
do
936 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
937 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
938 if candidate
!= null then
939 if msignature
== null then
940 msignature
= candidate
.intro
.as(MMethodDef).msignature
947 # Inherit the signature
948 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
949 # Parameters are untyped, thus inherit them
950 param_types
= new Array[MType]
951 for mparameter
in msignature
.mparameters
do
952 param_types
.add
(mparameter
.mtype
)
954 vararg_rank
= msignature
.vararg_rank
956 if msignature
!= null and ret_type
== null then
957 ret_type
= msignature
.return_mtype
960 if param_names
.length
!= param_types
.length
then
961 # Some parameters are typed, other parameters are not typed.
962 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
966 var mparameters
= new Array[MParameter]
967 for i
in [0..param_names
.length
[ do
968 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
969 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
970 mparameters
.add
(mparameter
)
973 # In `new`-factories, the return type is by default the classtype.
974 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
976 # Special checks for operator methods
977 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
978 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
980 if ret_type
== null and return_is_mandatory
then
981 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
984 msignature
= new MSignature(mparameters
, ret_type
)
985 mpropdef
.msignature
= msignature
986 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
987 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
988 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
991 var at
= self.get_single_annotation
("lazy", modelbuilder
)
992 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
994 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
995 if atautoinit
!= null then
996 if not mpropdef
.is_intro
then
997 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
998 else if not mclassdef
.is_intro
then
999 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1001 self.is_autoinit
= true
1006 redef fun check_signature
(modelbuilder
)
1008 var mpropdef
= self.mpropdef
1009 if mpropdef
== null then return # Error thus skiped
1010 var mclassdef
= mpropdef
.mclassdef
1011 var mmodule
= mclassdef
.mmodule
1012 var nsig
= self.n_signature
1013 var mysignature
= mpropdef
.msignature
1014 if mysignature
== null then return # Error thus skiped
1017 if nsig
!= null then
1018 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1019 mpropdef
.msignature
= null # invalidate
1020 mpropdef
.is_broken
= true
1021 return # Forward error
1025 # Lookup for signature in the precursor
1026 # FIXME all precursors should be considered
1027 if not mpropdef
.is_intro
then
1028 var msignature
= mpropdef
.mproperty
.intro
.msignature
1029 if msignature
== null then return
1031 var precursor_ret_type
= msignature
.return_mtype
1032 var ret_type
= mysignature
.return_mtype
1033 if ret_type
!= null and precursor_ret_type
== null then
1034 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1035 mpropdef
.msignature
= null
1036 mpropdef
.is_broken
= true
1040 if mysignature
.arity
> 0 then
1041 # Check parameters types
1042 for i
in [0..mysignature
.arity
[ do
1043 var myt
= mysignature
.mparameters
[i
].mtype
1044 var prt
= msignature
.mparameters
[i
].mtype
1045 var node
= nsig
.n_params
[i
]
1046 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1047 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1048 mpropdef
.msignature
= null
1049 mpropdef
.is_broken
= true
1053 if precursor_ret_type
!= null then
1054 var node
: nullable ANode = null
1055 if nsig
!= null then node
= nsig
.n_type
1056 if node
== null then node
= self
1057 if ret_type
== null then
1058 # Inherit the return type
1059 ret_type
= precursor_ret_type
1060 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1061 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1062 mpropdef
.msignature
= null
1063 mpropdef
.is_broken
= true
1068 if mysignature
.arity
> 0 then
1069 # Check parameters visibility
1070 for i
in [0..mysignature
.arity
[ do
1071 var nt
= nsig
.n_params
[i
].n_type
1072 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1074 var nt
= nsig
.n_type
1075 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1077 check_repeated_types
(modelbuilder
)
1080 # For parameters, type is always useless in a redef.
1081 # For return type, type is useless if not covariant with introduction.
1082 redef fun check_repeated_types
(modelbuilder
) do
1083 var mpropdef
= self.mpropdef
1084 if mpropdef
== null then return
1085 if mpropdef
.is_intro
or n_signature
== null then return
1087 for param
in n_signature
.n_params
do
1088 if param
.n_type
!= null then
1089 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1093 var intro
= mpropdef
.mproperty
.intro
1094 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1095 if n_intro
== null or not n_intro
isa AMethPropdef then return
1097 var ret_type
= n_signature
.ret_type
1098 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1099 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1105 # Is a return required?
1107 # * True for operators and brackets.
1108 # * False for id and assignment.
1109 fun return_is_mandatory
: Bool do return true
1111 # Can the last parameter be special like a vararg?
1113 # * False for operators: the last one is in fact the only one.
1114 # * False for assignments: it is the right part of the assignment.
1115 # * True for ids and brackets.
1116 fun accept_special_last_parameter
: Bool do return false
1118 # The minimum required number of parameters.
1120 # * 1 for binary operators
1122 # * 1 for assignments
1123 # * 2 for bracket assignments
1125 fun min_arity
: Int do return 1
1127 # Is the `self` a binary operator?
1128 fun is_binary
: Bool do return true
1131 redef class AIdMethid
1132 redef fun return_is_mandatory
do return false
1133 redef fun accept_special_last_parameter
do return true
1134 redef fun min_arity
do return 0
1135 redef fun is_binary
do return false
1138 redef class ABraMethid
1139 redef fun accept_special_last_parameter
do return true
1140 redef fun is_binary
do return false
1143 redef class ABraassignMethid
1144 redef fun return_is_mandatory
do return false
1145 redef fun min_arity
do return 2
1146 redef fun is_binary
do return false
1149 redef class AAssignMethid
1150 redef fun return_is_mandatory
do return false
1151 redef fun is_binary
do return false
1154 redef class AAttrPropdef
1155 redef type MPROPDEF: MAttributeDef
1157 # The static type of the property (declared, inferred or inherited)
1158 # This attribute is also used to check if the property was analyzed and is valid.
1159 var mtype
: nullable MType
1161 # Is the node tagged `noinit`?
1164 # Is the node tagged lazy?
1167 # Has the node a default value?
1168 # Could be through `n_expr` or `n_block`
1169 var has_value
= false
1171 # The guard associated to a lazy attribute.
1172 # Because some engines does not have a working `isset`,
1173 # this additional attribute is used to guard the lazy initialization.
1174 # TODO: to remove once isset is correctly implemented
1175 var mlazypropdef
: nullable MAttributeDef
1177 # The associated getter (read accessor) if any
1178 var mreadpropdef
: nullable MMethodDef is writable
1179 # The associated setter (write accessor) if any
1180 var mwritepropdef
: nullable MMethodDef is writable
1182 redef fun build_property
(modelbuilder
, mclassdef
)
1184 var mclass
= mclassdef
.mclass
1186 var name
= nid2
.text
1188 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1189 if atabstract
== null then
1190 if not mclass
.kind
.need_init
then
1191 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1194 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1195 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1196 self.mpropdef
= mpropdef
1197 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1201 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1202 if mreadprop
== null then
1203 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1204 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1205 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1207 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1208 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1210 mclassdef
.mprop2npropdef
[mreadprop
] = self
1212 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1213 self.mreadpropdef
= mreadpropdef
1214 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1215 set_doc
(mreadpropdef
, modelbuilder
)
1216 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1217 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1219 has_value
= n_expr
!= null or n_block
!= null
1221 if atabstract
!= null and has_value
then
1222 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1226 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1227 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1228 if atnoinit
!= null then
1231 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1234 if atabstract
!= null then
1235 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1239 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1240 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1241 if atlazy
!= null or atlateinit
!= null then
1242 if atlazy
!= null and atlateinit
!= null then
1243 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1246 if not has_value
then
1247 if atlazy
!= null then
1248 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1249 else if atlateinit
!= null then
1250 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1256 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1257 mlazyprop
.is_fictive
= true
1258 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1259 mlazypropdef
.is_fictive
= true
1260 self.mlazypropdef
= mlazypropdef
1263 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1264 if atreadonly
!= null then
1265 if not has_value
then
1266 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1268 # No setter, so just leave
1272 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1273 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1276 var writename
= name
+ "="
1277 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1278 if atwritable
!= null then
1279 if not atwritable
.n_args
.is_empty
then
1280 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1283 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1284 var nwkwredef
: nullable Token = null
1285 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1286 if mwriteprop
== null then
1288 if atwritable
!= null then
1289 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1291 mvisibility
= mreadprop
.visibility
1292 # By default, use protected visibility at most
1293 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1295 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1296 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1297 mwriteprop
.deprecation
= mreadprop
.deprecation
1299 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1300 if atwritable
!= null then
1301 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1304 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1306 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1307 self.mwritepropdef
= mwritepropdef
1308 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1309 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1310 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1312 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1313 if atautoinit
!= null then
1315 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1316 else if not mwritepropdef
.is_intro
then
1317 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1318 else if not mclassdef
.is_intro
then
1319 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1320 else if atabstract
== null then
1321 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1323 else if atabstract
!= null then
1324 # By default, abstract attribute are not autoinit
1329 redef fun build_signature
(modelbuilder
)
1331 var mreadpropdef
= self.mreadpropdef
1332 var mpropdef
= self.mpropdef
1333 if mreadpropdef
== null then return # Error thus skipped
1334 var mclassdef
= mreadpropdef
.mclassdef
1335 var mmodule
= mclassdef
.mmodule
1336 var mtype
: nullable MType = null
1339 var ntype
= self.n_type
1340 if ntype
!= null then
1341 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1342 if mtype
== null then return
1345 var inherited_type
: nullable MType = null
1346 # Inherit the type from the getter (usually an abstract getter)
1347 if not mreadpropdef
.is_intro
then
1348 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1349 if msignature
== null then return # Error, thus skipped
1350 inherited_type
= msignature
.return_mtype
1351 if inherited_type
!= null then
1352 # The inherited type is adapted to use the local formal types, if any.
1353 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1354 if mtype
== null then mtype
= inherited_type
1358 var nexpr
= self.n_expr
1359 if mtype
== null then
1360 if nexpr
!= null then
1361 if nexpr
isa ANewExpr then
1362 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1363 else if nexpr
isa AIntegerExpr then
1364 var cla
: nullable MClass = null
1365 if nexpr
.value
isa Int then
1366 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1367 else if nexpr
.value
isa Byte then
1368 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1369 else if nexpr
.value
isa Int8 then
1370 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1371 else if nexpr
.value
isa Int16 then
1372 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1373 else if nexpr
.value
isa UInt16 then
1374 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1375 else if nexpr
.value
isa Int32 then
1376 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1377 else if nexpr
.value
isa UInt32 then
1378 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1380 # Should not happen, and should be updated as new types are added
1383 if cla
!= null then mtype
= cla
.mclass_type
1384 else if nexpr
isa AFloatExpr then
1385 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1386 if cla
!= null then mtype
= cla
.mclass_type
1387 else if nexpr
isa ACharExpr then
1388 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1389 if cla
!= null then mtype
= cla
.mclass_type
1390 else if nexpr
isa ABoolExpr then
1391 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1392 if cla
!= null then mtype
= cla
.mclass_type
1393 else if nexpr
isa ASuperstringExpr then
1394 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1395 if cla
!= null then mtype
= cla
.mclass_type
1396 else if nexpr
isa AStringFormExpr then
1397 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1398 if cla
!= null then mtype
= cla
.mclass_type
1400 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1403 if mtype
== null then return
1405 else if ntype
!= null and inherited_type
== mtype
then
1406 if nexpr
isa ANewExpr then
1407 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1408 if xmtype
== mtype
then
1409 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1414 if mtype
== null then
1415 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1421 if mpropdef
!= null then
1422 mpropdef
.static_mtype
= mtype
1426 var msignature
= new MSignature(new Array[MParameter], mtype
)
1427 mreadpropdef
.msignature
= msignature
1430 var mwritepropdef
= self.mwritepropdef
1431 if mwritepropdef
!= null then
1434 var mparameter
= new MParameter(name
, mtype
, false)
1435 var msignature
= new MSignature([mparameter
], null)
1436 mwritepropdef
.msignature
= msignature
1439 var mlazypropdef
= self.mlazypropdef
1440 if mlazypropdef
!= null then
1441 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1443 check_repeated_types
(modelbuilder
)
1446 redef fun check_signature
(modelbuilder
)
1448 var mpropdef
= self.mpropdef
1449 if mpropdef
== null then return # Error thus skipped
1450 var ntype
= self.n_type
1451 var mtype
= self.mtype
1452 if mtype
== null then return # Error thus skipped
1454 var mclassdef
= mpropdef
.mclassdef
1455 var mmodule
= mclassdef
.mmodule
1458 if ntype
!= null then
1459 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1462 if nexpr
isa ANewExpr then
1463 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1466 # Lookup for signature in the precursor
1467 # FIXME all precursors should be considered
1468 if not mpropdef
.is_intro
then
1469 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1470 if precursor_type
== null then return
1472 if mtype
!= precursor_type
then
1473 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1478 # Check getter and setter
1479 var meth
= self.mreadpropdef
1480 if meth
!= null then
1481 self.check_method_signature
(modelbuilder
, meth
)
1482 var node
: nullable ANode = ntype
1483 if node
== null then node
= self
1484 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1486 meth
= self.mwritepropdef
1487 if meth
!= null then
1488 self.check_method_signature
(modelbuilder
, meth
)
1489 var node
: nullable ANode = ntype
1490 if node
== null then node
= self
1491 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1495 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1497 var mclassdef
= mpropdef
.mclassdef
1498 var mmodule
= mclassdef
.mmodule
1499 var nsig
= self.n_type
1500 var mysignature
= mpropdef
.msignature
1501 if mysignature
== null then return # Error thus skiped
1503 # Lookup for signature in the precursor
1504 # FIXME all precursors should be considered
1505 if not mpropdef
.is_intro
then
1506 var msignature
= mpropdef
.mproperty
.intro
.msignature
1507 if msignature
== null then return
1509 if mysignature
.arity
!= msignature
.arity
then
1511 if nsig
!= null then node
= nsig
else node
= self
1512 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}`.")
1515 var precursor_ret_type
= msignature
.return_mtype
1516 var ret_type
= mysignature
.return_mtype
1517 if ret_type
!= null and precursor_ret_type
== null then
1519 if nsig
!= null then node
= nsig
else node
= self
1520 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1524 if mysignature
.arity
> 0 then
1525 # Check parameters types
1526 for i
in [0..mysignature
.arity
[ do
1527 var myt
= mysignature
.mparameters
[i
].mtype
1528 var prt
= msignature
.mparameters
[i
].mtype
1530 if nsig
!= null then node
= nsig
else node
= self
1531 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1532 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1536 if precursor_ret_type
!= null then
1538 if nsig
!= null then node
= nsig
else node
= self
1539 if ret_type
== null then
1540 # Inherit the return type
1541 ret_type
= precursor_ret_type
1542 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1543 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1549 # Type is useless if the attribute type is the same thant the intro.
1550 redef fun check_repeated_types
(modelbuilder
) do
1551 var mreadpropdef
= self.mreadpropdef
1552 if mreadpropdef
== null then return
1553 if mreadpropdef
.is_intro
or n_type
== null then return
1555 var intro
= mreadpropdef
.mproperty
.intro
1556 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1557 if n_intro
== null then return
1560 if n_intro
isa AMethPropdef then
1561 ntype
= n_intro
.n_signature
.ret_type
1562 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1563 ntype
= n_intro
.n_type
.mtype
1566 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1567 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1571 redef class ATypePropdef
1572 redef type MPROPDEF: MVirtualTypeDef
1574 redef fun build_property
(modelbuilder
, mclassdef
)
1576 var name
= self.n_id
.text
1577 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1578 if mprop
== null then
1579 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1580 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1581 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1582 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1585 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1587 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1588 assert mprop
isa MVirtualTypeProp
1589 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1591 mclassdef
.mprop2npropdef
[mprop
] = self
1593 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1594 self.mpropdef
= mpropdef
1595 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1596 if mpropdef
.is_intro
then
1597 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1599 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1601 set_doc
(mpropdef
, modelbuilder
)
1603 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1604 if atfixed
!= null then
1605 mpropdef
.is_fixed
= true
1609 redef fun build_signature
(modelbuilder
)
1611 var mpropdef
= self.mpropdef
1612 if mpropdef
== null then return # Error thus skipped
1613 var mclassdef
= mpropdef
.mclassdef
1614 var mmodule
= mclassdef
.mmodule
1615 var mtype
: nullable MType = null
1617 var ntype
= self.n_type
1618 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1619 if mtype
== null then return
1621 mpropdef
.bound
= mtype
1622 # print "{mpropdef}: {mtype}"
1625 redef fun check_signature
(modelbuilder
)
1627 var mpropdef
= self.mpropdef
1628 if mpropdef
== null then return # Error thus skipped
1630 var bound
= mpropdef
.bound
1631 if bound
== null then return # Error thus skipped
1633 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1635 var mclassdef
= mpropdef
.mclassdef
1636 var mmodule
= mclassdef
.mmodule
1637 var anchor
= mclassdef
.bound_mtype
1639 var ntype
= self.n_type
1640 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1641 mpropdef
.bound
= null
1645 # Check redefinitions
1646 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1647 var supbound
= p
.bound
1648 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1650 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1653 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1654 # Still a warning to pass existing bad code
1655 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1658 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1659 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")