clang-tools  10.0.0svn
Public Member Functions | List of all members
clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck Class Reference

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. More...

#include <NonPrivateMemberVariablesInClassesCheck.h>

Inheritance diagram for clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck:
Collaboration graph
[legend]

Public Member Functions

 NonPrivateMemberVariablesInClassesCheck (StringRef Name, ClangTidyContext *Context)
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP)
 Override this to register PPCallbacks in the preprocessor. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
virtual void storeOptions (ClangTidyOptions::OptionMap &Options)
 Should store all options supported by this check with their current values or default values for options that haven't been overridden. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
const LangOptions & getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

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.

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.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/misc-non-private-member-variables-in-classes.html

Definition at line 29 of file NonPrivateMemberVariablesInClassesCheck.h.

Constructor & Destructor Documentation

◆ NonPrivateMemberVariablesInClassesCheck()

clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::NonPrivateMemberVariablesInClassesCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 43 of file NonPrivateMemberVariablesInClassesCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 80 of file NonPrivateMemberVariablesInClassesCheck.cpp.

◆ registerMatchers()

void clang::tidy::misc::NonPrivateMemberVariablesInClassesCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
overridevirtual

Override this to register AST matchers with Finder.

This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.

You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.

If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 51 of file NonPrivateMemberVariablesInClassesCheck.cpp.


The documentation for this class was generated from the following files: