clang-tools-extra/clang-tidy/bugprone/SuspiciousStringviewDataUsageCheck.h

   1 //===--- SuspiciousStringviewDataUsageCheck.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_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Identifies suspicious usages of std::string_view::data() that could lead to
  17 /// reading out-of-bounds data due to inadequate or incorrect string null
  18 /// termination.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-stringview-data-usage.html
  22 class SuspiciousStringviewDataUsageCheck : public ClangTidyCheck {
  23 public:
  24   SuspiciousStringviewDataUsageCheck(StringRef Name, ClangTidyContext *Context);
  25   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  26   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  27   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  28   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
  29   std::optional<TraversalKind> getCheckTraversalKind() const override;
  30
  31 private:
  32   std::vector<llvm::StringRef> StringViewTypes;
  33   std::vector<llvm::StringRef> AllowedCallees;
  34 };
  35
  36 } // namespace clang::tidy::bugprone
  37
  38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H