clang-tidy/bugprone/SuspiciousStringviewDataUsageCheck.h

0001 //===--- SuspiciousStringviewDataUsageCheck.h - clang-tidy -------//C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::bugprone {
0015
0016 /// Identifies suspicious usages of std::string_view::data() that could lead to
0017 /// reading out-of-bounds data due to inadequate or incorrect string null
0018 /// termination.
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-stringview-data-usage.html
0022 class SuspiciousStringviewDataUsageCheck : public ClangTidyCheck {
0023 public:
0024   SuspiciousStringviewDataUsageCheck(StringRef Name, ClangTidyContext *Context);
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0028   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
0029   std::optional<TraversalKind> getCheckTraversalKind() const override;
0030
0031 private:
0032   std::vector<llvm::StringRef> StringViewTypes;
0033   std::vector<llvm::StringRef> AllowedCallees;
0034 };
0035
0036 } // namespace clang::tidy::bugprone
0037
0038 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSSTRINGVIEWDATAUSAGECHECK_H