1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
20 intrude import modelize_class
21 private import annotation
23 redef class ToolContext
24 # Run `AClassdef::build_property` on the classdefs of each module
25 var modelize_property_phase
: Phase = new ModelizePropertyPhase(self, [modelize_class_phase
])
28 private class ModelizePropertyPhase
30 redef fun process_nmodule
(nmodule
)
32 for nclassdef
in nmodule
.n_classdefs
do
33 if nclassdef
.all_defs
== null then continue # skip non principal classdef
34 toolcontext
.modelbuilder
.build_properties
(nclassdef
)
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef
= new HashMap[MPropDef, APropdef]
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node
(mpropdef
: MPropDef): nullable ANode
52 res
= mpropdef2npropdef
.get_or_null
(mpropdef
)
54 # Run the phases on it
55 toolcontext
.run_phases_on_npropdef
(res
)
58 if mpropdef
isa MMethodDef and mpropdef
.mproperty
.is_root_init
then
59 res
= mclassdef2nclassdef
.get_or_null
(mpropdef
.mclassdef
)
60 if res
!= null then return res
65 # Retrieve all the attributes nodes localy definied
66 # FIXME think more about this method and how the separations separate/global and ast/model should be done.
67 fun collect_attr_propdef
(mclassdef
: MClassDef): Array[AAttrPropdef]
69 var res
= new Array[AAttrPropdef]
70 var n
= mclassdef2nclassdef
.get_or_null
(mclassdef
)
71 if n
== null then return res
72 for npropdef
in n
.n_propdefs
do
73 if npropdef
isa AAttrPropdef then
74 # Run the phases on it
75 toolcontext
.run_phases_on_npropdef
(npropdef
)
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties
(nclassdef
: AClassdef)
86 # Force building recursively
87 if nclassdef
.build_properties_is_done
then return
88 nclassdef
.build_properties_is_done
= true
89 var mclassdef
= nclassdef
.mclassdef
90 if mclassdef
== null then return # skip error
91 if mclassdef
.in_hierarchy
== null then return # Skip error
92 for superclassdef
in mclassdef
.in_hierarchy
.direct_greaters
do
93 if not mclassdef2nclassdef
.has_key
(superclassdef
) then continue
94 build_properties
(mclassdef2nclassdef
[superclassdef
])
97 mclassdef
.build_self_type
(self, nclassdef
)
98 for nclassdef2
in nclassdef
.all_defs
do
99 for npropdef
in nclassdef2
.n_propdefs
do
100 npropdef
.build_property
(self, mclassdef
)
102 for npropdef
in nclassdef2
.n_propdefs
do
103 npropdef
.build_signature
(self)
105 for npropdef
in nclassdef2
.n_propdefs
do
106 if not npropdef
isa ATypePropdef then continue
108 var mpropdef
= npropdef
.mpropdef
109 if mpropdef
== null then continue
110 if mpropdef
.bound
== null then continue
111 if not check_virtual_types_circularity
(npropdef
, mpropdef
.mproperty
, mclassdef
.bound_mtype
, mclassdef
.mmodule
) then
112 # Invalidate the bound
113 mpropdef
.bound
= mclassdef
.mmodule
.model
.null_type
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 nclassdef
.mfree_init
= mpropdef
156 self.toolcontext
.info
("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
157 the_root_init_mmethod
= mprop
161 # Is the class forbid constructors?
162 if not mclassdef
.mclass
.kind
.need_init
then return
164 # Is there already a constructor defined?
165 var defined_init
: nullable MMethodDef = null
166 for mpropdef
in mclassdef
.mpropdefs
do
167 if not mpropdef
isa MMethodDef then continue
168 if not mpropdef
.mproperty
.is_init
then continue
169 if mpropdef
.mproperty
.is_root_init
then
170 assert defined_init
== null
171 defined_init
= mpropdef
172 else if mpropdef
.mproperty
.name
== "init" then
173 # An explicit old-style init named "init", so return
178 if not nclassdef
isa AStdClassdef then return
180 # Collect undefined attributes
181 var mparameters
= new Array[MParameter]
182 var initializers
= new Array[MProperty]
183 for npropdef
in nclassdef
.n_propdefs
do
184 if npropdef
isa AMethPropdef then
185 if npropdef
.mpropdef
== null then return # Skip broken method
186 var at
= npropdef
.get_single_annotation
("autoinit", self)
187 if at
== null then continue # Skip non tagged init
189 var sig
= npropdef
.mpropdef
.msignature
190 if sig
== null then continue # Skip broken method
192 if not npropdef
.mpropdef
.is_intro
then
193 self.error
(at
, "Error: `autoinit` cannot be set on redefinitions.")
197 for param
in sig
.mparameters
do
198 var ret_type
= param
.mtype
199 var mparameter
= new MParameter(param
.name
, ret_type
, false, ret_type
isa MNullableType)
200 mparameters
.add
(mparameter
)
202 initializers
.add
(npropdef
.mpropdef
.mproperty
)
203 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
205 if npropdef
isa AAttrPropdef then
206 var mreadpropdef
= npropdef
.mreadpropdef
207 if mreadpropdef
== null or mreadpropdef
.msignature
== null then return # Skip broken attribute
208 if npropdef
.noinit
then continue # Skip noinit attribute
209 var atautoinit
= npropdef
.get_single_annotation
("autoinit", self)
210 if atautoinit
!= null then
211 # For autoinit attributes, call the reader to force
212 # the lazy initialization of the attribute.
213 initializers
.add
(mreadpropdef
.mproperty
)
214 mreadpropdef
.mproperty
.is_autoinit
= true
217 if npropdef
.has_value
then continue
218 var paramname
= mreadpropdef
.mproperty
.name
219 var ret_type
= mreadpropdef
.msignature
.return_mtype
220 if ret_type
== null then return
221 var mparameter
= new MParameter(paramname
, ret_type
, false, ret_type
isa MNullableType)
222 mparameters
.add
(mparameter
)
223 var msetter
= npropdef
.mwritepropdef
224 if msetter
== null then
225 # No setter, it is a readonly attribute, so just add it
226 initializers
.add
(npropdef
.mpropdef
.mproperty
)
227 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
229 # Add the setter to the list
230 initializers
.add
(msetter
.mproperty
)
231 msetter
.mproperty
.is_autoinit
= true
236 if the_root_init_mmethod
== null then return
238 # Look for most-specific new-stype init definitions
239 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
240 if spropdefs
.is_empty
then
241 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
245 # Look at the autoinit class-annotation
246 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
247 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
248 if autoinit
!= null then
249 # Just throws the collected initializers
253 if noautoinit
!= null then
254 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
257 if autoinit
.n_args
.is_empty
then
258 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
261 # Get and check each argument
262 for narg
in autoinit
.n_args
do
265 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
269 # Search the property.
270 # To avoid bad surprises, try to get the setter first.
271 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
273 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
276 error
(narg
, "Error: unknown method `{id}`")
279 if not p
.is_autoinit
then
280 error
(narg
, "Error: `{p}` is not an autoinit method")
284 # Register the initializer and the parameters
287 if pd
isa MMethodDef then
288 # Get the signature resolved for the current receiver
289 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
290 # Because the last parameter of setters is never default, try to default them for the autoinit.
291 for param
in sig
.mparameters
do
292 if not param
.is_default
and param
.mtype
isa MNullableType then
293 param
= new MParameter(param
.name
, param
.mtype
, param
.is_vararg
, true)
295 mparameters
.add
(param
)
302 else if noautoinit
!= null then
303 if initializers
.is_empty
then
304 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
306 # Just clear initializers
310 # Search the longest-one and checks for conflict
311 var longest
= spropdefs
.first
312 if spropdefs
.length
> 1 then
313 # Check for conflict in the order of initializers
314 # Each initializer list must me a prefix of the longest list
315 # part 1. find the longest list
316 for spd
in spropdefs
do
317 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
320 for spd
in spropdefs
do
322 for p
in spd
.initializers
do
323 if p
!= longest
.initializers
[i
] then
324 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
325 # TODO: invalidate the initializer to avoid more errors
333 # Can we just inherit?
334 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
335 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
336 mclassdef
.mclass
.root_init
= longest
340 # Combine the inherited list to what is collected
341 if longest
.initializers
.length
> 0 then
342 mparameters
.prepend longest
.new_msignature
.mparameters
343 initializers
.prepend longest
.initializers
347 # If we already have a basic init definition, then setup its initializers
348 if defined_init
!= null then
349 defined_init
.initializers
.add_all
(initializers
)
350 var msignature
= new MSignature(mparameters
, null)
351 defined_init
.new_msignature
= msignature
352 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
353 mclassdef
.mclass
.root_init
= defined_init
357 # Else create the local implicit basic init definition
358 var mprop
= the_root_init_mmethod
.as(not null)
359 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
360 mpropdef
.has_supercall
= true
361 mpropdef
.initializers
.add_all
(initializers
)
362 var msignature
= new MSignature(mparameters
, null)
363 mpropdef
.new_msignature
= msignature
364 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
365 nclassdef
.mfree_init
= mpropdef
366 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
367 mclassdef
.mclass
.root_init
= mpropdef
370 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
371 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
373 var mmodule
= mpropdef
.mclassdef
.mmodule
374 var mproperty
= mpropdef
.mproperty
376 # Extract visibility information of the main part of `mtype`
377 # It is a case-by case
378 var vis_type
: nullable MVisibility = null # The own visibility of the type
379 var mmodule_type
: nullable MModule = null # The original module of the type
380 mtype
= mtype
.undecorate
381 if mtype
isa MClassType then
382 vis_type
= mtype
.mclass
.visibility
383 mmodule_type
= mtype
.mclass
.intro
.mmodule
384 else if mtype
isa MVirtualType then
385 vis_type
= mtype
.mproperty
.visibility
386 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
387 else if mtype
isa MParameterType then
388 # nothing, always visible
389 else if mtype
isa MNullType then
392 node
.debug
"Unexpected type {mtype}"
396 if vis_type
!= null then
397 assert mmodule_type
!= null
398 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
399 if mproperty
.visibility
> vis_type
then
400 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
402 else if mproperty
.visibility
> vis_module_type
then
403 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
408 # No error, try to go deeper in generic types
409 if node
isa AType then
410 for a
in node
.n_types
do
412 if t
== null then continue # Error, thus skipped
413 check_visibility
(a
, t
, mpropdef
)
415 else if mtype
isa MGenericType then
416 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
420 # Detect circularity errors for virtual types.
421 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
424 # Slow case: progress on each resolution until we visit all without getting a loop
426 # The graph used to detect loops
427 var mtype
= mproperty
.mvirtualtype
428 var poset
= new POSet[MType]
430 # The work-list of types to resolve
431 var todo
= new List[MType]
434 while not todo
.is_empty
do
438 if not t
.need_anchor
then continue
440 # Get the types derived of `t` (subtypes and bounds)
442 if t
isa MNullableType then
444 else if t
isa MGenericType then
446 else if t
isa MVirtualType then
448 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
449 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
450 # TODO something to manage correctly bound conflicts
451 assert not defs
.is_empty
452 nexts
= new Array[MType]
454 var next
= defs
.first
.bound
455 if next
== null then return false
458 else if t
isa MClassType then
459 # Basic type, nothing to to
461 else if t
isa MParameterType then
462 # Parameter types cannot depend on virtual types, so nothing to do
470 if poset
.has_edge
(next
, t
) then
471 if mtype
== next
then
472 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
474 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
478 poset
.add_edge
(t
, next
)
488 # Does the MPropDef contains a call to super or a call of a super-constructor?
489 # Subsequent phases of the frontend (esp. typing) set it if required
490 var has_supercall
: Bool = false is writable
493 redef class AClassdef
494 # Marker used in `ModelBuilder::build_properties`
495 private var build_properties_is_done
= false
497 # The free init (implicitely constructed by the class if required)
498 var mfree_init
: nullable MMethodDef = null
502 # The base init of the class.
503 # Used to get the common new_msignature and initializers
505 # TODO: Where to put this information is not clear because unlike other
506 # informations, the initialisers are stable in a same class.
507 var root_init
: nullable MMethodDef = null
510 redef class MClassDef
511 # What is the `APropdef` associated to a `MProperty`?
512 # Used to check multiple definition of a property.
513 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
515 # Build the virtual type `SELF` only for introduction `MClassDef`
516 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
518 if not is_intro
then return
521 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
523 # If SELF type is declared nowherer?
524 if mprop
== null then return
526 # SELF is not a virtual type? it is weird but we ignore it
527 if not mprop
isa MVirtualTypeProp then return
529 # Is this the intro of SELF in the library?
530 var intro
= mprop
.intro
531 var intro_mclassdef
= intro
.mclassdef
532 if intro_mclassdef
== self then
533 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
535 # SELF must be declared in Object, otherwise this will create conflicts
536 if intro_mclassdef
.mclass
.name
!= "Object" then
537 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
540 # SELF must be public
541 if mprop
.visibility
!= public_visibility
then
542 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
545 # SELF must not be fixed
546 if intro
.is_fixed
then
547 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
553 # This class introduction inherits a SELF
554 # We insert an artificial property to update it
555 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
556 mpropdef
.bound
= mclass
.mclass_type
561 # The associated main model entity
562 type MPROPDEF: MPropDef
564 # The associated propdef once build by a `ModelBuilder`
565 var mpropdef
: nullable MPROPDEF is writable
567 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
568 private fun build_signature
(modelbuilder
: ModelBuilder) do end
569 private fun check_signature
(modelbuilder
: ModelBuilder) do end
570 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
572 var mvisibility
= public_visibility
573 if nvisibility
!= null then
574 mvisibility
= nvisibility
.mvisibility
575 if mvisibility
== intrude_visibility
then
576 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
577 mvisibility
= public_visibility
580 if mclassdef
.mclass
.visibility
== private_visibility
then
581 if mvisibility
== protected_visibility
then
582 assert nvisibility
!= null
583 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
584 else if mvisibility
== private_visibility
then
585 assert nvisibility
!= null
586 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
588 mvisibility
= private_visibility
593 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
595 var ndoc
= self.n_doc
597 var mdoc
= ndoc
.to_mdoc
599 mdoc
.original_mentity
= mpropdef
600 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
601 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
604 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
605 if at_deprecated
!= null then
606 if not mpropdef
.is_intro
then
607 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
609 var info
= new MDeprecationInfo
610 ndoc
= at_deprecated
.n_doc
611 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
612 mpropdef
.mproperty
.deprecation
= info
617 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
619 if nvisibility
== null then return
620 var mvisibility
= nvisibility
.mvisibility
621 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
622 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
626 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
628 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
629 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
632 if mprop
isa MMethod and mprop
.is_root_init
then return true
633 if kwredef
== null then
635 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
639 # Check for full-name conflicts in the project.
640 # A public property should have a unique qualified name `project::class::prop`.
641 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
642 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
643 if others
!= null then for other
in others
do
644 if other
!= mprop
and other
.intro_mclassdef
.mmodule
.mgroup
!= null and other
.intro_mclassdef
.mmodule
.mgroup
.mproject
== mprop
.intro_mclassdef
.mmodule
.mgroup
.mproject
and other
.intro_mclassdef
.mclass
.name
== mprop
.intro_mclassdef
.mclass
.name
and other
.visibility
>= protected_visibility
then
645 modelbuilder
.advice
(self, "full-name-conflict", "Warning: A property named `{other.full_name}` is already defined in module `{other.intro_mclassdef.mmodule}` for the class `{other.intro_mclassdef.mclass.name}`.")
651 if not need_redef
then
652 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
661 redef class ASignature
662 # Is the model builder has correctly visited the signature
663 var is_visited
= false
664 # Names of parameters from the AST
665 # REQUIRE: is_visited
666 var param_names
= new Array[String]
667 # Types of parameters from the AST
668 # REQUIRE: is_visited
669 var param_types
= new Array[MType]
670 # Rank of the vararg (of -1 if none)
671 # REQUIRE: is_visited
672 var vararg_rank
: Int = -1
674 var ret_type
: nullable MType = null
676 # Visit and fill information about a signature
677 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
679 var mmodule
= mclassdef
.mmodule
680 var param_names
= self.param_names
681 var param_types
= self.param_types
682 for np
in self.n_params
do
683 param_names
.add
(np
.n_id
.text
)
684 var ntype
= np
.n_type
685 if ntype
!= null then
686 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
687 if mtype
== null then return false # Skip error
688 for i
in [0..param_names
.length-param_types
.length
[ do
689 param_types
.add
(mtype
)
691 if np
.n_dotdotdot
!= null then
692 if self.vararg_rank
!= -1 then
693 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
696 self.vararg_rank
= param_names
.length
- 1
701 var ntype
= self.n_type
702 if ntype
!= null then
703 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
704 if self.ret_type
== null then return false # Skip error
707 self.is_visited
= true
711 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
714 for np
in self.n_params
do
715 var ntype
= np
.n_type
716 if ntype
!= null then
717 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
722 var ntype
= self.n_type
723 if ntype
!= null then
724 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
733 # The associated mparameter if any
734 var mparameter
: nullable MParameter = null
737 redef class AMethPropdef
738 redef type MPROPDEF: MMethodDef
741 # Can self be used as a root init?
742 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
744 # Need the `init` keyword
745 if n_kwinit
== null then return false
746 # Need to by anonymous
747 if self.n_methid
!= null then return false
748 # No annotation on itself
749 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
751 var amod
= self.parent
.parent
.as(AModule)
752 var amoddecl
= amod
.n_moduledecl
753 if amoddecl
!= null then
754 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
755 if old
!= null then return false
758 if self.n_signature
.n_params
.length
> 0 then
759 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
762 # Cannot be private or something
763 if not self.n_visibility
isa APublicVisibility then
764 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
771 redef fun build_property
(modelbuilder
, mclassdef
)
773 var n_kwinit
= n_kwinit
774 var n_kwnew
= n_kwnew
775 var is_init
= n_kwinit
!= null or n_kwnew
!= null
777 var amethodid
= self.n_methid
779 if amethodid
== null then
783 else if n_kwinit
!= null then
786 else if n_kwnew
!= null then
792 else if amethodid
isa AIdMethid then
793 name
= amethodid
.n_id
.text
794 name_node
= amethodid
796 # operator, bracket or assign
797 name
= amethodid
.collect_text
798 name_node
= amethodid
800 var arity
= self.n_signature
.n_params
.length
801 if name
== "+" and arity
== 0 then
803 else if name
== "-" and arity
== 0 then
805 else if name
== "~" and arity
== 0 then
808 if amethodid
.is_binary
and arity
!= 1 then
809 modelbuilder
.error
(self.n_signature
, "Syntax Error: binary operator `{name}` requires exactly one parameter; got {arity}.")
810 else if amethodid
.min_arity
> arity
then
811 modelbuilder
.error
(self.n_signature
, "Syntax Error: `{name}` requires at least {amethodid.min_arity} parameter(s); got {arity}.")
816 var look_like_a_root_init
= look_like_a_root_init
(modelbuilder
, mclassdef
)
817 var mprop
: nullable MMethod = null
818 if not is_init
or n_kwredef
!= null then mprop
= modelbuilder
.try_get_mproperty_by_name
(name_node
, mclassdef
, name
).as(nullable MMethod)
819 if mprop
== null and look_like_a_root_init
then
820 mprop
= modelbuilder
.the_root_init_mmethod
822 if nb
isa ABlockExpr and nb
.n_expr
.is_empty
and n_doc
== null then
823 modelbuilder
.advice
(self, "useless-init", "Warning: useless empty init in {mclassdef}")
826 if mprop
== null then
827 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
828 mprop
= new MMethod(mclassdef
, name
, mvisibility
)
829 if look_like_a_root_init
and modelbuilder
.the_root_init_mmethod
== null then
830 modelbuilder
.the_root_init_mmethod
= mprop
831 mprop
.is_root_init
= true
833 mprop
.is_init
= is_init
834 mprop
.is_new
= n_kwnew
!= null
835 if mprop
.is_new
then mclassdef
.mclass
.has_new_factory
= true
836 if name
== "sys" then mprop
.is_toplevel
= true # special case for sys allowed in `new` factories
837 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
839 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
840 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
843 # Check name conflicts in the local class for constructors.
845 for p
, n
in mclassdef
.mprop2npropdef
do
846 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
847 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
853 mclassdef
.mprop2npropdef
[mprop
] = self
855 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
857 set_doc
(mpropdef
, modelbuilder
)
859 self.mpropdef
= mpropdef
860 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
861 if mpropdef
.is_intro
then
862 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
864 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
868 redef fun build_signature
(modelbuilder
)
870 var mpropdef
= self.mpropdef
871 if mpropdef
== null then return # Error thus skiped
872 var mclassdef
= mpropdef
.mclassdef
873 var mmodule
= mclassdef
.mmodule
874 var nsig
= self.n_signature
876 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
877 var root_init
= mclassdef
.mclass
.root_init
878 if root_init
!= null then
879 # Inherit the initializers by refinement
880 mpropdef
.new_msignature
= root_init
.new_msignature
881 assert mpropdef
.initializers
.is_empty
882 mpropdef
.initializers
.add_all root_init
.initializers
886 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
887 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
889 # Retrieve info from the signature AST
890 var param_names
= new Array[String] # Names of parameters from the AST
891 var param_types
= new Array[MType] # Types of parameters from the AST
893 var ret_type
: nullable MType = null # Return type from the AST
895 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
896 param_names
= nsig
.param_names
897 param_types
= nsig
.param_types
898 vararg_rank
= nsig
.vararg_rank
899 ret_type
= nsig
.ret_type
902 # Look for some signature to inherit
903 # FIXME: do not inherit from the intro, but from the most specific
904 var msignature
: nullable MSignature = null
905 if not mpropdef
.is_intro
then
906 msignature
= mpropdef
.mproperty
.intro
.msignature
907 if msignature
== null then return # Skip error
909 # The local signature is adapted to use the local formal types, if any.
910 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
912 # Check inherited signature arity
913 if param_names
.length
!= msignature
.arity
then
915 if nsig
!= null then node
= nsig
else node
= self
916 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}`.")
919 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
920 # FIXME UGLY: inherit signature from a super-constructor
921 for msupertype
in mclassdef
.supertypes
do
922 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
923 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
924 if candidate
!= null then
925 if msignature
== null then
926 msignature
= candidate
.intro
.as(MMethodDef).msignature
933 # Inherit the signature
934 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
935 # Parameters are untyped, thus inherit them
936 param_types
= new Array[MType]
937 for mparameter
in msignature
.mparameters
do
938 param_types
.add
(mparameter
.mtype
)
940 vararg_rank
= msignature
.vararg_rank
942 if msignature
!= null and ret_type
== null then
943 ret_type
= msignature
.return_mtype
946 if param_names
.length
!= param_types
.length
then
947 # Some parameters are typed, other parameters are not typed.
948 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
952 var mparameters
= new Array[MParameter]
953 for i
in [0..param_names
.length
[ do
954 var is_default
= false
955 if vararg_rank
== -1 and param_types
[i
] isa MNullableType then
956 if i
< param_names
.length-1
or accept_special_last_parameter
then
960 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
, is_default
)
961 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
962 mparameters
.add
(mparameter
)
965 # In `new`-factories, the return type is by default the classtype.
966 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
968 # Special checks for operator methods
969 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
970 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
972 if ret_type
== null and return_is_mandatory
then
973 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
976 msignature
= new MSignature(mparameters
, ret_type
)
977 mpropdef
.msignature
= msignature
978 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
979 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
980 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
983 var at
= self.get_single_annotation
("lazy", modelbuilder
)
984 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
987 redef fun check_signature
(modelbuilder
)
989 var mpropdef
= self.mpropdef
990 if mpropdef
== null then return # Error thus skiped
991 var mclassdef
= mpropdef
.mclassdef
992 var mmodule
= mclassdef
.mmodule
993 var nsig
= self.n_signature
994 var mysignature
= self.mpropdef
.msignature
995 if mysignature
== null then return # Error thus skiped
999 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
1000 self.mpropdef
.msignature
= null # invalidate
1001 return # Forward error
1005 # Lookup for signature in the precursor
1006 # FIXME all precursors should be considered
1007 if not mpropdef
.is_intro
then
1008 var msignature
= mpropdef
.mproperty
.intro
.msignature
1009 if msignature
== null then return
1011 var precursor_ret_type
= msignature
.return_mtype
1012 var ret_type
= mysignature
.return_mtype
1013 if ret_type
!= null and precursor_ret_type
== null then
1014 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1015 self.mpropdef
.msignature
= null
1019 if mysignature
.arity
> 0 then
1020 # Check parameters types
1021 for i
in [0..mysignature
.arity
[ do
1022 var myt
= mysignature
.mparameters
[i
].mtype
1023 var prt
= msignature
.mparameters
[i
].mtype
1024 var node
= nsig
.n_params
[i
]
1025 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1026 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1027 self.mpropdef
.msignature
= null
1031 if precursor_ret_type
!= null then
1032 var node
: nullable ANode = null
1033 if nsig
!= null then node
= nsig
.n_type
1034 if node
== null then node
= self
1035 if ret_type
== null then
1036 # Inherit the return type
1037 ret_type
= precursor_ret_type
1038 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1039 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1040 self.mpropdef
.msignature
= null
1045 if mysignature
.arity
> 0 then
1046 # Check parameters visibility
1047 for i
in [0..mysignature
.arity
[ do
1048 var nt
= nsig
.n_params
[i
].n_type
1049 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1051 var nt
= nsig
.n_type
1052 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1058 # Is a return required?
1060 # * True for operators and brackets.
1061 # * False for id and assignment.
1062 fun return_is_mandatory
: Bool do return true
1064 # Can the last parameter be special like a vararg?
1066 # * False for operators: the last one is in fact the only one.
1067 # * False for assignments: it is the right part of the assignment.
1068 # * True for ids and brackets.
1069 fun accept_special_last_parameter
: Bool do return false
1071 # The minimum required number of parameters.
1073 # * 1 for binary operators
1075 # * 1 for assignments
1076 # * 2 for bracket assignments
1078 fun min_arity
: Int do return 1
1080 # Is the `self` a binary operator?
1081 fun is_binary
: Bool do return true
1084 redef class AIdMethid
1085 redef fun return_is_mandatory
do return false
1086 redef fun accept_special_last_parameter
do return true
1087 redef fun min_arity
do return 0
1088 redef fun is_binary
do return false
1091 redef class ABraMethid
1092 redef fun accept_special_last_parameter
do return true
1093 redef fun is_binary
do return false
1096 redef class ABraassignMethid
1097 redef fun return_is_mandatory
do return false
1098 redef fun min_arity
do return 2
1099 redef fun is_binary
do return false
1102 redef class AAssignMethid
1103 redef fun return_is_mandatory
do return false
1104 redef fun is_binary
do return false
1107 redef class AAttrPropdef
1108 redef type MPROPDEF: MAttributeDef
1110 # Is the node tagged `noinit`?
1113 # Is the node tagged lazy?
1116 # Has the node a default value?
1117 # Could be through `n_expr` or `n_block`
1118 var has_value
= false
1120 # The guard associated to a lazy attribute.
1121 # Because some engines does not have a working `isset`,
1122 # this additional attribute is used to guard the lazy initialization.
1123 # TODO: to remove once isset is correctly implemented
1124 var mlazypropdef
: nullable MAttributeDef
1126 # The associated getter (read accessor) if any
1127 var mreadpropdef
: nullable MMethodDef is writable
1128 # The associated setter (write accessor) if any
1129 var mwritepropdef
: nullable MMethodDef is writable
1131 redef fun build_property
(modelbuilder
, mclassdef
)
1133 var mclass
= mclassdef
.mclass
1135 var name
= nid2
.text
1137 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1138 if atabstract
== null then
1139 if not mclass
.kind
.need_init
then
1140 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1143 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1144 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1145 self.mpropdef
= mpropdef
1146 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1150 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1151 if mreadprop
== null then
1152 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1153 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1154 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1156 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1157 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1159 mclassdef
.mprop2npropdef
[mreadprop
] = self
1161 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1162 self.mreadpropdef
= mreadpropdef
1163 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1164 set_doc
(mreadpropdef
, modelbuilder
)
1165 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1166 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1168 has_value
= n_expr
!= null or n_block
!= null
1170 if atabstract
!= null and has_value
then
1171 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1175 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1176 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1177 if atnoinit
!= null then
1180 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1183 if atabstract
!= null then
1184 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot be abstract.")
1189 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1190 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1191 if atlazy
!= null or atautoinit
!= null then
1192 if atlazy
!= null and atautoinit
!= null then
1193 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `autoinit`.")
1196 if not has_value
then
1197 if atlazy
!= null then
1198 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1199 else if atautoinit
!= null then
1200 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes need a value.")
1206 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1207 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1208 self.mlazypropdef
= mlazypropdef
1211 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1212 if atreadonly
!= null then
1213 if not has_value
then
1214 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1216 # No setter, so just leave
1220 var writename
= name
+ "="
1221 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1222 if atwritable
!= null then
1223 if not atwritable
.n_args
.is_empty
then
1224 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1227 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1228 var nwkwredef
: nullable Token = null
1229 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1230 if mwriteprop
== null then
1232 if atwritable
!= null then
1233 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1235 mvisibility
= private_visibility
1237 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1238 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1239 mwriteprop
.deprecation
= mreadprop
.deprecation
1241 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1242 if atwritable
!= null then
1243 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1246 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1248 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1249 self.mwritepropdef
= mwritepropdef
1250 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1251 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1252 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1255 redef fun build_signature
(modelbuilder
)
1257 var mreadpropdef
= self.mreadpropdef
1258 var mpropdef
= self.mpropdef
1259 if mreadpropdef
== null then return # Error thus skipped
1260 var mclassdef
= mreadpropdef
.mclassdef
1261 var mmodule
= mclassdef
.mmodule
1262 var mtype
: nullable MType = null
1265 var ntype
= self.n_type
1266 if ntype
!= null then
1267 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1268 if mtype
== null then return
1271 var inherited_type
: nullable MType = null
1272 # Inherit the type from the getter (usually an abstract getter)
1273 if not mreadpropdef
.is_intro
then
1274 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1275 if msignature
== null then return # Error, thus skipped
1276 inherited_type
= msignature
.return_mtype
1277 if inherited_type
!= null then
1278 # The inherited type is adapted to use the local formal types, if any.
1279 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1280 if mtype
== null then mtype
= inherited_type
1284 var nexpr
= self.n_expr
1285 if mtype
== null then
1286 if nexpr
!= null then
1287 if nexpr
isa ANewExpr then
1288 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1289 else if nexpr
isa AIntExpr then
1290 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1291 if cla
!= null then mtype
= cla
.mclass_type
1292 else if nexpr
isa AFloatExpr then
1293 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1294 if cla
!= null then mtype
= cla
.mclass_type
1295 else if nexpr
isa ACharExpr then
1296 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1297 if cla
!= null then mtype
= cla
.mclass_type
1298 else if nexpr
isa ABoolExpr then
1299 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1300 if cla
!= null then mtype
= cla
.mclass_type
1301 else if nexpr
isa ASuperstringExpr then
1302 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1303 if cla
!= null then mtype
= cla
.mclass_type
1304 else if nexpr
isa AStringFormExpr then
1305 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1306 if cla
!= null then mtype
= cla
.mclass_type
1308 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1311 if mtype
== null then return
1313 else if ntype
!= null and inherited_type
== mtype
then
1314 if nexpr
isa ANewExpr then
1315 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1316 if xmtype
== mtype
then
1317 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1322 if mtype
== null then
1323 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1327 if mpropdef
!= null then
1328 mpropdef
.static_mtype
= mtype
1332 var msignature
= new MSignature(new Array[MParameter], mtype
)
1333 mreadpropdef
.msignature
= msignature
1336 var mwritepropdef
= self.mwritepropdef
1337 if mwritepropdef
!= null then
1340 var mparameter
= new MParameter(name
, mtype
, false, false)
1341 var msignature
= new MSignature([mparameter
], null)
1342 mwritepropdef
.msignature
= msignature
1345 var mlazypropdef
= self.mlazypropdef
1346 if mlazypropdef
!= null then
1347 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1351 redef fun check_signature
(modelbuilder
)
1353 var mpropdef
= self.mpropdef
1354 if mpropdef
== null then return # Error thus skipped
1355 var ntype
= self.n_type
1356 var mtype
= self.mpropdef
.static_mtype
1357 if mtype
== null then return # Error thus skipped
1359 var mclassdef
= mpropdef
.mclassdef
1360 var mmodule
= mclassdef
.mmodule
1363 if ntype
!= null then
1364 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1367 if nexpr
isa ANewExpr then
1368 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1371 # Lookup for signature in the precursor
1372 # FIXME all precursors should be considered
1373 if not mpropdef
.is_intro
then
1374 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1375 if precursor_type
== null then return
1377 if mtype
!= precursor_type
then
1378 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1383 # Check getter and setter
1384 var meth
= self.mreadpropdef
1385 if meth
!= null then
1386 self.check_method_signature
(modelbuilder
, meth
)
1387 var node
: nullable ANode = ntype
1388 if node
== null then node
= self
1389 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1391 meth
= self.mwritepropdef
1392 if meth
!= null then
1393 self.check_method_signature
(modelbuilder
, meth
)
1394 var node
: nullable ANode = ntype
1395 if node
== null then node
= self
1396 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1400 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1402 var mclassdef
= mpropdef
.mclassdef
1403 var mmodule
= mclassdef
.mmodule
1404 var nsig
= self.n_type
1405 var mysignature
= mpropdef
.msignature
1406 if mysignature
== null then return # Error thus skiped
1408 # Lookup for signature in the precursor
1409 # FIXME all precursors should be considered
1410 if not mpropdef
.is_intro
then
1411 var msignature
= mpropdef
.mproperty
.intro
.msignature
1412 if msignature
== null then return
1414 if mysignature
.arity
!= msignature
.arity
then
1416 if nsig
!= null then node
= nsig
else node
= self
1417 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}`.")
1420 var precursor_ret_type
= msignature
.return_mtype
1421 var ret_type
= mysignature
.return_mtype
1422 if ret_type
!= null and precursor_ret_type
== null then
1424 if nsig
!= null then node
= nsig
else node
= self
1425 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1429 if mysignature
.arity
> 0 then
1430 # Check parameters types
1431 for i
in [0..mysignature
.arity
[ do
1432 var myt
= mysignature
.mparameters
[i
].mtype
1433 var prt
= msignature
.mparameters
[i
].mtype
1435 if nsig
!= null then node
= nsig
else node
= self
1436 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1437 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1441 if precursor_ret_type
!= null then
1443 if nsig
!= null then node
= nsig
else node
= self
1444 if ret_type
== null then
1445 # Inherit the return type
1446 ret_type
= precursor_ret_type
1447 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1448 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1455 redef class ATypePropdef
1456 redef type MPROPDEF: MVirtualTypeDef
1458 redef fun build_property
(modelbuilder
, mclassdef
)
1460 var name
= self.n_id
.text
1461 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1462 if mprop
== null then
1463 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1464 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1465 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1466 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1469 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1471 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1472 assert mprop
isa MVirtualTypeProp
1473 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1475 mclassdef
.mprop2npropdef
[mprop
] = self
1477 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1478 self.mpropdef
= mpropdef
1479 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1480 if mpropdef
.is_intro
then
1481 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1483 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1485 set_doc
(mpropdef
, modelbuilder
)
1487 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1488 if atfixed
!= null then
1489 mpropdef
.is_fixed
= true
1493 redef fun build_signature
(modelbuilder
)
1495 var mpropdef
= self.mpropdef
1496 if mpropdef
== null then return # Error thus skipped
1497 var mclassdef
= mpropdef
.mclassdef
1498 var mmodule
= mclassdef
.mmodule
1499 var mtype
: nullable MType = null
1501 var ntype
= self.n_type
1502 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1503 if mtype
== null then return
1505 mpropdef
.bound
= mtype
1506 # print "{mpropdef}: {mtype}"
1509 redef fun check_signature
(modelbuilder
)
1511 var mpropdef
= self.mpropdef
1512 if mpropdef
== null then return # Error thus skipped
1514 var bound
= mpropdef
.bound
1515 if bound
== null then return # Error thus skipped
1517 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1519 var mclassdef
= mpropdef
.mclassdef
1520 var mmodule
= mclassdef
.mmodule
1521 var anchor
= mclassdef
.bound_mtype
1523 var ntype
= self.n_type
1524 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1525 mpropdef
.bound
= null
1529 # Check redefinitions
1530 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1531 var supbound
= p
.bound
1532 if supbound
== null then break # broken super bound, skip error
1534 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1537 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1538 # Still a warning to pass existing bad code
1539 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1542 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1543 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")