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