swift-mirror/test/stdlib/DebuggerSupport.swift

// RUN: %target-run-simple-swift
// REQUIRES: executable_test
// REQUIRES: optimized_stdlib
// REQUIRES: reflection

import StdlibUnittest

struct StructWithMembers {
  var a = 1
  var b = "Hello World"
}

struct StructIsNonCopyable: ~Copyable {
  var a = 1
  var b = "Hello World"
}

struct StructWithMembersAndDescription: CustomStringConvertible {
  var a = 1
  var description: String { "Hello World" }
}

class ClassWithMembers {
  var a = 1
  var b = "Hello World"
}

class ClassWithMirror: CustomReflectable {
  var customMirror: Mirror {
    return Mirror(self, children: ["a" : 1, "b" : "Hello World"])
  }
}

#if _runtime(_ObjC)
struct DontBridgeThisStruct {
  var message = "Hello World"
}

extension DontBridgeThisStruct : _ObjectiveCBridgeable {
  typealias _ObjectiveCType = AnyObject

  func _bridgeToObjectiveC() -> _ObjectiveCType {
    fatalError("tried to bridge DontBridgeThisStruct")
  }

  static func _forceBridgeFromObjectiveC(
    _ source: _ObjectiveCType,
    result: inout DontBridgeThisStruct?
  ) {
    result = nil
  }

  static func _conditionallyBridgeFromObjectiveC(
    _ source: _ObjectiveCType,
    result: inout DontBridgeThisStruct?
  ) -> Bool {
    result = nil
    return false
  }

  static func _unconditionallyBridgeFromObjectiveC(_ source: _ObjectiveCType?)
      -> DontBridgeThisStruct {
    return DontBridgeThisStruct()
  }
}
#endif

let StringForPrintObjectTests = TestSuite("StringForPrintObject")
StringForPrintObjectTests.test("StructWithMembers") {
  let printed = _stringForPrintObject(StructWithMembers())
  expectEqual(printed, "▿ StructWithMembers\n  - a : 1\n  - b : \"Hello World\"\n")
}

StringForPrintObjectTests.test("StructWithMembersAndDescription") {
  let printed = _stringForPrintObject(StructWithMembersAndDescription())
  expectEqual(printed, "Hello World\n")
}

#if _runtime(_ObjC)
StringForPrintObjectTests.test("ClassWithMembers") {
  let printed = _stringForPrintObject(ClassWithMembers())
  expectTrue(printed.hasPrefix("<ClassWithMembers: 0x"))
}
#endif

StringForPrintObjectTests.test("ClassWithMirror") {
  let printed = _stringForPrintObject(ClassWithMirror())
  expectEqual(printed, "▿ ClassWithMirror\n  - a : 1\n  - b : \"Hello World\"\n")
}

StringForPrintObjectTests.test("Array") {
  let printed = _stringForPrintObject([1,2,3,4])
  expectEqual(printed, "▿ 4 elements\n  - 0 : 1\n  - 1 : 2\n  - 2 : 3\n  - 3 : 4\n")
}

StringForPrintObjectTests.test("Dictionary") {
  let printed = _stringForPrintObject([1:2])
  expectEqual("▿ 1 element\n  ▿ 0 : 2 elements\n    - key : 1\n    - value : 2\n",
              printed)
}

StringForPrintObjectTests.test("NilOptional") {
  let printed = _stringForPrintObject(nil as Int?)
  expectEqual(printed, "nil\n")
}

StringForPrintObjectTests.test("SomeOptional") {
  let printed = _stringForPrintObject(3 as Int?)
  expectEqual(printed, "▿ Optional<Int>\n  - some : 3\n")
}

#if _runtime(_ObjC)
StringForPrintObjectTests.test("DontBridgeThisStruct") {
  let printed = _stringForPrintObject(DontBridgeThisStruct())
  expectEqual(printed, "▿ DontBridgeThisStruct\n  - message : \"Hello World\"\n")
}
#endif

if #available(SwiftStdlib 6.1, *) {
  StringForPrintObjectTests.test("String") {
    let printed = _stringForPrintObject("hello\nworld")
    expectEqual(printed, "hello\nworld\n")
  }
}

@available(SwiftStdlib 6.3, *)
func _expectStringForPrintObject<T>(_ pointer: UnsafePointer<T>, output: String) {
  guard let mangledTypeName = _mangledTypeName(T.self) else {
    expectTrue(false)
    return
  }
  let (success, printed) =
    _DebuggerSupport.stringForPrintObject(UnsafeRawPointer(pointer), mangledTypeName: mangledTypeName)
  expectTrue(success)
  expectEqual(printed, output)
}

if #available(SwiftStdlib 6.3, *) {
  StringForPrintObjectTests.test("PointerWithMangledTypeName") {
    var num = 33
    _expectStringForPrintObject(&num, output: "33\n")

    var val1 = StructWithMembers()
    _expectStringForPrintObject(&val1, output: "▿ StructWithMembers\n  - a : 1\n  - b : \"Hello World\"\n")

    var val2: StructWithMembers? = StructWithMembers()
    _expectStringForPrintObject(&val2,
      output: "▿ Optional<StructWithMembers>\n  ▿ some : StructWithMembers\n    - a : 1\n    - b : \"Hello World\"\n")

    do {
      var val3 = StructIsNonCopyable()
      if let mangledTypeName = _mangledTypeName(StructIsNonCopyable.self) {
        withUnsafeBytes(of: &val3) { bytes in
          guard let pointer = bytes.baseAddress else {
            expectTrue(false)
            return
          }
          let (success, printed) =
            _DebuggerSupport.stringForPrintObject(pointer, mangledTypeName: mangledTypeName)
          expectFalse(success)
          expectEqual(printed, "type not found for mangled name: \(mangledTypeName)")
        }
      } else {
        expectTrue(false)
      }
    }

    do {
      let obj = ClassWithMembers()
      if let mangledTypeName = _mangledTypeName(ClassWithMembers.self) {
        withExtendedLifetime(obj) { obj in
          let pointer = unsafeBitCast(obj, to: UnsafeRawPointer.self)
          let (success, printed) = _DebuggerSupport.stringForPrintObject(pointer, mangledTypeName: mangledTypeName)
          expectTrue(success)
          expectTrue(printed.hasPrefix("<ClassWithMembers: 0x"))
        }
      } else {
        expectTrue(false)
      }
    }
  }
}

class RefCountedObj {
  var patatino : Int
  init(_ p : Int) {
    self.patatino = p
  }
  public func f() -> Int {
    return self.patatino
  }
}

let RefcountTests = TestSuite("RefCount")
RefcountTests.test("Basic") {
  var Obj = RefCountedObj(47);

  // Counters for live objects should be always positive.
  // We try to be a little bit more lax here because optimizations
  // or different stdlib versions might impact the exact value of
  // refcounting, and we're just interested in testing whether the
  // stub works properly.
  expectGT(_getRetainCount(Obj), 0);
  expectGT(_getWeakRetainCount(Obj), 0);
  expectGT(_getUnownedRetainCount(Obj), 0);

  // Try to keep the object live here.
  let _ = Obj.f()
}

runAllTests()