clang-tidy/boost/UseRangesCheck.h

0001 //===--- UseRangesCheck.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_BOOST_USERANGESCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BOOST_USERANGESCHECK_H
0011
0012 #include "../utils/UseRangesCheck.h"
0013
0014 namespace clang::tidy::boost {
0015
0016 /// Detects calls to standard library iterator algorithms that could be
0017 /// replaced with a boost ranges version instead
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/boost/use-ranges.html
0021 class UseRangesCheck : public utils::UseRangesCheck {
0022 public:
0023   UseRangesCheck(StringRef Name, ClangTidyContext *Context);
0024
0025   void storeOptions(ClangTidyOptions::OptionMap &Options) override;
0026
0027   ReplacerMap getReplacerMap() const override;
0028
0029   DiagnosticBuilder createDiag(const CallExpr &Call) override;
0030
0031   ArrayRef<std::pair<StringRef, StringRef>>
0032   getFreeBeginEndMethods() const override;
0033
0034   std::optional<ReverseIteratorDescriptor>
0035   getReverseDescriptor() const override;
0036
0037 private:
0038   bool IncludeBoostSystem;
0039   bool UseReversePipe;
0040 };
0041
0042 } // namespace clang::tidy::boost
0043
0044 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BOOST_USERANGESCHECK_H