src/metrics/visit_self.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 # Statistics about the usage of explicit and implicit self
  18 module visit_self
  19
  20 import modelbuilder
  21 private import metrics_base
  22
  23 private class ASelfVisitor
  24         super Visitor
  25         var total: Int = 0
  26         var implicits: Int = 0
  27
  28         redef fun visit(n)
  29         do
  30                 if n isa ASelfExpr then
  31                         self.total += 1
  32                         if n isa AImplicitSelfExpr then
  33                                 self.implicits += 1
  34                         end
  35                 end
  36                 n.visit_all(self)
  37         end
  38 end
  39
  40 # Visit the AST and print statistics about the usage of self.
  41 fun visit_self(modelbuilder: ModelBuilder)
  42 do
  43         print "--- Explicit vs. Implicit Self ---"
  44         # Visit all the source code to collect data
  45         var visitor = new ASelfVisitor
  46         for nmodule in modelbuilder.nmodules do
  47                 for nclassdef in nmodule.n_classdefs do
  48                         visitor.enter_visit(nclassdef)
  49                 end
  50         end
  51         print "Total number of self: {visitor.total}"
  52         print "Total number of implicit self: {visitor.implicits} ({div(visitor.implicits*100,visitor.total)}%)"
  53 end