clang-tools  14.0.0git
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
26 public:
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  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
32  return TK_IgnoreUnlessSpelledInSource;
33  }
34 
35 private:
36  template <typename LiteralType>
37  bool checkBoundMatch(const ast_matchers::MatchFinder::MatchResult &Result);
38 
39  const std::vector<std::string> NewSuffixes;
40  const bool IgnoreMacros;
41 };
42 
43 } // namespace readability
44 } // namespace tidy
45 } // namespace clang
46 
47 #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:237
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::readability::UppercaseLiteralSuffixCheck
Detects when the integral literal or floating point literal has non-uppercase suffix,...
Definition: UppercaseLiteralSuffixCheck.h:25
clang::tidy::readability::UppercaseLiteralSuffixCheck::UppercaseLiteralSuffixCheck
UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context)
Definition: UppercaseLiteralSuffixCheck.cpp:187
clang::tidy::readability::UppercaseLiteralSuffixCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UppercaseLiteralSuffixCheck.cpp:201
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::readability::UppercaseLiteralSuffixCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: UppercaseLiteralSuffixCheck.h:31
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:194