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.
25 class ContainerDataPointerCheck : public ClangTidyCheck {
26 public:
27   ContainerDataPointerCheck(StringRef Name, ClangTidyContext *Context);
28 
isLanguageVersionSupported(const LangOptions & LO)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 
getCheckTraversalKind()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
46