clang-tidy/readability/AvoidReturnWithVoidValueCheck.h

0001 //===--- AvoidReturnWithVoidValueCheck.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_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::readability {
0015
0016 /// Finds return statements with `void` values used within functions with `void`
0017 /// result types.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/avoid-return-with-void-value.html
0021 class AvoidReturnWithVoidValueCheck : public ClangTidyCheck {
0022 public:
0023   AvoidReturnWithVoidValueCheck(StringRef Name, ClangTidyContext *Context);
0024
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027
0028 private:
0029   std::optional<TraversalKind> getCheckTraversalKind() const override {
0030     return TK_IgnoreUnlessSpelledInSource;
0031   }
0032   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0033     return LangOpts.CPlusPlus;
0034   }
0035   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0036
0037 private:
0038   bool IgnoreMacros;
0039   bool StrictMode;
0040 };
0041
0042 } // namespace clang::tidy::readability
0043
0044 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDRETURNWITHVOIDVALUECHECK_H