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

   1 //===--- UnusedReturnValueCheck.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_UNUSEDRETURNVALUECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDRETURNVALUECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include <string>
  14
  15 namespace clang::tidy::bugprone {
  16
  17 /// Detects function calls where the return value is unused.
  18 ///
  19 /// For the user-facing documentation see:
  20 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unused-return-value.html
  21 class UnusedReturnValueCheck : public ClangTidyCheck {
  22 public:
  23   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context);
  24   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  25   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  26   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  27   std::optional<TraversalKind> getCheckTraversalKind() const override {
  28     return TK_IgnoreUnlessSpelledInSource;
  29   }
  30
  31 private:
  32   const std::vector<StringRef> CheckedFunctions;
  33   const std::vector<StringRef> CheckedReturnTypes;
  34
  35 protected:
  36   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context,
  37                          std::vector<StringRef> CheckedFunctions);
  38   UnusedReturnValueCheck(StringRef Name, ClangTidyContext *Context,
  39                          std::vector<StringRef> CheckedFunctions,
  40                          std::vector<StringRef> CheckedReturnTypes,
  41                          bool AllowCastToVoid);
  42   bool AllowCastToVoid;
  43 };
  44
  45 } // namespace clang::tidy::bugprone
  46
  47 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNUSEDRETURNVALUECHECK_H