Adjust for latest round of code review; change PrintForDebugger to _DebuggerSupport and stringForPrintObject; minor indentation and label fixups

Author: Enrico Granata

stdlib/public/core/CMakeLists.txt

@@ -42,6 +42,7 @@ set(SWIFTLIB_ESSENTIAL
   ContiguousArrayBuffer.swift
   CString.swift
   CTypes.swift
+  DebuggerSupport.swift
   EmptyCollection.swift
   ErrorType.swift
   Existential.swift
@@ -78,7 +79,6 @@ set(SWIFTLIB_ESSENTIAL
   Pointer.swift
   Policy.swift
   Print.swift
-  PrintForDebugger.swift
   RandomAccessCollection.swift
   Range.swift.gyb
   RangeReplaceableCollection.swift.gyb

stdlib/public/core/PrintForDebugger.swift renamed to stdlib/public/core/DebuggerSupport.swift

@@ -10,8 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public enum _PrintForDebugger {
-
+public enum _DebuggerSupport {
   internal enum CollectionStatus {
     case NotACollection
     case CollectionOfElements
@@ -39,15 +38,15 @@ public enum _PrintForDebugger {
     }
   }
 
-  internal static func asObjectIdentifier(value: Any) -> ObjectIdentifier? {
+  internal static func asObjectIdentifier(_ value: Any) -> ObjectIdentifier? {
     if let ao = value as? AnyObject {
       return ObjectIdentifier(ao)
     } else {
       return nil
     }
   }
 
-  internal static func asNumericValue(value: Any) -> Int {
+  internal static func asNumericValue(_ value: Any) -> Int {
     if let ao = value as? AnyObject {
       return unsafeBitCast(ao, to: Int.self)
     } else {
@@ -62,54 +61,54 @@ public enum _PrintForDebugger {
   ) -> String? {
     let ds = mirror.displayStyle ?? .`struct`
     switch ds {
-    case .optional:
+      case .optional:
         if count > 0 {
-            return "\(mirror.subjectType)"
+          return "\(mirror.subjectType)"
         }
         else {
-            if let x = value {
-                return String(reflecting: x)
-            }
+          if let x = value {
+            return String(reflecting: x)
+          }
         }
-    case .collection:
+      case .collection:
         fallthrough
-    case .dictionary:
+      case .dictionary:
         fallthrough
-    case .set:
+      case .set:
         fallthrough
-    case .tuple:
+      case .tuple:
         return "\(Int(mirror.children.count)) elements"
-    case .`struct`:
+      case .`struct`:
         fallthrough
-    case .`enum`:
+      case .`enum`:
         if let x = value {
-            if let cdsc = (x as? CustomDebugStringConvertible) {
-                return cdsc.debugDescription
-            }
-            if let csc = (x as? CustomStringConvertible) {
-                return csc.description
-            }
+          if let cdsc = (x as? CustomDebugStringConvertible) {
+            return cdsc.debugDescription
+          }
+          if let csc = (x as? CustomStringConvertible) {
+            return csc.description
+          }
         }
         if count > 0 {
             return "\(mirror.subjectType)"
         }
-    case .`class`:
+      case .`class`:
         if let x = value {
-            if let cdsc = (x as? CustomDebugStringConvertible) {
-                return cdsc.debugDescription
-            }
-            if let csc = (x as? CustomStringConvertible) {
-                return csc.description
-            }
-            // for a Class with no custom summary, mimic the Foundation default
-            return "<\(x.dynamicType): 0x\(String(asNumericValue(value: x), radix: 16, uppercase: false))>"
+          if let cdsc = (x as? CustomDebugStringConvertible) {
+            return cdsc.debugDescription
+          }
+          if let csc = (x as? CustomStringConvertible) {
+            return csc.description
+          }
+          // for a Class with no custom summary, mimic the Foundation default
+          return "<\(x.dynamicType): 0x\(String(asNumericValue(x), radix: 16, uppercase: false))>"
         } else {
-            // but if I can't provide a value, just use the type anyway
-            return "\(mirror.subjectType)"
+          // but if I can't provide a value, just use the type anyway
+          return "\(mirror.subjectType)"
         }
     }
     if let x = value {
-        return String(reflecting: x)
+      return String(reflecting: x)
     }
     return nil
   }
@@ -139,7 +138,7 @@ public enum _PrintForDebugger {
     }
   }
 
-  internal static func printForDebuggerImpl<StreamType: OutputStream>(
+  internal static func printForDebuggerImpl<StreamType : OutputStream>(
     value: Any?,
     mirror: Mirror,
     name: String?,
@@ -204,7 +203,7 @@ public enum _PrintForDebugger {
     }
 
     if let x = value {
-      if let valueIdentifier = asObjectIdentifier(value: x) {
+      if let valueIdentifier = asObjectIdentifier(x) {
         if refsAlreadySeen.contains(valueIdentifier) {
           print(" { ... }", to: &targetStream)
           return
@@ -266,7 +265,7 @@ public enum _PrintForDebugger {
     }
   }
 
-  public static func printForDebugger(value: Any) -> String {
+  public static func stringForPrintObject(_ value: Any) -> String {
     var maxItemCounter = Int.max
     var refs = Set<ObjectIdentifier>()
     var targetStream = ""

stdlib/public/core/GroupInfo.json

@@ -142,6 +142,6 @@
     "Tuple.swift",
     "NewtypeWrapper.swift",
     "UnsafeBitMap.swift",
-    "PrintForDebugger.swift"
+    "DebuggerSupport.swift"
   ]
 }

test/1_stdlib/PrintForDebugger.swift renamed to test/1_stdlib/DebuggerSupport.swift

@@ -19,39 +19,39 @@ class ClassWithMirror: CustomReflectable {
   }
 }
 
-let PrintForDebuggerTests = TestSuite("PrintForDebugger")
-PrintForDebuggerTests.test("StructWithMembers") {
-  let printed = _PrintForDebugger.printForDebugger(value: StructWithMembers())
+let StringForPrintObjectTests = TestSuite("StringForPrintObject")
+StringForPrintObjectTests.test("StructWithMembers") {
+  let printed = _DebuggerSupport.stringForPrintObject(StructWithMembers())
   expectEqual(printed, "▿ StructWithMembers\n  - a : 1\n  - b : \"Hello World\"\n")
 }
 
-PrintForDebuggerTests.test("ClassWithMembers") {
-  let printed = _PrintForDebugger.printForDebugger(value: ClassWithMembers())
+StringForPrintObjectTests.test("ClassWithMembers") {
+  let printed = _DebuggerSupport.stringForPrintObject(ClassWithMembers())
   expectTrue(printed.hasPrefix("<ClassWithMembers: 0x"))
 }
 
-PrintForDebuggerTests.test("ClassWithMirror") {
-  let printed = _PrintForDebugger.printForDebugger(value: ClassWithMirror())
+StringForPrintObjectTests.test("ClassWithMirror") {
+  let printed = _DebuggerSupport.stringForPrintObject(ClassWithMirror())
   expectEqual(printed, "▿ ClassWithMirror\n  - a : 1\n  - b : \"Hello World\"\n")
 }
 
-PrintForDebuggerTests.test("Array") {
-  let printed = _PrintForDebugger.printForDebugger(value: [1,2,3,4])
+StringForPrintObjectTests.test("Array") {
+  let printed = _DebuggerSupport.stringForPrintObject([1,2,3,4])
   expectEqual(printed, "▿ 4 elements\n  - 0 : 1\n  - 1 : 2\n  - 2 : 3\n  - 3 : 4\n")
 }
 
-PrintForDebuggerTests.test("Dictionary") {
-  let printed = _PrintForDebugger.printForDebugger(value: [1:2])
+StringForPrintObjectTests.test("Dictionary") {
+  let printed = _DebuggerSupport.stringForPrintObject([1:2])
   expectEqual(printed, "▿ 1 elements\n  ▿ 0 : 2 elements\n    - .0 : 1\n    - .1 : 2\n")
 }
 
-PrintForDebuggerTests.test("NilOptional") {
-  let printed = _PrintForDebugger.printForDebugger(value: nil as Int?)
+StringForPrintObjectTests.test("NilOptional") {
+  let printed = _DebuggerSupport.stringForPrintObject(nil as Int?)
   expectTrue(printed.hasPrefix("nil"))
 }
 
-PrintForDebuggerTests.test("SomeOptional") {
-  let printed = _PrintForDebugger.printForDebugger(value: 3 as Int?)
+StringForPrintObjectTests.test("SomeOptional") {
+  let printed = _DebuggerSupport.stringForPrintObject(3 as Int?)
   expectEqual(printed, "▿ Optional<Int>\n  - some : 3\n")
 }