Classes
class	AvoidConstParamsInDecls

class	BracesAroundStatementsCheck
	Checks that bodies of `if` statements and loops (`for`, `range-for`, `do-while`, and `while`) are inside braces. More...

class	ConstReturnTypeCheck
	For any function whose return type is const-qualified, suggests removal of the `const` qualifier from that return type. More...

class	ContainerSizeEmptyCheck
	Checks whether a call to the `size()` method can be replaced with a call to `empty()`. More...

class	DeletedDefaultCheck
	Checks when a constructor or an assignment operator is marked as '= default' but is actually deleted by the compiler. More...

class	DeleteNullPointerCheck
	Check whether the 'if' statement is unnecessary before calling 'delete' on a pointer. More...

class	ElseAfterReturnCheck
	Flags the usages of `else` after `return`. More...

class	FunctionSizeCheck
	Checks for large functions based on various metrics. More...

class	IdentifierNamingCheck
	Checks for identifiers naming style mismatch. More...

class	ImplicitBoolConversionCheck
	Checks for use of implicit bool conversions in expressions. More...

class	InconsistentDeclarationParameterNameCheck
	Checks for declarations of functions which differ in parameter names. More...

class	IsolateDeclarationCheck
	This check diagnoses all DeclStmt's declaring more than one variable and tries to refactor the code to one statement per declaration. More...

class	MagicNumbersCheck
	Detects magic numbers, integer and floating point literals embedded in code. More...

class	MisleadingIndentationCheck
	Checks the code for dangling else, and possible misleading indentations due to missing braces. More...

class	MisplacedArrayIndexCheck
	Warn about unusual array index syntax (`index[array]` instead of `array[index]`). More...

class	NamedParameterCheck
	Find functions with unnamed arguments. More...

class	NamespaceCommentCheck
	Checks that long namespaces have a closing comment. More...

class	NonConstParameterCheck
	Warn when a pointer function parameter can be const. More...

class	ReadabilityModule

class	RedundantControlFlowCheck
	Eliminates redundant `return` statements at the end of a function that returns `void`. More...

class	RedundantDeclarationCheck
	Find redundant variable declarations. More...

class	RedundantFunctionPtrDereferenceCheck
	Eliminate redundant dereferences of a function pointer. More...

class	RedundantMemberInitCheck
	Finds member initializations that are unnecessary because the same default constructor would be called if they were not present. More...

class	RedundantPreprocessorCheck
	This check flags redundant preprocessor directives: nested directives with the same condition. More...

class	RedundantSmartptrGetCheck
	Find and remove redundant calls to smart pointer's `.get()` method. More...

class	RedundantStringCStrCheck
	Finds unnecessary calls to `std::string::c_str()`. More...

class	RedundantStringInitCheck
	Finds unnecessary string initializations. More...

class	SimplifyBooleanExprCheck
	Looks for boolean expressions involving boolean constants and simplifies them to use the appropriate boolean expression directly. More...

class	SimplifySubscriptExprCheck
	Simplifies subscript expressions. More...

class	StaticAccessedThroughInstanceCheck
	@brief Checks for member expressions that access static members through instances and replaces them with uses of the appropriate qualified-id. More...

class	StaticDefinitionInAnonymousNamespaceCheck
	Finds static function and variable definitions in anonymous namespace. More...

class	StringCompareCheck
	This check flags all calls compare when used to check for string equality or inequality. More...

class	UniqueptrDeleteReleaseCheck
	Flags statements of the form `delete <unique_ptr expr>.release();` and replaces them with: `<unique_ptr expr> = nullptr;` More...

class	UppercaseLiteralSuffixCheck
	Detects when the integral literal or floating point literal has non-uppercase suffix, and suggests to make the suffix uppercase. More...

Enumerations
enum	StyleKind { SK_Count, SK_Invalid }

Functions
static llvm::Optional< Token >	ConstTok (CharSourceRange Range, const MatchFinder::MatchResult &Result)

static llvm::Optional< Token >	findConstToRemove (const FunctionDecl *Def, const MatchFinder::MatchResult &Result)

static CheckResult	checkDef (const clang::FunctionDecl *Def, const MatchFinder::MatchResult &MatchResult)

static bool	matchesStyle (StringRef Name, IdentifierNamingCheck::NamingStyle Style)

static std::string	fixupWithCase (StringRef Name, IdentifierNamingCheck::CaseType Case)

static std::string	fixupWithStyle (StringRef Name, const IdentifierNamingCheck::NamingStyle &Style)

static StyleKind	findStyleKind (const NamedDecl *D, const std::vector< llvm::Optional< IdentifierNamingCheck::NamingStyle >> &NamingStyles)

static void	addUsage (IdentifierNamingCheck::NamingCheckFailureMap &Failures, const IdentifierNamingCheck::NamingCheckId &Decl, SourceRange Range, SourceManager *SourceMgr=nullptr)

static void	addUsage (IdentifierNamingCheck::NamingCheckFailureMap &Failures, const NamedDecl Decl, SourceRange Range, SourceManager SourceMgr=nullptr)
	Convenience method when the usage to be added is a NamedDecl. More...

static SourceLocation	findStartOfIndirection (SourceLocation Start, int Indirections, const SourceManager &SM, const LangOptions &LangOpts)

static bool	isMacroID (SourceRange R)

static int	countIndirections (const Type *T, int Indirections=0)
	This function counts the number of written indirections for the given Type `T`. More...

static bool	typeIsMemberPointer (const Type *T)

static Optional< std::vector< SourceRange > >	declRanges (const DeclStmt *DS, const SourceManager &SM, const LangOptions &LangOpts)
	This function tries to extract the SourceRanges that make up all declarations in this `DeclStmt`. More...

static Optional< std::vector< StringRef > >	collectSourceRanges (llvm::ArrayRef< SourceRange > Ranges, const SourceManager &SM, const LangOptions &LangOpts)

static std::vector< std::string >	createIsolatedDecls (llvm::ArrayRef< StringRef > Snippets)
	Expects a vector {TypeSnippet, Firstdecl, SecondDecl, ...}. More...

static const IfStmt *	getPrecedingIf (const SourceManager &SM, ASTContext Context, const IfStmt If)

static bool	locationsInSameFile (const SourceManager &Sources, SourceLocation Loc1, SourceLocation Loc2)

static std::string	getNamespaceComment (const NamespaceDecl *ND, bool InsertLineBreak)

static std::string	getNamespaceComment (const std::string &NameSpaceName, bool InsertLineBreak)

static ClangTidyModuleRegistry::Add< ReadabilityModule >	X ("readability-module", "Adds readability-related checks.")

	AST_MATCHER (FunctionDecl, doesDeclarationForceExternallyVisibleDefinition)

bool	containsBoolLiteral (const Expr *E)

static unsigned	getNameSpecifierNestingLevel (const QualType &QType)

Variables
static StringRef const	StyleNames []

const char	DefaultIgnoredIntegerValues [] = "1;2;3;4;"

const char	DefaultIgnoredFloatingPointValues [] = "1.0;100.0;"

static const char	kDefaultTypes []

static const StringRef	CompareMessage

Enumeration Type Documentation

◆ StyleKind

enum clang::tidy::readability::StyleKind

Enumerator
SK_Count
SK_Invalid

Definition at line 120 of file IdentifierNamingCheck.cpp.

Function Documentation

◆ addUsage() [1/2]

static void clang::tidy::readability::addUsage	(	IdentifierNamingCheck::NamingCheckFailureMap &	Failures,
		const IdentifierNamingCheck::NamingCheckId &	Decl,
		SourceRange	Range,
		SourceManager *	SourceMgr = `nullptr`
	)

static

Definition at line 659 of file IdentifierNamingCheck.cpp.

Referenced by clang::tidy::readability::IdentifierNamingCheck::check(), and clang::tidy::modernize::ForLoopIndexUseVisitor::getUsages().

◆ addUsage() [2/2]

static void clang::tidy::readability::addUsage	(	IdentifierNamingCheck::NamingCheckFailureMap &	Failures,
		const NamedDecl *	Decl,
		SourceRange	Range,
		SourceManager *	SourceMgr = `nullptr`
	)

static

Convenience method when the usage to be added is a NamedDecl.

Definition at line 689 of file IdentifierNamingCheck.cpp.

◆ AST_MATCHER()

clang::tidy::readability::AST_MATCHER	(	FunctionDecl	,
		doesDeclarationForceExternallyVisibleDefinition
	)

Definition at line 20 of file RedundantDeclarationCheck.cpp.

◆ checkDef()

static CheckResult clang::tidy::readability::checkDef	(	const clang::FunctionDecl *	Def,
		const MatchFinder::MatchResult &	MatchResult
	)

static

Definition at line 70 of file ConstReturnTypeCheck.cpp.

References Result.

Referenced by clang::tidy::readability::ConstReturnTypeCheck::check().

◆ collectSourceRanges()

static Optional<std::vector<StringRef> > clang::tidy::readability::collectSourceRanges	(	llvm::ArrayRef< SourceRange >	Ranges,
		const SourceManager &	SM,
		const LangOptions &	LangOpts
	)

