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