clang-tools  14.0.0git
bugprone/ExceptionEscapeCheck.h
Go to the documentation of this file.
1 //===--- ExceptionEscapeCheck.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_EXCEPTION_ESCAPE_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_EXCEPTION_ESCAPE_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "../utils/ExceptionAnalyzer.h"
14 #include "llvm/ADT/StringSet.h"
15 
16 namespace clang {
17 namespace tidy {
18 namespace bugprone {
19 
20 /// Finds functions which should not throw exceptions: Destructors, move
21 /// constructors, move assignment operators, the main() function,
22 /// swap() functions, functions marked with throw() or noexcept and functions
23 /// given as option to the checker.
24 ///
25 /// For the user-facing documentation see:
26 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-exception-escape.html
28 public:
29  ExceptionEscapeCheck(StringRef Name, ClangTidyContext *Context);
30  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
31  return LangOpts.CPlusPlus && LangOpts.CXXExceptions;
32  }
33  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
34  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
35  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
36 
37 private:
38  std::string RawFunctionsThatShouldNotThrow;
39  std::string RawIgnoredExceptions;
40 
41  llvm::StringSet<> FunctionsThatShouldNotThrow;
43 };
44 
45 } // namespace bugprone
46 } // namespace tidy
47 } // namespace clang
48 
49 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_EXCEPTION_ESCAPE_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::bugprone::ExceptionEscapeCheck::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: bugprone/ExceptionEscapeCheck.cpp:48
clang::tidy::utils::ExceptionAnalyzer
This class analysis if a FunctionDecl can in principle throw an exception, either directly or indirec...
Definition: ExceptionAnalyzer.h:24
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::bugprone::ExceptionEscapeCheck::ExceptionEscapeCheck
ExceptionEscapeCheck(StringRef Name, ClangTidyContext *Context)
Definition: bugprone/ExceptionEscapeCheck.cpp:28
clang::tidy::bugprone::ExceptionEscapeCheck::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: bugprone/ExceptionEscapeCheck.h:30
clang::tidy::bugprone::ExceptionEscapeCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::ExceptionEscapeCheck
Finds functions which should not throw exceptions: Destructors, move constructors,...
Definition: bugprone/ExceptionEscapeCheck.h:27
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::ExceptionEscapeCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.