Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ideadapt/metriculator

Eclipse CDT plug-in to create static c++ source code metrics
https://github.com/ideadapt/metriculator

Last synced: 3 days ago
JSON representation

Eclipse CDT plug-in to create static c++ source code metrics

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/ideadapt/metriculator.png?branch=master)](https://travis-ci.org/ideadapt/metriculator)



metriculator was subject of my bachelor thesis, the original documentation is available as PDF from http://eprints.hsr.ch/223/.



Features

========

* Various C++ source code metrics (McCabe Complexity, Logical Lines of Code, Number of Params, Efferent Coupling, Number of Members)

* Smoothly integrated into Eclipse UI (Juno and earlier)

* Rich export functions (tag cloud image, HTML report, ASCII Text file, plain XML)

* Configurable limits per metric (e.g. maximum lines of code per function)

* Designed to easily add your own metrics (via separate plugin or via project contribution)



Installation

============

* Download Eclipse CDT (or install C++ Development Tools as plug-in) from eclipse.org

* Install the following plug-ins via update site in eclipse:

  

  _zest_: https://hudson.eclipse.org/hudson/job/gef-zest-integration/ws/org.eclipse.zest.repository/target/repository/

   Zest is not supported in Eclipse Juno. Zest is only required if metriculator will be installed with the tag cloud feature.



  _metriculator_: http://metriculator.ideadapt.net



metriculator is also available from Eclipse marketplace: http://marketplace.eclipse.org/content/metriculator

To install from marketplace simply drag and drop the following _install_ button into your running Eclipse window.



 

	




Contributer Notes

=================



Metriculator allows you to add new C++ metrics easily. There are already some metrics implemented which might help you to implement additional metrics. The following steps describe how you can add new metrics fast an simple. This manual assumes that you are working with Eclipse and have installed the Plug-in Development Environment (PDE) as well as the C/C++ Development Tooling (CDT) plug-in.



Set up metriculator Eclipse Workspace

-------------------------------------

1. Checkout sources from the Git at GitHub repository

2. In Eclipse Import Existing Projects into Workspace, select the repository checked

out from point 1.

3. Set the missing baselines to ignore in Eclipse > Window > Preferences > Plug-in

Development > API Baselines.

4. Open the target definition file in the package metriculator and set it as target platform.

5. Update all the locations.



Adding a New Metric

-------------------

1. Add a new checker with a problem in the plugin.xml.

2. Create a new metric class which inherits from _AbstractMetric_.

 - If your new metric requires a non default metric value aggregation, override the _aggregate_ method.

3. Create a new metric checker class that inherits from _AbstractMetricChecker_.

 - Define a problem ID.

 - Create the name, description and preferences strings.

 - Add the name, description and preferences strings to the MetricLabels.properties file in the package resources.

 - Add the name, description and preferences strings to _MetricLabels_.

 - Create a new instance of the metric in this checker.

 - Register the new metric at the MetriculatorPluginActivator singleton instance.

 - Implement the reportProblemsFor method.

 - Implement the processTranslationUnit method. See chapter 3 for further information about visitors.

 

Pull Requests

-------------------------------------

To see whether your pull request would successfully build, after merged into the master branch, have a look at Travis-CI