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