blob: 1733f7e1d126d350858a039751753ec1445cad47 [file] [log] [blame]
Olivier Deprezf4ef2d02021-04-20 13:36:24 +02001//===--- 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 {
16namespace tidy {
17namespace modernize {
18
19using 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
26class RawStringLiteralCheck : public ClangTidyCheck {
27public:
28 RawStringLiteralCheck(StringRef Name, ClangTidyContext *Context);
29
30 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
31 return LangOpts.CPlusPlus11;
32 }
33 void storeOptions(ClangTidyOptions::OptionMap &Options) override;
34 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
35 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
36
37private:
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