[PlaygroundLogger] Implemented support for normalizing type names.

The legacy PlaygroundLogger stripped out the standard library's module prefix (e.g. `Swift.`) from type names when displaying them.
As a result, such support has been ported to the new PlaygroundLogger implementation.
Since generating type names and normalizing them is a costly operation, this includes caching of the type names.
To support this, a concurrent, lockless, insertion-only map implementation (based on the one used by the Swift runtime, but ported to Objective-C) has been added.

Author: cwakamo

PlaygroundLogger/PlaygroundLogger.xcodeproj/project.pbxproj

@@ -7,6 +7,9 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		5E184715202BB72700F01AD1 /* TypeName.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E184714202BB72700F01AD1 /* TypeName.swift */; };
+		5E184718202BB80200F01AD1 /* PGLConcurrentMap.h in Headers */ = {isa = PBXBuildFile; fileRef = 5E184716202BB80200F01AD1 /* PGLConcurrentMap.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		5E184719202BB80200F01AD1 /* PGLConcurrentMap_MRR.m in Sources */ = {isa = PBXBuildFile; fileRef = 5E184717202BB80200F01AD1 /* PGLConcurrentMap_MRR.m */; settings = {COMPILER_FLAGS = "-fno-objc-arc"; }; };
 		5E2646311FB64876002DC6B6 /* PlaygroundLogger.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5E2646271FB64876002DC6B6 /* PlaygroundLogger.framework */; };
 		5E2646381FB64876002DC6B6 /* PlaygroundLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = 5E26462A1FB64876002DC6B6 /* PlaygroundLogger.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		5E2646431FB64B2A002DC6B6 /* LoggerEntrypoints.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E2646421FB64B2A002DC6B6 /* LoggerEntrypoints.swift */; };
@@ -71,6 +74,7 @@
 		5E2756941FCF9CB000B69C83 /* SpriteKitOpaqueLoggable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E2756931FCF9CB000B69C83 /* SpriteKitOpaqueLoggable.swift */; };
 		5E4AF1AD1FDDBDE400B7C9D9 /* Unimplemented.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E4AF1AC1FDDBDE400B7C9D9 /* Unimplemented.swift */; };
 		5E4AF1AF1FDDC12A00B7C9D9 /* LegacyEntrypoints.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E4AF1AE1FDDC12A00B7C9D9 /* LegacyEntrypoints.swift */; };
+		5E5FE50B202D13C800E28C3C /* PGLConcurrentMap.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5E5FE50A202D13C800E28C3C /* PGLConcurrentMap.swift */; };
 		5ECE8F911FFCD2A70034D9BC /* LegacyPlaygroundLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5ECE8F901FFCD2A70034D9BC /* LegacyPlaygroundLoggerTests.swift */; };
 /* End PBXBuildFile section */
 
@@ -85,6 +89,9 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		5E184714202BB72700F01AD1 /* TypeName.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TypeName.swift; sourceTree = "<group>"; };
+		5E184716202BB80200F01AD1 /* PGLConcurrentMap.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PGLConcurrentMap.h; sourceTree = "<group>"; };
+		5E184717202BB80200F01AD1 /* PGLConcurrentMap_MRR.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PGLConcurrentMap_MRR.m; sourceTree = "<group>"; };
 		5E2646271FB64876002DC6B6 /* PlaygroundLogger.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = PlaygroundLogger.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		5E26462A1FB64876002DC6B6 /* PlaygroundLogger.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PlaygroundLogger.h; sourceTree = "<group>"; };
 		5E26462B1FB64876002DC6B6 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -152,6 +159,7 @@
 		5E2756931FCF9CB000B69C83 /* SpriteKitOpaqueLoggable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpriteKitOpaqueLoggable.swift; sourceTree = "<group>"; };
 		5E4AF1AC1FDDBDE400B7C9D9 /* Unimplemented.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Unimplemented.swift; sourceTree = "<group>"; };
 		5E4AF1AE1FDDC12A00B7C9D9 /* LegacyEntrypoints.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LegacyEntrypoints.swift; sourceTree = "<group>"; };
+		5E5FE50A202D13C800E28C3C /* PGLConcurrentMap.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PGLConcurrentMap.swift; sourceTree = "<group>"; };
 		5ECE8F901FFCD2A70034D9BC /* LegacyPlaygroundLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LegacyPlaygroundLoggerTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -207,6 +215,7 @@
 				5E2755D01FB6619800B69C83 /* LogPacket.swift */,
 				5E2755D41FB6807F00B69C83 /* LogPacket+Encoding.swift */,
 				5E2755D21FB672DC00B69C83 /* SendData.swift */,
