ncc

ncc

C/C++-Namenskonventionsprüfer (ncc)

ncc ist ein Entwicklungstool, das Programmierern beim Schreiben von C/C++-Code hilft, der einigen Namenskonventionen entspricht. Es automatisiert den Prozess der Überprüfung von C/C++-Code, um Menschen diese langweilige (aber wichtige) Aufgabe zu ersparen. Dies macht es ideal für Projekte, die einen Codierungsstandard durchsetzen möchten.

Abhängigkeiten

Die folgenden Pakete sind Voraussetzungen für das NCC-Tool. Beachten Sie, dass der Python „clang“ libclang-Python-Bindungen bereitstellt. Die Clang-Version sollte mit der libclang.so-Version auf Ihrem System übereinstimmen

• klirren
• Yaml

 pip install clang
pip install pyyaml

Windows

Installieren Sie unter Microsoft Windows die 32-Bit-Version der LLVM-Compiler-Toolkette.

Verwendung

 ncc . py [ - - help ] [ - - recurse ] [ - - style STYLE_FILE ] [ - - cdbdir CDBDIR ] [ - - dump ]
       [ - - output OUTPUT ] [ - - filetype FILETYPE ] [ - - exclude EXCLUDE [ EXCLUDE ...]]
       [ - - path PATH [ PATH ...]] [ - - include INCLUDE [ INCLUDE ...]]
       [ - - definition DEFINITION [ DEFINITION ...]] [ - - clang - lib CLANG_LIB ]

Für eine detaillierte Beschreibung aller Optionen:

 ncc . py - - help

So drucken Sie alle Regeln aus:

    ncc . py - - dump 

Stildefinition

Der Stil für C/C++-Konstrukte wird durch reguläre Ausdrücke definiert. Die folgenden Regeln besagen beispielsweise, dass eine Struktur ein beliebiges Zeichen haben kann, ein Klassenname mit „C“ beginnen sollte, eine Klassenmitgliedsvariable mit m_ beginnen sollte und ein Funktionsname mit Großbuchstaben beginnen sollte

    ClassName : ' C.* '
    CppMethod : ' [A-Z].* '
    VariableName :
        ScopePrefix :
            Global : ' g_ '
            Static : ' s_ '
            ClassMember : ' m_ '
        DataTypePrefix :
            String : ' str '
            Pointer : ' p '
            Integer : ' n '
            Bool : ' b '
        Pattern : ' ^.*$ ' 

Beispielverwendung

Überprüfen Sie die Datei test.cpp auf Verstöße gegen die Namenskonvention:

    ./ncc.py --style examples/ncc.style --path examples/test.cpp

    examples/test.cpp:16:7: " B " does not match " ^C.*$ " associated with ClassName
    examples/test.cpp:28:9: " b " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/test.cpp:31:5: " main(int, const char **) " does not match " ^[A-Z].*$ " associated with FunctionName
    Total number of errors = 3

Suchen Sie rekursiv alle Dateien im Verzeichnis „examples“, schließen Sie jedoch „ .cpp“- und „ .h“-Dateien aus

    ./ncc.py --style examples/ncc.style --recurse --exclude * .cpp * .h --path examples

    examples/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
    examples/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/test.c:8:9: " _b " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/test.c:9:9: " _c " does not match " ^[a-z].*$ " associated with StructMemberVariable
    examples/tmp/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
    examples/tmp/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
    examples/tmp/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
    Total number of errors = 8

Lizenz

Copyright © 2018 Nithin Nellikunnu

Verteilt unter der MIT-Lizenz (MIT).

Danke

Daniel J. Hofmann