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 "AvoidCaptureDefaultWhenCapturingThisCheck.h" 18 #include "AvoidCapturingLambdaCoroutinesCheck.h" 19 #include "AvoidConstOrRefDataMembersCheck.h" 20 #include "AvoidDoWhileCheck.h" 21 #include "AvoidGotoCheck.h" 22 #include "AvoidNonConstGlobalVariablesCheck.h" 23 #include "AvoidReferenceCoroutineParametersCheck.h" 24 #include "InitVariablesCheck.h" 25 #include "InterfacesGlobalInitCheck.h" 26 #include "MacroUsageCheck.h" 27 #include "NarrowingConversionsCheck.h" 28 #include "NoMallocCheck.h" 29 #include "OwningMemoryCheck.h" 30 #include "PreferMemberInitializerCheck.h" 31 #include "ProBoundsArrayToPointerDecayCheck.h" 32 #include "ProBoundsConstantArrayIndexCheck.h" 33 #include "ProBoundsPointerArithmeticCheck.h" 34 #include "ProTypeConstCastCheck.h" 35 #include "ProTypeCstyleCastCheck.h" 36 #include "ProTypeMemberInitCheck.h" 37 #include "ProTypeReinterpretCastCheck.h" 38 #include "ProTypeStaticCastDowncastCheck.h" 39 #include "ProTypeUnionAccessCheck.h" 40 #include "ProTypeVarargCheck.h" 41 #include "SlicingCheck.h" 42 #include "SpecialMemberFunctionsCheck.h" 43 #include "VirtualClassDestructorCheck.h" 44 45 namespace clang::tidy { 46 namespace cppcoreguidelines { 47 48 /// A module containing checks of the C++ Core Guidelines 49 class CppCoreGuidelinesModule : public ClangTidyModule { 50 public: 51 void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { 52 CheckFactories.registerCheck<AvoidCaptureDefaultWhenCapturingThisCheck>( 53 "cppcoreguidelines-avoid-capture-default-when-capturing-this"); 54 CheckFactories.registerCheck<AvoidCapturingLambdaCoroutinesCheck>( 55 "cppcoreguidelines-avoid-capturing-lambda-coroutines"); 56 CheckFactories.registerCheck<modernize::AvoidCArraysCheck>( 57 "cppcoreguidelines-avoid-c-arrays"); 58 CheckFactories.registerCheck<AvoidConstOrRefDataMembersCheck>( 59 "cppcoreguidelines-avoid-const-or-ref-data-members"); 60 CheckFactories.registerCheck<AvoidDoWhileCheck>( 61 "cppcoreguidelines-avoid-do-while"); 62 CheckFactories.registerCheck<AvoidGotoCheck>( 63 "cppcoreguidelines-avoid-goto"); 64 CheckFactories.registerCheck<readability::MagicNumbersCheck>( 65 "cppcoreguidelines-avoid-magic-numbers"); 66 CheckFactories.registerCheck<AvoidNonConstGlobalVariablesCheck>( 67 "cppcoreguidelines-avoid-non-const-global-variables"); 68 CheckFactories.registerCheck<AvoidReferenceCoroutineParametersCheck>( 69 "cppcoreguidelines-avoid-reference-coroutine-parameters"); 70 CheckFactories.registerCheck<modernize::UseOverrideCheck>( 71 "cppcoreguidelines-explicit-virtual-functions"); 72 CheckFactories.registerCheck<InitVariablesCheck>( 73 "cppcoreguidelines-init-variables"); 74 CheckFactories.registerCheck<InterfacesGlobalInitCheck>( 75 "cppcoreguidelines-interfaces-global-init"); 76 CheckFactories.registerCheck<MacroUsageCheck>( 77 "cppcoreguidelines-macro-usage"); 78 CheckFactories.registerCheck<NarrowingConversionsCheck>( 79 "cppcoreguidelines-narrowing-conversions"); 80 CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc"); 81 CheckFactories.registerCheck<misc::NonPrivateMemberVariablesInClassesCheck>( 82 "cppcoreguidelines-non-private-member-variables-in-classes"); 83 CheckFactories.registerCheck<OwningMemoryCheck>( 84 "cppcoreguidelines-owning-memory"); 85 CheckFactories.registerCheck<PreferMemberInitializerCheck>( 86 "cppcoreguidelines-prefer-member-initializer"); 87 CheckFactories.registerCheck<ProBoundsArrayToPointerDecayCheck>( 88 "cppcoreguidelines-pro-bounds-array-to-pointer-decay"); 89 CheckFactories.registerCheck<ProBoundsConstantArrayIndexCheck>( 90 "cppcoreguidelines-pro-bounds-constant-array-index"); 91 CheckFactories.registerCheck<ProBoundsPointerArithmeticCheck>( 92 "cppcoreguidelines-pro-bounds-pointer-arithmetic"); 93 CheckFactories.registerCheck<ProTypeConstCastCheck>( 94 "cppcoreguidelines-pro-type-const-cast"); 95 CheckFactories.registerCheck<ProTypeCstyleCastCheck>( 96 "cppcoreguidelines-pro-type-cstyle-cast"); 97 CheckFactories.registerCheck<ProTypeMemberInitCheck>( 98 "cppcoreguidelines-pro-type-member-init"); 99 CheckFactories.registerCheck<ProTypeReinterpretCastCheck>( 100 "cppcoreguidelines-pro-type-reinterpret-cast"); 101 CheckFactories.registerCheck<ProTypeStaticCastDowncastCheck>( 102 "cppcoreguidelines-pro-type-static-cast-downcast"); 103 CheckFactories.registerCheck<ProTypeUnionAccessCheck>( 104 "cppcoreguidelines-pro-type-union-access"); 105 CheckFactories.registerCheck<ProTypeVarargCheck>( 106 "cppcoreguidelines-pro-type-vararg"); 107 CheckFactories.registerCheck<SpecialMemberFunctionsCheck>( 108 "cppcoreguidelines-special-member-functions"); 109 CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing"); 110 CheckFactories.registerCheck<misc::UnconventionalAssignOperatorCheck>( 111 "cppcoreguidelines-c-copy-assignment-signature"); 112 CheckFactories.registerCheck<VirtualClassDestructorCheck>( 113 "cppcoreguidelines-virtual-class-destructor"); 114 } 115 116 ClangTidyOptions getModuleOptions() override { 117 ClangTidyOptions Options; 118 ClangTidyOptions::OptionMap &Opts = Options.CheckOptions; 119 120 Opts["cppcoreguidelines-non-private-member-variables-in-classes." 121 "IgnoreClassesWithAllMemberVariablesBeingPublic"] = "true"; 122 123 return Options; 124 } 125 }; 126 127 // Register the LLVMTidyModule using this statically initialized variable. 128 static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule> 129 X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines."); 130 131 } // namespace cppcoreguidelines 132 133 // This anchor is used to force the linker to link in the generated object file 134 // and thus register the CppCoreGuidelinesModule. 135 volatile int CppCoreGuidelinesModuleAnchorSource = 0; 136 137 } // namespace clang::tidy 138