clang-tools  14.0.0git
ThrowByValueCatchByReferenceCheck.h
Go to the documentation of this file.
1 //===--- ThrowByValueCatchByReferenceCheck.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_MISC_THROW_BY_VALUE_CATCH_BY_REFERENCE_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_THROW_BY_VALUE_CATCH_BY_REFERENCE_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace misc {
17 
18 ///checks for locations that do not throw by value
19 // or catch by reference.
20 // The check is C++ only. It checks that all throw locations
21 // throw by value and not by pointer. Additionally it
22 // contains an option ("CheckThrowTemporaries", default value "true") that
23 // checks that thrown objects are anonymous temporaries. It is also
24 // acceptable for this check to throw string literals.
25 // This test checks that exceptions are caught by reference
26 // and not by value or pointer. It will not warn when catching
27 // pointer to char, wchar_t, char16_t or char32_t. This is
28 // due to not warning on throwing string literals.
30 public:
32  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
33  return LangOpts.CPlusPlus;
34  }
35  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
36  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
37  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
38 
39 private:
40  void diagnoseThrowLocations(const CXXThrowExpr *ThrowExpr);
41  void diagnoseCatchLocations(const CXXCatchStmt *CatchStmt,
42  ASTContext &Context);
43  bool isFunctionParameter(const DeclRefExpr *DeclRefExpr);
44  bool isCatchVariable(const DeclRefExpr *DeclRefExpr);
45  bool isFunctionOrCatchVar(const DeclRefExpr *DeclRefExpr);
46  const bool CheckAnonymousTemporaries;
47  const bool WarnOnLargeObject;
48  const uint64_t MaxSizeOptions; // The raw value read from the options.
49  uint64_t MaxSize; // No `const` because we have to set it in two steps.
50 };
51 
52 } // namespace misc
53 } // namespace tidy
54 } // namespace clang
55 
56 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_THROW_BY_VALUE_CATCH_BY_REFERENCE_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::misc::ThrowByValueCatchByReferenceCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ThrowByValueCatchByReferenceCheck.cpp:42
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::misc::ThrowByValueCatchByReferenceCheck::ThrowByValueCatchByReferenceCheck
ThrowByValueCatchByReferenceCheck(StringRef Name, ClangTidyContext *Context)
Definition: ThrowByValueCatchByReferenceCheck.cpp:20
clang::tidy::misc::ThrowByValueCatchByReferenceCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: ThrowByValueCatchByReferenceCheck.h:32
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::misc::ThrowByValueCatchByReferenceCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ThrowByValueCatchByReferenceCheck.cpp:30
clang::tidy::misc::ThrowByValueCatchByReferenceCheck
checks for locations that do not throw by value
Definition: ThrowByValueCatchByReferenceCheck.h:29
clang::tidy::misc::ThrowByValueCatchByReferenceCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: ThrowByValueCatchByReferenceCheck.cpp:35