Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/matzeschmid/Cppcheck-HIS-addon

HIS metric python addon for Cppcheck
https://github.com/matzeschmid/Cppcheck-HIS-addon

Last synced: about 1 month ago
JSON representation

HIS metric python addon for Cppcheck

Host: GitHub
URL: https://github.com/matzeschmid/Cppcheck-HIS-addon
Owner: matzeschmid
License: unlicense
Created: 2019-12-03T16:32:26.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-04-29T13:57:23.000Z (4 months ago)
Last Synced: 2024-07-25T02:44:13.347Z (about 2 months ago)
Language: Python
Size: 75.2 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Cppcheck-HIS-addon

HIS metric python addon for Cppcheck.

This addon depends on functionality provided by `cppcheckdata.py` which is part of Cppcheck `addons` directory.

This addon has been tested 

  - with Cppcheck Release v1.84 up to v2.14

  - using Python 2.7.x as well as 3.8.x

  - using Python 3.10 (Windows 10 only)

  - on a machine running 64-bit Ubuntu 20.10

  - on a machine running 64-bit Windows 10

**NOTE:** Since Cppcheck v2.8 there is a `pathlib` module dependency. This module has been introduced with Python 3.4 . For earlier Python versions use `pip` to install it.

# Supported HIS metric checks

The following metrics are checked according to document `HIS source code metrics v1.3.1` .

| Metric | Description | Range | Note |

| ------ | ----------- |:-----:|:----:|

| HIS-COMF | Relationship of comments to number of statements | > 0.2 | |

| HIS-PATH | Number of non cyclic remark paths | 1-80 | Experimental, not finished yet! |

| HIS-GOTO | Number of goto statements | 0 | |

| HIS-STCYC | Cyclomatic complexity v(G) of functions by McCabe | 1-10 | |

| HIS-CALLING | Number of subfunctions calling a function | 0-5 | |

| HIS-CALLS | Number of called functions excluding duplicates | 0-7 | |

| HIS-PARAM | Number of function parameters | 0-5 | |

| HIS-STMT | Number of statements per function | 1-50 | |

| HIS-LEVEL | Depth of nesting of a function | 0-4 | |

| HIS-RETURN | Number of return points within a function | 0-1 | |

| HIS-VOCF | Language scope | 1-4 | Experimental, not finished yet! |

| HIS-NRECUR | Number of recursions | 0 | |

# Missing HIS metric checks

The following metrics part of document `HIS source code metrics v1.3.1` are not checked.

| Metric | Description | Note |

| ------ | ----------- |:-----:|

| HIS-SI | Stability index | Not supported |

| HIS-NOMV | Number of MISRA HIS Subset violations | Not supported |

| HIS-NOMVPR | Number of MISRA HIS Subset violations per rule | Not supported |

| HIS-SCHG | Number of changed statements | Not supported |

| HIS-SDEL | Number of deleted statements | Not supported |

| HIS-SNEW | Number of new statements | Not supported |

# Installation

Directories are the same as for Cppcheck addons.

  - Copy `his.py` to `addons` directory of Cppcheck installation.

  - Optional: For test purposes copy test pattern files from `addons/test` to corresponding directory of Cppcheck installation.

# Usage

Run `python his.py -h` or `python his.py --help` to get help on how to use HIS metric addon and show which command line options are available.

HIS metric addon uses first configuration of Cppcheck dump file(s) only. Thus create dump files for desired configuration using Cppcheck with command line options or project file.

**Example how to use HIS addon with HIS metric test pattern files on a Linux machine.**

1. Create a dump file for the source files which are desired to be checked.

   `$> ~/cppcheck/cppcheck --dump ~/cppcheck/cppcheck/addons/test/his-test.c ~/cppcheck/cppcheck/addons/test/his-test-calling.c`

2. Run HIS metric checker using dump files created during previous step.

   `$> python ~/cppcheck/addons/his.py ~/cppcheck/cppcheck/addons/test/his-test.c.dump ~/cppcheck/cppcheck/addons/test/his-test-calling.c.dump`

**Example how to call HIS addon from Cppcheck with HIS metric test pattern files on a Linux machine.**

Call HIS addon for files `his-test.c` and `his-test-calling.c` and write result to `his.xml`.

`$> ~/cppcheck/cppcheck --addon=his --xml --output-file=his.xml ~/cppcheck/cppcheck/addons/test/his-test.c ~/cppcheck/cppcheck/addons/test/his-test-calling.c`

**NOTE:** Calling HIS addon from Cppcheck using command line option --addon might suppress HIS-CALLING, HIS-NRECUR and HIS-VOCF violations depending on multiple files because addon is called for each dump file separatly.

**NOTE:** Command line option --addon is available since Cppcheck v1.88 .

**Example how to suppress metrics (e.g. HIS-GOTO and HIS-PARAM)**

    `$> python ~/cppcheck/addons/his.py --suppress-metrics GOTO,PARAM ~/cppcheck/cppcheck/addons/test/his-test.c.dump ~/cppcheck/cppcheck/addons/test/his-test-calling.c.dump`

    

**Example how to modify upper limit of metrics (e.g. HIS-RETURN and HIS-PARAM)**

    `$> python ~/cppcheck/addons/his.py --modify-metrics RETURN:2,PARAM:6 ~/cppcheck/cppcheck/addons/test/his-test.c.dump ~/cppcheck/cppcheck/addons/test/his-test-calling.c.dump`

    Upper limit of following metrics could be modified: PATH, STCYC, CALLING, CALLS, PARAM, STMT, LEVEL, RETURN