[stdlib] UnicodeStorage => _UnicodeViews

Author: Dave Abrahams

stdlib/public/core/AnyUnicode.swift

@@ -84,8 +84,8 @@ where
   CodeUnits.SubSequence.Index == CodeUnits.Index,
   CodeUnits.SubSequence.SubSequence == CodeUnits.SubSequence,
   CodeUnits.SubSequence.Iterator.Element == CodeUnits.Iterator.Element {
-  var characters: UnicodeStorage<CodeUnits,Encoding>.CharacterView {
-    return UnicodeStorage(codeUnits).characters
+  var characters: _UnicodeViews<CodeUnits,Encoding>.CharacterView {
+    return _UnicodeViews(codeUnits).characters
   }
 }
 
@@ -121,10 +121,10 @@ where
   CodeUnits.SubSequence.Iterator.Element == CodeUnits.Iterator.Element {
 
   var unicodeScalars: LazyMapBidirectionalCollection<
-    UnicodeStorage<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
+    _UnicodeViews<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
   , UnicodeScalar
   > {
-    return UnicodeStorage(codeUnits, Encoding.self)
+    return _UnicodeViews(codeUnits, Encoding.self)
       .scalarsTranscoded(to: UTF32.self)
       .lazy.map { UnicodeScalar($0) }
   }
@@ -234,8 +234,8 @@ where Encoding.EncodedScalar == UTF16.EncodedScalar,
   // this result—and maybe other nice properties—in the type system.  So maybe
   // this thing should conform to _FixedFormatUnicode
   var fccNormalizedUTF16
-  : UnicodeStorage<CodeUnits,Encoding>.FCCNormalizedUTF16View {
-    return UnicodeStorage(codeUnits, Encoding.self).fccNormalizedUTF16
+  : _UnicodeViews<CodeUnits,Encoding>.FCCNormalizedUTF16View {
+    return _UnicodeViews(codeUnits, Encoding.self).fccNormalizedUTF16
   }
 
   var rawUTF16 : CodeUnits {

stdlib/public/core/CMakeLists.txt

@@ -140,7 +140,7 @@ set(SWIFTLIB_ESSENTIAL
   Unicode.swift
   Unicode2.swift
   UnicodeScalar.swift
-  UnicodeStorage.swift
+  UnicodeViews.swift
   UnicodeTrie.swift.gyb
   Unmanaged.swift
   UnsafeBitMap.swift

stdlib/public/core/GroupInfo.json

@@ -28,7 +28,7 @@
     "Unicode.swift",
     "Unicode2.swift",
     "UnicodeScalar.swift",
-    "UnicodeStorage.swift",
+    "UnicodeViews.swift",
     "UnicodeTrie.swift",
     "UnavailableStringAPIs.swift"
   ],

stdlib/public/core/StringStorage.swift

@@ -135,14 +135,14 @@ extension _UTF16StringStorage : _FixedFormatUnicode {
   // WORKAROUND: helping type inference along will be unnecessary someday
   public typealias RawUTF16View = _UTF16StringStorage
   public typealias CodeUnits = _UTF16StringStorage
-  public typealias FCCNormalizedUTF16View = UnicodeStorage<
+  public typealias FCCNormalizedUTF16View = _UnicodeViews<
     CodeUnits, Encoding
   >.FCCNormalizedUTF16View
 
-  public typealias CharacterView = UnicodeStorage<CodeUnits,Encoding>.CharacterView
+  public typealias CharacterView = _UnicodeViews<CodeUnits,Encoding>.CharacterView
 
   public typealias UnicodeScalarView = LazyMapBidirectionalCollection<
-    UnicodeStorage<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
+    _UnicodeViews<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
   , UnicodeScalar
   >
 
@@ -301,7 +301,7 @@ extension _UTF16StringStorage : _FixedFormatUnicode {
 
       self.init(count: count)
       withUnsafeMutableBufferPointer {
-        UnicodeStorage(
+        _UnicodeViews(
           other.codeUnits, Other.Encoding.self).transcoded(
           to: UTF16.self
         )._copyCompleteContents(initializing: $0)
@@ -469,25 +469,25 @@ extension _UTF8StringStorage : _FixedFormatUnicode {
   // WORKAROUND: helping type inference along will be unnecessary someday
   public typealias CodeUnits = _UTF8StringStorage
 
-  public typealias RawUTF16View = UnicodeStorage<
+  public typealias RawUTF16View = _UnicodeViews<
     CodeUnits, Encoding
   >.TranscodedView<UTF16>
 
-  public typealias FCCNormalizedUTF16View = UnicodeStorage<
+  public typealias FCCNormalizedUTF16View = _UnicodeViews<
     CodeUnits, Encoding
   >.FCCNormalizedUTF16View
 
-  public typealias CharacterView = UnicodeStorage<CodeUnits,Encoding>.CharacterView
+  public typealias CharacterView = _UnicodeViews<CodeUnits,Encoding>.CharacterView
 
   public typealias UnicodeScalarView = LazyMapBidirectionalCollection<
-    UnicodeStorage<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
+    _UnicodeViews<CodeUnits,Encoding>.ScalarsTranscoded<UTF32>
   , UnicodeScalar
   >
 
   public var codeUnits: CodeUnits { return self }
   public var rawUTF16: RawUTF16View { return RawUTF16View(self) }
   public var fccNormalizedUTF16: FCCNormalizedUTF16View {
-    return UnicodeStorage(self, UTF8.self).fccNormalizedUTF16
+    return _UnicodeViews(self, UTF8.self).fccNormalizedUTF16
   }
 }
 

stdlib/public/core/UnicodeStorage.swift renamed to stdlib/public/core/UnicodeViews.swift

@@ -1,4 +1,4 @@
-//===--- UnicodeStorage.swift ---------------------------------------------===//
+//===--- UnicodeViews.swift -----------------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -32,12 +32,12 @@ internal func __swift_stdlib_U_FAILURE(_ x: __swift_stdlib_UErrorCode) -> Bool {
 
 /// A collection of `CodeUnit`s to be interpreted by some `Encoding`.
 ///
-/// View types nested in UnicodeStorage may be suitable *generic* implementation
+/// View types nested in _UnicodeViews may be suitable *generic* implementation
 /// guts for views for models of Unicode, but specific models may want to
 /// provide their own implementations.  For example, the UTF16 view of a
 /// Latin1String would might be a simple lazy zero-extended mapping, rather than
 /// something that goes through the transcoding machinery.
-public struct UnicodeStorage<
+public struct _UnicodeViews<
   CodeUnits : RandomAccessCollection,
   Encoding : UnicodeEncoding
 >
@@ -54,15 +54,15 @@ where Encoding.EncodedScalar.Iterator.Element == CodeUnits.Iterator.Element,
   public var codeUnits: CodeUnits
 }
 
-/// A straightforward typealias for _UnicodeStorage
+/// A straightforward typealias for _UnicodeViews
 ///
 /// Use this to escape the automatic deduction of the generic arguments given
-/// the name `UnicodeStorage` from within nested contexts
+/// the name `_UnicodeViews` from within nested contexts
 /// (https://bugs.swift.org/browse/SR-4155).
-internal typealias _UnicodeStorage<
+internal typealias _UnicodeViews_<
   CodeUnits : RandomAccessCollection,
   Encoding : UnicodeEncoding
->  = UnicodeStorage<CodeUnits, Encoding>
+>  = _UnicodeViews<CodeUnits, Encoding>
 where Encoding.EncodedScalar.Iterator.Element == CodeUnits.Iterator.Element,
   CodeUnits.SubSequence : RandomAccessCollection,
   CodeUnits.SubSequence.Index == CodeUnits.Index,
@@ -71,7 +71,7 @@ CodeUnits.SubSequence.Iterator.Element == CodeUnits.Iterator.Element
 
 /// A lazy collection of `Encoding.EncodedScalar` that results
 /// from parsing an instance of codeUnits using that `Encoding`.
-extension UnicodeStorage {
+extension _UnicodeViews {
   public struct EncodedScalars {
     let codeUnits: CodeUnits
 
@@ -81,7 +81,7 @@ extension UnicodeStorage {
   }
 }
 
-extension UnicodeStorage.EncodedScalars {
+extension _UnicodeViews.EncodedScalars {
   // Because parsing produces a buffer and a new index, to avoid
   // repeatedly decoding the same data, this index stores that buffer
   // and the next index.  This would obviously be more complicated if
@@ -108,7 +108,7 @@ extension UnicodeStorage.EncodedScalars {
 }
 
 /// Collection Conformance
-extension UnicodeStorage.EncodedScalars : BidirectionalCollection {
+extension _UnicodeViews.EncodedScalars : BidirectionalCollection {
   public var startIndex: Index {
     if _slowPath(codeUnits.isEmpty) { return endIndex }
     let s = codeUnits.startIndex
@@ -177,15 +177,15 @@ extension UnicodeStorage.EncodedScalars : BidirectionalCollection {
   }
 }
 
-extension UnicodeStorage {
+extension _UnicodeViews {
   public typealias ScalarsTranscoded<ToEncoding : UnicodeEncoding>
   = LazyMapBidirectionalCollection<EncodedScalars, ToEncoding.EncodedScalar>
 
   public func scalarsTranscoded<ToEncoding : UnicodeEncoding>(
     to dst: ToEncoding.Type
   )
   -> ScalarsTranscoded<ToEncoding> {
-    return UnicodeStorage.EncodedScalars(codeUnits, Encoding.self).lazy.map {
+    return _UnicodeViews.EncodedScalars(codeUnits, Encoding.self).lazy.map {
       dst.encode($0)!
     }
   }
@@ -201,7 +201,7 @@ extension UnicodeStorage {
     // Instead, we wrap an instance of Base.
     public typealias Base = FlattenBidirectionalCollection<
       LazyMapBidirectionalCollection<
-        UnicodeStorage<CodeUnits, FromEncoding>.EncodedScalars,
+        _UnicodeViews<CodeUnits, FromEncoding>.EncodedScalars,
         ToEncoding.EncodedScalar
       >
     >
@@ -211,7 +211,7 @@ extension UnicodeStorage {
       from src: FromEncoding.Type = FromEncoding.self,
       to dst: ToEncoding.Type = ToEncoding.self
     ) {
-      base = Base(UnicodeStorage(codeUnits).scalarsTranscoded(to: dst))
+      base = Base(_UnicodeViews(codeUnits).scalarsTranscoded(to: dst))
     }
 
     // FIXME: this should go in the extension below but for <rdar://30320012>
@@ -241,7 +241,7 @@ extension UnicodeStorage {
   }
 }
 
-extension UnicodeStorage : _UTextable {
+extension _UnicodeViews : _UTextable {
   internal func _nativeLength(_ uText: inout _UText) -> Int64 {
     uText.validate()
     return codeUnits.count^
@@ -250,15 +250,15 @@ extension UnicodeStorage : _UTextable {
   internal func _parsedSlice(
     _ offset: Int64,
     _ slice: (CodeUnits.Index) -> CodeUnits.SubSequence
-  ) -> UnicodeStorage<CodeUnits.SubSequence,Encoding>.EncodedScalars.SubSequence {
-    return _UnicodeStorage(
+  ) -> _UnicodeViews<CodeUnits.SubSequence,Encoding>.EncodedScalars.SubSequence {
+    return _UnicodeViews_(
       slice(codeUnits.index(atOffset: offset)), Encoding.self
     ).scalars.dropFirst(0)
   }
 
   internal func _parsedSuffix(
     fromOffset offset: Int64
-  ) -> UnicodeStorage<CodeUnits.SubSequence,Encoding>.EncodedScalars.SubSequence {
+  ) -> _UnicodeViews<CodeUnits.SubSequence,Encoding>.EncodedScalars.SubSequence {
     return _parsedSlice(offset, codeUnits.suffix(from:))
   }
 
@@ -381,7 +381,7 @@ extension UnicodeStorage : _UTextable {
       // the generic TranscodedView, which is likely to be less efficient in
       // some common cases.
       let source
-        = _UnicodeStorage(base, Encoding.self).transcoded(to: UTF16.self)
+        = _UnicodeViews_(base, Encoding.self).transcoded(to: UTF16.self)
       var d = destination // copy due to https://bugs.swift.org/browse/SR-3782
       let (limit, remainder) = d.copy(from: source)
 
@@ -426,26 +426,26 @@ extension UnicodeStorage : _UTextable {
       ..<
       codeUnits.index(atOffset: nativeIndex)]
 
-    return _UnicodeStorage(
+    return _UnicodeViews_(
       nativeChunk, Encoding.self).transcoded(to: UTF16.self).count^
   }
 }
 
-extension UnicodeStorage {
+extension _UnicodeViews {
   public var scalars: EncodedScalars {
     return EncodedScalars(codeUnits, Encoding.self)
   }
 }
 
-extension UnicodeStorage {
+extension _UnicodeViews {
 
   public struct CharacterView : BidirectionalCollection {
 
     public init(_ codeUnits: CodeUnits, _: Encoding.Type = Encoding.self) {
-      self.storage = UnicodeStorage(codeUnits)
+      self.storage = _UnicodeViews(codeUnits)
     }
 
-    internal let storage: UnicodeStorage
+    internal let storage: _UnicodeViews
 
     public typealias SubSequence = BidirectionalSlice<CharacterView>
 
@@ -455,7 +455,7 @@ extension UnicodeStorage {
 
     public subscript(i: Index) -> Character {
       let j = index(after: i)
-      let contents = UnicodeStorage<
+      let contents = _UnicodeViews<
                        // explicit generic parameters shouldn't be needed
                        // <rdar://problem/30882312>
                        CodeUnits.SubSequence,Encoding
@@ -532,7 +532,7 @@ internal func _makeFCCNormalizer() -> OpaquePointer {
 
 internal var _fccNormalizer = _makeFCCNormalizer()
 
-extension UnicodeStorage {
+extension _UnicodeViews {
 
   public typealias FCCNormalizedUTF16View = [UInt16]
 

test/Prototypes/AnyUnicode.swift

@@ -13,8 +13,8 @@
 // REQUIRES: executable_test
 
 extension _UTF16StringStorage {
-  var characters: UnicodeStorage<_UTF16StringStorage, UTF16>.CharacterView {
-    return UnicodeStorage(self, UTF16.self).characters
+  var characters: _UnicodeViews<_UTF16StringStorage, UTF16>.CharacterView {
+    return _UnicodeViews(self, UTF16.self).characters
   }
 }
 
@@ -634,7 +634,7 @@ Self.CharacterView.Index : SignedInteger
   // FIXME: this could be more efficient for encodings such as Latin1
   var utf32: AnyUnicodeBidirectionalUInt32 {
       return AnyUnicodeBidirectionalUInt32(
-      UnicodeStorage(
+      _UnicodeViews(
         _codeUnits, Encoding.self
       ).transcoded(to: UTF32.self)
     )
@@ -917,7 +917,7 @@ extension AnyStringContents : AnyUnicode {
     switch self {
     case .utf16(let storage):
       return AnyUnicodeBidirectionalUInt32(
-        UnicodeStorage(storage, UTF16.self).transcoded(to: UTF32.self)
+        _UnicodeViews(storage, UTF16.self).transcoded(to: UTF32.self)
       )
     case .latin1(let storage):
       return AnyUnicodeBidirectionalUInt32(storage)

test/Prototypes/string_prototype/CanonicalString.swift

@@ -6,7 +6,7 @@ struct SwiftCanonicalString {
   typealias Element = UInt16
   typealias CodeUnits = _StringBuffer<_UTF16StringStorage>
   typealias Encoding = UTF16
-  typealias Storage = UnicodeStorage<CodeUnits, Encoding>
+  typealias Storage = _UnicodeViews<CodeUnits, Encoding>
   var _storage: Storage
 
   // Always set at construction time, conservatively updated at modification
@@ -21,24 +21,24 @@ struct SwiftCanonicalString {
 
   // transcode and store the supplied code units
   init<OtherCodeUnits, OtherEncoding>(
-    _ other: UnicodeStorage<OtherCodeUnits, OtherEncoding>
+    _ other: _UnicodeViews<OtherCodeUnits, OtherEncoding>
   )
   // FIXME: when new integers land, we won't need this constraint anymore.
   where OtherCodeUnits.Iterator.Element : UnsignedInteger
   {
-    self._storage = UnicodeStorage(
+    self._storage = _UnicodeViews(
       CodeUnits(_UTF16StringStorage(utf16CodeUnitValues: other.transcoded(to: UTF16.self))))
   }
 
   init() {
-    self._storage = UnicodeStorage(CodeUnits(), Encoding.self)
+    self._storage = _UnicodeViews(CodeUnits(), Encoding.self)
     // Empty strings have all the encodings!
     self.isKnownASCII = true
     self.isKnownLatin1 = true
   }
 
   init(uninitializedCount count: Int) {
-    self._storage = UnicodeStorage(
+    self._storage = _UnicodeViews(
       CodeUnits(_uninitializedCount: count, minimumCapacity: count), 
       Encoding.self)
     self.isKnownASCII = true
@@ -63,7 +63,7 @@ extension SwiftCanonicalString {
   // FIXME: when new integers land, we won't need this constraint anymore.
   , OtherCodeUnits.Iterator.Element : UnsignedInteger
   {
-    self.init(UnicodeStorage(codeUnits, otherEncoding))
+    self.init(_UnicodeViews(codeUnits, otherEncoding))
   }
 }