clang-tidy/readability/UseStdMinMaxCheck.h

0001 //===--- UseStdMinMaxCheck.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_USESTDMINMAXCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_USESTDMINMAXCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/IncludeInserter.h"
0014
0015 namespace clang::tidy::readability {
0016
0017 /// Replaces certain conditional statements with equivalent calls to
0018 /// ``std::min`` or ``std::max``.
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/UseStdMinMax.html
0021 class UseStdMinMaxCheck : public ClangTidyCheck {
0022 public:
0023   UseStdMinMaxCheck(StringRef Name, ClangTidyContext *Context);
0024   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0025     return LangOpts.CPlusPlus;
0026   }
0027   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0028                            Preprocessor *ModuleExpanderPP) override;
0029   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0030   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0031   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0032   std::optional<TraversalKind> getCheckTraversalKind() const override {
0033     return TK_IgnoreUnlessSpelledInSource;
0034   }
0035
0036 private:
0037   utils::IncludeInserter IncludeInserter;
0038 };
0039
0040 } // namespace clang::tidy::readability
0041
0042 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_USESTDMINMAXCHECK_H