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