clang-tools 10.0.0

UppercaseLiteralSuffixCheck.h
Go to the documentation of this file.
1 //===--- UppercaseLiteralSuffixCheck.h - clang-tidy -------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
11
12 #include "../ClangTidyCheck.h"
13 #include "../utils/OptionsUtils.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace readability {
18
19 /// Detects when the integral literal or floating point literal has
20 /// non-uppercase suffix, and suggests to make the suffix uppercase.
21 /// Alternatively, a list of destination suffixes can be provided.
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/readability-uppercase-literal-suffix.html
25 class UppercaseLiteralSuffixCheck : public ClangTidyCheck {
26 public:
27 UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context);
28 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
31
32 private:
33 template <typename LiteralType>
34 bool checkBoundMatch(const ast_matchers::MatchFinder::MatchResult &Result);
35
36 const std::vector<std::string> NewSuffixes;
37 const bool IgnoreMacros;
38 };
39
40 } // namespace readability
41 } // namespace tidy
42 } // namespace clang
43
44 #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:232
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:25
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::readability::UppercaseLiteralSuffixCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UppercaseLiteralSuffixCheck.cpp:195
clang::tidy::readability::UppercaseLiteralSuffixCheck::UppercaseLiteralSuffixCheck
UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context)
Definition: UppercaseLiteralSuffixCheck.cpp:181
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:97
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
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:188