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