File: SourceEdit.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (72 lines) | stat: -rw-r--r-- 2,875 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

/// A textual edit to the original source represented by a range and a
/// replacement.
public struct SourceEdit: Equatable, Sendable {
  /// The half-open range that this edit applies to.
  public let range: Range<AbsolutePosition>
  /// The text to replace the original range with. Empty for a deletion.
  public let replacement: String

  /// Length of the original source range that this edit applies to. Zero if
  /// this is an addition.
  public var length: SourceLength {
    return SourceLength(utf8Length: range.upperBound.utf8Offset - range.lowerBound.utf8Offset)
  }

  /// Create an edit to replace `range` in the original source with
  /// `replacement`.
  public init(range: Range<AbsolutePosition>, replacement: String) {
    self.range = range
    self.replacement = replacement
  }

  /// Convenience function to create a textual addition after the given node
  /// and its trivia.
  public static func insert(_ newText: String, after node: some SyntaxProtocol) -> SourceEdit {
    return SourceEdit(range: node.endPosition..<node.endPosition, replacement: newText)
  }

  /// Convenience function to create a textual addition before the given node
  /// and its trivia.
  public static func insert(_ newText: String, before node: some SyntaxProtocol) -> SourceEdit {
    return SourceEdit(range: node.position..<node.position, replacement: newText)
  }

  /// Convenience function to create a textual replacement of the given node,
  /// including its trivia.
  public static func replace(_ node: some SyntaxProtocol, with replacement: String) -> SourceEdit {
    return SourceEdit(range: node.position..<node.endPosition, replacement: replacement)
  }

  /// Convenience function to create a textual deletion the given node and its
  /// trivia.
  public static func remove(_ node: some SyntaxProtocol) -> SourceEdit {
    return SourceEdit(range: node.position..<node.endPosition, replacement: "")
  }
}

extension SourceEdit: CustomDebugStringConvertible {
  public var debugDescription: String {
    let hasNewline = replacement.contains { $0.isNewline }
    if hasNewline {
      return #"""
        \#(range.lowerBound.utf8Offset)-\#(range.upperBound.utf8Offset)
        """
        \#(replacement)
        """
        """#
    }
    return "\(range.lowerBound.utf8Offset)-\(range.upperBound.utf8Offset) \"\(replacement)\""
  }
}