static

Definition at line 204 of file IsolateDeclarationCheck.cpp.

Referenced by clang::tidy::readability::IsolateDeclarationCheck::check().

◆ ConstTok()

static llvm::Optional<Token> clang::tidy::readability::ConstTok	(	CharSourceRange	Range,
		const MatchFinder::MatchResult &	Result
	)

static

Definition at line 50 of file AvoidConstParamsInDecls.cpp.

◆ containsBoolLiteral()

bool clang::tidy::readability::containsBoolLiteral ( const Expr * E )

Definition at line 344 of file SimplifyBooleanExprCheck.cpp.

References Range, and Result.

◆ countIndirections()

static int clang::tidy::readability::countIndirections	(	const Type *	T,
		int	Indirections = `0`
	)

static

This function counts the number of written indirections for the given Type T.

It does NOT resolve typedefs as it's a helper for lexing the source code.

See also: declRanges

Definition at line 60 of file IsolateDeclarationCheck.cpp.

◆ createIsolatedDecls()

static std::vector<std::string> clang::tidy::readability::createIsolatedDecls ( llvm::ArrayRef< StringRef > Snippets )

static

Expects a vector {TypeSnippet, Firstdecl, SecondDecl, ...}.

Definition at line 232 of file IsolateDeclarationCheck.cpp.

Referenced by clang::tidy::readability::IsolateDeclarationCheck::check().

◆ declRanges()

static Optional<std::vector<SourceRange> > clang::tidy::readability::declRanges	(	const DeclStmt *	DS,
		const SourceManager &	SM,
		const LangOptions &	LangOpts
	)

static

This function tries to extract the SourceRanges that make up all declarations in this DeclStmt.

The resulting vector has the structure {UnderlyingType, Decl1, Decl2, ...}. Each SourceRange is of the form [Begin, End). If any of the create ranges is invalid or in a macro the result will be None. If the DeclStmt contains only one declaration, the result is None. If the DeclStmt contains declarations other than VarDecl the result is None.

int * ptr1 = nullptr, value = 42;

// [ ][ ] [ ] - The ranges here are inclusive

Todo:: Generalize this function to take other declarations than VarDecl.

Definition at line 109 of file IsolateDeclarationCheck.cpp.

Referenced by clang::tidy::readability::IsolateDeclarationCheck::check().

◆ findConstToRemove()

static llvm::Optional<Token> clang::tidy::readability::findConstToRemove	(	const FunctionDecl *	Def,
		const MatchFinder::MatchResult &	Result
	)

static

Definition at line 28 of file ConstReturnTypeCheck.cpp.

References clang::tidy::utils::lexer::getConstQualifyingToken().

◆ findStartOfIndirection()

static SourceLocation clang::tidy::readability::findStartOfIndirection	(	SourceLocation	Start,
		int	Indirections,
		const SourceManager &	SM,
		const LangOptions &	LangOpts
	)

static

Definition at line 34 of file IsolateDeclarationCheck.cpp.

◆ findStyleKind()

static StyleKind clang::tidy::readability::findStyleKind	(	const NamedDecl *	D,
		const std::vector< llvm::Optional< IdentifierNamingCheck::NamingStyle >> &	NamingStyles
	)

static

Definition at line 391 of file IdentifierNamingCheck.cpp.

References SK_Invalid.

Referenced by clang::tidy::readability::IdentifierNamingCheck::check().

◆ fixupWithCase()

static std::string clang::tidy::readability::fixupWithCase	(	StringRef	Name,
		IdentifierNamingCheck::CaseType	Case
	)

static

Definition at line 284 of file IdentifierNamingCheck.cpp.

References clang::tidy::readability::IdentifierNamingCheck::CT_AnyCase, clang::tidy::readability::IdentifierNamingCheck::CT_CamelBack, clang::tidy::readability::IdentifierNamingCheck::CT_CamelCase, clang::tidy::readability::IdentifierNamingCheck::CT_CamelSnakeBack, clang::tidy::readability::IdentifierNamingCheck::CT_CamelSnakeCase, clang::tidy::readability::IdentifierNamingCheck::CT_LowerCase, clang::tidy::readability::IdentifierNamingCheck::CT_UpperCase, Name, and Word.

◆ fixupWithStyle()

static std::string clang::tidy::readability::fixupWithStyle	(	StringRef	Name,
		const IdentifierNamingCheck::NamingStyle &	Style
	)

static

Definition at line 381 of file IdentifierNamingCheck.cpp.

◆ getNamespaceComment() [1/2]

