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