mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-20 20:15:49 -04:00
6cfa38f1f1
Summary: Finds classes that not only contain the data (non-static member variables), but also have logic (non-static member functions), and diagnoses all member variables that have any other scope other than `private`. They should be made `private`, and manipulated exclusively via the member functions. Optionally, classes with all member variables being `public` could be ignored, and optionally all `public` member variables could be ignored. Options ------- * IgnoreClassesWithAllMemberVariablesBeingPublic Allows to completely ignore classes if **all** the member variables in that class have `public` visibility. * IgnorePublicMemberVariables Allows to ignore (not diagnose) **all** the member variables with `public` visibility scope. References: * MISRA 11-0-1 Member data in non-POD class types shall be private. * https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#c2-use-class-if-the-class-has-an-invariant-use-struct-if-the-data-members-can-vary-independently * https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rc-private * https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rh-protected Reviewers: JonasToth, aaron.ballman, alexfh, hokein, xazax.hun Reviewed By: aaron.ballman Subscribers: Eugene.Zelenko, zinovy.nis, cfe-commits, rnkovacs, nemanjai, mgorny, xazax.hun, kbarton Tags: #clang-tools-extra Differential Revision: https://reviews.llvm.org/D52771 llvm-svn: 344757
105 lines
4.4 KiB
C++
105 lines
4.4 KiB
C++
//===--- CppCoreGuidelinesModule.cpp - clang-tidy -------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "../ClangTidy.h"
|
|
#include "../ClangTidyModule.h"
|
|
#include "../ClangTidyModuleRegistry.h"
|
|
#include "../misc/NonPrivateMemberVariablesInClassesCheck.h"
|
|
#include "../misc/UnconventionalAssignOperatorCheck.h"
|
|
#include "../readability/MagicNumbersCheck.h"
|
|
#include "AvoidGotoCheck.h"
|
|
#include "InterfacesGlobalInitCheck.h"
|
|
#include "NarrowingConversionsCheck.h"
|
|
#include "NoMallocCheck.h"
|
|
#include "OwningMemoryCheck.h"
|
|
#include "ProBoundsArrayToPointerDecayCheck.h"
|
|
#include "ProBoundsConstantArrayIndexCheck.h"
|
|
#include "ProBoundsPointerArithmeticCheck.h"
|
|
#include "ProTypeConstCastCheck.h"
|
|
#include "ProTypeCstyleCastCheck.h"
|
|
#include "ProTypeMemberInitCheck.h"
|
|
#include "ProTypeReinterpretCastCheck.h"
|
|
#include "ProTypeStaticCastDowncastCheck.h"
|
|
#include "ProTypeUnionAccessCheck.h"
|
|
#include "ProTypeVarargCheck.h"
|
|
#include "SlicingCheck.h"
|
|
#include "SpecialMemberFunctionsCheck.h"
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace cppcoreguidelines {
|
|
|
|
/// A module containing checks of the C++ Core Guidelines
|
|
class CppCoreGuidelinesModule : public ClangTidyModule {
|
|
public:
|
|
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
|
|
CheckFactories.registerCheck<AvoidGotoCheck>(
|
|
"cppcoreguidelines-avoid-goto");
|
|
CheckFactories.registerCheck<readability::MagicNumbersCheck>(
|
|
"cppcoreguidelines-avoid-magic-numbers");
|
|
CheckFactories.registerCheck<InterfacesGlobalInitCheck>(
|
|
"cppcoreguidelines-interfaces-global-init");
|
|
CheckFactories.registerCheck<NarrowingConversionsCheck>(
|
|
"cppcoreguidelines-narrowing-conversions");
|
|
CheckFactories.registerCheck<NoMallocCheck>("cppcoreguidelines-no-malloc");
|
|
CheckFactories.registerCheck<misc::NonPrivateMemberVariablesInClassesCheck>(
|
|
"cppcoreguidelines-non-private-member-variables-in-classes");
|
|
CheckFactories.registerCheck<OwningMemoryCheck>(
|
|
"cppcoreguidelines-owning-memory");
|
|
CheckFactories.registerCheck<ProBoundsArrayToPointerDecayCheck>(
|
|
"cppcoreguidelines-pro-bounds-array-to-pointer-decay");
|
|
CheckFactories.registerCheck<ProBoundsConstantArrayIndexCheck>(
|
|
"cppcoreguidelines-pro-bounds-constant-array-index");
|
|
CheckFactories.registerCheck<ProBoundsPointerArithmeticCheck>(
|
|
"cppcoreguidelines-pro-bounds-pointer-arithmetic");
|
|
CheckFactories.registerCheck<ProTypeConstCastCheck>(
|
|
"cppcoreguidelines-pro-type-const-cast");
|
|
CheckFactories.registerCheck<ProTypeCstyleCastCheck>(
|
|
"cppcoreguidelines-pro-type-cstyle-cast");
|
|
CheckFactories.registerCheck<ProTypeMemberInitCheck>(
|
|
"cppcoreguidelines-pro-type-member-init");
|
|
CheckFactories.registerCheck<ProTypeReinterpretCastCheck>(
|
|
"cppcoreguidelines-pro-type-reinterpret-cast");
|
|
CheckFactories.registerCheck<ProTypeStaticCastDowncastCheck>(
|
|
"cppcoreguidelines-pro-type-static-cast-downcast");
|
|
CheckFactories.registerCheck<ProTypeUnionAccessCheck>(
|
|
"cppcoreguidelines-pro-type-union-access");
|
|
CheckFactories.registerCheck<ProTypeVarargCheck>(
|
|
"cppcoreguidelines-pro-type-vararg");
|
|
CheckFactories.registerCheck<SpecialMemberFunctionsCheck>(
|
|
"cppcoreguidelines-special-member-functions");
|
|
CheckFactories.registerCheck<SlicingCheck>("cppcoreguidelines-slicing");
|
|
CheckFactories.registerCheck<misc::UnconventionalAssignOperatorCheck>(
|
|
"cppcoreguidelines-c-copy-assignment-signature");
|
|
}
|
|
|
|
ClangTidyOptions getModuleOptions() override {
|
|
ClangTidyOptions Options;
|
|
ClangTidyOptions::OptionMap &Opts = Options.CheckOptions;
|
|
|
|
Opts["cppcoreguidelines-non-private-member-variables-in-classes."
|
|
"IgnoreClassesWithAllMemberVariablesBeingPublic"] = "1";
|
|
|
|
return Options;
|
|
}
|
|
};
|
|
|
|
// Register the LLVMTidyModule using this statically initialized variable.
|
|
static ClangTidyModuleRegistry::Add<CppCoreGuidelinesModule>
|
|
X("cppcoreguidelines-module", "Adds checks for the C++ Core Guidelines.");
|
|
|
|
} // namespace cppcoreguidelines
|
|
|
|
// This anchor is used to force the linker to link in the generated object file
|
|
// and thus register the CppCoreGuidelinesModule.
|
|
volatile int CppCoreGuidelinesModuleAnchorSource = 0;
|
|
|
|
} // namespace tidy
|
|
} // namespace clang
|