Merge branch 'alexandre/at-various-fixes' into wip
[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_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 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 module_names_to_import = new Array[Symbol]
430 var module_visibility = new HashMap[Symbol, Int]
431 var no_import: nullable AImport = null
432 for i in n_imports do
433 var n = i.module_name
434 if n != null then
435 module_names_to_import.add(n)
436 module_visibility[n] = i.visibility_level
437 else
438 no_import = i
439 end
440 end
441 if no_import != null then
442 if not module_names_to_import.is_empty then
443 tc.error(no_import.location, "Error: Top modules cannot import other modules.")
444 end
445 else if module_names_to_import.is_empty then
446 var stdname = once "standard".to_symbol
447 module_names_to_import.add(stdname)
448 module_visibility[stdname] = 1
449 end
450
451 mod.import_supers_modules(module_names_to_import)
452
453 for mname in module_names_to_import do
454 var level = module_visibility[mname]
455 var m = tc.get_module(mname, mod)
456 mod.add_super_module(m, level)
457 end
458 end
459 end
460
461 redef class AModuledecl
462 redef fun accept_class_builder(v)
463 do
464 if n_id.to_symbol != v.mmmodule.name then
465 v.error(n_id, "Error: Module name mismatch between {v.mmmodule.name} and {n_id.to_symbol}")
466 end
467 end
468 end
469
470 redef class AImport
471 # Imported module name (or null)
472 fun module_name: nullable Symbol is abstract
473
474 # Visibility level (intrude/public/private)
475 fun visibility_level: Int is abstract
476 end
477 redef class AStdImport
478 redef fun module_name
479 do
480 return n_id.to_symbol
481 end
482 redef fun visibility_level
483 do
484 return n_visibility.level
485 end
486 end
487 redef class ANoImport
488 redef fun module_name
489 do
490 return null
491 end
492 end
493
494 redef class AVisibility
495 # Visibility level
496 fun level: Int is abstract
497 end
498 redef class APublicVisibility
499 redef fun level do return 1
500 end
501 redef class AProtectedVisibility
502 redef fun level do return 2
503 end
504 redef class APrivateVisibility
505 redef fun level do return 3
506 end
507 redef class AIntrudeVisibility
508 redef fun level do return 0
509 end
510
511
512 redef class AClassdef
513 redef fun local_class: MMSrcLocalClass do return _local_class.as(not null)
514 var _local_class: nullable MMSrcLocalClass
515
516 # Name of the class
517 fun name: Symbol is abstract
518
519 # Number of formal parameters
520 fun arity: Int do return 0
521
522 # Visibility of the class
523 fun visibility_level: Int do return 1
524
525 redef fun accept_class_builder(v)
526 do
527 var local_class: MMSrcLocalClass
528 var mod = v.mmmodule
529 var local_classes = mod.src_local_classes
530 if (local_classes.has_key(name)) then
531 local_class = local_classes[name]
532 _local_class = local_class
533 if self isa AStdClassdef then
534 # If we are not a special implicit class then rant
535 v.error(self, "Error: A class {name} is already defined at line {local_class.node.location.line_start}.")
536 return
537 end
538 # Add the new node after the last node
539 var n = local_class.node
540 while n.next_node != null do n = n.next_node
541 n.next_node = self
542 else
543 local_class = new MMSrcLocalClass(mod, name, self, arity)
544 _local_class = local_class
545 local_classes[name] = local_class
546 if not mod.has_global_class_named(name) then
547 build_class_introduction(v)
548 else
549 var glob = mod.global_class_named(name)
550 build_class_refinement(v, glob)
551 end
552
553 end
554 v.local_class_arity = 0
555 v.formals = local_class.formal_dict
556
557 #####
558 super
559 #####
560
561 v.formals = null
562 end
563
564 fun build_class_introduction(v: AbsSyntaxVisitor)
565 do
566 local_class.new_global
567 var glob = local_class.global
568
569 glob.visibility_level = visibility_level
570 if self isa AStdClassdef then
571 if n_kwredef != null then
572 v.error(self, "Redef error: No class {name} is imported. Remove the redef keyword to define a new class.")
573 return
574 end
575 glob.is_interface = n_classkind.is_interface
576 glob.is_abstract = n_classkind.is_abstract
577 glob.is_enum = n_classkind.is_enum
578 end
579 end
580
581 fun build_class_refinement(v: AbsSyntaxVisitor, glob: MMGlobalClass)
582 do
583 local_class.set_global(glob)
584
585 glob.check_visibility(v, self, v.mmmodule)
586 if self isa AStdClassdef and n_kwredef == null then
587 v.error(self, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
588 return
589 end
590
591 if glob.intro.arity != _local_class.arity then
592 v.error(self, "Redef error: Formal parameter arity missmatch; got {_local_class.arity}, expected {glob.intro.arity}.")
593 end
594
595 if self isa AStdClassdef and (not glob.is_interface and n_classkind.is_interface or
596 not glob.is_abstract and n_classkind.is_abstract or
597 not glob.is_enum and n_classkind.is_enum)
598 then
599 v.error(self, "Redef error: cannot change kind of class {name}.")
600 end
601 end
602
603 redef fun accept_class_verifier(v)
604 do
605 super
606 var glob = _local_class.global
607 for c in _local_class.cshe.direct_greaters do
608 var cg = c.global
609 if glob.is_interface then
610 if cg.is_enum then
611 v.error(self, "Special error: Interface {name} try to specialise enum class {c.name}.")
612 else if not cg.is_interface then
613 v.error(self, "Special error: Interface {name} try to specialise class {c.name}.")
614 end
615 else if glob.is_enum then
616 if not cg.is_interface and not cg.is_enum then
617 v.error(self, "Special error: Enum class {name} try to specialise class {c.name}.")
618 end
619 else
620 if cg.is_enum then
621 v.error(self, "Special error: Class {name} try to specialise enum class {c.name}.")
622 end
623 end
624
625 end
626 end
627
628 redef fun accept_abs_syntax_visitor(v)
629 do
630 v.local_class = _local_class
631 super
632 v.local_class = null
633 end
634 end
635
636 redef class AClasskind
637 fun is_interface: Bool do return false
638 fun is_enum: Bool do return false
639 fun is_abstract: Bool do return false
640 end
641
642 redef class AInterfaceClasskind
643 redef fun is_interface do return true
644 end
645 redef class AEnumClasskind
646 redef fun is_enum do return true
647 end
648 redef class AAbstractClasskind
649 redef fun is_abstract do return true
650 end
651
652 redef class AStdClassdef
653 redef fun name
654 do
655 return n_id.to_symbol
656 end
657 redef fun arity
658 do
659 return n_formaldefs.length
660 end
661 redef fun accept_class_verifier(v)
662 do
663 super
664 var glob = _local_class.global
665 if glob.intro == _local_class then
666 # Intro
667 glob.visibility_level = visibility_level
668 glob.is_interface = n_classkind.is_interface
669 glob.is_abstract = n_classkind.is_abstract
670 glob.is_enum = n_classkind.is_enum
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
688 if cg.is_enum then
689 v.error(self, "Special error: Class {name} try to specialise enum class {c.name}.")
690 end
691 end
692
693 end
694 return
695 end
696
697 # Redef
698
699 glob.check_visibility(v, self, v.mmmodule)
700 if n_kwredef == null then
701 v.error(self, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
702 return
703 end
704
705 if glob.intro.arity != _local_class.arity then
706 v.error(self, "Redef error: Formal parameter arity mismatch; got {_local_class.arity}, expected {glob.intro.arity}.")
707 end
708
709 if
710 not glob.is_interface and n_classkind.is_interface or
711 not glob.is_abstract and n_classkind.is_abstract or
712 not glob.is_enum and n_classkind.is_enum
713 then
714 v.error(self, "Redef error: cannot change kind of class {name}.")
715 end
716 end
717
718 redef fun visibility_level
719 do
720 return n_visibility.level
721 end
722 end
723
724 redef class AMainClassdef
725 redef fun name
726 do
727 return once "Sys".to_symbol
728 end
729 end
730
731 redef class ATopClassdef
732 redef fun name
733 do
734 return once "Object".to_symbol
735 end
736 end
737
738 redef class AFormaldef
739 # The associated formal generic parameter (MM entity)
740 var _formal: nullable MMTypeFormalParameter
741
742 redef fun accept_class_builder(v)
743 do
744 var name = n_id.to_symbol
745 var formal_type = new MMTypeFormalParameter(name, v.local_class_arity, v.local_class)
746 _formal = formal_type
747 v.local_class_arity = v.local_class_arity + 1
748 v.local_class.register_formal(formal_type)
749 v.formals[name] = formal_type
750 super
751 end
752
753 redef fun accept_class_verifier(v)
754 do
755 super
756 var c = v.local_class
757 var o = c.global.intro
758 if c == o then
759 if n_type == null then
760 _formal.bound = v.mmmodule.type_any.as_nullable
761 else
762 var stype = n_type.get_stype(v)
763 if stype == null then return
764 _formal.bound = stype
765 end
766 else
767 var ob = o.get_formal(_formal.position).bound.for_module(v.mmmodule)
768 if n_type == null then
769 _formal.bound = ob
770 else
771 var stype = n_type.get_stype(v)
772 if stype == null then return
773 _formal.bound = stype
774 if _formal.bound != ob then
775 v.error(self, "Redef error: Cannot change formal parameter type of class {c}; got {_formal.bound}, expected {ob}.")
776 end
777 end
778 end
779 end
780 end
781
782 redef class ASuperclass
783 readable var _ancestor: nullable MMSrcAncestor
784
785 redef fun accept_class_specialization_builder(v)
786 do
787 super
788 var c = n_type.get_local_class(v)
789 if c == null then return
790 var ancestor = new MMSrcAncestor(c)
791 _ancestor = ancestor
792 v.local_class.add_direct_parent(ancestor)
793 end
794
795 redef fun accept_class_ancestor_builder(v)
796 do
797 super
798 _ancestor.stype = n_type.get_unchecked_stype(v)
799 _ancestor.inheriter = v.local_class.get_type
800 end
801
802 redef fun accept_class_verifier(v)
803 do
804 super
805 n_type.check_conform(v)
806 end
807 end
808
809 redef class APropdef
810 # Process and check properties of the property.
811 # * Distinguish inits and methods
812 # * Inherit or check visibility.
813 # * Check redef errors.
814 # * Check forbiden attribute definitions.
815 # * Check signature conformance.
816 private fun process_and_check(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
817 do
818 if prop.global.intro == prop then
819 do_and_check_intro(v, prop, has_redef, visibility_level)
820 else
821 do_and_check_redef(v, prop, has_redef, visibility_level)
822 end
823 end
824
825 # The part of process_and_check when prop is an introduction
826 private fun do_and_check_intro(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
827 do
828 var glob = prop.global
829 var gbc = prop.local_class.global
830 if v.local_class.global.visibility_level >= 3 then
831 # Method of private classes are private
832 visibility_level = 3
833 end
834 glob.visibility_level = visibility_level
835 if has_redef then
836 v.error(self, "Error: No property {prop.local_class}::{prop} is inherited. Remove the redef keyword to define a new property.")
837 end
838 if glob.is_attribute then
839 if gbc.is_interface then
840 v.error(self, "Error: Attempt to define attribute {prop} in the interface {prop.local_class}.")
841 else if gbc.is_enum then
842 v.error(self, "Error: Attempt to define attribute {prop} in the enum class {prop.local_class}.")
843 end
844 else if glob.is_init then
845 if gbc.is_interface then
846 v.error(self, "Error: Attempt to define a constructor {prop} in the class {prop.local_class}.")
847 else if gbc.is_enum then
848 v.error(self, "Error: Attempt to define a constructor {prop} in the enum {prop.local_class}.")
849 end
850 end
851 if prop.signature == null then
852 if glob.is_init then
853 var supers = prop.local_class.super_methods_named(prop.name)
854 inherit_signature(v, prop, supers)
855 end
856 if prop.signature != null or v.signature_builder.has_error_occured then
857 # ok
858 else if not v.signature_builder.untyped_params.is_empty then
859 v.error(v.signature_builder.untyped_params.first, "Error: Untyped parameter.")
860 else
861 prop.signature = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
862 for clos in v.signature_builder.closure_decls do
863 prop.signature.closures.add(clos.variable.closure)
864 end
865 end
866 end
867 end
868
869 private fun inherit_signature(v: PropertyVerifierVisitor, prop: MMLocalProperty, supers: Array[MMLocalProperty])
870 do
871 var s = prop.signature
872 for ip in supers do
873 var isig = ip.signature.adaptation_to(v.local_class.get_type)
874
875 if s == null then
876 if v.signature_builder.params.length != isig.arity then
877 return
878 end
879 for p in v.signature_builder.params do
880 var t = isig[p.position]
881 p.stype = t
882 if p.position == isig.vararg_rank then
883 t = v.type_array(t)
884 end
885 p.variable.stype = t
886 end
887
888 s = isig
889 prop.signature = s
890 end
891 end
892 end
893
894 # The part of process_and_check when prop is a redefinition
895 private fun do_and_check_redef(v: PropertyVerifierVisitor, prop: MMLocalProperty, has_redef: Bool, visibility_level: Int)
896 do
897 var is_init = self isa AConcreteInitPropdef
898 var glob = prop.global
899
900 if not has_redef then
901 v.error(self, "Redef error: {prop.local_class}::{prop} is an inherited property. To redefine it, add the redef keyword.")
902 return
903 end
904 if glob.is_init and not is_init then
905 v.error(self, "Redef error: A method {prop.local_class}::{prop} cannot redefine a constructor.")
906 else if not glob.is_init and is_init then
907 v.error(self, "Redef error: A constructor {prop.local_class}::{prop} cannot redefine a method.")
908 end
909
910 var s = prop.signature
911 #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}"
912 for i in prop.prhe.direct_greaters do
913 var ip = i.local_class[prop.global]
914 var isig = i.signature
915 if isig == null then break # previous signature is invalid
916 isig = isig.adaptation_to(v.local_class.get_type)
917
918 if s == null then
919 #print "{prop.full_name} inherits signature from {ip.full_name}"
920 if v.signature_builder.params.length != isig.arity then
921 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} parameter(s).")
922 return
923 end
924 if v.signature_builder.closure_decls.length != isig.closures.length then
925 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} closure(s).")
926 return
927 end
928 for p in v.signature_builder.params do
929 var t = isig[p.position]
930 p.stype = t
931 if p.position == isig.vararg_rank then
932 t = v.type_array(t)
933 end
934 p.variable.stype = t
935 end
936 s = isig
937 prop.signature = s
938 #print "s is null"
939 end
940
941 var nberr = v.tc.error_count
942 #print "Check {prop.local_class}::{prop}{s} vs {ip.local_class}::{ip}{isig}"
943 #print "s={s.object_id} isig={isig.object_id} isigorig={i.signature.object_id}"
944
945 #print "orig signature: {i.signature.recv} . {i.signature}"
946 #print "inh signature: {isig.recv} . {isig}"
947 #print "redef signature: {s.recv} . {s}"
948
949 if s.arity != isig.arity then
950 v.error(self, "Redef error: {prop.local_class}::{prop} redefines {ip.local_class}::{ip} with {isig.arity} parameter(s).")
951 else if s.arity > 0 then
952 if self isa AMethPropdef then
953 # A standard method
954 for j in [0..s.arity[ do
955 if s[j] != isig[j] then
956 v.error(n_signature.n_params[j], "Redef error: Expected {isig[j]}, as in {ip.local_class}::{ip}.")
957 end
958 end
959 else if self isa AAttrPropdef then
960 # A write accessor
961 if s[0] != isig[0] then
962 v.error(n_type, "Redef error: Expected {isig[0]}, as in the parameter of {ip.local_class}::{ip}.")
963 end
964
965 else
966 abort #
967 end
968 end
969
970 var srt = s.return_type
971 var isrt = isig.return_type
972 if srt == null and isrt != null then
973 v.error(self, "Redef error: The procedure {prop.local_class}::{prop} redefines the function {ip.local_class}::{ip}.")
974 else if srt != null and isrt == null then
975 v.error(self, "Redef error: The function {prop.local_class}::{prop} redefines the procedure {ip.local_class}::{ip}.")
976 else if srt != null and isrt != null and not srt < isrt then
977 var n: nullable ANode = null
978 if self isa AMethPropdef then
979 n = self.n_signature.n_type
980 else if self isa AAttrPropdef then
981 n = self.n_type
982 else if self isa ATypePropdef then
983 n = self.n_type
984 end
985 v.error(n, "Redef error: Expected {isrt}, as in {ip.local_class}::{ip}.")
986 else if not s < isig and nberr == v.tc.error_count then
987 # Systematic fallback for conformance check
988 v.error(self, "Redef error: Incompatible redefinition of {ip.local_class}::{ip} with {prop.local_class}::{prop}")
989 else if srt != null and isrt != null and srt != isrt and prop isa MMAttribute then
990 # FIXME: To remove
991 v.warning(self, "Redef warning: Expected {isrt}, as in {ip.local_class}::{ip}.")
992 end
993 end
994
995 if visibility_level != 1 and glob.visibility_level != visibility_level then
996 v.error(self, "Redef error: {prop.local_class}::{prop} redefinition cannot change visibility.")
997 end
998 glob.check_visibility(v, self, v.mmmodule, true)
999 end
1000 end
1001
1002 redef class AAttrPropdef
1003 redef readable var _readmethod: nullable MMSrcMethod
1004 redef readable var _writemethod: nullable MMSrcMethod
1005 var _prop: nullable MMSrcAttribute
1006 redef fun prop do return _prop.as(not null)
1007
1008 redef fun accept_property_builder(v)
1009 do
1010 super
1011 var name: Symbol
1012 if n_id != null then
1013 name = n_id.to_symbol
1014 else
1015 name = ("@" + n_id2.text).to_symbol
1016 end
1017 var lc = v.local_class
1018 var prop = new MMSrcAttribute(name, lc, self)
1019 _prop = prop
1020 v.local_class.add_src_local_property(v, prop)
1021
1022 if n_readable != null or n_id == null then
1023 if n_id != null then
1024 name = n_id.text.substring_from(1).to_symbol
1025 else
1026 name = n_id2.to_symbol
1027 end
1028 var readmethod = new MMReadImplementationMethod(name, lc, self)
1029 _readmethod = readmethod
1030 v.local_class.add_src_local_property(v, readmethod)
1031 end
1032 if n_writable != null or n_id == null then
1033 if n_id != null then
1034 name = (n_id.text.substring_from(1) + "=").to_symbol
1035 else
1036 name = (n_id2.text + "=").to_symbol
1037 end
1038 var writemethod = new MMWriteImplementationMethod(name, lc, self)
1039 _writemethod = writemethod
1040 v.local_class.add_src_local_property(v, writemethod)
1041 end
1042 end
1043
1044 redef fun accept_property_verifier(v)
1045 do
1046 super
1047 var t: MMType
1048 if n_type != null then
1049 var t0 = n_type.get_stype(v)
1050 if t0 != null then t = t0 else return
1051 else
1052 v.error(self, "Not yet implemented: Attribute definition {prop.local_class}::{prop} requires an explicit type.")
1053 return
1054 end
1055
1056 var prop = prop
1057 var signature = new MMSignature(new Array[MMParam], t, v.local_class.get_type)
1058 prop.signature = signature
1059 var visibility_level = n_visibility.level
1060 process_and_check(v, prop, n_id != null and n_kwredef != null, visibility_level)
1061 if n_readable != null or n_id == null then
1062 var m = _readmethod.as(not null)
1063 m.signature = signature
1064 process_and_check(v, m, (n_readable != null and n_readable.n_kwredef != null) or (n_id == null and n_kwredef != null), visibility_level)
1065 n_type.check_visibility(v, m)
1066 end
1067 if n_writable != null or n_id == null then
1068 var m = _writemethod.as(not null)
1069 m.signature = new MMSignature(new Array[MMParam].with_items(new MMParam(t, once "value".to_symbol)), null, v.local_class.get_type)
1070 var vl = visibility_level
1071 if n_id == null then
1072 if n_writable == null then vl = 3 else vl = n_writable.n_visibility.level # write accessor has a specific visibility
1073 end
1074 process_and_check(v, m, n_writable != null and n_writable.n_kwredef != null, vl)
1075 n_type.check_visibility(v, m)
1076 end
1077 end
1078
1079 redef fun accept_abs_syntax_visitor(v)
1080 do
1081 v.local_property = _prop
1082 super
1083 v.local_property = null
1084 end
1085 end
1086
1087 redef class AMethPropdef
1088 # Name of the method
1089 readable var _name: nullable Symbol
1090
1091 var _method: nullable MMMethSrcMethod
1092 redef fun method do return _method.as(not null)
1093
1094 redef fun accept_property_builder(v)
1095 do
1096 super
1097 var name: Symbol
1098 if n_methid == null then
1099 if self isa AConcreteInitPropdef then
1100 name = once "init".to_symbol
1101 else
1102 name = once "main".to_symbol
1103 end
1104 else
1105 name = n_methid.name.as(not null)
1106 # FIXME: Add the 'unary' keyword
1107 if n_methid.name == (once "-".to_symbol) then
1108 var ns = n_signature
1109 if ns != null and ns.n_params.length == 0 then
1110 name = once "unary -".to_symbol
1111 end
1112 end
1113 end
1114 _name = name
1115 var prop = new MMMethSrcMethod(name, v.local_class, self)
1116 _method = prop
1117 v.local_class.add_src_local_property(v, prop)
1118 end
1119
1120 redef fun accept_property_verifier(v)
1121 do
1122 v.signature_builder = new SignatureBuilder
1123 super
1124
1125 if v.signature_builder.has_error_occured then return
1126
1127 if v.signature_builder.signature == null then
1128 #_method.signature = new MMSignature(new Array[MMType], null, v.local_class.get_type)
1129 else
1130 method.signature = v.signature_builder.signature.as(not null)
1131 end
1132 var visibility_level = 1
1133 if n_visibility != null and n_visibility.level > 1 then
1134 visibility_level = n_visibility.level
1135 end
1136 process_and_check(v, method, n_kwredef != null, visibility_level)
1137 if n_signature != null then n_signature.check_visibility(v, method)
1138 end
1139
1140 redef fun accept_abs_syntax_visitor(v)
1141 do
1142 v.local_property = _method
1143 super
1144 v.local_property = null
1145 end
1146 end
1147
1148 redef class AMainMethPropdef
1149 redef fun process_and_check(v, prop, has_redef, visibility_level)
1150 do
1151 prop.global.visibility_level = visibility_level
1152 prop.signature = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
1153 # Disable all checks for main
1154 end
1155 end
1156
1157 redef class AExternMethPropdef
1158 redef fun accept_property_verifier(v)
1159 do
1160 super # Compute signature
1161 var ename: String
1162 if n_extern != null then
1163 ename = n_extern.text
1164 ename = ename.substring(1, ename.length-2)
1165 else
1166 ename = "{method.mmmodule.name}_{method.local_class.name}_{method.local_class.name}_{method.name}_{method.signature.arity}"
1167 end
1168 method.extern_name = ename
1169 end
1170 end
1171
1172 redef class ATypePropdef
1173 redef fun prop do return _prop.as(not null)
1174 var _prop: nullable MMSrcTypeProperty
1175
1176 redef fun accept_property_builder(v)
1177 do
1178 super
1179 var name = n_id.to_symbol
1180 var prop = new MMSrcTypeProperty(name, v.local_class, self)
1181 _prop = prop
1182 v.local_class.add_src_local_property(v, prop)
1183 end
1184
1185 redef fun accept_property_verifier(v)
1186 do
1187 super
1188 var signature = new MMSignature(new Array[MMParam], n_type.get_stype(v), v.local_class.get_type)
1189 prop.signature = signature
1190 var visibility_level = n_visibility.level
1191 process_and_check(v, prop, n_kwredef != null, visibility_level)
1192 end
1193
1194 redef fun accept_abs_syntax_visitor(v)
1195 do
1196 v.local_property = _prop
1197 super
1198 v.local_property = null
1199 end
1200 end
1201
1202 # Visitor used to build a full method name from multiple tokens
1203 private class MethidAccumulator
1204 super Visitor
1205 readable var _name: Buffer = new Buffer
1206 redef fun visit(n)
1207 do
1208 if n isa Token then
1209 _name.append(n.text)
1210 else
1211 n.visit_all(self)
1212 end
1213 end
1214 end
1215
1216 redef class AMethid
1217 redef readable var _name: nullable Symbol
1218
1219 redef fun accept_property_builder(v)
1220 do
1221 var accumulator = new MethidAccumulator
1222 accumulator.enter_visit(self)
1223 _name = accumulator.name.to_s.to_symbol
1224 super
1225 end
1226 end
1227
1228 redef class ASignature
1229 redef fun accept_property_verifier(v)
1230 do
1231 super
1232 if v.signature_builder.has_error_occured then
1233 return
1234 else if not v.signature_builder.untyped_params.is_empty then
1235 if v.signature_builder.untyped_params.first != v.signature_builder.params.first or n_type != null then
1236 v.error(v.signature_builder.untyped_params.first, "Syntax error: untyped parameter.")
1237 return
1238 end
1239 else if not v.signature_builder.params.is_empty or n_type != null then
1240 var pars = new Array[MMParam]
1241 for p in v.signature_builder.params do
1242 pars.add( new MMParam( p.stype.as(not null), p.n_id.to_symbol ) )
1243 end
1244 var ret: nullable MMType = null
1245 if n_type != null then
1246 ret = n_type.get_stype(v)
1247 if ret == null then
1248 v.signature_builder.has_error_occured = true
1249 return
1250 end
1251 end
1252 v.signature_builder.signature = new MMSignature(pars, ret, v.local_class.get_type)
1253 if v.signature_builder.vararg_rank >= 0 then
1254 v.signature_builder.signature.vararg_rank = v.signature_builder.vararg_rank
1255 end
1256 for clos in v.signature_builder.closure_decls do
1257 v.signature_builder.signature.closures.add(clos.variable.closure)
1258 end
1259 end
1260 end
1261
1262 # Check that visibilities of types in the signature are compatible with the visibility of the property.
1263 fun check_visibility(v: AbsSyntaxVisitor, p: MMLocalProperty)
1264 do
1265 if p.global.visibility_level >= 3 then return
1266 for n in n_params do
1267 if n.n_type != null then n.n_type.check_visibility(v, p)
1268 end
1269 if n_type != null then n_type.check_visibility(v, p)
1270 end
1271 end
1272
1273 redef class AParam
1274 redef readable var _position: Int = 0
1275
1276 redef fun variable: ParamVariable do return _variable.as(not null)
1277 var _variable: nullable ParamVariable
1278
1279 # The type of the parameter in signature
1280 readable writable var _stype: nullable MMType
1281
1282 redef fun accept_property_verifier(v)
1283 do
1284 super
1285 _position = v.signature_builder.params.length
1286 _variable = new ParamVariable(n_id.to_symbol, n_id)
1287 v.signature_builder.params.add(self)
1288 v.signature_builder.untyped_params.add(self)
1289 if n_type != null then
1290 var stype = n_type.get_stype(v)
1291 if stype == null then
1292 v.signature_builder.has_error_occured = true
1293 return
1294 end
1295 for p in v.signature_builder.untyped_params do
1296 p.stype = stype
1297 if is_vararg then
1298 if v.signature_builder.vararg_rank == -1 then
1299 v.signature_builder.vararg_rank = p.position
1300 else
1301 v.error(self, "Error: A vararg parameter is already defined.")
1302 end
1303 stype = v.type_array(stype)
1304 end
1305 p.variable.stype = stype
1306 end
1307 v.signature_builder.untyped_params.clear
1308 end
1309 end
1310
1311 fun is_vararg: Bool do return n_dotdotdot != null
1312 end
1313
1314 redef class AClosureDecl
1315 redef readable var _position: Int = 0
1316
1317 redef fun variable: ClosureVariable do return _variable.as(not null)
1318 var _variable: nullable ClosureVariable
1319
1320 redef fun accept_property_verifier(v)
1321 do
1322 var old_signature_builder = v.signature_builder
1323 v.signature_builder = new SignatureBuilder
1324 super
1325 if v.signature_builder.has_error_occured then
1326 return
1327 end
1328 var sig = v.signature_builder.signature
1329 if sig == null then
1330 sig = new MMSignature(new Array[MMParam], null, v.local_class.get_type)
1331 end
1332 if sig.return_type != null and n_kwbreak != null then
1333 v.error(self, "Syntax Error: A break block cannot have a return value.")
1334 end
1335
1336 # Add the finalizer to the closure signature
1337 var finalize_sig = new MMSignature(new Array[MMParam], null, v.mmmodule.type_any) # FIXME should be no receiver
1338 var finalizer_clos = new MMClosure(once ("break".to_symbol), finalize_sig, false, true)
1339 sig.closures.add(finalizer_clos)
1340
1341 var name = n_id.to_symbol
1342 var clos = new MMClosure(name, sig, n_kwbreak != null, n_expr != null)
1343 for c in old_signature_builder.closure_decls do
1344 if c.n_id.to_symbol == name then
1345 v.error(n_id, "A closure '!{name}' already defined at {c.n_id.location.relative_to(n_id.location)}.")
1346 return
1347 end
1348 end
1349 v.signature_builder = old_signature_builder
1350 _position = old_signature_builder.closure_decls.length
1351 old_signature_builder.closure_decls.add(self)
1352 _variable = new ClosureVariable(n_id.to_symbol, n_id, clos)
1353 end
1354 end
1355
1356 redef class AType
1357 # Check that visibilities of types in the signature are compatible with the visibility of the property.
1358 private fun check_visibility(v: AbsSyntaxVisitor, p: MMLocalProperty)
1359 do
1360 if p.global.visibility_level >= 3 then return
1361 var t = get_stype(v)
1362 if t == null then return
1363 var bc = t.local_class
1364 if bc.global.visibility_level >= 3 then
1365 v.error(self, "Access error: Class {bc} is private and cannot be used in the signature of the non-private property {p}.")
1366 end
1367 for n in n_types do
1368 n.check_visibility(v, p)
1369 end
1370 end
1371 end
1372
1373 redef class AExpr
1374 redef fun accept_class_builder(v) do end
1375 redef fun accept_property_builder(v) do end
1376 redef fun accept_property_verifier(v) do end
1377 end