clang-tidy/modernize/UseStdNumbersCheck.h

0001 //===--- UseStdNumbersCheck.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_MODERNIZE_USESTDNUMBERSCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTDNUMBERSCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/IncludeInserter.h"
0014
0015 namespace clang::tidy::modernize {
0016
0017 /// Finds constants and function calls to math functions that can be replaced
0018 /// with c++20's mathematical constants from the ``numbers`` header and
0019 /// offers fix-it hints.
0020 /// Does not match the use of variables with that value, and instead,
0021 /// offers a replacement at the definition of those variables.
0022 ///
0023 /// For the user-facing documentation see:
0024 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-std-numbers.html
0025 class UseStdNumbersCheck : public ClangTidyCheck {
0026 public:
0027   UseStdNumbersCheck(StringRef Name, ClangTidyContext *Context);
0028
0029   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0030     return LangOpts.CPlusPlus20;
0031   }
0032   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0033   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0034   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0035                            Preprocessor *ModuleExpanderPP) override;
0036   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0037   std::optional<TraversalKind> getCheckTraversalKind() const override {
0038     return TK_IgnoreUnlessSpelledInSource;
0039   }
0040
0041 private:
0042   utils::IncludeInserter IncludeInserter;
0043   StringRef DiffThresholdString;
0044   double DiffThreshold;
0045 };
0046
0047 } // namespace clang::tidy::modernize
0048
0049 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTDNUMBERSCHECK_H