xref: /llvm-project/clang-tools-extra/clang-tidy/bugprone/ReturnConstRefFromParameterCheck.h (revision d56f08b2ba439e88d026a75ff6ec443ac81a3260)
1 //===--- ReturnConstRefFromParameterCheck.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_RETURNCONSTREFFROMPARAMETERCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_RETURNCONSTREFFROMPARAMETERCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::bugprone {
15 
16 /// Detects return statements that return a constant reference parameter as
17 /// constant reference. This may cause use-after-free errors if the caller uses
18 /// xvalues as arguments.
19 ///
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/return-const-ref-from-parameter.html
22 class ReturnConstRefFromParameterCheck : public ClangTidyCheck {
23 public:
ReturnConstRefFromParameterCheck(StringRef Name,ClangTidyContext * Context)24   ReturnConstRefFromParameterCheck(StringRef Name, ClangTidyContext *Context)
25       : ClangTidyCheck(Name, Context) {}
26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
getCheckTraversalKind()28   std::optional<TraversalKind> getCheckTraversalKind() const override {
29     // Use 'AsIs' to make sure the return type is exactly the same as the
30     // parameter type.
31     return TK_AsIs;
32   }
isLanguageVersionSupported(const LangOptions & LangOpts)33   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
34     return LangOpts.CPlusPlus;
35   }
36 };
37 
38 } // namespace clang::tidy::bugprone
39 
40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_RETURNCONSTREFFROMPARAMETERCHECK_H
41