+				5E184714202BB72700F01AD1 /* TypeName.swift */,
 				5E27561B1FC4854C00B69C83 /* Opaque Representations */,
 				5E2756511FC4EC4100B69C83 /* Custom Loggable */,
 				5E27564D1FC4E54A00B69C83 /* Legacy Support */,
@@ -415,6 +424,9 @@
 			isa = PBXGroup;
 			children = (
 				5E4AF1AC1FDDBDE400B7C9D9 /* Unimplemented.swift */,
+				5E184716202BB80200F01AD1 /* PGLConcurrentMap.h */,
+				5E184717202BB80200F01AD1 /* PGLConcurrentMap_MRR.m */,
+				5E5FE50A202D13C800E28C3C /* PGLConcurrentMap.swift */,
 			);
 			path = Utilities;
 			sourceTree = "<group>";
@@ -426,6 +438,7 @@
 			isa = PBXHeadersBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				5E184718202BB80200F01AD1 /* PGLConcurrentMap.h in Headers */,
 				5E2646381FB64876002DC6B6 /* PlaygroundLogger.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -481,7 +494,7 @@
 				TargetAttributes = {
 					5E2646261FB64876002DC6B6 = {
 						CreatedOnToolsVersion = 9.1;
-						LastSwiftMigration = 0910;
+						LastSwiftMigration = 0920;
 						ProvisioningStyle = Automatic;
 					};
 					5E26462F1FB64876002DC6B6 = {
@@ -547,6 +560,7 @@
 				5E4AF1AF1FDDC12A00B7C9D9 /* LegacyEntrypoints.swift in Sources */,
 				5E27568F1FCF964400B69C83 /* NSBitmapImageRep+CustomOpaqueLoggable.swift in Sources */,
 				5E27568D1FCF45AE00B69C83 /* UIView+CustomOpaqueLoggable.swift in Sources */,
+				5E184719202BB80200F01AD1 /* PGLConcurrentMap_MRR.m in Sources */,
 				5E27566B1FC51D2B00B69C83 /* NSAttributedString+CustomOpaqueLoggable.swift in Sources */,
 				5E2755D71FB682DE00B69C83 /* LogEntry+Encoding.swift in Sources */,
 				5E2755DB1FB7069300B69C83 /* LogEntry+Reflection.swift in Sources */,
@@ -560,6 +574,7 @@
 				5E2756771FCF3C9700B69C83 /* CIColor+CustomOpaqueLoggable.swift in Sources */,
 				5E2756941FCF9CB000B69C83 /* SpriteKitOpaqueLoggable.swift in Sources */,
 				5E2756911FCF967300B69C83 /* NSBitmapImageRep+OpaqueImageRepresentable.swift in Sources */,
+				5E5FE50B202D13C800E28C3C /* PGLConcurrentMap.swift in Sources */,
 				5E2756891FCF454D00B69C83 /* UIColor+CustomOpaqueLoggable.swift in Sources */,
 				5E4AF1AD1FDDBDE400B7C9D9 /* Unimplemented.swift in Sources */,
 				5E27566E1FC51F7E00B69C83 /* CGGeometry+CustomOpaqueLoggable.swift in Sources */,
@@ -574,6 +589,7 @@
 				5E27567C1FCF423400B69C83 /* NSColor+CustomOpaqueLoggable.swift in Sources */,
 				5E2756821FCF439D00B69C83 /* NSImage+CustomOpaqueLoggable.swift in Sources */,
 				5E2755D91FB6836800B69C83 /* LogEncoder.swift in Sources */,
+				5E184715202BB72700F01AD1 /* TypeName.swift in Sources */,
 				5E2756791FCF3D3200B69C83 /* CIImage+CustomOpaqueLoggable.swift in Sources */,
 				5E2756871FCF451900B69C83 /* UIBezierPath+CustomOpaqueLoggable.swift in Sources */,
 				5E2756841FCF43DD00B69C83 /* NSView+CustomOpaqueLoggable.swift in Sources */,
@@ -750,6 +766,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
 				SUPPORTED_PLATFORMS = "macosx iphonesimulator iphoneos appletvsimulator appletvos";
+				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 4.0;
 			};
 			name = Debug;

PlaygroundLogger/PlaygroundLogger/LogEntry+Reflection.swift

