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