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