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