1 //===-- ReplacementsYaml.h -- Serialiazation for Replacements ---*- 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 /// \file
10 /// This file defines the structure of a YAML document for serializing
11 /// replacements.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_TOOLING_REPLACEMENTSYAML_H
16 #define LLVM_CLANG_TOOLING_REPLACEMENTSYAML_H
17 
18 #include "clang/Tooling/Refactoring.h"
19 #include "llvm/Support/YAMLTraits.h"
20 #include <string>
21 
22 LLVM_YAML_IS_SEQUENCE_VECTOR(clang::tooling::Replacement)
23 
24 namespace llvm {
25 namespace yaml {
26 
27 /// Specialized MappingTraits to describe how a Replacement is
28 /// (de)serialized.
29 template <> struct MappingTraits<clang::tooling::Replacement> {
30   /// Helper to (de)serialize a Replacement since we don't have direct
31   /// access to its data members.
32   struct NormalizedReplacement {
33     NormalizedReplacement(const IO &)
34         : FilePath(""), Offset(0), Length(0), ReplacementText("") {}
35 
36     NormalizedReplacement(const IO &, const clang::tooling::Replacement &R)
37         : FilePath(R.getFilePath()), Offset(R.getOffset()),
38           Length(R.getLength()), ReplacementText(R.getReplacementText()) {
39       size_t lineBreakPos = ReplacementText.find('\n');
40       while (lineBreakPos != std::string::npos) {
41         ReplacementText.replace(lineBreakPos, 1, "\n\n");
42         lineBreakPos = ReplacementText.find('\n', lineBreakPos + 2);
43       }
44     }
45 
46     clang::tooling::Replacement denormalize(const IO &) {
47       return clang::tooling::Replacement(FilePath, Offset, Length,
48                                          ReplacementText);
49     }
50 
51     std::string FilePath;
52     unsigned int Offset;
53     unsigned int Length;
54     std::string ReplacementText;
55   };
56 
57   static void mapping(IO &Io, clang::tooling::Replacement &R) {
58     MappingNormalization<NormalizedReplacement, clang::tooling::Replacement>
59     Keys(Io, R);
60     Io.mapRequired("FilePath", Keys->FilePath);
61     Io.mapRequired("Offset", Keys->Offset);
62     Io.mapRequired("Length", Keys->Length);
63     Io.mapRequired("ReplacementText", Keys->ReplacementText);
64   }
65 };
66 
67 /// Specialized MappingTraits to describe how a
68 /// TranslationUnitReplacements is (de)serialized.
69 template <> struct MappingTraits<clang::tooling::TranslationUnitReplacements> {
70   static void mapping(IO &Io,
71                       clang::tooling::TranslationUnitReplacements &Doc) {
72     Io.mapRequired("MainSourceFile", Doc.MainSourceFile);
73     Io.mapRequired("Replacements", Doc.Replacements);
74   }
75 };
76 } // end namespace yaml
77 } // end namespace llvm
78 
79 #endif
80