@@ -28,7 +28,7 @@ extension LogEntry {
         // TODO: need to handle optionals better (e.g. implicitly unwrap optionality, I think)
 
         // Returns either the passed-in type name/summary or the type name/summary of `instance`.
-        var typeName: String { return passedInTypeName ?? _typeName(type(of: instance)) }
+        var typeName: String { return passedInTypeName ?? normalizedName(of: type(of: instance)) }
         var summary: String { return passedInSummary ?? String(describing: instance) }
 
         // For types which conform to the `CustomOpaqueLoggable` protocol, get their custom representation and construct an opaque log entry. (This is checked *second* so that user implementations of `CustomPlaygroundRepresentable` are honored over this framework's implementations of `CustomOpaqueLoggable`.)
@@ -91,7 +91,7 @@ extension LogEntry {
 
         // If our Mirror has a superclassMirror, then we need to include that as the first "child" (and include it in the total children count).
         if let superclassMirror = mirror.superclassMirror {
-            let superclassTypeName = _typeName(superclassMirror.subjectType)
+            let superclassTypeName = normalizedName(of: superclassMirror.subjectType)
             childEntries.append(LogEntry(structureFrom: superclassMirror, name: LogEntry.superclassLogEntryName, typeName: superclassTypeName, summary: superclassTypeName))
 
             totalChildrenCount = Int(mirror.children.count) + 1

PlaygroundLogger/PlaygroundLogger/LogPacket.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
@@ -23,7 +23,7 @@ struct LogPacket {
     var logEntry: LogEntry
 }
 
-private let stringTypeName = _typeName(String.self)
+private let stringTypeName = normalizedName(of: String.self)
 
 extension LogPacket {
     private init(logEntry: LogEntry, startLine: Int, endLine: Int, startColumn: Int, endColumn: Int, threadID: String?) {

PlaygroundLogger/PlaygroundLogger/PlaygroundLogger.h

@@ -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
@@ -17,3 +17,5 @@ FOUNDATION_EXPORT double PlaygroundLoggerVersionNumber;
 
 //! Project version string for PlaygroundLogger.
 FOUNDATION_EXPORT const unsigned char PlaygroundLoggerVersionString[];
+
+#import <PlaygroundLogger/PGLConcurrentMap.h>

PlaygroundLogger/PlaygroundLogger/TypeName.swift

@@ -0,0 +1,28 @@
+//===--- TypeName.swift ---------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014-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
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+fileprivate let typeNameCache = PGLConcurrentMap()
+
+private let swiftStdlibModuleNameRegex = try! NSRegularExpression(pattern: "(?<!\\.)\\b(Swift\\.)", options: [.useUnicodeWordBoundaries])
+
+fileprivate func normalizeTypeName(_ typeName: String) -> String {
+    return swiftStdlibModuleNameRegex.stringByReplacingMatches(in: typeName, options: [], range: NSRange(location: 0, length: typeName.utf16.count), withTemplate: "")
+}
+
+/// Returns the normalized name of the given `Any.Type`.
+///
+/// - note: This function caches type names, as normalization (and type name generation in general) can be expensive.
+func normalizedName(of type: Any.Type) -> String {
+    let key = Int(bitPattern: ObjectIdentifier(type))
+    let (object, _) = typeNameCache.object(forKey: key, insertingIfNecessary: normalizeTypeName(_typeName(type)))
+    return object as! String
+}

PlaygroundLogger/PlaygroundLogger/Utilities/PGLConcurrentMap.h

@@ -0,0 +1,37 @@
+//===--- PGLConcurrentMap.h -----------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 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
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// PGLConcurrentMap provides an insertion-only map which allows for concurrent
+// accesses with minimal overhead. Since this is extremely limited, the keys
+// into this map are integers. (The values are arbitrary objects.)
+//
+//===----------------------------------------------------------------------===//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface PGLConcurrentMap : NSObject
+
+- (instancetype)init NS_DESIGNATED_INITIALIZER;
+
+- (BOOL)containsObjectForKey:(NSInteger)key;
+
+- (nullable id)objectForKey:(NSInteger)key;
+
+- (id)objectForKey:(NSInteger)key insertingObjectProvidedByBlockIfNotPresent:(id(^ NS_NOESCAPE)(void))objectProvider didInsert:(BOOL *)outDidInsert NS_REFINED_FOR_SWIFT;
+
+- (id)objectForKey:(NSInteger)key insertingObjectIfNotPresent:(id)object didInsert:(BOOL *)outDidInsert NS_REFINED_FOR_SWIFT;
+
+@end
+
+NS_ASSUME_NONNULL_END

PlaygroundLogger/PlaygroundLogger/Utilities/PGLConcurrentMap.swift

@@ -0,0 +1,19 @@
+//===--- PGLConcurrentMap.swift -------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 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
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+extension PGLConcurrentMap {
+    func object(forKey key: Int, insertingIfNecessary object: @autoclosure () -> Any) -> (Any, didInsert: Bool) {
+        var didInsert: ObjCBool = false
+        let returnedObject = self.__object(forKey: key, insertingObjectProvidedByBlockIfNotPresent: object, didInsert: &didInsert)
+        return (returnedObject, didInsert: didInsert.boolValue)
+    }
+}