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::tidy::misc {
15 
16 /// This checker finds classes that not only contain the data
17 /// (non-static member variables), but also have logic (non-static member
18 /// functions), and diagnoses all member variables that have any other scope
19 /// other than `private`. They should be made `private`, and manipulated
20 /// exclusively via the member functions.
21 ///
22 /// Optionally, classes with all member variables being `public` could be
23 /// ignored and optionally all `public` member variables could be ignored.
24 ///
25 /// For the user-facing documentation see:
26 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/non-private-member-variables-in-classes.html
27 class NonPrivateMemberVariablesInClassesCheck : public ClangTidyCheck {
28 public:
29   NonPrivateMemberVariablesInClassesCheck(StringRef Name,
30                                           ClangTidyContext *Context);
isLanguageVersionSupported(const LangOptions & LangOpts)31   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
32     return LangOpts.CPlusPlus;
33   }
34   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
35   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
36   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
37 
38 private:
39   const bool IgnoreClassesWithAllMemberVariablesBeingPublic;
40   const bool IgnorePublicMemberVariables;
41 };
42 
43 } // namespace clang::tidy::misc
44 
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_NONPRIVATEMEMBERVARIABLESINCLASSESCHECK_H
46