Rename byteOffset to utf8Offset and remove utf16

Author: Harlan Haskins

test/SwiftSyntax/AbsolutePosition.swift

@@ -31,11 +31,11 @@ PositionTests.test("Visitor") {
     let content = try SwiftLang.parse(getInput("visitor.swift"))
     let source = try String(contentsOf: getInput("visitor.swift"))
     let parsed = try SourceFileSyntax.decodeSourceFileSyntax(content)
-    expectEqual(parsed.position.byteOffset, 0)
-    expectEqual(parsed.eofToken.positionAfterSkippingLeadingTrivia.byteOffset,
-                source.count)
-    expectEqual(parsed.position.byteOffset, 0)
-    expectEqual(parsed.byteSize, source.count)
+    expectEqual(0, parsed.position.utf8Offset)
+    expectEqual(source.count,
+      parsed.eofToken.positionAfterSkippingLeadingTrivia.utf8Offset)
+    expectEqual(0, parsed.position.utf8Offset)
+    expectEqual(source.count, parsed.byteSize)
   })
 }
 
@@ -44,10 +44,10 @@ PositionTests.test("Closure") {
     let content = try SwiftLang.parse(getInput("closure.swift"))
     let source = try String(contentsOf: getInput("closure.swift"))
     let parsed = try SourceFileSyntax.decodeSourceFileSyntax(content)
-    expectEqual(parsed.eofToken.positionAfterSkippingLeadingTrivia.byteOffset,
-                source.count)
-    expectEqual(parsed.position.byteOffset, 0)
-    expectEqual(parsed.byteSize, source.count)
+    expectEqual(source.count, 
+      parsed.eofToken.positionAfterSkippingLeadingTrivia.utf8Offset)
+    expectEqual(0, parsed.position.utf8Offset)
+    expectEqual(source.count, parsed.byteSize)
   })
 }
 
@@ -57,9 +57,9 @@ PositionTests.test("Rename") {
     let parsed = try SourceFileSyntax.decodeSourceFileSyntax(content)
     let renamed = FuncRenamer().visit(parsed) as! SourceFileSyntax
     let renamedSource = renamed.description
-    expectEqual(renamed.eofToken.positionAfterSkippingLeadingTrivia.byteOffset,
-                renamedSource.count)
-    expectEqual(renamed.byteSize, renamedSource.count)
+    expectEqual(renamedSource.count, 
+      renamed.eofToken.positionAfterSkippingLeadingTrivia.utf8Offset)
+    expectEqual(renamedSource.count, renamed.byteSize)
   })
 }
 
@@ -74,8 +74,8 @@ PositionTests.test("CurrentFile") {
         _ = node.positionAfterSkippingLeadingTrivia
       }
       override func visit(_ node: TokenSyntax) {
-        expectEqual(node.position.byteOffset + node.leadingTrivia.byteSize,
-                    node.positionAfterSkippingLeadingTrivia.byteOffset)
+        expectEqual(node.positionAfterSkippingLeadingTrivia.utf8Offset,
+          node.position.utf8Offset + node.leadingTrivia.byteSize)
       }
     }
     Visitor().visit(parsed)
@@ -125,13 +125,14 @@ PositionTests.test("Trivias") {
   expectDoesNotThrow({
     let idx = 5
     let root = createSourceFile(idx + 1)
-    expectEqual(root.leadingTrivia!.count, 3)
-    expectEqual(root.trailingTrivia!.count, 0)
+    expectEqual(3, root.leadingTrivia!.count)
+    expectEqual(0, root.trailingTrivia!.count)
     let state = root.statements[idx]
-    expectEqual(state.leadingTrivia!.count, 3)
-    expectEqual(state.trailingTrivia!.count, 1)
-    expectEqual(state.leadingTrivia!.byteSize + state.trailingTrivia!.byteSize
-      + state.byteSizeAfterTrimmingTrivia, state.byteSize)
+    expectEqual(3, state.leadingTrivia!.count)
+    expectEqual(1, state.trailingTrivia!.count)
+    expectEqual(state.byteSize,
+      state.leadingTrivia!.byteSize + state.trailingTrivia!.byteSize
+        + state.byteSizeAfterTrimmingTrivia)
     expectFalse(root.statements.isImplicit)
   })
 }

tools/SwiftSyntax/CMakeLists.txt

@@ -2,6 +2,7 @@ add_swift_library(swiftSwiftSyntax SHARED
   # This file should be listed the first.  Module name is inferred from the
   # filename.
   SwiftSyntax.swift
+  AbsolutePosition.swift
   AtomicCache.swift
   Diagnostic.swift
   DiagnosticConsumer.swift

tools/SwiftSyntax/Diagnostic.swift

@@ -31,7 +31,7 @@ public struct SourceLocation: Codable {
 
   public init(file: String, position: AbsolutePosition) {
     self.init(line: position.line, column: position.column,
-              offset: position.byteOffset, file: file)
+              offset: position.utf8Offset, file: file)
   }
 
   public init(line: Int, column: Int, offset: Int, file: String) {

tools/SwiftSyntax/SyntaxData.swift

@@ -94,7 +94,7 @@ final class SyntaxData: Equatable {
   }
 
   var byteSize: Int {
-    return getNextSiblingPos().byteOffset - self.position.byteOffset
+    return getNextSiblingPos().utf8Offset - self.position.utf8Offset
   }
 
   /// Creates a SyntaxData with the provided raw syntax, pointing to the
@@ -258,63 +258,3 @@ final class SyntaxData: Equatable {
     return lhs === rhs
   }
 }
-
-/// An absolute position in a source file as text - the absolute byteOffset from
-/// the start, line, and column.
-public final class AbsolutePosition {
-  public fileprivate(set) var byteOffset: Int
-  public fileprivate(set) var line: Int
-  public fileprivate(set) var column: Int
-  public let encoding: Encoding
-
-  public enum Encoding {
-    case utf8
-    case utf16
-  }
-
-  public init(line: Int = 1, column: Int = 1, byteOffset: Int = 0,
-              encoding: Encoding = .utf8) {
-    self.line = line
-    self.column = column
-    self.byteOffset = byteOffset
-    self.encoding = encoding
-  }
-
-  internal func add(columns: Int) {
-    self.column += columns
-  }
-
-  internal func add(lines: Int, size: Int) {
-    self.line += lines * size
-    self.column = 1
-  }
-
-  /// Use some text as a reference for adding to the absolute position,
-  /// taking note of newlines, etc.
-  internal func add(text: String) {
-    for char in text {
-      switch char {
-      case "\n", "\r\n":
-        line += 1
-        column = 1
-      default:
-        column += 1
-      }
-
-      // FIXME: This is currently very wasteful, but should be fast once the small-string
-      //        optimization lands.
-      switch encoding {
-      case .utf8:
-        byteOffset += String(char).utf8.count
-      case .utf16:
-        // FIXME: Is this correct?
-        byteOffset += String(char).utf16.count * 2
-      }
-    }
-  }
-
-  internal func copy() -> AbsolutePosition {
-    return AbsolutePosition(line: line, column: column,
-      byteOffset: byteOffset)
-  }
-}

tools/SwiftSyntax/Trivia.swift.gyb

@@ -182,7 +182,7 @@ extension Trivia: Collection {
     for piece in pieces {
       piece.accumulateAbsolutePosition(pos)
     }
-    return pos.byteOffset
+    return pos.utf8Offset
   }
 }
 
@@ -214,6 +214,6 @@ extension TriviaPiece {
       pos.add(text: text)
 %   end
 % end
-  }
+    }
   }
 }