clang-tidy/readability/UppercaseLiteralSuffixCheck.h

0001 //===--- UppercaseLiteralSuffixCheck.h - clang-tidy -------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/OptionsUtils.h"
0014
0015 namespace clang::tidy::readability {
0016
0017 /// Detects when the integral literal or floating point literal has
0018 /// non-uppercase suffix, and suggests to make the suffix uppercase.
0019 /// Alternatively, a list of destination suffixes can be provided.
0020 ///
0021 /// For the user-facing documentation see:
0022 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/uppercase-literal-suffix.html
0023 class UppercaseLiteralSuffixCheck : public ClangTidyCheck {
0024 public:
0025   UppercaseLiteralSuffixCheck(StringRef Name, ClangTidyContext *Context);
0026   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0027   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0028   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0029   std::optional<TraversalKind> getCheckTraversalKind() const override {
0030     return TK_IgnoreUnlessSpelledInSource;
0031   }
0032
0033 private:
0034   template <typename LiteralType>
0035   bool checkBoundMatch(const ast_matchers::MatchFinder::MatchResult &Result);
0036
0037   const std::vector<StringRef> NewSuffixes;
0038   const bool IgnoreMacros;
0039 };
0040
0041 } // namespace clang::tidy::readability
0042
0043 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_UPPERCASELITERALSUFFIXCHECK_H