src/metrics/refinement_metrics.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2012 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 # Collect metrics about refinement usage
  18 module refinement_metrics
  19
  20 import model
  21 private import metrics_base
  22 import frontend
  23
  24 redef class ToolContext
  25         var refinement_metrics_phase = new RefinementMetricsPhase(self, null)
  26 end
  27
  28 private class RefinementMetricsPhase
  29         super Phase
  30         redef fun process_mainmodule(mainmodule)
  31         do
  32                 if not toolcontext.opt_refinement.value and not toolcontext.opt_all.value then return
  33                 compute_refinement_metrics(toolcontext.modelbuilder.model)
  34         end
  35 end
  36
  37 # Print refinement usage metrics
  38 fun compute_refinement_metrics(model: Model)
  39 do
  40         print "--- Metrics of refinement usage ---"
  41         var nbmod = model.mmodules.length
  42         print "Number of modules: {nbmod}"
  43
  44         print ""
  45
  46         var nbcla = model.mclasses.length
  47         var nbcladef = model.mclassdef_hierarchy.length
  48         print "Number of classes: {nbcla}"
  49
  50         # determine the distribution of:
  51         #  * class kinds (interface, abstract class, etc.)
  52         #  * refinex classes (vs. unrefined ones)
  53         var kinds = new Counter[MClassKind]
  54         var refined = 0
  55         for c in model.mclasses do
  56                 kinds.inc(c.kind)
  57                 if c.mclassdefs.length > 1 then
  58                         refined += 1
  59                 end
  60         end
  61         for k in kinds.sort do
  62                 var v = kinds[k]
  63                 print "  Number of {k} kind: {v} ({div(v*100,nbcla)}%)"
  64         end
  65
  66
  67         print ""
  68
  69         print "Number of class definitions: {nbcladef}"
  70         print "Number of refined classes: {refined} ({div(refined*100,nbcla)}%)"
  71         print "Average number of class refinments by classes: {div(nbcladef-nbcla,nbcla)}"
  72         print "Average number of class refinments by refined classes: {div(nbcladef-nbcla,refined)}"
  73
  74         print ""
  75
  76         var nbprop = model.mproperties.length
  77         var nbpropdef = 0
  78         var redefined = 0
  79         print "Number of properties: {model.mproperties.length}"
  80         var pkinds = new Counter[String]
  81         for p in model.mproperties do
  82                 nbpropdef += p.mpropdefs.length
  83                 if p.mpropdefs.length > 1 then
  84                         redefined += 1
  85                 end
  86                 pkinds.inc(p.class_name)
  87         end
  88         for k in pkinds.sort do
  89                 var v = pkinds[k]
  90                 print "  Number of {k}: {v} ({div(v*100,nbprop)}%)"
  91         end
  92
  93         print ""
  94
  95         print "Number of property definitions: {nbpropdef}"
  96         print "Number of redefined properties: {redefined} ({div(redefined*100,nbprop)}%)"
  97         print "Average number of property redefinitions by property: {div(nbpropdef-nbprop,nbprop)}"
  98         print "Average number of property redefinitions by redefined property: {div(nbpropdef-nbprop,redefined)}"
  99 end