clang-tools  14.0.0git
ContainerDataPointerCheck.h
Go to the documentation of this file.
1 //===--- ContainerDataPointerCheck.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_READABILITY_CONTAINERDATAPOINTERCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_CONTAINERDATAPOINTERCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace readability {
17 /// Checks whether a call to `operator[]` and `&` can be replaced with a call to
18 /// `data()`.
19 ///
20 /// This only replaces the case where the offset being accessed through the
21 /// subscript operation is a known constant 0. This avoids a potential invalid
22 /// memory access when the container is empty. Cases where the constant is not
23 /// explicitly zero can be addressed through the clang static analyzer, and
24 /// those which cannot be statically identified can be caught using UBSan.
26 public:
27  ContainerDataPointerCheck(StringRef Name, ClangTidyContext *Context);
28 
29  bool isLanguageVersionSupported(const LangOptions &LO) const override {
30  return LO.CPlusPlus11;
31  }
32 
33  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
34 
35  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
36 
37  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
38  return TK_IgnoreUnlessSpelledInSource;
39  }
40 };
41 } // namespace readability
42 } // namespace tidy
43 } // namespace clang
44 
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_CONTAINERDATAPOINTERCHECK_H
clang::tidy::readability::ContainerDataPointerCheck::ContainerDataPointerCheck
ContainerDataPointerCheck(StringRef Name, ClangTidyContext *Context)
Definition: ContainerDataPointerCheck.cpp:19
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::readability::ContainerDataPointerCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LO) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: ContainerDataPointerCheck.h:29
clang::tidy::readability::ContainerDataPointerCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ContainerDataPointerCheck.cpp:23
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::readability::ContainerDataPointerCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: ContainerDataPointerCheck.h:37
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::readability::ContainerDataPointerCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ContainerDataPointerCheck.cpp:95
clang::tidy::readability::ContainerDataPointerCheck
Checks whether a call to operator[] and & can be replaced with a call to data().
Definition: ContainerDataPointerCheck.h:25