Make most of Rope inlinable

jbmorley · Apr 10, 2023 · 454c84b · 454c84b
1 parent 83bc546
commit 454c84b
Show file tree

Hide file tree

Showing 28 changed files with 624 additions and 311 deletions.
diff --git a/Sources/HashTreeCollections/HashNode/_HashNode+Builder.swift b/Sources/HashTreeCollections/HashNode/_HashNode+Builder.swift
@@ -13,7 +13,7 @@ extension _HashNode {
   @usableFromInline
   @frozen
   internal struct Builder {
-    @usableFromInline typealias Element = _HashNode.Element
+    @usableFromInline internal typealias Element = _HashNode.Element
 
     @usableFromInline
     @frozen

diff --git a/Sources/RopeModule/Rope/Basics/Rope+Builder.swift b/Sources/RopeModule/Rope/Basics/Rope+Builder.swift
@@ -25,6 +25,7 @@ extension Rope {
 }
 
 extension Rope {
+  @frozen // Not really! This module isn't ABI stable.
   public struct Builder {
     //       ║                    ║
     //       ║ ║                ║ ║
@@ -34,26 +35,31 @@ extension Rope {
     // →prefixTrees→  ↑  ↑  ←suffixTrees←
     //           prefix  suffix
 
-    private var _prefixTrees: [Rope] = []
-    private var _prefixLeaf: Rope._Node?
-    var _prefix: Rope._Item?
+    @usableFromInline internal var _prefixTrees: [Rope] = []
+    @usableFromInline internal var _prefixLeaf: Rope._Node?
+
+    @usableFromInline internal var _prefix: Rope._Item?
 
-    var _suffix: Rope._Item?
-    var _suffixTrees: [Rope] = []
+    @usableFromInline internal var _suffix: Rope._Item?
+    @usableFromInline internal var _suffixTrees: [Rope] = []
 
+    @inlinable
     public init() {}
 
+    @inlinable
     public var isPrefixEmpty: Bool {
       if _prefix != nil { return false }
       if let leaf = self._prefixLeaf, !leaf.isEmpty { return false }
       return _prefixTrees.isEmpty
     }
 
+    @inlinable
     public var isSuffixEmpty: Bool {
       if _suffix != nil { return false }
       return _suffixTrees.isEmpty
     }
 
+    @inlinable
     public var prefixSummary: Summary {
       var sum = Summary.zero
       for sapling in _prefixTrees {
@@ -64,6 +70,7 @@ extension Rope {
       return sum
     }
 
+    @inlinable
     public var suffixSummary: Summary {
       var sum = Summary.zero
       if let item = _suffix { sum.add(item.summary) }
@@ -73,6 +80,7 @@ extension Rope {
       return sum
     }
 
+    @inlinable
     var _lastPrefixItem: Rope._Item {
       get {
         assert(!isPrefixEmpty)
@@ -92,6 +100,7 @@ extension Rope {
       }
     }
 
+    @inlinable
     var _firstSuffixItem: Rope._Item {
       get {
         assert(!isSuffixEmpty)
@@ -108,6 +117,7 @@ extension Rope {
       }
     }
 
+    @inlinable
     public func forEachElementInPrefix(
       from position: Int,
       in metric: some RopeMetric<Element>,
@@ -155,6 +165,7 @@ extension Rope {
       return true
     }
 
+    @inlinable
     public mutating func mutatingForEachSuffix<R>(
       _ body: (inout Element) -> R?
     ) -> R? {
@@ -170,10 +181,12 @@ extension Rope {
       return nil
     }
 
+    @inlinable
     public mutating func insertBeforeTip(_ item: __owned Element) {
       _insertBeforeTip(Rope._Item(item))
     }
 
+    @inlinable
     mutating func _insertBeforeTip(_ item: __owned Rope._Item) {
       guard !item.isEmpty else { return }
       guard var prefix = self._prefix._take() else {
@@ -189,6 +202,7 @@ extension Rope {
       self._prefix = item
     }
 
+    @inlinable
     mutating func _appendNow(_ item: __owned Rope._Item) {
       assert(self._prefix == nil)
       assert(!item.isUndersized)
@@ -202,11 +216,13 @@ extension Rope {
       _invariantCheck()
     }
 
+    @inlinable
     public mutating func insertBeforeTip(_ rope: __owned Rope) {
       guard rope._root != nil else { return }
       _insertBeforeTip(rope.root)
     }
 
+    @inlinable
     mutating func _insertBeforeTip(_ node: __owned Rope._Node) {
       defer { _invariantCheck() }
       var node = node
@@ -249,6 +265,7 @@ extension Rope {
       _appendNow(node)
     }
 
+    @inlinable
     mutating func _appendNow(_ rope: __owned Rope._Node) {
       assert(self._prefix == nil && self._prefixLeaf == nil)
       var new = rope
@@ -287,10 +304,12 @@ extension Rope {
       _prefixTrees.append(Rope(root: new))
     }
 
+    @inlinable
     public mutating func insertAfterTip(_ item: __owned Element) {
       _insertAfterTip(_Item(item))
     }
 
+    @inlinable
     mutating func _insertAfterTip(_ item: __owned _Item) {
       guard !item.isEmpty else { return }
       if var suffixItem = self._suffix._take() {
@@ -306,16 +325,19 @@ extension Rope {
       self._suffix = item
     }
 
+    @inlinable
     public mutating func insertAfterTip(_ rope: __owned Rope) {
       assert(_suffix == nil)
       assert(_suffixTrees.isEmpty || rope._height <= _suffixTrees.last!._height)
       _suffixTrees.append(rope)
     }
 
+    @inlinable
     mutating func _insertAfterTip(_ rope: __owned Rope._Node) {
       insertAfterTip(Rope(root: rope))
     }
 
+    @inlinable
     mutating func _insertBeforeTip(slots: Range<Int>, in node: __owned Rope._Node) {
       assert(slots.lowerBound >= 0 && slots.upperBound <= node.childCount)
       let c = slots.count
@@ -334,6 +356,7 @@ extension Rope {
       _insertBeforeTip(copy)
     }
 
+    @inlinable
     mutating func _insertAfterTip(slots: Range<Int>, in node: __owned Rope._Node) {
       assert(slots.lowerBound >= 0 && slots.upperBound <= node.childCount)
       let c = slots.count
@@ -352,6 +375,7 @@ extension Rope {
       _insertAfterTip(copy)
     }
 
+    @inlinable
     public mutating func finalize() -> Rope {
       // Integrate prefix & suffix chunks.
       if let suffixItem = self._suffix._take() {
@@ -390,6 +414,7 @@ extension Rope {
       return rope
     }
 
+    @inlinable
     public func _invariantCheck() {
 #if COLLECTIONS_INTERNAL_CHECKS
       var h = UInt8.max

diff --git a/Sources/RopeModule/Rope/Basics/Rope+Debugging.swift b/Sources/RopeModule/Rope/Basics/Rope+Debugging.swift
@@ -14,19 +14,22 @@ import _CollectionsUtilities
 #endif
 
 extension Rope._UnmanagedLeaf: CustomStringConvertible {
-  var description: String {
+  @usableFromInline
+  internal var description: String {
     _addressString(for: _ref.toOpaque())
   }
 }
 
 extension Rope {
+  @inlinable
   public var _nodeCount: Int {
     _root?.nodeCount ?? 0
   }
 }
 
 extension Rope._Node {
-  var nodeCount: Int {
+  @inlinable
+  internal var nodeCount: Int {
     guard !isLeaf else { return 1 }
     return readInner { $0.children.reduce(into: 1) { $0 += $1.nodeCount } }
   }
@@ -47,7 +50,8 @@ extension Rope {
 }
 
 extension Rope._Node: CustomStringConvertible {
-  var description: String {
+  @usableFromInline
+  internal var description: String {
         """
         \(height > 0 ? "Inner@\(height)" : "Leaf")(\
         at: \(_addressString(for: object)), \
@@ -58,6 +62,7 @@ extension Rope._Node: CustomStringConvertible {
 }
 
 extension Rope._Node {
+  @usableFromInline
   internal func dump(
     heightLimit: Int = .max,
     firstPrefix: String = "",

diff --git a/Sources/RopeModule/Rope/Basics/Rope+Invariants.swift b/Sources/RopeModule/Rope/Basics/Rope+Invariants.swift
@@ -10,6 +10,7 @@
 //===----------------------------------------------------------------------===//
 
 extension Rope {
+  @inlinable @inline(__always)
   public func _invariantCheck() {
 #if COLLECTIONS_INTERNAL_CHECKS
     _root?.invariantCheck(depth: 0, height: root.height, recursive: true)
@@ -18,8 +19,9 @@ extension Rope {
 }
 
 extension Rope._Node {
-  func invariantCheck(depth: UInt8, height: UInt8, recursive: Bool = true) {
 #if COLLECTIONS_INTERNAL_CHECKS
+  @usableFromInline
+  internal func invariantCheck(depth: UInt8, height: UInt8, recursive: Bool = true) {
     precondition(height == self.height, "Mismatching rope height")
     if isLeaf {
       precondition(self.childCount <= Summary.maxNodeSize, "Oversized leaf")
@@ -58,6 +60,11 @@ extension Rope._Node {
         child.invariantCheck(depth: depth + 1, height: height - 1, recursive: true)
       }
     }
-#endif
   }
+#else
+  @inlinable @inline(__always)
+  internal func invariantCheck(depth: UInt8, height: UInt8, recursive: Bool = true) {
+    // Do nothing.
+  }
+#endif
 }