static std::string clang::tidy::readability::getNamespaceComment	(	const NamespaceDecl *	ND,
		bool	InsertLineBreak
	)

static

Definition at line 48 of file NamespaceCommentCheck.cpp.

References Fix().

◆ getNamespaceComment() [2/2]

static std::string clang::tidy::readability::getNamespaceComment	(	const std::string &	NameSpaceName,
		bool	InsertLineBreak
	)

static

Definition at line 58 of file NamespaceCommentCheck.cpp.

References Fix().

◆ getNameSpecifierNestingLevel()

static unsigned clang::tidy::readability::getNameSpecifierNestingLevel ( const QualType & QType )

static

Definition at line 19 of file StaticAccessedThroughInstanceCheck.cpp.

Referenced by clang::tidy::readability::StaticAccessedThroughInstanceCheck::check().

◆ getPrecedingIf()

static const IfStmt* clang::tidy::readability::getPrecedingIf	(	const SourceManager &	SM,
		ASTContext *	Context,
		const IfStmt *	If
	)

static

Definition at line 19 of file MisleadingIndentationCheck.cpp.

◆ isMacroID()

static bool clang::tidy::readability::isMacroID ( SourceRange R )

static

Definition at line 52 of file IsolateDeclarationCheck.cpp.

◆ locationsInSameFile()

static bool clang::tidy::readability::locationsInSameFile	(	const SourceManager &	Sources,
		SourceLocation	Loc1,
		SourceLocation	Loc2
	)

static

Definition at line 42 of file NamespaceCommentCheck.cpp.

Referenced by clang::tidy::readability::NamespaceCommentCheck::check().

◆ matchesStyle()

static bool clang::tidy::readability::matchesStyle	(	StringRef	Name,
		IdentifierNamingCheck::NamingStyle	Style
	)

static

Definition at line 250 of file IdentifierNamingCheck.cpp.

◆ typeIsMemberPointer()

static bool clang::tidy::readability::typeIsMemberPointer ( const Type * T )

static

Definition at line 81 of file IsolateDeclarationCheck.cpp.

◆ X()

static ClangTidyModuleRegistry::Add<ReadabilityModule> clang::tidy::readability::X	(	"readability-module"	,
		"Adds readability-related checks."
	)

static

Referenced by clang::tidy::readability::ReadabilityModule::addCheckFactories().

Variable Documentation

◆ CompareMessage

const StringRef clang::tidy::readability::CompareMessage

static

Initial value:

= "do not use 'compare' to test equality "
                                        "of strings; use the string equality "
                                        "operator instead"

Definition at line 21 of file StringCompareCheck.cpp.

Referenced by clang::tidy::readability::StringCompareCheck::check().

◆ DefaultIgnoredFloatingPointValues

const char clang::tidy::readability::DefaultIgnoredFloatingPointValues[] = "1.0;100.0;"

Definition at line 53 of file MagicNumbersCheck.cpp.

◆ DefaultIgnoredIntegerValues

const char clang::tidy::readability::DefaultIgnoredIntegerValues[] = "1;2;3;4;"

Definition at line 52 of file MagicNumbersCheck.cpp.

◆ kDefaultTypes

const char clang::tidy::readability::kDefaultTypes[]

static

Initial value:

=

"::std::basic_string;::std::basic_string_view;::std::vector;::std::array"

Definition at line 20 of file SimplifySubscriptExprCheck.cpp.

◆ StyleNames

StringRef const clang::tidy::readability::StyleNames[]

static

Initial value:

= {
#define STRINGIZE(v) 
}

Definition at line 128 of file IdentifierNamingCheck.cpp.

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ StyleKind

Function Documentation

◆ addUsage() [1/2]

◆ addUsage() [2/2]

◆ AST_MATCHER()

◆ checkDef()

◆ collectSourceRanges()

◆ ConstTok()

◆ containsBoolLiteral()

◆ countIndirections()

◆ createIsolatedDecls()

◆ declRanges()

◆ findConstToRemove()

◆ findStartOfIndirection()

◆ findStyleKind()

◆ fixupWithCase()

◆ fixupWithStyle()

◆ getNamespaceComment() [1/2]

◆ getNamespaceComment() [2/2]

◆ getNameSpecifierNestingLevel()

◆ getPrecedingIf()

◆ isMacroID()

◆ locationsInSameFile()

◆ matchesStyle()

◆ typeIsMemberPointer()

◆ X()

Variable Documentation

◆ CompareMessage

◆ DefaultIgnoredFloatingPointValues

◆ DefaultIgnoredIntegerValues

◆ kDefaultTypes

◆ StyleNames