various phases: more robust for keep-going
[nit.git] / src / modelize / modelize_property.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2012 Jean Privat <jean@pryen.org>
4 #
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
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
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.
16
17 # Analysis and verification of property definitions to instantiate model element
18 module modelize_property
19
20 intrude import modelize_class
21 private import annotation
22
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])
26 end
27
28 private class ModelizePropertyPhase
29 super Phase
30 redef fun process_nmodule(nmodule)
31 do
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)
35 end
36 end
37 end
38
39 redef class ModelBuilder
40 # Registration of the npropdef associated to each mpropdef.
41 #
42 # Public clients need to use `mpropdef2node` to access stuff.
43 private var mpropdef2npropdef = new HashMap[MPropDef, APropdef]
44
45 # Retrieve the associated AST node of a mpropertydef.
46 # This method is used to associate model entity with syntactic entities.
47 #
48 # If the property definition is not associated with a node, returns `null`.
49 fun mpropdef2node(mpropdef: MPropDef): nullable ANode
50 do
51 var res
52 res = mpropdef2npropdef.get_or_null(mpropdef)
53 if res != null then
54 # Run the phases on it
55 toolcontext.run_phases_on_npropdef(res)
56 return res
57 end
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
61 end
62 return null
63 end
64
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]
68 do
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)
76 res.add(npropdef)
77 end
78 end
79 return res
80 end
81
82 # Build the properties of `nclassdef`.
83 # REQUIRE: all superclasses are built.
84 private fun build_properties(nclassdef: AClassdef)
85 do
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])
95 end
96
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)
101 end
102 for npropdef in nclassdef2.n_propdefs do
103 npropdef.build_signature(self)
104 end
105 for npropdef in nclassdef2.n_propdefs do
106 npropdef.check_signature(self)
107 end
108 end
109 process_default_constructors(nclassdef)
110 end
111
112 # the root init of the Object class
113 # Is usually implicitly defined
114 # Then explicit or implicit definitions of root-init are attached to it
115 var the_root_init_mmethod: nullable MMethod
116
117 # Introduce or inherit default constructor
118 # This is the last part of `build_properties`.
119 private fun process_default_constructors(nclassdef: AClassdef)
120 do
121 var mclassdef = nclassdef.mclassdef.as(not null)
122
123 # Are we a refinement
124 if not mclassdef.is_intro then return
125
126 # Look for the init in Object, or create it
127 if mclassdef.mclass.name == "Object" and the_root_init_mmethod == null then
128 # Create the implicit root-init method
129 var mprop = new MMethod(mclassdef, "init", mclassdef.mclass.visibility)
130 mprop.is_root_init = true
131 var mpropdef = new MMethodDef(mclassdef, mprop, nclassdef.location)
132 var mparameters = new Array[MParameter]
133 var msignature = new MSignature(mparameters, null)
134 mpropdef.msignature = msignature
135 mpropdef.new_msignature = msignature
136 mprop.is_init = true
137 nclassdef.mfree_init = mpropdef
138 self.toolcontext.info("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
139 the_root_init_mmethod = mprop
140 return
141 end
142
143 # Is the class forbid constructors?
144 if not mclassdef.mclass.kind.need_init then return
145
146 # Is there already a constructor defined?
147 var defined_init: nullable MMethodDef = null
148 for mpropdef in mclassdef.mpropdefs do
149 if not mpropdef isa MMethodDef then continue
150 if not mpropdef.mproperty.is_init then continue
151 if mpropdef.mproperty.is_root_init then
152 assert defined_init == null
153 defined_init = mpropdef
154 else if mpropdef.mproperty.name == "init" then
155 # An explicit old-style init named "init", so return
156 return
157 end
158 end
159
160 if not nclassdef isa AStdClassdef then return
161
162 # Collect undefined attributes
163 var mparameters = new Array[MParameter]
164 var initializers = new Array[MProperty]
165 for npropdef in nclassdef.n_propdefs do
166 if npropdef isa AMethPropdef then
167 if npropdef.mpropdef == null then return # Skip broken attribute
168 var at = npropdef.get_single_annotation("autoinit", self)
169 if at == null then continue # Skip non tagged init
170
171 var sig = npropdef.mpropdef.msignature
172 if sig == null then continue # Skip broken method
173
174 if not npropdef.mpropdef.is_intro then
175 self.error(at, "Error: `autoinit` cannot be set on redefinitions")
176 continue
177 end
178
179 for param in sig.mparameters do
180 var ret_type = param.mtype
181 var mparameter = new MParameter(param.name, ret_type, false)
182 mparameters.add(mparameter)
183 end
184 initializers.add(npropdef.mpropdef.mproperty)
185 npropdef.mpropdef.mproperty.is_autoinit = true
186 end
187 if npropdef isa AAttrPropdef then
188 if npropdef.mpropdef == null then return # Skip broken attribute
189 if npropdef.noinit then continue # Skip noinit attribute
190 var atautoinit = npropdef.get_single_annotation("autoinit", self)
191 if atautoinit != null then
192 # For autoinit attributes, call the reader to force
193 # the lazy initialization of the attribute.
194 initializers.add(npropdef.mreadpropdef.mproperty)
195 npropdef.mreadpropdef.mproperty.is_autoinit = true
196 continue
197 end
198 if npropdef.has_value then continue
199 var paramname = npropdef.mpropdef.mproperty.name.substring_from(1)
200 var ret_type = npropdef.mpropdef.static_mtype
201 if ret_type == null then return
202 var mparameter = new MParameter(paramname, ret_type, false)
203 mparameters.add(mparameter)
204 var msetter = npropdef.mwritepropdef
205 if msetter == null then
206 # No setter, it is a old-style attribute, so just add it
207 initializers.add(npropdef.mpropdef.mproperty)
208 npropdef.mpropdef.mproperty.is_autoinit = true
209 else
210 # Add the setter to the list
211 initializers.add(msetter.mproperty)
212 msetter.mproperty.is_autoinit = true
213 end
214 end
215 end
216
217 if the_root_init_mmethod == null then return
218
219 # Look for most-specific new-stype init definitions
220 var spropdefs = the_root_init_mmethod.lookup_super_definitions(mclassdef.mmodule, mclassdef.bound_mtype)
221 if spropdefs.is_empty then
222 toolcontext.error(nclassdef.location, "Error: {mclassdef} does not specialize {the_root_init_mmethod.intro_mclassdef}. Possible duplication of the root class `Object`?")
223 return
224 end
225
226 # Look at the autoinit class-annotation
227 var autoinit = nclassdef.get_single_annotation("autoinit", self)
228 var noautoinit = nclassdef.get_single_annotation("noautoinit", self)
229 if autoinit != null then
230 # Just throws the collected initializers
231 mparameters.clear
232 initializers.clear
233
234 if noautoinit != null then
235 error(autoinit, "Error: `autoinit` and `noautoinit` are incompatible.")
236 end
237
238 if autoinit.n_args.is_empty then
239 error(autoinit, "Syntax error: `autoinit` expects method identifiers, use `noautoinit` to clear all autoinits.")
240 end
241
242 # Get and check each argument
243 for narg in autoinit.n_args do
244 var id = narg.as_id
245 if id == null then
246 error(narg, "Syntax error: `autoinit` expects method identifiers.")
247 return
248 end
249
250 # Search the property.
251 # To avoid bad surprises, try to get the setter first.
252 var p = try_get_mproperty_by_name(narg, mclassdef, id + "=")
253 if p == null then
254 p = try_get_mproperty_by_name(narg, mclassdef, id)
255 end
256 if p == null then
257 error(narg, "Error: unknown method `{id}`")
258 return
259 end
260 if not p.is_autoinit then
261 error(narg, "Error: `{p}` is not an autoinit method")
262 return
263 end
264
265 # Register the initializer and the parameters
266 initializers.add(p)
267 var pd = p.intro
268 if pd isa MMethodDef then
269 # Get the signature resolved for the current receiver
270 var sig = pd.msignature.resolve_for(mclassdef.mclass.mclass_type, mclassdef.bound_mtype, mclassdef.mmodule, false)
271 mparameters.add_all sig.mparameters
272 else
273 # TODO attributes?
274 abort
275 end
276 end
277 else if noautoinit != null then
278 if initializers.is_empty then
279 warning(noautoinit, "useless-noautoinit", "Warning: the list of autoinit is already empty.")
280 end
281 # Just clear initializers
282 mparameters.clear
283 initializers.clear
284 else
285 # Search the longest-one and checks for conflict
286 var longest = spropdefs.first
287 if spropdefs.length > 1 then
288 # Check for conflict in the order of initializers
289 # Each initializer list must me a prefix of the longest list
290 # part 1. find the longest list
291 for spd in spropdefs do
292 if spd.initializers.length > longest.initializers.length then longest = spd
293 end
294 # part 2. compare
295 for spd in spropdefs do
296 var i = 0
297 for p in spd.initializers do
298 if p != longest.initializers[i] then
299 self.error(nclassdef, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
300 return
301 end
302 i += 1
303 end
304 end
305 end
306
307 # Can we just inherit?
308 if spropdefs.length == 1 and mparameters.is_empty and defined_init == null then
309 self.toolcontext.info("{mclassdef} inherits the basic constructor {longest}", 3)
310 mclassdef.mclass.root_init = longest
311 return
312 end
313
314 # Combine the inherited list to what is collected
315 if longest.initializers.length > 0 then
316 mparameters.prepend longest.new_msignature.mparameters
317 initializers.prepend longest.initializers
318 end
319 end
320
321 # If we already have a basic init definition, then setup its initializers
322 if defined_init != null then
323 defined_init.initializers.add_all(initializers)
324 var msignature = new MSignature(mparameters, null)
325 defined_init.new_msignature = msignature
326 self.toolcontext.info("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
327 mclassdef.mclass.root_init = defined_init
328 return
329 end
330
331 # Else create the local implicit basic init definition
332 var mprop = the_root_init_mmethod.as(not null)
333 var mpropdef = new MMethodDef(mclassdef, mprop, nclassdef.location)
334 mpropdef.has_supercall = true
335 mpropdef.initializers.add_all(initializers)
336 var msignature = new MSignature(mparameters, null)
337 mpropdef.new_msignature = msignature
338 mpropdef.msignature = new MSignature(new Array[MParameter], null) # always an empty real signature
339 nclassdef.mfree_init = mpropdef
340 self.toolcontext.info("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
341 mclassdef.mclass.root_init = mpropdef
342 end
343
344 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
345 fun check_visibility(node: ANode, mtype: MType, mpropdef: MPropDef)
346 do
347 var mmodule = mpropdef.mclassdef.mmodule
348 var mproperty = mpropdef.mproperty
349
350 # Extract visibility information of the main part of `mtype`
351 # It is a case-by case
352 var vis_type: nullable MVisibility = null # The own visibility of the type
353 var mmodule_type: nullable MModule = null # The original module of the type
354 mtype = mtype.as_notnullable
355 if mtype isa MClassType then
356 vis_type = mtype.mclass.visibility
357 mmodule_type = mtype.mclass.intro.mmodule
358 else if mtype isa MVirtualType then
359 vis_type = mtype.mproperty.visibility
360 mmodule_type = mtype.mproperty.intro_mclassdef.mmodule
361 else if mtype isa MParameterType then
362 # nothing, always visible
363 else
364 node.debug "Unexpected type {mtype}"
365 abort
366 end
367
368 if vis_type != null then
369 assert mmodule_type != null
370 var vis_module_type = mmodule.visibility_for(mmodule_type) # the visibility of the original module
371 if mproperty.visibility > vis_type then
372 error(node, "Error: The {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`")
373 return
374 else if mproperty.visibility > vis_module_type then
375 error(node, "Error: The {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`")
376 return
377 end
378 end
379
380 # No error, try to go deeper in generic types
381 if node isa AType then
382 for a in node.n_types do
383 var t = a.mtype
384 if t == null then continue # Error, thus skipped
385 check_visibility(a, t, mpropdef)
386 end
387 else if mtype isa MGenericType then
388 for t in mtype.arguments do check_visibility(node, t, mpropdef)
389 end
390 end
391 end
392
393 redef class MPropDef
394 # Does the MPropDef contains a call to super or a call of a super-constructor?
395 # Subsequent phases of the frontend (esp. typing) set it if required
396 var has_supercall: Bool = false is writable
397 end
398
399 redef class AClassdef
400 # Marker used in `ModelBuilder::build_properties`
401 private var build_properties_is_done = false
402
403 # The free init (implicitely constructed by the class if required)
404 var mfree_init: nullable MMethodDef = null
405 end
406
407 redef class MClass
408 # The base init of the class.
409 # Used to get the common new_msignature and initializers
410 #
411 # TODO: Where to put this information is not clear because unlike other
412 # informations, the initialisers are stable in a same class.
413 var root_init: nullable MMethodDef = null
414 end
415
416 redef class MClassDef
417 # What is the `APropdef` associated to a `MProperty`?
418 # Used to check multiple definition of a property.
419 var mprop2npropdef: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
420
421 # Build the virtual type `SELF` only for introduction `MClassDef`
422 fun build_self_type(modelbuilder: ModelBuilder, nclassdef: AClassdef)
423 do
424 if not is_intro then return
425
426 var name = "SELF"
427 var mprop = modelbuilder.try_get_mproperty_by_name(nclassdef, self, name)
428
429 # If SELF type is declared nowherer?
430 if mprop == null then return
431
432 # SELF is not a virtual type? it is weird but we ignore it
433 if not mprop isa MVirtualTypeProp then return
434
435 # Is this the intro of SELF in the library?
436 var intro = mprop.intro
437 var intro_mclassdef = intro.mclassdef
438 if intro_mclassdef == self then
439 var nintro = modelbuilder.mpropdef2npropdef[intro]
440
441 # SELF must be declared in Object, otherwise this will create conflicts
442 if intro_mclassdef.mclass.name != "Object" then
443 modelbuilder.error(nintro, "Error: the virtual type SELF must be declared in Object.")
444 end
445
446 # SELF must be public
447 if mprop.visibility != public_visibility then
448 modelbuilder.error(nintro, "Error: the virtual type SELF must be public.")
449 end
450
451 # SELF must not be fixed
452 if intro.is_fixed then
453 modelbuilder.error(nintro, "Error: the virtual type SELF cannot be fixed.")
454 end
455
456 return
457 end
458
459 # This class introduction inherits a SELF
460 # We insert an artificial property to update it
461 var mpropdef = new MVirtualTypeDef(self, mprop, self.location)
462 mpropdef.bound = mclass.mclass_type
463 end
464 end
465
466 redef class APropdef
467 # The associated main model entity
468 type MPROPDEF: MPropDef
469
470 # The associated propdef once build by a `ModelBuilder`
471 var mpropdef: nullable MPROPDEF is writable
472
473 private fun build_property(modelbuilder: ModelBuilder, mclassdef: MClassDef) do end
474 private fun build_signature(modelbuilder: ModelBuilder) do end
475 private fun check_signature(modelbuilder: ModelBuilder) do end
476 private fun new_property_visibility(modelbuilder: ModelBuilder, mclassdef: MClassDef, nvisibility: nullable AVisibility): MVisibility
477 do
478 var mvisibility = public_visibility
479 if nvisibility != null then
480 mvisibility = nvisibility.mvisibility
481 if mvisibility == intrude_visibility then
482 modelbuilder.error(nvisibility, "Error: intrude is not a legal visibility for properties.")
483 mvisibility = public_visibility
484 end
485 end
486 if mclassdef.mclass.visibility == private_visibility then
487 if mvisibility == protected_visibility then
488 assert nvisibility != null
489 modelbuilder.error(nvisibility, "Error: The only legal visibility for properties in a private class is private.")
490 else if mvisibility == private_visibility then
491 assert nvisibility != null
492 modelbuilder.advice(nvisibility, "useless-visibility", "Warning: private is superfluous since the only legal visibility for properties in a private class is private.")
493 end
494 mvisibility = private_visibility
495 end
496 return mvisibility
497 end
498
499 private fun set_doc(mpropdef: MPropDef, modelbuilder: ModelBuilder)
500 do
501 var ndoc = self.n_doc
502 if ndoc != null then
503 var mdoc = ndoc.to_mdoc
504 mpropdef.mdoc = mdoc
505 mdoc.original_mentity = mpropdef
506 else if mpropdef.is_intro and mpropdef.mproperty.visibility >= protected_visibility then
507 modelbuilder.advice(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
508 end
509
510 var at_deprecated = get_single_annotation("deprecated", modelbuilder)
511 if at_deprecated != null then
512 if not mpropdef.is_intro then
513 modelbuilder.error(self, "Error: method redefinition cannot be deprecated.")
514 else
515 var info = new MDeprecationInfo
516 ndoc = at_deprecated.n_doc
517 if ndoc != null then info.mdoc = ndoc.to_mdoc
518 mpropdef.mproperty.deprecation = info
519 end
520 end
521 end
522
523 private fun check_redef_property_visibility(modelbuilder: ModelBuilder, nvisibility: nullable AVisibility, mprop: MProperty)
524 do
525 if nvisibility == null then return
526 var mvisibility = nvisibility.mvisibility
527 if mvisibility != mprop.visibility and mvisibility != public_visibility then
528 modelbuilder.error(nvisibility, "Error: redefinition changed the visibility from a {mprop.visibility} to a {mvisibility}")
529 end
530 end
531
532 private fun check_redef_keyword(modelbuilder: ModelBuilder, mclassdef: MClassDef, kwredef: nullable Token, need_redef: Bool, mprop: MProperty): Bool
533 do
534 if mclassdef.mprop2npropdef.has_key(mprop) then
535 modelbuilder.error(self, "Error: A property {mprop} is already defined in class {mclassdef.mclass} at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
536 return false
537 end
538 if mprop isa MMethod and mprop.is_toplevel != (parent isa ATopClassdef) then
539 if mprop.is_toplevel then
540 modelbuilder.error(self, "Error: {mprop} is a top level method.")
541 else
542 modelbuilder.error(self, "Error: {mprop} is not a top level method.")
543 end
544 return false
545
546 end
547 if mprop isa MMethod and mprop.is_root_init then return true
548 if kwredef == null then
549 if need_redef then
550 modelbuilder.error(self, "Redef error: {mclassdef.mclass}::{mprop.name} is an inherited property. To redefine it, add the redef keyword.")
551 return false
552 end
553
554 # Check for full-name conflicts in the project.
555 # A public property should have a unique qualified name `project::class::prop`.
556 if mprop.intro_mclassdef.mmodule.mgroup != null and mprop.visibility >= protected_visibility then
557 var others = modelbuilder.model.get_mproperties_by_name(mprop.name)
558 if others != null then for other in others do
559 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
560 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}`.")
561 break
562 end
563 end
564 end
565 else
566 if not need_redef then
567 modelbuilder.error(self, "Error: No property {mclassdef.mclass}::{mprop.name} is inherited. Remove the redef keyword to define a new property.")
568 return false
569 end
570 end
571 return true
572 end
573
574 end
575
576 redef class ASignature
577 # Is the model builder has correctly visited the signature
578 var is_visited = false
579 # Names of parameters from the AST
580 # REQUIRE: is_visited
581 var param_names = new Array[String]
582 # Types of parameters from the AST
583 # REQUIRE: is_visited
584 var param_types = new Array[MType]
585 # Rank of the vararg (of -1 if none)
586 # REQUIRE: is_visited
587 var vararg_rank: Int = -1
588 # Return type
589 var ret_type: nullable MType = null
590
591 # Visit and fill information about a signature
592 private fun visit_signature(modelbuilder: ModelBuilder, mclassdef: MClassDef): Bool
593 do
594 var mmodule = mclassdef.mmodule
595 var param_names = self.param_names
596 var param_types = self.param_types
597 for np in self.n_params do
598 param_names.add(np.n_id.text)
599 var ntype = np.n_type
600 if ntype != null then
601 var mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
602 if mtype == null then return false # Skip error
603 for i in [0..param_names.length-param_types.length[ do
604 param_types.add(mtype)
605 end
606 if np.n_dotdotdot != null then
607 if self.vararg_rank != -1 then
608 modelbuilder.error(np, "Error: {param_names[self.vararg_rank]} is already a vararg")
609 return false
610 else
611 self.vararg_rank = param_names.length - 1
612 end
613 end
614 end
615 end
616 var ntype = self.n_type
617 if ntype != null then
618 self.ret_type = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
619 if self.ret_type == null then return false # Skip error
620 end
621
622 self.is_visited = true
623 return true
624 end
625
626 # Build a visited signature
627 fun build_signature(modelbuilder: ModelBuilder): nullable MSignature
628 do
629 if param_names.length != param_types.length then
630 # Some parameters are typed, other parameters are not typed.
631 modelbuilder.error(self.n_params[param_types.length], "Error: Untyped parameter `{param_names[param_types.length]}'.")
632 return null
633 end
634
635 var mparameters = new Array[MParameter]
636 for i in [0..param_names.length[ do
637 var mparameter = new MParameter(param_names[i], param_types[i], i == vararg_rank)
638 self.n_params[i].mparameter = mparameter
639 mparameters.add(mparameter)
640 end
641
642 var msignature = new MSignature(mparameters, ret_type)
643 return msignature
644 end
645 end
646
647 redef class AParam
648 # The associated mparameter if any
649 var mparameter: nullable MParameter = null
650 end
651
652 redef class AMethPropdef
653 redef type MPROPDEF: MMethodDef
654
655
656 # Can self be used as a root init?
657 private fun look_like_a_root_init(modelbuilder: ModelBuilder, mclassdef: MClassDef): Bool
658 do
659 # Need the `init` keyword
660 if n_kwinit == null then return false
661 # Need to by anonymous
662 if self.n_methid != null then return false
663 # No annotation on itself
664 if get_single_annotation("old_style_init", modelbuilder) != null then return false
665 # Nor on its module
666 var amod = self.parent.parent.as(AModule)
667 var amoddecl = amod.n_moduledecl
668 if amoddecl != null then
669 var old = amoddecl.get_single_annotation("old_style_init", modelbuilder)
670 if old != null then return false
671 end
672 # No parameters
673 if self.n_signature.n_params.length > 0 then
674 modelbuilder.advice(self, "old-init", "Warning: init with signature in {mclassdef}")
675 return false
676 end
677 # Cannot be private or something
678 if not self.n_visibility isa APublicVisibility then
679 modelbuilder.advice(self, "old-init", "Warning: non-public init in {mclassdef}")
680 return false
681 end
682
683 return true
684 end
685
686 redef fun build_property(modelbuilder, mclassdef)
687 do
688 var n_kwinit = n_kwinit
689 var n_kwnew = n_kwnew
690 var is_init = n_kwinit != null or n_kwnew != null
691 var name: String
692 var amethodid = self.n_methid
693 var name_node: ANode
694 if amethodid == null then
695 if not is_init then
696 name = "main"
697 name_node = self
698 else if n_kwinit != null then
699 name = "init"
700 name_node = n_kwinit
701 else if n_kwnew != null then
702 name = "new"
703 name_node = n_kwnew
704 else
705 abort
706 end
707 else if amethodid isa AIdMethid then
708 name = amethodid.n_id.text
709 name_node = amethodid
710 else
711 # operator, bracket or assign
712 name = amethodid.collect_text
713 name_node = amethodid
714
715 if name == "-" and self.n_signature.n_params.length == 0 then
716 name = "unary -"
717 end
718 end
719
720 var look_like_a_root_init = look_like_a_root_init(modelbuilder, mclassdef)
721 var mprop: nullable MMethod = null
722 if not is_init or n_kwredef != null then mprop = modelbuilder.try_get_mproperty_by_name(name_node, mclassdef, name).as(nullable MMethod)
723 if mprop == null and look_like_a_root_init then
724 mprop = modelbuilder.the_root_init_mmethod
725 var nb = n_block
726 if nb isa ABlockExpr and nb.n_expr.is_empty and n_doc == null then
727 modelbuilder.advice(self, "useless-init", "Warning: useless empty init in {mclassdef}")
728 end
729 end
730 if mprop == null then
731 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
732 mprop = new MMethod(mclassdef, name, mvisibility)
733 if look_like_a_root_init and modelbuilder.the_root_init_mmethod == null then
734 modelbuilder.the_root_init_mmethod = mprop
735 mprop.is_root_init = true
736 end
737 mprop.is_init = is_init
738 mprop.is_new = n_kwnew != null
739 if mprop.is_new then mclassdef.mclass.has_new_factory = true
740 if parent isa ATopClassdef then mprop.is_toplevel = true
741 self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, mprop)
742 else
743 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, not self isa AMainMethPropdef, mprop) then return
744 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
745 end
746
747 # Check name conflicts in the local class for constructors.
748 if is_init then
749 for p, n in mclassdef.mprop2npropdef do
750 if p != mprop and p isa MMethod and p.name == name then
751 check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, p)
752 break
753 end
754 end
755 end
756
757 mclassdef.mprop2npropdef[mprop] = self
758
759 var mpropdef = new MMethodDef(mclassdef, mprop, self.location)
760
761 set_doc(mpropdef, modelbuilder)
762
763 self.mpropdef = mpropdef
764 modelbuilder.mpropdef2npropdef[mpropdef] = self
765 if mpropdef.is_intro then
766 modelbuilder.toolcontext.info("{mpropdef} introduces new method {mprop.full_name}", 4)
767 else
768 modelbuilder.toolcontext.info("{mpropdef} redefines method {mprop.full_name}", 4)
769 end
770 end
771
772 redef fun build_signature(modelbuilder)
773 do
774 var mpropdef = self.mpropdef
775 if mpropdef == null then return # Error thus skiped
776 var mclassdef = mpropdef.mclassdef
777 var mmodule = mclassdef.mmodule
778 var nsig = self.n_signature
779
780 if mpropdef.mproperty.is_root_init and not mclassdef.is_intro then
781 var root_init = mclassdef.mclass.root_init
782 if root_init != null then
783 # Inherit the initializers by refinement
784 mpropdef.new_msignature = root_init.new_msignature
785 assert mpropdef.initializers.is_empty
786 mpropdef.initializers.add_all root_init.initializers
787 end
788 end
789
790 # Retrieve info from the signature AST
791 var param_names = new Array[String] # Names of parameters from the AST
792 var param_types = new Array[MType] # Types of parameters from the AST
793 var vararg_rank = -1
794 var ret_type: nullable MType = null # Return type from the AST
795 if nsig != null then
796 if not nsig.visit_signature(modelbuilder, mclassdef) then return
797 param_names = nsig.param_names
798 param_types = nsig.param_types
799 vararg_rank = nsig.vararg_rank
800 ret_type = nsig.ret_type
801 end
802
803 # Look for some signature to inherit
804 # FIXME: do not inherit from the intro, but from the most specific
805 var msignature: nullable MSignature = null
806 if not mpropdef.is_intro then
807 msignature = mpropdef.mproperty.intro.msignature
808 if msignature == null then return # Skip error
809
810 # The local signature is adapted to use the local formal types, if any.
811 msignature = msignature.resolve_for(mclassdef.mclass.mclass_type, mclassdef.bound_mtype, mmodule, false)
812
813 # Check inherited signature arity
814 if param_names.length != msignature.arity then
815 var node: ANode
816 if nsig != null then node = nsig else node = self
817 modelbuilder.error(node, "Redef error: {mpropdef} redefines {mpropdef.mproperty.intro} with {param_names.length} parameter(s), {msignature.arity} expected. Signature is {mpropdef}{msignature}")
818 return
819 end
820 else if mpropdef.mproperty.is_init and not mpropdef.mproperty.is_new then
821 # FIXME UGLY: inherit signature from a super-constructor
822 for msupertype in mclassdef.supertypes do
823 msupertype = msupertype.anchor_to(mmodule, mclassdef.bound_mtype)
824 var candidate = modelbuilder.try_get_mproperty_by_name2(self, mmodule, msupertype, mpropdef.mproperty.name)
825 if candidate != null then
826 if msignature == null then
827 msignature = candidate.intro.as(MMethodDef).msignature
828 end
829 end
830 end
831 end
832
833
834 # Inherit the signature
835 if msignature != null and param_names.length != param_types.length and param_names.length == msignature.arity and param_types.length == 0 then
836 # Parameters are untyped, thus inherit them
837 param_types = new Array[MType]
838 for mparameter in msignature.mparameters do
839 param_types.add(mparameter.mtype)
840 end
841 vararg_rank = msignature.vararg_rank
842 end
843 if msignature != null and ret_type == null then
844 ret_type = msignature.return_mtype
845 end
846
847 if param_names.length != param_types.length then
848 # Some parameters are typed, other parameters are not typed.
849 modelbuilder.error(nsig.n_params[param_types.length], "Error: Untyped parameter `{param_names[param_types.length]}'.")
850 return
851 end
852
853 var mparameters = new Array[MParameter]
854 for i in [0..param_names.length[ do
855 var mparameter = new MParameter(param_names[i], param_types[i], i == vararg_rank)
856 if nsig != null then nsig.n_params[i].mparameter = mparameter
857 mparameters.add(mparameter)
858 end
859
860 # In `new`-factories, the return type is by default the classtype.
861 if ret_type == null and mpropdef.mproperty.is_new then ret_type = mclassdef.mclass.mclass_type
862
863 msignature = new MSignature(mparameters, ret_type)
864 mpropdef.msignature = msignature
865 mpropdef.is_abstract = self.get_single_annotation("abstract", modelbuilder) != null
866 mpropdef.is_intern = self.get_single_annotation("intern", modelbuilder) != null
867 mpropdef.is_extern = self.n_extern_code_block != null or self.get_single_annotation("extern", modelbuilder) != null
868
869 # Check annotations
870 var at = self.get_single_annotation("lazy", modelbuilder)
871 if at != null then modelbuilder.error(at, "Syntax error: `lazy` must be used on attributes.")
872 end
873
874 redef fun check_signature(modelbuilder)
875 do
876 var mpropdef = self.mpropdef
877 if mpropdef == null then return # Error thus skiped
878 var mclassdef = mpropdef.mclassdef
879 var mmodule = mclassdef.mmodule
880 var nsig = self.n_signature
881 var mysignature = self.mpropdef.msignature
882 if mysignature == null then return # Error thus skiped
883
884 # Lookup for signature in the precursor
885 # FIXME all precursors should be considered
886 if not mpropdef.is_intro then
887 var msignature = mpropdef.mproperty.intro.msignature
888 if msignature == null then return
889
890 var precursor_ret_type = msignature.return_mtype
891 var ret_type = mysignature.return_mtype
892 if ret_type != null and precursor_ret_type == null then
893 modelbuilder.error(nsig.n_type.as(not null), "Redef Error: {mpropdef.mproperty} is a procedure, not a function.")
894 return
895 end
896
897 if mysignature.arity > 0 then
898 # Check parameters types
899 for i in [0..mysignature.arity[ do
900 var myt = mysignature.mparameters[i].mtype
901 var prt = msignature.mparameters[i].mtype
902 var node = nsig.n_params[i]
903 if not modelbuilder.check_sametype(node, mmodule, mclassdef.bound_mtype, myt, prt) then
904 modelbuilder.error(node, "Redef Error: Wrong type for parameter `{mysignature.mparameters[i].name}'. found {myt}, expected {prt} as in {mpropdef.mproperty.intro}.")
905 end
906 end
907 end
908 if precursor_ret_type != null then
909 var node: nullable ANode = null
910 if nsig != null then node = nsig.n_type
911 if node == null then node = self
912 if ret_type == null then
913 # Inherit the return type
914 ret_type = precursor_ret_type
915 else if not modelbuilder.check_subtype(node, mmodule, mclassdef.bound_mtype, ret_type, precursor_ret_type) then
916 modelbuilder.error(node, "Redef Error: Wrong return type. found {ret_type}, expected {precursor_ret_type} as in {mpropdef.mproperty.intro}.")
917 end
918 end
919 end
920
921 if mysignature.arity > 0 then
922 # Check parameters visibility
923 for i in [0..mysignature.arity[ do
924 var nt = nsig.n_params[i].n_type
925 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
926 end
927 var nt = nsig.n_type
928 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
929 end
930 end
931 end
932
933 redef class AAttrPropdef
934 redef type MPROPDEF: MAttributeDef
935
936 # Is the node tagged `noinit`?
937 var noinit = false
938
939 # Is the node tagged lazy?
940 var is_lazy = false
941
942 # Has the node a default value?
943 # Could be through `n_expr` or `n_block`
944 var has_value = false
945
946 # The guard associated to a lazy attribute.
947 # Because some engines does not have a working `isset`,
948 # this additional attribute is used to guard the lazy initialization.
949 # TODO: to remove once isset is correctly implemented
950 var mlazypropdef: nullable MAttributeDef
951
952 # The associated getter (read accessor) if any
953 var mreadpropdef: nullable MMethodDef is writable
954 # The associated setter (write accessor) if any
955 var mwritepropdef: nullable MMethodDef is writable
956
957 redef fun build_property(modelbuilder, mclassdef)
958 do
959 var mclass = mclassdef.mclass
960 var nid2 = n_id2
961 var name = nid2.text
962
963 var atabstract = self.get_single_annotation("abstract", modelbuilder)
964 if atabstract == null then
965 if mclass.kind == interface_kind then
966 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the interface {mclass}.")
967 else if mclass.kind == enum_kind then
968 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the enum class {mclass}.")
969 else if mclass.kind == extern_kind then
970 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the extern class {mclass}.")
971 end
972
973 var mprop = new MAttribute(mclassdef, "_" + name, private_visibility)
974 var mpropdef = new MAttributeDef(mclassdef, mprop, self.location)
975 self.mpropdef = mpropdef
976 modelbuilder.mpropdef2npropdef[mpropdef] = self
977 end
978
979 var readname = name
980 var mreadprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, readname).as(nullable MMethod)
981 if mreadprop == null then
982 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
983 mreadprop = new MMethod(mclassdef, readname, mvisibility)
984 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, mreadprop) then return
985 else
986 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, true, mreadprop) then return
987 check_redef_property_visibility(modelbuilder, self.n_visibility, mreadprop)
988 end
989 mclassdef.mprop2npropdef[mreadprop] = self
990
991 var mreadpropdef = new MMethodDef(mclassdef, mreadprop, self.location)
992 self.mreadpropdef = mreadpropdef
993 modelbuilder.mpropdef2npropdef[mreadpropdef] = self
994 set_doc(mreadpropdef, modelbuilder)
995 if mpropdef != null then mpropdef.mdoc = mreadpropdef.mdoc
996 if atabstract != null then mreadpropdef.is_abstract = true
997
998 has_value = n_expr != null or n_block != null
999
1000 if atabstract != null and has_value then
1001 modelbuilder.error(atabstract, "Error: `abstract` attributes cannot have an initial value")
1002 return
1003 end
1004
1005 var atnoinit = self.get_single_annotation("noinit", modelbuilder)
1006 if atnoinit == null then atnoinit = self.get_single_annotation("noautoinit", modelbuilder)
1007 if atnoinit != null then
1008 noinit = true
1009 if has_value then
1010 modelbuilder.error(atnoinit, "Error: `noautoinit` attributes cannot have an initial value")
1011 return
1012 end
1013 if atabstract != null then
1014 modelbuilder.error(atnoinit, "Error: `noautoinit` attributes cannot be abstract")
1015 return
1016 end
1017 end
1018
1019 var atlazy = self.get_single_annotation("lazy", modelbuilder)
1020 var atautoinit = self.get_single_annotation("autoinit", modelbuilder)
1021 if atlazy != null or atautoinit != null then
1022 if atlazy != null and atautoinit != null then
1023 modelbuilder.error(atlazy, "Error: lazy incompatible with autoinit")
1024 return
1025 end
1026 if not has_value then
1027 if atlazy != null then
1028 modelbuilder.error(atlazy, "Error: a lazy attribute needs a value")
1029 else if atautoinit != null then
1030 modelbuilder.error(atautoinit, "Error: a autoinit attribute needs a value")
1031 end
1032 return
1033 end
1034 is_lazy = true
1035 var mlazyprop = new MAttribute(mclassdef, "lazy _" + name, none_visibility)
1036 var mlazypropdef = new MAttributeDef(mclassdef, mlazyprop, self.location)
1037 self.mlazypropdef = mlazypropdef
1038 end
1039
1040 var atreadonly = self.get_single_annotation("readonly", modelbuilder)
1041 if atreadonly != null then
1042 if not has_value then
1043 modelbuilder.error(atreadonly, "Error: a readonly attribute needs a value")
1044 end
1045 # No setter, so just leave
1046 return
1047 end
1048
1049 var writename = name + "="
1050 var atwritable = self.get_single_annotation("writable", modelbuilder)
1051 if atwritable != null then
1052 if not atwritable.n_args.is_empty then
1053 writename = atwritable.arg_as_id(modelbuilder) or else writename
1054 end
1055 end
1056 var mwriteprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, writename).as(nullable MMethod)
1057 var nwkwredef: nullable Token = null
1058 if atwritable != null then nwkwredef = atwritable.n_kwredef
1059 if mwriteprop == null then
1060 var mvisibility
1061 if atwritable != null then
1062 mvisibility = new_property_visibility(modelbuilder, mclassdef, atwritable.n_visibility)
1063 else
1064 mvisibility = private_visibility
1065 end
1066 mwriteprop = new MMethod(mclassdef, writename, mvisibility)
1067 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef, false, mwriteprop) then return
1068 mwriteprop.deprecation = mreadprop.deprecation
1069 else
1070 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef or else n_kwredef, true, mwriteprop) then return
1071 if atwritable != null then
1072 check_redef_property_visibility(modelbuilder, atwritable.n_visibility, mwriteprop)
1073 end
1074 end
1075 mclassdef.mprop2npropdef[mwriteprop] = self
1076
1077 var mwritepropdef = new MMethodDef(mclassdef, mwriteprop, self.location)
1078 self.mwritepropdef = mwritepropdef
1079 modelbuilder.mpropdef2npropdef[mwritepropdef] = self
1080 mwritepropdef.mdoc = mreadpropdef.mdoc
1081 if atabstract != null then mwritepropdef.is_abstract = true
1082 end
1083
1084 redef fun build_signature(modelbuilder)
1085 do
1086 var mreadpropdef = self.mreadpropdef
1087 var mpropdef = self.mpropdef
1088 if mreadpropdef == null then return # Error thus skipped
1089 var mclassdef = mreadpropdef.mclassdef
1090 var mmodule = mclassdef.mmodule
1091 var mtype: nullable MType = null
1092
1093
1094 var ntype = self.n_type
1095 if ntype != null then
1096 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
1097 if mtype == null then return
1098 end
1099
1100 var inherited_type: nullable MType = null
1101 # Inherit the type from the getter (usually an abstract getter)
1102 if not mreadpropdef.is_intro then
1103 var msignature = mreadpropdef.mproperty.intro.msignature
1104 if msignature == null then return # Error, thus skipped
1105 inherited_type = msignature.return_mtype
1106 if inherited_type != null then
1107 # The inherited type is adapted to use the local formal types, if any.
1108 inherited_type = inherited_type.resolve_for(mclassdef.mclass.mclass_type, mclassdef.bound_mtype, mmodule, false)
1109 if mtype == null then mtype = inherited_type
1110 end
1111 end
1112
1113 var nexpr = self.n_expr
1114 if mtype == null then
1115 if nexpr != null then
1116 if nexpr isa ANewExpr then
1117 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, nexpr.n_type)
1118 else if nexpr isa AIntExpr then
1119 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int")
1120 if cla != null then mtype = cla.mclass_type
1121 else if nexpr isa AFloatExpr then
1122 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Float")
1123 if cla != null then mtype = cla.mclass_type
1124 else if nexpr isa ACharExpr then
1125 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Char")
1126 if cla != null then mtype = cla.mclass_type
1127 else if nexpr isa ABoolExpr then
1128 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Bool")
1129 if cla != null then mtype = cla.mclass_type
1130 else if nexpr isa ASuperstringExpr then
1131 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
1132 if cla != null then mtype = cla.mclass_type
1133 else if nexpr isa AStringFormExpr then
1134 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
1135 if cla != null then mtype = cla.mclass_type
1136 else
1137 modelbuilder.error(self, "Error: Untyped attribute {mreadpropdef}. Implicit typing allowed only for literals and new.")
1138 end
1139
1140 if mtype == null then return
1141 end
1142 else if ntype != null and inherited_type == mtype then
1143 if nexpr isa ANewExpr then
1144 var xmtype = modelbuilder.resolve_mtype(mmodule, mclassdef, nexpr.n_type)
1145 if xmtype == mtype then
1146 modelbuilder.advice(ntype, "useless-type", "Warning: useless type definition")
1147 end
1148 end
1149 end
1150
1151 if mtype == null then
1152 modelbuilder.error(self, "Error: Untyped attribute {mreadpropdef}")
1153 return
1154 end
1155
1156 if mpropdef != null then
1157 mpropdef.static_mtype = mtype
1158 end
1159
1160 do
1161 var msignature = new MSignature(new Array[MParameter], mtype)
1162 mreadpropdef.msignature = msignature
1163 end
1164
1165 var mwritepropdef = self.mwritepropdef
1166 if mwritepropdef != null then
1167 var name: String
1168 name = n_id2.text
1169 var mparameter = new MParameter(name, mtype, false)
1170 var msignature = new MSignature([mparameter], null)
1171 mwritepropdef.msignature = msignature
1172 end
1173
1174 var mlazypropdef = self.mlazypropdef
1175 if mlazypropdef != null then
1176 mlazypropdef.static_mtype = modelbuilder.model.get_mclasses_by_name("Bool").first.mclass_type
1177 end
1178 end
1179
1180 redef fun check_signature(modelbuilder)
1181 do
1182 var mpropdef = self.mpropdef
1183 if mpropdef == null then return # Error thus skipped
1184 var ntype = self.n_type
1185 var mtype = self.mpropdef.static_mtype
1186 if mtype == null then return # Error thus skipped
1187
1188 # Lookup for signature in the precursor
1189 # FIXME all precursors should be considered
1190 if not mpropdef.is_intro then
1191 var precursor_type = mpropdef.mproperty.intro.static_mtype
1192 if precursor_type == null then return
1193
1194 if mtype != precursor_type then
1195 modelbuilder.error(ntype.as(not null), "Redef Error: Wrong static type. found {mtype}, expected {precursor_type}.")
1196 return
1197 end
1198 end
1199
1200 # Check getter and setter
1201 var meth = self.mreadpropdef
1202 if meth != null then
1203 self.check_method_signature(modelbuilder, meth)
1204 var node: nullable ANode = ntype
1205 if node == null then node = self
1206 modelbuilder.check_visibility(node, mtype, meth)
1207 end
1208 meth = self.mwritepropdef
1209 if meth != null then
1210 self.check_method_signature(modelbuilder, meth)
1211 var node: nullable ANode = ntype
1212 if node == null then node = self
1213 modelbuilder.check_visibility(node, mtype, meth)
1214 end
1215 end
1216
1217 private fun check_method_signature(modelbuilder: ModelBuilder, mpropdef: MMethodDef)
1218 do
1219 var mclassdef = mpropdef.mclassdef
1220 var mmodule = mclassdef.mmodule
1221 var nsig = self.n_type
1222 var mysignature = mpropdef.msignature
1223 if mysignature == null then return # Error thus skiped
1224
1225 # Lookup for signature in the precursor
1226 # FIXME all precursors should be considered
1227 if not mpropdef.is_intro then
1228 var msignature = mpropdef.mproperty.intro.msignature
1229 if msignature == null then return
1230
1231 if mysignature.arity != msignature.arity then
1232 var node: ANode
1233 if nsig != null then node = nsig else node = self
1234 modelbuilder.error(node, "Redef Error: {mysignature.arity} parameters found, {msignature.arity} expected. Signature is {mpropdef}{msignature}")
1235 return
1236 end
1237 var precursor_ret_type = msignature.return_mtype
1238 var ret_type = mysignature.return_mtype
1239 if ret_type != null and precursor_ret_type == null then
1240 var node: ANode
1241 if nsig != null then node = nsig else node = self
1242 modelbuilder.error(node, "Redef Error: {mpropdef.mproperty} is a procedure, not a function.")
1243 return
1244 end
1245
1246 if mysignature.arity > 0 then
1247 # Check parameters types
1248 for i in [0..mysignature.arity[ do
1249 var myt = mysignature.mparameters[i].mtype
1250 var prt = msignature.mparameters[i].mtype
1251 var node: ANode
1252 if nsig != null then node = nsig else node = self
1253 if not modelbuilder.check_sametype(node, mmodule, mclassdef.bound_mtype, myt, prt) then
1254 modelbuilder.error(node, "Redef Error: Wrong type for parameter `{mysignature.mparameters[i].name}'. found {myt}, expected {prt}.")
1255 end
1256 end
1257 end
1258 if precursor_ret_type != null then
1259 var node: ANode
1260 if nsig != null then node = nsig else node = self
1261 if ret_type == null then
1262 # Inherit the return type
1263 ret_type = precursor_ret_type
1264 else if not modelbuilder.check_subtype(node, mmodule, mclassdef.bound_mtype, ret_type, precursor_ret_type) then
1265 modelbuilder.error(node, "Redef Error: Wrong return type. found {ret_type}, expected {precursor_ret_type}.")
1266 end
1267 end
1268 end
1269 end
1270 end
1271
1272 redef class ATypePropdef
1273 redef type MPROPDEF: MVirtualTypeDef
1274
1275 redef fun build_property(modelbuilder, mclassdef)
1276 do
1277 var name = self.n_id.text
1278 var mprop = modelbuilder.try_get_mproperty_by_name(self.n_id, mclassdef, name)
1279 if mprop == null then
1280 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
1281 mprop = new MVirtualTypeProp(mclassdef, name, mvisibility)
1282 for c in name.chars do if c >= 'a' and c<= 'z' then
1283 modelbuilder.warning(n_id, "bad-type-name", "Warning: lowercase in the virtual type {name}")
1284 break
1285 end
1286 if not self.check_redef_keyword(modelbuilder, mclassdef, self.n_kwredef, false, mprop) then return
1287 else
1288 if not self.check_redef_keyword(modelbuilder, mclassdef, self.n_kwredef, true, mprop) then return
1289 assert mprop isa MVirtualTypeProp
1290 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
1291 end
1292 mclassdef.mprop2npropdef[mprop] = self
1293
1294 var mpropdef = new MVirtualTypeDef(mclassdef, mprop, self.location)
1295 self.mpropdef = mpropdef
1296 modelbuilder.mpropdef2npropdef[mpropdef] = self
1297 if mpropdef.is_intro then
1298 modelbuilder.toolcontext.info("{mpropdef} introduces new type {mprop.full_name}", 4)
1299 else
1300 modelbuilder.toolcontext.info("{mpropdef} redefines type {mprop.full_name}", 4)
1301 end
1302 set_doc(mpropdef, modelbuilder)
1303
1304 var atfixed = get_single_annotation("fixed", modelbuilder)
1305 if atfixed != null then
1306 mpropdef.is_fixed = true
1307 end
1308 end
1309
1310 redef fun build_signature(modelbuilder)
1311 do
1312 var mpropdef = self.mpropdef
1313 if mpropdef == null then return # Error thus skipped
1314 var mclassdef = mpropdef.mclassdef
1315 var mmodule = mclassdef.mmodule
1316 var mtype: nullable MType = null
1317
1318 var ntype = self.n_type
1319 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
1320 if mtype == null then return
1321
1322 mpropdef.bound = mtype
1323 # print "{mpropdef}: {mtype}"
1324 end
1325
1326 redef fun check_signature(modelbuilder)
1327 do
1328 var mpropdef = self.mpropdef
1329 if mpropdef == null then return # Error thus skipped
1330
1331 var bound = self.mpropdef.bound
1332 if bound == null then return # Error thus skipped
1333
1334 modelbuilder.check_visibility(n_type, bound, mpropdef)
1335
1336 var mclassdef = mpropdef.mclassdef
1337 var mmodule = mclassdef.mmodule
1338 var anchor = mclassdef.bound_mtype
1339
1340 # Check circularity
1341 if bound isa MVirtualType then
1342 # Slow case: progress on each resolution until: (i) we loop, or (ii) we found a non formal type
1343 var seen = [self.mpropdef.mproperty.mvirtualtype]
1344 loop
1345 if seen.has(bound) then
1346 seen.add(bound)
1347 modelbuilder.error(self, "Error: circularity of virtual type definition: {seen.join(" -> ")}")
1348 return
1349 end
1350 seen.add(bound)
1351 var next = bound.lookup_bound(mmodule, anchor)
1352 if not next isa MVirtualType then break
1353 bound = next
1354 end
1355 end
1356
1357 # Check redefinitions
1358 bound = mpropdef.bound.as(not null)
1359 for p in mpropdef.mproperty.lookup_super_definitions(mmodule, anchor) do
1360 var supbound = p.bound
1361 if supbound == null then break # broken super bound, skip error
1362 if p.is_fixed then
1363 modelbuilder.error(self, "Redef Error: Virtual type {mpropdef.mproperty} is fixed in super-class {p.mclassdef.mclass}")
1364 break
1365 end
1366 if p.mclassdef.mclass == mclassdef.mclass then
1367 # Still a warning to pass existing bad code
1368 modelbuilder.warning(n_type, "refine-type", "Redef Error: a virtual type cannot be refined.")
1369 break
1370 end
1371 if not modelbuilder.check_subtype(n_type, mmodule, anchor, bound, supbound) then
1372 modelbuilder.error(n_type, "Redef Error: Wrong bound type. Found {bound}, expected a subtype of {supbound}, as in {p}.")
1373 break
1374 end
1375 end
1376 end
1377 end