| 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::tidy::readability { |
| 15 |
/// Checks whether a call to `operator[]` and `&` can be replaced with a call to |
| 16 |
/// `data()`. |
| 17 |
/// |
| 18 |
/// This only replaces the case where the offset being accessed through the |
| 19 |
/// subscript operation is a known constant 0. This avoids a potential invalid |
| 20 |
/// memory access when the container is empty. Cases where the constant is not |
| 21 |
/// explicitly zero can be addressed through the clang static analyzer, and |
| 22 |
/// those which cannot be statically identified can be caught using UBSan. |
| 23 |
class ContainerDataPointerCheck : public ClangTidyCheck { |
| 24 |
public: |
| 25 |
ContainerDataPointerCheck(StringRef Name, ClangTidyContext *Context); |
| 26 |
|
| 27 |
bool isLanguageVersionSupported(const LangOptions &LO) const override { |
| 28 |
return LO.CPlusPlus11; |
| 29 |
} |
| 30 |
|
| 31 |
void registerMatchers(ast_matchers::MatchFinder *Finder) override; |
| 32 |
|
| 33 |
void check(const ast_matchers::MatchFinder::MatchResult &Result) override; |
| 34 |
|
| 35 |
std::optional<TraversalKind> getCheckTraversalKind() const override { |
| 36 |
return TK_IgnoreUnlessSpelledInSource; |
| 37 |
} |
| 38 |
}; |
| 39 |
} // namespace clang::tidy::readability |
| 40 |
|
| 41 |
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_CONTAINERDATAPOINTERCHECK_H |