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