1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 # Fall back to the class node if any.
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
64 # Retrieve all the attributes nodes localy definied
65 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
66 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
68 var res
= new Array[AAttrPropdef]
69 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
70 if n
== null then return res
71 for npropdef
in n
.n_propdefs
do
72 if npropdef
isa AAttrPropdef then
73 # Run the phases on it
74 toolcontext
.run_phases_on_npropdef
(npropdef
)
81 # Build the properties of `nclassdef`.
82 # REQUIRE: all superclasses are built.
83 private fun build_properties
(nclassdef
: AClassdef)
85 # Force building recursively
86 if nclassdef
.build_properties_is_done
then return
87 nclassdef
.build_properties_is_done
= true
88 var mclassdef
= nclassdef
.mclassdef
89 if mclassdef
== null then return # skip error
90 if mclassdef
.in_hierarchy
== null then return # Skip error
91 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
92 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
93 build_properties
(mclassdef2nclassdef
[superclassdef
])
96 mclassdef
.build_self_type
(self, nclassdef
)
97 for nclassdef2
in nclassdef
.all_defs
do
98 for npropdef
in nclassdef2
.n_propdefs
do
99 npropdef
.build_property
(self, mclassdef
)
101 for npropdef
in nclassdef2
.n_propdefs
do
102 npropdef
.build_signature
(self)
104 for npropdef
in nclassdef2
.n_propdefs
do
105 if not npropdef
isa ATypePropdef then continue
107 var mpropdef
= npropdef
.mpropdef
108 if mpropdef
== null then continue
109 if mpropdef
.bound
== null then continue
110 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
111 # Invalidate the bound
112 mpropdef
.is_broken
= true
113 mpropdef
.bound
= new MBottomType(mclassdef
.mmodule
.model
)
116 for npropdef
in nclassdef2
.n_propdefs
do
117 # Check ATypePropdef first since they may be required for the other properties
118 if not npropdef
isa ATypePropdef then continue
119 npropdef
.check_signature
(self)
122 for npropdef
in nclassdef2
.n_propdefs
do
123 if npropdef
isa ATypePropdef then continue
124 npropdef
.check_signature
(self)
127 process_default_constructors
(nclassdef
)
130 # the root init of the Object class
131 # Is usually implicitly defined
132 # Then explicit or implicit definitions of root-init are attached to it
133 var the_root_init_mmethod
: nullable MMethod
135 # Introduce or inherit default constructor
136 # This is the last part of `build_properties`.
137 private fun process_default_constructors
(nclassdef
: AClassdef)
139 var mclassdef
= nclassdef
.mclassdef
.as(not null)
141 # Are we a refinement
142 if not mclassdef
.is_intro
then return
144 # Look for the init in Object, or create it
145 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
146 # Create the implicit root-init method
147 var mprop
= new MMethod(mclassdef
, "init", nclassdef
.location
, mclassdef
.mclass
.visibility
)
148 mprop
.is_root_init
= true
149 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
150 var mparameters
= new Array[MParameter]
151 var msignature
= new MSignature(mparameters
, null)
152 mpropdef
.msignature
= msignature
154 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
155 the_root_init_mmethod
= mprop
158 # Is there already a constructor defined?
159 var defined_init
: nullable MMethodDef = null
160 for mpropdef
in mclassdef
.mpropdefs
do
161 if not mpropdef
isa MMethodDef then continue
162 if not mpropdef
.mproperty
.is_init
then continue
163 if mpropdef
.mproperty
.is_root_init
then
164 assert defined_init
== null
165 defined_init
= mpropdef
166 else if mpropdef
.mproperty
.name
== "autoinit" then
167 # An explicit old-style init named "init", so return
172 if mclassdef
.auto_init
!= null then
176 if not nclassdef
isa AStdClassdef then return
178 # Collect undefined attributes
179 var mparameters
= new Array[MParameter]
180 var initializers
= new Array[MProperty]
181 for npropdef
in nclassdef
.n_propdefs
do
182 if npropdef
isa AMethPropdef then
183 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
184 var mpropdef
= npropdef
.mpropdef
185 if mpropdef
== null then return # Skip broken method
186 var sig
= mpropdef
.msignature
187 if sig
== null then continue # Skip broken method
189 mparameters
.add_all sig
.mparameters
190 initializers
.add
(mpropdef
.mproperty
)
191 mpropdef
.mproperty
.is_autoinit
= true
193 if npropdef
isa AAttrPropdef then
194 var mreadpropdef
= npropdef
.mreadpropdef
195 if mreadpropdef
== null then return # Skip broken attribute
196 var msignature
= mreadpropdef
.msignature
197 if msignature
== null then return # Skip broken attribute
198 if npropdef
.noinit
then continue # Skip noinit attribute
199 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
200 if atlateinit
!= null then
201 # For lateinit attributes, call the reader to force
202 # the lazy initialization of the attribute.
203 initializers
.add
(mreadpropdef
.mproperty
)
204 mreadpropdef
.mproperty
.is_autoinit
= true
207 if npropdef
.has_value
and not npropdef
.is_optional
then continue
208 var msetter
= npropdef
.mwritepropdef
209 if msetter
== null then
210 # No setter, it is a readonly attribute, so just add it
211 var paramname
= mreadpropdef
.mproperty
.name
212 var ret_type
= msignature
.return_mtype
213 if ret_type
== null then return
214 var mparameter
= new MParameter(paramname
, ret_type
, false)
215 mparameters
.add
(mparameter
)
217 initializers
.add
(npropdef
.mpropdef
.mproperty
)
218 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
220 # Add the setter to the list
221 mparameters
.add_all msetter
.msignature
.mparameters
222 initializers
.add
(msetter
.mproperty
)
223 msetter
.mproperty
.is_autoinit
= true
228 var the_root_init_mmethod
= self.the_root_init_mmethod
229 if the_root_init_mmethod
== null then return
231 # Look for most-specific new-stype init definitions
232 var spropdefs
= new ArraySet[MMethodDef]
233 for x
in mclassdef
.in_hierarchy
.direct_greaters
do
234 var y
= x
.mclass
.intro
.auto_init
235 if y
== null then continue
236 if y
.is_broken
or y
.msignature
== null then return
240 # Look at the autoinit class-annotation
241 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
242 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
243 if autoinit
!= null then
244 # Just throws the collected initializers
248 if noautoinit
!= null then
249 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
252 if autoinit
.n_args
.is_empty
then
253 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
256 # Get and check each argument
257 for narg
in autoinit
.n_args
do
260 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
264 # Search the property.
265 # To avoid bad surprises, try to get the setter first.
266 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
268 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
271 error
(narg
, "Error: unknown method `{id}`")
274 if not p
.is_autoinit
then
275 error
(narg
, "Error: `{p}` is not an autoinit method")
279 # Register the initializer and the parameters
282 if pd
isa MMethodDef then
283 # Get the signature resolved for the current receiver
284 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
285 mparameters
.add_all
(sig
.mparameters
)
291 else if spropdefs
.not_empty
then
292 # Search for inherited manual autoinit
294 for s
in spropdefs
do
295 if mpropdef2npropdef
.has_key
(s
) then
296 self.toolcontext
.info
("{mclassdef} inherits a manual autoinit {s}", 3)
297 #mclassdef.autoinit = s
303 # Search the longest-one and checks for conflict
304 var longest
= spropdefs
.first
305 if spropdefs
.length
> 1 then
306 # part 1. find the longest list
307 for spd
in spropdefs
do
308 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
309 if spd
!= manual
and manual
!= null then
310 self.toolcontext
.info
("{mclassdef} conflict between manual autoinit {manual} and automatic autoinit {spd}.", 3)
313 # conflict with manual autoinit?
314 if longest
!= manual
and manual
!= null then
315 self.error
(nclassdef
, "Error: conflict between manual autoinit {manual} and automatic autoinit {longest}.")
318 # Check for conflict in the order of initializers
319 # Each initializer list must me a prefix of the longest list
320 # If `noautoinit` is set, just ignore conflicts
321 if noautoinit
== null then for spd
in spropdefs
do
323 for p
in spd
.initializers
do
324 if p
!= longest
.initializers
[i
] then
325 var proposal
= new ArraySet[MProperty]
326 for spd2
in spropdefs
do
327 proposal
.add_all spd2
.initializers
329 proposal
.add_all initializers
330 self.error
(nclassdef
, "Error: cannot generate automatic init for class {mclassdef.mclass}. Conflict in the order in inherited initializers {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")}). Use `autoinit` to order initializers. eg `autoinit {proposal.join(", ")}`")
331 # TODO: invalidate the initializer to avoid more errors
339 if noautoinit
!= null then
340 # If there is local or inherited initializers, then complain.
341 if initializers
.is_empty
and longest
.initializers
.is_empty
then
342 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
344 # Just clear initializers
348 # Combine the inherited list to what is collected
349 if longest
.initializers
.length
> 0 then
350 mparameters
.prepend longest
.msignature
.mparameters
351 initializers
.prepend longest
.initializers
356 # Create a specific new autoinit constructor
358 var mprop
= new MMethod(mclassdef
, "autoinit", nclassdef
.location
, public_visibility
)
360 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
361 mpropdef
.initializers
.add_all
(initializers
)
362 var msignature
= new MSignature(mparameters
, null)
363 mpropdef
.msignature
= msignature
364 mclassdef
.auto_init
= mpropdef
365 self.toolcontext
.info
("{mclassdef} gets a free auto constructor `{mpropdef}{msignature}`. {spropdefs}", 3)
366 #mclassdef.mclass.root_init = mpropdef
367 mclassdef
.mclass
.the_root_init_mmethod
= the_root_init_mmethod
371 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
372 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
374 var mmodule
= mpropdef
.mclassdef
.mmodule
375 var mproperty
= mpropdef
.mproperty
377 # Extract visibility information of the main part of `mtype`
378 # It is a case-by case
379 var vis_type
: nullable MVisibility = null # The own visibility of the type
380 var mmodule_type
: nullable MModule = null # The original module of the type
381 mtype
= mtype
.undecorate
382 if mtype
isa MClassType then
383 vis_type
= mtype
.mclass
.visibility
384 mmodule_type
= mtype
.mclass
.intro_mmodule
385 else if mtype
isa MVirtualType then
386 vis_type
= mtype
.mproperty
.visibility
387 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
388 else if mtype
isa MParameterType then
389 # nothing, always visible
390 else if mtype
isa MNullType then
392 else if mtype
isa MBottomType then
395 node
.debug
"Unexpected type {mtype}"
399 if vis_type
!= null then
400 assert mmodule_type
!= null
401 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
402 if mproperty
.visibility
> vis_type
then
403 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
405 else if mproperty
.visibility
> vis_module_type
then
406 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
411 # No error, try to go deeper in generic types
412 if node
isa AType then
413 for a
in node
.n_types
do
415 if t
== null then continue # Error, thus skipped
416 check_visibility
(a
, t
, mpropdef
)
418 else if mtype
isa MGenericType then
419 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
423 # Detect circularity errors for virtual types.
424 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
427 # Slow case: progress on each resolution until we visit all without getting a loop
429 # The graph used to detect loops
430 var mtype
= mproperty
.mvirtualtype
431 var poset
= new POSet[MType]
433 # The work-list of types to resolve
434 var todo
= new List[MType]
437 while not todo
.is_empty
do
441 if not t
.need_anchor
then continue
443 # Get the types derived of `t` (subtypes and bounds)
445 if t
isa MNullableType then
447 else if t
isa MGenericType then
449 else if t
isa MVirtualType then
451 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
452 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
453 if defs
.is_empty
then return false
454 nexts
= new Array[MType]
456 var next
= defs
.first
.bound
457 if next
== null then return false
460 else if t
isa MClassType then
461 # Basic type, nothing to to
463 else if t
isa MParameterType then
464 # Parameter types cannot depend on virtual types, so nothing to do
472 if poset
.has_edge
(next
, t
) then
473 if mtype
== next
then
474 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
476 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
480 poset
.add_edge
(t
, next
)
490 # Does the MPropDef contains a call to super or a call of a super-constructor?
491 # Subsequent phases of the frontend (esp. typing) set it if required
492 var has_supercall
: Bool = false is writable
495 redef class AClassdef
496 # Marker used in `ModelBuilder::build_properties`
497 private var build_properties_is_done
= false
501 # The base init of the class.
503 # TODO: Where to put this information is not clear because unlike other
504 # informations, the initialisers are stable in a same class.
505 var root_init
: nullable MMethodDef = null
507 # The base init of the class.
509 # TODO: merge with `root_init` and `ModelBuilder::the_root_init_mmethod` if possible
510 var the_root_init_mmethod
: nullable MMethod = null
513 redef class MClassDef
514 # What is the `APropdef` associated to a `MProperty`?
515 # Used to check multiple definition of a property.
516 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
518 # Build the virtual type `SELF` only for introduction `MClassDef`
519 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
521 if not is_intro
then return
524 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
526 # If SELF type is declared nowherer?
527 if mprop
== null then return
529 # SELF is not a virtual type? it is weird but we ignore it
530 if not mprop
isa MVirtualTypeProp then return
532 # Is this the intro of SELF in the library?
533 var intro
= mprop
.intro
534 var intro_mclassdef
= intro
.mclassdef
535 if intro_mclassdef
== self then
536 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
538 # SELF must be declared in Object, otherwise this will create conflicts
539 if intro_mclassdef
.mclass
.name
!= "Object" then
540 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
543 # SELF must be public
544 if mprop
.visibility
!= public_visibility
then
545 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
548 # SELF must not be fixed
549 if intro
.is_fixed
then
550 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
556 # This class introduction inherits a SELF
557 # We insert an artificial property to update it
558 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
559 mpropdef
.bound
= mclass
.mclass_type
564 # The associated main model entity
565 type MPROPDEF: MPropDef
567 # The associated propdef once build by a `ModelBuilder`
568 var mpropdef
: nullable MPROPDEF is writable
570 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
571 private fun build_signature
(modelbuilder
: ModelBuilder) do end
572 private fun check_signature
(modelbuilder
: ModelBuilder) do end
573 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
575 var mvisibility
= public_visibility
576 if nvisibility
!= null then
577 mvisibility
= nvisibility
.mvisibility
578 if mvisibility
== intrude_visibility
then
579 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
580 mvisibility
= public_visibility
583 if mclassdef
.mclass
.visibility
== private_visibility
then
584 if mvisibility
== protected_visibility
then
585 assert nvisibility
!= null
586 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
587 else if mvisibility
== private_visibility
then
588 assert nvisibility
!= null
589 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
591 mvisibility
= private_visibility
596 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
598 var ndoc
= self.n_doc
600 var mdoc
= ndoc
.to_mdoc
602 mdoc
.original_mentity
= mpropdef
603 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
and mpropdef
.name
!= "new" then
604 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
607 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
608 if at_deprecated
!= null then
609 if not mpropdef
.is_intro
then
610 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
612 var info
= new MDeprecationInfo
613 ndoc
= at_deprecated
.n_doc
614 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
615 mpropdef
.mproperty
.deprecation
= info
620 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
622 if nvisibility
== null then return
623 var mvisibility
= nvisibility
.mvisibility
624 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
625 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
629 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
631 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
632 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
635 if mprop
isa MMethod and mprop
.is_root_init
then return true
636 if kwredef
== null then
638 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
642 # Check for full-name conflicts in the package.
643 # A public property should have a unique qualified name `package::class::prop`.
644 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
645 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
646 if others
!= null then for other
in others
do
647 if other
!= mprop
and other
.intro_mclassdef
.mmodule
.mgroup
!= null and other
.intro_mclassdef
.mmodule
.mgroup
.mpackage
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mpackage
and other
.intro_mclassdef
.mclass
.name
== mprop
.intro_mclassdef
.mclass
.name
and other
.visibility
>= protected_visibility
then
648 modelbuilder
.advice
(self, "full-name-conflict", "Warning: A property named `{other.full_name}` is already defined in module `{other.intro_mclassdef.mmodule}` for the class `{other.intro_mclassdef.mclass.name}`.")
654 if not need_redef
then
655 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
662 # Checks for useless type in redef signatures.
663 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
666 redef class ASignature
667 # Is the model builder has correctly visited the signature
668 var is_visited
= false
669 # Names of parameters from the AST
670 # REQUIRE: is_visited
671 var param_names
= new Array[String]
672 # Types of parameters from the AST
673 # REQUIRE: is_visited
674 var param_types
= new Array[MType]
675 # Rank of the vararg (of -1 if none)
676 # REQUIRE: is_visited
677 var vararg_rank
: Int = -1
679 var ret_type
: nullable MType = null
681 # Visit and fill information about a signature
682 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
684 var mmodule
= mclassdef
.mmodule
685 var param_names
= self.param_names
686 var param_types
= self.param_types
687 for np
in self.n_params
do
688 param_names
.add
(np
.n_id
.text
)
689 var ntype
= np
.n_type
690 if ntype
!= null then
691 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
692 if mtype
== null then return false # Skip error
693 for i
in [0..param_names
.length-param_types
.length
[ do
694 param_types
.add
(mtype
)
696 if np
.n_dotdotdot
!= null then
697 if self.vararg_rank
!= -1 then
698 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
701 self.vararg_rank
= param_names
.length
- 1
706 var ntype
= self.n_type
707 if ntype
!= null then
708 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
709 if self.ret_type
== null then return false # Skip error
712 self.is_visited
= true
716 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
719 for np
in self.n_params
do
720 var ntype
= np
.n_type
721 if ntype
!= null then
722 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
727 var ntype
= self.n_type
728 if ntype
!= null then
729 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
733 if not res
then is_broken
= true
739 # The associated mparameter if any
740 var mparameter
: nullable MParameter = null
743 redef class AMethPropdef
744 redef type MPROPDEF: MMethodDef
746 # Is the method annotated `autoinit`?
747 var is_autoinit
= false
749 # Can self be used as a root init?
750 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
752 # Need the `init` keyword
753 if n_kwinit
== null then return false
754 # Need to by anonymous
755 if self.n_methid
!= null then return false
756 # No annotation on itself
757 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
759 var amod
= self.parent
.parent
.as(AModule)
760 var amoddecl
= amod
.n_moduledecl
761 if amoddecl
!= null then
762 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
763 if old
!= null then return false
766 if self.n_signature
.n_params
.length
> 0 then
767 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
770 # Cannot be private or something
771 if not self.n_visibility
isa APublicVisibility then
772 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
779 redef fun build_property
(modelbuilder
, mclassdef
)
781 var n_kwinit
= n_kwinit
782 var n_kwnew
= n_kwnew
783 var is_init
= n_kwinit
!= null or n_kwnew
!= null
785 var amethodid
= self.n_methid
787 if amethodid
== null then
791 else if n_kwinit
!= null then
794 if self.n_signature
.n_params
.not_empty
or get_single_annotation
("old_style_init", modelbuilder
) != null then
797 else if n_kwnew
!= null then
803 else if amethodid
isa AIdMethid then
804 name
= amethodid
.n_id
.text
805 name_node
= amethodid
807 # operator, bracket or assign
808 name
= amethodid
.collect_text
809 name_node
= amethodid
811 var arity
= self.n_signature
.n_params
.length
812 if name
== "+" and arity
== 0 then
814 else if name
== "-" and arity
== 0 then
816 else if name
== "~" and arity
== 0 then
819 if amethodid
.is_binary
and arity
!= 1 then
820 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
821 else if amethodid
.min_arity
> arity
then
822 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
827 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
828 var mprop
: nullable MMethod = null
829 if not is_init
or n_kwredef
!= null or look_like_a_root_init
then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
830 if mprop
== null and look_like_a_root_init
then
831 mprop
= modelbuilder
.the_root_init_mmethod
833 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
834 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
837 if mprop
== null then
838 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
839 mprop
= new MMethod(mclassdef
, name
, self.location
, mvisibility
)
840 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
841 modelbuilder
.the_root_init_mmethod
= mprop
842 mprop
.is_root_init
= true
844 mprop
.is_init
= is_init
845 mprop
.is_new
= n_kwnew
!= null
846 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
847 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
848 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
849 mprop
.is_broken
= true
853 if mprop
.is_broken
then return
854 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
855 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
858 # Check name conflicts in the local class for constructors.
860 for p
, n
in mclassdef
.mprop2npropdef
do
861 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
862 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
863 mprop
.is_broken
= true
871 mclassdef
.mprop2npropdef
[mprop
] = self
873 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
874 if mprop
.name
== "autoinit" and mclassdef
.is_intro
then
875 assert mclassdef
.auto_init
== null
876 mclassdef
.auto_init
= mpropdef
877 if mpropdef
.is_intro
then
878 mpropdef
.initializers
.add mprop
879 mpropdef
.is_calling_init
= true
883 set_doc
(mpropdef
, modelbuilder
)
885 self.mpropdef
= mpropdef
886 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
887 if mpropdef
.is_intro
then
888 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
890 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
894 redef fun build_signature
(modelbuilder
)
896 var mpropdef
= self.mpropdef
897 if mpropdef
== null then return # Error thus skiped
898 var mclassdef
= mpropdef
.mclassdef
899 var mmodule
= mclassdef
.mmodule
900 var nsig
= self.n_signature
902 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
903 var root_init
= mclassdef
.mclass
.root_init
904 if root_init
!= null then
905 # Inherit the initializers by refinement
906 assert mpropdef
.initializers
.is_empty
907 mpropdef
.initializers
.add_all root_init
.initializers
911 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
912 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
914 # Retrieve info from the signature AST
915 var param_names
= new Array[String] # Names of parameters from the AST
916 var param_types
= new Array[MType] # Types of parameters from the AST
918 var ret_type
: nullable MType = null # Return type from the AST
920 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
921 param_names
= nsig
.param_names
922 param_types
= nsig
.param_types
923 vararg_rank
= nsig
.vararg_rank
924 ret_type
= nsig
.ret_type
927 # Look for some signature to inherit
928 # FIXME: do not inherit from the intro, but from the most specific
929 var msignature
: nullable MSignature = null
930 if not mpropdef
.is_intro
then
931 msignature
= mpropdef
.mproperty
.intro
.msignature
932 if msignature
== null then return # Skip error
934 # The local signature is adapted to use the local formal types, if any.
935 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
937 # Check inherited signature arity
938 if param_names
.length
!= msignature
.arity
then
940 if nsig
!= null then node
= nsig
else node
= self
941 modelbuilder
.error
(node
, "Redef Error: expected {msignature.arity} parameter(s) for `{mpropdef.mproperty.name}{msignature}`; got {param_names.length}. See introduction at `{mpropdef.mproperty.full_name}`.")
944 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
945 # FIXME UGLY: inherit signature from a super-constructor
946 for msupertype
in mclassdef
.supertypes
do
947 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
948 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
949 if candidate
!= null then
950 if msignature
== null then
951 msignature
= candidate
.intro
.as(MMethodDef).msignature
958 # Inherit the signature
959 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
960 # Parameters are untyped, thus inherit them
961 param_types
= new Array[MType]
962 for mparameter
in msignature
.mparameters
do
963 param_types
.add
(mparameter
.mtype
)
965 vararg_rank
= msignature
.vararg_rank
967 if msignature
!= null and ret_type
== null then
968 ret_type
= msignature
.return_mtype
971 if param_names
.length
!= param_types
.length
then
972 # Some parameters are typed, other parameters are not typed.
973 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
977 var mparameters
= new Array[MParameter]
978 for i
in [0..param_names
.length
[ do
979 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
980 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
981 mparameters
.add
(mparameter
)
984 # In `new`-factories, the return type is by default the classtype.
985 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
987 # Special checks for operator methods
988 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
989 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
991 if ret_type
== null and return_is_mandatory
then
992 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
995 msignature
= new MSignature(mparameters
, ret_type
)
996 mpropdef
.msignature
= msignature
997 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
998 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
999 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
1002 var at
= self.get_single_annotation
("lazy", modelbuilder
)
1003 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
1005 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1006 if atautoinit
!= null then
1007 if not mpropdef
.is_intro
then
1008 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
1009 else if not mclassdef
.is_intro
then
1010 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
1012 self.is_autoinit
= true
1017 redef fun check_signature
(modelbuilder
)
1019 var mpropdef
= self.mpropdef
1020 if mpropdef
== null then return # Error thus skiped
1021 var mclassdef
= mpropdef
.mclassdef
1022 var mmodule
= mclassdef
.mmodule
1023 var nsig
= self.n_signature
1024 var mysignature
= mpropdef
.msignature
1025 if mysignature
== null then return # Error thus skiped
1028 if nsig
!= null then
1029 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1030 mpropdef
.msignature
= null # invalidate
1031 mpropdef
.is_broken
= true
1032 return # Forward error
1036 # Lookup for signature in the precursor
1037 # FIXME all precursors should be considered
1038 if not mpropdef
.is_intro
then
1039 var msignature
= mpropdef
.mproperty
.intro
.msignature
1040 if msignature
== null then return
1042 var precursor_ret_type
= msignature
.return_mtype
1043 var ret_type
= mysignature
.return_mtype
1044 if ret_type
!= null and precursor_ret_type
== null then
1045 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1046 mpropdef
.msignature
= null
1047 mpropdef
.is_broken
= true
1051 if mysignature
.arity
> 0 then
1052 # Check parameters types
1053 for i
in [0..mysignature
.arity
[ do
1054 var myt
= mysignature
.mparameters
[i
].mtype
1055 var prt
= msignature
.mparameters
[i
].mtype
1056 var node
= nsig
.n_params
[i
]
1057 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1058 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1059 mpropdef
.msignature
= null
1060 mpropdef
.is_broken
= true
1064 if precursor_ret_type
!= null then
1065 var node
: nullable ANode = null
1066 if nsig
!= null then node
= nsig
.n_type
1067 if node
== null then node
= self
1068 if ret_type
== null then
1069 # Inherit the return type
1070 ret_type
= precursor_ret_type
1071 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1072 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1073 mpropdef
.msignature
= null
1074 mpropdef
.is_broken
= true
1079 if nsig
!= null then
1080 # Check parameters visibility
1081 for i
in [0..mysignature
.arity
[ do
1082 var nt
= nsig
.n_params
[i
].n_type
1083 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1085 var nt
= nsig
.n_type
1086 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1088 check_repeated_types
(modelbuilder
)
1091 # For parameters, type is always useless in a redef.
1092 # For return type, type is useless if not covariant with introduction.
1093 redef fun check_repeated_types
(modelbuilder
) do
1094 var mpropdef
= self.mpropdef
1095 if mpropdef
== null then return
1096 if mpropdef
.is_intro
or n_signature
== null then return
1098 for param
in n_signature
.n_params
do
1099 if param
.n_type
!= null then
1100 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1104 var intro
= mpropdef
.mproperty
.intro
1105 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1106 if n_intro
== null or not n_intro
isa AMethPropdef then return
1108 var ret_type
= n_signature
.ret_type
1109 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1110 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1116 # Is a return required?
1118 # * True for operators and brackets.
1119 # * False for id and assignment.
1120 fun return_is_mandatory
: Bool do return true
1122 # Can the last parameter be special like a vararg?
1124 # * False for operators: the last one is in fact the only one.
1125 # * False for assignments: it is the right part of the assignment.
1126 # * True for ids and brackets.
1127 fun accept_special_last_parameter
: Bool do return false
1129 # The minimum required number of parameters.
1131 # * 1 for binary operators
1133 # * 1 for assignments
1134 # * 2 for bracket assignments
1136 fun min_arity
: Int do return 1
1138 # Is the `self` a binary operator?
1139 fun is_binary
: Bool do return true
1142 redef class AIdMethid
1143 redef fun return_is_mandatory
do return false
1144 redef fun accept_special_last_parameter
do return true
1145 redef fun min_arity
do return 0
1146 redef fun is_binary
do return false
1149 redef class ABraMethid
1150 redef fun accept_special_last_parameter
do return true
1151 redef fun is_binary
do return false
1154 redef class ABraassignMethid
1155 redef fun return_is_mandatory
do return false
1156 redef fun min_arity
do return 2
1157 redef fun is_binary
do return false
1160 redef class AAssignMethid
1161 redef fun return_is_mandatory
do return false
1162 redef fun is_binary
do return false
1165 redef class AAttrPropdef
1166 redef type MPROPDEF: MAttributeDef
1168 # The static type of the property (declared, inferred or inherited)
1169 # This attribute is also used to check if the property was analyzed and is valid.
1170 var mtype
: nullable MType
1172 # Is the node tagged `noinit`?
1175 # Is the node tagged lazy?
1178 # Is the node tagged optional?
1179 var is_optional
= false
1181 # Has the node a default value?
1182 # Could be through `n_expr` or `n_block`
1183 var has_value
= false
1185 # The guard associated to a lazy attribute.
1186 # Because some engines does not have a working `isset`,
1187 # this additional attribute is used to guard the lazy initialization.
1188 # TODO: to remove once isset is correctly implemented
1189 var mlazypropdef
: nullable MAttributeDef
1191 # The associated getter (read accessor) if any
1192 var mreadpropdef
: nullable MMethodDef is writable
1193 # The associated setter (write accessor) if any
1194 var mwritepropdef
: nullable MMethodDef is writable
1196 redef fun build_property
(modelbuilder
, mclassdef
)
1198 var mclass
= mclassdef
.mclass
1200 var name
= nid2
.text
1202 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1203 if atabstract
== null then
1204 if not mclass
.kind
.need_init
then
1205 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1208 var mprop
= new MAttribute(mclassdef
, "_" + name
, self.location
, private_visibility
)
1209 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1210 self.mpropdef
= mpropdef
1211 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1215 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1216 if mreadprop
== null then
1217 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1218 mreadprop
= new MMethod(mclassdef
, readname
, self.location
, mvisibility
)
1219 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then
1220 mreadprop
.is_broken
= true
1224 if mreadprop
.is_broken
then return
1225 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1226 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1228 mclassdef
.mprop2npropdef
[mreadprop
] = self
1230 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1231 self.mreadpropdef
= mreadpropdef
1232 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1233 set_doc
(mreadpropdef
, modelbuilder
)
1234 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1235 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1237 has_value
= n_expr
!= null or n_block
!= null
1239 if atabstract
!= null and has_value
then
1240 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1244 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1245 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1246 if atnoinit
!= null then
1249 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1252 if atabstract
!= null then
1253 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1257 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1258 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1259 if atlazy
!= null or atlateinit
!= null then
1260 if atlazy
!= null and atlateinit
!= null then
1261 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1264 if not has_value
then
1265 if atlazy
!= null then
1266 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1267 else if atlateinit
!= null then
1268 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1274 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, self.location
, none_visibility
)
1275 mlazyprop
.is_fictive
= true
1276 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1277 mlazypropdef
.is_fictive
= true
1278 self.mlazypropdef
= mlazypropdef
1281 var atoptional
= self.get_single_annotation
("optional", modelbuilder
)
1282 if atoptional
!= null then
1283 if not has_value
then
1284 modelbuilder
.error
(atoptional
, "Error: `optional` attributes need a default value.")
1289 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1290 if atreadonly
!= null then
1291 if not has_value
then
1292 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1294 # No setter, so just leave
1298 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1299 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1302 var writename
= name
+ "="
1303 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1304 if atwritable
!= null then
1305 if not atwritable
.n_args
.is_empty
then
1306 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1309 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1310 var nwkwredef
: nullable Token = null
1311 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1312 if mwriteprop
== null then
1314 if atwritable
!= null then
1315 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1317 mvisibility
= mreadprop
.visibility
1318 # By default, use protected visibility at most
1319 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1321 mwriteprop
= new MMethod(mclassdef
, writename
, self.location
, mvisibility
)
1322 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then
1323 mwriteprop
.is_broken
= true
1326 mwriteprop
.deprecation
= mreadprop
.deprecation
1328 if mwriteprop
.is_broken
then return
1329 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1330 if atwritable
!= null then
1331 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1334 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1336 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1337 self.mwritepropdef
= mwritepropdef
1338 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1339 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1340 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1342 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1343 if atautoinit
!= null then
1345 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1346 else if not mwritepropdef
.is_intro
then
1347 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1348 else if not mclassdef
.is_intro
then
1349 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1350 else if atabstract
== null then
1351 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1353 else if atabstract
!= null then
1354 # By default, abstract attribute are not autoinit
1359 redef fun build_signature
(modelbuilder
)
1361 var mreadpropdef
= self.mreadpropdef
1362 var mpropdef
= self.mpropdef
1363 if mreadpropdef
== null then return # Error thus skipped
1364 var mclassdef
= mreadpropdef
.mclassdef
1365 var mmodule
= mclassdef
.mmodule
1366 var mtype
: nullable MType = null
1369 var ntype
= self.n_type
1370 if ntype
!= null then
1371 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1372 if mtype
== null then return
1375 var inherited_type
: nullable MType = null
1376 # Inherit the type from the getter (usually an abstract getter)
1377 if not mreadpropdef
.is_intro
then
1378 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1379 if msignature
== null then return # Error, thus skipped
1380 inherited_type
= msignature
.return_mtype
1381 if inherited_type
!= null then
1382 # The inherited type is adapted to use the local formal types, if any.
1383 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1384 if mtype
== null then mtype
= inherited_type
1388 var nexpr
= self.n_expr
1389 if mtype
== null then
1390 if nexpr
!= null then
1391 if nexpr
isa ANewExpr then
1392 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1393 else if nexpr
isa AAsCastExpr then
1394 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1395 else if nexpr
isa AIntegerExpr then
1396 var cla
: nullable MClass = null
1397 if nexpr
.value
isa Int then
1398 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1399 else if nexpr
.value
isa Byte then
1400 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1401 else if nexpr
.value
isa Int8 then
1402 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1403 else if nexpr
.value
isa Int16 then
1404 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1405 else if nexpr
.value
isa UInt16 then
1406 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1407 else if nexpr
.value
isa Int32 then
1408 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1409 else if nexpr
.value
isa UInt32 then
1410 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1412 # Should not happen, and should be updated as new types are added
1415 if cla
!= null then mtype
= cla
.mclass_type
1416 else if nexpr
isa AFloatExpr then
1417 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1418 if cla
!= null then mtype
= cla
.mclass_type
1419 else if nexpr
isa ACharExpr then
1420 var cla
: nullable MClass
1421 if nexpr
.is_ascii
then
1422 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1423 else if nexpr
.is_code_point
then
1424 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1426 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1428 if cla
!= null then mtype
= cla
.mclass_type
1429 else if nexpr
isa ABoolExpr then
1430 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1431 if cla
!= null then mtype
= cla
.mclass_type
1432 else if nexpr
isa ASuperstringExpr then
1433 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1434 if cla
!= null then mtype
= cla
.mclass_type
1435 else if nexpr
isa AStringFormExpr then
1436 var cla
: nullable MClass
1437 if nexpr
.is_bytestring
then
1438 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bytes")
1439 else if nexpr
.is_re
then
1440 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Regex")
1441 else if nexpr
.is_string
then
1442 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1446 if cla
!= null then mtype
= cla
.mclass_type
1448 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
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
(mmodule
, 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
1474 var msignature
= new MSignature(new Array[MParameter], mtype
)
1475 mreadpropdef
.msignature
= msignature
1478 var mwritepropdef
= self.mwritepropdef
1479 if mwritepropdef
!= null then
1480 var mwritetype
= mtype
1482 mwritetype
= mwritetype
.as_nullable
1486 var mparameter
= new MParameter(name
, mwritetype
, false)
1487 var msignature
= new MSignature([mparameter
], null)
1488 mwritepropdef
.msignature
= msignature
1491 var mlazypropdef
= self.mlazypropdef
1492 if mlazypropdef
!= null then
1493 mlazypropdef
.static_mtype
= mmodule
.bool_type
1495 check_repeated_types
(modelbuilder
)
1498 redef fun check_signature
(modelbuilder
)
1500 var mpropdef
= self.mpropdef
1501 if mpropdef
== null then return # Error thus skipped
1502 var ntype
= self.n_type
1503 var mtype
= self.mtype
1504 if mtype
== null then return # Error thus skipped
1506 var mclassdef
= mpropdef
.mclassdef
1507 var mmodule
= mclassdef
.mmodule
1510 if ntype
!= null then
1511 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1514 if nexpr
isa ANewExpr then
1515 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1518 # Lookup for signature in the precursor
1519 # FIXME all precursors should be considered
1520 if not mpropdef
.is_intro
then
1521 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1522 if precursor_type
== null then return
1524 if mtype
!= precursor_type
then
1525 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1530 # Check getter and setter
1531 var meth
= self.mreadpropdef
1532 if meth
!= null then
1533 self.check_method_signature
(modelbuilder
, meth
)
1534 var node
: nullable ANode = ntype
1535 if node
== null then node
= self
1536 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1538 meth
= self.mwritepropdef
1539 if meth
!= null then
1540 self.check_method_signature
(modelbuilder
, meth
)
1541 var node
: nullable ANode = ntype
1542 if node
== null then node
= self
1543 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1547 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1549 var mclassdef
= mpropdef
.mclassdef
1550 var mmodule
= mclassdef
.mmodule
1551 var nsig
= self.n_type
1552 var mysignature
= mpropdef
.msignature
1553 if mysignature
== null then return # Error thus skiped
1555 # Lookup for signature in the precursor
1556 # FIXME all precursors should be considered
1557 if not mpropdef
.is_intro
then
1558 var msignature
= mpropdef
.mproperty
.intro
.msignature
1559 if msignature
== null then return
1561 if mysignature
.arity
!= msignature
.arity
then
1563 if nsig
!= null then node
= nsig
else node
= self
1564 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}`.")
1567 var precursor_ret_type
= msignature
.return_mtype
1568 var ret_type
= mysignature
.return_mtype
1569 if ret_type
!= null and precursor_ret_type
== null then
1571 if nsig
!= null then node
= nsig
else node
= self
1572 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1576 if mysignature
.arity
> 0 then
1577 # Check parameters types
1578 for i
in [0..mysignature
.arity
[ do
1579 var myt
= mysignature
.mparameters
[i
].mtype
1580 var prt
= msignature
.mparameters
[i
].mtype
1582 if nsig
!= null then node
= nsig
else node
= self
1583 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1584 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1588 if precursor_ret_type
!= null then
1590 if nsig
!= null then node
= nsig
else node
= self
1591 if ret_type
== null then
1592 # Inherit the return type
1593 ret_type
= precursor_ret_type
1594 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1595 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1601 # Type is useless if the attribute type is the same thant the intro.
1602 redef fun check_repeated_types
(modelbuilder
) do
1603 var mreadpropdef
= self.mreadpropdef
1604 if mreadpropdef
== null then return
1605 if mreadpropdef
.is_intro
or n_type
== null then return
1607 var intro
= mreadpropdef
.mproperty
.intro
1608 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1609 if n_intro
== null then return
1612 if n_intro
isa AMethPropdef then
1613 ntype
= n_intro
.n_signature
.ret_type
1614 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1615 ntype
= n_intro
.n_type
.mtype
1618 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1619 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1623 redef class ATypePropdef
1624 redef type MPROPDEF: MVirtualTypeDef
1626 redef fun build_property
(modelbuilder
, mclassdef
)
1628 var name
= self.n_qid
.n_id
.text
1629 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1630 if mprop
== null then
1631 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1632 mprop
= new MVirtualTypeProp(mclassdef
, name
, self.location
, mvisibility
)
1633 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1634 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1638 if mprop
.is_broken
then return
1639 assert mprop
isa MVirtualTypeProp
1640 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1643 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1644 self.mpropdef
= mpropdef
1645 if mpropdef
.is_intro
then
1646 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1648 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1650 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1651 mpropdef
.is_broken
=true
1653 mclassdef
.mprop2npropdef
[mprop
] = self
1654 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1655 set_doc
(mpropdef
, modelbuilder
)
1657 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1658 if atfixed
!= null then
1659 mpropdef
.is_fixed
= true
1663 redef fun build_signature
(modelbuilder
)
1665 var mpropdef
= self.mpropdef
1666 if mpropdef
== null then return # Error thus skipped
1667 var mclassdef
= mpropdef
.mclassdef
1668 var mmodule
= mclassdef
.mmodule
1669 var mtype
: nullable MType = null
1671 var ntype
= self.n_type
1672 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1673 if mtype
== null then return
1675 mpropdef
.bound
= mtype
1676 # print "{mpropdef}: {mtype}"
1679 redef fun check_signature
(modelbuilder
)
1681 var mpropdef
= self.mpropdef
1682 if mpropdef
== null then return # Error thus skipped
1684 var bound
= mpropdef
.bound
1685 if bound
== null then return # Error thus skipped
1687 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1689 var mclassdef
= mpropdef
.mclassdef
1690 var mmodule
= mclassdef
.mmodule
1691 var anchor
= mclassdef
.bound_mtype
1693 var ntype
= self.n_type
1694 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1695 mpropdef
.bound
= null
1699 # Check redefinitions
1700 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1701 var supbound
= p
.bound
1702 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1704 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1707 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1708 # Still a warning to pass existing bad code
1709 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1712 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1713 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")