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