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