494d099190f6ce6b27218be02300f8411a7d0b22
[nit.git] / src / syntax / mmbuilder.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2008 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 # Build MM entity from NIT AST and check conformance of these entities.
18 # This module introduce specific MM class (MMSrcXXX) that specialize the abstract one from metamodel
19 #
20 package mmbuilder
21
22 import syntax_base
23
24 # Class specialization hierarchy sorter
25 private class CSHSorter
26 super AbstractSorter[MMLocalClass]
27 redef fun compare(a, b)
28 do
29 return a.cshe.rank <=> b.cshe.rank
30 end
31
32 init do end
33 end
34
35 redef class MMSrcModule
36 # Syntax analysis and MM construction for the module
37 # Require that supermodules are processed
38 fun do_mmbuilder(tc: ToolContext)
39 do
40 # Import global classes
41 import_global_classes
42
43 # Create local classes and attach them to global classes
44 var mmbv = new ClassBuilderVisitor(tc, self)
45 mmbv.enter_visit(node)
46 tc.check_errors
47
48 if mhe.direct_greaters.is_empty then
49 process_default_classes(tc)
50 end
51
52 # Import unrefined local classes and attach them to global classes
53 import_local_classes
54
55 # Resolve classes in super clauses
56 var mmbv1 = new ClassSpecializationBuilderVisitor(tc, self)
57 mmbv1.enter_visit(node)
58 tc.check_errors
59
60 # Compute specialization relation
61 for c in local_classes do
62 if visibility_for(c.global.intro.mmmodule) < c.global.visibility_level then
63 continue
64 end
65 c.compute_super_classes
66 end
67 tc.check_errors
68
69 # Class that we will process now are those in the hierarchy
70 # Its mean all the visible classes and their super-classes
71 # Note that leaves invisible classes are not in the 'classes' set
72 var classes = class_specialization_hierarchy.to_a
73
74 # Prepare class list to process the following in a right order
75 var sorter = once new CSHSorter
76 sorter.sort(classes)
77
78 # Compute class ancestors types
79 var mmbv1b = new ClassAncestorBuilder(tc, self)
80 for c in classes do
81 c.accept_class_visitor(mmbv1b)
82 tc.check_errors
83 c.compute_ancestors
84 end
85
86 # Check class conformity
87 var mmbv1c = new ClassVerifierVisitor(tc, self)
88 for c in classes do
89 c.accept_class_visitor(mmbv1c)
90 end
91 tc.check_errors
92
93 # Property inhritance and introduction
94 var mmbv2 = new PropertyBuilderVisitor(tc, self)
95 for c in classes do
96 # Global property introduction and redefinition
97 c.accept_class_visitor(mmbv2)
98
99 # Default and inherited constructor if needed
100 if c isa MMSrcLocalClass and c.global.intro == c and not c.global.is_enum and not c.global.is_extern and not c.global.is_interface then
101 c.process_default_constructors(mmbv2)
102 end
103
104 # Note that inherited unredefined property are processed on demand latter
105 end
106 tc.check_errors
107
108 # Property signature analysis and inheritance conformance
109 var mmbv3 = new PropertyVerifierVisitor(tc, self)
110 for c in classes do
111 c.accept_properties_visitor(mmbv3)
112 end
113
114 tc.check_errors
115 end
116
117 # Create some primitive default classes if they do not exists
118 fun process_default_classes(tc: ToolContext)
119 do
120 var name = once ("Object".to_symbol)
121 if not has_global_class_named(name) then
122 var c = new MMSrcLocalClass(self, name, null, 0)
123 c.new_global
124 src_local_classes[name] = c
125 end
126 name = once ("Bool".to_symbol)
127 if not has_global_class_named(name) then
128 var c = new MMSrcLocalClass(self, name, null, 0)
129 c.new_global
130 src_local_classes[name] = c
131 end
132 end
133 end
134
135 redef class MMLocalClass
136 # Accept a class visitor (on class nodes)
137 private fun accept_class_visitor(v: AbsSyntaxVisitor)
138 do
139 end
140
141 # Accept a class visitor (on class properties)
142 private fun accept_properties_visitor(v: AbsSyntaxVisitor)
143 do
144 end
145 end
146
147 redef class MMSrcLocalClass
148 redef fun accept_class_visitor(v)
149 do
150 var n = node
151 while n != null do
152 v.enter_visit(n)
153 n = n.next_node
154 end
155 end
156
157 # Accept a class visitor (on class properties)
158 redef fun accept_properties_visitor(v)
159 do
160 var n = node
161 while n != null do
162 v.enter_visit(n)
163 n = n.next_node
164 end
165
166 for p in src_local_properties do
167 p.accept_property_visitor(v)
168 end
169 end
170
171 # Introduce or inherit default constructors
172 private fun process_default_constructors(v: PropertyBuilderVisitor)
173 do
174 # Is there already a constructor ?
175 for gp in global_properties do
176 if gp.is_init then
177 # Return if explicit constructor in the class
178 if gp.intro.local_class == self then return
179 end
180 end
181
182 # Collect visible constructors in super stateful classes
183 var super_inits = new ArraySet[MMLocalProperty]
184 var super_constructors = new ArraySet[MMGlobalProperty]
185 for sc in che.direct_greaters do
186 if sc.global.is_enum and not sc.global.is_extern or sc.global.is_interface then continue
187 for gp in sc.global_properties do
188 if not gp.is_init then continue
189 super_constructors.add(gp)
190 end
191 var initname = once ("init".to_symbol)
192 if sc.has_global_property_by_name(initname) then
193 var gp = sc.get_property_by_name(initname)
194 super_inits.add(self[gp])
195 end
196 end
197
198 # Collect unassigned attributes
199 var unassigned_attributes = new Array[MMSrcAttribute]
200 for a in src_local_properties do
201 if a isa MMSrcAttribute then
202 var n = a.node
203 if n.n_expr == null then unassigned_attributes.add(a)
204 end
205 end
206
207 if not super_constructors.is_empty then
208 # Select most specific classes introducing inheritable constructors
209 # Mixin classes are skipped
210 var supers = new Array[MMLocalClass]
211 for gp in super_constructors do
212 var sc = gp.local_class
213 if supers.has(sc) then continue
214 if not sc.global.is_mixin then
215 supers.add(sc)
216 end
217 end
218 supers = che.order.select_smallests(supers)
219
220 # A mixin class can only have 0 or 1 most specific non-mixin superclass
221 var superclass: nullable MMLocalClass = null # This most specific non-mixin superclass (if any)
222
223 if supers.length > 1 then
224 v.error(node, "Error: Explicit constructor required in {self} since multiple inheritance of constructor is forbiden. Conflicting classes are {supers.join(", ")}. Costructors are {super_constructors.join(", ")}.")
225 return
226 else if supers.length == 1 then
227 superclass = supers.first
228 end
229
230 for gp in super_constructors do
231 # Inherit constructors : the one of the non-mixin super class or all from the all mixin super-classes
232 if superclass == null or gp.local_class == superclass then
233 make_visible_an_inherited_global_property(gp)
234 end
235 end
236 global.mixin_of = superclass.as(not null).global # FIXME Dear! this should break!
237 else
238 # v.error(nodes.first, "Error, constructor required in {self} since no anonimous init found in {sc}.")
239
240 # unassigned attributes, then implicit consructors are generated
241 var p = new MMImplicitInit(self, unassigned_attributes, super_inits.to_a)
242 add_src_local_property(v, p)
243 #print("Create implicit init {p} in {self} from {super_inits.join(", ")} + {unassigned_attributes.length} args")
244 end
245 end
246
247 # Add a source property
248 # Register it to the class and attach it to global property
249 private fun add_src_local_property(v: PropertyBuilderVisitor, prop: MMLocalProperty)
250 do
251 var pname = prop.name
252 # Check double definition in the same class
253 if src_local_properties.has_key(pname) then
254 v.error(prop.node, "Error: A property {pname} is already defined in class {name}.")
255 return
256 end
257 src_local_properties[pname] = prop
258
259 # Intro or redefinition ?
260 if has_global_property_by_name(pname) then
261 var g = get_property_by_name(pname)
262 prop.inherit_global(g)
263 end
264
265 if not prop.is_global_set then
266 prop.new_global
267 prop.global.is_init = prop.is_init
268 end
269 end
270 end
271
272 redef class MMLocalProperty
273 private fun accept_property_visitor(v: AbsSyntaxVisitor)
274 do
275 end
276 end
277
278 redef class MMImplicitInit
279 redef readable var _super_init: nullable MMLocalProperty = null
280 redef fun accept_property_visitor(v)
281 do
282 var base: nullable MMLocalProperty = null
283 for p in super_inits do
284 if p.signature.arity > 0 then
285 if base == null then
286 base = p
287 else
288 v.error(null, "Error: explicit constructor needed in {local_class} since both super-constructor {base.full_name} and {p.full_name} have paramters")
289 return
290 end
291 end
292 end
293 _super_init = base
294
295 var params = new Array[MMParam]
296 if base != null then
297 var sig = base.signature
298 for i in [0..sig.arity[ do
299 params.add(sig.params[i])
300 end
301 end
302 for a in unassigned_attributes do
303 var sig = a.signature
304 if sig == null then return # Broken attribute definition
305 params.add( new MMParam( sig.return_type.as(not null), once "recv".to_symbol))
306 end
307 signature = new MMSignature(params, null, local_class.get_type)
308 end
309 end
310
311
312 # Concrete NIT class specialization relation
313 class MMSrcAncestor
314 super MMAncestor
315 redef readable var _local_class: MMLocalClass
316
317 init(c: MMLocalClass)
318 do
319 _local_class = c
320 end
321 end
322
323 ###############################################################################
324
325 # A pass visitor for syntax analysis.
326 # * Build the classes and attach them to global classes
327 # * Collect generic formal parameters.
328 private class ClassBuilderVisitor
329 super AbsSyntaxVisitor
330 # Current class arity
331 readable writable var _local_class_arity: Int = 0
332
333 # Current class formal parameters
334 readable writable var _formals: nullable Map[Symbol, MMTypeFormalParameter]
335
336 redef fun visit(n) do n.accept_class_builder(self)
337 init(tc, m) do super
338 end
339
340 # Another pass visitor for syntax analysis.
341 # * Build ancertors (with only class informations not the type one)
342 private class ClassSpecializationBuilderVisitor
343 super AbsSyntaxVisitor
344 redef fun visit(n) do n.accept_class_specialization_builder(self)
345 init(tc, m) do super
346 end
347
348 # Another pass visitor for syntax analysis.
349 # * Compute types in ancestors
350 private class ClassAncestorBuilder
351 super AbsSyntaxVisitor
352 redef fun visit(n) do n.accept_class_ancestor_builder(self)
353 init(tc, m) do super
354 end
355
356 # Another pass visitor for syntax analysis.
357 # * Checks classes in regard to superclasses
358 private class ClassVerifierVisitor
359 super AbsSyntaxVisitor
360 redef fun visit(n) do n.accept_class_verifier(self)
361 init(tc, m) do super
362 end
363
364
365 # Another pass visitor for syntax analysis.
366 # * Build propertie names
367 # * Build local properties and attache them to global properties
368 # * Attach bound to formal types
369 private class PropertyBuilderVisitor
370 super AbsSyntaxVisitor
371 redef fun visit(n) do n.accept_property_builder(self)
372 init(tc, m) do super
373 end
374
375 # Another pass pass visitor for syntax analysis.
376 # * Check property conformance
377 private class PropertyVerifierVisitor
378 super AbsSyntaxVisitor
379
380 # The signature currently build
381 readable writable var _signature_builder: SignatureBuilder
382
383 redef fun visit(n) do n.accept_property_verifier(self)
384
385 init(tc, m)
386 do
387 super
388 _signature_builder = new SignatureBuilder
389 end
390 end
391
392 # Information about a signature currently build
393 private class SignatureBuilder
394 # Current visited parameter types
395 readable writable var _params: Array[AParam] = new Array[AParam]
396
397 # Visited parameters without type information added
398 readable writable var _untyped_params: Array[AParam] = new Array[AParam]
399
400 # Position of the current star parameter
401 readable writable var _vararg_rank: Int = -1
402
403 # Current closure declarations
404 readable writable var _closure_decls: Array[AClosureDecl] = new Array[AClosureDecl]
405
406 # True is a problen occured durring building
407 readable writable var _has_error_occured: Bool = false
408
409 # Current signature
410 readable writable var _signature: nullable MMSignature = null
411 end
412
413 ###############################################################################
414
415 redef class ANode
416 private fun accept_class_builder(v: ClassBuilderVisitor) do accept_abs_syntax_visitor(v)
417 private fun accept_class_specialization_builder(v: ClassSpecializationBuilderVisitor) do accept_abs_syntax_visitor(v)
418 private fun accept_class_ancestor_builder(v: ClassAncestorBuilder) do accept_abs_syntax_visitor(v)
419 private fun accept_class_verifier(v: ClassVerifierVisitor) do accept_abs_syntax_visitor(v)
420 private fun accept_property_builder(v: PropertyBuilderVisitor) do accept_abs_syntax_visitor(v)
421 private fun accept_property_verifier(v: PropertyVerifierVisitor) do accept_abs_syntax_visitor(v)
422 end
423
424 redef class AModule
425 # Import supermodules and compute visibility
426 fun import_super_modules(tc: ToolContext, mod: MMSrcModule)
427 do
428 # Import super-modules
429 var supers = new Array[MMModule]
430 var no_import: nullable AImport = null
431 for i in n_imports do
432 var n = i.module_name
433 if n != null then
434 var m = tc.get_module(n, mod)
435 supers.add(m)
436 mod.add_super_module(m, i.visibility_level)
437 else
438 no_import = i
439 end
440 end
441 if no_import != null then
442 if not supers.is_empty then
443 tc.error(no_import.location, "Error: Top modules cannot import other modules.")
444 end
445 else if supers.is_empty then
446 var stdname = once "standard".to_symbol
447 var m = tc.get_module(stdname, mod)
448 supers.add(m)
449 mod.add_super_module(m, 1)
450 end
451
452 tc.add_module(mod, supers)
453 end
454 end
455
456 redef class AModuledecl
457 redef fun accept_class_builder(v)
458 do
459 if n_name.n_id.to_symbol != v.mmmodule.name then
460 v.error(n_name.n_id, "Error: Module name mismatch between {v.mmmodule.name} and {n_name.n_id.to_symbol}")
461 end
462 end
463 end
464
465 redef class AImport
466 # Imported module name (or null)
467 fun module_name: nullable Symbol is abstract
468
469 # Visibility level (intrude/public/private)
470 fun visibility_level: Int is abstract
471 end
472 redef class AStdImport
473 redef fun module_name
474 do
475 return n_name.n_id.to_symbol
476 end
477 redef fun visibility_level
478 do
479 return n_visibility.level
480 end
481 end
482 redef class ANoImport
483 redef fun module_name
484 do
485 return null
486 end
487 end
488
489 redef class AVisibility
490 # Visibility level
491 fun level: Int is abstract
492 end
493 redef class APublicVisibility
494 redef fun level do return 1
495 end
496 redef class AProtectedVisibility
497 redef fun level do return 2
498 end
499 redef class APrivateVisibility
500 redef fun level do return 3
501 end
502 redef class AIntrudeVisibility
503 redef fun level do return 0
504 end
505
506
507 redef class AClassdef
508 redef fun local_class: MMSrcLocalClass do return _local_class.as(not null)
509 var _local_class: nullable MMSrcLocalClass
510
511 # Name of the class
512 fun name: Symbol is abstract
513
514 # Number of formal parameters
515 fun arity: Int do return 0
516
517 # Visibility of the class
518 fun visibility_level: Int do return 1
519
520 redef fun accept_class_builder(v)
521 do
522 var local_class: MMSrcLocalClass
523 var mod = v.mmmodule
524 var local_classes = mod.src_local_classes
525 if (local_classes.has_key(name)) then
526 local_class = local_classes[name]
527 _local_class = local_class
528 if self isa AStdClassdef then
529 # If we are not a special implicit class then rant
530 v.error(self, "Error: A class {name} is already defined at line {local_class.node.location.line_start}.")
531 return
532 end
533 # Add the new node after the last node
534 var n = local_class.node
535 while n.next_node != null do n = n.next_node
536 n.next_node = self
537 else
538 local_class = new MMSrcLocalClass(mod, name, self, arity)
539 _local_class = local_class
540 local_classes[name] = local_class
541 if not mod.has_global_class_named(name) then
542 build_class_introduction(v)
543 else
544 var glob = mod.global_class_named(name)
545 build_class_refinement(v, glob)
546 end
547
548 end
549 v.local_class_arity = 0
550 v.formals = local_class.formal_dict
551
552 #####
553 super
554 #####
555
556 v.formals = null
557 end
558
559 fun build_class_introduction(v: AbsSyntaxVisitor)
560 do
561 local_class.new_global
562 var glob = local_class.global
563
564 glob.visibility_level = visibility_level
565 if self isa AStdClassdef then
566 if n_kwredef != null then
567 v.error(self, "Redef error: No class {name} is imported. Remove the redef keyword to define a new class.")
568 return
569 end
570 glob.is_interface = n_classkind.is_interface
571 glob.is_abstract = n_classkind.is_abstract
572 glob.is_enum = n_classkind.is_enum
573 end
574 end
575
576 fun build_class_refinement(v: AbsSyntaxVisitor, glob: MMGlobalClass)
577 do
578 local_class.set_global(glob)
579
580 glob.check_visibility(v, self, v.mmmodule)
581 if self isa AStdClassdef and n_kwredef == null then
582 v.error(self, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
583 return
584 end
585
586 if glob.intro.arity != _local_class.arity then
587 v.error(self, "Redef error: Formal parameter arity missmatch; got {_local_class.arity}, expected {glob.intro.arity}.")
588 end
589
590 if self isa AStdClassdef and (not glob.is_interface and n_classkind.is_interface or
591 not glob.is_abstract and n_classkind.is_abstract or
592 not glob.is_enum and n_classkind.is_enum)
593 then
594 v.error(self, "Redef error: cannot change kind of class {name}.")
595 end
596 end
597
598 redef fun accept_class_verifier(v)
599 do
600 super
601 var glob = _local_class.global
602 for c in _local_class.cshe.direct_greaters do
603 var cg = c.global
604 if glob.is_interface then
605 if cg.is_enum then
606 v.error(self, "Special error: Interface {name} try to specialise enum class {c.name}.")
607 else if not cg.is_interface then
608 v.error(self, "Special error: Interface {name} try to specialise class {c.name}.")
609 end
610 else if glob.is_enum then
611 if not cg.is_interface and not cg.is_enum then
612 v.error(self, "Special error: Enum class {name} try to specialise class {c.name}.")
613 end
614 else
615 if cg.is_enum then
616 v.error(self, "Special error: Class {name} try to specialise enum class {c.name}.")
617 end
618 end
619
620 end
621 end
622
623 redef fun accept_abs_syntax_visitor(v)
624 do
625 v.local_class = _local_class
626 super
627 v.local_class = null
628 end
629 end
630
631 redef class AClasskind
632 fun is_interface: Bool do return false
633 fun is_enum: Bool do return false
634 fun is_abstract: Bool do return false
635 fun is_extern : Bool do return false
636 end
637
638 redef class AInterfaceClasskind
639 redef fun is_interface do return true
640 end
641 redef class AEnumClasskind
642 redef fun is_enum do return true
643 end
644 redef class AExternClasskind
645 redef fun is_extern do return true
646 end
647 redef class AAbstractClasskind
648 redef fun is_abstract do return true
649 end
650
651 redef class AStdClassdef
652 redef fun name
653 do
654 return n_id.to_symbol
655 end
656 redef fun arity
657 do
658 return n_formaldefs.length
659 end
660 redef fun accept_class_verifier(v)
661 do
662 super
663 var glob = _local_class.global
664 if glob.intro == _local_class then
665 # Intro
666 glob.visibility_level = visibility_level
667 glob.is_interface = n_classkind.is_interface
668 glob.is_abstract = n_classkind.is_abstract
669 glob.is_enum = n_classkind.is_enum
670 glob.is_extern = n_classkind.is_extern
671 if n_kwredef != null then
672 v.error(self, "Redef error: No class {name} is imported. Remove the redef keyword to define a new class.")
673 end
674
675 for c in _local_class.cshe.direct_greaters do
676 var cg = c.global
677 if glob.is_interface then
678 if cg.is_enum then
679 v.error(self, "Special error: Interface {name} try to specialise enum class {c.name}.")
680 else if not cg.is_interface then
681 v.error(self, "Special error: Interface {name} try to specialise class {c.name}.")
682 end
683 else if glob.is_enum then
684 if not cg.is_interface and not cg.is_enum then
685 v.error(self, "Special error: Enum class {name} try to specialise class {c.name}.")
686 end
687 else if glob.is_extern then
688 if not cg.is_interface and not cg.is_extern then
689 v.error(self, "Special error: Extern class {name} try to specialise class {c.name}.")
690 end
691 else
692 if cg.is_enum then
693 v.error(self, "Special error: Class {name} try to specialise enum class {c.name}.")
694 else if cg.is_extern then
695 v.error(self, "Special error: Class {name} try to specialise extern class {c.name}.")
696 end
697 end
698
699 end
700 return
701 end
702
703 # Redef
704
705 glob.check_visibility(v, self, v.mmmodule)
706 if n_kwredef == null then
707 v.error(self, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
708 return
709 end
710
711 if glob.intro.arity != _local_class.arity then
712 v.error(self, "Redef error: Formal parameter arity mismatch; got {_local_class.arity}, expected {glob.intro.arity}.")
713 end
714
715 if
716 not glob.is_interface and n_classkind.is_interface or
717 not glob.is_abstract and n_classkind.is_abstract or
718 not glob.is_enum and n_classkind.is_enum or
719 not glob.is_extern and n_classkind.is_extern
720 then
721 v.error(self, "Redef error: cannot change kind of class {name}.")
722 end
723 end
724
725 redef fun visibility_level
726 do
727 return n_visibility.level
728 end
729 end
730
731 redef class AMainClassdef
732 redef fun name
733 do
734 return once "Sys".to_symbol
735 end
736 end
737
738 redef class ATopClassdef
739 redef fun name
740 do
741 return once "Object".to_symbol
742 end
743 end
744
745 redef class AFormaldef
746 # The associated formal generic parameter (MM entity)
747 var _formal: nullable MMTypeFormalParameter
748
749 redef fun accept_class_builder(v)
750 do
751 var name = n_id.to_symbol
752 var formal_type = new MMTypeFormalParameter(name, v.local_class_arity, v.local_class)
753 _formal = formal_type
754 v.local_class_arity = v.local_class_arity + 1
755 v.local_class.register_formal(formal_type)
756 v.formals[name] = formal_type
757 super
758 end
759
760 redef fun accept_class_verifier(v)
761 do
762 super
763 var c = v.local_class
764 var o = c.global.intro
765 if c == o then
766 if n_type == null then
767 _formal.bound = v.mmmodule.type_any.as_nullable
768 else
769 var stype = n_type.get_stype(v)
770 if stype == null then return
771 _formal.bound = stype
772 end
773 else
774 var ob = o.get_formal(_formal.position).bound.for_module(v.mmmodule)
775 if n_type == null then
776 _formal.bound = ob
777 else
778 var stype = n_type.get_stype(v)
779 if stype == null then return
780 _formal.bound = stype
781 if _formal.bound != ob then
782 v.error(self, "Redef error: Cannot change formal parameter type of class {c}; got {_formal.bound}, expected {ob}.")
783 end
784 end
785 end
786 end
787 end
788
789 redef class ASuperclass
790 readable var _ancestor: nullable MMSrcAncestor
791
792 redef fun accept_class_specialization_builder(v)
793 do
794 super
795 var c = n_type.get_local_class(v)
796 if c == null then return
797 var ancestor = new MMSrcAncestor(c)
798 _ancestor = ancestor
799 v.local_class.add_direct_parent(ancestor)
800 end
801
802 redef fun accept_class_ancestor_builder(v)
803 do
804 super
805 _ancestor.stype = n_type.get_unchecked_stype(v)
806 _ancestor.inheriter = v.local_class.get_type
807 end
808
809 redef fun accept_class_verifier(v)
810 do
811 super
812 n_type.check_conform(v)
813 end
814 end
815
816 redef class APropdef
817 # Process and check properties of the property.
818 # * Distinguish inits and methods
819 # * Inherit or check visibility.
820 # * Check redef errors.
821 # * Check forbiden attribute definitions.
822 # * Check signature conformance.
823 private fun process_and_check(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
824 do
825 if prop.global.intro == prop then
826 do_and_check_intro(v, prop, has_redef, visibility_level)
827 else
828 do_and_check_redef(v, prop, has_redef, visibility_level)
829 end
830 end
831
832 # The part of process_and_check when prop is an introduction
833 private fun do_and_check_intro(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
834 do
835 var glob = prop.global
836 var gbc = prop.local_class.global
837 if v.local_class.global.visibility_level >= 3 then
838 # Method of private classes are private
839 visibility_level = 3
840 end
841 glob.visibility_level = visibility_level
842 if has_redef then
843 v.error(self, "Error: No property {prop.local_class}::{prop} is inherited. Remove the redef keyword to define a new property.")
844 end
845 if glob.is_attribute then
846 if gbc.is_interface then
847 v.error(self, "Error: Attempt to define attribute {prop} in the interface {prop.local_class}.")
848 else if gbc.is_enum then
849 v.error(self, "Error: Attempt to define attribute {prop} in the enum class {prop.local_class}.")
850 else if gbc.is_extern then
851 v.error(self, "Error: Attempt to define attribute {prop} in the extern class {prop.local_class}.")
852 end
853 else if glob.is_init then
854 if gbc.is_interface then
855 v.error(self, "Error: Attempt to define a constructor {prop} in the class {prop.local_class}.")
856 else if gbc.is_enum then
857 v.error(self, "Error: Attempt to define a constructor {prop} in the enum {prop.local_class}.")
858 end
859
860 # ok in extern
861 end
862 if prop.signature == null then
863 if glob.is_init then
864 var supers = prop.local_class.super_methods_named(prop.name)
865 inherit_signature(v, prop, supers)
866 end
867 if prop.signature != null or v.signature_builder.has_error_occured then
868 # ok
869 else if not v.signature_builder.untyped_params.is_empty then
870 v.error(v.signature_builder.untyped_params.first, "Error: Untyped parameter.")
871 else
872 prop.signature = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
873 for clos in v.signature_builder.closure_decls do
874 prop.signature.closures.add(clos.variable.closure)
875 end
876 end
877 end
878 end
879
880 private fun inherit_signature(v: PropertyVerifierVisitor, prop: MMLocalProperty, supers: Array[MMLocalProperty])
881 do
882 var s = prop.signature
883 for ip in supers do
884 var isig = ip.signature.adaptation_to(v.local_class.get_type)
885
886 if s == null then
887 if v.signature_builder.params.length != isig.arity then
888 return
889 end
890 for p in v.signature_builder.params do
891 var t = isig[p.position]
892 p.stype = t
893 if p.position == isig.vararg_rank then
894 t = v.type_array(t)
895 end
896 p.variable.stype = t
897 end
898
899 s = isig
900 prop.signature = s
901 end
902 end
903 end
904
905 # The part of process_and_check when prop is a redefinition
906 private fun do_and_check_redef(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
907 do
908 var is_init = self isa AInitPropdef
909 var glob = prop.global
910
911 if not has_redef then
912 v.error(self, "Redef error: {prop.local_class}::{prop} is an inherited property. To redefine it, add the redef keyword.")
913 return
914 end
915 if glob.is_init and not is_init then
916 v.error(self, "Redef error: A method {prop.local_class}::{prop} cannot redefine a constructor.")
917 else if not glob.is_init and is_init then
918 v.error(self, "Redef error: A constructor {prop.local_class}::{prop} cannot redefine a method.")
919 end
920
921 var s = prop.signature
922 #print "process {prop.local_class.mmmodule}::{prop.local_class}::{prop} from global {prop.global.local_property.local_class.mmmodule}::{prop.global.local_property.local_class}::{prop.global.local_property}"
923 for i in prop.prhe.direct_greaters do
924 var ip = i.local_class[prop.global]
925 var isig = i.signature
926 if isig == null then break # previous signature is invalid
927 isig = isig.adaptation_to(v.local_class.get_type)
928
929 if s == null then
930 #print "{prop.full_name} inherits signature from {ip.full_name}"
931 if v.signature_builder.params.length != isig.arity then
932 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} parameter(s).")
933 return
934 end
935 if v.signature_builder.closure_decls.length != isig.closures.length then
936 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} closure(s).")
937 return
938 end
939 for p in v.signature_builder.params do
940 var t = isig[p.position]
941 p.stype = t
942 if p.position == isig.vararg_rank then
943 t = v.type_array(t)
944 end
945 p.variable.stype = t
946 end
947 s = isig
948 prop.signature = s
949 #print "s is null"
950 end
951
952 var nberr = v.tc.error_count
953 #print "Check {prop.local_class}::{prop}{s} vs {ip.local_class}::{ip}{isig}"
954 #print "s={s.object_id} isig={isig.object_id} isigorig={i.signature.object_id}"
955
956 #print "orig signature: {i.signature.recv} . {i.signature}"
957 #print "inh signature: {isig.recv} . {isig}"
958 #print "redef signature: {s.recv} . {s}"
959
960 if s.arity != isig.arity then
961 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} parameter(s).")
962 else if s.arity > 0 then
963 if self isa AMethPropdef then
964 # A standard method
965 for j in [0..s.arity[ do
966 if s[j] != isig[j] then
967 v.error(n_signature.n_params[j], "Redef error: Expected {isig[j]}, as in {ip.local_class}::{ip}.")
968 end
969 end
970 else if self isa AAttrPropdef then
971 # A write accessor
972 if s[0] != isig[0] then
973 v.error(n_type, "Redef error: Expected {isig[0]}, as in the parameter of {ip.local_class}::{ip}.")
974 end
975
976 else
977 abort #
978 end
979 end
980
981 var srt = s.return_type
982 var isrt = isig.return_type
983 if srt == null and isrt != null then
984 v.error(self, "Redef error: The procedure {prop.local_class}::{prop} redefines the function {ip.local_class}::{ip}.")
985 else if srt != null and isrt == null then
986 v.error(self, "Redef error: The function {prop.local_class}::{prop} redefines the procedure {ip.local_class}::{ip}.")
987 else if srt != null and isrt != null and not srt < isrt then
988 var n: nullable ANode = null
989 if self isa AMethPropdef then
990 n = self.n_signature.n_type
991 else if self isa AAttrPropdef then
992 n = self.n_type
993 else if self isa ATypePropdef then
994 n = self.n_type
995 end
996 v.error(n, "Redef error: Expected {isrt}, as in {ip.local_class}::{ip}.")
997 else if not s < isig and nberr == v.tc.error_count then
998 # Systematic fallback for conformance check
999 v.error(self, "Redef error: Incompatible redefinition of {ip.local_class}::{ip} with {prop.local_class}::{prop}")
1000 else if srt != null and isrt != null and srt != isrt and prop isa MMAttribute then
1001 # FIXME: To remove
1002 v.warning(self, "Redef warning: Expected {isrt}, as in {ip.local_class}::{ip}.")
1003 end
1004 end
1005
1006 if visibility_level != 1 and glob.visibility_level != visibility_level then
1007 v.error(self, "Redef error: {prop.local_class}::{prop} redefinition cannot change visibility.")
1008 end
1009 glob.check_visibility(v, self, v.mmmodule, true)
1010 end
1011 end
1012
1013 redef class AAttrPropdef
1014 redef readable var _readmethod: nullable MMSrcMethod
1015 redef readable var _writemethod: nullable MMSrcMethod
1016 var _prop: nullable MMSrcAttribute
1017 redef fun prop do return _prop.as(not null)
1018
1019 redef fun accept_property_builder(v)
1020 do
1021 super
1022 var name: Symbol
1023 if n_id != null then
1024 name = n_id.to_symbol
1025 else
1026 name = ("@" + n_id2.text).to_symbol
1027 end
1028 var lc = v.local_class
1029 var prop = new MMSrcAttribute(name, lc, self)
1030 _prop = prop
1031 v.local_class.add_src_local_property(v, prop)
1032
1033 if n_readable != null or n_id == null then
1034 if n_id != null then
1035 name = n_id.text.substring_from(1).to_symbol
1036 else
1037 name = n_id2.to_symbol
1038 end
1039 var readmethod = new MMReadImplementationMethod(name, lc, self)
1040 _readmethod = readmethod
1041 v.local_class.add_src_local_property(v, readmethod)
1042 end
1043 if n_writable != null or n_id == null then
1044 if n_id != null then
1045 name = (n_id.text.substring_from(1) + "=").to_symbol
1046 else
1047 name = (n_id2.text + "=").to_symbol
1048 end
1049 var writemethod = new MMWriteImplementationMethod(name, lc, self)
1050 _writemethod = writemethod
1051 v.local_class.add_src_local_property(v, writemethod)
1052 end
1053 end
1054
1055 redef fun accept_property_verifier(v)
1056 do
1057 super
1058 var t: MMType
1059 if n_type != null then
1060 var t0 = n_type.get_stype(v)
1061 if t0 != null then t = t0 else return
1062 else
1063 v.error(self, "Not yet implemented: Attribute definition {prop.local_class}::{prop} requires an explicit type.")
1064 return
1065 end
1066
1067 var prop = prop
1068 var signature = new MMSignature(new Array[MMParam], t, v.local_class.get_type)
1069 prop.signature = signature
1070 var visibility_level = n_visibility.level
1071 process_and_check(v, prop, n_id != null and n_kwredef != null, visibility_level)
1072 if n_readable != null or n_id == null then
1073 var m = _readmethod.as(not null)
1074 m.signature = signature
1075 process_and_check(v, m, (n_readable != null and n_readable.n_kwredef != null) or (n_id == null and n_kwredef != null), visibility_level)
1076 n_type.check_visibility(v, m)
1077 end
1078 if n_writable != null or n_id == null then
1079 var m = _writemethod.as(not null)
1080 m.signature = new MMSignature(new Array[MMParam].with_items(new MMParam(t, once "value".to_symbol)), null, v.local_class.get_type)
1081 var vl = visibility_level
1082 if n_id == null then
1083 if n_writable == null then vl = 3 else vl = n_writable.n_visibility.level # write accessor has a specific visibility
1084 end
1085 process_and_check(v, m, n_writable != null and n_writable.n_kwredef != null, vl)
1086 n_type.check_visibility(v, m)
1087 end
1088 end
1089
1090 redef fun accept_abs_syntax_visitor(v)
1091 do
1092 v.local_property = _prop
1093 super
1094 v.local_property = null
1095 end
1096 end
1097
1098 redef class AMethPropdef
1099 # Name of the method
1100 readable var _name: nullable Symbol
1101
1102 var _method: nullable MMMethSrcMethod
1103 redef fun method do return _method.as(not null)
1104
1105 redef fun accept_property_builder(v)
1106 do
1107 super
1108 var name: Symbol
1109 if n_methid == null then
1110 if self isa AInitPropdef then
1111 name = once "init".to_symbol
1112 else
1113 name = once "main".to_symbol
1114 end
1115 else
1116 name = n_methid.name.as(not null)
1117 # FIXME: Add the 'unary' keyword
1118 if n_methid.name == (once "-".to_symbol) then
1119 var ns = n_signature
1120 if ns != null and ns.n_params.length == 0 then
1121 name = once "unary -".to_symbol
1122 end
1123 end
1124 end
1125 _name = name
1126 var prop = new MMMethSrcMethod(name, v.local_class, self)
1127 _method = prop
1128 v.local_class.add_src_local_property(v, prop)
1129 end
1130
1131 redef fun accept_property_verifier(v)
1132 do
1133 v.signature_builder = new SignatureBuilder
1134 super
1135
1136 if v.signature_builder.has_error_occured then return
1137
1138 if v.signature_builder.signature == null then
1139 #_method.signature = new MMSignature(new Array[MMType], null, v.local_class.get_type)
1140 else
1141 method.signature = v.signature_builder.signature.as(not null)
1142 end
1143 var visibility_level = 1
1144 if n_visibility != null and n_visibility.level > 1 then
1145 visibility_level = n_visibility.level
1146 end
1147 process_and_check(v, method, n_kwredef != null, visibility_level)
1148 if n_signature != null then n_signature.check_visibility(v, method)
1149 end
1150
1151 redef fun accept_abs_syntax_visitor(v)
1152 do
1153 v.local_property = _method
1154 super
1155 v.local_property = null
1156 end
1157 end
1158
1159 redef class AMainMethPropdef
1160 redef fun process_and_check(v, prop, has_redef, visibility_level)
1161 do
1162 prop.global.visibility_level = visibility_level
1163 prop.signature = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
1164 # Disable all checks for main
1165 end
1166 end
1167
1168 redef class AExternPropdef
1169 redef fun accept_property_verifier(v)
1170 do
1171 super # Compute signature
1172 var ename: String
1173 if n_extern != null then
1174 ename = n_extern.text
1175 ename = ename.substring(1, ename.length-2)
1176 else
1177 ename = method.default_extern_name
1178 end
1179 method.extern_name = ename
1180 end
1181 end
1182
1183 redef class MMMethod
1184 fun default_extern_name : String
1185 do
1186 return "{mmmodule.name}_{local_class.name}_{local_class.name}_{name}_{signature.arity}"
1187 end
1188 end
1189
1190 redef class ATypePropdef
1191 redef fun prop do return _prop.as(not null)
1192 var _prop: nullable MMSrcTypeProperty
1193
1194 redef fun accept_property_builder(v)
1195 do
1196 super
1197 var name = n_id.to_symbol
1198 var prop = new MMSrcTypeProperty(name, v.local_class, self)
1199 _prop = prop
1200 v.local_class.add_src_local_property(v, prop)
1201 end
1202
1203 redef fun accept_property_verifier(v)
1204 do
1205 super
1206 var signature = new MMSignature(new Array[MMParam], n_type.get_stype(v), v.local_class.get_type)
1207 prop.signature = signature
1208 var visibility_level = n_visibility.level
1209 process_and_check(v, prop, n_kwredef != null, visibility_level)
1210 end
1211
1212 redef fun accept_abs_syntax_visitor(v)
1213 do
1214 v.local_property = _prop
1215 super
1216 v.local_property = null
1217 end
1218 end
1219
1220 # Visitor used to build a full method name from multiple tokens
1221 private class MethidAccumulator
1222 super Visitor
1223 readable var _name: Buffer = new Buffer
1224 redef fun visit(n)
1225 do
1226 if n isa Token then
1227 _name.append(n.text)
1228 else
1229 n.visit_all(self)
1230 end
1231 end
1232 end
1233
1234 redef class AMethid
1235 redef readable var _name: nullable Symbol
1236
1237 redef fun accept_property_builder(v)
1238 do
1239 var accumulator = new MethidAccumulator
1240 accumulator.enter_visit(self)
1241 _name = accumulator.name.to_s.to_symbol
1242 super
1243 end
1244 end
1245
1246 redef class ASignature
1247 redef fun accept_property_verifier(v)
1248 do
1249 super
1250 if v.signature_builder.has_error_occured then
1251 return
1252 else if not v.signature_builder.untyped_params.is_empty then
1253 if v.signature_builder.untyped_params.first != v.signature_builder.params.first or n_type != null then
1254 v.error(v.signature_builder.untyped_params.first, "Syntax error: untyped parameter.")
1255 return
1256 end
1257 else if not v.signature_builder.params.is_empty or n_type != null then
1258 var pars = new Array[MMParam]
1259 for p in v.signature_builder.params do
1260 pars.add( new MMParam( p.stype.as(not null), p.n_id.to_symbol ) )
1261 end
1262 var ret: nullable MMType = null
1263 if n_type != null then
1264 ret = n_type.get_stype(v)
1265 if ret == null then
1266 v.signature_builder.has_error_occured = true
1267 return
1268 end
1269 end
1270 v.signature_builder.signature = new MMSignature(pars, ret, v.local_class.get_type)
1271 if v.signature_builder.vararg_rank >= 0 then
1272 v.signature_builder.signature.vararg_rank = v.signature_builder.vararg_rank
1273 end
1274 for clos in v.signature_builder.closure_decls do
1275 v.signature_builder.signature.closures.add(clos.variable.closure)
1276 end
1277 end
1278 end
1279
1280 # Check that visibilities of types in the signature are compatible with the visibility of the property.
1281 fun check_visibility(v: AbsSyntaxVisitor, p: MMLocalProperty)
1282 do
1283 if p.global.visibility_level >= 3 then return
1284 for n in n_params do
1285 if n.n_type != null then n.n_type.check_visibility(v, p)
1286 end
1287 if n_type != null then n_type.check_visibility(v, p)
1288 end
1289 end
1290
1291 redef class AParam
1292 redef readable var _position: Int = 0
1293
1294 redef fun variable: ParamVariable do return _variable.as(not null)
1295 var _variable: nullable ParamVariable
1296
1297 # The type of the parameter in signature
1298 readable writable var _stype: nullable MMType
1299
1300 redef fun accept_property_verifier(v)
1301 do
1302 super
1303 _position = v.signature_builder.params.length
1304 _variable = new ParamVariable(n_id.to_symbol, n_id)
1305 v.signature_builder.params.add(self)
1306 v.signature_builder.untyped_params.add(self)
1307 if n_type != null then
1308 var stype = n_type.get_stype(v)
1309 if stype == null then
1310 v.signature_builder.has_error_occured = true
1311 return
1312 end
1313 for p in v.signature_builder.untyped_params do
1314 p.stype = stype
1315 if is_vararg then
1316 if v.signature_builder.vararg_rank == -1 then
1317 v.signature_builder.vararg_rank = p.position
1318 else
1319 v.error(self, "Error: A vararg parameter is already defined.")
1320 end
1321 stype = v.type_array(stype)
1322 end
1323 p.variable.stype = stype
1324 end
1325 v.signature_builder.untyped_params.clear
1326 end
1327 end
1328
1329 fun is_vararg: Bool do return n_dotdotdot != null
1330 end
1331
1332 redef class AClosureDecl
1333 redef readable var _position: Int = 0
1334
1335 redef fun variable: ClosureVariable do return _variable.as(not null)
1336 var _variable: nullable ClosureVariable
1337
1338 redef fun accept_property_verifier(v)
1339 do
1340 var old_signature_builder = v.signature_builder
1341 v.signature_builder = new SignatureBuilder
1342 super
1343 if v.signature_builder.has_error_occured then
1344 return
1345 end
1346 var sig = v.signature_builder.signature
1347 if sig == null then
1348 sig = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
1349 end
1350 if sig.return_type != null and n_kwbreak != null then
1351 v.error(self, "Syntax Error: A break block cannot have a return value.")
1352 end
1353
1354 # Add the finalizer to the closure signature
1355 var finalize_sig = new MMSignature(new Array[MMParam], null, v.mmmodule.type_any) # FIXME should be no receiver
1356 var finalizer_clos = new MMClosure(once ("break".to_symbol), finalize_sig, false, true)
1357 sig.closures.add(finalizer_clos)
1358
1359 var name = n_id.to_symbol
1360 var clos = new MMClosure(name, sig, n_kwbreak != null, n_expr != null)
1361 for c in old_signature_builder.closure_decls do
1362 if c.n_id.to_symbol == name then
1363 v.error(n_id, "A closure '!{name}' already defined at {c.n_id.location.relative_to(n_id.location)}.")
1364 return
1365 end
1366 end
1367 v.signature_builder = old_signature_builder
1368 _position = old_signature_builder.closure_decls.length
1369 old_signature_builder.closure_decls.add(self)
1370 _variable = new ClosureVariable(n_id.to_symbol, n_id, clos)
1371 end
1372 end
1373
1374 redef class AType
1375 # Check that visibilities of types in the signature are compatible with the visibility of the property.
1376 private fun check_visibility(v: AbsSyntaxVisitor, p: MMLocalProperty)
1377 do
1378 if p.global.visibility_level >= 3 then return
1379 var t = get_stype(v)
1380 if t == null then return
1381 var bc = t.local_class
1382 if bc.global.visibility_level >= 3 then
1383 v.error(self, "Access error: Class {bc} is private and cannot be used in the signature of the non-private property {p}.")
1384 end
1385 for n in n_types do
1386 n.check_visibility(v, p)
1387 end
1388 end
1389 end
1390
1391 redef class AExpr
1392 redef fun accept_class_builder(v) do end
1393 redef fun accept_property_builder(v) do end
1394 redef fun accept_property_verifier(v) do end
1395 end