Merge branch 'main' of https://github.com/duraidabdul/LocalConsole into main

Improved debug border implementation.

README.md

@@ -3,8 +3,8 @@
 Welcome to LocalConsole! This Swift Package makes on-device debugging easy with a convenient PiP-style console that can display items in the same way ```print()``` will in Xcode. This tool can also dynamically display view frames and restart SpringBoard right from your live app.
 
 <div>
-  <img src="https://github.com/duraidabdul/LocalConsole/blob/main/Additional%20Files/Demo_Pan.gif?raw=true" width="320">
-  <img src="https://github.com/duraidabdul/LocalConsole/blob/main/Additional%20Files/Demo_Resize.gif?raw=true" width="320">
+  <img src="https://github.com/duraidabdul/Demos/blob/main/Demo_Pan.gif?raw=true" width="320">
+  <img src="https://github.com/duraidabdul/Demos/blob/main/Demo_Resize.gif?raw=true" width="320">
 </div>
 
 ## **Setup**

Sources/LocalConsole/LCManager.swift

@@ -8,8 +8,8 @@
 //#if canImport(UIKit)
 
 import UIKit
+import SwiftUI
 
-var GLOBAL_DEBUG_BORDERS = false
 var GLOBAL_BORDER_TRACKERS: [BorderManager] = []
 
 public class LCManager: NSObject, UIGestureRecognizerDelegate {
@@ -26,17 +26,35 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         }
     }
     
-    let defaultConsoleSize = CGSize(width: 212, height: 124)
+    let defaultConsoleSize = CGSize(width: 228, height: 142)
     
     /// The fixed size of the console view.
     lazy var consoleSize = defaultConsoleSize {
         didSet {
             consoleView.frame.size = consoleSize
+            
+            // Update text view width.
             if consoleView.frame.size.width > ResizeController.kMaxConsoleWidth {
-                consoleTextView.frame.size.width = ResizeController.kMaxConsoleWidth
+                consoleTextView.frame.size.width = ResizeController.kMaxConsoleWidth - 4
+            } else if consoleView.frame.size.width < ResizeController.kMinConsoleWidth {
+                consoleTextView.frame.size.width = ResizeController.kMinConsoleWidth - 4
             } else {
-                consoleTextView.frame.size.width = consoleSize.width
+                consoleTextView.frame.size.width = consoleSize.width - 4
             }
+            
+            // Update text view height.
+            if consoleView.frame.size.height > ResizeController.kMaxConsoleHeight {
+                consoleTextView.frame.size.height = ResizeController.kMaxConsoleHeight - 4
+                + (consoleView.frame.size.height - ResizeController.kMaxConsoleHeight) * 2 / 3
+            } else if consoleView.frame.size.height < ResizeController.kMinConsoleHeight {
+                consoleTextView.frame.size.height = ResizeController.kMinConsoleHeight - 4
+                + (consoleView.frame.size.height - ResizeController.kMinConsoleHeight) * 2 / 3
+            } else {
+                consoleTextView.frame.size.height = consoleSize.height - 4
+            }
+            
+            consoleTextView.contentOffset.y = consoleTextView.contentSize.height - consoleTextView.bounds.size.height
+            
             // TODO: Snap to nearest position.
             
             UserDefaults.standard.set(consoleSize.width, forKey: "LocalConsole_Width")
@@ -52,7 +70,7 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
     lazy var consoleView = viewController.view!
     
     /// Text view that displays printed items.
-    let consoleTextView = UITextView()
+    let consoleTextView = InvertedTextView()
     
     /// Button that reveals menu.
     lazy var menuButton = UIButton()
@@ -74,14 +92,14 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
                     CGPoint(x: UIScreen.portraitSize.width - consoleSize.width / 2 - 12,
                             y: (UIScreen.hasRoundedCorners ? 44 : 16) + consoleSize.height / 2 + 12),
                     CGPoint(x: consoleSize.width / 2 + 12,
-                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (consoleWindow?.safeAreaInsets.bottom ?? 0) - 12),
+                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (keyboardHeight ?? consoleWindow?.safeAreaInsets.bottom ?? 0) - 12),
                     CGPoint(x: UIScreen.portraitSize.width - consoleSize.width / 2 - 12,
-                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (consoleWindow?.safeAreaInsets.bottom ?? 0) - 12)]
+                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (keyboardHeight ?? consoleWindow?.safeAreaInsets.bottom ?? 0) - 12)]
         } else {
             return [CGPoint(x: UIScreen.portraitSize.width / 2,
                             y: (UIScreen.hasRoundedCorners ? 44 : 16) + consoleSize.height / 2 + 12),
                     CGPoint(x: UIScreen.portraitSize.width / 2,
-                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (consoleWindow?.safeAreaInsets.bottom ?? 0) - 12)]
+                            y: UIScreen.portraitSize.height - consoleSize.height / 2 - (keyboardHeight ?? consoleWindow?.safeAreaInsets.bottom ?? 0) - 12)]
         }
     }
     
@@ -103,7 +121,7 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         consoleView.center = possibleEndpoints.first!
         consoleView.alpha = 0
         
-        consoleView.layer.cornerRadius = 20
+        consoleView.layer.cornerRadius = 22
         consoleView.layer.cornerCurve = .continuous
         
         let borderView = UIView()
@@ -118,17 +136,19 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         consoleView.addSubview(borderView)
         
         // Configure text view.
-        consoleTextView.frame = CGRect(x: 0, y: 2, width: consoleSize.width, height: consoleSize.height - 4)
+        consoleTextView.frame = CGRect(x: 2, y: 2, width: consoleSize.width - 4, height: consoleSize.height - 4)
         consoleTextView.isEditable = false
         consoleTextView.backgroundColor = .clear
-        consoleTextView.textContainerInset = UIEdgeInsets(top: 8, left: 10, bottom: 8, right: 10)
+        consoleTextView.textContainerInset = UIEdgeInsets(top: 10, left: 8, bottom: 10, right: 8)
         
         consoleTextView.isSelectable = false
         consoleTextView.showsVerticalScrollIndicator = false
         consoleTextView.contentInsetAdjustmentBehavior = .never
-        consoleTextView.autoresizingMask = [.flexibleHeight]
         consoleView.addSubview(consoleTextView)
         
+        consoleTextView.layer.cornerRadius = consoleView.layer.cornerRadius - 2
+        consoleTextView.layer.cornerCurve = .continuous
+        
         // Configure gesture recognizers.
         panRecognizer.maximumNumberOfTouches = 1
         panRecognizer.delegate = self
@@ -143,7 +163,7 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         consoleView.addGestureRecognizer(longPressRecognizer)
         
         // Prepare menu button.
