clang-tidy/bugprone/InaccurateEraseCheck.h

0001 //===--- InaccurateEraseCheck.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_BUGPRONE_INACCURATEERASECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::bugprone {
0015
0016 /// Checks for inaccurate use of the `erase()` method.
0017 ///
0018 /// Algorithms like `remove()` do not actually remove any element from the
0019 /// container but return an iterator to the first redundant element at the end
0020 /// of the container. These redundant elements must be removed using the
0021 /// `erase()` method. This check warns when not all of the elements will be
0022 /// removed due to using an inappropriate overload.
0023 class InaccurateEraseCheck : public ClangTidyCheck {
0024 public:
0025   InaccurateEraseCheck(StringRef Name, ClangTidyContext *Context)
0026       : ClangTidyCheck(Name, Context) {}
0027   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0028     return LangOpts.CPlusPlus;
0029   }
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
0037 } // namespace clang::tidy::bugprone
0038
0039 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H