xref: /llvm-project/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h (revision aaadaee7b228d7010ff7076f5002ebb96b5e03dc)
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 #include "clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h"
15 
16 namespace clang::tidy::bugprone {
17 
18 /// Warns when the code is unwrapping a `std::optional<T>`, `absl::optional<T>`,
19 /// or `base::std::optional<T>` object without assuring that it contains a
20 /// value.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unchecked-optional-access.html
24 class UncheckedOptionalAccessCheck : public ClangTidyCheck {
25 public:
26   UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context)
27       : ClangTidyCheck(Name, Context),
28         ModelOptions{Options.get("IgnoreSmartPointerDereference", false)} {}
29   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
30   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
31   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
32     return LangOpts.CPlusPlus;
33   }
34   void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
35     Options.store(Opts, "IgnoreSmartPointerDereference",
36                   ModelOptions.IgnoreSmartPointerDereference);
37   }
38 
39 private:
40   dataflow::UncheckedOptionalAccessModelOptions ModelOptions;
41 };
42 
43 } // namespace clang::tidy::bugprone
44 
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
46