clang-tools
9.0.0
llvm.src
tools
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
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
34
void
check
(
const
ast_matchers::MatchFinder::MatchResult &
Result
)
override
;
35
36
private
:
37
const
bool
IgnoreClassesWithAllMemberVariablesBeingPublic;
38
const
bool
IgnorePublicMemberVariables;
39
};
40
41
}
// namespace misc
42
}
// namespace tidy
43
}
// namespace clang
44
45
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NONPRIVATEMEMBERVARIABLESINCLASSESCHECK_H
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:80
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck
This checker 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.
Definition:
NonPrivateMemberVariablesInClassesCheck.h:29
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:47
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::NonPrivateMemberVariablesInClassesCheck
NonPrivateMemberVariablesInClassesCheck(StringRef Name, ClangTidyContext *Context)
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:43
Name
static constexpr llvm::StringLiteral Name
Definition:
UppercaseLiteralSuffixCheck.cpp:27
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:99
Result
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
Definition:
Rename.cpp:36
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
NonPrivateMemberVariablesInClassesCheck.cpp:51
Generated on Thu Sep 19 2019 15:17:53 for clang-tools by
1.8.13