clang-tools  14.0.0git
RawStringLiteralCheck.h
Go to the documentation of this file.
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 {
16 namespace tidy {
17 namespace modernize {
18 
19 using CharsBitSet = std::bitset<1 << CHAR_BIT>;
20 
21 /// This check replaces string literals with escaped characters to
22 /// raw string literals.
23 ///
24 /// For the user-facing documentation see:
25 /// http://clang.llvm.org/extra/clang-tidy/checks/modernize-raw-string-literal.html
27 public:
28  RawStringLiteralCheck(StringRef Name, ClangTidyContext *Context);
29 
30  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
31  return LangOpts.CPlusPlus11;
32  }
34  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
35  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
36 
37 private:
38  void replaceWithRawStringLiteral(
39  const ast_matchers::MatchFinder::MatchResult &Result,
40  const StringLiteral *Literal, StringRef Replacement);
41 
42  std::string DelimiterStem;
43  CharsBitSet DisallowedChars;
44  const bool ReplaceShorterLiterals;
45 };
46 
47 } // namespace modernize
48 } // namespace tidy
49 } // namespace clang
50 
51 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_RAW_STRING_LITERAL_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::modernize::CharsBitSet
std::bitset< 1<< CHAR_BIT > CharsBitSet
Definition: RawStringLiteralCheck.h:19
clang::tidy::modernize::RawStringLiteralCheck
This check replaces string literals with escaped characters to raw string literals.
Definition: RawStringLiteralCheck.h:26
clang::tidy::modernize::RawStringLiteralCheck::RawStringLiteralCheck
RawStringLiteralCheck(StringRef Name, ClangTidyContext *Context)
Definition: RawStringLiteralCheck.cpp:87
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::modernize::RawStringLiteralCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Options) override
Should store all options supported by this check with their current values or default values for opti...
Definition: RawStringLiteralCheck.cpp:114
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:416
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::modernize::RawStringLiteralCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: RawStringLiteralCheck.cpp:124
clang::tidy::modernize::RawStringLiteralCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: RawStringLiteralCheck.cpp:119
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::RawStringLiteralCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: RawStringLiteralCheck.h:30