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