xref: /llvm-project/clang-tools-extra/clang-tidy/readability/AvoidReturnWithVoidValueCheck.h (revision a89141f733cef817c586bb6da0ea69a5a323874e)
1 //===--- AvoidReturnWithVoidValueCheck.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_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::readability {
15 
16 /// Finds return statements with `void` values used within functions with `void`
17 /// result types.
18 ///
19 /// For the user-facing documentation see:
20 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/avoid-return-with-void-value.html
21 class AvoidReturnWithVoidValueCheck : public ClangTidyCheck {
22 public:
23   AvoidReturnWithVoidValueCheck(StringRef Name, ClangTidyContext *Context);
24 
25   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
26   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
27 
28 private:
getCheckTraversalKind()29   std::optional<TraversalKind> getCheckTraversalKind() const override {
30     return TK_IgnoreUnlessSpelledInSource;
31   }
isLanguageVersionSupported(const LangOptions & LangOpts)32   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
33     return LangOpts.CPlusPlus;
34   }
35   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
36 
37 private:
38   bool IgnoreMacros;
39   bool StrictMode;
40 };
41 
42 } // namespace clang::tidy::readability
43 
44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H
45