Temporary commit of members plugin. maintainability index metric should be documented.

mainline/LIMITATIONS.md

@@ -53,6 +53,7 @@ These comments are considered to be parts of a define.
 				/* ... */
 			}
 
++ C# parser interprets properties with default getter/setter as data fields.
 
 + Java parser does not recognise anonymous inner classes.
 

mainline/doc/extend.html

@@ -364,7 +364,7 @@ class Plugin(mpp.api.Plugin,
     def initialize(self):
         # improve pattern to find declarations of constants
         pattern_to_search = re.compile(
-            r'''((const\s+([_a-zA-Z][_a-zA-Z0-9]*\s+)+[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
+            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),
                             # give a pair of pattern + custom counter logic class
@@ -419,10 +419,10 @@ class Plugin(mpp.api.Plugin,
     def initialize(self):
         # specialized pattern for java
         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)''')
+            r'''((const(\s+[_$a-zA-Z][_$a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         # pattern for C++ and C# languages
         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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         # pattern for all other languages
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')
@@ -480,9 +480,9 @@ class Plugin(mpp.api.Plugin,
     
     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)''')
+            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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')
         self.declare_metric(self.is_active_numbers,
@@ -545,9 +545,9 @@ class Plugin(mpp.api.Plugin,
     
     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)''')
+            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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')
         self.declare_metric(self.is_active_numbers,

mainline/ext/std/code/filelines.ini

@@ -18,7 +18,7 @@
 ;
 
 [Plugin]
-version: 1.1
+version: 1.0
 package: std.code
 module:  filelines
 class:   Plugin

mainline/ext/std/code/magic.ini

@@ -18,7 +18,7 @@
 ;
 
 [Plugin]
-version: 1.1
+version: 1.2
 package: std.code
 module:  magic
 class:   Plugin

mainline/ext/std/code/magic.py

@@ -40,9 +40,9 @@ class Plugin(mpp.api.Plugin,
     
     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)''')
