clang-tools  11.0.0
CppCoreGuidelinesTidyModule.cpp
Go to the documentation of this file.
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"
19 #include "InitVariablesCheck.h"
21 #include "MacroUsageCheck.h"
23 #include "NoMallocCheck.h"
24 #include "OwningMemoryCheck.h"
28 #include "ProTypeConstCastCheck.h"
29 #include "ProTypeCstyleCastCheck.h"
30 #include "ProTypeMemberInitCheck.h"
34 #include "ProTypeVarargCheck.h"
35 #include "SlicingCheck.h"
37 
38 namespace clang {
39 namespace tidy {
40 namespace cppcoreguidelines {
41 
42 /// A module containing checks of the C++ Core Guidelines
44 public:
45  void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
47  "cppcoreguidelines-avoid-c-arrays");
48  CheckFactories.registerCheck<AvoidGotoCheck>(
49  "cppcoreguidelines-avoid-goto");
51  "cppcoreguidelines-avoid-magic-numbers");
53  "cppcoreguidelines-avoid-non-const-global-variables");
55  "cppcoreguidelines-explicit-virtual-functions");
56  CheckFactories.registerCheck<InitVariablesCheck>(
57  "cppcoreguidelines-init-variables");
59  "cppcoreguidelines-interfaces-global-init");
60  CheckFactories.registerCheck<MacroUsageCheck>(
61  "cppcoreguidelines-macro-usage");
63  "cppcoreguidelines-narrowing-conversions");
64  CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc");
66  "cppcoreguidelines-non-private-member-variables-in-classes");
67  CheckFactories.registerCheck<OwningMemoryCheck>(
68  "cppcoreguidelines-owning-memory");
70  "cppcoreguidelines-pro-bounds-array-to-pointer-decay");
72  "cppcoreguidelines-pro-bounds-constant-array-index");
74  "cppcoreguidelines-pro-bounds-pointer-arithmetic");
75  CheckFactories.registerCheck<ProTypeConstCastCheck>(
76  "cppcoreguidelines-pro-type-const-cast");
77  CheckFactories.registerCheck<ProTypeCstyleCastCheck>(
78  "cppcoreguidelines-pro-type-cstyle-cast");
79  CheckFactories.registerCheck<ProTypeMemberInitCheck>(
80  "cppcoreguidelines-pro-type-member-init");
82  "cppcoreguidelines-pro-type-reinterpret-cast");
84  "cppcoreguidelines-pro-type-static-cast-downcast");
85  CheckFactories.registerCheck<ProTypeUnionAccessCheck>(
86  "cppcoreguidelines-pro-type-union-access");
87  CheckFactories.registerCheck<ProTypeVarargCheck>(
88  "cppcoreguidelines-pro-type-vararg");
90  "cppcoreguidelines-special-member-functions");
91  CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing");
93  "cppcoreguidelines-c-copy-assignment-signature");
94  }
95 
97  ClangTidyOptions Options;
99 
100  Opts["cppcoreguidelines-non-private-member-variables-in-classes."
101  "IgnoreClassesWithAllMemberVariablesBeingPublic"] = "1";
102 
103  Opts["cppcoreguidelines-explicit-virtual-functions."
104  "IgnoreDestructors"] = "1";
105 
106  return Options;
107  }
108 };
109 
110 // Register the LLVMTidyModule using this statically initialized variable.
111 static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule>
112  X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines.");
113 
114 } // namespace cppcoreguidelines
115 
116 // This anchor is used to force the linker to link in the generated object file
117 // and thus register the CppCoreGuidelinesModule.
119 
120 } // namespace tidy
121 } // namespace clang
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule::addCheckFactories
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override
Implement this function in order to register all CheckFactories belonging to this module.
Definition: CppCoreGuidelinesTidyModule.cpp:45
SpecialMemberFunctionsCheck.h
AvoidNonConstGlobalVariablesCheck.h
InterfacesGlobalInitCheck.h
clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck
Checks for classes where some, but not all, of the special member functions are defined.
Definition: SpecialMemberFunctionsCheck.h:25
clang::tidy::cppcoreguidelines::InterfacesGlobalInitCheck
Flags possible initialization order issues of static variables.
Definition: InterfacesGlobalInitCheck.h:22
clang::tidy::cppcoreguidelines::ProTypeStaticCastDowncastCheck
Checks for usages of static_cast, where a base class is downcasted to a derived class.
Definition: ProTypeStaticCastDowncastCheck.h:23
ProTypeVarargCheck.h
clang::tidy::cppcoreguidelines::NoMallocCheck
This checker is concerned with C-style memory management and suggest modern alternatives to it.
Definition: NoMallocCheck.h:25
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule
A module containing checks of the C++ Core Guidelines.
Definition: CppCoreGuidelinesTidyModule.cpp:43
AvoidGotoCheck.h
clang::tidy::cppcoreguidelines::AvoidGotoCheck
The usage of goto for control flow is error prone and should be replaced with looping constructs.
Definition: AvoidGotoCheck.h:23
NarrowingConversionsCheck.h
ProTypeConstCastCheck.h
clang::tidy::cppcoreguidelines::X
static ClangTidyModuleRegistry::Add< CppCoreGuidelinesModule > X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines.")
InitVariablesCheck.h
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck
This checker finds classes that not only contain the data (non-static member variables),...
Definition: NonPrivateMemberVariablesInClassesCheck.h:29
clang::tidy::ClangTidyOptions::CheckOptions
OptionMap CheckOptions
Key-value mapping used to store check-specific options.
Definition: ClangTidyOptions.h:114
clang::tidy::cppcoreguidelines::CppCoreGuidelinesModule::getModuleOptions
ClangTidyOptions getModuleOptions() override
Gets default options for checks defined in this module.
Definition: CppCoreGuidelinesTidyModule.cpp:96
ProTypeUnionAccessCheck.h
clang::tidy::ClangTidyOptions
Contains options for clang-tidy.
Definition: ClangTidyOptions.h:50
clang::tidy::misc::UnconventionalAssignOperatorCheck
Finds declarations of assignment operators with the wrong return and/or argument types and definition...
Definition: UnconventionalAssignOperatorCheck.h:29
clang::tidy::ClangTidyCheckFactories
A collection of ClangTidyCheckFactory instances.
Definition: ClangTidyModule.h:30
ProBoundsArrayToPointerDecayCheck.h
clang::tidy::cppcoreguidelines::ProTypeReinterpretCastCheck
Flags all occurrences of reinterpret_cast.
Definition: ProTypeReinterpretCastCheck.h:22
clang::tidy::cppcoreguidelines::NarrowingConversionsCheck
Checks for narrowing conversions, e.g: int i = 0; i += 0.1;.
Definition: NarrowingConversionsCheck.h:24
ProTypeMemberInitCheck.h
clang::tidy::cppcoreguidelines::ProTypeMemberInitCheck
Implements C++ Core Guidelines Type.6.
Definition: ProTypeMemberInitCheck.h:33
clang::tidy::cppcoreguidelines::ProBoundsArrayToPointerDecayCheck
This check flags all array to pointer decays.
Definition: ProBoundsArrayToPointerDecayCheck.h:22
OwningMemoryCheck.h
clang::tidy::cppcoreguidelines::MacroUsageCheck
Find macro usage that is considered problematic because better language constructs exist for the task...
Definition: MacroUsageCheck.h:26
SlicingCheck.h
clang::tidy::CppCoreGuidelinesModuleAnchorSource
volatile int CppCoreGuidelinesModuleAnchorSource
Definition: CppCoreGuidelinesTidyModule.cpp:118
ProTypeReinterpretCastCheck.h
clang::tidy::cppcoreguidelines::InitVariablesCheck
Find uninitialized local variables.
Definition: InitVariablesCheck.h:24
clang::tidy::modernize::UseOverrideCheck
Use C++11's override and remove virtual where applicable.
Definition: UseOverrideCheck.h:19
ProBoundsPointerArithmeticCheck.h
clang::tidy::cppcoreguidelines::SlicingCheck
Flags slicing (incomplete copying of an object's state) of member variables or vtable.
Definition: SlicingCheck.h:27
ProTypeStaticCastDowncastCheck.h
clang::tidy::readability::MagicNumbersCheck
Detects magic numbers, integer and floating point literals embedded in code.
Definition: MagicNumbersCheck.h:25
clang::tidy::cppcoreguidelines::AvoidNonConstGlobalVariablesCheck
Non-const global variables hide dependencies and make the dependencies subject to unpredictable chang...
Definition: AvoidNonConstGlobalVariablesCheck.h:23
clang::tidy::cppcoreguidelines::ProTypeUnionAccessCheck
This check flags all access to members of unions.
Definition: ProTypeUnionAccessCheck.h:23
NoMallocCheck.h
ProTypeCstyleCastCheck.h
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::cppcoreguidelines::ProTypeVarargCheck
This check flags all calls to c-style variadic functions and all use of va_arg.
Definition: ProTypeVarargCheck.h:23
clang::tidy::cppcoreguidelines::ProBoundsPointerArithmeticCheck
Flags all kinds of pointer arithmetic that have result of pointer type, i.e.
Definition: ProBoundsPointerArithmeticCheck.h:24
ProBoundsConstantArrayIndexCheck.h
clang::tidy::cppcoreguidelines::ProTypeCstyleCastCheck
This check flags all use of C-style casts that perform a static_cast downcast, const_cast,...
Definition: ProTypeCstyleCastCheck.h:23
MacroUsageCheck.h
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck
This checks that all array subscriptions on static arrays and std::arrays have a constant index and a...
Definition: ProBoundsConstantArrayIndexCheck.h:24
clang::tidy::cppcoreguidelines::ProTypeConstCastCheck
This check flags all instances of const_cast.
Definition: ProTypeConstCastCheck.h:22
clang::tidy::ClangTidyModule
A clang-tidy module groups a number of ClangTidyChecks and gives them a prefixed name.
Definition: ClangTidyModule.h:83
clang::tidy::cppcoreguidelines::OwningMemoryCheck
Checks for common use cases for gsl::owner and enforces the unique owner nature of it whenever possib...
Definition: OwningMemoryCheck.h:23
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:111
clang::tidy::ClangTidyCheckFactories::registerCheck
void registerCheck(llvm::StringRef CheckName)
Registers the CheckType with the name Name.
Definition: ClangTidyModule.h:61
clang::tidy::modernize::AvoidCArraysCheck
Find C-style array types and recommend to use std::array<> / std::vector<>.
Definition: AvoidCArraysCheck.h:22