clang-tidy/bugprone/UnusedReturnValueCheck.h

0001 //===--- UnusedReturnValueCheck.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_UNUSEDRETURNVALUECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDRETURNVALUECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include <string>
0014
0015 namespace clang::tidy::bugprone {
0016
0017 /// Detects function calls where the return value is unused.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unused-return-value.html
0021 class UnusedReturnValueCheck : public ClangTidyCheck {
0022 public:
0023   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context);
0024   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027   std::optional<TraversalKind> getCheckTraversalKind() const override {
0028     return TK_IgnoreUnlessSpelledInSource;
0029   }
0030
0031 private:
0032   const std::vector<StringRef> CheckedFunctions;
0033   const std::vector<StringRef> CheckedReturnTypes;
0034
0035 protected:
0036   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context,
0037                          std::vector<StringRef> CheckedFunctions);
0038   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context,
0039                          std::vector<StringRef> CheckedFunctions,
0040                          std::vector<StringRef> CheckedReturnTypes,
0041                          bool AllowCastToVoid);
0042   bool AllowCastToVoid;
0043 };
0044
0045 } // namespace clang::tidy::bugprone
0046
0047 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDRETURNVALUECHECK_H