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 # Associate a `npropdef` with its `mpropdef`
47 # Be careful, this method is unsafe, no checking is done when it's used.
48 # The safe way to add method it's to use the `build_property`
50 # See `mpropdef2npropdef`
51 fun unsafe_add_mpropdef2npropdef
(mpropdef
: MPropDef,npropdef
: APropdef)
53 mpropdef2npropdef
[mpropdef
] = npropdef
56 # Retrieve the associated AST node of a mpropertydef.
57 # This method is used to associate model entity with syntactic entities.
59 # If the property definition is not associated with a node, returns `null`.
60 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
63 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
65 # Run the phases on it
66 toolcontext
.run_phases_on_npropdef
(res
)
69 # Fall back to the class node if any.
70 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
71 if res
!= null then return res
75 # Retrieve all the attributes nodes localy definied
76 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
77 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
79 var res
= new Array[AAttrPropdef]
80 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
81 if n
== null then return res
82 for npropdef
in n
.n_propdefs
do
83 if npropdef
isa AAttrPropdef then
84 # Run the phases on it
85 toolcontext
.run_phases_on_npropdef
(npropdef
)
92 # Build the properties of `nclassdef`.
93 private fun build_properties
(nclassdef
: AClassdef)
95 # Force building recursively
96 if nclassdef
.build_properties_is_done
then return
97 nclassdef
.build_properties_is_done
= true
98 var mclassdef
= nclassdef
.mclassdef
99 if mclassdef
== null then return # skip error
100 if mclassdef
.in_hierarchy
== null then return # Skip error
101 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
102 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
103 build_properties
(mclassdef2nclassdef
[superclassdef
])
106 mclassdef
.build_self_type
(self, nclassdef
)
107 for nclassdef2
in nclassdef
.all_defs
do
108 for npropdef
in nclassdef2
.n_propdefs
do
109 npropdef
.build_property
(self, mclassdef
)
111 for npropdef
in nclassdef2
.n_propdefs
do
112 npropdef
.build_signature
(self)
114 for npropdef
in nclassdef2
.n_propdefs
do
115 if not npropdef
isa ATypePropdef then continue
117 var mpropdef
= npropdef
.mpropdef
118 if mpropdef
== null then continue
119 if mpropdef
.bound
== null then continue
120 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
121 # Invalidate the bound
122 mpropdef
.is_broken
= true
123 mpropdef
.bound
= new MErrorType(mclassdef
.mmodule
.model
)
126 for npropdef
in nclassdef2
.n_propdefs
do
127 # Check ATypePropdef first since they may be required for the other properties
128 if not npropdef
isa ATypePropdef then continue
129 npropdef
.check_signature
(self)
132 for npropdef
in nclassdef2
.n_propdefs
do
133 if npropdef
isa ATypePropdef then continue
134 npropdef
.check_signature
(self)
137 process_default_constructors
(nclassdef
)
140 # the root init of the Object class
141 # Is usually implicitly defined
142 # Then explicit or implicit definitions of root-init are attached to it
143 var the_root_init_mmethod
: nullable MMethod
145 # Introduce or inherit default constructor
146 # This is the last part of `build_properties`.
147 private fun process_default_constructors
(nclassdef
: AClassdef)
149 var mclassdef
= nclassdef
.mclassdef
.as(not null)
151 # Are we a refinement
152 if not mclassdef
.is_intro
then
153 # Set the default_init of the mclassdef with the intro default_init
154 mclassdef
.default_init
= mclassdef
.mclass
.intro
.default_init
158 # Look for the init in Object, or create it
159 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
160 # Create the implicit root-init method
161 var mprop
= new MMethod(mclassdef
, "init", nclassdef
.location
, mclassdef
.mclass
.visibility
)
162 mprop
.is_root_init
= true
163 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
164 var mparameters
= new Array[MParameter]
165 var msignature
= new MSignature(mparameters
, null)
166 mpropdef
.msignature
= msignature
168 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
169 the_root_init_mmethod
= mprop
172 # Is there already a constructor defined?
173 var defined_init
: nullable MMethodDef = null
174 for mpropdef
in mclassdef
.mpropdefs
do
175 if not mpropdef
isa MMethodDef then continue
176 if not mpropdef
.mproperty
.is_init
then continue
177 if mpropdef
.mproperty
.is_root_init
then
178 assert defined_init
== null
179 defined_init
= mpropdef
180 else if mpropdef
.name
== "defaultinit" then
185 if mclassdef
.default_init
!= null then return
187 # If the class is not AStdClassdef or it's an enum just return. No defaultinit is need.
188 if not nclassdef
isa AStdClassdef or nclassdef
.n_classkind
isa AEnumClasskind then return
190 # Collect undefined attributes
191 var mparameters
= new Array[MParameter]
192 var initializers
= new Array[MProperty]
193 for npropdef
in nclassdef
.n_propdefs
do
194 if npropdef
isa AMethPropdef then
195 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
196 var mpropdef
= npropdef
.mpropdef
197 if mpropdef
== null then return # Skip broken method
198 var sig
= mpropdef
.msignature
199 if sig
== null then continue # Skip broken method
200 mparameters
.add_all sig
.mparameters
201 initializers
.add
(mpropdef
.mproperty
)
202 mpropdef
.mproperty
.is_autoinit
= true
204 if npropdef
isa AAttrPropdef then
205 var mreadpropdef
= npropdef
.mreadpropdef
206 if mreadpropdef
== null then return # Skip broken attribute
207 var msignature
= mreadpropdef
.msignature
208 if msignature
== null then return # Skip broken attribute
209 if npropdef
.noinit
then continue # Skip noinit attribute
210 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
211 if atlateinit
!= null then
212 # For lateinit attributes, call the reader to force
213 # the lazy initialization of the attribute.
214 initializers
.add
(mreadpropdef
.mproperty
)
215 mreadpropdef
.mproperty
.is_autoinit
= true
218 if npropdef
.has_value
and not npropdef
.is_optional
then continue
219 var msetter
= npropdef
.mwritepropdef
220 if msetter
== null then
221 # No setter, it is a readonly attribute, so just add it
222 var paramname
= mreadpropdef
.mproperty
.name
223 var ret_type
= msignature
.return_mtype
224 if ret_type
== null then return
225 var mparameter
= new MParameter(paramname
, ret_type
, false)
226 mparameters
.add
(mparameter
)
228 initializers
.add
(npropdef
.mpropdef
.mproperty
)
229 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
231 # Add the setter to the list
232 mparameters
.add_all msetter
.msignature
.mparameters
233 initializers
.add
(msetter
.mproperty
)
234 msetter
.mproperty
.is_autoinit
= true
239 var the_root_init_mmethod
= self.the_root_init_mmethod
240 if the_root_init_mmethod
== null then return
242 # Look for most-specific new-stype init definitions
243 var spropdefs
= new ArraySet[MMethodDef]
245 for x
in mclassdef
.get_direct_supermtype
do
246 var y
= x
.mclass
.intro
.default_init
247 if y
== null then continue
248 if y
.is_broken
or y
.msignature
== null then return
252 # Look at the autoinit class-annotation
253 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
254 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
255 if autoinit
!= null then
256 # Just throws the collected initializers
260 if noautoinit
!= null then
261 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
264 if autoinit
.n_args
.is_empty
then
265 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
268 # Get and check each argument
269 for narg
in autoinit
.n_args
do
272 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
276 # Search the property.
277 # To avoid bad surprises, try to get the setter first.
278 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
280 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
283 error
(narg
, "Error: unknown method `{id}`")
286 if not p
.is_autoinit
then
287 error
(narg
, "Error: `{p}` is not an autoinit method")
291 # Register the initializer and the parameters
294 if pd
isa MMethodDef then
295 # Get the signature resolved for the current receiver
296 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
297 mparameters
.add_all
(sig
.mparameters
)
303 else if spropdefs
.not_empty
then
304 # Search for inherited manual defaultinit
306 for s
in spropdefs
do
307 if mpropdef2npropdef
.has_key
(s
) then
308 self.toolcontext
.info
("{mclassdef} inherits a manual defaultinit {s}", 3)
312 # Search the longest-one and checks for conflict
313 var longest
= spropdefs
.first
314 if spropdefs
.length
> 1 then
315 # part 1. find the longest list
316 for spd
in spropdefs
do
317 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
319 if spd
!= manual
and manual
!= null then
320 self.toolcontext
.info
("{mclassdef} conflict between manual defaultinit {manual} and automatic defaultinit {spd}.", 3)
323 # conflict with manual autoinit?
324 if longest
!= manual
and manual
!= null then
325 self.error
(nclassdef
, "Error: conflict between manual defaultinit {manual} and automatic defaultinit {longest}.")
328 # Check for conflict in the order of initializers
329 # Each initializer list must me a prefix of the longest list
330 # If `noautoinit` is set, just ignore conflicts
331 if noautoinit
== null then for spd
in spropdefs
do
333 for p
in spd
.initializers
do
334 if p
!= longest
.initializers
[i
] then
335 var proposal
= new ArraySet[MProperty]
336 for spd2
in spropdefs
do
337 proposal
.add_all spd2
.initializers
339 proposal
.add_all initializers
340 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(", ")}`")
341 # TODO: invalidate the initializer to avoid more errors
349 if noautoinit
!= null then
350 # If there is local or inherited initializers, then complain.
351 if initializers
.is_empty
and longest
.initializers
.is_empty
then
352 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
354 # Just clear initializers
358 # Combine the inherited list to what is collected
359 if longest
.initializers
.length
> 0 then
360 mparameters
.prepend longest
.msignature
.mparameters
361 initializers
.prepend longest
.initializers
366 # Create a specific new autoinit constructor
368 var mprop
= new MMethod(mclassdef
, "defaultinit", nclassdef
.location
, public_visibility
)
370 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
371 mpropdef
.initializers
.add_all
(initializers
)
372 var msignature
= new MSignature(mparameters
, null)
373 mpropdef
.msignature
= msignature
374 mclassdef
.default_init
= mpropdef
375 self.toolcontext
.info
("{mclassdef} gets a free auto constructor `{mpropdef}{msignature}`. {spropdefs}", 3)
376 mclassdef
.mclass
.the_root_init_mmethod
= the_root_init_mmethod
380 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
381 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
383 var mmodule
= mpropdef
.mclassdef
.mmodule
384 var mproperty
= mpropdef
.mproperty
386 # Extract visibility information of the main part of `mtype`
387 # It is a case-by case
388 var vis_type
: nullable MVisibility = null # The own visibility of the type
389 var mmodule_type
: nullable MModule = null # The original module of the type
390 mtype
= mtype
.undecorate
391 if mtype
isa MClassType then
392 vis_type
= mtype
.mclass
.visibility
393 mmodule_type
= mtype
.mclass
.intro_mmodule
394 else if mtype
isa MVirtualType then
395 vis_type
= mtype
.mproperty
.visibility
396 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
397 else if mtype
isa MParameterType then
398 # nothing, always visible
399 else if mtype
isa MNullType then
401 else if mtype
isa MBottomType then
403 else if mtype
isa MErrorType then
406 node
.debug
"Unexpected type {mtype}"
410 if vis_type
!= null then
411 assert mmodule_type
!= null
412 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
413 if mproperty
.visibility
> vis_type
then
414 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
416 else if mproperty
.visibility
> vis_module_type
then
417 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
422 # No error, try to go deeper in generic types
423 if node
isa AType then
424 for a
in node
.n_types
do
426 if t
== null then continue # Error, thus skipped
427 check_visibility
(a
, t
, mpropdef
)
429 else if mtype
isa MGenericType then
430 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
434 # Detect circularity errors for virtual types.
435 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
438 # Slow case: progress on each resolution until we visit all without getting a loop
440 # The graph used to detect loops
441 var mtype
= mproperty
.mvirtualtype
442 var poset
= new POSet[MType]
444 # The work-list of types to resolve
445 var todo
= new List[MType]
448 while not todo
.is_empty
do
452 if not t
.need_anchor
then continue
454 # Get the types derived of `t` (subtypes and bounds)
456 if t
isa MNullableType then
458 else if t
isa MGenericType then
460 else if t
isa MVirtualType then
462 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
463 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
464 if defs
.is_empty
then return false
465 nexts
= new Array[MType]
467 var next
= defs
.first
.bound
468 if next
== null then return false
471 else if t
isa MClassType then
472 # Basic type, nothing to to
474 else if t
isa MParameterType then
475 # Parameter types cannot depend on virtual types, so nothing to do
483 if poset
.has_edge
(next
, t
) then
484 if mtype
== next
then
485 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
487 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
491 poset
.add_edge
(t
, next
)
501 # Does the MPropDef contains a call to super or a call of a super-constructor?
502 # Subsequent phases of the frontend (esp. typing) set it if required
503 var has_supercall
: Bool = false is writable
506 redef class AClassdef
507 # Marker used in `ModelBuilder::build_properties`
508 private var build_properties_is_done
= false
512 # The base init of the class.
514 # TODO: merge with `root_init` and `ModelBuilder::the_root_init_mmethod` if possible
515 var the_root_init_mmethod
: nullable MMethod = null
518 redef class MClassDef
519 # What is the `APropdef` associated to a `MProperty`?
520 # Used to check multiple definition of a property.
521 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
523 # Build the virtual type `SELF` only for introduction `MClassDef`
524 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
526 if not is_intro
then return
529 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
531 # If SELF type is declared nowherer?
532 if mprop
== null then return
534 # SELF is not a virtual type? it is weird but we ignore it
535 if not mprop
isa MVirtualTypeProp then return
537 # Is this the intro of SELF in the library?
538 var intro
= mprop
.intro
539 var intro_mclassdef
= intro
.mclassdef
540 if intro_mclassdef
== self then
541 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
543 # SELF must be declared in Object, otherwise this will create conflicts
544 if intro_mclassdef
.mclass
.name
!= "Object" then
545 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
548 # SELF must be public
549 if mprop
.visibility
!= public_visibility
then
550 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
553 # SELF must not be fixed
554 if intro
.is_fixed
then
555 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
561 # This class introduction inherits a SELF
562 # We insert an artificial property to update it
563 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
564 mpropdef
.bound
= mclass
.mclass_type
569 # The associated main model entity
570 type MPROPDEF: MPropDef
572 # The associated propdef once build by a `ModelBuilder`
573 var mpropdef
: nullable MPROPDEF is writable
575 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
576 private fun build_signature
(modelbuilder
: ModelBuilder) do end
577 private fun check_signature
(modelbuilder
: ModelBuilder) do end
578 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
580 var mvisibility
= public_visibility
581 if nvisibility
!= null then
582 mvisibility
= nvisibility
.mvisibility
583 if mvisibility
== intrude_visibility
then
584 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
585 mvisibility
= public_visibility
588 if mclassdef
.mclass
.visibility
== private_visibility
then
589 if mvisibility
== protected_visibility
then
590 assert nvisibility
!= null
591 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
592 else if mvisibility
== private_visibility
then
593 assert nvisibility
!= null
594 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
596 mvisibility
= private_visibility
601 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
603 var ndoc
= self.n_doc
605 var mdoc
= ndoc
.to_mdoc
607 mdoc
.original_mentity
= mpropdef
608 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
and mpropdef
.name
!= "new" then
609 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
612 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
613 if at_deprecated
!= null then
614 if not mpropdef
.is_intro
then
615 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
617 var info
= new MDeprecationInfo
618 ndoc
= at_deprecated
.n_doc
619 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
620 mpropdef
.mproperty
.deprecation
= info
625 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
627 if nvisibility
== null then return
628 var mvisibility
= nvisibility
.mvisibility
629 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
630 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
634 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
636 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
637 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
640 if mprop
isa MMethod and mprop
.is_root_init
then return true
641 if kwredef
== null then
643 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
647 # Check for full-name conflicts in the package.
648 # A public property should have a unique qualified name `package::class::prop`.
649 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
650 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
651 if others
!= null then for other
in others
do
652 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
653 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}`.")
659 if not need_redef
then
660 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
667 # Checks for useless type in redef signatures.
668 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
671 redef class ASignature
672 # Is the model builder has correctly visited the signature
673 var is_visited
= false
674 # Names of parameters from the AST
675 # REQUIRE: is_visited
676 var param_names
= new Array[String]
677 # Types of parameters from the AST
678 # REQUIRE: is_visited
679 var param_types
= new Array[MType]
680 # Rank of the vararg (of -1 if none)
681 # REQUIRE: is_visited
682 var vararg_rank
: Int = -1
684 var ret_type
: nullable MType = null
686 # Visit and fill information about a signature
687 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
689 var param_names
= self.param_names
690 var param_types
= self.param_types
691 for np
in self.n_params
do
692 param_names
.add
(np
.n_id
.text
)
693 var ntype
= np
.n_type
694 if ntype
!= null then
695 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
696 if mtype
== null then return false # Skip error
697 for i
in [0..param_names
.length-param_types
.length
[ do
698 param_types
.add
(mtype
)
700 if np
.n_dotdotdot
!= null then
701 if self.vararg_rank
!= -1 then
702 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
705 self.vararg_rank
= param_names
.length
- 1
710 var ntype
= self.n_type
711 if ntype
!= null then
712 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
713 if self.ret_type
== null then return false # Skip error
716 self.is_visited
= true
720 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
723 for np
in self.n_params
do
724 var ntype
= np
.n_type
725 if ntype
!= null then
726 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
731 var ntype
= self.n_type
732 if ntype
!= null then
733 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
737 if not res
then is_broken
= true
743 # The associated mparameter if any
744 var mparameter
: nullable MParameter = null
747 redef class AMethPropdef
748 redef type MPROPDEF: MMethodDef
750 # Is the method annotated `autoinit`?
751 var is_autoinit
= false
753 # Can self be used as a root init?
754 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
756 # Need the `init` keyword
757 if n_kwinit
== null then return false
758 # Need to by anonymous
759 if self.n_methid
!= null then return false
760 # No annotation on itself
761 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
763 var amod
= self.parent
.parent
.as(AModule)
764 var amoddecl
= amod
.n_moduledecl
765 if amoddecl
!= null then
766 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
767 if old
!= null then return false
770 if self.n_signature
.n_params
.length
> 0 then
771 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
774 # Cannot be private or something
775 if not self.n_visibility
isa APublicVisibility then
776 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
783 redef fun build_property
(modelbuilder
, mclassdef
)
785 var n_kwinit
= n_kwinit
786 var n_kwnew
= n_kwnew
787 var is_new
= n_kwnew
!= null
788 var is_init
= n_kwinit
!= null or is_new
790 var amethodid
= self.n_methid
792 var is_old_style_init
= false
793 if amethodid
== null then
794 if n_kwinit
!= null then
797 var old_style_annot
= get_single_annotation
("old_style_init", modelbuilder
)
798 if old_style_annot
!= null or self.n_signature
.n_params
.not_empty
then
800 if old_style_annot
!= null then is_old_style_init
= true
802 else if n_kwnew
!= null then
809 else if amethodid
isa AIdMethid then
810 name
= amethodid
.n_id
.text
811 name_node
= amethodid
813 # operator, bracket or assign
814 name
= amethodid
.collect_text
815 name_node
= amethodid
817 var arity
= self.n_signature
.n_params
.length
818 if name
== "+" and arity
== 0 then
820 else if name
== "-" and arity
== 0 then
822 else if name
== "~" and arity
== 0 then
825 if amethodid
.is_binary
and arity
!= 1 then
826 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
827 else if amethodid
.min_arity
> arity
then
828 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
833 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
834 var mprop
: nullable MMethod = null
835 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)
836 if mprop
== null and look_like_a_root_init
then
837 mprop
= modelbuilder
.the_root_init_mmethod
839 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
840 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
843 if mprop
== null then
844 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
845 mprop
= new MMethod(mclassdef
, name
, self.location
, mvisibility
)
846 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
847 modelbuilder
.the_root_init_mmethod
= mprop
848 mprop
.is_root_init
= true
850 mprop
.is_init
= is_init
851 mprop
.is_new
= is_new
852 if is_new
then mclassdef
.mclass
.has_new_factory
= true
853 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
854 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
855 mprop
.is_broken
= true
859 if mprop
.is_broken
then return
860 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
861 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
864 # Check name conflicts in the local class for constructors.
866 for p
, n
in mclassdef
.mprop2npropdef
do
867 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
868 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
869 mprop
.is_broken
= true
877 mclassdef
.mprop2npropdef
[mprop
] = self
879 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
880 if mpropdef
.name
== "defaultinit" and mclassdef
.is_intro
then
881 assert mclassdef
.default_init
== null
882 mpropdef
.is_old_style_init
= is_old_style_init
883 mclassdef
.default_init
= mpropdef
884 # Set the initializers with the mproperty.
885 # This point is need when a super class define this own default_init and inherited class use the default_init generated automaticlely.
886 mpropdef
.initializers
.add mprop
887 mpropdef
.is_calling_init
= true
890 set_doc
(mpropdef
, modelbuilder
)
892 self.mpropdef
= mpropdef
893 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
894 if mpropdef
.is_intro
then
895 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
897 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
901 redef fun build_signature
(modelbuilder
)
903 var mpropdef
= self.mpropdef
904 if mpropdef
== null then return # Error thus skiped
905 var mproperty
= mpropdef
.mproperty
906 var mclassdef
= mpropdef
.mclassdef
907 var mmodule
= mclassdef
.mmodule
908 var nsig
= self.n_signature
910 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
911 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
913 # Retrieve info from the signature AST
914 var param_names
= new Array[String] # Names of parameters from the AST
915 var param_types
= new Array[MType] # Types of parameters from the AST
917 var ret_type
: nullable MType = null # Return type from the AST
919 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
920 param_names
= nsig
.param_names
921 param_types
= nsig
.param_types
922 vararg_rank
= nsig
.vararg_rank
923 ret_type
= nsig
.ret_type
926 # Look for some signature to inherit
927 # FIXME: do not inherit from the intro, but from the most specific
928 var msignature
: nullable MSignature = null
929 if not mpropdef
.is_intro
then
930 msignature
= mproperty
.intro
.msignature
931 if msignature
== null then return # Skip error
933 # The local signature is adapted to use the local formal types, if any.
934 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
936 # Check inherited signature arity
937 if param_names
.length
!= msignature
.arity
then
939 if nsig
!= null then node
= nsig
else node
= self
940 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mproperty.name}{msignature}`; got {param_names.length}. See introduction at `{mproperty.full_name}`.")
943 else if mproperty
.is_init
and not mproperty
.is_new
then
944 # FIXME UGLY: inherit signature from a super-constructor
945 for msupertype
in mclassdef
.supertypes
do
946 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
947 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mproperty
.name
)
948 if candidate
!= null then
949 if msignature
== null then
950 msignature
= candidate
.intro
.as(MMethodDef).msignature
957 # Inherit the signature
958 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
959 # Parameters are untyped, thus inherit them
960 param_types
= new Array[MType]
961 for mparameter
in msignature
.mparameters
do
962 param_types
.add
(mparameter
.mtype
)
964 vararg_rank
= msignature
.vararg_rank
966 if msignature
!= null and ret_type
== null then
967 ret_type
= msignature
.return_mtype
970 if param_names
.length
!= param_types
.length
then
971 # Some parameters are typed, other parameters are not typed.
972 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
976 var mparameters
= new Array[MParameter]
977 for i
in [0..param_names
.length
[ do
978 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
979 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
980 mparameters
.add
(mparameter
)
983 # In `new`-factories, the return type is by default the classtype.
984 if ret_type
== null and mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
986 # Special checks for operator methods
987 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
988 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mproperty.name}`.")
990 if ret_type
== null and return_is_mandatory
then
991 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mproperty.name}`.")
994 msignature
= new MSignature(mparameters
, ret_type
)
995 mpropdef
.msignature
= msignature
996 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
997 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
998 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
1001 var at
= self.get_single_annotation
("lazy", modelbuilder
)
1002 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
1004 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1005 if atautoinit
!= null then
1006 if not mpropdef
.is_intro
then
1007 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
1008 else if not mclassdef
.is_intro
then
1009 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1011 self.is_autoinit
= true
1016 redef fun check_signature
(modelbuilder
)
1018 var mpropdef
= self.mpropdef
1019 if mpropdef
== null then return # Error thus skiped
1020 var mclassdef
= mpropdef
.mclassdef
1021 var mmodule
= mclassdef
.mmodule
1022 var nsig
= self.n_signature
1023 var mysignature
= mpropdef
.msignature
1024 if mysignature
== null then return # Error thus skiped
1027 if nsig
!= null then
1028 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1029 mpropdef
.msignature
= null # invalidate
1030 mpropdef
.is_broken
= true
1031 return # Forward error
1035 # Lookup for signature in the precursor
1036 # FIXME all precursors should be considered
1037 if not mpropdef
.is_intro
then
1038 var msignature
= mpropdef
.mproperty
.intro
.msignature
1039 if msignature
== null then return
1041 var precursor_ret_type
= msignature
.return_mtype
1042 var ret_type
= mysignature
.return_mtype
1043 if ret_type
!= null and precursor_ret_type
== null then
1044 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1045 mpropdef
.msignature
= null
1046 mpropdef
.is_broken
= true
1050 if mysignature
.arity
> 0 then
1051 # Check parameters types
1052 for i
in [0..mysignature
.arity
[ do
1053 var myt
= mysignature
.mparameters
[i
].mtype
1054 var prt
= msignature
.mparameters
[i
].mtype
1055 var node
= nsig
.n_params
[i
]
1056 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1057 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1058 mpropdef
.msignature
= null
1059 mpropdef
.is_broken
= true
1063 if precursor_ret_type
!= null then
1064 var node
: nullable ANode = null
1065 if nsig
!= null then node
= nsig
.n_type
1066 if node
== null then node
= self
1067 if ret_type
== null then
1068 # Inherit the return type
1069 ret_type
= precursor_ret_type
1070 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1071 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1072 mpropdef
.msignature
= null
1073 mpropdef
.is_broken
= true
1078 if nsig
!= null then
1079 # Check parameters visibility
1080 for i
in [0..mysignature
.arity
[ do
1081 var nt
= nsig
.n_params
[i
].n_type
1082 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1084 var nt
= nsig
.n_type
1085 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1087 check_repeated_types
(modelbuilder
)
1090 # For parameters, type is always useless in a redef.
1091 # For return type, type is useless if not covariant with introduction.
1092 redef fun check_repeated_types
(modelbuilder
) do
1093 var mpropdef
= self.mpropdef
1094 if mpropdef
== null then return
1095 if mpropdef
.is_intro
or n_signature
== null then return
1097 for param
in n_signature
.n_params
do
1098 if param
.n_type
!= null then
1099 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1103 var intro
= mpropdef
.mproperty
.intro
1104 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1105 if n_intro
== null or not n_intro
isa AMethPropdef then return
1107 var ret_type
= n_signature
.ret_type
1108 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1109 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1115 # Is a return required?
1117 # * True for operators and brackets.
1118 # * False for id and assignment.
1119 fun return_is_mandatory
: Bool do return true
1121 # Can the last parameter be special like a vararg?
1123 # * False for operators: the last one is in fact the only one.
1124 # * False for assignments: it is the right part of the assignment.
1125 # * True for ids and brackets.
1126 fun accept_special_last_parameter
: Bool do return false
1128 # The minimum required number of parameters.
1130 # * 1 for binary operators
1132 # * 1 for assignments
1133 # * 2 for bracket assignments
1135 fun min_arity
: Int do return 1
1137 # Is the `self` a binary operator?
1138 fun is_binary
: Bool do return true
1141 redef class AIdMethid
1142 redef fun return_is_mandatory
do return false
1143 redef fun accept_special_last_parameter
do return true
1144 redef fun min_arity
do return 0
1145 redef fun is_binary
do return false
1148 redef class ABraMethid
1149 redef fun accept_special_last_parameter
do return true
1150 redef fun is_binary
do return false
1153 redef class ABraassignMethid
1154 redef fun return_is_mandatory
do return false
1155 redef fun min_arity
do return 2
1156 redef fun is_binary
do return false
1159 redef class AAssignMethid
1160 redef fun return_is_mandatory
do return false
1161 redef fun is_binary
do return false
1164 redef class AAttrPropdef
1165 redef type MPROPDEF: MAttributeDef
1167 # The static type of the property (declared, inferred or inherited)
1168 # This attribute is also used to check if the property was analyzed and is valid.
1169 var mtype
: nullable MType
1171 # Is the node tagged `noinit`?
1174 # Is the node tagged lazy?
1177 # Is the node tagged optional?
1178 var is_optional
= false
1180 # Does the node have a default value?
1181 # Could be through `n_expr`, `n_block` or `is_lazy`
1182 var has_value
= false
1184 # The name of the attribute
1185 # Note: The name of the attribute is in reality the name of the mreadpropdef
1186 var name
: String = n_id2
.text
is lazy
1188 # The guard associated to a lazy attribute.
1189 # Because some engines does not have a working `isset`,
1190 # this additional attribute is used to guard the lazy initialization.
1191 # TODO: to remove once isset is correctly implemented
1192 var mlazypropdef
: nullable MAttributeDef
1194 # The associated getter (read accessor) if any
1195 var mreadpropdef
: nullable MMethodDef is writable
1196 # The associated setter (write accessor) if any
1197 var mwritepropdef
: nullable MMethodDef is writable
1199 redef fun build_property
(modelbuilder
, mclassdef
)
1201 var mclass
= mclassdef
.mclass
1203 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1205 if atabstract
== null then build_attribute_property
(modelbuilder
, mclassdef
)
1207 # Construction of the read property. If it's not correctly built just return.
1208 if not build_read_property
(modelbuilder
, mclassdef
) then return
1210 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1212 has_value
= n_expr
!= null or n_block
!= null
1214 if atabstract
!= null and has_value
then
1215 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1219 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1220 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1221 if atnoinit
!= null then
1224 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1227 if atabstract
!= null then
1228 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1232 # Construction of the read property. If it's not correctly built just return.
1233 if not build_lazy_property
(modelbuilder
, mclassdef
) then return
1235 var atoptional
= self.get_single_annotation
("optional", modelbuilder
)
1236 if atoptional
!= null then
1237 if not has_value
then
1238 modelbuilder
.error
(atoptional
, "Error: `optional` attributes need a default value.")
1243 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1244 if atreadonly
!= null then
1245 if not has_value
then
1246 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1248 # No setter, so just leave
1252 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1253 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1256 # Construction of the read property. If it's not correctly built just return.
1257 if not build_write_property
(modelbuilder
, mclassdef
, false) then return
1259 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1261 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1262 if atautoinit
!= null then
1264 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1265 else if not mwritepropdef
.is_intro
then
1266 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1267 else if not mclassdef
.is_intro
then
1268 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1269 else if atabstract
== null then
1270 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1272 else if atabstract
!= null then
1273 # By default, abstract attribute are not autoinit
1278 # Build the attribute property
1279 fun build_attribute_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef)
1281 var mclass
= mclassdef
.mclass
1282 var attribute_name
= "_" + name
1284 if not mclass
.kind
.need_init
then
1285 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1287 var mprop
= new MAttribute(mclassdef
, "_" + name
, self.location
, private_visibility
)
1288 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1289 self.mpropdef
= mpropdef
1290 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1293 # Build the read method property to get the value of the attribute
1294 # Return `true` if the property was correctly created else return `false`.
1295 # Warning the signature of the property is not set. This step is done by `build_signature`.
1296 fun build_read_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
1298 var mclass
= mclassdef
.mclass
1301 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(self, mclassdef
, readname
).as(nullable MMethod)
1302 if mreadprop
== null then
1303 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1304 mreadprop
= new MMethod(mclassdef
, readname
, self.location
, mvisibility
)
1305 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then
1306 mreadprop
.is_broken
= true
1310 if mreadprop
.is_broken
then return false
1311 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return false
1312 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1314 mclassdef
.mprop2npropdef
[mreadprop
] = self
1316 var attr_mpropdef
= mpropdef
1317 if attr_mpropdef
!= null then
1318 mreadprop
.getter_for
= attr_mpropdef
.mproperty
1319 attr_mpropdef
.mproperty
.getter
= mreadprop
1322 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1323 self.mreadpropdef
= mreadpropdef
1324 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1325 set_doc
(mreadpropdef
, modelbuilder
)
1326 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1331 # Build the write method property to set the attribute value
1332 # Return `true` if the property was correctly created else return `false`.
1333 # Warning the signature of the property is not set.
1334 fun build_write_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, is_same_visibility
: Bool): Bool
1336 var mclass
= mclassdef
.mclass
1338 var writename
= name
+ "="
1339 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1340 if atwritable
!= null then
1341 if not atwritable
.n_args
.is_empty
then
1342 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1345 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(self, mclassdef
, writename
).as(nullable MMethod)
1346 var nwkwredef
: nullable Token = null
1347 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1348 if mwriteprop
== null then
1350 if atwritable
!= null then
1351 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1353 mvisibility
= mreadpropdef
.mproperty
.visibility
1354 # By default, use protected visibility at most
1355 if mvisibility
> protected_visibility
and not is_same_visibility
then mvisibility
= protected_visibility
1357 mwriteprop
= new MMethod(mclassdef
, writename
, self.location
, mvisibility
)
1358 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then
1359 mwriteprop
.is_broken
= true
1362 mwriteprop
.deprecation
= mreadpropdef
.mproperty
.deprecation
1364 if mwriteprop
.is_broken
then return false
1365 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return false
1366 if atwritable
!= null then
1367 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1370 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1372 var attr_mpropdef
= mpropdef
1373 if attr_mpropdef
!= null then
1374 mwriteprop
.setter_for
= attr_mpropdef
.mproperty
1375 attr_mpropdef
.mproperty
.setter
= mwriteprop
1378 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1379 self.mwritepropdef
= mwritepropdef
1380 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1381 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1386 # Build the lazy attribute property
1387 # Return `true` if the property was correctly created else return `false`.
1388 fun build_lazy_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
1390 var mclass
= mclassdef
.mclass
1392 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1393 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1394 if atlazy
!= null or atlateinit
!= null then
1395 if atlazy
!= null and atlateinit
!= null then
1396 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1399 if not has_value
then
1400 if atlazy
!= null then
1401 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1402 else if atlateinit
!= null then
1403 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1409 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, self.location
, none_visibility
)
1410 mlazyprop
.is_fictive
= true
1411 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1412 mlazypropdef
.is_fictive
= true
1413 self.mlazypropdef
= mlazypropdef
1418 redef fun build_signature
(modelbuilder
)
1420 var mreadpropdef
= self.mreadpropdef
1421 var mpropdef
= self.mpropdef
1422 if mreadpropdef
== null then return # Error thus skipped
1423 var mclassdef
= mreadpropdef
.mclassdef
1424 var mmodule
= mclassdef
.mmodule
1425 var mtype
: nullable MType = null
1428 var ntype
= self.n_type
1429 if ntype
!= null then
1430 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1431 if mtype
== null then return
1434 var inherited_type
: nullable MType = null
1435 # Inherit the type from the getter (usually an abstract getter)
1436 if not mreadpropdef
.is_intro
then
1437 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1438 if msignature
== null then return # Error, thus skipped
1439 inherited_type
= msignature
.return_mtype
1440 if inherited_type
!= null then
1441 # The inherited type is adapted to use the local formal types, if any.
1442 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1443 if mtype
== null then mtype
= inherited_type
1447 var nexpr
= self.n_expr
1448 if mtype
== null then
1449 if nexpr
!= null then
1450 mtype
= infer_static_type
(modelbuilder
, nexpr
, mclassdef
, mmodule
, mreadpropdef
)
1451 if mtype
== null then return
1453 else if ntype
!= null and inherited_type
== mtype
then
1454 if nexpr
isa ANewExpr then
1455 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1456 if xmtype
== mtype
then
1457 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1462 if mtype
== null then
1463 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1469 if mpropdef
!= null then
1470 mpropdef
.static_mtype
= mtype
1473 build_read_signature
1475 if self.mwritepropdef
!= null then build_write_signature
1477 var mlazypropdef
= self.mlazypropdef
1478 if mlazypropdef
!= null then
1479 mlazypropdef
.static_mtype
= mmodule
.bool_type
1481 check_repeated_types
(modelbuilder
)
1484 # Build the read method signature
1485 # `except`: mreadpropdef != null
1486 # `expect`: mtype != null
1487 fun build_read_signature
1489 expect
(mreadpropdef
!= null and mtype
!= null)
1491 var msignature
= new MSignature(new Array[MParameter], mtype
)
1492 mreadpropdef
.msignature
= msignature
1495 # Build the write method signature
1496 # `except`: mwritepropdef != null
1497 # `expect`: mtype != null
1498 fun build_write_signature
1500 expect
(mwritepropdef
!= null and mtype
!= null)
1502 var mwritetype
= mtype
.as(not null)
1504 mwritetype
= mwritetype
.as_nullable
1506 var mparameter
= new MParameter(name
, mwritetype
, false)
1507 var msignature
= new MSignature([mparameter
], null)
1508 mwritepropdef
.msignature
= msignature
1511 # Detect the static type from the value assigned to the attribute `self`
1513 # Return the static type if it can be safely inferred.
1514 private fun infer_static_type
(modelbuilder
: ModelBuilder, nexpr
: AExpr,
1515 mclassdef
: MClassDef, mmodule
: MModule, mreadpropdef
: MPropDef): nullable MType
1518 if nexpr
isa ANewExpr then
1519 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1520 else if nexpr
isa AAsCastExpr then
1521 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1522 else if nexpr
isa AIntegerExpr then
1523 var cla
: nullable MClass = null
1524 if nexpr
.value
isa Int then
1525 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1526 else if nexpr
.value
isa Byte then
1527 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1528 else if nexpr
.value
isa Int8 then
1529 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1530 else if nexpr
.value
isa Int16 then
1531 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1532 else if nexpr
.value
isa UInt16 then
1533 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1534 else if nexpr
.value
isa Int32 then
1535 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1536 else if nexpr
.value
isa UInt32 then
1537 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1539 # Should not happen, and should be updated as new types are added
1542 if cla
!= null then mtype
= cla
.mclass_type
1543 else if nexpr
isa AFloatExpr then
1544 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1545 if cla
!= null then mtype
= cla
.mclass_type
1546 else if nexpr
isa ACharExpr then
1547 var cla
: nullable MClass
1548 if nexpr
.is_code_point
then
1549 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1551 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1553 if cla
!= null then mtype
= cla
.mclass_type
1554 else if nexpr
isa ABoolExpr then
1555 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1556 if cla
!= null then mtype
= cla
.mclass_type
1557 else if nexpr
isa ASuperstringExpr then
1558 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1559 if cla
!= null then mtype
= cla
.mclass_type
1560 else if nexpr
isa AStringFormExpr then
1561 var cla
: nullable MClass
1562 if nexpr
.is_bytestring
then
1563 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bytes")
1564 else if nexpr
.is_re
then
1565 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Regex")
1566 else if nexpr
.is_string
then
1567 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1571 if cla
!= null then mtype
= cla
.mclass_type
1572 else if nexpr
isa AArrayExpr and nexpr
.n_type
== null and nexpr
.n_exprs
.not_empty
then
1573 # Non-empty arrays without an explicit type
1575 var item_mtypes
= new Set[MType]
1577 for node
in nexpr
.n_exprs
do
1578 var item_mtype
= infer_static_type
(modelbuilder
, node
, mclassdef
, mmodule
, mreadpropdef
)
1579 if item_mtype
== null then
1582 item_mtypes
.add item_mtype
1586 if fails
then return null # Failed to infer some types
1588 if item_mtypes
.length
> 1 then
1589 modelbuilder
.error
(self, "Type Error: ambiguous array type {item_mtypes.join(" ")}")
1592 mtype
= mmodule
.array_type
(item_mtypes
.first
)
1593 else if nexpr
isa AUminusExpr and (nexpr
.n_expr
isa AIntegerExpr or nexpr
.n_expr
isa AFloatExpr) then
1594 # The Int and Float unary - is defined in `kernel`, so this may
1595 # result in an invalid behavior when using a custom kernel.
1596 # A workaround is to declare the attribute static type.
1597 # This is still very useful, especially to novice programmers.
1598 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1599 else if nexpr
isa AOnceExpr then
1600 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1602 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1607 redef fun check_signature
(modelbuilder
)
1609 var mpropdef
= self.mpropdef
1610 if mpropdef
== null then return # Error thus skipped
1611 var ntype
= self.n_type
1612 var mtype
= self.mtype
1613 if mtype
== null then return # Error thus skipped
1615 var mclassdef
= mpropdef
.mclassdef
1616 var mmodule
= mclassdef
.mmodule
1619 if ntype
!= null then
1620 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then return
1623 if nexpr
isa ANewExpr then
1624 if modelbuilder
.resolve_mtype
(mclassdef
, nexpr
.n_type
) == null then return
1627 # Lookup for signature in the precursor
1628 # FIXME all precursors should be considered
1629 if not mpropdef
.is_intro
then
1630 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1631 if precursor_type
== null then return
1633 if mtype
!= precursor_type
then
1634 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1639 # Check getter and setter
1640 var meth
= self.mreadpropdef
1641 if meth
!= null then
1642 self.check_method_signature
(modelbuilder
, meth
)
1643 var node
: nullable ANode = ntype
1644 if node
== null then node
= self
1645 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1647 meth
= self.mwritepropdef
1648 if meth
!= null then
1649 self.check_method_signature
(modelbuilder
, meth
)
1650 var node
: nullable ANode = ntype
1651 if node
== null then node
= self
1652 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1656 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1658 var mclassdef
= mpropdef
.mclassdef
1659 var mmodule
= mclassdef
.mmodule
1660 var nsig
= self.n_type
1661 var mysignature
= mpropdef
.msignature
1662 if mysignature
== null then return # Error thus skiped
1664 # Lookup for signature in the precursor
1665 # FIXME all precursors should be considered
1666 if not mpropdef
.is_intro
then
1667 var msignature
= mpropdef
.mproperty
.intro
.msignature
1668 if msignature
== null then return
1670 if mysignature
.arity
!= msignature
.arity
then
1672 if nsig
!= null then node
= nsig
else node
= self
1673 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}`.")
1676 var precursor_ret_type
= msignature
.return_mtype
1677 var ret_type
= mysignature
.return_mtype
1678 if ret_type
!= null and precursor_ret_type
== null then
1680 if nsig
!= null then node
= nsig
else node
= self
1681 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1685 if mysignature
.arity
> 0 then
1686 # Check parameters types
1687 for i
in [0..mysignature
.arity
[ do
1688 var myt
= mysignature
.mparameters
[i
].mtype
1689 var prt
= msignature
.mparameters
[i
].mtype
1691 if nsig
!= null then node
= nsig
else node
= self
1692 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1693 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1697 if precursor_ret_type
!= null then
1699 if nsig
!= null then node
= nsig
else node
= self
1700 if ret_type
== null then
1701 # Inherit the return type
1702 ret_type
= precursor_ret_type
1703 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1704 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1710 # Type is useless if the attribute type is the same thant the intro.
1711 redef fun check_repeated_types
(modelbuilder
) do
1712 var mreadpropdef
= self.mreadpropdef
1713 if mreadpropdef
== null then return
1714 if mreadpropdef
.is_intro
or n_type
== null then return
1716 var intro
= mreadpropdef
.mproperty
.intro
1717 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1718 if n_intro
== null then return
1721 if n_intro
isa AMethPropdef then
1722 ntype
= n_intro
.n_signature
.ret_type
1723 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1724 ntype
= n_intro
.n_type
.mtype
1727 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1728 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1732 redef class ATypePropdef
1733 redef type MPROPDEF: MVirtualTypeDef
1735 redef fun build_property
(modelbuilder
, mclassdef
)
1737 var name
= self.n_qid
.n_id
.text
1738 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1739 if mprop
== null then
1740 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1741 mprop
= new MVirtualTypeProp(mclassdef
, name
, self.location
, mvisibility
)
1742 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1743 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1747 if mprop
.is_broken
then return
1748 assert mprop
isa MVirtualTypeProp
1749 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1752 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1753 self.mpropdef
= mpropdef
1754 if mpropdef
.is_intro
then
1755 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1757 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1759 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1760 mpropdef
.is_broken
=true
1762 mclassdef
.mprop2npropdef
[mprop
] = self
1763 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1764 set_doc
(mpropdef
, modelbuilder
)
1766 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1767 if atfixed
!= null then
1768 mpropdef
.is_fixed
= true
1772 redef fun build_signature
(modelbuilder
)
1774 var mpropdef
= self.mpropdef
1775 if mpropdef
== null then return # Error thus skipped
1776 var mclassdef
= mpropdef
.mclassdef
1777 var mtype
: nullable MType = null
1779 var ntype
= self.n_type
1780 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1781 if mtype
== null then return
1783 mpropdef
.bound
= mtype
1784 # print "{mpropdef}: {mtype}"
1787 redef fun check_signature
(modelbuilder
)
1789 var mpropdef
= self.mpropdef
1790 if mpropdef
== null then return # Error thus skipped
1792 var bound
= mpropdef
.bound
1793 if bound
== null then return # Error thus skipped
1795 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1797 var mclassdef
= mpropdef
.mclassdef
1798 var mmodule
= mclassdef
.mmodule
1799 var anchor
= mclassdef
.bound_mtype
1801 var ntype
= self.n_type
1802 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
1803 mpropdef
.bound
= null
1807 # Check redefinitions
1808 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1809 var supbound
= p
.bound
1810 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1812 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1815 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1816 modelbuilder
.error
(n_type
, "Redef Error: a virtual type cannot be refined.")
1819 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1820 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")