1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 # Computing of super-constructors that must be implicitly called at the begin of constructors.
18 # The current rules are a bit crazy but whatever.
19 module auto_super_init
22 private import annotation
24 redef class ToolContext
25 # Phase that inject `super` in constructors that need it.
26 var auto_super_init_phase
: Phase = new AutoSuperInitPhase(self, [typing_phase
])
29 private class AutoSuperInitPhase
31 redef fun process_npropdef
(npropdef
) do if npropdef
isa AMethPropdef then npropdef
.do_auto_super_init
(toolcontext
.modelbuilder
)
34 private class AutoSuperInitVisitor
38 n
.accept_auto_super_init
(self)
42 var has_explicit_super_init
: nullable ANode = null
44 # The method is broken, so avoid to display additional errors
49 redef class AMethPropdef
50 # In case of introduced constructor, the list of implicit auto super init constructors invoked (if needed)
51 var auto_super_inits
: nullable Array[CallSite] = null
53 # In case of redefined constructors, is an implicit call-to-super required?
54 var auto_super_call
= false
56 # Collect initializers and build the auto-init
57 fun do_auto_super_init
(modelbuilder
: ModelBuilder)
59 var mclassdef
= self.parent
.as(AClassdef).mclassdef
60 if mclassdef
== null or mclassdef
.is_broken
then return # skip error
61 var mpropdef
= self.mpropdef
62 if mpropdef
== null or mpropdef
.is_broken
then return # skip error
63 var mmodule
= mpropdef
.mclassdef
.mmodule
64 var anchor
= mclassdef
.bound_mtype
65 var recvtype
= mclassdef
.mclass
.mclass_type
67 # Get the annotation, but check its pertinence before returning
68 var nosuper
= get_single_annotation
("nosuper", modelbuilder
)
70 # Collect only for constructors
71 if not mpropdef
.mproperty
.is_init
or mpropdef
.mproperty
.is_new
then
72 if nosuper
!= null then modelbuilder
.error
(nosuper
, "Error: `nosuper` only allowed in `init`.")
76 # Now we search for the absence of any explicit super-init invocation
78 # * via a call of an other init
79 var nblock
= self.n_block
80 if nblock
!= null then
81 var v
= new AutoSuperInitVisitor
83 var anode
= v
.has_explicit_super_init
85 if nosuper
!= null then modelbuilder
.error
(anode
, "Error: method is annotated `nosuper` but a super-constructor call is present.")
88 if v
.is_broken
then return # skip
91 if nosuper
!= null then return
93 # Still here? So it means that we must add an implicit super-call on redefinitions.
94 if not mpropdef
.is_intro
then
95 auto_super_call
= true
96 mpropdef
.has_supercall
= true
97 modelbuilder
.toolcontext
.info
("Auto-super call for {mpropdef}", 4)
101 # Still here? So it means that we must determine what super inits need to be automatically invoked
102 # The code that follow is required to deal with complex cases with old-style and new-style inits
104 var auto_super_inits
= new Array[CallSite]
106 # The look for new-style super constructors (called from a old style constructor)
107 var the_root_init_mmethod
= modelbuilder
.the_root_init_mmethod
108 if the_root_init_mmethod
!= null and auto_super_inits
.is_empty
then
109 var candidatedefs
= the_root_init_mmethod
.lookup_definitions
(mmodule
, anchor
)
110 if candidatedefs
.is_empty
then
116 var candidatedef
= candidatedefs
.first
117 if candidatedefs
.length
> 1 then
118 var cd2
= candidatedefs
[1]
119 modelbuilder
.error
(self, "Error: cannot do an implicit constructor call to conflicting inherited inits `{cd2}({cd2.initializers.join(", ")}`) and `{candidatedef}({candidatedef.initializers.join(", ")}`). NOTE: Do not mix old-style and new-style init!")
124 var msignature
= candidatedef
.new_msignature
or else candidatedef
.msignature
125 msignature
= msignature
.resolve_for
(recvtype
, anchor
, mmodule
, true)
127 if msignature
.arity
> 0 then
128 modelbuilder
.error
(self, "Error: cannot do an implicit constructor call to `{candidatedef}{msignature}`. Expected at least `{msignature.arity}` arguments.")
133 var callsite
= new CallSite(hot_location
, recvtype
, mmodule
, anchor
, true, the_root_init_mmethod
, candidatedef
, msignature
, false)
134 auto_super_inits
.add
(callsite
)
135 modelbuilder
.toolcontext
.info
("Auto-super init for {mpropdef} to {the_root_init_mmethod.full_name}", 4)
137 if auto_super_inits
.is_empty
then
138 modelbuilder
.error
(self, "Error: no constructors to call implicitly in `{mpropdef}`. Call one explicitly.")
142 self.auto_super_inits
= auto_super_inits
148 private fun accept_auto_super_init
(v
: AutoSuperInitVisitor) do end
152 redef class ASendExpr
153 redef fun accept_auto_super_init
(v
)
155 var callsite
= self.callsite
156 if callsite
== null then
160 if callsite
.mproperty
.is_init
then
161 v
.has_explicit_super_init
= self
166 redef class ASuperExpr
167 redef fun accept_auto_super_init
(v
)
169 # If the super is a standard call-next-method then there it is considered am explicit super init call
170 # The the super is a "super int" then it is also an explicit super init call
171 v
.has_explicit_super_init
= self