clang-tools 10.0.0

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.
25 class InaccurateEraseCheck : public ClangTidyCheck {
26 public:
27 InaccurateEraseCheck(StringRef Name, ClangTidyContext *Context)
28 : ClangTidyCheck(Name, Context) {}
29 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31 };
32
33 } // namespace bugprone
34 } // namespace tidy
35 } // namespace clang
36
37 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_INACCURATEERASECHECK_H
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:50
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::bugprone::InaccurateEraseCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: InaccurateEraseCheck.cpp:20
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::bugprone::InaccurateEraseCheck
Checks for inaccurate use of the erase() method.
Definition: InaccurateEraseCheck.h:25
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::bugprone::InaccurateEraseCheck::InaccurateEraseCheck
InaccurateEraseCheck(StringRef Name, ClangTidyContext *Context)
Definition: InaccurateEraseCheck.h:27