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