clang-tools-extra/clang-tidy/modernize/UseStartsEndsWithCheck.h

   1 //===--- UseStartsEndsWithCheck.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_MODERNIZE_USESTARTSENDSWITHCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTARTSENDSWITHCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::modernize {
  15
  16 /// Checks for common roundabout ways to express ``starts_with`` and
  17 /// ``ends_with`` and suggests replacing with the simpler method when it is
  18 /// available. Notably, this will work with ``std::string`` and
  19 /// ``std::string_view``.
  20 ///
  21 /// For the user-facing documentation see:
  22 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-starts-ends-with.html
  23 class UseStartsEndsWithCheck : public ClangTidyCheck {
  24 public:
  25   UseStartsEndsWithCheck(StringRef Name, ClangTidyContext *Context);
  26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  28   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  29     return LangOpts.CPlusPlus;
  30   }
  31   std::optional<TraversalKind> getCheckTraversalKind() const override {
  32     return TK_IgnoreUnlessSpelledInSource;
  33   }
  34 };
  35
  36 } // namespace clang::tidy::modernize
  37
  38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USESTARTSENDSWITHCHECK_H