clang-tools 17.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
15namespace clang::tidy::modernize {
16
17using 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
25public:
26 RawStringLiteralCheck(StringRef Name, ClangTidyContext *Context);
27
28 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
29 return LangOpts.CPlusPlus11;
30 }
32 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
33 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
34
35private:
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
Token Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
This check replaces string literals with escaped characters to raw string literals.
void storeOptions(ClangTidyOptions::OptionMap &Options) override
Should store all options supported by this check with their current values or default values for opti...
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
std::bitset< 1<< CHAR_BIT > CharsBitSet
llvm::StringMap< ClangTidyValue > OptionMap