xref: /llvm-project/clang-tools-extra/clang-tidy/hicpp/IgnoredRemoveResultCheck.h (revision 3ed940ac3dac03d044a8d1e51005cec84dd128f9)
1*3ed940acSBjörn Svensson //===--- IgnoredRemoveResultCheck.h - clang-tidy ----------------*- C++ -*-===//
2*3ed940acSBjörn Svensson //
3*3ed940acSBjörn Svensson // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*3ed940acSBjörn Svensson // See https://llvm.org/LICENSE.txt for license information.
5*3ed940acSBjörn Svensson // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*3ed940acSBjörn Svensson //
7*3ed940acSBjörn Svensson //===----------------------------------------------------------------------===//
8*3ed940acSBjörn Svensson 
9*3ed940acSBjörn Svensson #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_IGNOREDREMOVERESULTCHECK_H
10*3ed940acSBjörn Svensson #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_IGNOREDREMOVERESULTCHECK_H
11*3ed940acSBjörn Svensson 
12*3ed940acSBjörn Svensson #include "../bugprone/UnusedReturnValueCheck.h"
13*3ed940acSBjörn Svensson 
14*3ed940acSBjörn Svensson namespace clang::tidy::hicpp {
15*3ed940acSBjörn Svensson 
16*3ed940acSBjörn Svensson /// Ensure that the result of std::remove, std::remove_if and std::unique
17*3ed940acSBjörn Svensson /// are not ignored according to rule 17.5.1.
18*3ed940acSBjörn Svensson ///
19*3ed940acSBjörn Svensson /// For the user-facing documentation see:
20*3ed940acSBjörn Svensson /// http://clang.llvm.org/extra/clang-tidy/checks/hicpp/ignored-remove-result.html
21*3ed940acSBjörn Svensson class IgnoredRemoveResultCheck : public bugprone::UnusedReturnValueCheck {
22*3ed940acSBjörn Svensson public:
23*3ed940acSBjörn Svensson   IgnoredRemoveResultCheck(StringRef Name, ClangTidyContext *Context);
24*3ed940acSBjörn Svensson   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
25*3ed940acSBjörn Svensson };
26*3ed940acSBjörn Svensson 
27*3ed940acSBjörn Svensson } // namespace clang::tidy::hicpp
28*3ed940acSBjörn Svensson 
29*3ed940acSBjörn Svensson #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_HICPP_IGNOREDREMOVERESULTCHECK_H
30