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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 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
//
//===----------------------------------------------------------------------===//
// Loosely adapted from https://github.com/apple/swift/tree/main/stdlib/private/StdlibCollectionUnittest
// FIXME: Port all of the collection validation tests from the Swift compiler codebase.
import XCTest
extension BidirectionalCollection {
func _indicesByIndexBefore() -> [Index] {
var result: [Index] = []
var i = endIndex
while i != startIndex {
i = index(before: i)
result.append(i)
}
result.reverse()
return result
}
func _indicesByFormIndexBefore() -> [Index] {
var result: [Index] = []
var i = endIndex
while i != startIndex {
formIndex(before: &i)
result.append(i)
}
result.reverse()
return result
}
}
public func checkBidirectionalCollection<C: BidirectionalCollection, S: Sequence>(
_ collection: C,
expectedContents: S,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where C.Element: Equatable, S.Element == C.Element {
checkBidirectionalCollection(
collection,
expectedContents: expectedContents,
by: ==,
maxSamples: maxSamples,
file: file,
line: line)
}
public func checkBidirectionalCollection<C: BidirectionalCollection, S: Sequence>(
_ collection: C,
expectedContents: S,
by areEquivalent: (S.Element, S.Element) -> Bool,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where S.Element == C.Element {
checkSequence(
{ collection }, expectedContents: expectedContents,
by: areEquivalent,
file: file, line: line)
_checkCollection(
collection, expectedContents: expectedContents,
by: areEquivalent,
maxSamples: maxSamples,
file: file, line: line)
_checkBidirectionalCollection(
collection, expectedContents: expectedContents,
by: areEquivalent,
maxSamples: maxSamples,
file: file, line: line)
}
public func _checkBidirectionalCollection_indexOffsetBy<
C: Collection
>(
_ collection: C,
expectedContents: [C.Element],
by areEquivalent: (C.Element, C.Element) -> Bool,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) {
var allIndices = collection._indicesByIndexAfter()
allIndices.append(collection.endIndex)
withSomeRanges(
"range",
in: 0 ..< allIndices.count - (1 as Int),
maxSamples: maxSamples
) { range in
let i = range.lowerBound
let j = range.upperBound
// Check `index(_,offsetBy:)` with negative offsets
let a = collection.index(allIndices[j], offsetBy: i - j)
expectEqual(a, allIndices[i])
if i < expectedContents.count {
expectEquivalent(
collection[a], expectedContents[i],
by: areEquivalent)
}
// Check `distance(from:to:)` with decreasing indices
let d = collection.distance(from: allIndices[j], to: allIndices[i])
expectEqual(d, i - j)
}
// Check `index(_,offsetBy:limitedBy:)`
let limits =
Set([0, allIndices.count - 1, allIndices.count / 2])
.sorted()
withEvery("limit", in: limits) { limit in
withEvery("i", in: 0 ..< allIndices.count) { i in
let min = -i - (limit <= i ? 2 : 0)
withEvery("delta", in: stride(from: 0, through: min, by: -1)) { delta in
let actual = collection.index(
allIndices[i],
offsetBy: delta,
limitedBy: allIndices[limit])
let j = i + delta
let expected = i < limit || j >= limit ? allIndices[j] : nil
expectEqual(actual, expected)
}
}
}
}
public func _checkBidirectionalCollection<C: BidirectionalCollection, S: Sequence>(
_ collection: C,
expectedContents: S,
by areEquivalent: (S.Element, S.Element) -> Bool,
maxSamples: Int? = nil,
file: StaticString = #file,
line: UInt = #line
) where S.Element == C.Element {
let entry = TestContext.current.push("checkBidirectionalCollection", file: file, line: line)
defer { TestContext.current.pop(entry) }
let expectedContents = Array(expectedContents)
// Check that `index(before:)` and `formIndex(before:)` are consistent with `index(after:)`.
let indicesByIndexAfter = collection._indicesByIndexAfter()
let indicesByIndexBefore = collection._indicesByIndexBefore()
let indicesByFormIndexBefore = collection._indicesByFormIndexBefore()
expectEqual(indicesByIndexBefore, indicesByIndexAfter)
expectEqual(indicesByFormIndexBefore, indicesByIndexAfter)
// Check contents using indexing.
let indexContents1 = indicesByIndexBefore.map { collection[$0] }
expectEquivalentElements(
indexContents1, expectedContents,
by: areEquivalent,
"\(expectedContents)")
let indexContents2 = indicesByFormIndexBefore.map { collection[$0] }
expectEquivalentElements(
indexContents2, expectedContents,
by: areEquivalent,
"\(expectedContents)")
// Check `distance(from:to:)`, `index(_:offsetBy)` and
// `index(_:offsetBy:limitedBy:)`.
_checkBidirectionalCollection_indexOffsetBy(
collection, expectedContents: expectedContents, by: areEquivalent)
var allIndices = indicesByIndexAfter
allIndices.append(collection.endIndex)
withSomeRanges(
"range",
in: 0 ..< allIndices.count - 1,
maxSamples: maxSamples
) { range in
let i = range.lowerBound
let j = range.upperBound
// Check slicing.
let slice = collection[allIndices[i] ..< allIndices[j]]
expectEqualElements(slice._indicesByIndexBefore(), allIndices[i ..< j])
expectEqualElements(slice._indicesByFormIndexBefore(), allIndices[i ..< j])
}
// Check the Indices associated type
if C.self != C.Indices.self && C.self != DefaultIndices<C>.self {
TestContext.current.withTrace("Indices") {
checkBidirectionalCollection(
collection.indices,
expectedContents: indicesByIndexAfter,
maxSamples: maxSamples)
}
}
}
|