clang::tidy::bugprone::SuspiciousIncludeCheck Class Reference

Warns on inclusion of files whose names suggest that they're implementation files, instead of headers. More...

#include <SuspiciousIncludeCheck.h>

Inheritance diagram for clang::tidy::bugprone::SuspiciousIncludeCheck:

Public Member Functions
	SuspiciousIncludeCheck (StringRef Name, ClangTidyContext *Context)
void	registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
void	storeOptions (ClangTidyOptions::OptionMap &Opts) override

Public Attributes
FileExtensionsSet	HeaderFileExtensions
FileExtensionsSet	ImplementationFileExtensions
StringRef	IgnoredRegexString
llvm::Regex	IgnoredRegex

Detailed Description

Warns on inclusion of files whose names suggest that they're implementation files, instead of headers.

E.g:

#include "foo.cpp"  // warning
#include "bar.c"    // warning
#include "baz.h"    // no diagnostic

For the user-facing documentation see: https://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-include.html

Definition at line 25 of file SuspiciousIncludeCheck.h.

Constructor & Destructor Documentation

SuspiciousIncludeCheck()

clang::tidy::bugprone::SuspiciousIncludeCheck::SuspiciousIncludeCheck	(	StringRef	Name,
		ClangTidyContext *	Context )

Definition at line 39 of file SuspiciousIncludeCheck.cpp.

References HeaderFileExtensions, IgnoredRegex, IgnoredRegexString, and ImplementationFileExtensions.

Member Function Documentation

registerPPCallbacks()

void clang::tidy::bugprone::SuspiciousIncludeCheck::registerPPCallbacks ( const SourceManager & SM, Preprocessor * PP, Preprocessor * ModuleExpanderPP )

override

Definition at line 47 of file SuspiciousIncludeCheck.cpp.

References clang::tidy::bugprone::PP.

storeOptions()

void clang::tidy::bugprone::SuspiciousIncludeCheck::storeOptions ( ClangTidyOptions::OptionMap & Opts )

override

Definition at line 53 of file SuspiciousIncludeCheck.cpp.

References IgnoredRegexString.

Member Data Documentation

HeaderFileExtensions

FileExtensionsSet clang::tidy::bugprone::SuspiciousIncludeCheck::HeaderFileExtensions

Definition at line 32 of file SuspiciousIncludeCheck.h.

Referenced by SuspiciousIncludeCheck().

IgnoredRegex

llvm::Regex clang::tidy::bugprone::SuspiciousIncludeCheck::IgnoredRegex

Definition at line 35 of file SuspiciousIncludeCheck.h.

Referenced by SuspiciousIncludeCheck().

IgnoredRegexString

StringRef clang::tidy::bugprone::SuspiciousIncludeCheck::IgnoredRegexString

Definition at line 34 of file SuspiciousIncludeCheck.h.

Referenced by storeOptions(), and SuspiciousIncludeCheck().

ImplementationFileExtensions

FileExtensionsSet clang::tidy::bugprone::SuspiciousIncludeCheck::ImplementationFileExtensions

Definition at line 33 of file SuspiciousIncludeCheck.h.

Referenced by SuspiciousIncludeCheck().

---

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

• SuspiciousIncludeCheck.h
• SuspiciousIncludeCheck.cpp