# # Metrix++, Copyright 2009-2013, Metrix++ Project # Link: http://metrixplusplus.sourceforge.net # # This file is a part of Metrix++ Tool. # # Metrix++ is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, version 3 of the License. # # Metrix++ is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Metrix++. If not, see . # import mpp.api import re class Plugin(mpp.api.Plugin, mpp.api.IConfigurable, mpp.api.Child, mpp.api.MetricPluginMixin): def declare_configuration(self, parser): parser.add_option("--std.code.magic.numbers", "--scmn", action="store_true", default=False, help="Enables collection of magic numbers metric [default: %default]") parser.add_option("--std.code.magic.numbers.simplier", "--scmns", action="store_true", default=False, help="Is set, 0, -1 and 1 numbers are not counted " "in 'std.code.magic.numbers' metric [default: %default]") def configure(self, options): self.is_active_numbers = options.__dict__['std.code.magic.numbers'] self.is_active_numbers_simplier = options.__dict__['std.code.magic.numbers.simplier'] def initialize(self): pattern_to_search_java = re.compile( r'''((const(\s+[_$a-zA-Z][_$a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''') pattern_to_search_cpp_cs = re.compile( r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''') self.declare_metric(self.is_active_numbers, self.Field('numbers', int, non_zero=True), { 'std.code.java': (pattern_to_search_java, self.NumbersCounter), 'std.code.cpp': (pattern_to_search_cpp_cs, self.NumbersCounter), 'std.code.cs': (pattern_to_search_cpp_cs, self.NumbersCounter), }, marker_type_mask=mpp.api.Marker.T.CODE, region_type_mask=mpp.api.Region.T.ANY) super(Plugin, self).initialize(fields=self.get_fields(), properties=[self.Property('number.simplier', self.is_active_numbers_simplier)]) if self.is_active() == True: self.subscribe_by_parents_interface(mpp.api.ICode) class NumbersCounter(mpp.api.MetricPluginMixin.IterIncrementCounter): def increment(self, match): if (match.group(0).startswith('const') or (self.plugin.is_active_numbers_simplier == True and match.group(0) in ['0', '1', '-1', '+1'])): return 0 return 1