clang-tools-extra/clang-tidy/modernize/UseIntegerSignComparisonCheck.h

   1 //===--- UseIntegerSignComparisonCheck.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_MODERNIZE_USEINTEGERSIGNCOMPARISONCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USEINTEGERSIGNCOMPARISONCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include "../utils/IncludeInserter.h"
  14 #include "clang/ASTMatchers/ASTMatchFinder.h"
  15
  16 namespace clang::tidy::modernize {
  17
  18 /// Replace comparisons between signed and unsigned integers with their safe
  19 /// C++20 ``std::cmp_*`` alternative, if available.
  20 ///
  21 /// For the user-facing documentation see:
  22 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-integer-sign-comparison.html
  23 class UseIntegerSignComparisonCheck : public ClangTidyCheck {
  24 public:
  25   UseIntegerSignComparisonCheck(StringRef Name, ClangTidyContext *Context);
  26
  27   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  28   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  29                            Preprocessor *ModuleExpanderPP) override;
  30   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  31   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  32   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  33     return LangOpts.CPlusPlus20;
  34   }
  35
  36 private:
  37   utils::IncludeInserter IncludeInserter;
  38 };
  39
  40 } // namespace clang::tidy::modernize
  41
  42 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USEINTEGERSIGNCOMPARISONCHECK_H