clang-tools 20.0.0git
UseStdMinMaxCheck.h
Go to the documentation of this file.
1//===--- UseStdMinMaxCheck.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_USESTDMINMAXCHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_USESTDMINMAXCHECK_H
11
12#include "../ClangTidyCheck.h"
13#include "../utils/IncludeInserter.h"
14
16
17/// Replaces certain conditional statements with equivalent calls to
18/// ``std::min`` or ``std::max``.
19/// For the user-facing documentation see:
20/// http://clang.llvm.org/extra/clang-tidy/checks/readability/UseStdMinMax.html
22public:
23 UseStdMinMaxCheck(StringRef Name, ClangTidyContext *Context);
24 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
25 return LangOpts.CPlusPlus;
26 }
27 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
28 Preprocessor *ModuleExpanderPP) override;
29 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
30 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
31 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
32 std::optional<TraversalKind> getCheckTraversalKind() const override {
33 return TK_IgnoreUnlessSpelledInSource;
34 }
35
36private:
37 utils::IncludeInserter IncludeInserter;
38};
39
40} // namespace clang::tidy::readability
41
42#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_USESTDMINMAXCHECK_H
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Replaces certain conditional statements with equivalent calls to std::min or std::max.
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
std::optional< TraversalKind > getCheckTraversalKind() const override
Produces fixes to insert specified includes to source files, if not yet present.
llvm::StringMap< ClangTidyValue > OptionMap