1 //===-- CppCoreGuidelinesTidyModule.cpp - clang-tidy ----------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "../ClangTidy.h" 10 #include "../ClangTidyModule.h" 11 #include "../ClangTidyModuleRegistry.h" 12 #include "../misc/NonPrivateMemberVariablesInClassesCheck.h" 13 #include "../misc/UnconventionalAssignOperatorCheck.h" 14 #include "../modernize/AvoidCArraysCheck.h" 15 #include "../modernize/UseOverrideCheck.h" 16 #include "../readability/MagicNumbersCheck.h" 17 #include "AvoidGotoCheck.h" 18 #include "AvoidNonConstGlobalVariablesCheck.h" 19 #include "InitVariablesCheck.h" 20 #include "InterfacesGlobalInitCheck.h" 21 #include "MacroUsageCheck.h" 22 #include "NarrowingConversionsCheck.h" 23 #include "NoMallocCheck.h" 24 #include "OwningMemoryCheck.h" 25 #include "PreferMemberInitializerCheck.h" 26 #include "ProBoundsArrayToPointerDecayCheck.h" 27 #include "ProBoundsConstantArrayIndexCheck.h" 28 #include "ProBoundsPointerArithmeticCheck.h" 29 #include "ProTypeConstCastCheck.h" 30 #include "ProTypeCstyleCastCheck.h" 31 #include "ProTypeMemberInitCheck.h" 32 #include "ProTypeReinterpretCastCheck.h" 33 #include "ProTypeStaticCastDowncastCheck.h" 34 #include "ProTypeUnionAccessCheck.h" 35 #include "ProTypeVarargCheck.h" 36 #include "SlicingCheck.h" 37 #include "SpecialMemberFunctionsCheck.h" 38 #include "VirtualClassDestructorCheck.h" 39 40 namespace clang { 41 namespace tidy { 42 namespace cppcoreguidelines { 43 44 /// A module containing checks of the C++ Core Guidelines 45 class CppCoreGuidelinesModule : public ClangTidyModule { 46 public: 47 void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { 48 CheckFactories.registerCheck<modernize::AvoidCArraysCheck>( 49 "cppcoreguidelines-avoid-c-arrays"); 50 CheckFactories.registerCheck<AvoidGotoCheck>( 51 "cppcoreguidelines-avoid-goto"); 52 CheckFactories.registerCheck<readability::MagicNumbersCheck>( 53 "cppcoreguidelines-avoid-magic-numbers"); 54 CheckFactories.registerCheck<AvoidNonConstGlobalVariablesCheck>( 55 "cppcoreguidelines-avoid-non-const-global-variables"); 56 CheckFactories.registerCheck<modernize::UseOverrideCheck>( 57 "cppcoreguidelines-explicit-virtual-functions"); 58 CheckFactories.registerCheck<InitVariablesCheck>( 59 "cppcoreguidelines-init-variables"); 60 CheckFactories.registerCheck<InterfacesGlobalInitCheck>( 61 "cppcoreguidelines-interfaces-global-init"); 62 CheckFactories.registerCheck<MacroUsageCheck>( 63 "cppcoreguidelines-macro-usage"); 64 CheckFactories.registerCheck<NarrowingConversionsCheck>( 65 "cppcoreguidelines-narrowing-conversions"); 66 CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc"); 67 CheckFactories.registerCheck<misc::NonPrivateMemberVariablesInClassesCheck>( 68 "cppcoreguidelines-non-private-member-variables-in-classes"); 69 CheckFactories.registerCheck<OwningMemoryCheck>( 70 "cppcoreguidelines-owning-memory"); 71 CheckFactories.registerCheck<PreferMemberInitializerCheck>( 72 "cppcoreguidelines-prefer-member-initializer"); 73 CheckFactories.registerCheck<ProBoundsArrayToPointerDecayCheck>( 74 "cppcoreguidelines-pro-bounds-array-to-pointer-decay"); 75 CheckFactories.registerCheck<ProBoundsConstantArrayIndexCheck>( 76 "cppcoreguidelines-pro-bounds-constant-array-index"); 77 CheckFactories.registerCheck<ProBoundsPointerArithmeticCheck>( 78 "cppcoreguidelines-pro-bounds-pointer-arithmetic"); 79 CheckFactories.registerCheck<ProTypeConstCastCheck>( 80 "cppcoreguidelines-pro-type-const-cast"); 81 CheckFactories.registerCheck<ProTypeCstyleCastCheck>( 82 "cppcoreguidelines-pro-type-cstyle-cast"); 83 CheckFactories.registerCheck<ProTypeMemberInitCheck>( 84 "cppcoreguidelines-pro-type-member-init"); 85 CheckFactories.registerCheck<ProTypeReinterpretCastCheck>( 86 "cppcoreguidelines-pro-type-reinterpret-cast"); 87 CheckFactories.registerCheck<ProTypeStaticCastDowncastCheck>( 88 "cppcoreguidelines-pro-type-static-cast-downcast"); 89 CheckFactories.registerCheck<ProTypeUnionAccessCheck>( 90 "cppcoreguidelines-pro-type-union-access"); 91 CheckFactories.registerCheck<ProTypeVarargCheck>( 92 "cppcoreguidelines-pro-type-vararg"); 93 CheckFactories.registerCheck<SpecialMemberFunctionsCheck>( 94 "cppcoreguidelines-special-member-functions"); 95 CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing"); 96 CheckFactories.registerCheck<misc::UnconventionalAssignOperatorCheck>( 97 "cppcoreguidelines-c-copy-assignment-signature"); 98 CheckFactories.registerCheck<VirtualClassDestructorCheck>( 99 "cppcoreguidelines-virtual-class-destructor"); 100 } 101 102 ClangTidyOptions getModuleOptions() override { 103 ClangTidyOptions Options; 104 ClangTidyOptions::OptionMap &Opts = Options.CheckOptions; 105 106 Opts["cppcoreguidelines-non-private-member-variables-in-classes." 107 "IgnoreClassesWithAllMemberVariablesBeingPublic"] = "true"; 108 109 Opts["cppcoreguidelines-explicit-virtual-functions." 110 "IgnoreDestructors"] = "true"; 111 112 return Options; 113 } 114 }; 115 116 // Register the LLVMTidyModule using this statically initialized variable. 117 static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule> 118 X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines."); 119 120 } // namespace cppcoreguidelines 121 122 // This anchor is used to force the linker to link in the generated object file 123 // and thus register the CppCoreGuidelinesModule. 124 volatile int CppCoreGuidelinesModuleAnchorSource = 0; 125 126 } // namespace tidy 127 } // namespace clang 128