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