[PlaygroundLogger] Began introducing limited error handling.

cwakamo · cwakamo · commit cffd4585258d · 2018-02-23T21:04:44.000-08:00
Made `CustomOpaqueLoggable` and `PlaygroundQuickLook.opaqueRepresentation()` into throwing operations, as converting to an opaque representation may fail.
This means that creating a `LogEntry` may fail outright if the subject cannot provide its opaque representation.
Further, that means that both structural log entries and `LogPacket` may now contain error log entries representing cases when generating the opaque representation fails.
Note that this is not full error handling, as many errors occur during the encoding process rather than during `LogEntry` generation.
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSBitmapImageRep+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSBitmapImageRep+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -14,7 +14,7 @@
     import AppKit
     
     extension NSBitmapImageRep: CustomOpaqueLoggable {
-        var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+        func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
             return ImageOpaqueRepresentation(kind: .image, backedBy: self)
         }
     }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSColor+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSColor+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -14,7 +14,7 @@
     import AppKit
     
     extension NSColor: CustomOpaqueLoggable {
-        var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+        func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
             return self.cgColor
         }
     }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSCursor+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSCursor+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -14,7 +14,7 @@
     import AppKit
     
     extension NSCursor: CustomOpaqueLoggable {
-        var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+        func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
             return ImageOpaqueRepresentation(kind: .image, backedBy: self.image)
         }
     }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSImage+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSImage+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -14,7 +14,7 @@
     import AppKit
     
     extension NSImage: CustomOpaqueLoggable {
-        var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+        func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
             return ImageOpaqueRepresentation(kind: .image, backedBy: self)
         }
     }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSView+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/AppKit/NSView+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -14,7 +14,7 @@
     import AppKit
     
     extension NSView: CustomOpaqueLoggable {
-        var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+        func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
             return ImageOpaqueRepresentation(kind: .view, backedBy: self)
         }
     }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreGraphics/CGFloat+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreGraphics/CGFloat+CustomOpaqueLoggable.swift
@@ -13,7 +13,7 @@
 import CoreGraphics
 
 extension CGFloat: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self.native
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreGraphics/CGImage+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreGraphics/CGImage+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -13,7 +13,7 @@
 import CoreGraphics
 
 extension CGImage: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return ImageOpaqueRepresentation(kind: .image, backedBy: self)
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreImage/CIColor+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreImage/CIColor+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -13,7 +13,7 @@
 import CoreImage
 
 extension CIColor: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() throws -> LogEntry.OpaqueRepresentation {
         guard let color = CGColor(colorSpace: self.colorSpace, components: self.components) else {
             loggingError("Unable to convert CIColor to CGColor")
         }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreImage/CIImage+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CoreImage/CIImage+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -20,7 +20,7 @@ import CoreGraphics
 #endif
 
 extension CIImage: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         if let cgImage = self.cgImage {
             return ImageOpaqueRepresentation(kind: .image, backedBy: cgImage)
         }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -11,11 +11,11 @@
 //===----------------------------------------------------------------------===//
 
 protocol CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation { get }
+    func opaqueRepresentation() throws -> LogEntry.OpaqueRepresentation
 }
 
 extension CustomOpaqueLoggable where Self: LogEntry.OpaqueRepresentation {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/Date+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/Date+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -20,13 +20,13 @@ fileprivate let dateLoggingFormatter: DateFormatter = {
 }()
 
 extension Date: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return dateLoggingFormatter.string(from: self)
     }
 }
 
 extension NSDate: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
-        return (self as Date).opaqueRepresentation
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
+        return (self as Date).opaqueRepresentation()
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/NSNumber+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/NSNumber+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -13,7 +13,7 @@
 import Foundation
 
 extension NSNumber: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         switch UInt8(self.objCType.pointee) {
         case UInt8(ascii: "c"), UInt8(ascii: "s"), UInt8(ascii: "i"), UInt8(ascii: "l"), UInt8(ascii: "q"):
             return self.int64Value
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/NSString+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/NSString+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -13,7 +13,7 @@
 import Foundation
 
 extension NSString: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self as String
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/URL+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Foundation/URL+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -15,7 +15,7 @@ import Foundation
 extension URL: CustomOpaqueLoggable {}
 
 extension NSURL: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self as URL
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/SpriteKit/SpriteKitOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/SpriteKit/SpriteKitOpaqueLoggable.swift
@@ -30,7 +30,7 @@ extension SpriteKitOpaqueLoggable {
         encoder.encode(data: imageData)
     }
     
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return ImageOpaqueRepresentation(kind: .sprite, backedBy: self)
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/Integers+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/Integers+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -11,51 +11,51 @@
 //===----------------------------------------------------------------------===//
 
 extension Int: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return Int64(self)
     }
 }
 
 extension Int8: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return Int64(self)
     }
 }
 
 extension Int16: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return Int64(self)
     }
 }
 
 extension Int32: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return Int64(self)
     }
 }
 
 extension Int64: CustomOpaqueLoggable {}
 
 extension UInt: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return UInt64(self)
     }
 }
 
 extension UInt8: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return UInt64(self)
     }
 }
 
 extension UInt16: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return UInt64(self)
     }
 }
 
 extension UInt32: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return UInt64(self)
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/String+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/String+CustomOpaqueLoggable.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2017 Apple Inc. and the Swift project authors
+// Copyright (c) 2017-2018 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See http://swift.org/LICENSE.txt for license information
@@ -13,31 +13,31 @@
 extension String: CustomOpaqueLoggable {}
 
 extension Character: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return String(self)
     }
 }
 
 extension UnicodeScalar: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return UInt64(self)
     }
 }
 
 extension String.UnicodeScalarView: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self.description
     }
 }
 
 extension String.UTF16View: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self.description
     }
 }
 
 extension String.UTF8View: CustomOpaqueLoggable {
-    var opaqueRepresentation: LogEntry.OpaqueRepresentation {
+    func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {
         return self.description
     }
 }
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/UnsafePointers+CustomPlaygroundLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/Swift/UnsafePointers+CustomPlaygroundLoggable.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIColor+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIColor+CustomOpaqueLoggable.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIImage+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIImage+CustomOpaqueLoggable.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIView+CustomOpaqueLoggable.swift b/PlaygroundLogger/PlaygroundLogger/CustomLoggable/UIKit/UIView+CustomOpaqueLoggable.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/LegacySupport/PlaygroundQuickLook+OpaqueRepresentationSupport.swift b/PlaygroundLogger/PlaygroundLogger/LegacySupport/PlaygroundQuickLook+OpaqueRepresentationSupport.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/LogEntry+Reflection.swift b/PlaygroundLogger/PlaygroundLogger/LogEntry+Reflection.swift
diff --git a/PlaygroundLogger/PlaygroundLogger/LogPacket.swift b/PlaygroundLogger/PlaygroundLogger/LogPacket.swift
diff --git a/PlaygroundLogger/PlaygroundLoggerTests/LogPolicyTests.swift b/PlaygroundLogger/PlaygroundLoggerTests/LogPolicyTests.swift

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`import CoreGraphics`
`14`	`14`
`15`	`15`	`extension CGFloat: CustomOpaqueLoggable {`
`16`		`- var opaqueRepresentation: LogEntry.OpaqueRepresentation {`
	`16`	`+ func opaqueRepresentation() -> LogEntry.OpaqueRepresentation {`
`17`	`17`	`return self.native`
`18`	`18`	`}`
`19`	`19`	`}`