clang-tools
15.0.0git
llvm-project
clang-tools-extra
clang-tidy
misc
NonPrivateMemberVariablesInClassesCheck.h
Go to the documentation of this file.
1
//===--- NonPrivateMemberVariablesInClassesCheck.h - clang-tidy -*- C++ -*-===//
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
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NONPRIVATEMEMBERVARIABLESINCLASSESCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NONPRIVATEMEMBERVARIABLESINCLASSESCHECK_H
11
12
#include "../ClangTidyCheck.h"
13
14
namespace
clang
{
15
namespace
tidy {
16
namespace
misc {
17
18
/// This checker finds classes that not only contain the data
19
/// (non-static member variables), but also have logic (non-static member
20
/// functions), and diagnoses all member variables that have any other scope
21
/// other than `private`. They should be made `private`, and manipulated
22
/// exclusively via the member functions.
23
///
24
/// Optionally, classes with all member variables being `public` could be
25
/// ignored and optionally all `public` member variables could be ignored.
26
///
27
/// For the user-facing documentation see:
28
/// http://clang.llvm.org/extra/clang-tidy/checks/misc-non-private-member-variables-in-classes.html
29
class
NonPrivateMemberVariablesInClassesCheck
:
public
ClangTidyCheck
{
30
public
:
31
NonPrivateMemberVariablesInClassesCheck
(StringRef
Name
,
32
ClangTidyContext
*Context);
33
bool
isLanguageVersionSupported
(
const
LangOptions &
LangOpts
)
const override
{
34
return
LangOpts
.CPlusPlus;
35
}
36
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
37
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
38
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
39
40
private
:
41
const
bool
IgnoreClassesWithAllMemberVariablesBeingPublic;
42
const
bool
IgnorePublicMemberVariables;
43
};
44
45
}
// namespace misc
46
}
// namespace tidy
47
}
// namespace clang
48
49
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NONPRIVATEMEMBERVARIABLESINCLASSESCHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck
This checker finds classes that not only contain the data (non-static member variables),...
Definition:
NonPrivateMemberVariablesInClassesCheck.h:29
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:59
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:66
Name
Token Name
Definition:
MacroToEnumCheck.cpp:89
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:86
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:51
LangOpts
const LangOptions * LangOpts
Definition:
ExtractFunction.cpp:366
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition:
NonPrivateMemberVariablesInClassesCheck.h:33
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::NonPrivateMemberVariablesInClassesCheck
NonPrivateMemberVariablesInClassesCheck(StringRef Name, ClangTidyContext *Context)
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:43
Generated on Tue May 17 2022 03:42:04 for clang-tools by
1.8.17