clang-tools  15.0.0git
UncheckedOptionalAccessCheck.h
Go to the documentation of this file.
1 //===--- UncheckedOptionalAccessCheck.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_UNCHECKEDOPTIONALACCESSCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "clang/ASTMatchers/ASTMatchFinder.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace bugprone {
18 
19 /// Warns when the code is unwrapping a `std::optional<T>`, `absl::optional<T>`,
20 /// or `base::Optional<T>` object without assuring that it contains a value.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unchecked-optional-access.html
25 public:
27  : ClangTidyCheck(Name, Context) {}
28  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
31  return LangOpts.CPlusPlus;
32  }
33 };
34 
35 } // namespace bugprone
36 } // namespace tidy
37 } // namespace clang
38 
39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
clang::tidy::bugprone::UncheckedOptionalAccessCheck::UncheckedOptionalAccessCheck
UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context)
Definition: UncheckedOptionalAccessCheck.h:26
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
clang::tidy::bugprone::UncheckedOptionalAccessCheck
Warns when the code is unwrapping a std::optional<T>, absl::optional<T>, or base::Optional<T> object ...
Definition: UncheckedOptionalAccessCheck.h:24
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:67
Name
Token Name
Definition: MacroToEnumCheck.cpp:89
clang::tidy::bugprone::UncheckedOptionalAccessCheck::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: UncheckedOptionalAccessCheck.h:30
clang::tidy::bugprone::UncheckedOptionalAccessCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UncheckedOptionalAccessCheck.cpp:74
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
LangOpts
const LangOptions * LangOpts
Definition: ExtractFunction.cpp:366
clang::tidy::bugprone::UncheckedOptionalAccessCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UncheckedOptionalAccessCheck.cpp:91