Merge: Some gammar improvements
[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 import modelize_class
21 private import annotation
22
23 redef class ToolContext
24 var modelize_property_phase: Phase = new ModelizePropertyPhase(self, [modelize_class_phase])
25 end
26
27 private class ModelizePropertyPhase
28 super Phase
29 redef fun process_nmodule(nmodule)
30 do
31 for nclassdef in nmodule.n_classdefs do
32 if nclassdef.all_defs == null then continue # skip non principal classdef
33 toolcontext.modelbuilder.build_properties(nclassdef)
34 end
35 end
36 end
37
38 redef class ModelBuilder
39 # Register the npropdef associated to each mpropdef
40 # FIXME: why not refine the `MPropDef` class with a nullable attribute?
41 var mpropdef2npropdef = new HashMap[MPropDef, APropdef]
42
43 # Build the properties of `nclassdef`.
44 # REQUIRE: all superclasses are built.
45 private fun build_properties(nclassdef: AClassdef)
46 do
47 # Force building recursively
48 if nclassdef.build_properties_is_done then return
49 nclassdef.build_properties_is_done = true
50 var mclassdef = nclassdef.mclassdef.as(not null)
51 if mclassdef.in_hierarchy == null then return # Skip error
52 for superclassdef in mclassdef.in_hierarchy.direct_greaters do
53 if not mclassdef2nclassdef.has_key(superclassdef) then continue
54 build_properties(mclassdef2nclassdef[superclassdef])
55 end
56
57 for nclassdef2 in nclassdef.all_defs do
58 for npropdef in nclassdef2.n_propdefs do
59 npropdef.build_property(self, mclassdef)
60 end
61 for npropdef in nclassdef2.n_propdefs do
62 npropdef.build_signature(self)
63 end
64 for npropdef in nclassdef2.n_propdefs do
65 npropdef.check_signature(self)
66 end
67 end
68 process_default_constructors(nclassdef)
69 end
70
71 # the root init of the Object class
72 # Is usually implicitly defined
73 # Then explicit or implicit definitions of root-init are attached to it
74 var the_root_init_mmethod: nullable MMethod
75
76 # Introduce or inherit default constructor
77 # This is the last part of `build_properties`.
78 private fun process_default_constructors(nclassdef: AClassdef)
79 do
80 var mclassdef = nclassdef.mclassdef.as(not null)
81
82 # Are we a refinement
83 if not mclassdef.is_intro then return
84
85 # Look for the init in Object, or create it
86 if mclassdef.mclass.name == "Object" and the_root_init_mmethod == null then
87 # Create the implicit root-init method
88 var mprop = new MMethod(mclassdef, "init", mclassdef.mclass.visibility)
89 mprop.is_root_init = true
90 var mpropdef = new MMethodDef(mclassdef, mprop, nclassdef.location)
91 var mparameters = new Array[MParameter]
92 var msignature = new MSignature(mparameters, null)
93 mpropdef.msignature = msignature
94 mpropdef.new_msignature = msignature
95 mprop.is_init = true
96 nclassdef.mfree_init = mpropdef
97 self.toolcontext.info("{mclassdef} gets a free empty constructor {mpropdef}{msignature}", 3)
98 the_root_init_mmethod = mprop
99 return
100 end
101
102 # Is the class forbid constructors?
103 if not mclassdef.mclass.kind.need_init then return
104
105 # Is there already a constructor defined?
106 var defined_init: nullable MMethodDef = null
107 for mpropdef in mclassdef.mpropdefs do
108 if not mpropdef isa MMethodDef then continue
109 if not mpropdef.mproperty.is_init then continue
110 if mpropdef.mproperty.is_root_init then
111 assert defined_init == null
112 defined_init = mpropdef
113 else if mpropdef.mproperty.name == "init" then
114 # An explicit old-style init named "init", so return
115 return
116 end
117 end
118
119 if not nclassdef isa AStdClassdef then return
120
121 # Collect undefined attributes
122 var mparameters = new Array[MParameter]
123 var initializers = new Array[MProperty]
124 for npropdef in nclassdef.n_propdefs do
125 if npropdef isa AMethPropdef then
126 if npropdef.mpropdef == null then return # Skip broken attribute
127 var at = npropdef.get_single_annotation("autoinit", self)
128 if at == null then continue # Skip non tagged init
129
130 var sig = npropdef.mpropdef.msignature
131 if sig == null then continue # Skip broken method
132
133 if not npropdef.mpropdef.is_intro then
134 self.error(at, "Error: `autoinit` cannot be set on redefinitions")
135 continue
136 end
137
138 for param in sig.mparameters do
139 var ret_type = param.mtype
140 var mparameter = new MParameter(param.name, ret_type, false)
141 mparameters.add(mparameter)
142 end
143 initializers.add(npropdef.mpropdef.mproperty)
144 end
145 if npropdef isa AAttrPropdef then
146 if npropdef.mpropdef == null then return # Skip broken attribute
147 var at = npropdef.get_single_annotation("noinit", self)
148 if at != null then
149 npropdef.noinit = true
150 if npropdef.n_expr != null then
151 self.error(at, "Error: `noinit` attributes cannot have an initial value")
152 end
153 continue # Skip noinit attributes
154 end
155 if npropdef.n_expr != null then continue
156 var paramname = npropdef.mpropdef.mproperty.name.substring_from(1)
157 var ret_type = npropdef.mpropdef.static_mtype
158 if ret_type == null then return
159 var mparameter = new MParameter(paramname, ret_type, false)
160 mparameters.add(mparameter)
161 var msetter = npropdef.mwritepropdef
162 if msetter == null then
163 # No setter, it is a old-style attribute, so just add it
164 initializers.add(npropdef.mpropdef.mproperty)
165 else
166 # Add the setter to the list
167 initializers.add(msetter.mproperty)
168 end
169 end
170 end
171
172 if the_root_init_mmethod == null then return
173
174 # Look for most-specific new-stype init definitions
175 var spropdefs = the_root_init_mmethod.lookup_super_definitions(mclassdef.mmodule, mclassdef.bound_mtype)
176 if spropdefs.is_empty then
177 toolcontext.fatal_error(nclassdef.location, "Fatal error: {mclassdef} does not specialize {the_root_init_mmethod.intro_mclassdef}. Possible duplication of the root class `Object`?")
178 end
179
180 # Search the longest-one and checks for conflict
181 var longest = spropdefs.first
182 if spropdefs.length > 1 then
183 # Check for conflict in the order of initializers
184 # Each initializer list must me a prefix of the longest list
185 # part 1. find the longest list
186 for spd in spropdefs do
187 if spd.initializers.length > longest.initializers.length then longest = spd
188 end
189 # part 2. compare
190 for spd in spropdefs do
191 var i = 0
192 for p in spd.initializers do
193 if p != longest.initializers[i] then
194 self.error(nclassdef, "Error: conflict for inherited inits {spd}({spd.initializers.join(", ")}) and {longest}({longest.initializers.join(", ")})")
195 return
196 end
197 i += 1
198 end
199 end
200 end
201
202 # Can we just inherit?
203 if spropdefs.length == 1 and mparameters.is_empty and defined_init == null then
204 self.toolcontext.info("{mclassdef} inherits the basic constructor {longest}", 3)
205 mclassdef.mclass.root_init = longest
206 return
207 end
208
209 # Combine the inherited list to what is collected
210 if longest.initializers.length > 0 then
211 mparameters.prepend longest.new_msignature.mparameters
212 initializers.prepend longest.initializers
213 end
214
215 # If we already have a basic init definition, then setup its initializers
216 if defined_init != null then
217 defined_init.initializers.add_all(initializers)
218 var msignature = new MSignature(mparameters, null)
219 defined_init.new_msignature = msignature
220 self.toolcontext.info("{mclassdef} extends its basic constructor signature to {defined_init}{msignature}", 3)
221 mclassdef.mclass.root_init = defined_init
222 return
223 end
224
225 # Else create the local implicit basic init definition
226 var mprop = the_root_init_mmethod.as(not null)
227 var mpropdef = new MMethodDef(mclassdef, mprop, nclassdef.location)
228 mpropdef.has_supercall = true
229 mpropdef.initializers.add_all(initializers)
230 var msignature = new MSignature(mparameters, null)
231 mpropdef.new_msignature = msignature
232 mpropdef.msignature = new MSignature(new Array[MParameter], null) # always an empty real signature
233 nclassdef.mfree_init = mpropdef
234 self.toolcontext.info("{mclassdef} gets a free constructor for attributes {mpropdef}{msignature}", 3)
235 mclassdef.mclass.root_init = mpropdef
236 end
237
238 # Check the visibility of `mtype` as an element of the signature of `mpropdef`.
239 fun check_visibility(node: ANode, mtype: MType, mpropdef: MPropDef)
240 do
241 var mmodule = mpropdef.mclassdef.mmodule
242 var mproperty = mpropdef.mproperty
243
244 # Extract visibility information of the main part of `mtype`
245 # It is a case-by case
246 var vis_type: nullable MVisibility = null # The own visibility of the type
247 var mmodule_type: nullable MModule = null # The original module of the type
248 mtype = mtype.as_notnullable
249 if mtype isa MClassType then
250 vis_type = mtype.mclass.visibility
251 mmodule_type = mtype.mclass.intro.mmodule
252 else if mtype isa MVirtualType then
253 vis_type = mtype.mproperty.visibility
254 mmodule_type = mtype.mproperty.intro_mclassdef.mmodule
255 else if mtype isa MParameterType then
256 # nothing, always visible
257 else
258 node.debug "Unexpected type {mtype}"
259 abort
260 end
261
262 if vis_type != null then
263 assert mmodule_type != null
264 var vis_module_type = mmodule.visibility_for(mmodule_type) # the visibility of the original module
265 if mproperty.visibility > vis_type then
266 error(node, "Error: The {mproperty.visibility} property `{mproperty}` cannot contain the {vis_type} type `{mtype}`")
267 return
268 else if mproperty.visibility > vis_module_type then
269 error(node, "Error: The {mproperty.visibility} property `{mproperty}` cannot contain the type `{mtype}` from the {vis_module_type} module `{mmodule_type}`")
270 return
271 end
272 end
273
274 # No error, try to go deeper in generic types
275 if node isa AType then
276 for a in node.n_types do
277 var t = a.mtype
278 if t == null then continue # Error, thus skipped
279 check_visibility(a, t, mpropdef)
280 end
281 else if mtype isa MGenericType then
282 for t in mtype.arguments do check_visibility(node, t, mpropdef)
283 end
284 end
285 end
286
287 redef class MPropDef
288 # Does the MPropDef contains a call to super or a call of a super-constructor?
289 # Subsequent phases of the frontend (esp. typing) set it if required
290 var has_supercall: Bool = false is writable
291 end
292
293 redef class AClassdef
294 var build_properties_is_done = false
295
296 # The free init (implicitely constructed by the class if required)
297 var mfree_init: nullable MMethodDef = null
298 end
299
300 redef class MClass
301 # The base init of the class.
302 # Used to get the common new_msignature and initializers
303 #
304 # TODO: Where to put this information is not clear because unlike other
305 # informations, the initialisers are stable in a same class.
306 var root_init: nullable MMethodDef = null
307 end
308
309 redef class MClassDef
310 # What is the `APropdef` associated to a `MProperty`?
311 # Used to check multiple definition of a property.
312 var mprop2npropdef: Map[MProperty, APropdef] = new HashMap[MProperty, APropdef]
313 end
314
315 redef class APropdef
316 # The associated main model entity
317 type MPROPDEF: MPropDef
318
319 # The associated propdef once build by a `ModelBuilder`
320 var mpropdef: nullable MPROPDEF is writable
321
322 private fun build_property(modelbuilder: ModelBuilder, mclassdef: MClassDef) is abstract
323 private fun build_signature(modelbuilder: ModelBuilder) is abstract
324 private fun check_signature(modelbuilder: ModelBuilder) is abstract
325 private fun new_property_visibility(modelbuilder: ModelBuilder, mclassdef: MClassDef, nvisibility: nullable AVisibility): MVisibility
326 do
327 var mvisibility = public_visibility
328 if nvisibility != null then
329 mvisibility = nvisibility.mvisibility
330 if mvisibility == intrude_visibility then
331 modelbuilder.error(nvisibility, "Error: intrude is not a legal visibility for properties.")
332 mvisibility = public_visibility
333 end
334 end
335 if mclassdef.mclass.visibility == private_visibility then
336 if mvisibility == protected_visibility then
337 assert nvisibility != null
338 modelbuilder.error(nvisibility, "Error: The only legal visibility for properties in a private class is private.")
339 else if mvisibility == private_visibility then
340 assert nvisibility != null
341 modelbuilder.advice(nvisibility, "useless-visibility", "Warning: private is superfluous since the only legal visibility for properties in a private class is private.")
342 end
343 mvisibility = private_visibility
344 end
345 return mvisibility
346 end
347
348 private fun set_doc(mpropdef: MPropDef, modelbuilder: ModelBuilder)
349 do
350 var ndoc = self.n_doc
351 if ndoc != null then
352 var mdoc = ndoc.to_mdoc
353 mpropdef.mdoc = mdoc
354 mdoc.original_mentity = mpropdef
355 else if mpropdef.is_intro and mpropdef.mproperty.visibility >= protected_visibility then
356 modelbuilder.advice(self, "missing-doc", "Documentation warning: Undocumented property `{mpropdef.mproperty}`")
357 end
358
359 var at_deprecated = get_single_annotation("deprecated", modelbuilder)
360 if at_deprecated != null then
361 if not mpropdef.is_intro then
362 modelbuilder.error(self, "Error: method redefinition cannot be deprecated.")
363 else
364 var info = new MDeprecationInfo
365 ndoc = at_deprecated.n_doc
366 if ndoc != null then info.mdoc = ndoc.to_mdoc
367 mpropdef.mproperty.deprecation = info
368 end
369 end
370 end
371
372 private fun check_redef_property_visibility(modelbuilder: ModelBuilder, nvisibility: nullable AVisibility, mprop: MProperty)
373 do
374 if nvisibility == null then return
375 var mvisibility = nvisibility.mvisibility
376 if mvisibility != mprop.visibility and mvisibility != public_visibility then
377 modelbuilder.error(nvisibility, "Error: redefinition changed the visibility from a {mprop.visibility} to a {mvisibility}")
378 end
379 end
380
381 private fun check_redef_keyword(modelbuilder: ModelBuilder, mclassdef: MClassDef, kwredef: nullable Token, need_redef: Bool, mprop: MProperty): Bool
382 do
383 if mclassdef.mprop2npropdef.has_key(mprop) then
384 modelbuilder.error(self, "Error: A property {mprop} is already defined in class {mclassdef.mclass} at line {mclassdef.mprop2npropdef[mprop].location.line_start}.")
385 return false
386 end
387 if mprop isa MMethod and mprop.is_toplevel != (parent isa ATopClassdef) then
388 if mprop.is_toplevel then
389 modelbuilder.error(self, "Error: {mprop} is a top level method.")
390 else
391 modelbuilder.error(self, "Error: {mprop} is not a top level method.")
392 end
393 return false
394
395 end
396 if kwredef == null then
397 if need_redef then
398 modelbuilder.error(self, "Redef error: {mclassdef.mclass}::{mprop.name} is an inherited property. To redefine it, add the redef keyword.")
399 return false
400 end
401 else
402 if not need_redef then
403 modelbuilder.error(self, "Error: No property {mclassdef.mclass}::{mprop.name} is inherited. Remove the redef keyword to define a new property.")
404 return false
405 end
406 end
407 return true
408 end
409
410 end
411
412 redef class ASignature
413 # Is the model builder has correctly visited the signature
414 var is_visited = false
415 # Names of parameters from the AST
416 # REQUIRE: is_visited
417 var param_names = new Array[String]
418 # Types of parameters from the AST
419 # REQUIRE: is_visited
420 var param_types = new Array[MType]
421 # Rank of the vararg (of -1 if none)
422 # REQUIRE: is_visited
423 var vararg_rank: Int = -1
424 # Return type
425 var ret_type: nullable MType = null
426
427 # Visit and fill information about a signature
428 private fun visit_signature(modelbuilder: ModelBuilder, mclassdef: MClassDef): Bool
429 do
430 var mmodule = mclassdef.mmodule
431 var param_names = self.param_names
432 var param_types = self.param_types
433 for np in self.n_params do
434 param_names.add(np.n_id.text)
435 var ntype = np.n_type
436 if ntype != null then
437 var mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
438 if mtype == null then return false # Skip error
439 for i in [0..param_names.length-param_types.length[ do
440 param_types.add(mtype)
441 end
442 if np.n_dotdotdot != null then
443 if self.vararg_rank != -1 then
444 modelbuilder.error(np, "Error: {param_names[self.vararg_rank]} is already a vararg")
445 return false
446 else
447 self.vararg_rank = param_names.length - 1
448 end
449 end
450 end
451 end
452 var ntype = self.n_type
453 if ntype != null then
454 self.ret_type = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
455 if self.ret_type == null then return false # Skip error
456 end
457
458 self.is_visited = true
459 return true
460 end
461
462 # Build a visited signature
463 fun build_signature(modelbuilder: ModelBuilder): nullable MSignature
464 do
465 if param_names.length != param_types.length then
466 # Some parameters are typed, other parameters are not typed.
467 modelbuilder.error(self.n_params[param_types.length], "Error: Untyped parameter `{param_names[param_types.length]}'.")
468 return null
469 end
470
471 var mparameters = new Array[MParameter]
472 for i in [0..param_names.length[ do
473 var mparameter = new MParameter(param_names[i], param_types[i], i == vararg_rank)
474 self.n_params[i].mparameter = mparameter
475 mparameters.add(mparameter)
476 end
477
478 var msignature = new MSignature(mparameters, ret_type)
479 return msignature
480 end
481 end
482
483 redef class AParam
484 # The associated mparameter if any
485 var mparameter: nullable MParameter = null
486 end
487
488 redef class AMethPropdef
489 redef type MPROPDEF: MMethodDef
490
491
492 # Can self be used as a root init?
493 private fun look_like_a_root_init(modelbuilder: ModelBuilder): Bool
494 do
495 # Need the `init` keyword
496 if n_kwinit == null then return false
497 # Need to by anonymous
498 if self.n_methid != null then return false
499 # No parameters
500 if self.n_signature.n_params.length > 0 then return false
501 # Cannot be private or something
502 if not self.n_visibility isa APublicVisibility then return false
503 # No annotation on itself
504 if get_single_annotation("old_style_init", modelbuilder) != null then return false
505 # Nor on its module
506 var amod = self.parent.parent.as(AModule)
507 var amoddecl = amod.n_moduledecl
508 if amoddecl != null then
509 var old = amoddecl.get_single_annotation("old_style_init", modelbuilder)
510 if old != null then return false
511 end
512
513 return true
514 end
515
516 redef fun build_property(modelbuilder, mclassdef)
517 do
518 var n_kwinit = n_kwinit
519 var n_kwnew = n_kwnew
520 var is_init = n_kwinit != null or n_kwnew != null
521 var name: String
522 var amethodid = self.n_methid
523 var name_node: ANode
524 if amethodid == null then
525 if not is_init then
526 name = "main"
527 name_node = self
528 else if n_kwinit != null then
529 name = "init"
530 name_node = n_kwinit
531 else if n_kwnew != null then
532 name = "init"
533 name_node = n_kwnew
534 else
535 abort
536 end
537 else if amethodid isa AIdMethid then
538 name = amethodid.n_id.text
539 name_node = amethodid
540 else
541 # operator, bracket or assign
542 name = amethodid.collect_text
543 name_node = amethodid
544
545 if name == "-" and self.n_signature.n_params.length == 0 then
546 name = "unary -"
547 end
548 end
549
550 var mprop: nullable MMethod = null
551 if not is_init or n_kwredef != null then mprop = modelbuilder.try_get_mproperty_by_name(name_node, mclassdef, name).as(nullable MMethod)
552 if mprop == null and look_like_a_root_init(modelbuilder) then
553 mprop = modelbuilder.the_root_init_mmethod
554 var nb = n_block
555 if nb isa ABlockExpr and nb.n_expr.is_empty and n_doc == null then
556 modelbuilder.advice(self, "useless-init", "Warning: useless empty init in {mclassdef}")
557 end
558 end
559 if mprop == null then
560 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
561 mprop = new MMethod(mclassdef, name, mvisibility)
562 if look_like_a_root_init(modelbuilder) and modelbuilder.the_root_init_mmethod == null then
563 modelbuilder.the_root_init_mmethod = mprop
564 mprop.is_root_init = true
565 end
566 mprop.is_init = is_init
567 mprop.is_new = n_kwnew != null
568 if parent isa ATopClassdef then mprop.is_toplevel = true
569 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, mprop) then return
570 else
571 if not mprop.is_root_init and not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, not self isa AMainMethPropdef, mprop) then return
572 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
573 end
574 mclassdef.mprop2npropdef[mprop] = self
575
576 var mpropdef = new MMethodDef(mclassdef, mprop, self.location)
577
578 set_doc(mpropdef, modelbuilder)
579
580 self.mpropdef = mpropdef
581 modelbuilder.mpropdef2npropdef[mpropdef] = self
582 if mpropdef.is_intro then
583 modelbuilder.toolcontext.info("{mpropdef} introduces new method {mprop.full_name}", 3)
584 else
585 modelbuilder.toolcontext.info("{mpropdef} redefines method {mprop.full_name}", 3)
586 end
587 end
588
589 redef fun build_signature(modelbuilder)
590 do
591 var mpropdef = self.mpropdef
592 if mpropdef == null then return # Error thus skiped
593 var mclassdef = mpropdef.mclassdef
594 var mmodule = mclassdef.mmodule
595 var nsig = self.n_signature
596
597 if mpropdef.mproperty.is_root_init and not mclassdef.is_intro then
598 var root_init = mclassdef.mclass.root_init
599 if root_init != null then
600 # Inherit the initializers by refinement
601 mpropdef.new_msignature = root_init.new_msignature
602 assert mpropdef.initializers.is_empty
603 mpropdef.initializers.add_all root_init.initializers
604 end
605 end
606
607 # Retrieve info from the signature AST
608 var param_names = new Array[String] # Names of parameters from the AST
609 var param_types = new Array[MType] # Types of parameters from the AST
610 var vararg_rank = -1
611 var ret_type: nullable MType = null # Return type from the AST
612 if nsig != null then
613 if not nsig.visit_signature(modelbuilder, mclassdef) then return
614 param_names = nsig.param_names
615 param_types = nsig.param_types
616 vararg_rank = nsig.vararg_rank
617 ret_type = nsig.ret_type
618 end
619
620 # Look for some signature to inherit
621 # FIXME: do not inherit from the intro, but from the most specific
622 var msignature: nullable MSignature = null
623 if not mpropdef.is_intro then
624 msignature = mpropdef.mproperty.intro.msignature
625 if msignature == null then return # Skip error
626
627 # Check inherited signature arity
628 if param_names.length != msignature.arity then
629 var node: ANode
630 if nsig != null then node = nsig else node = self
631 modelbuilder.error(node, "Redef error: {mpropdef} redefines {mpropdef.mproperty.intro} with {param_names.length} parameter(s), {msignature.arity} expected. Signature is {mpropdef}{msignature}")
632 return
633 end
634 else if mpropdef.mproperty.is_init then
635 # FIXME UGLY: inherit signature from a super-constructor
636 for msupertype in mclassdef.supertypes do
637 msupertype = msupertype.anchor_to(mmodule, mclassdef.bound_mtype)
638 var candidate = modelbuilder.try_get_mproperty_by_name2(self, mmodule, msupertype, mpropdef.mproperty.name)
639 if candidate != null then
640 if msignature == null then
641 msignature = candidate.intro.as(MMethodDef).msignature
642 end
643 end
644 end
645 end
646
647
648 # Inherit the signature
649 if msignature != null and param_names.length != param_types.length and param_names.length == msignature.arity and param_types.length == 0 then
650 # Parameters are untyped, thus inherit them
651 param_types = new Array[MType]
652 for mparameter in msignature.mparameters do
653 param_types.add(mparameter.mtype)
654 end
655 vararg_rank = msignature.vararg_rank
656 end
657 if msignature != null and ret_type == null then
658 ret_type = msignature.return_mtype
659 end
660
661 if param_names.length != param_types.length then
662 # Some parameters are typed, other parameters are not typed.
663 modelbuilder.error(nsig.n_params[param_types.length], "Error: Untyped parameter `{param_names[param_types.length]}'.")
664 return
665 end
666
667 var mparameters = new Array[MParameter]
668 for i in [0..param_names.length[ do
669 var mparameter = new MParameter(param_names[i], param_types[i], i == vararg_rank)
670 if nsig != null then nsig.n_params[i].mparameter = mparameter
671 mparameters.add(mparameter)
672 end
673
674 msignature = new MSignature(mparameters, ret_type)
675 mpropdef.msignature = msignature
676 mpropdef.is_abstract = self.get_single_annotation("abstract", modelbuilder) != null
677 mpropdef.is_intern = self.get_single_annotation("intern", modelbuilder) != null
678 mpropdef.is_extern = self.n_extern_code_block != null or self.get_single_annotation("extern", modelbuilder) != null
679 end
680
681 redef fun check_signature(modelbuilder)
682 do
683 var mpropdef = self.mpropdef
684 if mpropdef == null then return # Error thus skiped
685 var mclassdef = mpropdef.mclassdef
686 var mmodule = mclassdef.mmodule
687 var nsig = self.n_signature
688 var mysignature = self.mpropdef.msignature
689 if mysignature == null then return # Error thus skiped
690
691 # Lookup for signature in the precursor
692 # FIXME all precursors should be considered
693 if not mpropdef.is_intro then
694 var msignature = mpropdef.mproperty.intro.msignature
695 if msignature == null then return
696
697 var precursor_ret_type = msignature.return_mtype
698 var ret_type = mysignature.return_mtype
699 if ret_type != null and precursor_ret_type == null then
700 modelbuilder.error(nsig.n_type.as(not null), "Redef Error: {mpropdef.mproperty} is a procedure, not a function.")
701 return
702 end
703
704 if mysignature.arity > 0 then
705 # Check parameters types
706 for i in [0..mysignature.arity[ do
707 var myt = mysignature.mparameters[i].mtype
708 var prt = msignature.mparameters[i].mtype
709 if not myt.is_subtype(mmodule, mclassdef.bound_mtype, prt) or
710 not prt.is_subtype(mmodule, mclassdef.bound_mtype, myt) then
711 modelbuilder.error(nsig.n_params[i], "Redef Error: Wrong type for parameter `{mysignature.mparameters[i].name}'. found {myt}, expected {prt} as in {mpropdef.mproperty.intro}.")
712 end
713 end
714 end
715 if precursor_ret_type != null then
716 if ret_type == null then
717 # Inherit the return type
718 ret_type = precursor_ret_type
719 else if not ret_type.is_subtype(mmodule, mclassdef.bound_mtype, precursor_ret_type) then
720 modelbuilder.error(nsig.n_type.as(not null), "Redef Error: Wrong return type. found {ret_type}, expected {precursor_ret_type} as in {mpropdef.mproperty.intro}.")
721 end
722 end
723 end
724
725 if mysignature.arity > 0 then
726 # Check parameters visibility
727 for i in [0..mysignature.arity[ do
728 var nt = nsig.n_params[i].n_type
729 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
730 end
731 var nt = nsig.n_type
732 if nt != null then modelbuilder.check_visibility(nt, nt.mtype.as(not null), mpropdef)
733 end
734 end
735 end
736
737 redef class AAttrPropdef
738 redef type MPROPDEF: MAttributeDef
739
740 # Is the node tagged `noinit`?
741 var noinit = false
742
743 # Is the node tagged lazy?
744 var is_lazy = false
745
746 # The guard associated to a lazy attribute.
747 # Because some engines does not have a working `isset`,
748 # this additional attribute is used to guard the lazy initialization.
749 # TODO: to remove once isset is correctly implemented
750 var mlazypropdef: nullable MAttributeDef
751
752 # The associated getter (read accessor) if any
753 var mreadpropdef: nullable MMethodDef is writable
754 # The associated setter (write accessor) if any
755 var mwritepropdef: nullable MMethodDef is writable
756
757 redef fun build_property(modelbuilder, mclassdef)
758 do
759 var mclass = mclassdef.mclass
760
761 var name: String
762 name = self.n_id2.text
763
764 if mclass.kind == interface_kind or mclassdef.mclass.kind == enum_kind then
765 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the interface {mclass}.")
766 else if mclass.kind == enum_kind then
767 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the enum class {mclass}.")
768 else if mclass.kind == extern_kind then
769 modelbuilder.error(self, "Error: Attempt to define attribute {name} in the extern class {mclass}.")
770 end
771
772 # New attribute style
773 var nid2 = self.n_id2
774 var mprop = new MAttribute(mclassdef, "_" + name, private_visibility)
775 var mpropdef = new MAttributeDef(mclassdef, mprop, self.location)
776 self.mpropdef = mpropdef
777 modelbuilder.mpropdef2npropdef[mpropdef] = self
778
779 var readname = name
780 var mreadprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, readname).as(nullable MMethod)
781 if mreadprop == null then
782 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
783 mreadprop = new MMethod(mclassdef, readname, mvisibility)
784 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, false, mreadprop) then return
785 mreadprop.deprecation = mprop.deprecation
786 else
787 if not self.check_redef_keyword(modelbuilder, mclassdef, n_kwredef, true, mreadprop) then return
788 check_redef_property_visibility(modelbuilder, self.n_visibility, mreadprop)
789 end
790 mclassdef.mprop2npropdef[mreadprop] = self
791
792 var mreadpropdef = new MMethodDef(mclassdef, mreadprop, self.location)
793 self.mreadpropdef = mreadpropdef
794 modelbuilder.mpropdef2npropdef[mreadpropdef] = self
795 set_doc(mreadpropdef, modelbuilder)
796 mpropdef.mdoc = mreadpropdef.mdoc
797
798 var atlazy = self.get_single_annotation("lazy", modelbuilder)
799 if atlazy != null then
800 if n_expr == null then
801 modelbuilder.error(atlazy, "Error: a lazy attribute needs a value")
802 end
803 is_lazy = true
804 var mlazyprop = new MAttribute(mclassdef, "lazy _" + name, none_visibility)
805 var mlazypropdef = new MAttributeDef(mclassdef, mlazyprop, self.location)
806 self.mlazypropdef = mlazypropdef
807 end
808
809 var atreadonly = self.get_single_annotation("readonly", modelbuilder)
810 if atreadonly != null then
811 if n_expr == null then
812 modelbuilder.error(atreadonly, "Error: a readonly attribute needs a value")
813 end
814 # No setter, so just leave
815 return
816 end
817
818 var writename = name + "="
819 var atwritable = self.get_single_annotation("writable", modelbuilder)
820 if atwritable != null then
821 if not atwritable.n_args.is_empty then
822 writename = atwritable.arg_as_id(modelbuilder) or else writename
823 end
824 end
825 var mwriteprop = modelbuilder.try_get_mproperty_by_name(nid2, mclassdef, writename).as(nullable MMethod)
826 var nwkwredef: nullable Token = null
827 if atwritable != null then nwkwredef = atwritable.n_kwredef
828 if mwriteprop == null then
829 var mvisibility
830 if atwritable != null then
831 mvisibility = new_property_visibility(modelbuilder, mclassdef, atwritable.n_visibility)
832 else
833 mvisibility = private_visibility
834 end
835 mwriteprop = new MMethod(mclassdef, writename, mvisibility)
836 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef, false, mwriteprop) then return
837 mwriteprop.deprecation = mprop.deprecation
838 else
839 if not self.check_redef_keyword(modelbuilder, mclassdef, nwkwredef or else n_kwredef, true, mwriteprop) then return
840 if atwritable != null then
841 check_redef_property_visibility(modelbuilder, atwritable.n_visibility, mwriteprop)
842 end
843 end
844 mclassdef.mprop2npropdef[mwriteprop] = self
845
846 var mwritepropdef = new MMethodDef(mclassdef, mwriteprop, self.location)
847 self.mwritepropdef = mwritepropdef
848 modelbuilder.mpropdef2npropdef[mwritepropdef] = self
849 mwritepropdef.mdoc = mpropdef.mdoc
850 end
851
852 redef fun build_signature(modelbuilder)
853 do
854 var mpropdef = self.mpropdef
855 if mpropdef == null then return # Error thus skipped
856 var mclassdef = mpropdef.mclassdef
857 var mmodule = mclassdef.mmodule
858 var mtype: nullable MType = null
859
860 var mreadpropdef = self.mreadpropdef
861
862 var ntype = self.n_type
863 if ntype != null then
864 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
865 if mtype == null then return
866 end
867
868 # Inherit the type from the getter (usually an abstract getter)
869 if mtype == null and mreadpropdef != null and not mreadpropdef.is_intro then
870 var msignature = mreadpropdef.mproperty.intro.msignature
871 if msignature == null then return # Error, thus skipped
872 mtype = msignature.return_mtype
873 end
874
875 var nexpr = self.n_expr
876 if mtype == null then
877 if nexpr != null then
878 if nexpr isa ANewExpr then
879 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, nexpr.n_type)
880 else if nexpr isa AIntExpr then
881 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Int")
882 if cla != null then mtype = cla.mclass_type
883 else if nexpr isa AFloatExpr then
884 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Float")
885 if cla != null then mtype = cla.mclass_type
886 else if nexpr isa ACharExpr then
887 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Char")
888 if cla != null then mtype = cla.mclass_type
889 else if nexpr isa ABoolExpr then
890 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "Bool")
891 if cla != null then mtype = cla.mclass_type
892 else if nexpr isa ASuperstringExpr then
893 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
894 if cla != null then mtype = cla.mclass_type
895 else if nexpr isa AStringFormExpr then
896 var cla = modelbuilder.try_get_mclass_by_name(nexpr, mmodule, "String")
897 if cla != null then mtype = cla.mclass_type
898 else
899 modelbuilder.error(self, "Error: Untyped attribute {mpropdef}. Implicit typing allowed only for literals and new.")
900 end
901
902 if mtype == null then return
903 end
904 else if ntype != null then
905 if nexpr isa ANewExpr then
906 var xmtype = modelbuilder.resolve_mtype(mmodule, mclassdef, nexpr.n_type)
907 if xmtype == mtype then
908 modelbuilder.advice(ntype, "useless-type", "Warning: useless type definition")
909 end
910 end
911 end
912
913 if mtype == null then
914 modelbuilder.error(self, "Error: Untyped attribute {mpropdef}")
915 return
916 end
917
918 mpropdef.static_mtype = mtype
919
920 if mreadpropdef != null then
921 var msignature = new MSignature(new Array[MParameter], mtype)
922 mreadpropdef.msignature = msignature
923 end
924
925 var mwritepropdef = self.mwritepropdef
926 if mwritepropdef != null then
927 var name: String
928 name = n_id2.text
929 var mparameter = new MParameter(name, mtype, false)
930 var msignature = new MSignature([mparameter], null)
931 mwritepropdef.msignature = msignature
932 end
933
934 var mlazypropdef = self.mlazypropdef
935 if mlazypropdef != null then
936 mlazypropdef.static_mtype = modelbuilder.model.get_mclasses_by_name("Bool").first.mclass_type
937 end
938 end
939
940 redef fun check_signature(modelbuilder)
941 do
942 var mpropdef = self.mpropdef
943 if mpropdef == null then return # Error thus skipped
944 var ntype = self.n_type
945 var mtype = self.mpropdef.static_mtype
946 if mtype == null then return # Error thus skipped
947
948 # Lookup for signature in the precursor
949 # FIXME all precursors should be considered
950 if not mpropdef.is_intro then
951 var precursor_type = mpropdef.mproperty.intro.static_mtype
952 if precursor_type == null then return
953
954 if mtype != precursor_type then
955 modelbuilder.error(ntype.as(not null), "Redef Error: Wrong static type. found {mtype}, expected {precursor_type}.")
956 return
957 end
958 end
959
960 # Check getter and setter
961 var meth = self.mreadpropdef
962 if meth != null then
963 self.check_method_signature(modelbuilder, meth)
964 var node: nullable ANode = ntype
965 if node == null then node = self
966 modelbuilder.check_visibility(node, mtype, meth)
967 end
968 meth = self.mwritepropdef
969 if meth != null then
970 self.check_method_signature(modelbuilder, meth)
971 var node: nullable ANode = ntype
972 if node == null then node = self
973 modelbuilder.check_visibility(node, mtype, meth)
974 end
975 end
976
977 private fun check_method_signature(modelbuilder: ModelBuilder, mpropdef: MMethodDef)
978 do
979 var mclassdef = mpropdef.mclassdef
980 var mmodule = mclassdef.mmodule
981 var nsig = self.n_type
982 var mysignature = mpropdef.msignature
983 if mysignature == null then return # Error thus skiped
984
985 # Lookup for signature in the precursor
986 # FIXME all precursors should be considered
987 if not mpropdef.is_intro then
988 var msignature = mpropdef.mproperty.intro.msignature
989 if msignature == null then return
990
991 if mysignature.arity != msignature.arity then
992 var node: ANode
993 if nsig != null then node = nsig else node = self
994 modelbuilder.error(node, "Redef Error: {mysignature.arity} parameters found, {msignature.arity} expected. Signature is {mpropdef}{msignature}")
995 return
996 end
997 var precursor_ret_type = msignature.return_mtype
998 var ret_type = mysignature.return_mtype
999 if ret_type != null and precursor_ret_type == null then
1000 var node: ANode
1001 if nsig != null then node = nsig else node = self
1002 modelbuilder.error(node, "Redef Error: {mpropdef.mproperty} is a procedure, not a function.")
1003 return
1004 end
1005
1006 if mysignature.arity > 0 then
1007 # Check parameters types
1008 for i in [0..mysignature.arity[ do
1009 var myt = mysignature.mparameters[i].mtype
1010 var prt = msignature.mparameters[i].mtype
1011 if not myt.is_subtype(mmodule, mclassdef.bound_mtype, prt) or
1012 not prt.is_subtype(mmodule, mclassdef.bound_mtype, myt) then
1013 var node: ANode
1014 if nsig != null then node = nsig else node = self
1015 modelbuilder.error(node, "Redef Error: Wrong type for parameter `{mysignature.mparameters[i].name}'. found {myt}, expected {prt}.")
1016 end
1017 end
1018 end
1019 if precursor_ret_type != null then
1020 if ret_type == null then
1021 # Inherit the return type
1022 ret_type = precursor_ret_type
1023 else if not ret_type.is_subtype(mmodule, mclassdef.bound_mtype, precursor_ret_type) then
1024 var node: ANode
1025 if nsig != null then node = nsig else node = self
1026 modelbuilder.error(node, "Redef Error: Wrong return type. found {ret_type}, expected {precursor_ret_type}.")
1027 end
1028 end
1029 end
1030 end
1031 end
1032
1033 redef class ATypePropdef
1034 redef type MPROPDEF: MVirtualTypeDef
1035
1036 redef fun build_property(modelbuilder, mclassdef)
1037 do
1038 var name = self.n_id.text
1039 var mprop = modelbuilder.try_get_mproperty_by_name(self.n_id, mclassdef, name)
1040 if mprop == null then
1041 var mvisibility = new_property_visibility(modelbuilder, mclassdef, self.n_visibility)
1042 mprop = new MVirtualTypeProp(mclassdef, name, mvisibility)
1043 for c in name.chars do if c >= 'a' and c<= 'z' then
1044 modelbuilder.warning(n_id, "bad-type-name", "Warning: lowercase in the virtual type {name}")
1045 break
1046 end
1047 if not self.check_redef_keyword(modelbuilder, mclassdef, self.n_kwredef, false, mprop) then return
1048 else
1049 if not self.check_redef_keyword(modelbuilder, mclassdef, self.n_kwredef, true, mprop) then return
1050 assert mprop isa MVirtualTypeProp
1051 check_redef_property_visibility(modelbuilder, self.n_visibility, mprop)
1052 end
1053 mclassdef.mprop2npropdef[mprop] = self
1054
1055 var mpropdef = new MVirtualTypeDef(mclassdef, mprop, self.location)
1056 self.mpropdef = mpropdef
1057 modelbuilder.mpropdef2npropdef[mpropdef] = self
1058 set_doc(mpropdef, modelbuilder)
1059
1060 var atfixed = get_single_annotation("fixed", modelbuilder)
1061 if atfixed != null then
1062 mpropdef.is_fixed = true
1063 end
1064 end
1065
1066 redef fun build_signature(modelbuilder)
1067 do
1068 var mpropdef = self.mpropdef
1069 if mpropdef == null then return # Error thus skipped
1070 var mclassdef = mpropdef.mclassdef
1071 var mmodule = mclassdef.mmodule
1072 var mtype: nullable MType = null
1073
1074 var ntype = self.n_type
1075 mtype = modelbuilder.resolve_mtype(mmodule, mclassdef, ntype)
1076 if mtype == null then return
1077
1078 mpropdef.bound = mtype
1079 # print "{mpropdef}: {mtype}"
1080 end
1081
1082 redef fun check_signature(modelbuilder)
1083 do
1084 var mpropdef = self.mpropdef
1085 if mpropdef == null then return # Error thus skipped
1086
1087 var bound = self.mpropdef.bound
1088 if bound == null then return # Error thus skipped
1089
1090 modelbuilder.check_visibility(n_type, bound, mpropdef)
1091
1092 var mclassdef = mpropdef.mclassdef
1093 var mmodule = mclassdef.mmodule
1094 var anchor = mclassdef.bound_mtype
1095
1096 # Check circularity
1097 if bound isa MVirtualType then
1098 # Slow case: progress on each resolution until: (i) we loop, or (ii) we found a non formal type
1099 var seen = [self.mpropdef.mproperty.mvirtualtype]
1100 loop
1101 if seen.has(bound) then
1102 seen.add(bound)
1103 modelbuilder.error(self, "Error: circularity of virtual type definition: {seen.join(" -> ")}")
1104 return
1105 end
1106 seen.add(bound)
1107 var next = bound.lookup_bound(mmodule, anchor)
1108 if not next isa MVirtualType then break
1109 bound = next
1110 end
1111 end
1112
1113 # Check redefinitions
1114 bound = mpropdef.bound.as(not null)
1115 for p in mpropdef.mproperty.lookup_super_definitions(mmodule, anchor) do
1116 var supbound = p.bound.as(not null)
1117 if p.is_fixed then
1118 modelbuilder.error(self, "Redef Error: Virtual type {mpropdef.mproperty} is fixed in super-class {p.mclassdef.mclass}")
1119 break
1120 end
1121 if p.mclassdef.mclass == mclassdef.mclass then
1122 # Still a warning to pass existing bad code
1123 modelbuilder.warning(n_type, "refine-type", "Redef Error: a virtual type cannot be refined.")
1124 break
1125 end
1126 if not bound.is_subtype(mmodule, anchor, supbound) then
1127 modelbuilder.error(n_type, "Redef Error: Wrong bound type. Found {bound}, expected a subtype of {supbound}, as in {p}.")
1128 break
1129 end
1130 end
1131 end
1132 end