src/metrics/self_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 # Metrics about the usage of explicit and implicit self
  18 module self_metrics
  19 import modelbuilder
  20 private import metrics_base
  21 import frontend
  22
  23 redef class ToolContext
  24         var self_metrics_phase = new SelfMetricsPhase(self, null)
  25 end
  26
  27 private class SelfMetricsPhase
  28         super Phase
  29         redef fun process_mainmodule(mainmodule, given_mmodules)
  30         do
  31                 if not toolcontext.opt_self.value and not toolcontext.opt_all.value then return
  32                 compute_self_metrics(toolcontext.modelbuilder)
  33         end
  34 end
  35
  36 private class ASelfVisitor
  37         super Visitor
  38         var total: Int = 0
  39         var implicits: Int = 0
  40
  41         redef fun visit(n)
  42         do
  43                 if n isa ASelfExpr then
  44                         self.total += 1
  45                         if n isa AImplicitSelfExpr then
  46                                 self.implicits += 1
  47                         end
  48                 end
  49                 n.visit_all(self)
  50         end
  51 end
  52
  53 # Visit the AST and print metics about the usage of self.
  54 fun compute_self_metrics(modelbuilder: ModelBuilder)
  55 do
  56         print "--- Explicit vs. Implicit Self ---"
  57         # Visit all the source code to collect data
  58         var visitor = new ASelfVisitor
  59         for nmodule in modelbuilder.nmodules do
  60                 for nclassdef in nmodule.n_classdefs do
  61                         visitor.enter_visit(nclassdef)
  62                 end
  63         end
  64         print "Total number of self: {visitor.total}"
  65         print "Total number of implicit self: {visitor.implicits} ({div(visitor.implicits*100,visitor.total)}%)"
  66 end