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

   1 //===--- RawStringLiteralCheck.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_RAW_STRING_LITERAL_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_RAW_STRING_LITERAL_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include <bitset>
  14
  15 namespace clang::tidy::modernize {
  16
  17 using CharsBitSet = std::bitset<1 << CHAR_BIT>;
  18
  19 /// This check replaces string literals with escaped characters to
  20 /// raw string literals.
  21 ///
  22 /// For the user-facing documentation see:
  23 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize/raw-string-literal.html
  24 class RawStringLiteralCheck : public ClangTidyCheck {
  25 public:
  26   RawStringLiteralCheck(StringRef Name, ClangTidyContext *Context);
  27
  28   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  29     return LangOpts.CPlusPlus11;
  30   }
  31   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  32   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  33   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  34
  35 private:
  36   void replaceWithRawStringLiteral(
  37       const ast_matchers::MatchFinder::MatchResult &Result,
  38       const StringLiteral *Literal, StringRef Replacement);
  39
  40   std::string DelimiterStem;
  41   CharsBitSet DisallowedChars;
  42   const bool ReplaceShorterLiterals;
  43 };
  44
  45 } // namespace clang::tidy::modernize
  46
  47 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_RAW_STRING_LITERAL_H