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