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