displayLink weak reference

Alex009 · Alex009 · commit 8aacebec3f31 · 2023-04-27T18:46:09.000+06:00
diff --git a/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/factory/ButtonWithIconViewFactory.kt b/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/factory/ButtonWithIconViewFactory.kt
@@ -90,6 +90,7 @@ actual class ButtonWithIconViewFactory actual constructor(
                     button.setTitle(title = processedText, forState = UIControlStateNormal)
                 }
             }
+
             else -> throw Exception("Not supported content type")
         }
 
@@ -109,14 +110,17 @@ actual class ButtonWithIconViewFactory actual constructor(
                 contentAttribute = UISemanticContentAttributeForceLeftToRight
                 contentAlignment = UIControlContentHorizontalAlignmentLeft
             }
+
             IconGravity.END -> {
                 contentAttribute = UISemanticContentAttributeForceRightToLeft
                 contentAlignment = UIControlContentHorizontalAlignmentLeft
             }
+
             IconGravity.TEXT_START, null -> {
                 contentAttribute = UISemanticContentAttributeForceLeftToRight
                 contentAlignment = UIControlContentHorizontalAlignmentCenter
             }
+
             IconGravity.TEXT_END -> {
                 contentAttribute = UISemanticContentAttributeForceRightToLeft
                 contentAlignment = UIControlContentHorizontalAlignmentCenter
@@ -127,27 +131,36 @@ actual class ButtonWithIconViewFactory actual constructor(
 
         button.imageView?.let { button.bringSubviewToFront(it) }
 
-        var buttonWidth = 0.0
-        // TODO remove this bad :(
-        button.displayLink {
-            val icPadding: Double = iconPadding?.toDouble() ?: 0.0
+        setupLayoutUpdate(button, viewFactory = this)
+
+        return ViewBundle(
+            view = button,
+            size = size,
+            margins = margins
+        )
+    }
 
-            val newButtonWidth = button.bounds.useContents { this.size.width }
-            if (buttonWidth == newButtonWidth) return@displayLink
-            buttonWidth = newButtonWidth
+    private fun setupLayoutUpdate(button: UIButton, viewFactory: ButtonWithIconViewFactory) {
+        button.displayLink(
+            context = viewFactory,
+            objectForSkipCheck = { it.bounds }
+        ) { button, viewFactory ->
+            val icPadding: Double = viewFactory.iconPadding?.toDouble() ?: 0.0
+
+            val buttonWidth: CGFloat = button.bounds.useContents { this.size.width }
 
             val iconWidth = button.imageView?.frame?.useContents { this.size.width } ?: 0.0
             val titleWidth = button.titleLabel?.frame?.useContents { this.size.width } ?: 0.0
 
-            val paddingTop = padding?.top?.toDouble() ?: 0.0
-            var paddingLeft = padding?.start?.toDouble() ?: 0.0
-            var paddingRight = padding?.end?.toDouble() ?: 0.0
-            val paddingBottom = padding?.bottom?.toDouble() ?: 0.0
+            val paddingTop = viewFactory.padding?.top?.toDouble() ?: 0.0
+            var paddingLeft = viewFactory.padding?.start?.toDouble() ?: 0.0
+            var paddingRight = viewFactory.padding?.end?.toDouble() ?: 0.0
+            val paddingBottom = viewFactory.padding?.bottom?.toDouble() ?: 0.0
 
             val titleLeftInset: CGFloat
             val titleRightInset: CGFloat
 
-            when (iconGravity) {
+            when (viewFactory.iconGravity) {
                 IconGravity.START -> {
                     val inset = buttonWidth -
                             iconWidth - titleWidth -
@@ -157,6 +170,7 @@ actual class ButtonWithIconViewFactory actual constructor(
                     titleRightInset = -inset
                     paddingRight += inset
                 }
+
                 IconGravity.END -> {
                     val inset = buttonWidth -
                             iconWidth - titleWidth -
@@ -166,11 +180,13 @@ actual class ButtonWithIconViewFactory actual constructor(
                     titleRightInset = inset
                     paddingLeft += inset
                 }
+
                 IconGravity.TEXT_START, null -> {
                     titleLeftInset = icPadding
                     titleRightInset = -icPadding
                     paddingRight += icPadding
                 }
+
                 IconGravity.TEXT_END -> {
                     titleLeftInset = -icPadding
                     titleRightInset = icPadding
@@ -191,11 +207,5 @@ actual class ButtonWithIconViewFactory actual constructor(
                 right = paddingRight
             )
         }
-
-        return ViewBundle(
-            view = button,
-            size = size,
-            margins = margins
-        )
     }
 }
diff --git a/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/utils/BackgroundExt.kt b/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/utils/BackgroundExt.kt
@@ -10,21 +10,19 @@ import dev.icerock.moko.widgets.core.style.background.Direction
 import dev.icerock.moko.widgets.core.style.background.Fill
 import dev.icerock.moko.widgets.core.style.state.PressableState
 import kotlinx.cinterop.useContents
+import platform.CoreGraphics.CGFloat
 import platform.CoreGraphics.CGPointMake
 import platform.CoreGraphics.CGRectMake
-import platform.Foundation.NSRunLoop
-import platform.Foundation.NSRunLoopCommonModes
-import platform.QuartzCore.CADisplayLink
 import platform.QuartzCore.CAGradientLayer
 import platform.QuartzCore.CALayer
 import platform.QuartzCore.CATransaction
 import platform.UIKit.UIButton
 import platform.UIKit.UIColor
+import platform.UIKit.UIControl
 import platform.UIKit.UIView
 import platform.UIKit.adjustsImageWhenDisabled
 import platform.UIKit.adjustsImageWhenHighlighted
 import platform.UIKit.backgroundColor
-import platform.UIKit.window
 
 @Suppress("MagicNumber", "ComplexMethod")
 fun Background<out Fill>.caLayer(): CALayer {
@@ -35,6 +33,7 @@ fun Background<out Fill>.caLayer(): CALayer {
         is Fill.Solid -> backgroundLayer = CALayer().apply {
             backgroundColor = fill.color.toUIColor().CGColor
         }
+
         is Fill.Gradient -> {
             backgroundLayer = CAGradientLayer().apply {
                 colors = cgColors(fill.colors.map {
@@ -58,6 +57,7 @@ fun Background<out Fill>.caLayer(): CALayer {
                 endPoint = end
             }
         }
+
         null -> {
             backgroundLayer = CALayer()
         }
@@ -84,56 +84,62 @@ fun UIButton.applyStateBackgroundIfNeeded(background: PressableState<Background<
     adjustsImageWhenDisabled = false
     adjustsImageWhenHighlighted = false
 
-    val normalBg = background.normal.caLayer().also {
-        layer.addSublayer(it)
-    }
-    val disabledBg = background.disabled.caLayer().also {
-        layer.addSublayer(it)
-    }
-    val pressedBg = background.pressed.caLayer().also {
-        layer.addSublayer(it)
-    }
-
-    fun updateLayers() {
-        if (!isEnabled()) {
-            disabledBg.opacity = 1.0f
-            normalBg.opacity = 0f
-            pressedBg.opacity = 0f
-            return
+    val stateLayers = StateLayers(
+        normal = background.normal.caLayer().also {
+            layer.addSublayer(it)
+        },
+        disabled = background.disabled.caLayer().also {
+            layer.addSublayer(it)
+        },
+        pressed = background.pressed.caLayer().also {
+            layer.addSublayer(it)
         }
+    )
 
-        if (isHighlighted()) {
-            pressedBg.opacity = 1.0f
-            normalBg.opacity = 0f
-        } else {
-            normalBg.opacity = 1.0f
-            pressedBg.opacity = 0f
-        }
-        disabledBg.opacity = 0f
-    }
+    stateLayers.update(this)
 
-    updateLayers()
+    this.displayLink(
+        context = stateLayers,
+        objectForSkipCheck = { it.layer.bounds }
+    ) { button, stateLayers ->
+        val (width: CGFloat, height: CGFloat) = button.layer.bounds.useContents {
+            this.size.width to this.size.height
+        }
 
-    // FIXME memoryleak, perfomance problem !!!
-    var link: CADisplayLink? = null
+        CATransaction.begin()
+        CATransaction.setDisableActions(true)
 
-    link = displayLink {
-        if (window != null) {
-            val (width, height) = layer.bounds.useContents { size.width to size.height }
+        stateLayers.normal.frame = CGRectMake(0.0, 0.0, width, height)
+        stateLayers.disabled.frame = CGRectMake(0.0, 0.0, width, height)
+        stateLayers.pressed.frame = CGRectMake(0.0, 0.0, width, height)
 
-            CATransaction.begin()
-            CATransaction.setDisableActions(true)
+        stateLayers.update(button)
 
-            normalBg.frame = CGRectMake(0.0, 0.0, width, height)
-            disabledBg.frame = CGRectMake(0.0, 0.0, width, height)
-            pressedBg.frame = CGRectMake(0.0, 0.0, width, height)
+        CATransaction.commit()
+    }
+}
 
-            updateLayers()
+private data class StateLayers(
+    val normal: CALayer,
+    val disabled: CALayer,
+    val pressed: CALayer
+) {
+    fun update(control: UIControl) {
+        if (!control.isEnabled()) {
+            disabled.opacity = 1.0f
+            normal.opacity = 0f
+            pressed.opacity = 0f
+            return
+        }
 
-            CATransaction.commit()
+        if (control.isHighlighted()) {
+            pressed.opacity = 1.0f
+            normal.opacity = 0f
         } else {
-            link?.removeFromRunLoop(NSRunLoop.currentRunLoop, NSRunLoopCommonModes)
+            normal.opacity = 1.0f
+            pressed.opacity = 0f
         }
+        disabled.opacity = 0f
     }
 }
 
@@ -156,24 +162,22 @@ fun UIView.applyBackgroundIfNeeded(background: Background<out Fill>?) {
 
     this.backgroundColor = UIColor.clearColor
 
-    val bgLayer = background.caLayer()
+    val bgLayer: CALayer = background.caLayer()
     layer.insertSublayer(bgLayer, 0U)
 
-    // FIXME memoryleak, perfomance problem !!!
-    var link: CADisplayLink? = null
-
-    link = displayLink {
-        if (window != null) {
-            val (width, height) = layer.bounds.useContents { size.width to size.height }
+    this.displayLink(
+        context = bgLayer,
+        objectForSkipCheck = { it.layer.bounds }
+    ) { view, bgLayer ->
+        val (width: CGFloat, height: CGFloat) = view.layer.bounds.useContents {
+            this.size.width to this.size.height
+        }
 
-            CATransaction.begin()
-            CATransaction.setDisableActions(true)
+        CATransaction.begin()
+        CATransaction.setDisableActions(true)
 
-            bgLayer.frame = CGRectMake(0.0, 0.0, width, height)
+        bgLayer.frame = CGRectMake(0.0, 0.0, width, height)
 
-            CATransaction.commit()
-        } else {
-            link?.removeFromRunLoop(NSRunLoop.currentRunLoop, NSRunLoopCommonModes)
-        }
+        CATransaction.commit()
     }
 }
diff --git a/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/utils/UIControlExt.kt b/widgets/src/iosMain/kotlin/dev/icerock/moko/widgets/core/utils/UIControlExt.kt
@@ -13,9 +13,11 @@ import platform.QuartzCore.CADisplayLink
 import platform.UIKit.UIControl
 import platform.UIKit.UIControlEvents
 import platform.UIKit.UIGestureRecognizer
+import platform.UIKit.UIView
 import platform.darwin.NSObject
 import platform.objc.OBJC_ASSOCIATION_RETAIN
 import platform.objc.objc_setAssociatedObject
+import kotlin.native.ref.WeakReference
 
 fun UIControl.setEventHandler(controlEvent: UIControlEvents, action: () -> Unit) {
     val target = LambdaTarget(action)
@@ -50,10 +52,31 @@ fun UIGestureRecognizer.setHandler(action: () -> Unit) {
     )
 }
 
-fun NSObject.displayLink(action: () -> Unit): CADisplayLink {
-    val target = LambdaTarget(action)
+fun <T : Any, CTX> T.displayLink(
+    context: CTX,
+    objectForSkipCheck: (T) -> Any,
+    action: (T, CTX) -> Unit
+) {
+    val ref: WeakReference<T> = WeakReference(this)
+
+    var displayLink: CADisplayLink? = null
+
+    var oldState: Any = objectForSkipCheck(this)
+    val target = LambdaTarget {
+        val strongRef: T? = ref.get()
+        if (strongRef == null) {
+            displayLink?.removeFromRunLoop(NSRunLoop.currentRunLoop, NSRunLoopCommonModes)
+            displayLink = null
+            return@LambdaTarget
+        }
+
+        val newState: Any = objectForSkipCheck(strongRef)
+        if (newState == oldState) return@LambdaTarget
+
+        action(strongRef, context)
+    }
 
-    return CADisplayLink.displayLinkWithTarget(
+    CADisplayLink.displayLinkWithTarget(
         target = target,
         selector = NSSelectorFromString("displayLink:")
     ).apply {
