Clang Project

clang_source_code/include/clang/Tooling/ReplacementsYaml.h
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
22LLVM_YAML_IS_SEQUENCE_VECTOR(clang::tooling::Replacement)
23
24namespace llvm {
25namespace yaml {
26
27/// Specialized MappingTraits to describe how a Replacement is
28/// (de)serialized.
29template <> 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
40    clang::tooling::Replacement denormalize(const IO &) {
41      return clang::tooling::Replacement(FilePath, Offset, Length,
42                                         ReplacementText);
43    }
44
45    std::string FilePath;
46    unsigned int Offset;
47    unsigned int Length;
48    std::string ReplacementText;
49  };
50
51  static void mapping(IO &Io, clang::tooling::Replacement &R) {
52    MappingNormalization<NormalizedReplacement, clang::tooling::Replacement>
53    Keys(Io, R);
54    Io.mapRequired("FilePath", Keys->FilePath);
55    Io.mapRequired("Offset", Keys->Offset);
56    Io.mapRequired("Length", Keys->Length);
57    Io.mapRequired("ReplacementText", Keys->ReplacementText);
58  }
59};
60
61/// Specialized MappingTraits to describe how a
62/// TranslationUnitReplacements is (de)serialized.
63template <> struct MappingTraits<clang::tooling::TranslationUnitReplacements> {
64  static void mapping(IO &Io,
65                      clang::tooling::TranslationUnitReplacements &Doc) {
66    Io.mapRequired("MainSourceFile", Doc.MainSourceFile);
67    Io.mapRequired("Replacements", Doc.Replacements);
68  }
69};
70} // end namespace yaml
71} // end namespace llvm
72
73#endif
74
CodeThinker, Enjoy your reading code