clang-tools 20.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#include "clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h"
15#include <optional>
16
17namespace clang::tidy::bugprone {
18
19/// Warns when the code is unwrapping a `std::optional<T>`, `absl::optional<T>`,
20/// or `base::std::optional<T>` object without assuring that it contains a
21/// value.
22///
23/// For the user-facing documentation see:
24/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/unchecked-optional-access.html
26public:
28 : ClangTidyCheck(Name, Context),
29 ModelOptions{
30 Options.getLocalOrGlobal("IgnoreSmartPointerDereference", false)} {}
31 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
32 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
33 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
34 return LangOpts.CPlusPlus;
35 }
37 Options.store(Opts, "IgnoreSmartPointerDereference",
38 ModelOptions.IgnoreSmartPointerDereference);
39 }
40
41private:
42 dataflow::UncheckedOptionalAccessModelOptions ModelOptions;
43};
44
45} // namespace clang::tidy::bugprone
46
47#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNCHECKEDOPTIONALACCESSCHECK_H
llvm::SmallString< 256U > Name
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Warns when the code is unwrapping a std::optional<T>, absl::optional<T>, or base::std::optional<T> ob...
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context)
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
llvm::StringMap< ClangTidyValue > OptionMap