nsiqcppstyle

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #llm #java #nodejs #windows #cli #kubernetes #vue #security #mcp #open-source

(★ 27)

Cpp style checker in python

nsiqcppstyle Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Tests CI](https://github.com/kunaltyagi/nsiqcppstyle/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/kunaltyagi/nsiqcppstyle/actions/workflows/tests.yml)
# About

nsiqcppstyle is one of the most customizable cpp style checkers about.

## Development
Please install [hatch](hatch.pypa.io/) using `pip install hatch`. You can either use `hatch run <command>` or activate the virtual environment using `hatch shell <$SHELL>`

Some handy commands:

* `hatch run lint:fmt`: Format code
* `hatch run update`: Update dependencies post change in `pyproject.toml`

## Features

* Checks more than 47 rules. You can find the available rules in http://nsiqcppstyle.appspot.com or run the command (given below)
* No complex preprocess setting(Easy to run. Just run the nsiqcppstyle in the folder to be analyzed.)
* Rule / Analysis engine separated structure.
* Easy to add custom rules.
* Analysis engine parses source code in heuristic way not concrete grammar. So it supports **most** C/C++ variations.
* Supports IDE integation.
* Easy to integrate in Visual Studio / Emacs / Eclipse CDT. Support each IDE standard error output format.
* Support CI server.
* Support checkstyle xml output. You can use checkstyle plugin in various CI server to show N'SIQ CppStyle result.
* Various violation suppression
* Provides 4 way to suppress the false alarm. filefilter / basefile / rule ignore per file / violation ignore

## Known limitations
AFAIK, C++98, C++11 and C++14 code doesn't produce false positives. If you encounter some, please create an issue.
Several features of C++20 onwards are not implemented yet. A non-exhaustive list is provided here:
* Spaceship operator `<=>`
* `requires`
* concepts
* modules

There are a few corner cases where false positives are generated on a pure C code.

One such known case is while returning ```struct``` from a function (See Issue #8).
```C
struct test_struct
{
    int a;
    int b;
};

struct test_struct func(void)
{
    struct test_struct ts = {1, 2};
    return ts;
}
```

A simple solution is to use ```typedef``` so that the lexer doesn't think of ```func``` like a structure but a function.
```C
typedef struct test_struct
{
    int a;
    int b;
} test_struct;

test_struct func(void)
...
```

# Instructions

It's really simple

## How to set up the rules to be used.

1. Make the filefilter.txt in the root folder which contains C/C++ file and write the rules to be used in following way. You can find the lastest available rules in http://nsiqcppstyle.appspot.com/rule_doc/ or just find the rules in the rules folder in N'SIQ CppStyle isntallation.

~ RULE_10_1_A_do_not_use_bufferoverflow_risky_function_for_unix
        ~ RULE_10_1_B_do_not_use_bufferoverflow_risky_function_for_windows
        ~ RULE_3_1_A_do_not_start_filename_with_underbar
        ~ RULE_3_2_B_do_not_use_same_filename_more_than_once
        ~ RULE_3_2_CD_do_not_use_special_characters_in_filename
        ~ RULE_3_2_F_use_representitive_classname_for_cpp_filename
        ~ RULE_3_2_H_do_not_use_underbars_for_cpp_filename
        ~ RULE_3_2_H_do_not_use_uppercase_for_c_filename
        ~ RULE_3_3_A_start_function_name_with_is_or_has_when_return_bool
        ~ RULE_3_3_A_start_function_name_with_lowercase_unix
        ~ RULE_3_3_A_start_function_name_with_upperrcase_windows
        ~ RULE_3_3_B_start_private_function_name_with_underbar
        ~ RULE_4_1_A_A_use_tab_for_indentation
        ~ RULE_4_1_A_B_use_space_for_indentation
        ~ RULE_4_1_B_indent_each_enum_item_in_enum_block
        ~ RULE_4_1_B_locate_each_enum_item_in_seperate_line
        ~ RULE_4_1_C_align_long_function_parameter_list
        ~ RULE_4_1_E_align_conditions
        ~ RULE_4_2_A_A_space_around_operator
        ~ RULE_4_2_A_B_space_around_word
        ~ RULE_4_4_A_do_not_write_over_120_columns_per_line
        ~ RULE_4_5_A_braces_for_function_definition_should_be_located_in_seperate_line
        ~ RULE_4_5_A_braces_for_type_definition_should_be_located_in_seperate_line
        ~ RULE_4_5_A_braces_inside_of_function_should_be_located_in_end_of_line
        ~ RULE_4_5_A_indent_blocks_inside_of_function
        ~ RULE_4_5_A_matching_braces_inside_of_function_should_be_located_same_column
        ~ RULE_4_5_B_use_braces_even_for_one_statement
        ~ RULE_5_2_C_provide_doxygen_class_comment_on_class_def
        ~ RULE_5_2_C_provide_doxygen_namespace_comment_on_namespace_def
        ~ RULE_5_2_C_provide_doxygen_struct_comment_on_struct_def
        ~ RULE_5_3_A_provide_doxygen_function_comment_on_function_in_header
        ~ RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl
        ~ RULE_6_1_A_do_not_omit_function_parameter_names
        ~ RULE_6_1_E_do_not_use_more_than_5_paramters_in_function
        ~ RULE_6_1_G_write_less_than_200_lines_for_function
        ~ RULE_6_2_A_do_not_use_system_dependent_type
        ~ RULE_6_4_B_initialize_first_item_of_enum
        ~ RULE_6_5_B_do_not_use_lowercase_for_macro_constants
        ~ RULE_6_5_B_do_not_use_macro_for_constants
        ~ RULE_7_1_B_A_do_not_use_double_assignment
        ~ RULE_7_1_C_do_not_use_question_keyword
        ~ RULE_7_2_B_do_not_use_goto_statement
        ~ RULE_8_1_A_provide_file_info_comment
        ~ RULE_9_1_A_do_not_use_hardcorded_include_path
        ~ RULE_9_2_D_use_reentrant_function
        ~ RULE_A_3_avoid_too_deep_blocks

2. If you want to rule all available rules first, just run ```"nsiqcppstyle -r > filefilter.txt"```.

filefilter.txt is configuration file for the friend tool N'SIQ Collector originally. The filter setting for selecting which file is analyzed by file name pattern matching. N'SIQ CppStyle uses N'SIQCollector filefilter.txt file for reuse of the settings. In addition N'SIQ CppStyle uses '~' character to represent the applying rules in filefilter.txt.

3. **Warning**: Some rules above conflict each other. Eg:
       RULE_4_1_A_A_use_tab_for_indent
       RULE_4_1_A_B_use_space_for_indent.
    So you should carefully pick the appropriate rules which fit your need.

## How to run N'SIQ CppStyle on a folder containing C/C++ files

* After rule setting, run following. Of course the folder which stores nsiqcppstyle should be in the path

```nsiqcppstyle folder_to_be_analyzed```

Then, N'SIQ CppStyle outputs the analyzed result.
```
======================================================================================
Update: checking for update

============================ Analyzing box ===========================================
======================================================================================

* load rule set in filefilter.txt

-  RULE_10_1_A_do_not_use_bufferoverflow_risky_function_for_unix is applied.
    ~~~
  -  RULE_9_1_A_do_not_use_hardcorded_include_path is applied.
======================================================================================

* report filefilter.txt settings.

Filter Scope "default" is applied.
Current Filter Setting (Following is applied sequentially)
  1. \externals\ is excluded
  2. \box\ is excluded
  3. \tet\ is excluded
  4. \.cvs\ is excluded
  5. \.svn\ is excluded
  6. \.git\ is excluded

Current File extension and Language Settings
  C/C++=c,cxx,h,hpp,cpp,hxx

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

* Violation list

d:\sample\a.c(1, 5):  Do not start function name(SetGlobalAuthority) with uppercase  [RULE_3_3_A_start_function_name_with_lowercase_unix]
d:\sample\a.c(1, 5):  Doxygen Comment should be provided in front of function (SetGlobalAuthority) in impl file.  [RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(1, 1):  Please provide file info comment in front of file  [RULE_8_1_A_provide_file_info_comment]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(21, 6):  Do not start function name(writeLog) with lowercase  [RULE_3_3_A_start_function_name_with_upperrcase_windows]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(21, 6):  Doxygen Comment should be provided in front of function (writeLog) in impl file.  [RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(36, 6):  Do not start function name(openOut) with lowercase  [RULE_3_3_A_start_function_name_with_upperrcase_windows]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(36, 6):  Doxygen Comment should be provided in front of function (openOut) in impl file.  [RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(40, 2):  Matching Braces inside of function should be located in the same column   [RULE_4_5_A_braces_inside_of_function_should_be_located_same_column]
d:\sample\utils\trunk\boxmonlog\boxmonlog.cpp(44, 3):  Do not use system dependent type(int). Use system independent type like (int32_t)

=============================== Summary Report ==========================================

** Total Available Rules     : 46
 ** Total Applied Rules       : 43
 ** Total Violated Rules      : 20
 ** Total Errors Occurs       : 243
 ** Total Analyzed Files      : 8
 ** Total Violated Files Count: 8
 ** Build Quality             : 0.00%  <== (total analyzed files - the ratio total violated file count) / total analyzed files * 100

=========================== Violated Rule Details ==========================

-  RULE_4_2_A_A_space_between_operators rule violated : 42
   ~~
 -  RULE_3_3_A_start_function_name_with_is_or_has_when_return_bool rule violated : 11

=========================== Violated File Details ==========================

-  d:\sample\utils\_service\jobqueue.h  violated in total :  5
   *  RULE_4_2_A_A_space_between_operators  :  1
   ~~
   *  RULE_5_2_C_provide_doxygen_struct_comment_on_struct_def  :  1
 -  d:\sample\utils\_service\broker.cpp  violated in total :  44
   *  RULE_4_2_A_A_space_between_operators  :  10
    ~~
   *  RULE_5_2_C_provide_doxygen_class_comment_on_class_def  :  1
```

## How to run N'SIQ CppStyle on single C/C++ file

N'SIQ CppStyle supports single file analysis as well as folder analysis. Run the following.

```
nsiqcppstyle -f file_filter_file_name file_to_be_analyzed
```

When analyzing a folder, N'SIQ CppStyle can find the filefilter.txt location under the analyzed folder. However, There is no way to automatically figure out where filefilter.txt is. So you should provide the filefilter file location, when analyzing single file.

# Available Options

## How to suppress rule violations

N'SIQ CppStyle provide the per violation / file violation suppression
You can provide the comment just next to the false alarmed violation.
```
ErrorCase // NS
```

```// NS``` is short form of No Style. Which means no rules are applied in this line.

You can ignore some rules per file. Provide the following line in the first comment of source code.
```
/*
-- RULE_NAME
*/
```

## How to filter files

If you want to filter in or out some source code files in the target directory please locate filefilter.txt file in the target directory in the form of
```
* FILTER_SCOPE_NAME
+ INCLUDE_PATH_STRING
- EXCLUDE_PATH_STRING
~ RULE NAME
```
For example, If you provide
```
* default
- \
+ \src\
- **\test\
+ \src\*\test\
~ RULES....
```

The filter rules (starting with `+` and `-`) are applied sequentially. This this situation, nsiqcppstyle will:

* all source files under `src`
* excluding any file under a `test` dir, top level or under `src` or any other folder/sub-folder
* except in the `\src\<some directory>\test` directory

This will reject `\src\test\main.cpp` and `\third_party\test` but accept `\src\third_party\test\main.cpp`

### Pattern Maching
Please use Python 3.13 or higher if you intend to make use of pattern matching for filter files. Backported functionality has limitations and will change behavior depending on python version.

* `**` matches none or one-or-more sub-directories, irrespective of what characters they contain in their name
* `*` matches any filename, except one with a directory separator

## Integration with CI

nsiqcppstyle supports checkstyle output. So you can you checkstyle hudson plugin to integrate nsiqcppstyle into hudson.

In you build file, please add following
```
nsiqcppstyle --ci --output=xml folder_to_be_analyzed
```
Single files are also allowed in this format

# Credits

All ther development upto Aug 18 was done by [JunHo Yoon](https://code.google.com/u/103331831595695901509/). For more information, contact him on twitter : [@Junotest](https://twitter.com/junotest)

Original code can be found [here](https://code.google.com/p/nsiqcppstyle/)

Also, instructions for deploying a rule server can be found [here](https://code.google.com/p/nsiqcppstyle/wiki/HowToInstallNsiqCppStyleServer).

I haven't tested this functionality as of now **2014-08-19 Tue 11:05 PM**

nsiqcppstyle

nsiqcppstyle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nsiqcppstyle

nsiqcppstyle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README