Merge pull request #838 from austinzheng/az-port-mirror

Migrate mirrors to use CustomReflectable API, rewrite dump()

...and there was much rejoicing.

Author: Dave Abrahams

stdlib/public/SDK/AppKit/AppKit.swift

@@ -13,94 +13,39 @@
 import Foundation
 @_exported import AppKit
 
-struct _NSCursorMirror : _MirrorType {
-  var _value: NSCursor
-
-  init(_ v: NSCursor) { _value = v }
-
-  var value: Any { return _value }
-
-  var valueType: Any.Type { return (_value as Any).dynamicType }
-
-  var objectIdentifier: ObjectIdentifier? { return .None }
-
-  var count: Int { return 0 }
-
-  subscript(_: Int) -> (String, _MirrorType) {
-    _preconditionFailure("_MirrorType access out of bounds")
+extension NSCursor : CustomPlaygroundQuickLookable {
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Image(image)
   }
-
-  var summary: String { return "" }
-
-  var quickLookObject: PlaygroundQuickLook? {
-    return .Some(.Image(_value.image))
-  }
-  
-  var disposition : _MirrorDisposition { return .Aggregate }
 }
 
-extension NSCursor : _Reflectable {
-  public func _getMirror() -> _MirrorType {
-    return _NSCursorMirror(self)
-  }
+internal struct _NSViewQuickLookState {
+  static var views = Set<NSView>()
 }
 
-struct _NSViewMirror : _MirrorType {
-  static var _views = Set<NSView>()
-
-  var _v : NSView
-  
-  init(_ v : NSView) { _v = v }
-  
-  var value: Any { return _v }
-  
-  var valueType: Any.Type { return (_v as Any).dynamicType }
-  
-  var objectIdentifier: ObjectIdentifier? { return .None }
-  
-  var count: Int { return 0 }
-  
-  subscript(_: Int) -> (String, _MirrorType) {
-    _preconditionFailure("_MirrorType access out of bounds")
-  }
-  
-  var summary: String { return "" }
-  
-  var quickLookObject: PlaygroundQuickLook? {
-    // adapted from the Xcode QuickLooks implementation
-    
-    var result: PlaygroundQuickLook? = nil
-    
+extension NSView : CustomPlaygroundQuickLookable {
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
     // if you set NSView.needsDisplay, you can get yourself in a recursive scenario where the same view
     // could need to draw itself in order to get a QLObject for itself, which in turn if your code was
     // instrumented to log on-draw, would cause yourself to get back here and so on and so forth
     // until you run out of stack and crash
     // This code checks that we aren't trying to log the same view recursively - and if so just returns
-    // nil, which is probably a safer option than crashing
+    // an empty view, which is probably a safer option than crashing
     // FIXME: is there a way to say "cacheDisplayInRect butDoNotRedrawEvenIfISaidSo"?
-    if !_NSViewMirror._views.contains(_v) {
-      _NSViewMirror._views.insert(_v)
-      
-      let bounds = _v.bounds
-      if let b = _v.bitmapImageRepForCachingDisplayInRect(bounds) {
-        _v.cacheDisplayInRect(bounds, toBitmapImageRep: b)
-        result = .Some(.View(b))
+    if _NSViewQuickLookState.views.contains(self) {
+      return .View(NSImage())
+    } else {
+      _NSViewQuickLookState.views.insert(self)
+      let result : PlaygroundQuickLook
+      if let b = bitmapImageRepForCachingDisplayInRect(bounds) {
+        cacheDisplayInRect(bounds, toBitmapImageRep: b)
+        result = .View(b)
+      } else {
+        result = .View(NSImage())
       }
-      
-      _NSViewMirror._views.remove(_v)
+      _NSViewQuickLookState.views.remove(self)
+      return result
     }
-    
-    return result
-    
-  }
-  
-  var disposition : _MirrorDisposition { return .Aggregate }
-}
-
-extension NSView : _Reflectable {
-  /// Returns a mirror that reflects `self`.
-  public func _getMirror() -> _MirrorType {
-    return _NSViewMirror(self)
   }
 }
 

stdlib/public/SDK/CoreGraphics/CGFloat.swift.gyb

@@ -145,10 +145,10 @@ public var CGFLOAT_MAX: CGFloat {
   fatalError("can't retrieve unavailable property")
 }
 
-extension CGFloat : _Reflectable {
+extension CGFloat : CustomReflectable {
   /// Returns a mirror that reflects `self`.
-  public func _getMirror() -> _MirrorType {
-    return _reflect(native)
+  public func customMirror() -> Mirror {
+    return Mirror(reflecting: native)
   }
 }
 

stdlib/public/SDK/CoreGraphics/CMakeLists.txt

@@ -1,7 +1,6 @@
 add_swift_library(swiftCoreGraphics IS_SDK_OVERLAY
   CoreGraphics.swift
   CGFloat.swift.gyb
-  CoreGraphicsMirrors.swift.gyb
   # rdar://problem/20891746
   # SWIFT_COMPILE_FLAGS -Xfrontend -sil-serialize-all
   SWIFT_MODULE_DEPENDS ObjectiveC Dispatch Darwin

stdlib/public/SDK/CoreGraphics/CoreGraphics.swift

@@ -39,6 +39,22 @@ public extension CGPoint {
   }
 }
 
+extension CGPoint : CustomReflectable, CustomPlaygroundQuickLookable {
+  public func customMirror() -> Mirror {
+    return Mirror(self, children: ["x": x, "y": y], displayStyle: .Struct)
+  }
+
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Point(Double(x), Double(y))
+  }
+}
+
+extension CGPoint : CustomDebugStringConvertible {
+  public var debugDescription : String {
+    return "(\(x), \(y))"
+  }
+}
+
 extension CGPoint : Equatable {}
 @_transparent // @fragile
 @warn_unused_result
@@ -68,6 +84,22 @@ public extension CGSize {
   }
 }
 
+extension CGSize : CustomReflectable, CustomPlaygroundQuickLookable {
+  public func customMirror() -> Mirror {
+    return Mirror(self, children: ["width": width, "height": height], displayStyle: .Struct)
+  }
+
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Size(Double(width), Double(height))
+  }
+}
+
+extension CGSize : CustomDebugStringConvertible {
+  public var debugDescription : String {
+    return "(\(width), \(height))"
+  }
+}
+
 extension CGSize : Equatable {}
 @_transparent // @fragile
 @warn_unused_result
@@ -357,6 +389,22 @@ public extension CGRect {
   }
 }
 
+extension CGRect : CustomReflectable, CustomPlaygroundQuickLookable {
+  public func customMirror() -> Mirror {
+    return Mirror(self, children: ["origin": origin, "size": size], displayStyle: .Struct)
+  }
+
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Rectangle(Double(origin.x), Double(origin.y), Double(size.width), Double(size.height))
+  }
+}
+
+extension CGRect : CustomDebugStringConvertible {
+  public var debugDescription : String {
+    return "(\(origin.x), \(origin.y), \(size.width), \(size.height))"
+  }
+}
+
 extension CGRect : Equatable {}
 @_transparent // @fragile
 @warn_unused_result

stdlib/public/SDK/CoreGraphics/CoreGraphicsMirrors.swift.gyb

@@ -42,10 +42,10 @@ public struct DarwinBoolean : BooleanType, BooleanLiteralConvertible {
   }
 }
 
-extension DarwinBoolean : _Reflectable {
+extension DarwinBoolean : CustomReflectable {
   /// Returns a mirror that reflects `self`.
-  public func _getMirror() -> _MirrorType {
-    return _reflect(boolValue)
+  public func customMirror() -> Mirror {
+    return Mirror(reflecting: boolValue)
   }
 }
 

stdlib/public/SDK/Darwin/Darwin.swift

@@ -1,6 +1,5 @@
 add_swift_library(swiftFoundation IS_SDK_OVERLAY
   Foundation.swift
-  FoundationMirrors.swift.gyb
   NSError.swift
   NSStringAPI.swift
   NSValue.swift

stdlib/public/SDK/Foundation/CMakeLists.txt

@@ -1376,6 +1376,10 @@ extension NSKeyedUnarchiver {
   }
 }
 
+//===----------------------------------------------------------------------===//
+// NSURL
+//===----------------------------------------------------------------------===//
+
 extension NSURL : _FileReferenceLiteralConvertible {
   private convenience init(failableFileReferenceLiteral path: String) {
     let fullPath = NSBundle.mainBundle().pathForResource(path, ofType: nil)!
@@ -1388,3 +1392,62 @@ extension NSURL : _FileReferenceLiteralConvertible {
 }
 
 public typealias _FileReferenceLiteralType = NSURL
+
+//===----------------------------------------------------------------------===//
+// Mirror/Quick Look Conformance
+//===----------------------------------------------------------------------===//
+
+extension NSURL : CustomPlaygroundQuickLookable {
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .URL(absoluteString)
+  }
+}
+
+extension NSRange : CustomReflectable {
+  public func customMirror() -> Mirror {
+    return Mirror(self, children: ["location": location, "length": length])
+  }
+}
+
+extension NSRange : CustomPlaygroundQuickLookable {
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Range(Int64(location), Int64(length))
+  }
+}
+
+extension NSDate : CustomPlaygroundQuickLookable {
+  var summary: String {
+    let df = NSDateFormatter()
+    df.dateStyle = .MediumStyle
+    df.timeStyle = .ShortStyle
+    return df.stringFromDate(self)
+  }
+
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Text(summary)
+  }
+}
+
+extension NSSet : CustomReflectable {
+  public func customMirror() -> Mirror {
+    return Mirror(reflecting: _convertNSSetToSet(self) as Set<NSObject>)
+  }
+}
+
+extension NSString : CustomPlaygroundQuickLookable {
+  public func customPlaygroundQuickLook() -> PlaygroundQuickLook {
+    return .Text(self as String)
+  }
+}
+
+extension NSArray : CustomReflectable {
+  public func customMirror() -> Mirror {
+    return Mirror(reflecting: self as [AnyObject])
+  }
+}
+
+extension NSDictionary : CustomReflectable {
+  public func customMirror() -> Mirror {
+    return Mirror(reflecting: _convertNSDictionaryToDictionary(self) as [NSObject : AnyObject])
+  }
+}