+            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)''')
+            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),

mainline/ext/std/code/member.ini

@@ -0,0 +1,27 @@
+;
+;    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 <http://www.gnu.org/licenses/>.
+;
+
+[Plugin]
+version: 1.0
+package: std.code
+module:  member
+class:   Plugin
+depends: None
+actions: collect
+enabled: True

mainline/ext/std/code/member.py

@@ -0,0 +1,105 @@
+#
+#    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 <http://www.gnu.org/licenses/>.
+#
+
+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.member.fields", "--scmf",
+            action="store_true", default=False,
+            help="Enables collection of number of data members / fields "
+            "per classes, structs and interfaces [default: %default]")
+        parser.add_option("--std.code.member.globals", "--scmg",
+            action="store_true", default=False,
+            help="Enables collection of number of global variables / fields "
+            "per global regions and namespaces [default: %default]")
+        parser.add_option("--std.code.member.classes", "--scmc",
+            action="store_true", default=False,
+            help="Enables collection of number of classes defined "
+            "per any region [default: %default]")
+        parser.add_option("--std.code.member.structs", "--scms",
+            action="store_true", default=False,
+            help="Enables collection of number of structs defined "
+            "per any region [default: %default]")
+        parser.add_option("--std.code.member.interfaces", "--scmi",
+            action="store_true", default=False,
+            help="Enables collection of number of interfaces defined "
+            "per any region [default: %default]")
+        parser.add_option("--std.code.member.methods", "--scmm",
+            action="store_true", default=False,
+            help="Enables collection of number of methods (functions) defined "
+            "per any region [default: %default]")
+        parser.add_option("--std.code.member.namespaces", "--scmn",
+            action="store_true", default=False,
+            help="Enables collection of number of namespaces defined "
+            "globally and enclosed (sub-namespaces) [default: %default]")
+    
+    def configure(self, options):
+        self.is_active_fields = options.__dict__['std.code.member.fields']
+        self.is_active_globals = options.__dict__['std.code.member.globals']
+        self.is_active_classes = options.__dict__['std.code.member.classes']
+        self.is_active_structs = options.__dict__['std.code.member.structs']
+        self.is_active_interfaces = options.__dict__['std.code.member.interfaces']
+        self.is_active_methods = options.__dict__['std.code.member.methods']
+        self.is_active_namespaces = options.__dict__['std.code.member.namspaces']
+    
+    def initialize(self):
+        # counts fields and properties with default getter/setter
+        pattern_to_search_cs = re.compile(
+            r'''([_a-zA-Z][_a-zA-Z0-9]*\s+[_a-zA-Z][_a-zA-Z0-9])\s*([=;]|[{]\s*(public\s+|private\s+|protected\s+|internal\s+)?(get|set)\s*[;])''')
+        pattern_to_search_cpp_java = re.compile(
+            r'''([_a-zA-Z][_a-zA-Z0-9]*\s+[_a-zA-Z][_a-zA-Z0-9])\s*[=;]''')
+        self.declare_metric(self.is_active_fields,
+                            self.Field('fields', int, _zero=True),
+                            {
+                             'std.code.java': pattern_to_search_cpp_java,
+                             'std.code.cpp': pattern_to_search_cpp_java,
+                             'std.code.cs': pattern_to_search_cs,
+                            },
+                            marker_type_mask=mpp.api.Marker.T.CODE,
+                            region_type_mask=mpp.api.Region.T.CLASS |
+                            mpp.api.Region.T.STRUCT | mpp.api.Region.T.INTERFACE)
+        self.declare_metric(self.is_active_fields,
+                            self.Field('globals', int, _zero=True),
+                            {
+                             'std.code.java': pattern_to_search_cpp_java,
+                             'std.code.cpp': pattern_to_search_cpp_java,
+                             'std.code.cs': pattern_to_search_cs,
+                            },
+                            marker_type_mask=mpp.api.Marker.T.CODE,
+                            region_type_mask=mpp.api.Region.T.GLOBAL |
+                            mpp.api.Region.T.NAMESPACE)
+        
+        super(Plugin, self).initialize(fields=self.get_fields())
+        
+        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

mainline/ext/std/code/mi.py

@@ -26,7 +26,7 @@ class Plugin(mpp.api.Plugin,
     
     def declare_configuration(self, parser):
         self.parser = parser
-        parser.add_option("--std.code.mi.simple", "--scms",
+        parser.add_option("--std.code.maintindex.simple", "--scmis",
             action="store_true", default=False,
             help="Enables collection of simple maintainability index metric."
              " It uses std.code.line:code, std.code.complexity:cyclomatic"
@@ -35,12 +35,12 @@ class Plugin(mpp.api.Plugin,
              " [default: %default]")
 
     def configure(self, options):
-        self.is_active_simple = options.__dict__['std.code.mi.simple']
+        self.is_active_simple = options.__dict__['std.code.maintindex.simple']
         if self.is_active_simple == True:
             required_opts = ['std.code.complexity.cyclomatic', 'std.code.lines.code']
             for each in required_opts:
                 if options.__dict__[each] == False:
-                    self.parser.error('option --std.code.mi.simple: requires --{0} option'.
+                    self.parser.error('option --std.code.maintindex.simple: requires --{0} option'.
                                       format(each))
     
     def initialize(self):

mainline/ext/std/tools/collect.ini

@@ -18,7 +18,7 @@
 ;
 
 [Plugin]
-version: 1.0
+version: 1.1
 package: std.tools
 module:  collect
 class:   Plugin

mainline/tests/general/test_basic/test_help_collect_default_stdout.gold.txt

@@ -43,7 +43,7 @@ Options:
                         Enables collection of total lines metric (per region
                         detalization) - number of any type of lines (blank,
                         code, comments, etc.)[default: False]
-  --std.code.mi.simple, --scms
+  --std.code.maintindex.simple, --scmis
                         Enables collection of simple maintainability index
                         metric. It uses std.code.line:code,
                         std.code.complexity:cyclomatic metrics to rank level
@@ -68,6 +68,25 @@ Options:
   --std.code.length.total, --sclent
                         Enables collection of size metric (in number of
                         symbols per region) [default: False]
+  --std.code.member.fields, --scmf
+                        Enables collection of number of data members / fields
+                        per classes, structs and interfaces [default: False]
+  --std.code.member.globals, --scmg
+                        Enables collection of number of global variables /
+                        fields per global regions and namespaces [default:
+                        False]
+  --std.code.member.classes, --scmc
+                        Enables collection of number of classes defined per
+                        any region [default: False]
+  --std.code.member.structs, --scms
+                        Enables collection of number of structs defined per
+                        any region [default: False]
+  --std.code.member.interfaces, --scmi
+                        Enables collection of number of interfaces defined per
+                        any region [default: False]
+  --std.code.member.methods, --scmm
+                        Enables collection of number of methods (functions)
+                        defined per any region [default: False]
   --std.code.cpp.files=STD.CODE.CPP.FILES
                         Enumerates filename extensions to match C/C++ files
                         [default: *.c,*.h,*.cpp,*.hpp,*.cc,*.hh,*.cxx,*.hxx]

mainline/tests/general/test_basic/test_workflow_info_default_stdout.gold.txt

@@ -10,7 +10,7 @@ test_workflow.db:: info: Created using plugins and settings:
 	std.code.java:files: *.java
 	std.code.todo:version: 1.0
 	std.code.todo:tags: FIXME,FixMe,HACK,TBD,TODO,ToDo,XXX
-	std.code.magic:version: 1.1
+	std.code.magic:version: 1.2
 	std.code.magic:number.simplier: False
 	std.suppress:version: 1.0
 

mainline/tests/general/test_basic/test_workflow_info_second_stdout.gold.txt

@@ -10,7 +10,7 @@ test_workflow.db:: info: Created using plugins and settings:
 	std.code.java:files: *.java
 	std.code.todo:version: 1.0
 	std.code.todo:tags: FIXME,FixMe,HACK,TBD,TODO,ToDo,XXX
-	std.code.magic:version: 1.1
+	std.code.magic:version: 1.2
 	std.code.magic:number.simplier: False
 	std.suppress:version: 1.0
 

mainline/tests/system/test_api_tutorial/ext/step5/myext/magic.py

@@ -36,7 +36,7 @@ class Plugin(mpp.api.Plugin,
     def initialize(self):
         # improve pattern to find declarations of constants
         pattern_to_search = re.compile(
-            r'''((const\s+([_a-zA-Z][_a-zA-Z0-9]*\s+)+[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
+            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),
                             # give a pair of pattern + custom counter logic class

mainline/tests/system/test_api_tutorial/ext/step6/myext/magic.py

@@ -36,10 +36,10 @@ class Plugin(mpp.api.Plugin,
     def initialize(self):
         # specialized pattern for java
         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)''')
+            r'''((const(\s+[_$a-zA-Z][_$a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         # pattern for C++ and C# languages
         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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         # pattern for all other languages
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')

mainline/tests/system/test_api_tutorial/ext/step7/myext/magic.py

@@ -35,9 +35,9 @@ class Plugin(mpp.api.Plugin,
     
     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)''')
+            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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')
         self.declare_metric(self.is_active_numbers,

mainline/tests/system/test_api_tutorial/ext/step8/myext/magic.py

@@ -41,9 +41,9 @@ class Plugin(mpp.api.Plugin,
     
     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)''')
+            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)''')
+            r'''((const(\s+[_a-zA-Z][_a-zA-Z0-9]*)+\s*[=]\s*)[-+]?[0-9]+\b)|(\b[0-9]+\b)''')
         pattern_to_search = re.compile(
             r'''\b[0-9]+\b''')
         self.declare_metric(self.is_active_numbers,

mainline/tests/system/test_boost_parts/test_workflow_info_default_stdout.gold.txt

@@ -10,7 +10,7 @@ test_workflow.db:: info: Created using plugins and settings:
 	std.code.java:files: *.java
 	std.code.todo:version: 1.0
 	std.code.todo:tags: FIXME,FixMe,HACK,TBD,TODO,ToDo,XXX
-	std.code.magic:version: 1.1
+	std.code.magic:version: 1.2
 	std.code.magic:number.simplier: False
 
 test_workflow.db:: info: Collected metrics: