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