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