src/metrics/ast_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 nodes and identifiers in the AST
  18 module ast_metrics
  19 import modelbuilder
  20 private import metrics_base
  21 import frontend
  22
  23 redef class ToolContext
  24         var ast_metrics_phase = new AstMetricsPhase(self, null)
  25 end
  26
  27 private class AstMetricsPhase
  28         super Phase
  29         var node_counter = new Counter[String]
  30         var id_counter = new Counter[String]
  31
  32         redef fun process_mainmodule(mainmodule, given_mmodules)
  33         do
  34                 if not toolcontext.opt_ast.value and not toolcontext.opt_all.value then return
  35                 print "--- AST Metrics ---"
  36                 # Visit all the source code to collect data
  37                 var visitor = new AstMetricsVisitor(self)
  38                 for nmodule in toolcontext.modelbuilder.nmodules do
  39                         visitor.enter_visit(nmodule)
  40                 end
  41                 print "## All nodes of the AST"
  42                 node_counter.print_summary
  43                 node_counter.print_elements(10)
  44                 print "## All identifiers of the AST"
  45                 id_counter.print_summary
  46                 id_counter.print_elements(10)
  47         end
  48 end
  49
  50 private class AstMetricsVisitor
  51         super Visitor
  52
  53         var phase: AstMetricsPhase
  54         init(phase: AstMetricsPhase) do self.phase = phase
  55
  56         redef fun visit(n)
  57         do
  58                 n.visit_all(self)
  59                 phase.node_counter.inc(n.class_name)
  60                 if n isa TId or n isa TAttrid or n isa TClassid then
  61                         assert n isa Token
  62                         phase.id_counter.inc(n.text)
  63                 end
  64         end
  65 end