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