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
23 import mclasses_metrics
26 redef class ToolContext
27 var nullables_metrics_phase
: Phase = new NullablesMetricsPhase(self, null)
30 private class NullablesMetricsPhase
32 redef fun process_mainmodule
(mainmodule
, given_mmodules
)
34 if not toolcontext
.opt_nullables
.value
and not toolcontext
.opt_all
.value
then return
36 var csv
= toolcontext
.opt_csv
.value
37 var out
= "{toolcontext.opt_dir.value or else "metrics"}/nullables"
40 print toolcontext
.format_h1
("\n# Nullable metrics")
42 var metrics
= new MetricSet
43 var min_vis
= private_visibility
44 metrics
.register
(new CNBA(mainmodule
, min_vis
))
45 metrics
.register
(new CNBNA(mainmodule
, min_vis
))
47 var model
= toolcontext
.modelbuilder
.model
48 var mclasses
= new HashSet[MClass]
49 for mproject
in model
.mprojects
do
51 print toolcontext
.format_h2
("\n ## project {mproject}")
53 for mgroup
in mproject
.mgroups
do
54 if mgroup
.mmodules
.is_empty
then continue
58 print toolcontext
.format_h3
(" `- group {mgroup.full_name}")
59 var mod_mclasses
= new HashSet[MClass]
60 for mmodule
in mgroup
.mmodules
do mod_mclasses
.add_all
(mmodule
.intro_mclasses
)
61 if mod_mclasses
.is_empty
then continue
62 mclasses
.add_all
(mod_mclasses
)
63 metrics
.collect
(new HashSet[MClass].from
(mod_mclasses
))
64 metrics
.to_console
(1, not toolcontext
.opt_nocolors
.value
)
65 if csv
then metrics
.to_csv
.save
("{out}/{mgroup}.csv")
68 if not mclasses
.is_empty
then
71 print toolcontext
.format_h2
("\n ## global metrics")
72 metrics
.collect
(mclasses
)
73 metrics
.to_console
(1, not toolcontext
.opt_nocolors
.value
)
74 if csv
then metrics
.to_csv
.save
("{out}/summary.csv")
77 compute_nullables_metrics
(toolcontext
.modelbuilder
)
81 # Class Metric: Number of nullables MAttributes
85 redef fun name
do return "cnbna"
86 redef fun desc
do return "number of accessible nullable attributes (inherited + local)"
88 var mainmodule
: MModule
89 var min_visibility
: MVisibility
91 init(mainmodule
: MModule, min_visibility
: MVisibility) do
92 self.mainmodule
= mainmodule
93 self.min_visibility
= min_visibility
96 redef fun collect
(mclasses
) do
97 for mclass
in mclasses
do
98 var all
= mclass
.all_mattributes
(mainmodule
, min_visibility
)
100 if mattr
.is_nullable
then values
.inc
(mclass
)
107 private class NullableSends
109 var modelbuilder
: ModelBuilder
110 var nclassdef
: AClassdef
112 var total_sends
: Int = 0
113 var nullable_sends
: Int = 0
114 var buggy_sends
: Int = 0
116 # Get a new visitor on a classef to add type count in `typecount`.
117 init(modelbuilder
: ModelBuilder, nclassdef
: AClassdef)
119 self.modelbuilder
= modelbuilder
120 self.nclassdef
= nclassdef
126 if n
isa ASendExpr then
127 self.total_sends
+= 1
128 var t
= n
.n_expr
.mtype
130 self.buggy_sends
+= 1
133 t
= t
.anchor_to
(self.nclassdef
.mclassdef
.mmodule
, self.nclassdef
.mclassdef
.bound_mtype
)
134 if t
isa MNullableType then
135 self.nullable_sends
+= 1
136 else if t
isa MClassType then
139 n
.debug
("Problem: strange receiver type found: {t} ({t.class_name})")
145 # Visit the AST and print metrics about the usage of send on nullable reciever.
146 fun compute_nullables_metrics
(modelbuilder
: ModelBuilder)
148 print
"--- Sends on Nullable Receiver ---"
150 var nullable_sends
= 0
153 # Visit all the source code to collect data
154 for nmodule
in modelbuilder
.nmodules
do
155 for nclassdef
in nmodule
.n_classdefs
do
156 var visitor
= new NullableSends(modelbuilder
, nclassdef
)
157 visitor
.enter_visit
(nclassdef
)
158 total_sends
+= visitor
.total_sends
159 nullable_sends
+= visitor
.nullable_sends
160 buggy_sends
+= visitor
.buggy_sends
163 print
"Total number of sends: {total_sends}"
164 print
"Number of sends on a nullable receiver: {nullable_sends} ({div(nullable_sends*100,total_sends)}%)"
165 print
"Number of buggy sends (cannot determine the type of the receiver): {buggy_sends} ({div(buggy_sends*100,total_sends)}%)"