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 # Statistics about the usage of nullables
18 module nullables_metrics
22 private import metrics_base
25 redef class ToolContext
26 var nullables_metrics_phase
= new NullablesMetricsPhase(self, null)
29 private class NullablesMetricsPhase
31 redef fun process_mainmodule
(mainmodule
)
33 if not toolcontext
.opt_nullables
.value
and not toolcontext
.opt_all
.value
then return
34 compute_nullables_metrics
(toolcontext
.modelbuilder
)
38 private class NullableSends
40 var modelbuilder
: ModelBuilder
41 var nclassdef
: AClassdef
43 var total_sends
: Int = 0
44 var nullable_sends
: Int = 0
45 var buggy_sends
: Int = 0
47 # Get a new visitor on a classef to add type count in `typecount'.
48 init(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
50 self.modelbuilder
= modelbuilder
51 self.nclassdef
= nclassdef
57 if n
isa ASendExpr then
59 var t
= n
.n_expr
.mtype
64 t
= t
.anchor_to
(self.nclassdef
.mclassdef
.mmodule
, self.nclassdef
.mclassdef
.bound_mtype
)
65 if t
isa MNullableType then
66 self.nullable_sends
+= 1
67 else if t
isa MClassType then
70 n
.debug
("Problem: strange receiver type found: {t} ({t.class_name})")
76 # Visit the AST and print metrics about the usage of send on nullable reciever.
77 fun compute_nullables_metrics
(modelbuilder
: ModelBuilder)
79 print
"--- Sends on Nullable Reciever ---"
81 var nullable_sends
= 0
84 # Visit all the source code to collect data
85 for nmodule
in modelbuilder
.nmodules
do
86 for nclassdef
in nmodule
.n_classdefs
do
87 var visitor
= new NullableSends(modelbuilder
, nclassdef
)
88 visitor
.enter_visit
(nclassdef
)
89 total_sends
+= visitor
.total_sends
90 nullable_sends
+= visitor
.nullable_sends
91 buggy_sends
+= visitor
.buggy_sends
94 print
"Total number of sends: {total_sends}"
95 print
"Number of sends on a nullable receiver: {nullable_sends} ({div(nullable_sends*100,total_sends)}%)"
96 print
"Number of buggy sends (cannot determine the type of the receiver): {buggy_sends} ({div(buggy_sends*100,total_sends)}%)"