modelize: mark property broken is they are bad introduction
[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", nclassdef.location, 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 and mpropdef.name != "new" 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, self.location, 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 return
840 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, not self isa AMainMethPropdef, mprop) then return
841 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
842 end
843
844 # Check name conflicts in the local class for constructors.
845 if is_init then
846 for p, n in mclassdef.mprop2npropdef do
847 if p != mprop and p isa MMethod and p.name == name then
848 if not check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, p) then
849 mprop.is_broken = true
850 return
851 end
852 break
853 end
854 end
855 end
856
857 mclassdef.mprop2npropdef[mprop] = self
858
859 var mpropdef = new MMethodDef(mclassdef, mprop, self.location)
860
861 set_doc(mpropdef, modelbuilder)
862
863 self.mpropdef = mpropdef
864 modelbuilder.mpropdef2npropdef[mpropdef] = self
865 if mpropdef.is_intro then
866 modelbuilder.toolcontext.info("{mpropdef} introduces new method {mprop.full_name}", 4)
867 else
868 modelbuilder.toolcontext.info("{mpropdef} redefines method {mprop.full_name}", 4)
869 end
870 end
871
872 redef fun build_signature(modelbuilder)
873 do
874 var mpropdef = self.mpropdef
875 if mpropdef == null then return # Error thus skiped
876 var mclassdef = mpropdef.mclassdef
877 var mmodule = mclassdef.mmodule
878 var nsig = self.n_signature
879
880 if mpropdef.mproperty.is_root_init and not mclassdef.is_intro then
881 var root_init = mclassdef.mclass.root_init
882 if root_init != null then
883 # Inherit the initializers by refinement
884 mpropdef.new_msignature = root_init.new_msignature
885 assert mpropdef.initializers.is_empty
886 mpropdef.initializers.add_all root_init.initializers
887 end
888 end
889
890 var accept_special_last_parameter = self.n_methid == null or self.n_methid.accept_special_last_parameter
891 var return_is_mandatory = self.n_methid != null and self.n_methid.return_is_mandatory
892
893 # Retrieve info from the signature AST
894 var param_names = new Array[String] # Names of parameters from the AST
895 var param_types = new Array[MType] # Types of parameters from the AST
896 var vararg_rank = -1
897 var ret_type: nullable MType = null # Return type from the AST
898 if nsig != null then
899 if not nsig.visit_signature(modelbuilder, mclassdef) then return
900 param_names = nsig.param_names
901 param_types = nsig.param_types
902 vararg_rank = nsig.vararg_rank
903 ret_type = nsig.ret_type
904 end
905
906 # Look for some signature to inherit
907 # FIXME: do not inherit from the intro, but from the most specific
908 var msignature: nullable MSignature = null
909 if not mpropdef.is_intro then
910 msignature = mpropdef.mproperty.intro.msignature
911 if msignature == null then return # Skip error
912
913 # The local signature is adapted to use the local formal types, if any.
914 msignature = msignature.resolve_for(mclassdef.mclass.mclass_type, mclassdef.bound_mtype, mmodule, false)
915
916 # Check inherited signature arity
917 if param_names.length != msignature.arity then
918 var node: ANode
919 if nsig != null then node = nsig else node = self
920 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}`.")
921 return
922 end
923 else if mpropdef.mproperty.is_init and not mpropdef.mproperty.is_new then
924 # FIXME UGLY: inherit signature from a super-constructor
925 for msupertype in mclassdef.supertypes do
926 msupertype = msupertype.anchor_to(mmodule, mclassdef.bound_mtype)
927 var candidate = modelbuilder.try_get_mproperty_by_name2(self, mmodule, msupertype, mpropdef.mproperty.name)
928 if candidate != null then
929 if msignature == null then
930 msignature = candidate.intro.as(MMethodDef).msignature
931 end
932 end
933 end
934 end
935
936
937 # Inherit the signature
938 if msignature != null and param_names.length != param_types.length and param_names.length == msignature.arity and param_types.length == 0 then
939 # Parameters are untyped, thus inherit them
940 param_types = new Array[MType]
941 for mparameter in msignature.mparameters do
942 param_types.add(mparameter.mtype)
943 end
944 vararg_rank = msignature.vararg_rank
945 end
946 if msignature != null and ret_type == null then
947 ret_type = msignature.return_mtype
948 end
949
950 if param_names.length != param_types.length then
951 # Some parameters are typed, other parameters are not typed.
952 modelbuilder.error(nsig.n_params[param_types.length], "Error: untyped parameter `{param_names[param_types.length]}'.")
953 return
954 end
955
956 var mparameters = new Array[MParameter]
957 for i in [0..param_names.length[ do
958 var mparameter = new MParameter(param_names[i], param_types[i], i == vararg_rank)
959 if nsig != null then nsig.n_params[i].mparameter = mparameter
960 mparameters.add(mparameter)
961 end
962
963 # In `new`-factories, the return type is by default the classtype.
964 if ret_type == null and mpropdef.mproperty.is_new then ret_type = mclassdef.mclass.mclass_type
965
966 # Special checks for operator methods
967 if not accept_special_last_parameter and mparameters.not_empty and mparameters.last.is_vararg then
968 modelbuilder.error(self.n_signature.n_params.last, "Error: illegal variadic parameter `{mparameters.last}` for `{mpropdef.mproperty.name}`.")
969 end
970 if ret_type == null and return_is_mandatory then
971 modelbuilder.error(self.n_methid, "Error: mandatory return type for `{mpropdef.mproperty.name}`.")
972 end
973
974 msignature = new MSignature(mparameters, ret_type)
975 mpropdef.msignature = msignature
976 mpropdef.is_abstract = self.get_single_annotation("abstract", modelbuilder) != null
977 mpropdef.is_intern = self.get_single_annotation("intern", modelbuilder) != null
978 mpropdef.is_extern = self.n_extern_code_block != null or self.get_single_annotation("extern", modelbuilder) != null
979
980 # Check annotations
981 var at = self.get_single_annotation("lazy", modelbuilder)
982 if at != null then modelbuilder.error(at, "Syntax Error: `lazy` must be used on attributes.")
983
984 var atautoinit = self.get_single_annotation("autoinit", modelbuilder)
985 if atautoinit != null then
986 if not mpropdef.is_intro then
987 modelbuilder.error(atautoinit, "Error: `autoinit` cannot be set on redefinitions.")
988 else if not mclassdef.is_intro then
989 modelbuilder.error(atautoinit, "Error: `autoinit` cannot be used in class refinements.")
990 else
991 self.is_autoinit = true
992 end
993 end
994 end
995
996 redef fun check_signature(modelbuilder)
997 do
998 var mpropdef = self.mpropdef
999 if mpropdef == null then return # Error thus skiped
1000 var mclassdef = mpropdef.mclassdef
1001 var mmodule = mclassdef.mmodule
1002 var nsig = self.n_signature
1003 var mysignature = mpropdef.msignature
1004 if mysignature == null then return # Error thus skiped
1005
1006 # Check
1007 if nsig != null then
1008 if not nsig.check_signature(modelbuilder, mclassdef) then
1009 mpropdef.msignature = null # invalidate
1010 mpropdef.is_broken = true
1011 return # Forward error
1012 end
1013 end
1014
1015 # Lookup for signature in the precursor
1016 # FIXME all precursors should be considered
1017 if not mpropdef.is_intro then
1018 var msignature = mpropdef.mproperty.intro.msignature
1019 if msignature == null then return
1020
1021 var precursor_ret_type = msignature.return_mtype
1022 var ret_type = mysignature.return_mtype
1023 if ret_type != null and precursor_ret_type == null then
1024 modelbuilder.error(nsig.n_type, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1025 mpropdef.msignature = null
1026 mpropdef.is_broken = true
1027 return
1028 end
1029
1030 if mysignature.arity > 0 then
1031 # Check parameters types
1032 for i in [0..mysignature.arity[ do
1033 var myt = mysignature.mparameters[i].mtype
1034 var prt = msignature.mparameters[i].mtype
1035 var node = nsig.n_params[i]
1036 if not modelbuilder.check_sametype(node, mmodule, mclassdef.bound_mtype, myt, prt) then
1037 modelbuilder.error(node, "Redef Error: expected `{prt}` for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1038 mpropdef.msignature = null
1039 mpropdef.is_broken = true
1040 end
1041 end
1042 end
1043 if precursor_ret_type != null then
1044 var node: nullable ANode = null
1045 if nsig != null then node = nsig.n_type
1046 if node == null then node = self
1047 if ret_type == null then
1048 # Inherit the return type
1049 ret_type = precursor_ret_type
1050 else if not modelbuilder.check_subtype(node, mmodule, mclassdef.bound_mtype, ret_type, precursor_ret_type) then
1051 modelbuilder.error(node, "Redef Error: expected `{precursor_ret_type}` for return type; got `{ret_type}`.")
1052 mpropdef.msignature = null
1053 mpropdef.is_broken = true
1054 end
1055 end
1056 end
1057
1058 if nsig != null then
1059 # Check parameters visibility
1060 for i in [0..mysignature.arity[ do
1061 var nt = nsig.n_params[i].n_type
1062 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
1063 end
1064 var nt = nsig.n_type
1065 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
1066 end
1067 check_repeated_types(modelbuilder)
1068 end
1069
1070 # For parameters, type is always useless in a redef.
1071 # For return type, type is useless if not covariant with introduction.
1072 redef fun check_repeated_types(modelbuilder) do
1073 var mpropdef = self.mpropdef
1074 if mpropdef == null then return
1075 if mpropdef.is_intro or n_signature == null then return
1076 # check params
1077 for param in n_signature.n_params do
1078 if param.n_type != null then
1079 modelbuilder.advice(param.n_type, "useless-signature", "Warning: useless type repetition on parameter `{param.n_id.text}` for redefined method `{mpropdef.name}`")
1080 end
1081 end
1082 # get intro
1083 var intro = mpropdef.mproperty.intro
1084 var n_intro = modelbuilder.mpropdef2npropdef.get_or_null(intro)
1085 if n_intro == null or not n_intro isa AMethPropdef then return
1086 # check return type
1087 var ret_type = n_signature.ret_type
1088 if ret_type != null and ret_type == n_intro.n_signature.ret_type then
1089 modelbuilder.advice(n_signature.n_type, "useless-signature", "Warning: useless return type repetition for redefined method `{mpropdef.name}`")
1090 end
1091 end
1092 end
1093
1094 redef class AMethid
1095 # Is a return required?
1096 #
1097 # * True for operators and brackets.
1098 # * False for id and assignment.
1099 fun return_is_mandatory: Bool do return true
1100
1101 # Can the last parameter be special like a vararg?
1102 #
1103 # * False for operators: the last one is in fact the only one.
1104 # * False for assignments: it is the right part of the assignment.
1105 # * True for ids and brackets.
1106 fun accept_special_last_parameter: Bool do return false
1107
1108 # The minimum required number of parameters.
1109 #
1110 # * 1 for binary operators
1111 # * 1 for brackets
1112 # * 1 for assignments
1113 # * 2 for bracket assignments
1114 # * 0 for ids
1115 fun min_arity: Int do return 1
1116
1117 # Is the `self` a binary operator?
1118 fun is_binary: Bool do return true
1119 end
1120
1121 redef class AIdMethid
1122 redef fun return_is_mandatory do return false
1123 redef fun accept_special_last_parameter do return true
1124 redef fun min_arity do return 0
1125 redef fun is_binary do return false
1126 end
1127
1128 redef class ABraMethid
1129 redef fun accept_special_last_parameter do return true
1130 redef fun is_binary do return false
1131 end
1132
1133 redef class ABraassignMethid
1134 redef fun return_is_mandatory do return false
1135 redef fun min_arity do return 2
1136 redef fun is_binary do return false
1137 end
1138
1139 redef class AAssignMethid
1140 redef fun return_is_mandatory do return false
1141 redef fun is_binary do return false
1142 end
1143
1144 redef class AAttrPropdef
1145 redef type MPROPDEF: MAttributeDef
1146
1147 # The static type of the property (declared, inferred or inherited)
1148 # This attribute is also used to check if the property was analyzed and is valid.
1149 var mtype: nullable MType
1150
1151 # Is the node tagged `noinit`?
1152 var noinit = false
1153
1154 # Is the node tagged lazy?
1155 var is_lazy = false
1156
1157 # Is the node tagged optional?
1158 var is_optional = false
1159
1160 # Has the node a default value?
1161 # Could be through `n_expr` or `n_block`
1162 var has_value = false
1163
1164 # The guard associated to a lazy attribute.
1165 # Because some engines does not have a working `isset`,
1166 # this additional attribute is used to guard the lazy initialization.
1167 # TODO: to remove once isset is correctly implemented
1168 var mlazypropdef: nullable MAttributeDef
1169
1170 # The associated getter (read accessor) if any
1171 var mreadpropdef: nullable MMethodDef is writable
1172 # The associated setter (write accessor) if any
1173 var mwritepropdef: nullable MMethodDef is writable
1174
1175 redef fun build_property(modelbuilder, mclassdef)
1176 do
1177 var mclass = mclassdef.mclass
1178 var nid2 = n_id2
1179 var name = nid2.text
1180
1181 var atabstract = self.get_single_annotation("abstract", modelbuilder)
1182 if atabstract == null then
1183 if not mclass.kind.need_init then
1184 modelbuilder.error(self, "Error: attempt to define attribute `{name}` in the {mclass.kind} `{mclass}`.")
1185 end
1186
1187 var mprop = new MAttribute(mclassdef, "_" + name, self.location, private_visibility)
1188 var mpropdef = new MAttributeDef(mclassdef, mprop, self.location)
1189 self.mpropdef = mpropdef
1190 modelbuilder.mpropdef2npropdef[mpropdef] = self
1191 end
1192
1193 var readname = name
1194 var mreadprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, readname).as(nullable MMethod)
1195 if mreadprop == null then
1196 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
1197 mreadprop = new MMethod(mclassdef, readname, self.location, mvisibility)
1198 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, mreadprop) then
1199 mreadprop.is_broken = true
1200 return
1201 end
1202 else
1203 if mreadprop.is_broken then return
1204 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, true, mreadprop) then return
1205 check_redef_property_visibility(modelbuilder, self.n_visibility, mreadprop)
1206 end
1207 mclassdef.mprop2npropdef[mreadprop] = self
1208
1209 var mreadpropdef = new MMethodDef(mclassdef, mreadprop, self.location)
1210 self.mreadpropdef = mreadpropdef
1211 modelbuilder.mpropdef2npropdef[mreadpropdef] = self
1212 set_doc(mreadpropdef, modelbuilder)
1213 if mpropdef != null then mpropdef.mdoc = mreadpropdef.mdoc
1214 if atabstract != null then mreadpropdef.is_abstract = true
1215
1216 has_value = n_expr != null or n_block != null
1217
1218 if atabstract != null and has_value then
1219 modelbuilder.error(atabstract, "Error: `abstract` attributes cannot have an initial value.")
1220 return
1221 end
1222
1223 var atnoinit = self.get_single_annotation("noinit", modelbuilder)
1224 if atnoinit == null then atnoinit = self.get_single_annotation("noautoinit", modelbuilder)
1225 if atnoinit != null then
1226 noinit = true
1227 if has_value then
1228 modelbuilder.error(atnoinit, "Error: `noautoinit` attributes cannot have an initial value.")
1229 return
1230 end
1231 if atabstract != null then
1232 modelbuilder.warning(atnoinit, "useless-noautoinit", "Warning: superfluous `noautoinit` on abstract attribute.")
1233 end
1234 end
1235
1236 var atlazy = self.get_single_annotation("lazy", modelbuilder)
1237 var atlateinit = self.get_single_annotation("lateinit", modelbuilder)
1238 if atlazy != null or atlateinit != null then
1239 if atlazy != null and atlateinit != null then
1240 modelbuilder.error(atlazy, "Error: `lazy` incompatible with `lateinit`.")
1241 return
1242 end
1243 if not has_value then
1244 if atlazy != null then
1245 modelbuilder.error(atlazy, "Error: `lazy` attributes need a value.")
1246 else if atlateinit != null then
1247 modelbuilder.error(atlateinit, "Error: `lateinit` attributes need a value.")
1248 end
1249 has_value = true
1250 return
1251 end
1252 is_lazy = true
1253 var mlazyprop = new MAttribute(mclassdef, "lazy _" + name, self.location, none_visibility)
1254 mlazyprop.is_fictive = true
1255 var mlazypropdef = new MAttributeDef(mclassdef, mlazyprop, self.location)
1256 mlazypropdef.is_fictive = true
1257 self.mlazypropdef = mlazypropdef
1258 end
1259
1260 var atoptional = self.get_single_annotation("optional", modelbuilder)
1261 if atoptional != null then
1262 if not has_value then
1263 modelbuilder.error(atoptional, "Error: `optional` attributes need a default value.")
1264 end
1265 is_optional = true
1266 end
1267
1268 var atreadonly = self.get_single_annotation("readonly", modelbuilder)
1269 if atreadonly != null then
1270 if not has_value then
1271 modelbuilder.error(atreadonly, "Error: `readonly` attributes need a value.")
1272 end
1273 # No setter, so just leave
1274 return
1275 end
1276
1277 if not mclassdef.is_intro and not has_value and not noinit then
1278 modelbuilder.advice(self, "attr-in-refinement", "Warning: attributes in refinement need a value or `noautoinit`.")
1279 end
1280
1281 var writename = name + "="
1282 var atwritable = self.get_single_annotation("writable", modelbuilder)
1283 if atwritable != null then
1284 if not atwritable.n_args.is_empty then
1285 writename = atwritable.arg_as_id(modelbuilder) or else writename
1286 end
1287 end
1288 var mwriteprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, writename).as(nullable MMethod)
1289 var nwkwredef: nullable Token = null
1290 if atwritable != null then nwkwredef = atwritable.n_kwredef
1291 if mwriteprop == null then
1292 var mvisibility
1293 if atwritable != null then
1294 mvisibility = new_property_visibility(modelbuilder, mclassdef, atwritable.n_visibility)
1295 else
1296 mvisibility = mreadprop.visibility
1297 # By default, use protected visibility at most
1298 if mvisibility > protected_visibility then mvisibility = protected_visibility
1299 end
1300 mwriteprop = new MMethod(mclassdef, writename, self.location, mvisibility)
1301 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef, false, mwriteprop) then
1302 mwriteprop.is_broken = true
1303 return
1304 end
1305 mwriteprop.deprecation = mreadprop.deprecation
1306 else
1307 if mwriteprop.is_broken then return
1308 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef or else n_kwredef, true, mwriteprop) then return
1309 if atwritable != null then
1310 check_redef_property_visibility(modelbuilder, atwritable.n_visibility, mwriteprop)
1311 end
1312 end
1313 mclassdef.mprop2npropdef[mwriteprop] = self
1314
1315 var mwritepropdef = new MMethodDef(mclassdef, mwriteprop, self.location)
1316 self.mwritepropdef = mwritepropdef
1317 modelbuilder.mpropdef2npropdef[mwritepropdef] = self
1318 mwritepropdef.mdoc = mreadpropdef.mdoc
1319 if atabstract != null then mwritepropdef.is_abstract = true
1320
1321 var atautoinit = self.get_single_annotation("autoinit", modelbuilder)
1322 if atautoinit != null then
1323 if has_value then
1324 modelbuilder.error(atautoinit, "Error: `autoinit` attributes cannot have an initial value.")
1325 else if not mwritepropdef.is_intro then
1326 modelbuilder.error(atautoinit, "Error: `autoinit` attributes cannot be set on redefinitions.")
1327 else if not mclassdef.is_intro then
1328 modelbuilder.error(atautoinit, "Error: `autoinit` attributes cannot be used in class refinements.")
1329 else if atabstract == null then
1330 modelbuilder.warning(atautoinit, "useless-autoinit", "Warning: superfluous `autoinit` on attribute.")
1331 end
1332 else if atabstract != null then
1333 # By default, abstract attribute are not autoinit
1334 noinit = true
1335 end
1336 end
1337
1338 redef fun build_signature(modelbuilder)
1339 do
1340 var mreadpropdef = self.mreadpropdef
1341 var mpropdef = self.mpropdef
1342 if mreadpropdef == null then return # Error thus skipped
1343 var mclassdef = mreadpropdef.mclassdef
1344 var mmodule = mclassdef.mmodule
1345 var mtype: nullable MType = null
1346
1347
1348 var ntype = self.n_type
1349 if ntype != null then
1350 mtype = modelbuilder.resolve_mtype_unchecked(mmodule, mclassdef, ntype, true)
1351 if mtype == null then return
1352 end
1353
1354 var inherited_type: nullable MType = null
1355 # Inherit the type from the getter (usually an abstract getter)
1356 if not mreadpropdef.is_intro then
1357 var msignature = mreadpropdef.mproperty.intro.msignature
1358 if msignature == null then return # Error, thus skipped
1359 inherited_type = msignature.return_mtype
1360 if inherited_type != null then
1361 # The inherited type is adapted to use the local formal types, if any.
1362 inherited_type = inherited_type.resolve_for(mclassdef.mclass.mclass_type, mclassdef.bound_mtype, mmodule, false)
1363 if mtype == null then mtype = inherited_type
1364 end
1365 end
1366
1367 var nexpr = self.n_expr
1368 if mtype == null then
1369 if nexpr != null then
1370 if nexpr isa ANewExpr then
1371 mtype = modelbuilder.resolve_mtype_unchecked(mmodule, mclassdef, nexpr.n_type, true)
1372 else if nexpr isa AAsCastExpr then
1373 mtype = modelbuilder.resolve_mtype_unchecked(mmodule, mclassdef, nexpr.n_type, true)
1374 else if nexpr isa AIntegerExpr then
1375 var cla: nullable MClass = null
1376 if nexpr.value isa Int then
1377 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int")
1378 else if nexpr.value isa Byte then
1379 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Byte")
1380 else if nexpr.value isa Int8 then
1381 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int8")
1382 else if nexpr.value isa Int16 then
1383 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int16")
1384 else if nexpr.value isa UInt16 then
1385 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "UInt16")
1386 else if nexpr.value isa Int32 then
1387 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int32")
1388 else if nexpr.value isa UInt32 then
1389 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "UInt32")
1390 else
1391 # Should not happen, and should be updated as new types are added
1392 abort
1393 end
1394 if cla != null then mtype = cla.mclass_type
1395 else if nexpr isa AFloatExpr then
1396 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Float")
1397 if cla != null then mtype = cla.mclass_type
1398 else if nexpr isa ACharExpr then
1399 var cla: nullable MClass
1400 if nexpr.is_ascii then
1401 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Byte")
1402 else if nexpr.is_code_point then
1403 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int")
1404 else
1405 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Char")
1406 end
1407 if cla != null then mtype = cla.mclass_type
1408 else if nexpr isa ABoolExpr then
1409 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Bool")
1410 if cla != null then mtype = cla.mclass_type
1411 else if nexpr isa ASuperstringExpr then
1412 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
1413 if cla != null then mtype = cla.mclass_type
1414 else if nexpr isa AStringFormExpr then
1415 var cla: nullable MClass
1416 if nexpr.is_bytestring then
1417 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Bytes")
1418 else if nexpr.is_re then
1419 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Regex")
1420 else if nexpr.is_string then
1421 cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
1422 else
1423 abort
1424 end
1425 if cla != null then mtype = cla.mclass_type
1426 else
1427 modelbuilder.error(self, "Error: untyped attribute `{mreadpropdef}`. Implicit typing allowed only for literals and new.")
1428 end
1429
1430 if mtype == null then return
1431 end
1432 else if ntype != null and inherited_type == mtype then
1433 if nexpr isa ANewExpr then
1434 var xmtype = modelbuilder.resolve_mtype_unchecked(mmodule, mclassdef, nexpr.n_type, true)
1435 if xmtype == mtype then
1436 modelbuilder.advice(ntype, "useless-type", "Warning: useless type definition")
1437 end
1438 end
1439 end
1440
1441 if mtype == null then
1442 modelbuilder.error(self, "Error: untyped attribute `{mreadpropdef}`.")
1443 return
1444 end
1445
1446 self.mtype = mtype
1447
1448 if mpropdef != null then
1449 mpropdef.static_mtype = mtype
1450 end
1451
1452 do
1453 var msignature = new MSignature(new Array[MParameter], mtype)
1454 mreadpropdef.msignature = msignature
1455 end
1456
1457 var mwritepropdef = self.mwritepropdef
1458 if mwritepropdef != null then
1459 var mwritetype = mtype
1460 if is_optional then
1461 mwritetype = mwritetype.as_nullable
1462 end
1463 var name: String
1464 name = n_id2.text
1465 var mparameter = new MParameter(name, mwritetype, false)
1466 var msignature = new MSignature([mparameter], null)
1467 mwritepropdef.msignature = msignature
1468 end
1469
1470 var mlazypropdef = self.mlazypropdef
1471 if mlazypropdef != null then
1472 mlazypropdef.static_mtype = mmodule.bool_type
1473 end
1474 check_repeated_types(modelbuilder)
1475 end
1476
1477 redef fun check_signature(modelbuilder)
1478 do
1479 var mpropdef = self.mpropdef
1480 if mpropdef == null then return # Error thus skipped
1481 var ntype = self.n_type
1482 var mtype = self.mtype
1483 if mtype == null then return # Error thus skipped
1484
1485 var mclassdef = mpropdef.mclassdef
1486 var mmodule = mclassdef.mmodule
1487
1488 # Check types
1489 if ntype != null then
1490 if modelbuilder.resolve_mtype(mmodule, mclassdef, ntype) == null then return
1491 end
1492 var nexpr = n_expr
1493 if nexpr isa ANewExpr then
1494 if modelbuilder.resolve_mtype(mmodule, mclassdef, nexpr.n_type) == null then return
1495 end
1496
1497 # Lookup for signature in the precursor
1498 # FIXME all precursors should be considered
1499 if not mpropdef.is_intro then
1500 var precursor_type = mpropdef.mproperty.intro.static_mtype
1501 if precursor_type == null then return
1502
1503 if mtype != precursor_type then
1504 modelbuilder.error(ntype.as(not null), "Redef Error: expected `{precursor_type}` type as a bound; got `{mtype}`.")
1505 return
1506 end
1507 end
1508
1509 # Check getter and setter
1510 var meth = self.mreadpropdef
1511 if meth != null then
1512 self.check_method_signature(modelbuilder, meth)
1513 var node: nullable ANode = ntype
1514 if node == null then node = self
1515 modelbuilder.check_visibility(node, mtype, meth)
1516 end
1517 meth = self.mwritepropdef
1518 if meth != null then
1519 self.check_method_signature(modelbuilder, meth)
1520 var node: nullable ANode = ntype
1521 if node == null then node = self
1522 modelbuilder.check_visibility(node, mtype, meth)
1523 end
1524 end
1525
1526 private fun check_method_signature(modelbuilder: ModelBuilder, mpropdef: MMethodDef)
1527 do
1528 var mclassdef = mpropdef.mclassdef
1529 var mmodule = mclassdef.mmodule
1530 var nsig = self.n_type
1531 var mysignature = mpropdef.msignature
1532 if mysignature == null then return # Error thus skiped
1533
1534 # Lookup for signature in the precursor
1535 # FIXME all precursors should be considered
1536 if not mpropdef.is_intro then
1537 var msignature = mpropdef.mproperty.intro.msignature
1538 if msignature == null then return
1539
1540 if mysignature.arity != msignature.arity then
1541 var node: ANode
1542 if nsig != null then node = nsig else node = self
1543 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}`.")
1544 return
1545 end
1546 var precursor_ret_type = msignature.return_mtype
1547 var ret_type = mysignature.return_mtype
1548 if ret_type != null and precursor_ret_type == null then
1549 var node: ANode
1550 if nsig != null then node = nsig else node = self
1551 modelbuilder.error(node, "Redef Error: `{mpropdef.mproperty}` is a procedure, not a function.")
1552 return
1553 end
1554
1555 if mysignature.arity > 0 then
1556 # Check parameters types
1557 for i in [0..mysignature.arity[ do
1558 var myt = mysignature.mparameters[i].mtype
1559 var prt = msignature.mparameters[i].mtype
1560 var node: ANode
1561 if nsig != null then node = nsig else node = self
1562 if not modelbuilder.check_sametype(node, mmodule, mclassdef.bound_mtype, myt, prt) then
1563 modelbuilder.error(node, "Redef Error: expected `{prt}` type for parameter `{mysignature.mparameters[i].name}'; got `{myt}`.")
1564 end
1565 end
1566 end
1567 if precursor_ret_type != null then
1568 var node: ANode
1569 if nsig != null then node = nsig else node = self
1570 if ret_type == null then
1571 # Inherit the return type
1572 ret_type = precursor_ret_type
1573 else if not modelbuilder.check_subtype(node, mmodule, mclassdef.bound_mtype, ret_type, precursor_ret_type) then
1574 modelbuilder.error(node, "Redef Error: expected `{precursor_ret_type}` return type; got `{ret_type}`.")
1575 end
1576 end
1577 end
1578 end
1579
1580 # Type is useless if the attribute type is the same thant the intro.
1581 redef fun check_repeated_types(modelbuilder) do
1582 var mreadpropdef = self.mreadpropdef
1583 if mreadpropdef == null then return
1584 if mreadpropdef.is_intro or n_type == null then return
1585 # get intro
1586 var intro = mreadpropdef.mproperty.intro
1587 var n_intro = modelbuilder.mpropdef2npropdef.get_or_null(intro)
1588 if n_intro == null then return
1589 # get intro type
1590 var ntype = null
1591 if n_intro isa AMethPropdef then
1592 ntype = n_intro.n_signature.ret_type
1593 else if n_intro isa AAttrPropdef and n_intro.n_type != null then
1594 ntype = n_intro.n_type.mtype
1595 end
1596 # check
1597 if ntype == null or ntype != n_type.mtype or mpropdef == null then return
1598 modelbuilder.advice(n_type, "useless-signature", "Warning: useless type repetition on redefined attribute `{mpropdef.name}`")
1599 end
1600 end
1601
1602 redef class ATypePropdef
1603 redef type MPROPDEF: MVirtualTypeDef
1604
1605 redef fun build_property(modelbuilder, mclassdef)
1606 do
1607 var name = self.n_qid.n_id.text
1608 var mprop = modelbuilder.try_get_mproperty_by_name(self.n_qid, mclassdef, name)
1609 if mprop == null then
1610 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
1611 mprop = new MVirtualTypeProp(mclassdef, name, self.location, mvisibility)
1612 for c in name.chars do if c >= 'a' and c<= 'z' then
1613 modelbuilder.warning(n_qid, "bad-type-name", "Warning: lowercase in the virtual type `{name}`.")
1614 break
1615 end
1616 else
1617 if mprop.is_broken then return
1618 assert mprop isa MVirtualTypeProp
1619 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
1620 end
1621
1622 var mpropdef = new MVirtualTypeDef(mclassdef, mprop, self.location)
1623 self.mpropdef = mpropdef
1624 if mpropdef.is_intro then
1625 modelbuilder.toolcontext.info("{mpropdef} introduces new type {mprop.full_name}", 4)
1626 else
1627 modelbuilder.toolcontext.info("{mpropdef} redefines type {mprop.full_name}", 4)
1628 end
1629 if not self.check_redef_keyword(modelbuilder, mclassdef, self.n_kwredef, not mpropdef.is_intro, mprop) then
1630 mpropdef.is_broken =true
1631 end
1632 mclassdef.mprop2npropdef[mprop] = self
1633 modelbuilder.mpropdef2npropdef[mpropdef] = self
1634 set_doc(mpropdef, modelbuilder)
1635
1636 var atfixed = get_single_annotation("fixed", modelbuilder)
1637 if atfixed != null then
1638 mpropdef.is_fixed = true
1639 end
1640 end
1641
1642 redef fun build_signature(modelbuilder)
1643 do
1644 var mpropdef = self.mpropdef
1645 if mpropdef == null then return # Error thus skipped
1646 var mclassdef = mpropdef.mclassdef
1647 var mmodule = mclassdef.mmodule
1648 var mtype: nullable MType = null
1649
1650 var ntype = self.n_type
1651 mtype = modelbuilder.resolve_mtype_unchecked(mmodule, mclassdef, ntype, true)
1652 if mtype == null then return
1653
1654 mpropdef.bound = mtype
1655 # print "{mpropdef}: {mtype}"
1656 end
1657
1658 redef fun check_signature(modelbuilder)
1659 do
1660 var mpropdef = self.mpropdef
1661 if mpropdef == null then return # Error thus skipped
1662
1663 var bound = mpropdef.bound
1664 if bound == null then return # Error thus skipped
1665
1666 modelbuilder.check_visibility(n_type, bound, mpropdef)
1667
1668 var mclassdef = mpropdef.mclassdef
1669 var mmodule = mclassdef.mmodule
1670 var anchor = mclassdef.bound_mtype
1671
1672 var ntype = self.n_type
1673 if modelbuilder.resolve_mtype(mmodule, mclassdef, ntype) == null then
1674 mpropdef.bound = null
1675 return
1676 end
1677
1678 # Check redefinitions
1679 for p in mpropdef.mproperty.lookup_super_definitions(mmodule, anchor) do
1680 var supbound = p.bound
1681 if supbound == null or supbound isa MBottomType or p.is_broken then break # broken super bound, skip error
1682 if p.is_fixed then
1683 modelbuilder.error(self, "Redef Error: virtual type `{mpropdef.mproperty}` is fixed in super-class `{p.mclassdef.mclass}`.")
1684 break
1685 end
1686 if p.mclassdef.mclass == mclassdef.mclass then
1687 # Still a warning to pass existing bad code
1688 modelbuilder.warning(n_type, "refine-type", "Redef Error: a virtual type cannot be refined.")
1689 break
1690 end
1691 if not modelbuilder.check_subtype(n_type, mmodule, anchor, bound, supbound) then
1692 modelbuilder.error(n_type, "Redef Error: expected `{supbound}` bound type; got `{bound}`.")
1693 break
1694 end
1695 end
1696 end
1697 end