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 # Metrics on the usage of explicit static types.
18 module static_types_metrics
20 private import metrics_base
23 # The job of this visitor is to resolve all types found
24 private class ATypeCounterVisitor
26 var modelbuilder
: ModelBuilder
27 var nclassdef
: AClassdef
29 var typecount
: Counter[MType]
31 # Get a new visitor on a classef to add type count in `typecount'.
32 init(modelbuilder
: ModelBuilder, nclassdef
: AClassdef, typecount
: Counter[MType])
34 self.modelbuilder
= modelbuilder
35 self.nclassdef
= nclassdef
36 self.typecount
= typecount
42 var mtype
= modelbuilder
.resolve_mtype
(self.nclassdef
, n
)
44 self.typecount
.inc
(mtype
)
51 # Visit the AST and print metrics on the usage of explicit static types.
52 fun compute_static_types_metrics
(modelbuilder
: ModelBuilder)
54 # Count each occurence of a specific static type
55 var typecount
= new Counter[MType]
57 # Visit all the source code to collect data
58 for nmodule
in modelbuilder
.nmodules
do
59 for nclassdef
in nmodule
.n_classdefs
do
60 var visitor
= new ATypeCounterVisitor(modelbuilder
, nclassdef
, typecount
)
61 visitor
.enter_visit
(nclassdef
)
66 print
"--- Metrics of the explitic static types ---"
67 print
"Total number of explicit static types: {typecount.total}"
68 if typecount
.total
== 0 then return
70 # types sorted by usage
71 var types
= typecount
.sort
73 # Display most used types (ie the last of `types')
74 print
"Most used types: "
76 if types
.length
< min
then min
= types
.length
78 var t
= types
[types
.length-i-1
]
79 print
" {t}: {typecount[t]}"
82 # Compute the distribution of type usage
83 print
"Distribution of type usage:"
88 if typecount
[t
] > limit
then
89 print
" <={limit}: {count} ({div(count*100,types.length)}% of types; {div(sum*100,typecount.total)}% of usage)"
92 while typecount
[t
] > limit
do limit
= limit
* 2
97 print
" <={limit}: {count} ({div(count*100,types.length)}% of types; {div(sum*100,typecount.total)}% of usage)"