clang-tools-extra/clang-tidy/bugprone/InaccurateEraseCheck.h

   1 //===--- InaccurateEraseCheck.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_BUGPRONE_INACCURATEERASECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Checks for inaccurate use of the `erase()` method.
  17 ///
  18 /// Algorithms like `remove()` do not actually remove any element from the
  19 /// container but return an iterator to the first redundant element at the end
  20 /// of the container. These redundant elements must be removed using the
  21 /// `erase()` method. This check warns when not all of the elements will be
  22 /// removed due to using an inappropriate overload.
  23 class InaccurateEraseCheck : public ClangTidyCheck {
  24 public:
  25   InaccurateEraseCheck(StringRef Name, ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  28     return LangOpts.CPlusPlus;
  29   }
  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 };
  36
  37 } // namespace clang::tidy::bugprone
  38
  39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H