clang-tools 8.0.0

UppercaseLiteralSuffixCheck.h
Go to the documentation of this file.
1 //===--- UppercaseLiteralSuffixCheck.h - clang-tidy -------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
12
13 #include "../ClangTidy.h"
14 #include "../utils/OptionsUtils.h"
15
16 namespace clang {
17 namespace tidy {
18 namespace readability {
19
20 /// Detects when the integral literal or floating point literal has
21 /// non-uppercase suffix, and suggests to make the suffix uppercase.
22 /// Alternatively, a list of destination suffixes can be provided.
23 ///
24 /// For the user-facing documentation see:
25 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-uppercase-literal-suffix.html
26 class UppercaseLiteralSuffixCheck : public ClangTidyCheck {
27 public:
28 UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context);
29 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
32
33 private:
34 template <typename LiteralType>
35 bool checkBoundMatch(const ast_matchers::MatchFinder::MatchResult &Result);
36
37 const std::vector<std::string> NewSuffixes;
38 const bool IgnoreMacros;
39 };
40
41 } // namespace readability
42 } // namespace tidy
43 } // namespace clang
44
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
clang::tidy::readability::UppercaseLiteralSuffixCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UppercaseLiteralSuffixCheck.cpp:233
clang::tidy::readability::UppercaseLiteralSuffixCheck
Detects when the integral literal or floating point literal has non-uppercase suffix, and suggests to make the suffix uppercase.
Definition: UppercaseLiteralSuffixCheck.h:26
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
clang::tidy::readability::UppercaseLiteralSuffixCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UppercaseLiteralSuffixCheck.cpp:196
clang::tidy::readability::UppercaseLiteralSuffixCheck::UppercaseLiteralSuffixCheck
UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context)
Definition: UppercaseLiteralSuffixCheck.cpp:182
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:98
Result
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
Definition: ClangdServer.cpp:60
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ChangeNamespace.cpp:18
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:100
clang::tidy::readability::UppercaseLiteralSuffixCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: UppercaseLiteralSuffixCheck.cpp:189