1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 # Fall back to the class node if any.
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
64 # Retrieve all the attributes nodes localy definied
65 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
66 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
68 var res
= new Array[AAttrPropdef]
69 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
70 if n
== null then return res
71 for npropdef
in n
.n_propdefs
do
72 if npropdef
isa AAttrPropdef then
73 # Run the phases on it
74 toolcontext
.run_phases_on_npropdef
(npropdef
)
81 # Build the properties of `nclassdef`.
82 # REQUIRE: all superclasses are built.
83 private fun build_properties
(nclassdef
: AClassdef)
85 # Force building recursively
86 if nclassdef
.build_properties_is_done
then return
87 nclassdef
.build_properties_is_done
= true
88 var mclassdef
= nclassdef
.mclassdef
89 if mclassdef
== null then return # skip error
90 if mclassdef
.in_hierarchy
== null then return # Skip error
91 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
92 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
93 build_properties
(mclassdef2nclassdef
[superclassdef
])
96 mclassdef
.build_self_type
(self, nclassdef
)
97 for nclassdef2
in nclassdef
.all_defs
do
98 for npropdef
in nclassdef2
.n_propdefs
do
99 npropdef
.build_property
(self, mclassdef
)
101 for npropdef
in nclassdef2
.n_propdefs
do
102 npropdef
.build_signature
(self)
104 for npropdef
in nclassdef2
.n_propdefs
do
105 if not npropdef
isa ATypePropdef then continue
107 var mpropdef
= npropdef
.mpropdef
108 if mpropdef
== null then continue
109 if mpropdef
.bound
== null then continue
110 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
111 # Invalidate the bound
112 mpropdef
.is_broken
= true
113 mpropdef
.bound
= new MBottomType(mclassdef
.mmodule
.model
)
116 for npropdef
in nclassdef2
.n_propdefs
do
117 # Check ATypePropdef first since they may be required for the other properties
118 if not npropdef
isa ATypePropdef then continue
119 npropdef
.check_signature
(self)
122 for npropdef
in nclassdef2
.n_propdefs
do
123 if npropdef
isa ATypePropdef then continue
124 npropdef
.check_signature
(self)
127 process_default_constructors
(nclassdef
)
130 # the root init of the Object class
131 # Is usually implicitly defined
132 # Then explicit or implicit definitions of root-init are attached to it
133 var the_root_init_mmethod
: nullable MMethod
135 # Introduce or inherit default constructor
136 # This is the last part of `build_properties`.
137 private fun process_default_constructors
(nclassdef
: AClassdef)
139 var mclassdef
= nclassdef
.mclassdef
.as(not null)
141 # Are we a refinement
142 if not mclassdef
.is_intro
then return
144 # Look for the init in Object, or create it
145 if mclassdef
.mclass
.name
== "Object" and the_root_init_mmethod
== null then
146 # Create the implicit root-init method
147 var mprop
= new MMethod(mclassdef
, "init", mclassdef
.mclass
.visibility
)
148 mprop
.is_root_init
= true
149 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
150 var mparameters
= new Array[MParameter]
151 var msignature
= new MSignature(mparameters
, null)
152 mpropdef
.msignature
= msignature
153 mpropdef
.new_msignature
= msignature
155 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
156 the_root_init_mmethod
= mprop
159 # Is there already a constructor defined?
160 var defined_init
: nullable MMethodDef = null
161 for mpropdef
in mclassdef
.mpropdefs
do
162 if not mpropdef
isa MMethodDef then continue
163 if not mpropdef
.mproperty
.is_init
then continue
164 if mpropdef
.mproperty
.is_root_init
then
165 assert defined_init
== null
166 defined_init
= mpropdef
167 else if mpropdef
.mproperty
.name
== "autoinit" then
168 # An explicit old-style init named "init", so return
173 if mclassdef
.auto_init
!= null then
177 if not nclassdef
isa AStdClassdef then return
179 # Collect undefined attributes
180 var mparameters
= new Array[MParameter]
181 var initializers
= new Array[MProperty]
182 for npropdef
in nclassdef
.n_propdefs
do
183 if npropdef
isa AMethPropdef then
184 if not npropdef
.is_autoinit
then continue # Skip non tagged autoinit
185 var mpropdef
= npropdef
.mpropdef
186 if mpropdef
== null then return # Skip broken method
187 var sig
= mpropdef
.msignature
188 if sig
== null then continue # Skip broken method
190 mparameters
.add_all sig
.mparameters
191 initializers
.add
(mpropdef
.mproperty
)
192 mpropdef
.mproperty
.is_autoinit
= true
194 if npropdef
isa AAttrPropdef then
195 var mreadpropdef
= npropdef
.mreadpropdef
196 if mreadpropdef
== null then return # Skip broken attribute
197 var msignature
= mreadpropdef
.msignature
198 if msignature
== null then return # Skip broken attribute
199 if npropdef
.noinit
then continue # Skip noinit attribute
200 var atlateinit
= npropdef
.get_single_annotation
("lateinit", self)
201 if atlateinit
!= null then
202 # For lateinit attributes, call the reader to force
203 # the lazy initialization of the attribute.
204 initializers
.add
(mreadpropdef
.mproperty
)
205 mreadpropdef
.mproperty
.is_autoinit
= true
208 if npropdef
.has_value
then continue
209 var paramname
= mreadpropdef
.mproperty
.name
210 var ret_type
= msignature
.return_mtype
211 if ret_type
== null then return
212 var mparameter
= new MParameter(paramname
, ret_type
, false)
213 mparameters
.add
(mparameter
)
214 var msetter
= npropdef
.mwritepropdef
215 if msetter
== null then
216 # No setter, it is a readonly attribute, so just add it
217 initializers
.add
(npropdef
.mpropdef
.mproperty
)
218 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
220 # Add the setter to the list
221 initializers
.add
(msetter
.mproperty
)
222 msetter
.mproperty
.is_autoinit
= true
227 var the_root_init_mmethod
= self.the_root_init_mmethod
228 if the_root_init_mmethod
== null then return
230 # Look for most-specific new-stype init definitions
231 var spropdefs
= new ArraySet[MMethodDef]
232 for x
in mclassdef
.in_hierarchy
.direct_greaters
do
233 var y
= x
.mclass
.intro
.auto_init
234 if y
== null then continue
235 if y
.is_broken
or y
.msignature
== null then return
239 # Look at the autoinit class-annotation
240 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
241 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
242 if autoinit
!= null then
243 # Just throws the collected initializers
247 if noautoinit
!= null then
248 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
251 if autoinit
.n_args
.is_empty
then
252 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
255 # Get and check each argument
256 for narg
in autoinit
.n_args
do
259 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
263 # Search the property.
264 # To avoid bad surprises, try to get the setter first.
265 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
267 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
270 error
(narg
, "Error: unknown method `{id}`")
273 if not p
.is_autoinit
then
274 error
(narg
, "Error: `{p}` is not an autoinit method")
278 # Register the initializer and the parameters
281 if pd
isa MMethodDef then
282 # Get the signature resolved for the current receiver
283 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
284 mparameters
.add_all
(sig
.mparameters
)
291 # Search the longest-one and checks for conflict
292 var longest
= spropdefs
.first
293 if spropdefs
.length
> 1 then
294 # part 1. find the longest list
295 for spd
in spropdefs
do
296 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
299 # Check for conflict in the order of initializers
300 # Each initializer list must me a prefix of the longest list
301 # If `noautoinit` is set, just ignore conflicts
302 if noautoinit
== null then for spd
in spropdefs
do
304 for p
in spd
.initializers
do
305 if p
!= longest
.initializers
[i
] then
306 var proposal
= new ArraySet[MProperty]
307 for spd2
in spropdefs
do
308 proposal
.add_all spd2
.initializers
310 proposal
.add_all initializers
311 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(", ")}`")
312 # TODO: invalidate the initializer to avoid more errors
320 if noautoinit
!= null then
321 # If there is local or inherited initializers, then complain.
322 if initializers
.is_empty
and longest
.initializers
.is_empty
then
323 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
325 # Just clear initializers
329 # Can we just inherit?
330 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
331 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
332 mclassdef
.mclass
.root_init
= longest
336 # Combine the inherited list to what is collected
337 if longest
.initializers
.length
> 0 then
338 mparameters
.prepend longest
.new_msignature
.mparameters
339 initializers
.prepend longest
.initializers
344 # Create a specific new autoinit constructor
346 var mprop
= new MMethod(mclassdef
, "autoinit", public_visibility
)
348 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
349 mpropdef
.initializers
.add_all
(initializers
)
350 var msignature
= new MSignature(mparameters
, null)
351 mpropdef
.msignature
= msignature
352 mclassdef
.auto_init
= mpropdef
353 self.toolcontext
.info
("{mclassdef} gets a free auto constructor `{mpropdef}{msignature}`. {spropdefs}", 3)
354 #mclassdef.mclass.root_init = mpropdef
355 mclassdef
.mclass
.the_root_init_mmethod
= the_root_init_mmethod
359 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
360 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
362 var mmodule
= mpropdef
.mclassdef
.mmodule
363 var mproperty
= mpropdef
.mproperty
365 # Extract visibility information of the main part of `mtype`
366 # It is a case-by case
367 var vis_type
: nullable MVisibility = null # The own visibility of the type
368 var mmodule_type
: nullable MModule = null # The original module of the type
369 mtype
= mtype
.undecorate
370 if mtype
isa MClassType then
371 vis_type
= mtype
.mclass
.visibility
372 mmodule_type
= mtype
.mclass
.intro_mmodule
373 else if mtype
isa MVirtualType then
374 vis_type
= mtype
.mproperty
.visibility
375 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
376 else if mtype
isa MParameterType then
377 # nothing, always visible
378 else if mtype
isa MNullType then
380 else if mtype
isa MBottomType then
383 node
.debug
"Unexpected type {mtype}"
387 if vis_type
!= null then
388 assert mmodule_type
!= null
389 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
390 if mproperty
.visibility
> vis_type
then
391 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
393 else if mproperty
.visibility
> vis_module_type
then
394 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
399 # No error, try to go deeper in generic types
400 if node
isa AType then
401 for a
in node
.n_types
do
403 if t
== null then continue # Error, thus skipped
404 check_visibility
(a
, t
, mpropdef
)
406 else if mtype
isa MGenericType then
407 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
411 # Detect circularity errors for virtual types.
412 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
415 # Slow case: progress on each resolution until we visit all without getting a loop
417 # The graph used to detect loops
418 var mtype
= mproperty
.mvirtualtype
419 var poset
= new POSet[MType]
421 # The work-list of types to resolve
422 var todo
= new List[MType]
425 while not todo
.is_empty
do
429 if not t
.need_anchor
then continue
431 # Get the types derived of `t` (subtypes and bounds)
433 if t
isa MNullableType then
435 else if t
isa MGenericType then
437 else if t
isa MVirtualType then
439 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
440 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
441 if defs
.is_empty
then return false
442 nexts
= new Array[MType]
444 var next
= defs
.first
.bound
445 if next
== null then return false
448 else if t
isa MClassType then
449 # Basic type, nothing to to
451 else if t
isa MParameterType then
452 # Parameter types cannot depend on virtual types, so nothing to do
460 if poset
.has_edge
(next
, t
) then
461 if mtype
== next
then
462 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
464 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
468 poset
.add_edge
(t
, next
)
478 # Does the MPropDef contains a call to super or a call of a super-constructor?
479 # Subsequent phases of the frontend (esp. typing) set it if required
480 var has_supercall
: Bool = false is writable
483 redef class AClassdef
484 # Marker used in `ModelBuilder::build_properties`
485 private var build_properties_is_done
= false
489 # The base init of the class.
491 # TODO: Where to put this information is not clear because unlike other
492 # informations, the initialisers are stable in a same class.
493 var root_init
: nullable MMethodDef = null
495 # The base init of the class.
497 # TODO: merge with `root_init` and `ModelBuilder::the_root_init_mmethod` if possible
498 var the_root_init_mmethod
: nullable MMethod = null
501 redef class MClassDef
502 # What is the `APropdef` associated to a `MProperty`?
503 # Used to check multiple definition of a property.
504 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
506 # Build the virtual type `SELF` only for introduction `MClassDef`
507 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
509 if not is_intro
then return
512 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
514 # If SELF type is declared nowherer?
515 if mprop
== null then return
517 # SELF is not a virtual type? it is weird but we ignore it
518 if not mprop
isa MVirtualTypeProp then return
520 # Is this the intro of SELF in the library?
521 var intro
= mprop
.intro
522 var intro_mclassdef
= intro
.mclassdef
523 if intro_mclassdef
== self then
524 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
526 # SELF must be declared in Object, otherwise this will create conflicts
527 if intro_mclassdef
.mclass
.name
!= "Object" then
528 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
531 # SELF must be public
532 if mprop
.visibility
!= public_visibility
then
533 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
536 # SELF must not be fixed
537 if intro
.is_fixed
then
538 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
544 # This class introduction inherits a SELF
545 # We insert an artificial property to update it
546 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
547 mpropdef
.bound
= mclass
.mclass_type
552 # The associated main model entity
553 type MPROPDEF: MPropDef
555 # The associated propdef once build by a `ModelBuilder`
556 var mpropdef
: nullable MPROPDEF is writable
558 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
559 private fun build_signature
(modelbuilder
: ModelBuilder) do end
560 private fun check_signature
(modelbuilder
: ModelBuilder) do end
561 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
563 var mvisibility
= public_visibility
564 if nvisibility
!= null then
565 mvisibility
= nvisibility
.mvisibility
566 if mvisibility
== intrude_visibility
then
567 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
568 mvisibility
= public_visibility
571 if mclassdef
.mclass
.visibility
== private_visibility
then
572 if mvisibility
== protected_visibility
then
573 assert nvisibility
!= null
574 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
575 else if mvisibility
== private_visibility
then
576 assert nvisibility
!= null
577 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
579 mvisibility
= private_visibility
584 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
586 var ndoc
= self.n_doc
588 var mdoc
= ndoc
.to_mdoc
590 mdoc
.original_mentity
= mpropdef
591 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
592 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
595 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
596 if at_deprecated
!= null then
597 if not mpropdef
.is_intro
then
598 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
600 var info
= new MDeprecationInfo
601 ndoc
= at_deprecated
.n_doc
602 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
603 mpropdef
.mproperty
.deprecation
= info
608 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
610 if nvisibility
== null then return
611 var mvisibility
= nvisibility
.mvisibility
612 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
613 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
617 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
619 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
620 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
623 if mprop
isa MMethod and mprop
.is_root_init
then return true
624 if kwredef
== null then
626 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
630 # Check for full-name conflicts in the package.
631 # A public property should have a unique qualified name `package::class::prop`.
632 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
633 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
634 if others
!= null then for other
in others
do
635 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
636 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}`.")
642 if not need_redef
then
643 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
650 # Checks for useless type in redef signatures.
651 private fun check_repeated_types
(modelbuilder
: ModelBuilder) do end
654 redef class ASignature
655 # Is the model builder has correctly visited the signature
656 var is_visited
= false
657 # Names of parameters from the AST
658 # REQUIRE: is_visited
659 var param_names
= new Array[String]
660 # Types of parameters from the AST
661 # REQUIRE: is_visited
662 var param_types
= new Array[MType]
663 # Rank of the vararg (of -1 if none)
664 # REQUIRE: is_visited
665 var vararg_rank
: Int = -1
667 var ret_type
: nullable MType = null
669 # Visit and fill information about a signature
670 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
672 var mmodule
= mclassdef
.mmodule
673 var param_names
= self.param_names
674 var param_types
= self.param_types
675 for np
in self.n_params
do
676 param_names
.add
(np
.n_id
.text
)
677 var ntype
= np
.n_type
678 if ntype
!= null then
679 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
680 if mtype
== null then return false # Skip error
681 for i
in [0..param_names
.length-param_types
.length
[ do
682 param_types
.add
(mtype
)
684 if np
.n_dotdotdot
!= null then
685 if self.vararg_rank
!= -1 then
686 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
689 self.vararg_rank
= param_names
.length
- 1
694 var ntype
= self.n_type
695 if ntype
!= null then
696 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
697 if self.ret_type
== null then return false # Skip error
700 self.is_visited
= true
704 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
707 for np
in self.n_params
do
708 var ntype
= np
.n_type
709 if ntype
!= null then
710 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
715 var ntype
= self.n_type
716 if ntype
!= null then
717 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
721 if not res
then is_broken
= true
727 # The associated mparameter if any
728 var mparameter
: nullable MParameter = null
731 redef class AMethPropdef
732 redef type MPROPDEF: MMethodDef
734 # Is the method annotated `autoinit`?
735 var is_autoinit
= false
737 # Can self be used as a root init?
738 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
740 # Need the `init` keyword
741 if n_kwinit
== null then return false
742 # Need to by anonymous
743 if self.n_methid
!= null then return false
744 # No annotation on itself
745 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
747 var amod
= self.parent
.parent
.as(AModule)
748 var amoddecl
= amod
.n_moduledecl
749 if amoddecl
!= null then
750 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
751 if old
!= null then return false
754 if self.n_signature
.n_params
.length
> 0 then
755 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
758 # Cannot be private or something
759 if not self.n_visibility
isa APublicVisibility then
760 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
767 redef fun build_property
(modelbuilder
, mclassdef
)
769 var n_kwinit
= n_kwinit
770 var n_kwnew
= n_kwnew
771 var is_init
= n_kwinit
!= null or n_kwnew
!= null
773 var amethodid
= self.n_methid
775 if amethodid
== null then
779 else if n_kwinit
!= null then
782 if self.n_signature
.n_params
.not_empty
or get_single_annotation
("old_style_init", modelbuilder
) != null then
785 else if n_kwnew
!= null then
791 else if amethodid
isa AIdMethid then
792 name
= amethodid
.n_id
.text
793 name_node
= amethodid
795 # operator, bracket or assign
796 name
= amethodid
.collect_text
797 name_node
= amethodid
799 var arity
= self.n_signature
.n_params
.length
800 if name
== "+" and arity
== 0 then
802 else if name
== "-" and arity
== 0 then
804 else if name
== "~" and arity
== 0 then
807 if amethodid
.is_binary
and arity
!= 1 then
808 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
809 else if amethodid
.min_arity
> arity
then
810 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
815 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
816 var mprop
: nullable MMethod = null
817 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
818 if mprop
== null and look_like_a_root_init
then
819 mprop
= modelbuilder
.the_root_init_mmethod
821 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
822 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
825 if mprop
== null then
826 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
827 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
828 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
829 modelbuilder
.the_root_init_mmethod
= mprop
830 mprop
.is_root_init
= true
832 mprop
.is_init
= is_init
833 mprop
.is_new
= n_kwnew
!= null
834 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
835 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
836 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
) then
837 mprop
.is_broken
= true
841 if mprop
.is_broken
then
844 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
845 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
848 # Check name conflicts in the local class for constructors.
850 for p
, n
in mclassdef
.mprop2npropdef
do
851 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
852 if not check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
) then
853 mprop
.is_broken
= true
861 mclassdef
.mprop2npropdef
[mprop
] = self
863 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
865 set_doc
(mpropdef
, modelbuilder
)
867 self.mpropdef
= mpropdef
868 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
869 if mpropdef
.is_intro
then
870 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
872 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
876 redef fun build_signature
(modelbuilder
)
878 var mpropdef
= self.mpropdef
879 if mpropdef
== null then return # Error thus skiped
880 var mclassdef
= mpropdef
.mclassdef
881 var mmodule
= mclassdef
.mmodule
882 var nsig
= self.n_signature
884 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
885 var root_init
= mclassdef
.mclass
.root_init
886 if root_init
!= null then
887 # Inherit the initializers by refinement
888 mpropdef
.new_msignature
= root_init
.new_msignature
889 assert mpropdef
.initializers
.is_empty
890 mpropdef
.initializers
.add_all root_init
.initializers
894 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
895 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
897 # Retrieve info from the signature AST
898 var param_names
= new Array[String] # Names of parameters from the AST
899 var param_types
= new Array[MType] # Types of parameters from the AST
901 var ret_type
: nullable MType = null # Return type from the AST
903 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
904 param_names
= nsig
.param_names
905 param_types
= nsig
.param_types
906 vararg_rank
= nsig
.vararg_rank
907 ret_type
= nsig
.ret_type
910 # Look for some signature to inherit
911 # FIXME: do not inherit from the intro, but from the most specific
912 var msignature
: nullable MSignature = null
913 if not mpropdef
.is_intro
then
914 msignature
= mpropdef
.mproperty
.intro
.msignature
915 if msignature
== null then return # Skip error
917 # The local signature is adapted to use the local formal types, if any.
918 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
920 # Check inherited signature arity
921 if param_names
.length
!= msignature
.arity
then
923 if nsig
!= null then node
= nsig
else node
= self
924 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}`.")
927 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
928 # FIXME UGLY: inherit signature from a super-constructor
929 for msupertype
in mclassdef
.supertypes
do
930 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
931 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
932 if candidate
!= null then
933 if msignature
== null then
934 msignature
= candidate
.intro
.as(MMethodDef).msignature
941 # Inherit the signature
942 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
943 # Parameters are untyped, thus inherit them
944 param_types
= new Array[MType]
945 for mparameter
in msignature
.mparameters
do
946 param_types
.add
(mparameter
.mtype
)
948 vararg_rank
= msignature
.vararg_rank
950 if msignature
!= null and ret_type
== null then
951 ret_type
= msignature
.return_mtype
954 if param_names
.length
!= param_types
.length
then
955 # Some parameters are typed, other parameters are not typed.
956 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
960 var mparameters
= new Array[MParameter]
961 for i
in [0..param_names
.length
[ do
962 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
)
963 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
964 mparameters
.add
(mparameter
)
967 # In `new`-factories, the return type is by default the classtype.
968 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
970 # Special checks for operator methods
971 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
972 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
974 if ret_type
== null and return_is_mandatory
then
975 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
978 msignature
= new MSignature(mparameters
, ret_type
)
979 mpropdef
.msignature
= msignature
980 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
981 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
982 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
985 var at
= self.get_single_annotation
("lazy", modelbuilder
)
986 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
988 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
989 if atautoinit
!= null then
990 if not mpropdef
.is_intro
then
991 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be set on redefinitions.")
992 else if not mclassdef
.is_intro
then
993 modelbuilder
.error
(atautoinit
, "Error: `autoinit` cannot be used in class refinements.")
995 self.is_autoinit
= true
1000 redef fun check_signature
(modelbuilder
)
1002 var mpropdef
= self.mpropdef
1003 if mpropdef
== null then return # Error thus skiped
1004 var mclassdef
= mpropdef
.mclassdef
1005 var mmodule
= mclassdef
.mmodule
1006 var nsig
= self.n_signature
1007 var mysignature
= mpropdef
.msignature
1008 if mysignature
== null then return # Error thus skiped
1011 if nsig
!= null then
1012 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1013 mpropdef
.msignature
= null # invalidate
1014 mpropdef
.is_broken
= true
1015 return # Forward error
1019 # Lookup for signature in the precursor
1020 # FIXME all precursors should be considered
1021 if not mpropdef
.is_intro
then
1022 var msignature
= mpropdef
.mproperty
.intro
.msignature
1023 if msignature
== null then return
1025 var precursor_ret_type
= msignature
.return_mtype
1026 var ret_type
= mysignature
.return_mtype
1027 if ret_type
!= null and precursor_ret_type
== null then
1028 modelbuilder
.error
(nsig
.n_type
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1029 mpropdef
.msignature
= null
1030 mpropdef
.is_broken
= true
1034 if mysignature
.arity
> 0 then
1035 # Check parameters types
1036 for i
in [0..mysignature
.arity
[ do
1037 var myt
= mysignature
.mparameters
[i
].mtype
1038 var prt
= msignature
.mparameters
[i
].mtype
1039 var node
= nsig
.n_params
[i
]
1040 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1041 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1042 mpropdef
.msignature
= null
1043 mpropdef
.is_broken
= true
1047 if precursor_ret_type
!= null then
1048 var node
: nullable ANode = null
1049 if nsig
!= null then node
= nsig
.n_type
1050 if node
== null then node
= self
1051 if ret_type
== null then
1052 # Inherit the return type
1053 ret_type
= precursor_ret_type
1054 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1055 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1056 mpropdef
.msignature
= null
1057 mpropdef
.is_broken
= true
1062 if nsig
!= null then
1063 # Check parameters visibility
1064 for i
in [0..mysignature
.arity
[ do
1065 var nt
= nsig
.n_params
[i
].n_type
1066 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1068 var nt
= nsig
.n_type
1069 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1071 check_repeated_types
(modelbuilder
)
1074 # For parameters, type is always useless in a redef.
1075 # For return type, type is useless if not covariant with introduction.
1076 redef fun check_repeated_types
(modelbuilder
) do
1077 var mpropdef
= self.mpropdef
1078 if mpropdef
== null then return
1079 if mpropdef
.is_intro
or n_signature
== null then return
1081 for param
in n_signature
.n_params
do
1082 if param
.n_type
!= null then
1083 modelbuilder
.advice
(param
.n_type
, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1087 var intro
= mpropdef
.mproperty
.intro
1088 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1089 if n_intro
== null or not n_intro
isa AMethPropdef then return
1091 var ret_type
= n_signature
.ret_type
1092 if ret_type
!= null and ret_type
== n_intro
.n_signature
.ret_type
then
1093 modelbuilder
.advice
(n_signature
.n_type
, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1099 # Is a return required?
1101 # * True for operators and brackets.
1102 # * False for id and assignment.
1103 fun return_is_mandatory
: Bool do return true
1105 # Can the last parameter be special like a vararg?
1107 # * False for operators: the last one is in fact the only one.
1108 # * False for assignments: it is the right part of the assignment.
1109 # * True for ids and brackets.
1110 fun accept_special_last_parameter
: Bool do return false
1112 # The minimum required number of parameters.
1114 # * 1 for binary operators
1116 # * 1 for assignments
1117 # * 2 for bracket assignments
1119 fun min_arity
: Int do return 1
1121 # Is the `self` a binary operator?
1122 fun is_binary
: Bool do return true
1125 redef class AIdMethid
1126 redef fun return_is_mandatory
do return false
1127 redef fun accept_special_last_parameter
do return true
1128 redef fun min_arity
do return 0
1129 redef fun is_binary
do return false
1132 redef class ABraMethid
1133 redef fun accept_special_last_parameter
do return true
1134 redef fun is_binary
do return false
1137 redef class ABraassignMethid
1138 redef fun return_is_mandatory
do return false
1139 redef fun min_arity
do return 2
1140 redef fun is_binary
do return false
1143 redef class AAssignMethid
1144 redef fun return_is_mandatory
do return false
1145 redef fun is_binary
do return false
1148 redef class AAttrPropdef
1149 redef type MPROPDEF: MAttributeDef
1151 # The static type of the property (declared, inferred or inherited)
1152 # This attribute is also used to check if the property was analyzed and is valid.
1153 var mtype
: nullable MType
1155 # Is the node tagged `noinit`?
1158 # Is the node tagged lazy?
1161 # Has the node a default value?
1162 # Could be through `n_expr` or `n_block`
1163 var has_value
= false
1165 # The guard associated to a lazy attribute.
1166 # Because some engines does not have a working `isset`,
1167 # this additional attribute is used to guard the lazy initialization.
1168 # TODO: to remove once isset is correctly implemented
1169 var mlazypropdef
: nullable MAttributeDef
1171 # The associated getter (read accessor) if any
1172 var mreadpropdef
: nullable MMethodDef is writable
1173 # The associated setter (write accessor) if any
1174 var mwritepropdef
: nullable MMethodDef is writable
1176 redef fun build_property
(modelbuilder
, mclassdef
)
1178 var mclass
= mclassdef
.mclass
1180 var name
= nid2
.text
1182 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1183 if atabstract
== null then
1184 if not mclass
.kind
.need_init
then
1185 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1188 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1189 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1190 self.mpropdef
= mpropdef
1191 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1195 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1196 if mreadprop
== null then
1197 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1198 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1199 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1201 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1202 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1204 mclassdef
.mprop2npropdef
[mreadprop
] = self
1206 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1207 self.mreadpropdef
= mreadpropdef
1208 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1209 set_doc
(mreadpropdef
, modelbuilder
)
1210 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1211 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1213 has_value
= n_expr
!= null or n_block
!= null
1215 if atabstract
!= null and has_value
then
1216 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1220 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1221 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1222 if atnoinit
!= null then
1225 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1228 if atabstract
!= null then
1229 modelbuilder
.warning
(atnoinit
, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1233 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1234 var atlateinit
= self.get_single_annotation
("lateinit", modelbuilder
)
1235 if atlazy
!= null or atlateinit
!= null then
1236 if atlazy
!= null and atlateinit
!= null then
1237 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `lateinit`.")
1240 if not has_value
then
1241 if atlazy
!= null then
1242 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1243 else if atlateinit
!= null then
1244 modelbuilder
.error
(atlateinit
, "Error: `lateinit` attributes need a value.")
1250 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1251 mlazyprop
.is_fictive
= true
1252 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1253 mlazypropdef
.is_fictive
= true
1254 self.mlazypropdef
= mlazypropdef
1257 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1258 if atreadonly
!= null then
1259 if not has_value
then
1260 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1262 # No setter, so just leave
1266 if not mclassdef
.is_intro
and not has_value
and not noinit
then
1267 modelbuilder
.advice
(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1270 var writename
= name
+ "="
1271 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1272 if atwritable
!= null then
1273 if not atwritable
.n_args
.is_empty
then
1274 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1277 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1278 var nwkwredef
: nullable Token = null
1279 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1280 if mwriteprop
== null then
1282 if atwritable
!= null then
1283 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1285 mvisibility
= mreadprop
.visibility
1286 # By default, use protected visibility at most
1287 if mvisibility
> protected_visibility
then mvisibility
= protected_visibility
1289 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1290 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1291 mwriteprop
.deprecation
= mreadprop
.deprecation
1293 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1294 if atwritable
!= null then
1295 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1298 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1300 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1301 self.mwritepropdef
= mwritepropdef
1302 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1303 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1304 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1306 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1307 if atautoinit
!= null then
1309 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot have an initial value.")
1310 else if not mwritepropdef
.is_intro
then
1311 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be set on redefinitions.")
1312 else if not mclassdef
.is_intro
then
1313 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes cannot be used in class refinements.")
1314 else if atabstract
== null then
1315 modelbuilder
.warning
(atautoinit
, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1317 else if atabstract
!= null then
1318 # By default, abstract attribute are not autoinit
1323 redef fun build_signature
(modelbuilder
)
1325 var mreadpropdef
= self.mreadpropdef
1326 var mpropdef
= self.mpropdef
1327 if mreadpropdef
== null then return # Error thus skipped
1328 var mclassdef
= mreadpropdef
.mclassdef
1329 var mmodule
= mclassdef
.mmodule
1330 var mtype
: nullable MType = null
1333 var ntype
= self.n_type
1334 if ntype
!= null then
1335 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1336 if mtype
== null then return
1339 var inherited_type
: nullable MType = null
1340 # Inherit the type from the getter (usually an abstract getter)
1341 if not mreadpropdef
.is_intro
then
1342 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1343 if msignature
== null then return # Error, thus skipped
1344 inherited_type
= msignature
.return_mtype
1345 if inherited_type
!= null then
1346 # The inherited type is adapted to use the local formal types, if any.
1347 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1348 if mtype
== null then mtype
= inherited_type
1352 var nexpr
= self.n_expr
1353 if mtype
== null then
1354 if nexpr
!= null then
1355 if nexpr
isa ANewExpr then
1356 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1357 else if nexpr
isa AAsCastExpr then
1358 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1359 else if nexpr
isa AIntegerExpr then
1360 var cla
: nullable MClass = null
1361 if nexpr
.value
isa Int then
1362 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1363 else if nexpr
.value
isa Byte then
1364 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Byte")
1365 else if nexpr
.value
isa Int8 then
1366 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int8")
1367 else if nexpr
.value
isa Int16 then
1368 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int16")
1369 else if nexpr
.value
isa UInt16 then
1370 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt16")
1371 else if nexpr
.value
isa Int32 then
1372 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int32")
1373 else if nexpr
.value
isa UInt32 then
1374 cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "UInt32")
1376 # Should not happen, and should be updated as new types are added
1379 if cla
!= null then mtype
= cla
.mclass_type
1380 else if nexpr
isa AFloatExpr then
1381 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1382 if cla
!= null then mtype
= cla
.mclass_type
1383 else if nexpr
isa ACharExpr then
1384 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1385 if cla
!= null then mtype
= cla
.mclass_type
1386 else if nexpr
isa ABoolExpr then
1387 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1388 if cla
!= null then mtype
= cla
.mclass_type
1389 else if nexpr
isa ASuperstringExpr then
1390 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1391 if cla
!= null then mtype
= cla
.mclass_type
1392 else if nexpr
isa AStringFormExpr then
1393 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1394 if cla
!= null then mtype
= cla
.mclass_type
1396 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1399 if mtype
== null then return
1401 else if ntype
!= null and inherited_type
== mtype
then
1402 if nexpr
isa ANewExpr then
1403 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1404 if xmtype
== mtype
then
1405 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1410 if mtype
== null then
1411 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1417 if mpropdef
!= null then
1418 mpropdef
.static_mtype
= mtype
1422 var msignature
= new MSignature(new Array[MParameter], mtype
)
1423 mreadpropdef
.msignature
= msignature
1426 var mwritepropdef
= self.mwritepropdef
1427 if mwritepropdef
!= null then
1430 var mparameter
= new MParameter(name
, mtype
, false)
1431 var msignature
= new MSignature([mparameter
], null)
1432 mwritepropdef
.msignature
= msignature
1435 var mlazypropdef
= self.mlazypropdef
1436 if mlazypropdef
!= null then
1437 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1439 check_repeated_types
(modelbuilder
)
1442 redef fun check_signature
(modelbuilder
)
1444 var mpropdef
= self.mpropdef
1445 if mpropdef
== null then return # Error thus skipped
1446 var ntype
= self.n_type
1447 var mtype
= self.mtype
1448 if mtype
== null then return # Error thus skipped
1450 var mclassdef
= mpropdef
.mclassdef
1451 var mmodule
= mclassdef
.mmodule
1454 if ntype
!= null then
1455 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1458 if nexpr
isa ANewExpr then
1459 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1462 # Lookup for signature in the precursor
1463 # FIXME all precursors should be considered
1464 if not mpropdef
.is_intro
then
1465 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1466 if precursor_type
== null then return
1468 if mtype
!= precursor_type
then
1469 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1474 # Check getter and setter
1475 var meth
= self.mreadpropdef
1476 if meth
!= null then
1477 self.check_method_signature
(modelbuilder
, meth
)
1478 var node
: nullable ANode = ntype
1479 if node
== null then node
= self
1480 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1482 meth
= self.mwritepropdef
1483 if meth
!= null then
1484 self.check_method_signature
(modelbuilder
, meth
)
1485 var node
: nullable ANode = ntype
1486 if node
== null then node
= self
1487 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1491 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1493 var mclassdef
= mpropdef
.mclassdef
1494 var mmodule
= mclassdef
.mmodule
1495 var nsig
= self.n_type
1496 var mysignature
= mpropdef
.msignature
1497 if mysignature
== null then return # Error thus skiped
1499 # Lookup for signature in the precursor
1500 # FIXME all precursors should be considered
1501 if not mpropdef
.is_intro
then
1502 var msignature
= mpropdef
.mproperty
.intro
.msignature
1503 if msignature
== null then return
1505 if mysignature
.arity
!= msignature
.arity
then
1507 if nsig
!= null then node
= nsig
else node
= self
1508 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}`.")
1511 var precursor_ret_type
= msignature
.return_mtype
1512 var ret_type
= mysignature
.return_mtype
1513 if ret_type
!= null and precursor_ret_type
== null then
1515 if nsig
!= null then node
= nsig
else node
= self
1516 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1520 if mysignature
.arity
> 0 then
1521 # Check parameters types
1522 for i
in [0..mysignature
.arity
[ do
1523 var myt
= mysignature
.mparameters
[i
].mtype
1524 var prt
= msignature
.mparameters
[i
].mtype
1526 if nsig
!= null then node
= nsig
else node
= self
1527 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1528 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1532 if precursor_ret_type
!= null then
1534 if nsig
!= null then node
= nsig
else node
= self
1535 if ret_type
== null then
1536 # Inherit the return type
1537 ret_type
= precursor_ret_type
1538 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1539 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1545 # Type is useless if the attribute type is the same thant the intro.
1546 redef fun check_repeated_types
(modelbuilder
) do
1547 var mreadpropdef
= self.mreadpropdef
1548 if mreadpropdef
== null then return
1549 if mreadpropdef
.is_intro
or n_type
== null then return
1551 var intro
= mreadpropdef
.mproperty
.intro
1552 var n_intro
= modelbuilder
.mpropdef2npropdef
.get_or_null
(intro
)
1553 if n_intro
== null then return
1556 if n_intro
isa AMethPropdef then
1557 ntype
= n_intro
.n_signature
.ret_type
1558 else if n_intro
isa AAttrPropdef and n_intro
.n_type
!= null then
1559 ntype
= n_intro
.n_type
.mtype
1562 if ntype
== null or ntype
!= n_type
.mtype
or mpropdef
== null then return
1563 modelbuilder
.advice
(n_type
, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1567 redef class ATypePropdef
1568 redef type MPROPDEF: MVirtualTypeDef
1570 redef fun build_property
(modelbuilder
, mclassdef
)
1572 var name
= self.n_qid
.n_id
.text
1573 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_qid
, mclassdef
, name
)
1574 if mprop
== null then
1575 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1576 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1577 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1578 modelbuilder
.warning
(n_qid
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1582 assert mprop
isa MVirtualTypeProp
1583 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1586 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1587 self.mpropdef
= mpropdef
1588 if mpropdef
.is_intro
then
1589 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1591 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1593 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, not mpropdef
.is_intro
, mprop
) then
1594 mpropdef
.is_broken
=true
1596 mclassdef
.mprop2npropdef
[mprop
] = self
1597 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1598 set_doc
(mpropdef
, modelbuilder
)
1600 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1601 if atfixed
!= null then
1602 mpropdef
.is_fixed
= true
1606 redef fun build_signature
(modelbuilder
)
1608 var mpropdef
= self.mpropdef
1609 if mpropdef
== null then return # Error thus skipped
1610 var mclassdef
= mpropdef
.mclassdef
1611 var mmodule
= mclassdef
.mmodule
1612 var mtype
: nullable MType = null
1614 var ntype
= self.n_type
1615 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1616 if mtype
== null then return
1618 mpropdef
.bound
= mtype
1619 # print "{mpropdef}: {mtype}"
1622 redef fun check_signature
(modelbuilder
)
1624 var mpropdef
= self.mpropdef
1625 if mpropdef
== null then return # Error thus skipped
1627 var bound
= mpropdef
.bound
1628 if bound
== null then return # Error thus skipped
1630 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1632 var mclassdef
= mpropdef
.mclassdef
1633 var mmodule
= mclassdef
.mmodule
1634 var anchor
= mclassdef
.bound_mtype
1636 var ntype
= self.n_type
1637 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1638 mpropdef
.bound
= null
1642 # Check redefinitions
1643 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1644 var supbound
= p
.bound
1645 if supbound
== null or supbound
isa MBottomType or p
.is_broken
then break # broken super bound, skip error
1647 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1650 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1651 # Still a warning to pass existing bad code
1652 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1655 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1656 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")