clang-tools 20.0.0git
boost/UseRangesCheck.h
Go to the documentation of this file.
1//===--- UseRangesCheck.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_BOOST_USERANGESCHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BOOST_USERANGESCHECK_H
11
12#include "../utils/UseRangesCheck.h"
13
14namespace clang::tidy::boost {
15
16/// Detects calls to standard library iterator algorithms that could be
17/// replaced with a boost ranges version instead
18///
19/// For the user-facing documentation see:
20/// http://clang.llvm.org/extra/clang-tidy/checks/boost/use-ranges.html
22public:
23 UseRangesCheck(StringRef Name, ClangTidyContext *Context);
24
26
27 ReplacerMap getReplacerMap() const override;
28
29 DiagnosticBuilder createDiag(const CallExpr &Call) override;
30
31 ArrayRef<std::pair<StringRef, StringRef>>
32 getFreeBeginEndMethods() const override;
33
34 std::optional<ReverseIteratorDescriptor>
35 getReverseDescriptor() const override;
36
37private:
38 bool IncludeBoostSystem;
39 bool UseReversePipe;
40};
41
42} // namespace clang::tidy::boost
43
44#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BOOST_USERANGESCHECK_H
llvm::SmallString< 256U > Name
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Detects calls to standard library iterator algorithms that could be replaced with a boost ranges vers...
ArrayRef< std::pair< StringRef, StringRef > > getFreeBeginEndMethods() const override
Gets the fully qualified names of begin and end functions.
DiagnosticBuilder createDiag(const CallExpr &Call) override
Create a diagnostic for the CallExpr Override this to support custom diagnostic messages.
void storeOptions(ClangTidyOptions::OptionMap &Options) override
Should store all options supported by this check with their current values or default values for opti...
ReplacerMap getReplacerMap() const override
Gets a map of function to replace and methods to create the replacements.
std::optional< ReverseIteratorDescriptor > getReverseDescriptor() const override
Base class for handling converting std iterator algorithms to a range equivalent.
llvm::StringMap< llvm::IntrusiveRefCntPtr< Replacer > > ReplacerMap
llvm::StringMap< ClangTidyValue > OptionMap