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 return
154 # Look for the init in Object, or create it
155 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
156 # Create the implicit root-init method
157 var mprop
= new MMethod(mclassdef
, "init", nclassdef
.location
, mclassdef
.mclass
.visibility
)
158 mprop
.is_root_init
= true
159 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
160 var mparameters
= new Array[MParameter]
161 var msignature
= new MSignature(mparameters
, null)
162 mpropdef
.msignature
= msignature
164 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
165 the_root_init_mmethod
= mprop
168 # Is there already a constructor defined?
169 var defined_init
: nullable MMethodDef = null
170 for mpropdef
in mclassdef
.mpropdefs
do
171 if not mpropdef
isa MMethodDef then continue
172 if not mpropdef
.mproperty
.is_init
then continue
173 if mpropdef
.mproperty
.is_root_init
then
174 assert defined_init
== null
175 defined_init
= mpropdef
176 else if mpropdef
.mproperty
.name
== "autoinit" then
177 # An explicit old-style init named "init", so return
182 if mclassdef
.auto_init
!= null then
186 if not nclassdef
isa AStdClassdef then return
188 # Collect undefined attributes
189 var mparameters
= new Array[MParameter]
190 var initializers
= new Array[MProperty]
191 for npropdef
in nclassdef
.n_propdefs
do
192 if npropdef
isa AMethPropdef then
193 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
194 var mpropdef
= npropdef
.mpropdef
195 if mpropdef
== null then return # Skip broken method
196 var sig
= mpropdef
.msignature
197 if sig
== null then continue # Skip broken method
199 mparameters
.add_all sig
.mparameters
200 initializers
.add
(mpropdef
.mproperty
)
201 mpropdef
.mproperty
.is_autoinit
= true
203 if npropdef
isa AAttrPropdef then
204 var mreadpropdef
= npropdef
.mreadpropdef
205 if mreadpropdef
== null then return # Skip broken attribute
206 var msignature
= mreadpropdef
.msignature
207 if msignature
== null then return # Skip broken attribute
208 if npropdef
.noinit
then continue # Skip noinit attribute
209 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
210 if atlateinit
!= null then
211 # For lateinit attributes, call the reader to force
212 # the lazy initialization of the attribute.
213 initializers
.add
(mreadpropdef
.mproperty
)
214 mreadpropdef
.mproperty
.is_autoinit
= true
217 if npropdef
.has_value
and not npropdef
.is_optional
then continue
218 var msetter
= npropdef
.mwritepropdef
219 if msetter
== null then
220 # No setter, it is a readonly attribute, so just add it
221 var paramname
= mreadpropdef
.mproperty
.name
222 var ret_type
= msignature
.return_mtype
223 if ret_type
== null then return
224 var mparameter
= new MParameter(paramname
, ret_type
, false)
225 mparameters
.add
(mparameter
)
227 initializers
.add
(npropdef
.mpropdef
.mproperty
)
228 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
230 # Add the setter to the list
231 mparameters
.add_all msetter
.msignature
.mparameters
232 initializers
.add
(msetter
.mproperty
)
233 msetter
.mproperty
.is_autoinit
= true
238 var the_root_init_mmethod
= self.the_root_init_mmethod
239 if the_root_init_mmethod
== null then return
241 # Look for most-specific new-stype init definitions
242 var spropdefs
= new ArraySet[MMethodDef]
243 for x
in mclassdef
.in_hierarchy
.direct_greaters
do
244 var y
= x
.mclass
.intro
.auto_init
245 if y
== null then continue
246 if y
.is_broken
or y
.msignature
== null then return
250 # Look at the autoinit class-annotation
251 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
252 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
253 if autoinit
!= null then
254 # Just throws the collected initializers
258 if noautoinit
!= null then
259 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
262 if autoinit
.n_args
.is_empty
then
263 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
266 # Get and check each argument
267 for narg
in autoinit
.n_args
do
270 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
274 # Search the property.
275 # To avoid bad surprises, try to get the setter first.
276 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
278 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
281 error
(narg
, "Error: unknown method `{id}`")
284 if not p
.is_autoinit
then
285 error
(narg
, "Error: `{p}` is not an autoinit method")
289 # Register the initializer and the parameters
292 if pd
isa MMethodDef then
293 # Get the signature resolved for the current receiver
294 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
295 mparameters
.add_all
(sig
.mparameters
)
301 else if spropdefs
.not_empty
then
302 # Search for inherited manual autoinit
304 for s
in spropdefs
do
305 if mpropdef2npropdef
.has_key
(s
) then
306 self.toolcontext
.info
("{mclassdef} inherits a manual autoinit {s}", 3)
307 #mclassdef.autoinit = s
313 # Search the longest-one and checks for conflict
314 var longest
= spropdefs
.first
315 if spropdefs
.length
> 1 then
316 # part 1. find the longest list
317 for spd
in spropdefs
do
318 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 autoinit {manual} and automatic autoinit {spd}.", 3)
323 # conflict with manual autoinit?
324 if longest
!= manual
and manual
!= null then
325 self.error
(nclassdef
, "Error: conflict between manual autoinit {manual} and automatic autoinit {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
, "autoinit", 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
.auto_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 if amethodid
== null then
793 if n_kwinit
!= null then
796 if self.n_signature
.n_params
.not_empty
or get_single_annotation
("old_style_init", modelbuilder
) != null then
799 else if n_kwnew
!= null then
806 else if amethodid
isa AIdMethid then
807 name
= amethodid
.n_id
.text
808 name_node
= amethodid
810 # operator, bracket or assign
811 name
= amethodid
.collect_text
812 name_node
= amethodid
814 var arity
= self.n_signature
.n_params
.length
815 if name
== "+" and arity
== 0 then
817 else if name
== "-" and arity
== 0 then
819 else if name
== "~" and arity
== 0 then
822 if amethodid
.is_binary
and arity
!= 1 then
823 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
824 else if amethodid
.min_arity
> arity
then
825 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
830 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
831 var mprop
: nullable MMethod = null
832 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)
833 if mprop
== null and look_like_a_root_init
then
834 mprop
= modelbuilder
.the_root_init_mmethod
836 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
837 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
840 if mprop
== null then
841 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
842 mprop
= new MMethod(mclassdef
, name
, self.location
, mvisibility
)
843 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
844 modelbuilder
.the_root_init_mmethod
= mprop
845 mprop
.is_root_init
= true
847 mprop
.is_init
= is_init
848 mprop
.is_new
= is_new
849 if is_new
then mclassdef
.mclass
.has_new_factory
= true
850 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
851 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
852 mprop
.is_broken
= true
856 if mprop
.is_broken
then return
857 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
858 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
861 # Check name conflicts in the local class for constructors.
863 for p
, n
in mclassdef
.mprop2npropdef
do
864 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
865 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
866 mprop
.is_broken
= true
874 mclassdef
.mprop2npropdef
[mprop
] = self
876 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
877 if mprop
.name
== "autoinit" and mclassdef
.is_intro
then
878 assert mclassdef
.auto_init
== null
879 mclassdef
.auto_init
= mpropdef
880 if mpropdef
.is_intro
then
881 mpropdef
.initializers
.add mprop
882 mpropdef
.is_calling_init
= true
886 set_doc
(mpropdef
, modelbuilder
)
888 self.mpropdef
= mpropdef
889 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
890 if mpropdef
.is_intro
then
891 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
893 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
897 redef fun build_signature
(modelbuilder
)
899 var mpropdef
= self.mpropdef
900 if mpropdef
== null then return # Error thus skiped
901 var mproperty
= mpropdef
.mproperty
902 var mclassdef
= mpropdef
.mclassdef
903 var mmodule
= mclassdef
.mmodule
904 var nsig
= self.n_signature
906 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
907 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
909 # Retrieve info from the signature AST
910 var param_names
= new Array[String] # Names of parameters from the AST
911 var param_types
= new Array[MType] # Types of parameters from the AST
913 var ret_type
: nullable MType = null # Return type from the AST
915 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
916 param_names
= nsig
.param_names
917 param_types
= nsig
.param_types
918 vararg_rank
= nsig
.vararg_rank
919 ret_type
= nsig
.ret_type
922 # Look for some signature to inherit
923 # FIXME: do not inherit from the intro, but from the most specific
924 var msignature
: nullable MSignature = null
925 if not mpropdef
.is_intro
then
926 msignature
= mproperty
.intro
.msignature
927 if msignature
== null then return # Skip error
929 # The local signature is adapted to use the local formal types, if any.
930 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
932 # Check inherited signature arity
933 if param_names
.length
!= msignature
.arity
then
935 if nsig
!= null then node
= nsig
else node
= self
936 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mproperty.name}{msignature}`; got {param_names.length}. See introduction at `{mproperty.full_name}`.")
939 else if mproperty
.is_init
and not mproperty
.is_new
then
940 # FIXME UGLY: inherit signature from a super-constructor
941 for msupertype
in mclassdef
.supertypes
do
942 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
943 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mproperty
.name
)
944 if candidate
!= null then
945 if msignature
== null then
946 msignature
= candidate
.intro
.as(MMethodDef).msignature
953 # Inherit the signature
954 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
955 # Parameters are untyped, thus inherit them
956 param_types
= new Array[MType]
957 for mparameter
in msignature
.mparameters
do
958 param_types
.add
(mparameter
.mtype
)
960 vararg_rank
= msignature
.vararg_rank
962 if msignature
!= null and ret_type
== null then
963 ret_type
= msignature
.return_mtype
966 if param_names
.length
!= param_types
.length
then
967 # Some parameters are typed, other parameters are not typed.
968 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
972 var mparameters
= new Array[MParameter]
973 for i
in [0..param_names
.length
[ do
974 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
975 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
976 mparameters
.add
(mparameter
)
979 # In `new`-factories, the return type is by default the classtype.
980 if ret_type
== null and mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
982 # Special checks for operator methods
983 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
984 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mproperty.name}`.")
986 if ret_type
== null and return_is_mandatory
then
987 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mproperty.name}`.")
990 msignature
= new MSignature(mparameters
, ret_type
)
991 mpropdef
.msignature
= msignature
992 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
993 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
994 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
997 var at
= self.get_single_annotation
("lazy", modelbuilder
)
998 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
1000 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1001 if atautoinit
!= null then
1002 if not mpropdef
.is_intro
then
1003 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
1004 else if not mclassdef
.is_intro
then
1005 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1007 self.is_autoinit
= true
1012 redef fun check_signature
(modelbuilder
)
1014 var mpropdef
= self.mpropdef
1015 if mpropdef
== null then return # Error thus skiped
1016 var mclassdef
= mpropdef
.mclassdef
1017 var mmodule
= mclassdef
.mmodule
1018 var nsig
= self.n_signature
1019 var mysignature
= mpropdef
.msignature
1020 if mysignature
== null then return # Error thus skiped
1023 if nsig
!= null then
1024 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1025 mpropdef
.msignature
= null # invalidate
1026 mpropdef
.is_broken
= true
1027 return # Forward error
1031 # Lookup for signature in the precursor
1032 # FIXME all precursors should be considered
1033 if not mpropdef
.is_intro
then
1034 var msignature
= mpropdef
.mproperty
.intro
.msignature
1035 if msignature
== null then return
1037 var precursor_ret_type
= msignature
.return_mtype
1038 var ret_type
= mysignature
.return_mtype
1039 if ret_type
!= null and precursor_ret_type
== null then
1040 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1041 mpropdef
.msignature
= null
1042 mpropdef
.is_broken
= true
1046 if mysignature
.arity
> 0 then
1047 # Check parameters types
1048 for i
in [0..mysignature
.arity
[ do
1049 var myt
= mysignature
.mparameters
[i
].mtype
1050 var prt
= msignature
.mparameters
[i
].mtype
1051 var node
= nsig
.n_params
[i
]
1052 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1053 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1054 mpropdef
.msignature
= null
1055 mpropdef
.is_broken
= true
1059 if precursor_ret_type
!= null then
1060 var node
: nullable ANode = null
1061 if nsig
!= null then node
= nsig
.n_type
1062 if node
== null then node
= self
1063 if ret_type
== null then
1064 # Inherit the return type
1065 ret_type
= precursor_ret_type
1066 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1067 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1068 mpropdef
.msignature
= null
1069 mpropdef
.is_broken
= true
1074 if nsig
!= null then
1075 # Check parameters visibility
1076 for i
in [0..mysignature
.arity
[ do
1077 var nt
= nsig
.n_params
[i
].n_type
1078 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1080 var nt
= nsig
.n_type
1081 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1083 check_repeated_types
(modelbuilder
)
1086 # For parameters, type is always useless in a redef.
1087 # For return type, type is useless if not covariant with introduction.
1088 redef fun check_repeated_types
(modelbuilder
) do
1089 var mpropdef
= self.mpropdef
1090 if mpropdef
== null then return
1091 if mpropdef
.is_intro
or n_signature
== null then return
1093 for param
in n_signature
.n_params
do
1094 if param
.n_type
!= null then
1095 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1099 var intro
= mpropdef
.mproperty
.intro
1100 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1101 if n_intro
== null or not n_intro
isa AMethPropdef then return
1103 var ret_type
= n_signature
.ret_type
1104 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1105 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1111 # Is a return required?
1113 # * True for operators and brackets.
1114 # * False for id and assignment.
1115 fun return_is_mandatory
: Bool do return true
1117 # Can the last parameter be special like a vararg?
1119 # * False for operators: the last one is in fact the only one.
1120 # * False for assignments: it is the right part of the assignment.
1121 # * True for ids and brackets.
1122 fun accept_special_last_parameter
: Bool do return false
1124 # The minimum required number of parameters.
1126 # * 1 for binary operators
1128 # * 1 for assignments
1129 # * 2 for bracket assignments
1131 fun min_arity
: Int do return 1
1133 # Is the `self` a binary operator?
1134 fun is_binary
: Bool do return true
1137 redef class AIdMethid
1138 redef fun return_is_mandatory
do return false
1139 redef fun accept_special_last_parameter
do return true
1140 redef fun min_arity
do return 0
1141 redef fun is_binary
do return false
1144 redef class ABraMethid
1145 redef fun accept_special_last_parameter
do return true
1146 redef fun is_binary
do return false
1149 redef class ABraassignMethid
1150 redef fun return_is_mandatory
do return false
1151 redef fun min_arity
do return 2
1152 redef fun is_binary
do return false
1155 redef class AAssignMethid
1156 redef fun return_is_mandatory
do return false
1157 redef fun is_binary
do return false
1160 redef class AAttrPropdef
1161 redef type MPROPDEF: MAttributeDef
1163 # The static type of the property (declared, inferred or inherited)
1164 # This attribute is also used to check if the property was analyzed and is valid.
1165 var mtype
: nullable MType
1167 # Is the node tagged `noinit`?
1170 # Is the node tagged lazy?
1173 # Is the node tagged optional?
1174 var is_optional
= false
1176 # Does the node have a default value?
1177 # Could be through `n_expr`, `n_block` or `is_lazy`
1178 var has_value
= false
1180 # The guard associated to a lazy attribute.
1181 # Because some engines does not have a working `isset`,
1182 # this additional attribute is used to guard the lazy initialization.
1183 # TODO: to remove once isset is correctly implemented
1184 var mlazypropdef
: nullable MAttributeDef
1186 # The associated getter (read accessor) if any
1187 var mreadpropdef
: nullable MMethodDef is writable
1188 # The associated setter (write accessor) if any
1189 var mwritepropdef
: nullable MMethodDef is writable
1191 redef fun build_property
(modelbuilder
, mclassdef
)
1193 var mclass
= mclassdef
.mclass
1195 var name
= nid2
.text
1197 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1198 if atabstract
== null then
1199 if not mclass
.kind
.need_init
then
1200 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1203 var mprop
= new MAttribute(mclassdef
, "_" + name
, self.location
, private_visibility
)
1204 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1205 self.mpropdef
= mpropdef
1206 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1210 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1211 if mreadprop
== null then
1212 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1213 mreadprop
= new MMethod(mclassdef
, readname
, self.location
, mvisibility
)
1214 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then
1215 mreadprop
.is_broken
= true
1219 if mreadprop
.is_broken
then return
1220 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1221 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1223 mclassdef
.mprop2npropdef
[mreadprop
] = self
1225 var attr_mpropdef
= mpropdef
1226 if attr_mpropdef
!= null then
1227 mreadprop
.getter_for
= attr_mpropdef
.mproperty
1228 attr_mpropdef
.mproperty
.getter
= mreadprop
1231 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1232 self.mreadpropdef
= mreadpropdef
1233 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1234 set_doc
(mreadpropdef
, modelbuilder
)
1235 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1236 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1238 has_value
= n_expr
!= null or n_block
!= null
1240 if atabstract
!= null and has_value
then
1241 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1245 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1246 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1247 if atnoinit
!= null then
1250 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1253 if atabstract
!= null then
1254 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1258 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1259 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1260 if atlazy
!= null or atlateinit
!= null then
1261 if atlazy
!= null and atlateinit
!= null then
1262 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1265 if not has_value
then
1266 if atlazy
!= null then
1267 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1268 else if atlateinit
!= null then
1269 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1275 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, self.location
, none_visibility
)
1276 mlazyprop
.is_fictive
= true
1277 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1278 mlazypropdef
.is_fictive
= true
1279 self.mlazypropdef
= mlazypropdef
1282 var atoptional
= self.get_single_annotation
("optional", modelbuilder
)
1283 if atoptional
!= null then
1284 if not has_value
then
1285 modelbuilder
.error
(atoptional
, "Error: `optional` attributes need a default value.")
1290 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1291 if atreadonly
!= null then
1292 if not has_value
then
1293 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1295 # No setter, so just leave
1299 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1300 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1303 var writename
= name
+ "="
1304 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1305 if atwritable
!= null then
1306 if not atwritable
.n_args
.is_empty
then
1307 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1310 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1311 var nwkwredef
: nullable Token = null
1312 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1313 if mwriteprop
== null then
1315 if atwritable
!= null then
1316 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1318 mvisibility
= mreadprop
.visibility
1319 # By default, use protected visibility at most
1320 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1322 mwriteprop
= new MMethod(mclassdef
, writename
, self.location
, mvisibility
)
1323 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then
1324 mwriteprop
.is_broken
= true
1327 mwriteprop
.deprecation
= mreadprop
.deprecation
1329 if mwriteprop
.is_broken
then return
1330 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1331 if atwritable
!= null then
1332 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1335 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1337 if attr_mpropdef
!= null then
1338 mwriteprop
.setter_for
= attr_mpropdef
.mproperty
1339 attr_mpropdef
.mproperty
.setter
= mwriteprop
1342 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1343 self.mwritepropdef
= mwritepropdef
1344 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1345 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1346 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1348 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1349 if atautoinit
!= null then
1351 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1352 else if not mwritepropdef
.is_intro
then
1353 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1354 else if not mclassdef
.is_intro
then
1355 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1356 else if atabstract
== null then
1357 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1359 else if atabstract
!= null then
1360 # By default, abstract attribute are not autoinit
1365 redef fun build_signature
(modelbuilder
)
1367 var mreadpropdef
= self.mreadpropdef
1368 var mpropdef
= self.mpropdef
1369 if mreadpropdef
== null then return # Error thus skipped
1370 var mclassdef
= mreadpropdef
.mclassdef
1371 var mmodule
= mclassdef
.mmodule
1372 var mtype
: nullable MType = null
1375 var ntype
= self.n_type
1376 if ntype
!= null then
1377 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1378 if mtype
== null then return
1381 var inherited_type
: nullable MType = null
1382 # Inherit the type from the getter (usually an abstract getter)
1383 if not mreadpropdef
.is_intro
then
1384 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1385 if msignature
== null then return # Error, thus skipped
1386 inherited_type
= msignature
.return_mtype
1387 if inherited_type
!= null then
1388 # The inherited type is adapted to use the local formal types, if any.
1389 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1390 if mtype
== null then mtype
= inherited_type
1394 var nexpr
= self.n_expr
1395 if mtype
== null then
1396 if nexpr
!= null then
1397 mtype
= infer_static_type
(modelbuilder
, nexpr
, mclassdef
, mmodule
, mreadpropdef
)
1398 if mtype
== null then return
1400 else if ntype
!= null and inherited_type
== mtype
then
1401 if nexpr
isa ANewExpr then
1402 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1403 if xmtype
== mtype
then
1404 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1409 if mtype
== null then
1410 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1416 if mpropdef
!= null then
1417 mpropdef
.static_mtype
= mtype
1421 var msignature
= new MSignature(new Array[MParameter], mtype
)
1422 mreadpropdef
.msignature
= msignature
1425 var mwritepropdef
= self.mwritepropdef
1426 if mwritepropdef
!= null then
1427 var mwritetype
= mtype
1429 mwritetype
= mwritetype
.as_nullable
1433 var mparameter
= new MParameter(name
, mwritetype
, false)
1434 var msignature
= new MSignature([mparameter
], null)
1435 mwritepropdef
.msignature
= msignature
1438 var mlazypropdef
= self.mlazypropdef
1439 if mlazypropdef
!= null then
1440 mlazypropdef
.static_mtype
= mmodule
.bool_type
1442 check_repeated_types
(modelbuilder
)
1445 # Detect the static type from the value assigned to the attribute `self`
1447 # Return the static type if it can be safely inferred.
1448 private fun infer_static_type
(modelbuilder
: ModelBuilder, nexpr
: AExpr,
1449 mclassdef
: MClassDef, mmodule
: MModule, mreadpropdef
: MPropDef): nullable MType
1452 if nexpr
isa ANewExpr then
1453 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1454 else if nexpr
isa AAsCastExpr then
1455 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, nexpr
.n_type
, true)
1456 else if nexpr
isa AIntegerExpr then
1457 var cla
: nullable MClass = null
1458 if nexpr
.value
isa Int then
1459 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1460 else if nexpr
.value
isa Byte then
1461 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1462 else if nexpr
.value
isa Int8 then
1463 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1464 else if nexpr
.value
isa Int16 then
1465 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1466 else if nexpr
.value
isa UInt16 then
1467 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1468 else if nexpr
.value
isa Int32 then
1469 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1470 else if nexpr
.value
isa UInt32 then
1471 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1473 # Should not happen, and should be updated as new types are added
1476 if cla
!= null then mtype
= cla
.mclass_type
1477 else if nexpr
isa AFloatExpr then
1478 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1479 if cla
!= null then mtype
= cla
.mclass_type
1480 else if nexpr
isa ACharExpr then
1481 var cla
: nullable MClass
1482 if nexpr
.is_code_point
then
1483 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1485 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1487 if cla
!= null then mtype
= cla
.mclass_type
1488 else if nexpr
isa ABoolExpr then
1489 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1490 if cla
!= null then mtype
= cla
.mclass_type
1491 else if nexpr
isa ASuperstringExpr then
1492 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1493 if cla
!= null then mtype
= cla
.mclass_type
1494 else if nexpr
isa AStringFormExpr then
1495 var cla
: nullable MClass
1496 if nexpr
.is_bytestring
then
1497 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bytes")
1498 else if nexpr
.is_re
then
1499 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Regex")
1500 else if nexpr
.is_string
then
1501 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1505 if cla
!= null then mtype
= cla
.mclass_type
1506 else if nexpr
isa AArrayExpr and nexpr
.n_type
== null and nexpr
.n_exprs
.not_empty
then
1507 # Non-empty arrays without an explicit type
1509 var item_mtypes
= new Set[MType]
1511 for node
in nexpr
.n_exprs
do
1512 var item_mtype
= infer_static_type
(modelbuilder
, node
, mclassdef
, mmodule
, mreadpropdef
)
1513 if item_mtype
== null then
1516 item_mtypes
.add item_mtype
1520 if fails
then return null # Failed to infer some types
1522 if item_mtypes
.length
> 1 then
1523 modelbuilder
.error
(self, "Type Error: ambiguous array type {item_mtypes.join(" ")}")
1526 mtype
= mmodule
.array_type
(item_mtypes
.first
)
1527 else if nexpr
isa AUminusExpr and (nexpr
.n_expr
isa AIntegerExpr or nexpr
.n_expr
isa AFloatExpr) then
1528 # The Int and Float unary - is defined in `kernel`, so this may
1529 # result in an invalid behavior when using a custom kernel.
1530 # A workaround is to declare the attribute static type.
1531 # This is still very useful, especially to novice programmers.
1532 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1533 else if nexpr
isa AOnceExpr then
1534 mtype
= infer_static_type
(modelbuilder
, nexpr
.n_expr
, mclassdef
, mmodule
, mreadpropdef
)
1536 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1541 redef fun check_signature
(modelbuilder
)
1543 var mpropdef
= self.mpropdef
1544 if mpropdef
== null then return # Error thus skipped
1545 var ntype
= self.n_type
1546 var mtype
= self.mtype
1547 if mtype
== null then return # Error thus skipped
1549 var mclassdef
= mpropdef
.mclassdef
1550 var mmodule
= mclassdef
.mmodule
1553 if ntype
!= null then
1554 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then return
1557 if nexpr
isa ANewExpr then
1558 if modelbuilder
.resolve_mtype
(mclassdef
, nexpr
.n_type
) == null then return
1561 # Lookup for signature in the precursor
1562 # FIXME all precursors should be considered
1563 if not mpropdef
.is_intro
then
1564 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1565 if precursor_type
== null then return
1567 if mtype
!= precursor_type
then
1568 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1573 # Check getter and setter
1574 var meth
= self.mreadpropdef
1575 if meth
!= null then
1576 self.check_method_signature
(modelbuilder
, meth
)
1577 var node
: nullable ANode = ntype
1578 if node
== null then node
= self
1579 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1581 meth
= self.mwritepropdef
1582 if meth
!= null then
1583 self.check_method_signature
(modelbuilder
, meth
)
1584 var node
: nullable ANode = ntype
1585 if node
== null then node
= self
1586 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1590 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1592 var mclassdef
= mpropdef
.mclassdef
1593 var mmodule
= mclassdef
.mmodule
1594 var nsig
= self.n_type
1595 var mysignature
= mpropdef
.msignature
1596 if mysignature
== null then return # Error thus skiped
1598 # Lookup for signature in the precursor
1599 # FIXME all precursors should be considered
1600 if not mpropdef
.is_intro
then
1601 var msignature
= mpropdef
.mproperty
.intro
.msignature
1602 if msignature
== null then return
1604 if mysignature
.arity
!= msignature
.arity
then
1606 if nsig
!= null then node
= nsig
else node
= self
1607 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}`.")
1610 var precursor_ret_type
= msignature
.return_mtype
1611 var ret_type
= mysignature
.return_mtype
1612 if ret_type
!= null and precursor_ret_type
== null then
1614 if nsig
!= null then node
= nsig
else node
= self
1615 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1619 if mysignature
.arity
> 0 then
1620 # Check parameters types
1621 for i
in [0..mysignature
.arity
[ do
1622 var myt
= mysignature
.mparameters
[i
].mtype
1623 var prt
= msignature
.mparameters
[i
].mtype
1625 if nsig
!= null then node
= nsig
else node
= self
1626 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1627 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1631 if precursor_ret_type
!= null then
1633 if nsig
!= null then node
= nsig
else node
= self
1634 if ret_type
== null then
1635 # Inherit the return type
1636 ret_type
= precursor_ret_type
1637 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1638 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1644 # Type is useless if the attribute type is the same thant the intro.
1645 redef fun check_repeated_types
(modelbuilder
) do
1646 var mreadpropdef
= self.mreadpropdef
1647 if mreadpropdef
== null then return
1648 if mreadpropdef
.is_intro
or n_type
== null then return
1650 var intro
= mreadpropdef
.mproperty
.intro
1651 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1652 if n_intro
== null then return
1655 if n_intro
isa AMethPropdef then
1656 ntype
= n_intro
.n_signature
.ret_type
1657 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1658 ntype
= n_intro
.n_type
.mtype
1661 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1662 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1666 redef class ATypePropdef
1667 redef type MPROPDEF: MVirtualTypeDef
1669 redef fun build_property
(modelbuilder
, mclassdef
)
1671 var name
= self.n_qid
.n_id
.text
1672 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1673 if mprop
== null then
1674 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1675 mprop
= new MVirtualTypeProp(mclassdef
, name
, self.location
, mvisibility
)
1676 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1677 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1681 if mprop
.is_broken
then return
1682 assert mprop
isa MVirtualTypeProp
1683 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1686 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1687 self.mpropdef
= mpropdef
1688 if mpropdef
.is_intro
then
1689 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1691 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1693 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1694 mpropdef
.is_broken
=true
1696 mclassdef
.mprop2npropdef
[mprop
] = self
1697 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1698 set_doc
(mpropdef
, modelbuilder
)
1700 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1701 if atfixed
!= null then
1702 mpropdef
.is_fixed
= true
1706 redef fun build_signature
(modelbuilder
)
1708 var mpropdef
= self.mpropdef
1709 if mpropdef
== null then return # Error thus skipped
1710 var mclassdef
= mpropdef
.mclassdef
1711 var mtype
: nullable MType = null
1713 var ntype
= self.n_type
1714 mtype
= modelbuilder
.resolve_mtype_unchecked
(mclassdef
, ntype
, true)
1715 if mtype
== null then return
1717 mpropdef
.bound
= mtype
1718 # print "{mpropdef}: {mtype}"
1721 redef fun check_signature
(modelbuilder
)
1723 var mpropdef
= self.mpropdef
1724 if mpropdef
== null then return # Error thus skipped
1726 var bound
= mpropdef
.bound
1727 if bound
== null then return # Error thus skipped
1729 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1731 var mclassdef
= mpropdef
.mclassdef
1732 var mmodule
= mclassdef
.mmodule
1733 var anchor
= mclassdef
.bound_mtype
1735 var ntype
= self.n_type
1736 if modelbuilder
.resolve_mtype
(mclassdef
, ntype
) == null then
1737 mpropdef
.bound
= null
1741 # Check redefinitions
1742 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1743 var supbound
= p
.bound
1744 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1746 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1749 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1750 modelbuilder
.error
(n_type
, "Redef Error: a virtual type cannot be refined.")
1753 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1754 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")