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 attribute
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 if npropdef
.mpropdef
== null then return # Skip broken attribute
207 if npropdef
.noinit
then continue # Skip noinit attribute
208 var atautoinit
= npropdef
.get_single_annotation
("autoinit", self)
209 if atautoinit
!= null then
210 # For autoinit attributes, call the reader to force
211 # the lazy initialization of the attribute.
212 initializers
.add
(npropdef
.mreadpropdef
.mproperty
)
213 npropdef
.mreadpropdef
.mproperty
.is_autoinit
= true
216 if npropdef
.has_value
then continue
217 var paramname
= npropdef
.mpropdef
.mproperty
.name
.substring_from
(1)
218 var ret_type
= npropdef
.mpropdef
.static_mtype
219 if ret_type
== null then return
220 var mparameter
= new MParameter(paramname
, ret_type
, false, ret_type
isa MNullableType)
221 mparameters
.add
(mparameter
)
222 var msetter
= npropdef
.mwritepropdef
223 if msetter
== null then
224 # No setter, it is a old-style attribute, so just add it
225 initializers
.add
(npropdef
.mpropdef
.mproperty
)
226 npropdef
.mpropdef
.mproperty
.is_autoinit
= true
228 # Add the setter to the list
229 initializers
.add
(msetter
.mproperty
)
230 msetter
.mproperty
.is_autoinit
= true
235 if the_root_init_mmethod
== null then return
237 # Look for most-specific new-stype init definitions
238 var spropdefs
= the_root_init_mmethod
.lookup_super_definitions
(mclassdef
.mmodule
, mclassdef
.bound_mtype
)
239 if spropdefs
.is_empty
then
240 toolcontext
.error
(nclassdef
.location
, "Error: `{mclassdef}` does not specialize `{the_root_init_mmethod.intro_mclassdef}`. Possible duplication of the root class `Object`?")
244 # Look at the autoinit class-annotation
245 var autoinit
= nclassdef
.get_single_annotation
("autoinit", self)
246 var noautoinit
= nclassdef
.get_single_annotation
("noautoinit", self)
247 if autoinit
!= null then
248 # Just throws the collected initializers
252 if noautoinit
!= null then
253 error
(autoinit
, "Error: `autoinit` and `noautoinit` are incompatible.")
256 if autoinit
.n_args
.is_empty
then
257 error
(autoinit
, "Syntax Error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
260 # Get and check each argument
261 for narg
in autoinit
.n_args
do
264 error
(narg
, "Syntax Error: `autoinit` expects method identifiers.")
268 # Search the property.
269 # To avoid bad surprises, try to get the setter first.
270 var p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
+ "=")
272 p
= try_get_mproperty_by_name
(narg
, mclassdef
, id
)
275 error
(narg
, "Error: unknown method `{id}`")
278 if not p
.is_autoinit
then
279 error
(narg
, "Error: `{p}` is not an autoinit method")
283 # Register the initializer and the parameters
286 if pd
isa MMethodDef then
287 # Get the signature resolved for the current receiver
288 var sig
= pd
.msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mclassdef
.mmodule
, false)
289 # Because the last parameter of setters is never default, try to default them for the autoinit.
290 for param
in sig
.mparameters
do
291 if not param
.is_default
and param
.mtype
isa MNullableType then
292 param
= new MParameter(param
.name
, param
.mtype
, param
.is_vararg
, true)
294 mparameters
.add
(param
)
301 else if noautoinit
!= null then
302 if initializers
.is_empty
then
303 warning
(noautoinit
, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
305 # Just clear initializers
309 # Search the longest-one and checks for conflict
310 var longest
= spropdefs
.first
311 if spropdefs
.length
> 1 then
312 # Check for conflict in the order of initializers
313 # Each initializer list must me a prefix of the longest list
314 # part 1. find the longest list
315 for spd
in spropdefs
do
316 if spd
.initializers
.length
> longest
.initializers
.length
then longest
= spd
319 for spd
in spropdefs
do
321 for p
in spd
.initializers
do
322 if p
!= longest
.initializers
[i
] then
323 self.error
(nclassdef
, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
324 # TODO: invalidate the initializer to avoid more errors
332 # Can we just inherit?
333 if spropdefs
.length
== 1 and mparameters
.is_empty
and defined_init
== null then
334 self.toolcontext
.info
("{mclassdef} inherits the basic constructor {longest}", 3)
335 mclassdef
.mclass
.root_init
= longest
339 # Combine the inherited list to what is collected
340 if longest
.initializers
.length
> 0 then
341 mparameters
.prepend longest
.new_msignature
.mparameters
342 initializers
.prepend longest
.initializers
346 # If we already have a basic init definition, then setup its initializers
347 if defined_init
!= null then
348 defined_init
.initializers
.add_all
(initializers
)
349 var msignature
= new MSignature(mparameters
, null)
350 defined_init
.new_msignature
= msignature
351 self.toolcontext
.info
("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
352 mclassdef
.mclass
.root_init
= defined_init
356 # Else create the local implicit basic init definition
357 var mprop
= the_root_init_mmethod
.as(not null)
358 var mpropdef
= new MMethodDef(mclassdef
, mprop
, nclassdef
.location
)
359 mpropdef
.has_supercall
= true
360 mpropdef
.initializers
.add_all
(initializers
)
361 var msignature
= new MSignature(mparameters
, null)
362 mpropdef
.new_msignature
= msignature
363 mpropdef
.msignature
= new MSignature(new Array[MParameter], null) # always an empty real signature
364 nclassdef
.mfree_init
= mpropdef
365 self.toolcontext
.info
("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
366 mclassdef
.mclass
.root_init
= mpropdef
369 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
370 fun check_visibility
(node
: ANode, mtype
: MType, mpropdef
: MPropDef)
372 var mmodule
= mpropdef
.mclassdef
.mmodule
373 var mproperty
= mpropdef
.mproperty
375 # Extract visibility information of the main part of `mtype`
376 # It is a case-by case
377 var vis_type
: nullable MVisibility = null # The own visibility of the type
378 var mmodule_type
: nullable MModule = null # The original module of the type
379 mtype
= mtype
.undecorate
380 if mtype
isa MClassType then
381 vis_type
= mtype
.mclass
.visibility
382 mmodule_type
= mtype
.mclass
.intro
.mmodule
383 else if mtype
isa MVirtualType then
384 vis_type
= mtype
.mproperty
.visibility
385 mmodule_type
= mtype
.mproperty
.intro_mclassdef
.mmodule
386 else if mtype
isa MParameterType then
387 # nothing, always visible
388 else if mtype
isa MNullType then
391 node
.debug
"Unexpected type {mtype}"
395 if vis_type
!= null then
396 assert mmodule_type
!= null
397 var vis_module_type
= mmodule
.visibility_for
(mmodule_type
) # the visibility of the original module
398 if mproperty
.visibility
> vis_type
then
399 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`.")
401 else if mproperty
.visibility
> vis_module_type
then
402 error
(node
, "Error: the {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`.")
407 # No error, try to go deeper in generic types
408 if node
isa AType then
409 for a
in node
.n_types
do
411 if t
== null then continue # Error, thus skipped
412 check_visibility
(a
, t
, mpropdef
)
414 else if mtype
isa MGenericType then
415 for t
in mtype
.arguments
do check_visibility
(node
, t
, mpropdef
)
419 # Detect circularity errors for virtual types.
420 fun check_virtual_types_circularity
(node
: ANode, mproperty
: MVirtualTypeProp, recv
: MType, mmodule
: MModule): Bool
423 # Slow case: progress on each resolution until we visit all without getting a loop
425 # The graph used to detect loops
426 var mtype
= mproperty
.mvirtualtype
427 var poset
= new POSet[MType]
429 # The work-list of types to resolve
430 var todo
= new List[MType]
433 while not todo
.is_empty
do
437 if not t
.need_anchor
then continue
439 # Get the types derived of `t` (subtypes and bounds)
441 if t
isa MNullableType then
443 else if t
isa MGenericType then
445 else if t
isa MVirtualType then
447 # Because `vt` is possibly unchecked, we have to do the bound-lookup manually
448 var defs
= vt
.lookup_definitions
(mmodule
, recv
)
449 # TODO something to manage correctly bound conflicts
450 assert not defs
.is_empty
451 nexts
= new Array[MType]
453 var next
= defs
.first
.bound
454 if next
== null then return false
457 else if t
isa MClassType then
458 # Basic type, nothing to to
460 else if t
isa MParameterType then
461 # Parameter types cannot depend on virtual types, so nothing to do
469 if poset
.has_edge
(next
, t
) then
470 if mtype
== next
then
471 error
(node
, "Error: circularity of virtual type definition: {next} <-> {t}.")
473 error
(node
, "Error: circularity of virtual type definition: {mtype} -> {next} <-> {t}.")
477 poset
.add_edge
(t
, next
)
487 # Does the MPropDef contains a call to super or a call of a super-constructor?
488 # Subsequent phases of the frontend (esp. typing) set it if required
489 var has_supercall
: Bool = false is writable
492 redef class AClassdef
493 # Marker used in `ModelBuilder::build_properties`
494 private var build_properties_is_done
= false
496 # The free init (implicitely constructed by the class if required)
497 var mfree_init
: nullable MMethodDef = null
501 # The base init of the class.
502 # Used to get the common new_msignature and initializers
504 # TODO: Where to put this information is not clear because unlike other
505 # informations, the initialisers are stable in a same class.
506 var root_init
: nullable MMethodDef = null
509 redef class MClassDef
510 # What is the `APropdef` associated to a `MProperty`?
511 # Used to check multiple definition of a property.
512 var mprop2npropdef
: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
514 # Build the virtual type `SELF` only for introduction `MClassDef`
515 fun build_self_type
(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
517 if not is_intro
then return
520 var mprop
= modelbuilder
.try_get_mproperty_by_name
(nclassdef
, self, name
)
522 # If SELF type is declared nowherer?
523 if mprop
== null then return
525 # SELF is not a virtual type? it is weird but we ignore it
526 if not mprop
isa MVirtualTypeProp then return
528 # Is this the intro of SELF in the library?
529 var intro
= mprop
.intro
530 var intro_mclassdef
= intro
.mclassdef
531 if intro_mclassdef
== self then
532 var nintro
= modelbuilder
.mpropdef2npropdef
[intro
]
534 # SELF must be declared in Object, otherwise this will create conflicts
535 if intro_mclassdef
.mclass
.name
!= "Object" then
536 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be declared in `Object`.")
539 # SELF must be public
540 if mprop
.visibility
!= public_visibility
then
541 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` must be public.")
544 # SELF must not be fixed
545 if intro
.is_fixed
then
546 modelbuilder
.error
(nintro
, "Error: the virtual type `SELF` cannot be fixed.")
552 # This class introduction inherits a SELF
553 # We insert an artificial property to update it
554 var mpropdef
= new MVirtualTypeDef(self, mprop
, self.location
)
555 mpropdef
.bound
= mclass
.mclass_type
560 # The associated main model entity
561 type MPROPDEF: MPropDef
563 # The associated propdef once build by a `ModelBuilder`
564 var mpropdef
: nullable MPROPDEF is writable
566 private fun build_property
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef) do end
567 private fun build_signature
(modelbuilder
: ModelBuilder) do end
568 private fun check_signature
(modelbuilder
: ModelBuilder) do end
569 private fun new_property_visibility
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, nvisibility
: nullable AVisibility): MVisibility
571 var mvisibility
= public_visibility
572 if nvisibility
!= null then
573 mvisibility
= nvisibility
.mvisibility
574 if mvisibility
== intrude_visibility
then
575 modelbuilder
.error
(nvisibility
, "Error: `intrude` is not a legal visibility for properties.")
576 mvisibility
= public_visibility
579 if mclassdef
.mclass
.visibility
== private_visibility
then
580 if mvisibility
== protected_visibility
then
581 assert nvisibility
!= null
582 modelbuilder
.error
(nvisibility
, "Error: `private` is the only legal visibility for properties in a private class.")
583 else if mvisibility
== private_visibility
then
584 assert nvisibility
!= null
585 modelbuilder
.advice
(nvisibility
, "useless-visibility", "Warning: `private` is superfluous since the only legal visibility for properties in a private class is private.")
587 mvisibility
= private_visibility
592 private fun set_doc
(mpropdef
: MPropDef, modelbuilder
: ModelBuilder)
594 var ndoc
= self.n_doc
596 var mdoc
= ndoc
.to_mdoc
598 mdoc
.original_mentity
= mpropdef
599 else if mpropdef
.is_intro
and mpropdef
.mproperty
.visibility
>= protected_visibility
then
600 modelbuilder
.advice
(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
603 var at_deprecated
= get_single_annotation
("deprecated", modelbuilder
)
604 if at_deprecated
!= null then
605 if not mpropdef
.is_intro
then
606 modelbuilder
.error
(self, "Error: method redefinition cannot be deprecated.")
608 var info
= new MDeprecationInfo
609 ndoc
= at_deprecated
.n_doc
610 if ndoc
!= null then info
.mdoc
= ndoc
.to_mdoc
611 mpropdef
.mproperty
.deprecation
= info
616 private fun check_redef_property_visibility
(modelbuilder
: ModelBuilder, nvisibility
: nullable AVisibility, mprop
: MProperty)
618 if nvisibility
== null then return
619 var mvisibility
= nvisibility
.mvisibility
620 if mvisibility
!= mprop
.visibility
and mvisibility
!= public_visibility
then
621 modelbuilder
.error
(nvisibility
, "Error: redefinition changed the visibility from `{mprop.visibility}` to `{mvisibility}`.")
625 private fun check_redef_keyword
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef, kwredef
: nullable Token, need_redef
: Bool, mprop
: MProperty): Bool
627 if mclassdef
.mprop2npropdef
.has_key
(mprop
) then
628 modelbuilder
.error
(self, "Error: a property `{mprop}` is already defined in class `{mclassdef.mclass}` at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
631 if mprop
isa MMethod and mprop
.is_root_init
then return true
632 if kwredef
== null then
634 modelbuilder
.error
(self, "Redef Error: `{mclassdef.mclass}::{mprop.name}` is an inherited property. To redefine it, add the `redef` keyword.")
638 # Check for full-name conflicts in the project.
639 # A public property should have a unique qualified name `project::class::prop`.
640 if mprop
.intro_mclassdef
.mmodule
.mgroup
!= null and mprop
.visibility
>= protected_visibility
then
641 var others
= modelbuilder
.model
.get_mproperties_by_name
(mprop
.name
)
642 if others
!= null then for other
in others
do
643 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
644 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}`.")
650 if not need_redef
then
651 modelbuilder
.error
(self, "Error: no property `{mclassdef.mclass}::{mprop.name}` is inherited. Remove the `redef` keyword to define a new property.")
660 redef class ASignature
661 # Is the model builder has correctly visited the signature
662 var is_visited
= false
663 # Names of parameters from the AST
664 # REQUIRE: is_visited
665 var param_names
= new Array[String]
666 # Types of parameters from the AST
667 # REQUIRE: is_visited
668 var param_types
= new Array[MType]
669 # Rank of the vararg (of -1 if none)
670 # REQUIRE: is_visited
671 var vararg_rank
: Int = -1
673 var ret_type
: nullable MType = null
675 # Visit and fill information about a signature
676 private fun visit_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
678 var mmodule
= mclassdef
.mmodule
679 var param_names
= self.param_names
680 var param_types
= self.param_types
681 for np
in self.n_params
do
682 param_names
.add
(np
.n_id
.text
)
683 var ntype
= np
.n_type
684 if ntype
!= null then
685 var mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
686 if mtype
== null then return false # Skip error
687 for i
in [0..param_names
.length-param_types
.length
[ do
688 param_types
.add
(mtype
)
690 if np
.n_dotdotdot
!= null then
691 if self.vararg_rank
!= -1 then
692 modelbuilder
.error
(np
, "Error: `{param_names[self.vararg_rank]}` is already a vararg")
695 self.vararg_rank
= param_names
.length
- 1
700 var ntype
= self.n_type
701 if ntype
!= null then
702 self.ret_type
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
703 if self.ret_type
== null then return false # Skip error
706 self.is_visited
= true
710 private fun check_signature
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
713 for np
in self.n_params
do
714 var ntype
= np
.n_type
715 if ntype
!= null then
716 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
721 var ntype
= self.n_type
722 if ntype
!= null then
723 if modelbuilder
.resolve_mtype
(mclassdef
.mmodule
, mclassdef
, ntype
) == null then
732 # The associated mparameter if any
733 var mparameter
: nullable MParameter = null
736 redef class AMethPropdef
737 redef type MPROPDEF: MMethodDef
740 # Can self be used as a root init?
741 private fun look_like_a_root_init
(modelbuilder
: ModelBuilder, mclassdef
: MClassDef): Bool
743 # Need the `init` keyword
744 if n_kwinit
== null then return false
745 # Need to by anonymous
746 if self.n_methid
!= null then return false
747 # No annotation on itself
748 if get_single_annotation
("old_style_init", modelbuilder
) != null then return false
750 var amod
= self.parent
.parent
.as(AModule)
751 var amoddecl
= amod
.n_moduledecl
752 if amoddecl
!= null then
753 var old
= amoddecl
.get_single_annotation
("old_style_init", modelbuilder
)
754 if old
!= null then return false
757 if self.n_signature
.n_params
.length
> 0 then
758 modelbuilder
.advice
(self, "old-init", "Warning: init with signature in {mclassdef}")
761 # Cannot be private or something
762 if not self.n_visibility
isa APublicVisibility then
763 modelbuilder
.advice
(self, "old-init", "Warning: non-public init in {mclassdef}")
770 redef fun build_property
(modelbuilder
, mclassdef
)
772 var n_kwinit
= n_kwinit
773 var n_kwnew
= n_kwnew
774 var is_init
= n_kwinit
!= null or n_kwnew
!= null
776 var amethodid
= self.n_methid
778 if amethodid
== null then
782 else if n_kwinit
!= 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 self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mprop
)
838 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, not self isa AMainMethPropdef, mprop
) then return
839 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
842 # Check name conflicts in the local class for constructors.
844 for p
, n
in mclassdef
.mprop2npropdef
do
845 if p
!= mprop
and p
isa MMethod and p
.name
== name
then
846 check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, p
)
852 mclassdef
.mprop2npropdef
[mprop
] = self
854 var mpropdef
= new MMethodDef(mclassdef
, mprop
, self.location
)
856 set_doc
(mpropdef
, modelbuilder
)
858 self.mpropdef
= mpropdef
859 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
860 if mpropdef
.is_intro
then
861 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new method {mprop.full_name}", 4)
863 modelbuilder
.toolcontext
.info
("{mpropdef} redefines method {mprop.full_name}", 4)
867 redef fun build_signature
(modelbuilder
)
869 var mpropdef
= self.mpropdef
870 if mpropdef
== null then return # Error thus skiped
871 var mclassdef
= mpropdef
.mclassdef
872 var mmodule
= mclassdef
.mmodule
873 var nsig
= self.n_signature
875 if mpropdef
.mproperty
.is_root_init
and not mclassdef
.is_intro
then
876 var root_init
= mclassdef
.mclass
.root_init
877 if root_init
!= null then
878 # Inherit the initializers by refinement
879 mpropdef
.new_msignature
= root_init
.new_msignature
880 assert mpropdef
.initializers
.is_empty
881 mpropdef
.initializers
.add_all root_init
.initializers
885 var accept_special_last_parameter
= self.n_methid
== null or self.n_methid
.accept_special_last_parameter
886 var return_is_mandatory
= self.n_methid
!= null and self.n_methid
.return_is_mandatory
888 # Retrieve info from the signature AST
889 var param_names
= new Array[String] # Names of parameters from the AST
890 var param_types
= new Array[MType] # Types of parameters from the AST
892 var ret_type
: nullable MType = null # Return type from the AST
894 if not nsig
.visit_signature
(modelbuilder
, mclassdef
) then return
895 param_names
= nsig
.param_names
896 param_types
= nsig
.param_types
897 vararg_rank
= nsig
.vararg_rank
898 ret_type
= nsig
.ret_type
901 # Look for some signature to inherit
902 # FIXME: do not inherit from the intro, but from the most specific
903 var msignature
: nullable MSignature = null
904 if not mpropdef
.is_intro
then
905 msignature
= mpropdef
.mproperty
.intro
.msignature
906 if msignature
== null then return # Skip error
908 # The local signature is adapted to use the local formal types, if any.
909 msignature
= msignature
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
911 # Check inherited signature arity
912 if param_names
.length
!= msignature
.arity
then
914 if nsig
!= null then node
= nsig
else node
= self
915 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}`.")
918 else if mpropdef
.mproperty
.is_init
and not mpropdef
.mproperty
.is_new
then
919 # FIXME UGLY: inherit signature from a super-constructor
920 for msupertype
in mclassdef
.supertypes
do
921 msupertype
= msupertype
.anchor_to
(mmodule
, mclassdef
.bound_mtype
)
922 var candidate
= modelbuilder
.try_get_mproperty_by_name2
(self, mmodule
, msupertype
, mpropdef
.mproperty
.name
)
923 if candidate
!= null then
924 if msignature
== null then
925 msignature
= candidate
.intro
.as(MMethodDef).msignature
932 # Inherit the signature
933 if msignature
!= null and param_names
.length
!= param_types
.length
and param_names
.length
== msignature
.arity
and param_types
.length
== 0 then
934 # Parameters are untyped, thus inherit them
935 param_types
= new Array[MType]
936 for mparameter
in msignature
.mparameters
do
937 param_types
.add
(mparameter
.mtype
)
939 vararg_rank
= msignature
.vararg_rank
941 if msignature
!= null and ret_type
== null then
942 ret_type
= msignature
.return_mtype
945 if param_names
.length
!= param_types
.length
then
946 # Some parameters are typed, other parameters are not typed.
947 modelbuilder
.error
(nsig
.n_params
[param_types
.length
], "Error: untyped parameter `{param_names[param_types.length]}'.")
951 var mparameters
= new Array[MParameter]
952 for i
in [0..param_names
.length
[ do
953 var is_default
= false
954 if vararg_rank
== -1 and param_types
[i
] isa MNullableType then
955 if i
< param_names
.length-1
or accept_special_last_parameter
then
959 var mparameter
= new MParameter(param_names
[i
], param_types
[i
], i
== vararg_rank
, is_default
)
960 if nsig
!= null then nsig
.n_params
[i
].mparameter
= mparameter
961 mparameters
.add
(mparameter
)
964 # In `new`-factories, the return type is by default the classtype.
965 if ret_type
== null and mpropdef
.mproperty
.is_new
then ret_type
= mclassdef
.mclass
.mclass_type
967 # Special checks for operator methods
968 if not accept_special_last_parameter
and mparameters
.not_empty
and mparameters
.last
.is_vararg
then
969 modelbuilder
.error
(self.n_signature
.n_params
.last
, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
971 if ret_type
== null and return_is_mandatory
then
972 modelbuilder
.error
(self.n_methid
, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
975 msignature
= new MSignature(mparameters
, ret_type
)
976 mpropdef
.msignature
= msignature
977 mpropdef
.is_abstract
= self.get_single_annotation
("abstract", modelbuilder
) != null
978 mpropdef
.is_intern
= self.get_single_annotation
("intern", modelbuilder
) != null
979 mpropdef
.is_extern
= self.n_extern_code_block
!= null or self.get_single_annotation
("extern", modelbuilder
) != null
982 var at
= self.get_single_annotation
("lazy", modelbuilder
)
983 if at
!= null then modelbuilder
.error
(at
, "Syntax Error: `lazy` must be used on attributes.")
986 redef fun check_signature
(modelbuilder
)
988 var mpropdef
= self.mpropdef
989 if mpropdef
== null then return # Error thus skiped
990 var mclassdef
= mpropdef
.mclassdef
991 var mmodule
= mclassdef
.mmodule
992 var nsig
= self.n_signature
993 var mysignature
= self.mpropdef
.msignature
994 if mysignature
== null then return # Error thus skiped
998 if not nsig
.check_signature
(modelbuilder
, mclassdef
) then
999 self.mpropdef
.msignature
= null # invalidate
1000 return # Forward error
1004 # Lookup for signature in the precursor
1005 # FIXME all precursors should be considered
1006 if not mpropdef
.is_intro
then
1007 var msignature
= mpropdef
.mproperty
.intro
.msignature
1008 if msignature
== null then return
1010 var precursor_ret_type
= msignature
.return_mtype
1011 var ret_type
= mysignature
.return_mtype
1012 if ret_type
!= null and precursor_ret_type
== null then
1013 modelbuilder
.error
(nsig
.n_type
.as(not null), "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1014 self.mpropdef
.msignature
= null
1018 if mysignature
.arity
> 0 then
1019 # Check parameters types
1020 for i
in [0..mysignature
.arity
[ do
1021 var myt
= mysignature
.mparameters
[i
].mtype
1022 var prt
= msignature
.mparameters
[i
].mtype
1023 var node
= nsig
.n_params
[i
]
1024 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1025 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1026 self.mpropdef
.msignature
= null
1030 if precursor_ret_type
!= null then
1031 var node
: nullable ANode = null
1032 if nsig
!= null then node
= nsig
.n_type
1033 if node
== null then node
= self
1034 if ret_type
== null then
1035 # Inherit the return type
1036 ret_type
= precursor_ret_type
1037 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1038 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1039 self.mpropdef
.msignature
= null
1044 if mysignature
.arity
> 0 then
1045 # Check parameters visibility
1046 for i
in [0..mysignature
.arity
[ do
1047 var nt
= nsig
.n_params
[i
].n_type
1048 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1050 var nt
= nsig
.n_type
1051 if nt
!= null then modelbuilder
.check_visibility
(nt
, nt
.mtype
.as(not null), mpropdef
)
1057 # Is a return required?
1059 # * True for operators and brackets.
1060 # * False for id and assignment.
1061 fun return_is_mandatory
: Bool do return true
1063 # Can the last parameter be special like a vararg?
1065 # * False for operators: the last one is in fact the only one.
1066 # * False for assignments: it is the right part of the assignment.
1067 # * True for ids and brackets.
1068 fun accept_special_last_parameter
: Bool do return false
1070 # The minimum required number of parameters.
1072 # * 1 for binary operators
1074 # * 1 for assignments
1075 # * 2 for bracket assignments
1077 fun min_arity
: Int do return 1
1079 # Is the `self` a binary operator?
1080 fun is_binary
: Bool do return true
1083 redef class AIdMethid
1084 redef fun return_is_mandatory
do return false
1085 redef fun accept_special_last_parameter
do return true
1086 redef fun min_arity
do return 0
1087 redef fun is_binary
do return false
1090 redef class ABraMethid
1091 redef fun accept_special_last_parameter
do return true
1092 redef fun is_binary
do return false
1095 redef class ABraassignMethid
1096 redef fun return_is_mandatory
do return false
1097 redef fun min_arity
do return 2
1098 redef fun is_binary
do return false
1101 redef class AAssignMethid
1102 redef fun return_is_mandatory
do return false
1103 redef fun is_binary
do return false
1106 redef class AAttrPropdef
1107 redef type MPROPDEF: MAttributeDef
1109 # Is the node tagged `noinit`?
1112 # Is the node tagged lazy?
1115 # Has the node a default value?
1116 # Could be through `n_expr` or `n_block`
1117 var has_value
= false
1119 # The guard associated to a lazy attribute.
1120 # Because some engines does not have a working `isset`,
1121 # this additional attribute is used to guard the lazy initialization.
1122 # TODO: to remove once isset is correctly implemented
1123 var mlazypropdef
: nullable MAttributeDef
1125 # The associated getter (read accessor) if any
1126 var mreadpropdef
: nullable MMethodDef is writable
1127 # The associated setter (write accessor) if any
1128 var mwritepropdef
: nullable MMethodDef is writable
1130 redef fun build_property
(modelbuilder
, mclassdef
)
1132 var mclass
= mclassdef
.mclass
1134 var name
= nid2
.text
1136 var atabstract
= self.get_single_annotation
("abstract", modelbuilder
)
1137 if atabstract
== null then
1138 if not mclass
.kind
.need_init
then
1139 modelbuilder
.error
(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1142 var mprop
= new MAttribute(mclassdef
, "_" + name
, private_visibility
)
1143 var mpropdef
= new MAttributeDef(mclassdef
, mprop
, self.location
)
1144 self.mpropdef
= mpropdef
1145 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1149 var mreadprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, readname
).as(nullable MMethod)
1150 if mreadprop
== null then
1151 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1152 mreadprop
= new MMethod(mclassdef
, readname
, mvisibility
)
1153 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, false, mreadprop
) then return
1155 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, n_kwredef
, true, mreadprop
) then return
1156 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mreadprop
)
1158 mclassdef
.mprop2npropdef
[mreadprop
] = self
1160 var mreadpropdef
= new MMethodDef(mclassdef
, mreadprop
, self.location
)
1161 self.mreadpropdef
= mreadpropdef
1162 modelbuilder
.mpropdef2npropdef
[mreadpropdef
] = self
1163 set_doc
(mreadpropdef
, modelbuilder
)
1164 if mpropdef
!= null then mpropdef
.mdoc
= mreadpropdef
.mdoc
1165 if atabstract
!= null then mreadpropdef
.is_abstract
= true
1167 has_value
= n_expr
!= null or n_block
!= null
1169 if atabstract
!= null and has_value
then
1170 modelbuilder
.error
(atabstract
, "Error: `abstract` attributes cannot have an initial value.")
1174 var atnoinit
= self.get_single_annotation
("noinit", modelbuilder
)
1175 if atnoinit
== null then atnoinit
= self.get_single_annotation
("noautoinit", modelbuilder
)
1176 if atnoinit
!= null then
1179 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot have an initial value.")
1182 if atabstract
!= null then
1183 modelbuilder
.error
(atnoinit
, "Error: `noautoinit` attributes cannot be abstract.")
1188 var atlazy
= self.get_single_annotation
("lazy", modelbuilder
)
1189 var atautoinit
= self.get_single_annotation
("autoinit", modelbuilder
)
1190 if atlazy
!= null or atautoinit
!= null then
1191 if atlazy
!= null and atautoinit
!= null then
1192 modelbuilder
.error
(atlazy
, "Error: `lazy` incompatible with `autoinit`.")
1195 if not has_value
then
1196 if atlazy
!= null then
1197 modelbuilder
.error
(atlazy
, "Error: `lazy` attributes need a value.")
1198 else if atautoinit
!= null then
1199 modelbuilder
.error
(atautoinit
, "Error: `autoinit` attributes need a value.")
1205 var mlazyprop
= new MAttribute(mclassdef
, "lazy _" + name
, none_visibility
)
1206 var mlazypropdef
= new MAttributeDef(mclassdef
, mlazyprop
, self.location
)
1207 self.mlazypropdef
= mlazypropdef
1210 var atreadonly
= self.get_single_annotation
("readonly", modelbuilder
)
1211 if atreadonly
!= null then
1212 if not has_value
then
1213 modelbuilder
.error
(atreadonly
, "Error: `readonly` attributes need a value.")
1215 # No setter, so just leave
1219 var writename
= name
+ "="
1220 var atwritable
= self.get_single_annotation
("writable", modelbuilder
)
1221 if atwritable
!= null then
1222 if not atwritable
.n_args
.is_empty
then
1223 writename
= atwritable
.arg_as_id
(modelbuilder
) or else writename
1226 var mwriteprop
= modelbuilder
.try_get_mproperty_by_name
(nid2
, mclassdef
, writename
).as(nullable MMethod)
1227 var nwkwredef
: nullable Token = null
1228 if atwritable
!= null then nwkwredef
= atwritable
.n_kwredef
1229 if mwriteprop
== null then
1231 if atwritable
!= null then
1232 mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, atwritable
.n_visibility
)
1234 mvisibility
= private_visibility
1236 mwriteprop
= new MMethod(mclassdef
, writename
, mvisibility
)
1237 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
, false, mwriteprop
) then return
1238 mwriteprop
.deprecation
= mreadprop
.deprecation
1240 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, nwkwredef
or else n_kwredef
, true, mwriteprop
) then return
1241 if atwritable
!= null then
1242 check_redef_property_visibility
(modelbuilder
, atwritable
.n_visibility
, mwriteprop
)
1245 mclassdef
.mprop2npropdef
[mwriteprop
] = self
1247 var mwritepropdef
= new MMethodDef(mclassdef
, mwriteprop
, self.location
)
1248 self.mwritepropdef
= mwritepropdef
1249 modelbuilder
.mpropdef2npropdef
[mwritepropdef
] = self
1250 mwritepropdef
.mdoc
= mreadpropdef
.mdoc
1251 if atabstract
!= null then mwritepropdef
.is_abstract
= true
1254 redef fun build_signature
(modelbuilder
)
1256 var mreadpropdef
= self.mreadpropdef
1257 var mpropdef
= self.mpropdef
1258 if mreadpropdef
== null then return # Error thus skipped
1259 var mclassdef
= mreadpropdef
.mclassdef
1260 var mmodule
= mclassdef
.mmodule
1261 var mtype
: nullable MType = null
1264 var ntype
= self.n_type
1265 if ntype
!= null then
1266 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1267 if mtype
== null then return
1270 var inherited_type
: nullable MType = null
1271 # Inherit the type from the getter (usually an abstract getter)
1272 if not mreadpropdef
.is_intro
then
1273 var msignature
= mreadpropdef
.mproperty
.intro
.msignature
1274 if msignature
== null then return # Error, thus skipped
1275 inherited_type
= msignature
.return_mtype
1276 if inherited_type
!= null then
1277 # The inherited type is adapted to use the local formal types, if any.
1278 inherited_type
= inherited_type
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
1279 if mtype
== null then mtype
= inherited_type
1283 var nexpr
= self.n_expr
1284 if mtype
== null then
1285 if nexpr
!= null then
1286 if nexpr
isa ANewExpr then
1287 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1288 else if nexpr
isa AIntExpr then
1289 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Int")
1290 if cla
!= null then mtype
= cla
.mclass_type
1291 else if nexpr
isa AFloatExpr then
1292 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Float")
1293 if cla
!= null then mtype
= cla
.mclass_type
1294 else if nexpr
isa ACharExpr then
1295 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Char")
1296 if cla
!= null then mtype
= cla
.mclass_type
1297 else if nexpr
isa ABoolExpr then
1298 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "Bool")
1299 if cla
!= null then mtype
= cla
.mclass_type
1300 else if nexpr
isa ASuperstringExpr then
1301 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1302 if cla
!= null then mtype
= cla
.mclass_type
1303 else if nexpr
isa AStringFormExpr then
1304 var cla
= modelbuilder
.try_get_mclass_by_name
(nexpr
, mmodule
, "String")
1305 if cla
!= null then mtype
= cla
.mclass_type
1307 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1310 if mtype
== null then return
1312 else if ntype
!= null and inherited_type
== mtype
then
1313 if nexpr
isa ANewExpr then
1314 var xmtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, nexpr
.n_type
, true)
1315 if xmtype
== mtype
then
1316 modelbuilder
.advice
(ntype
, "useless-type", "Warning: useless type definition")
1321 if mtype
== null then
1322 modelbuilder
.error
(self, "Error: untyped attribute `{mreadpropdef}`.")
1326 if mpropdef
!= null then
1327 mpropdef
.static_mtype
= mtype
1331 var msignature
= new MSignature(new Array[MParameter], mtype
)
1332 mreadpropdef
.msignature
= msignature
1335 var mwritepropdef
= self.mwritepropdef
1336 if mwritepropdef
!= null then
1339 var mparameter
= new MParameter(name
, mtype
, false, false)
1340 var msignature
= new MSignature([mparameter
], null)
1341 mwritepropdef
.msignature
= msignature
1344 var mlazypropdef
= self.mlazypropdef
1345 if mlazypropdef
!= null then
1346 mlazypropdef
.static_mtype
= modelbuilder
.model
.get_mclasses_by_name
("Bool").first
.mclass_type
1350 redef fun check_signature
(modelbuilder
)
1352 var mpropdef
= self.mpropdef
1353 if mpropdef
== null then return # Error thus skipped
1354 var ntype
= self.n_type
1355 var mtype
= self.mpropdef
.static_mtype
1356 if mtype
== null then return # Error thus skipped
1358 var mclassdef
= mpropdef
.mclassdef
1359 var mmodule
= mclassdef
.mmodule
1362 if ntype
!= null then
1363 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then return
1366 if nexpr
isa ANewExpr then
1367 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, nexpr
.n_type
) == null then return
1370 # Lookup for signature in the precursor
1371 # FIXME all precursors should be considered
1372 if not mpropdef
.is_intro
then
1373 var precursor_type
= mpropdef
.mproperty
.intro
.static_mtype
1374 if precursor_type
== null then return
1376 if mtype
!= precursor_type
then
1377 modelbuilder
.error
(ntype
.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1382 # Check getter and setter
1383 var meth
= self.mreadpropdef
1384 if meth
!= null then
1385 self.check_method_signature
(modelbuilder
, meth
)
1386 var node
: nullable ANode = ntype
1387 if node
== null then node
= self
1388 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1390 meth
= self.mwritepropdef
1391 if meth
!= null then
1392 self.check_method_signature
(modelbuilder
, meth
)
1393 var node
: nullable ANode = ntype
1394 if node
== null then node
= self
1395 modelbuilder
.check_visibility
(node
, mtype
, meth
)
1399 private fun check_method_signature
(modelbuilder
: ModelBuilder, mpropdef
: MMethodDef)
1401 var mclassdef
= mpropdef
.mclassdef
1402 var mmodule
= mclassdef
.mmodule
1403 var nsig
= self.n_type
1404 var mysignature
= mpropdef
.msignature
1405 if mysignature
== null then return # Error thus skiped
1407 # Lookup for signature in the precursor
1408 # FIXME all precursors should be considered
1409 if not mpropdef
.is_intro
then
1410 var msignature
= mpropdef
.mproperty
.intro
.msignature
1411 if msignature
== null then return
1413 if mysignature
.arity
!= msignature
.arity
then
1415 if nsig
!= null then node
= nsig
else node
= self
1416 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}`.")
1419 var precursor_ret_type
= msignature
.return_mtype
1420 var ret_type
= mysignature
.return_mtype
1421 if ret_type
!= null and precursor_ret_type
== null then
1423 if nsig
!= null then node
= nsig
else node
= self
1424 modelbuilder
.error
(node
, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1428 if mysignature
.arity
> 0 then
1429 # Check parameters types
1430 for i
in [0..mysignature
.arity
[ do
1431 var myt
= mysignature
.mparameters
[i
].mtype
1432 var prt
= msignature
.mparameters
[i
].mtype
1434 if nsig
!= null then node
= nsig
else node
= self
1435 if not modelbuilder
.check_sametype
(node
, mmodule
, mclassdef
.bound_mtype
, myt
, prt
) then
1436 modelbuilder
.error
(node
, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1440 if precursor_ret_type
!= null then
1442 if nsig
!= null then node
= nsig
else node
= self
1443 if ret_type
== null then
1444 # Inherit the return type
1445 ret_type
= precursor_ret_type
1446 else if not modelbuilder
.check_subtype
(node
, mmodule
, mclassdef
.bound_mtype
, ret_type
, precursor_ret_type
) then
1447 modelbuilder
.error
(node
, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1454 redef class ATypePropdef
1455 redef type MPROPDEF: MVirtualTypeDef
1457 redef fun build_property
(modelbuilder
, mclassdef
)
1459 var name
= self.n_id
.text
1460 var mprop
= modelbuilder
.try_get_mproperty_by_name
(self.n_id
, mclassdef
, name
)
1461 if mprop
== null then
1462 var mvisibility
= new_property_visibility
(modelbuilder
, mclassdef
, self.n_visibility
)
1463 mprop
= new MVirtualTypeProp(mclassdef
, name
, mvisibility
)
1464 for c
in name
.chars
do if c
>= 'a' and c
<= 'z' then
1465 modelbuilder
.warning
(n_id
, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1468 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, false, mprop
) then return
1470 if not self.check_redef_keyword
(modelbuilder
, mclassdef
, self.n_kwredef
, true, mprop
) then return
1471 assert mprop
isa MVirtualTypeProp
1472 check_redef_property_visibility
(modelbuilder
, self.n_visibility
, mprop
)
1474 mclassdef
.mprop2npropdef
[mprop
] = self
1476 var mpropdef
= new MVirtualTypeDef(mclassdef
, mprop
, self.location
)
1477 self.mpropdef
= mpropdef
1478 modelbuilder
.mpropdef2npropdef
[mpropdef
] = self
1479 if mpropdef
.is_intro
then
1480 modelbuilder
.toolcontext
.info
("{mpropdef} introduces new type {mprop.full_name}", 4)
1482 modelbuilder
.toolcontext
.info
("{mpropdef} redefines type {mprop.full_name}", 4)
1484 set_doc
(mpropdef
, modelbuilder
)
1486 var atfixed
= get_single_annotation
("fixed", modelbuilder
)
1487 if atfixed
!= null then
1488 mpropdef
.is_fixed
= true
1492 redef fun build_signature
(modelbuilder
)
1494 var mpropdef
= self.mpropdef
1495 if mpropdef
== null then return # Error thus skipped
1496 var mclassdef
= mpropdef
.mclassdef
1497 var mmodule
= mclassdef
.mmodule
1498 var mtype
: nullable MType = null
1500 var ntype
= self.n_type
1501 mtype
= modelbuilder
.resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, true)
1502 if mtype
== null then return
1504 mpropdef
.bound
= mtype
1505 # print "{mpropdef}: {mtype}"
1508 redef fun check_signature
(modelbuilder
)
1510 var mpropdef
= self.mpropdef
1511 if mpropdef
== null then return # Error thus skipped
1513 var bound
= mpropdef
.bound
1514 if bound
== null then return # Error thus skipped
1516 modelbuilder
.check_visibility
(n_type
, bound
, mpropdef
)
1518 var mclassdef
= mpropdef
.mclassdef
1519 var mmodule
= mclassdef
.mmodule
1520 var anchor
= mclassdef
.bound_mtype
1522 var ntype
= self.n_type
1523 if modelbuilder
.resolve_mtype
(mmodule
, mclassdef
, ntype
) == null then
1524 mpropdef
.bound
= null
1528 # Check redefinitions
1529 for p
in mpropdef
.mproperty
.lookup_super_definitions
(mmodule
, anchor
) do
1530 var supbound
= p
.bound
1531 if supbound
== null then break # broken super bound, skip error
1533 modelbuilder
.error
(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1536 if p
.mclassdef
.mclass
== mclassdef
.mclass
then
1537 # Still a warning to pass existing bad code
1538 modelbuilder
.warning
(n_type
, "refine-type", "Redef Error: a virtual type cannot be refined.")
1541 if not modelbuilder
.check_subtype
(n_type
, mmodule
, anchor
, bound
, supbound
) then
1542 modelbuilder
.error
(n_type
, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")