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::tidy::readability {
16 
17 /// Detects when the integral literal or floating point literal has
18 /// non-uppercase suffix, and suggests to make the suffix uppercase.
19 /// Alternatively, a list of destination suffixes can be provided.
20 ///
21 /// For the user-facing documentation see:
22 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/uppercase-literal-suffix.html
23 class UppercaseLiteralSuffixCheck : public ClangTidyCheck {
24 public:
25   UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context);
26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
28   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
getCheckTraversalKind()29   std::optional<TraversalKind> getCheckTraversalKind() const override {
30     return TK_IgnoreUnlessSpelledInSource;
31   }
32 
33 private:
34   template <typename LiteralType>
35   bool checkBoundMatch(const ast_matchers::MatchFinder::MatchResult &Result);
36 
37   const std::vector<StringRef> NewSuffixes;
38   const bool IgnoreMacros;
39 };
40 
41 } // namespace clang::tidy::readability
42 
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
44