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