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

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

#include <UppercaseLiteralSuffixCheck.h>

Inheritance diagram for clang::tidy::readability::UppercaseLiteralSuffixCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::readability::UppercaseLiteralSuffixCheck:
Collaboration graph
[legend]

Public Member Functions

 UppercaseLiteralSuffixCheck (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...
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Should store all options supported by this check with their current values or default values for options that haven't been overridden. More...
 
template<typename LiteralType >
bool checkBoundMatch (const MatchFinder::MatchResult &Result)
 
- 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...
 

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

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

Alternatively, a list of destination suffixes can be provided.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/readability-uppercase-literal-suffix.html

Definition at line 25 of file UppercaseLiteralSuffixCheck.h.

Constructor & Destructor Documentation

◆ UppercaseLiteralSuffixCheck()

clang::tidy::readability::UppercaseLiteralSuffixCheck::UppercaseLiteralSuffixCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 181 of file UppercaseLiteralSuffixCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::readability::UppercaseLiteralSuffixCheck::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 232 of file UppercaseLiteralSuffixCheck.cpp.

◆ checkBoundMatch()

template<typename LiteralType >
bool clang::tidy::readability::UppercaseLiteralSuffixCheck::checkBoundMatch ( const MatchFinder::MatchResult &  Result)

Definition at line 209 of file UppercaseLiteralSuffixCheck.cpp.

◆ registerMatchers()

void clang::tidy::readability::UppercaseLiteralSuffixCheck::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 195 of file UppercaseLiteralSuffixCheck.cpp.

◆ storeOptions()

void clang::tidy::readability::UppercaseLiteralSuffixCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
overridevirtual

Should store all options supported by this check with their current values or default values for options that haven't been overridden.

The check should use Options.store() to store each option it supports whether it has the default value or it has been overridden.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 188 of file UppercaseLiteralSuffixCheck.cpp.


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