clang-tools  14.0.0git
InaccurateEraseCheck.h
Go to the documentation of this file.
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 {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// Checks for inaccurate use of the `erase()` method.
19 ///
20 /// Algorithms like `remove()` do not actually remove any element from the
21 /// container but return an iterator to the first redundant element at the end
22 /// of the container. These redundant elements must be removed using the
23 /// `erase()` method. This check warns when not all of the elements will be
24 /// removed due to using an inappropriate overload.
26 public:
28  : ClangTidyCheck(Name, Context) {}
29  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
30  return LangOpts.CPlusPlus;
31  }
32  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
33  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
34  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
35  return TK_IgnoreUnlessSpelledInSource;
36  }
37 };
38 
39 } // namespace bugprone
40 } // namespace tidy
41 } // namespace clang
42 
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H
clang::tidy::bugprone::InaccurateEraseCheck
Checks for inaccurate use of the erase() method.
Definition: InaccurateEraseCheck.h:25
clang::tidy::bugprone::InaccurateEraseCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: InaccurateEraseCheck.cpp:40
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
clang::tidy::bugprone::InaccurateEraseCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: InaccurateEraseCheck.h:29
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::InaccurateEraseCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: InaccurateEraseCheck.cpp:20
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::InaccurateEraseCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: InaccurateEraseCheck.h:34
clang::tidy::bugprone::InaccurateEraseCheck::InaccurateEraseCheck
InaccurateEraseCheck(StringRef Name, ClangTidyContext *Context)
Definition: InaccurateEraseCheck.h:27