-        let diameter = CGFloat(26)
+        let diameter = CGFloat(28)
         
         // This tuned button frame is used to adjust where the menu appears.
         menuButton = UIButton(frame: CGRect(x: consoleView.bounds.width - 44,
@@ -163,7 +183,7 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         circle.isUserInteractionEnabled = false
         menuButton.addSubview(circle)
         
-        let ellipsisImage = UIImageView(image: UIImage(systemName: "ellipsis", withConfiguration: UIImage.SymbolConfiguration(pointSize: 16)))
+        let ellipsisImage = UIImageView(image: UIImage(systemName: "ellipsis", withConfiguration: UIImage.SymbolConfiguration(pointSize: 17)))
         ellipsisImage.frame.size = circle.bounds.size
         ellipsisImage.contentMode = .center
         circle.addSubview(ellipsisImage)
@@ -173,7 +193,8 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         menuButton.showsMenuAsPrimaryAction = true
         consoleView.addSubview(menuButton)
         
-        UIView.swizzleDebugBehaviour
+        NotificationCenter.default.addObserver(self, selector: #selector(keyboardWillHide), name: UIResponder.keyboardWillHideNotification, object: nil)
+        NotificationCenter.default.addObserver(self, selector: #selector(keyboardWillShow), name: UIResponder.keyboardWillShowNotification, object: nil)
     }
     
     /// Adds a LocalConsole window to the app's main scene.
@@ -235,32 +256,68 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
                 UIViewPropertyAnimator(duration: 0.5, dampingRatio: 0.6) { [self] in
                     consoleView.transform = .init(scaleX: 1, y: 1)
                 }.startAnimation()
-                UIViewPropertyAnimator(duration: 0.3, dampingRatio: 1) { [self] in
+                UIViewPropertyAnimator(duration: 0.4, dampingRatio: 1) { [self] in
                     consoleView.alpha = 1
                 }.startAnimation()
+                
+                let animation = CABasicAnimation(keyPath: "shadowOpacity")
+                animation.fromValue = 0
+                animation.toValue = 0.5
+                animation.duration = 0.6
+                consoleView.layer.add(animation, forKey: animation.keyPath)
+                consoleView.layer.shadowOpacity = 0.5
+                
             } else {
-                UIViewPropertyAnimator(duration: 0.25, dampingRatio: 1) { [self] in
+                UIViewPropertyAnimator(duration: 0.4, dampingRatio: 1) { [self] in
                     consoleView.transform = .init(scaleX: 0.9, y: 0.9)
+                }.startAnimation()
+                
+                UIViewPropertyAnimator(duration: 0.3, dampingRatio: 1) { [self] in
                     consoleView.alpha = 0
                 }.startAnimation()
             }
         }
     }
     
+    private var _hasRelayedOffsetChange = false
+    
     /// Print items to the console view.
     public func print(_ items: Any) {
-        let string: String = {
-            if consoleTextView.text == "" {
-                return "\(items)"
-            } else {
-                return "\(items)\n" + consoleTextView.text
+        
+        func performActions() {
+            if consoleTextView.contentOffset.y > consoleTextView.contentSize.height - 20 - consoleTextView.bounds.size.height ||
+                _hasRelayedOffsetChange == false {
+                consoleTextView.pendingOffsetChange = true
+                
+                _hasRelayedOffsetChange = true
             }
-        }()
+            
+            let needsMenuUpdate = consoleTextView.text == ""
+            
+            let string: String = {
+                if consoleTextView.text == "" {
+                    return "\(items)"
+                } else {
+                    return consoleTextView.text + "\n\(items)"
+                }
+            }()
+            
+            setAttributedText(string)
+            
+            if needsMenuUpdate {
+                // Update the context menu to show the clipboard/clear actions.
+                menuButton.menu = makeMenu()
+            }
+        }
         
-        setAttributedText(string)
-        
-        // Update the context menu to show the clipboard/clear actions.
-        menuButton.menu = makeMenu()
+        // Ensure we are performing UI updates on the main thread.
+        DispatchQueue.main.async {
+            
+            // Ensure the console doesn't get caught into any external animation blocks.
+            UIView.performWithoutAnimation {
+                performActions()
+            }
+        }
     }
     
     /// Clear text in the console view.
@@ -278,9 +335,37 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
     
     // MARK: - Private
     
+    
+    // MARK: Handle keyboard show/hide.
+    private var keyboardHeight: CGFloat? = nil {
+        didSet {
+            
+            if consoleView.center != possibleEndpoints[0] && consoleView.center != possibleEndpoints[1] {
+                let nearestTargetPosition = nearestTargetTo(consoleView.center, possibleTargets: possibleEndpoints.suffix(2))
+                
+                UIViewPropertyAnimator(duration: 0.55, dampingRatio: 1) {
+                    self.consoleView.center = nearestTargetPosition
+                }.startAnimation()
+            }
+        }
+    }
+    
+    @objc func keyboardWillShow(_ notification: Notification) {
+        if let keyboardFrame: NSValue = notification.userInfo?[UIResponder.keyboardFrameEndUserInfoKey] as? NSValue {
+            let keyboardRectangle = keyboardFrame.cgRectValue
+            self.keyboardHeight = keyboardRectangle.height
+        }
+    }
+    
+    @objc func keyboardWillHide() {
+        keyboardHeight = nil
+    }
+    
     private var debugBordersEnabled = false {
         didSet {
-            GLOBAL_DEBUG_BORDERS = debugBordersEnabled
+            
+            UIView.swizzleDebugBehaviour_UNTRACKABLE_TOGGLE()
+            
             guard debugBordersEnabled else {
                 GLOBAL_BORDER_TRACKERS.forEach {
                     $0.deactivate()
@@ -308,51 +393,48 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
     
     func systemReport() {
         DispatchQueue.main.async { [self] in
-            print("Screen Scale:       \(UIScreen.main.scale)\n")
-            print("Screen Radius:      \(UIScreen.main.value(forKey: "_displayCornerRadius") as! CGFloat)")
-            print("Screen Size:        \(UIScreen.main.bounds.size)")
-            print("Max Frame Rate:     \(UIScreen.main.maximumFramesPerSecond) Hz")
-            print("Low Power Mode:     \(ProcessInfo.processInfo.isLowPowerModeEnabled)")
-            print("System Uptime:      \(Int(ProcessInfo.processInfo.systemUptime))s")
-            print("Thermal State:      \(SystemReport.shared.thermalState)")
-            print("Processor Cores:    \(Int(ProcessInfo.processInfo.processorCount))")
-            print("Memory:             \(round(100 * Double(ProcessInfo.processInfo.physicalMemory) * pow(10, -9)) / 100) GB")
-            print("OS Compile Date:    \(SystemReport.shared.compileDate)")
-            print("System Version:     \(SystemReport.shared.versionString)")
-            print("Kernel Version:     \(SystemReport.shared.kernel) \(SystemReport.shared.kernelVersion)")
-            print("Firmware:           \(SystemReport.shared.gestaltFirmwareVersion)")
-            print("Architecture:       \(SystemReport.shared.gestaltArchitecture)")
-            print("Model Identifier:   \(SystemReport.shared.gestaltModelIdentifier)")
-            print("Marketing Name:     \(SystemReport.shared.gestaltMarketingName)")
+            
+            print(
+                  """
+                  \n
+                  Model Name:         \(SystemReport.shared.gestaltMarketingName)
+                  Model Identifier:   \(SystemReport.shared.gestaltModelIdentifier)
+                  Architecture:       \(SystemReport.shared.gestaltArchitecture)
+                  Firmware:           \(SystemReport.shared.gestaltFirmwareVersion)
+                  Kernel Version:     \(SystemReport.shared.kernel) \(SystemReport.shared.kernelVersion)
+                  System Version:     \(SystemReport.shared.versionString)
+                  OS Compile Date:    \(SystemReport.shared.compileDate)
+                  Memory:             \(round(100 * Double(ProcessInfo.processInfo.physicalMemory) * pow(10, -9)) / 100) GB
+                  Processor Cores:    \(Int(ProcessInfo.processInfo.processorCount))
+                  Thermal State:      \(SystemReport.shared.thermalState)
+                  System Uptime:      \(Int(ProcessInfo.processInfo.systemUptime))s
+                  Low Power Mode:     \(ProcessInfo.processInfo.isLowPowerModeEnabled)
+                  """
+            )
+            
         }
     }
     
+    func displayReport() {
+        DispatchQueue.main.async { [self] in
+            
+            print(
+                  """
+                  \n
+                  Screen Size:            \(UIScreen.main.bounds.size)
+                  Screen Corner Radius:   \(UIScreen.main.value(forKey: "_displayCornerRadius") as! CGFloat)
+                  Screen Scale:           \(UIScreen.main.scale)
+                  Max Frame Rate:         \(UIScreen.main.maximumFramesPerSecond) Hz
+                  Brightness:             \(UIScreen.main.brightness)
+                  """
+            )
+        }
+    }
     
     @objc func toggleLock() {
         scrollLocked.toggle()
     }
     
-    func toggleVisibility() {
-        if isVisible {
-            UIViewPropertyAnimator(duration: 0.25, dampingRatio: 1) { [self] in
-                consoleView.transform = .init(scaleX: 0.9, y: 0.9)
-                consoleView.alpha = 0
-            }.startAnimation()
-            
-            isVisible = false
-        } else {
-            UIViewPropertyAnimator(duration: 0.4, dampingRatio: 1) { [self] in
-                consoleView.transform = .init(scaleX: 1, y: 1)
-                consoleView.alpha = 1
-            }.startAnimation()
-            
-            isVisible = true
-        }
-        
-        // Renders color properly (for dark appearance).
-        consoleView.backgroundColor = .black
-    }
-    
     func setAttributedText(_ string: String) {
         let paragraphStyle = NSMutableParagraphStyle()
         paragraphStyle.headIndent = 7
@@ -388,17 +470,49 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
         
         let consoleActions = UIMenu(title: "", options: .displayInline, children: [clear, resize])
         
+        var frameSymbol = "rectangle.3.offgrid"
+        if #available(iOS 15, *) {
+            frameSymbol = "square.inset.filled"
+        }
+        
         let viewFrames = UIAction(title: debugBordersEnabled ? "Hide View Frames" : "Show View Frames",
-                                  image: UIImage(systemName: "rectangle.3.offgrid"), handler: { _ in
+                                  image: UIImage(systemName: frameSymbol), handler: { _ in
                                     self.debugBordersEnabled.toggle()
                                     self.menuButton.menu = self.makeMenu()
                                   })
         
         let systemReport = UIAction(title: "System Report",
-                                  image: UIImage(systemName: "doc.badge.gearshape"), handler: { _ in
+                                  image: UIImage(systemName: "cpu"), handler: { _ in
                                     self.systemReport()
                                   })
         
+        // Show the right glyph for the current device being used.
+        let deviceSymbol: String = {
+            
+            let hasHomeButton = UIScreen.main.value(forKey: "_displayCornerRadius") as! CGFloat == 0
+            
+            if UIDevice.current.userInterfaceIdiom == .pad {
+                if hasHomeButton {
+                    return "ipad.homebutton"
+                } else {
+                    return "ipad"
+                }
+            } else if UIDevice.current.userInterfaceIdiom == .phone {
+                if hasHomeButton {
+                    return "iphone.homebutton"
+                } else {
+                    return "iphone"
+                }
+            } else {
+                return "rectangle"
+            }
+        }()
+        
+        let displayReport = UIAction(title: "Display Report",
+                                  image: UIImage(systemName: deviceSymbol), handler: { _ in
+                                    self.displayReport()
+                                  })
+        
         let respring = UIAction(title: "Restart SpringBoard",
                                 image: UIImage(systemName: "apps.iphone"), handler: { _ in
                                     guard let window = UIApplication.shared.windows.first else { return }
@@ -417,7 +531,9 @@ public class LCManager: NSObject, UIGestureRecognizerDelegate {
                                     }
                                     animator.startAnimation()
                                 })
-        let debugActions = UIMenu(title: "", options: .displayInline, children: [viewFrames, systemReport, respring])
+        let debugActions = UIMenu(title: "", options: .displayInline,
+                                  children: [UIMenu(title: "Debug", image: UIImage(systemName: "ant"),
+                                                    children: [viewFrames, systemReport, displayReport, respring])])
         
         var menuContent: [UIMenuElement] = []
         
@@ -585,20 +701,18 @@ public class UITapStartEndGestureRecognizer: UITapGestureRecognizer {
 // MARK: Fun hacks!
 extension UIView {
     /// Swizzle UIView to use custom frame system when needed.
-    static let swizzleDebugBehaviour: Void = {
+    static func swizzleDebugBehaviour_UNTRACKABLE_TOGGLE() {
         guard let originalMethod = class_getInstanceMethod(UIView.self, #selector(layoutSubviews)),
               let swizzledMethod = class_getInstanceMethod(UIView.self, #selector(swizzled_layoutSubviews)) else { return }
         method_exchangeImplementations(originalMethod, swizzledMethod)
-    }()
+    }
 
     @objc func swizzled_layoutSubviews() {
         swizzled_layoutSubviews()
         
-        if GLOBAL_DEBUG_BORDERS {
-            let tracker = BorderManager(view: self)
-            GLOBAL_BORDER_TRACKERS.append(tracker)
-            tracker.activate()
-        }
+        let tracker = BorderManager(view: self)
+        GLOBAL_BORDER_TRACKERS.append(tracker)
+        tracker.activate()
     }
 }
 
@@ -618,3 +732,33 @@ extension UIWindow {
 }
 
 //#endif
+
+class InvertedTextView: UITextView {
+    
+    var pendingOffsetChange = false
+    
+    // Thanks to WWDC21 Lab!
+    override func layoutSubviews() {
+        super.layoutSubviews()
+
+        if panGestureRecognizer.numberOfTouches == 0 && pendingOffsetChange {
+            contentOffset.y = contentSize.height - bounds.size.height
+        } else {
+            pendingOffsetChange = false
+        }
+    }
+    
+    var cancelNextContentSizeDidSet = false
+    
+    override var contentSize: CGSize {
+        didSet {
+            cancelNextContentSizeDidSet = true
+            
+            if contentSize.height < bounds.size.height {
+                contentInset.top = bounds.size.height - contentSize.height
+            } else {
+                contentInset.top = 0
+            }
+        }
+    }
+}

Sources/LocalConsole/ResizeController.swift

@@ -116,6 +116,14 @@ class ResizeController {
             
             if isActive {
                 
+                UIViewPropertyAnimator(duration: 0.75, dampingRatio: 1) {
+                    
+                    let textView = LCManager.shared.consoleTextView
+                    
+                    textView.contentOffset.y = textView.contentSize.height - textView.bounds.size.height
+                }.startAnimation()
+                
+                
                 if LCManager.shared.consoleView.traitCollection.userInterfaceStyle == .light {
                     LCManager.shared.consoleView.layer.shadowOpacity = 0.25
                 }
@@ -189,12 +197,15 @@ class ResizeController {
     
     var initialHeight = CGFloat.zero
     
+    static let kMinConsoleHeight: CGFloat = 108
+    static let kMaxConsoleHeight: CGFloat = 346
+    
     @objc func verticalPanner(recognizer: UIPanGestureRecognizer) {
         
         let translation = recognizer.translation(in: bottomGrabber.superview)
         
-        let maxHeight: CGFloat = 346
-        let minHeight: CGFloat = 108
+        let minHeight = Self.kMinConsoleHeight
+        let maxHeight = Self.kMaxConsoleHeight
         
         switch recognizer.state {
         case .began:
@@ -252,14 +263,15 @@ class ResizeController {
     
     var initialWidth = CGFloat.zero
     
+    static let kMinConsoleWidth: CGFloat = 112
     static let kMaxConsoleWidth: CGFloat = UIScreen.portraitSize.width - 56
     
     @objc func horizontalPanner(recognizer: UIPanGestureRecognizer) {
         
         let translation = recognizer.translation(in: bottomGrabber.superview)
         
-        let maxWidth: CGFloat = Self.kMaxConsoleWidth
-        let minWidth: CGFloat = 112
+        let minWidth = Self.kMinConsoleWidth
+        let maxWidth = Self.kMaxConsoleWidth
         
         switch recognizer.state {
         case .began:
@@ -377,6 +389,7 @@ class PlatterView: UIView {
         
         let subtitleLabel = UILabel()
         subtitleLabel.text = "Use the grabbers to resize the console."
+        subtitleLabel.font = .systemFont(ofSize: 17, weight: .medium)
         subtitleLabel.sizeToFit()
         subtitleLabel.alpha = 0.5
         subtitleLabel.center.x = bounds.width / 2
@@ -455,7 +468,7 @@ class PlatterView: UIView {
             
             // Resolves a text view frame animation bug that occurs when *decreasing* text view width.
             if LCManager.shared.consoleSize.width > LCManager.shared.defaultConsoleSize.width {
-                LCManager.shared.consoleTextView.frame.size.width = LCManager.shared.defaultConsoleSize.width
+                LCManager.shared.consoleTextView.frame.size.width = LCManager.shared.defaultConsoleSize.width - 4
             }
             
             UIViewPropertyAnimator(duration: 0.4, dampingRatio: 1) {