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