clang-tidy/bugprone/UncheckedOptionalAccessCheck.h

0001 //===--- UncheckedOptionalAccessCheck.h - clang-tidy ------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "clang/ASTMatchers/ASTMatchFinder.h"
0014 #include "clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h"
0015
0016 namespace clang::tidy::bugprone {
0017
0018 /// Warns when the code is unwrapping a `std::optional<T>`, `absl::optional<T>`,
0019 /// or `base::std::optional<T>` object without assuring that it contains a
0020 /// value.
0021 ///
0022 /// For the user-facing documentation see:
0023 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unchecked-optional-access.html
0024 class UncheckedOptionalAccessCheck : public ClangTidyCheck {
0025 public:
0026   UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context)
0027       : ClangTidyCheck(Name, Context),
0028         ModelOptions{Options.get("IgnoreSmartPointerDereference", false)} {}
0029   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0030   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0031   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0032     return LangOpts.CPlusPlus;
0033   }
0034   void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
0035     Options.store(Opts, "IgnoreSmartPointerDereference",
0036                   ModelOptions.IgnoreSmartPointerDereference);
0037   }
0038
0039 private:
0040   dataflow::UncheckedOptionalAccessModelOptions ModelOptions;
0041 };
0042
0043 } // namespace clang::tidy::bugprone
0044
0045 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H