Files
swift-mirror/test/Interop/Cxx/stdlib/overlay/custom-iterator-module-interface.swift
Egor Zhdan 041005af7c [cxx-interop] Use more correct type names in C++ template parameters
When importing a C++ class template instantiation, Swift translates the template parameter type names from C++ into their Swift equivalent.

For instance, `basic_string<wchar_t, char_traits<wchar_t>, allocator<wchar_t>>` gets imported as `basic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>`: `wchar_t` is imported as `CWideChar`, which is a typealias for `Scalar` on most platforms including Darwin. Notice that Swift goes through the `CWideChar` typealias on the specific platform. Another instantiation `basic_string<uint32_t, char_traits<uint32_t>, allocator<uint32_t>>` also gets imported as `basic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>`: `uint32_t` is also imported as `Scalar`. This is problematic because we have two distinct C++ types that have the same name in Swift.

This change makes sure Swift doesn't go through typealiases when emitting names of template parameters, so `wchar_t` would now get printed as `CWideChar`, `int` would get printed as `CInt`, etc.

This also encourages clients to use the correct type (`CInt`, `CWideChar`, etc) instead of relying on platform-specific typealiases.

rdar://115673622
2023-10-09 14:57:10 +01:00

147 lines
6.5 KiB
Swift

// RUN: %target-swift-ide-test -print-module -module-to-print=CustomSequence -source-filename=x -I %S/Inputs -enable-experimental-cxx-interop | %FileCheck %s
// CHECK: struct ConstIterator : UnsafeCxxInputIterator {
// CHECK: func successor() -> ConstIterator
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: ConstIterator, other: ConstIterator) -> Bool
// CHECK: }
// CHECK: struct ConstRACIterator : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: func successor() -> ConstRACIterator
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: typealias Distance = Int32
// CHECK: static func += (lhs: inout ConstRACIterator, v: ConstRACIterator.difference_type)
// CHECK: static func - (lhs: ConstRACIterator, other: ConstRACIterator) -> Int32
// CHECK: static func == (lhs: ConstRACIterator, other: ConstRACIterator) -> Bool
// CHECK: }
// CHECK: struct ConstRACIteratorRefPlusEq : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: func successor() -> ConstRACIterator
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: typealias Distance = Int32
// CHECK: static func += (lhs: inout ConstRACIteratorRefPlusEq, v: ConstRACIteratorRefPlusEq.difference_type)
// CHECK: static func - (lhs: ConstRACIteratorRefPlusEq, other: ConstRACIteratorRefPlusEq) -> Int32
// CHECK: static func == (lhs: ConstRACIteratorRefPlusEq, other: ConstRACIteratorRefPlusEq) -> Bool
// CHECK: }
// CHECK: struct ConstIteratorOutOfLineEq : UnsafeCxxInputIterator {
// CHECK: func successor() -> ConstIteratorOutOfLineEq
// CHECK: var pointee: Int32 { get }
// CHECK: }
// CHECK: func == (lhs: ConstIteratorOutOfLineEq, rhs: ConstIteratorOutOfLineEq) -> Bool
// CHECK: struct MinimalIterator : UnsafeCxxInputIterator {
// CHECK: func successor() -> MinimalIterator
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: MinimalIterator, other: MinimalIterator) -> Bool
// CHECK: }
// CHECK: struct ForwardIterator : UnsafeCxxInputIterator {
// CHECK: func successor() -> ForwardIterator
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: ForwardIterator, other: ForwardIterator) -> Bool
// CHECK: }
// CHECK: struct HasCustomIteratorTag : UnsafeCxxInputIterator {
// CHECK: func successor() -> HasCustomIteratorTag
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: HasCustomIteratorTag, other: HasCustomIteratorTag) -> Bool
// CHECK: }
// CHECK: struct HasCustomRACIteratorTag : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: func successor() -> HasCustomRACIteratorTag
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: typealias Distance = Int32
// CHECK: static func += (lhs: inout HasCustomRACIteratorTag, x: Int32)
// CHECK: static func - (lhs: HasCustomRACIteratorTag, x: HasCustomRACIteratorTag) -> Int32
// CHECK: static func == (lhs: HasCustomRACIteratorTag, other: HasCustomRACIteratorTag) -> Bool
// CHECK: }
// CHECK: struct HasCustomIteratorTagInline : UnsafeCxxInputIterator {
// CHECK: func successor() -> HasCustomIteratorTagInline
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: HasCustomIteratorTagInline, other: HasCustomIteratorTagInline) -> Bool
// CHECK: }
// CHECK: struct HasTypedefIteratorTag : UnsafeCxxInputIterator {
// CHECK: func successor() -> HasTypedefIteratorTag
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: HasTypedefIteratorTag, other: HasTypedefIteratorTag) -> Bool
// CHECK: }
// CHECK-NOT: struct HasNoIteratorCategory : UnsafeCxxInputIterator
// CHECK-NOT: struct HasInvalidIteratorCategory : UnsafeCxxInputIterator
// CHECK-NOT: struct HasNoEqualEqual : UnsafeCxxInputIterator
// CHECK-NOT: struct HasInvalidEqualEqual : UnsafeCxxInputIterator
// CHECK-NOT: struct HasNoIncrementOperator : UnsafeCxxInputIterator
// CHECK-NOT: struct HasNoPreIncrementOperator : UnsafeCxxInputIterator
// CHECK-NOT: struct HasNoDereferenceOperator : UnsafeCxxInputIterator
// CHECK: struct TemplatedIterator<CInt> : UnsafeCxxInputIterator {
// CHECK: func successor() -> TemplatedIterator<CInt>
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: static func == (lhs: TemplatedIterator<CInt>, other: TemplatedIterator<CInt>) -> Bool
// CHECK: }
// CHECK: struct TemplatedIteratorOutOfLineEq<CInt> : UnsafeCxxInputIterator {
// CHECK: func successor() -> TemplatedIteratorOutOfLineEq<CInt>
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: }
// CHECK: struct TemplatedRACIteratorOutOfLineEq<CInt> : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: func successor() -> TemplatedRACIteratorOutOfLineEq<CInt>
// CHECK: var pointee: Int32 { get }
// CHECK: typealias Pointee = Int32
// CHECK: typealias Distance = TemplatedRACIteratorOutOfLineEq<CInt>.difference_type
// CHECK: }
// CHECK: struct BaseIntIterator {
// CHECK: }
// CHECK: struct InheritedConstIterator : UnsafeCxxInputIterator {
// CHECK: }
// CHECK: struct InheritedTemplatedConstIterator<T> {
// CHECK: }
// CHECK: struct InheritedTemplatedConstIterator<CInt> : UnsafeCxxInputIterator {
// CHECK: }
// CHECK: struct InheritedTemplatedConstRACIterator<T> {
// CHECK: }
// CHECK: struct InheritedTemplatedConstRACIterator<CInt> : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: }
// CHECK: struct InheritedTemplatedConstRACIteratorOutOfLineOps<T> {
// CHECK: }
// CHECK: struct InheritedTemplatedConstRACIteratorOutOfLineOps<CInt> : UnsafeCxxRandomAccessIterator, UnsafeCxxInputIterator {
// CHECK: }
// CHECK: struct InputOutputIterator : UnsafeCxxMutableInputIterator {
// CHECK: func successor() -> InputOutputIterator
// CHECK: var pointee: Int32
// CHECK: typealias Pointee = Int32
// CHECK: }
// CHECK: struct InputOutputConstIterator : UnsafeCxxMutableInputIterator {
// CHECK: func successor() -> InputOutputConstIterator
// CHECK: var pointee: Int32 { get nonmutating set }
// CHECK: typealias Pointee = Int32
// CHECK: }
// CHECK: struct MutableRACIterator : UnsafeCxxMutableRandomAccessIterator, UnsafeCxxMutableInputIterator {
// CHECK: func successor() -> MutableRACIterator
// CHECK: var pointee: Int32
// CHECK: typealias Pointee = Int32
// CHECK: typealias Distance = Int32
// CHECK: }