# Collect common metrics about mclasses
module mclasses_metrics
-import model
import metrics_base
-import phase
-import frontend
+import model::model_collect
redef class ToolContext
- var mclasses_metrics_phase = new MClassesMetricsPhase(self, null)
+
+ # MClass related metrics phase
+ var mclasses_metrics_phase: Phase = new MClassesMetricsPhase(self, null)
end
# Extract metrics about mclasses from model.
private class MClassesMetricsPhase
super Phase
- redef fun process_mainmodule(mainmodule)
+ redef fun process_mainmodule(mainmodule, given_mmodules)
do
if not toolcontext.opt_mclasses.value and not toolcontext.opt_all.value then return
+ var csv = toolcontext.opt_csv.value
+ var out = "{toolcontext.opt_dir.value or else "metrics"}/mclasses"
+ out.mkdir
+
+ var model = toolcontext.modelbuilder.model
+ var filter = new ModelFilter(private_visibility)
print toolcontext.format_h1("\n# MClasses metrics")
- var metrics = new MClassMetricSet
- var min_vis = private_visibility
- metrics.register(new CNOA(mainmodule))
- metrics.register(new CNOP(mainmodule))
- metrics.register(new CNOC(mainmodule))
- metrics.register(new CNOD(mainmodule))
- metrics.register(new CDIT(mainmodule))
- metrics.register(new CNBIP(mainmodule, min_vis))
- metrics.register(new CNBRP(mainmodule, min_vis))
- metrics.register(new CNBHP(mainmodule, min_vis))
- #TODO metrics.register(new CNBI) # nb init
- #TODO metrics.register(new CNBA) # nb attrs
- #TODO metrics.register(new CNBM) # nb methods
- #TODO metrics.register(new CNBV) # nb vtypes
+ var metrics = new MetricSet
+ metrics.register(new CNOA(model, mainmodule, filter))
+ metrics.register(new CNOP(model, mainmodule, filter))
+ metrics.register(new CNOC(model, mainmodule, filter))
+ metrics.register(new CNOD(model, mainmodule, filter))
+ metrics.register(new CDIT(model, mainmodule, filter))
+ metrics.register(new CNBP(model, mainmodule, filter))
+ metrics.register(new CNBA(model, mainmodule, filter))
+ metrics.register(new CNBI(model, mainmodule, filter))
+ metrics.register(new CNBM(model, mainmodule, filter))
+ metrics.register(new CNBV(model, mainmodule, filter))
+ metrics.register(new CNBIP(model, mainmodule, filter))
+ metrics.register(new CNBRP(model, mainmodule, filter))
+ metrics.register(new CNBHP(model, mainmodule, filter))
- var model = toolcontext.modelbuilder.model
var mclasses = new HashSet[MClass]
- for mproject in model.mprojects do
+ for mpackage in model.mpackages do
- print toolcontext.format_h2("\n ## project {mproject}")
+ print toolcontext.format_h2("\n ## package {mpackage}")
- for mgroup in mproject.mgroups do
+ for mgroup in mpackage.mgroups do
if mgroup.mmodules.is_empty then continue
+ metrics.clear
# Scalar metrics
print toolcontext.format_h3(" `- group {mgroup.full_name}")
-
var mod_mclasses = new HashSet[MClass]
for mmodule in mgroup.mmodules do mod_mclasses.add_all(mmodule.intro_mclasses)
if mod_mclasses.is_empty then continue
mclasses.add_all(mod_mclasses)
- metrics.collect(new HashSet[MClass].from(mod_mclasses), mainmodule)
- for name, metric in metrics.metrics do
- if metric isa IntMetric then
- print toolcontext.format_h4("\t{name}: {metric.desc}")
- print toolcontext.format_p("\t avg: {metric.avg}")
- var max = metric.max
- print toolcontext.format_p("\t max: {max.first} ({max.second})")
- var min = metric.min
- print toolcontext.format_p("\t min: {min.first} ({min.second})")
- end
- end
+ metrics.collect(new HashSet[MClass].from(mod_mclasses))
+ metrics.to_console(1, not toolcontext.opt_nocolors.value)
+ if csv then metrics.to_csv.write_to_file("{out}/{mgroup}.csv")
end
end
if not mclasses.is_empty then
+ metrics.clear
# Global metrics
print toolcontext.format_h2("\n ## global metrics")
-
- metrics.collect(mclasses, mainmodule)
- for name, metric in metrics.metrics do
- if metric isa IntMetric then
- print toolcontext.format_h4("\t{name}: {metric.desc}")
- print toolcontext.format_p("\t avg: {metric.avg}")
- var max = metric.max
- print toolcontext.format_p("\t max: {max.first} ({max.second})")
- var min = metric.min
- print toolcontext.format_p("\t min: {min.first} ({min.second})")
- end
- end
- end
- end
-end
-
-# An MetricSet for MClasses metrics
-class MClassMetricSet
- super MetricSet
- redef type METRIC: MClassMetric
-
- # Collect all the metrics on the set of MClasses
- fun collect(mclasses: Set[MClass], mainmodule: MModule) do
- clear
- for metric in metrics.values do
- metric.collect(mclasses)
+ metrics.collect(mclasses)
+ metrics.to_console(1, not toolcontext.opt_nocolors.value)
+ if csv then metrics.to_csv.write_to_file("{out}/summary.csv")
end
end
end
# A metric about MClass
-interface MClassMetric
+abstract class MClassMetric
super Metric
redef type ELM: MClass
+
+ # Model used to collect and filter entities
+ var model: Model
+
+ # Mainmodule for class linearization
+ var mainmodule: MModule
+
+ # Filter to apply
+ var filter: nullable ModelFilter
end
# Class Metric: Number of Ancestors
redef fun name do return "cnoa"
redef fun desc do return "number of ancestor classes"
- var mainmodule: MModule
- init(mainmodule: MModule) do self.mainmodule = mainmodule
-
redef fun collect(mclasses) do
for mclass in mclasses do
values[mclass] = mclass.in_hierarchy(mainmodule).greaters.length - 1
redef fun name do return "cnop"
redef fun desc do return "number of parent classes"
- var mainmodule: MModule
- init(mainmodule: MModule) do self.mainmodule = mainmodule
-
redef fun collect(mclasses) do
for mclass in mclasses do
values[mclass] = mclass.in_hierarchy(mainmodule).direct_greaters.length
redef fun name do return "cnoc"
redef fun desc do return "number of child classes"
- var mainmodule: MModule
- init(mainmodule: MModule) do self.mainmodule = mainmodule
-
redef fun collect(mclasses) do
for mclass in mclasses do
values[mclass] = mclass.in_hierarchy(mainmodule).direct_smallers.length
redef fun name do return "cnod"
redef fun desc do return "number of descendant classes"
- var mainmodule: MModule
- init(mainmodule: MModule) do self.mainmodule = mainmodule
-
redef fun collect(mclasses) do
for mclass in mclasses do
values[mclass] = mclass.in_hierarchy(mainmodule).smallers.length - 1
redef fun name do return "cdit"
redef fun desc do return "depth in class tree"
- var mainmodule: MModule
- init(mainmodule: MModule) do self.mainmodule = mainmodule
-
redef fun collect(mclasses) do
for mclass in mclasses do
values[mclass] = mclass.in_hierarchy(mainmodule).depth
end
end
+# Class Metric: Number of MProperties
+class CNBP
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnbp"
+ redef fun desc do return "number of accessible properties (inherited + local)"
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_accessible_mproperties(mainmodule, filter).length
+ end
+ end
+end
+
+# Class Metric: Number of MAttributes
+class CNBA
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnba"
+ redef fun desc do return "number of accessible attributes (inherited + local)"
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_accessible_mattributes(mainmodule, filter).length
+ end
+ end
+end
+
+# Class Metric: Number of MMethods
+class CNBM
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnbm"
+ redef fun desc do return "number of accessible methods (inherited + local)"
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_accessible_mmethods(mainmodule, filter).length
+ end
+ end
+end
+
+# Class Metric: Number of Constructors
+class CNBI
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnbi"
+ redef fun desc do return "number of accessible constructors (inherited + local)"
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_accessible_inits(mainmodule, filter).length
+ end
+ end
+end
+
+# Class Metric: Number of Virtual Types
+class CNBV
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnbv"
+ redef fun desc do return "number of accessible virtual types (inherited + local)"
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_accessible_vts(mainmodule, filter).length
+ end
+ end
+end
+
# Class Metric: Number of Introduced MProperties
class CNBIP
super MClassMetric
redef fun name do return "cnbip"
redef fun desc do return "number of introduced properties"
- var mainmodule: MModule
- var min_visibility: MVisibility
-
- init(mainmodule: MModule, min_visibility: MVisibility) do
- self.mainmodule = mainmodule
- self.min_visibility = min_visibility
- end
-
redef fun collect(mclasses) do
for mclass in mclasses do
- values[mclass] = mclass.intro_mproperties(min_visibility).length
+ values[mclass] = mclass.collect_intro_mproperties(filter).length
end
end
end
redef fun name do return "cnbrp"
redef fun desc do return "number of redefined properties"
- var mainmodule: MModule
- var min_visibility: MVisibility
-
- init(mainmodule: MModule, min_visibility: MVisibility) do
- self.mainmodule = mainmodule
- self.min_visibility = min_visibility
- end
-
redef fun collect(mclasses) do
for mclass in mclasses do
- values[mclass] = mclass.redef_mproperties(min_visibility).length
+ values[mclass] = mclass.collect_redef_mproperties(filter).length
end
end
end
redef fun name do return "cnbhp"
redef fun desc do return "number of inherited properties"
- var mainmodule: MModule
- var min_visibility: MVisibility
-
- init(mainmodule: MModule, min_visibility: MVisibility) do
- self.mainmodule = mainmodule
- self.min_visibility = min_visibility
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.collect_inherited_mproperties(mainmodule, filter).length
+ end
end
+end
+
+# Class Metric: Number of Local MProperties (Intro + Redef)
+class CNBLP
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnblp"
+ redef fun desc do return "number of local properties (intro + redef)"
redef fun collect(mclasses) do
for mclass in mclasses do
- values[mclass] = mclass.inherited_mproperties(mainmodule, min_visibility).length
+ values[mclass] = mclass.collect_local_mproperties(filter).length
end
end
end
-
nitlanguage / nit.git / blobdiff