wip: time to burn down decorator

rjrjr · rjrjr · commit 0dd2acebac4f · 2022-01-07T10:36:42.000-08:00
diff --git a/samples/containers/android/src/main/java/com/squareup/sample/container/panel/PanelOverlayDialogFactory.kt b/samples/containers/android/src/main/java/com/squareup/sample/container/panel/PanelOverlayDialogFactory.kt
@@ -17,10 +17,10 @@ import com.squareup.workflow1.ui.container.setBounds
 internal object PanelOverlayDialogFactory : ModalScreenOverlayDialogFactory<PanelOverlay<*>>(
   type = PanelOverlay::class
 ) {
-  override fun buildDialogWithContentView(contentView: View): Dialog {
-    val context = contentView.context
+  override fun buildDialogWithContent(content: View): Dialog {
+    val context = content.context
     return Dialog(context, R.style.PanelDialog).also { dialog ->
-      dialog.setContentView(contentView)
+      dialog.setContentView(content)
 
       // Welcome to Android. Nothing workflow-related here, this is just how one
       // finds the window background color for the theme. I sure hope it's better in Compose.
diff --git a/workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/modal/ModalViewContainer.kt b/workflow-ui/container-android/src/main/java/com/squareup/workflow1/ui/modal/ModalViewContainer.kt
@@ -12,18 +12,17 @@ import android.view.ViewGroup
 import android.view.ViewGroup.LayoutParams.MATCH_PARENT
 import android.view.ViewGroup.LayoutParams.WRAP_CONTENT
 import androidx.annotation.IdRes
-import com.squareup.workflow1.ui.asScreen
 import com.squareup.workflow1.ui.BuilderViewFactory
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.ViewRegistry
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+import com.squareup.workflow1.ui.asScreen
 import com.squareup.workflow1.ui.backPressedHandler
 import com.squareup.workflow1.ui.bindShowRendering
 import com.squareup.workflow1.ui.buildView
 import com.squareup.workflow1.ui.modal.ModalViewContainer.Companion.binding
 import com.squareup.workflow1.ui.onBackPressedDispatcherOwnerOrNull
 import com.squareup.workflow1.ui.showRendering
-import com.squareup.workflow1.ui.start
 import kotlin.reflect.KClass
 
 /**
@@ -65,45 +64,47 @@ public open class ModalViewContainer @JvmOverloads constructor(
     initialModalRendering: Any,
     initialViewEnvironment: ViewEnvironment
   ): DialogRef<Any> {
-    val view = asScreen(initialModalRendering).buildView(
-            viewEnvironment = initialViewEnvironment,
-            contextForNewView = this.context,
-            container = this
-    )
-        .apply {
-          start()
-          // If the modal's root view has no backPressedHandler, add a no-op one to
-          // ensure that the `onBackPressed` call below will not leak up to handlers
-          // that should be blocked by this modal session.
-          if (backPressedHandler == null) backPressedHandler = { }
-        }
+    val view = asScreen(initialModalRendering)
+      .buildView(
+        viewEnvironment = initialViewEnvironment,
+        contextForNewView = this.context,
+        container = this
+      )
+      .let { holder ->
+        holder.start()
+        holder.view
+      }
+    // If the modal's root view has no backPressedHandler, add a no-op one to
+    // ensure that the `onBackPressed` call below will not leak up to handlers
+    // that should be blocked by this modal session.
+    if (view.backPressedHandler == null) view.backPressedHandler = { }
 
     return buildDialogForView(view)
-        .apply {
-          // Dialogs are modal windows and so they block events, including back button presses
-          // -- that's their job! But we *want* the Activity's onBackPressedDispatcher to fire
-          // when back is pressed, so long as it doesn't look past this modal window for handlers.
-          //
-          // Here, we handle the ACTION_UP portion of a KEYCODE_BACK key event, and below
-          // we make sure that the root view has a backPressedHandler that will consume the
-          // onBackPressed call if no child of the root modal view does.
+      .apply {
+        // Dialogs are modal windows and so they block events, including back button presses
+        // -- that's their job! But we *want* the Activity's onBackPressedDispatcher to fire
+        // when back is pressed, so long as it doesn't look past this modal window for handlers.
+        //
+        // Here, we handle the ACTION_UP portion of a KEYCODE_BACK key event, and below
+        // we make sure that the root view has a backPressedHandler that will consume the
+        // onBackPressed call if no child of the root modal view does.
 
-          setOnKeyListener { _, keyCode, keyEvent ->
-            if (keyCode == KeyEvent.KEYCODE_BACK && keyEvent.action == ACTION_UP) {
-              view.context.onBackPressedDispatcherOwnerOrNull()
-                  ?.onBackPressedDispatcher
-                  ?.let {
-                    if (it.hasEnabledCallbacks()) it.onBackPressed()
-                  }
-              true
-            } else {
-              false
-            }
+        setOnKeyListener { _, keyCode, keyEvent ->
+          if (keyCode == KeyEvent.KEYCODE_BACK && keyEvent.action == ACTION_UP) {
+            view.context.onBackPressedDispatcherOwnerOrNull()
+              ?.onBackPressedDispatcher
+              ?.let {
+                if (it.hasEnabledCallbacks()) it.onBackPressed()
+              }
+            true
+          } else {
+            false
           }
         }
-        .run {
-          DialogRef(initialModalRendering, initialViewEnvironment, this, view)
-        }
+      }
+      .run {
+        DialogRef(initialModalRendering, initialViewEnvironment, this, view)
+      }
   }
 
   override fun updateDialog(dialogRef: DialogRef<Any>) {
@@ -118,14 +119,14 @@ public open class ModalViewContainer @JvmOverloads constructor(
     type: KClass<H>
   ) : com.squareup.workflow1.ui.ViewFactory<H>
   by BuilderViewFactory(
-      type = type,
-      viewConstructor = { initialRendering, initialEnv, context, _ ->
-        ModalViewContainer(context).apply {
-          this.id = id
-          layoutParams = ViewGroup.LayoutParams(MATCH_PARENT, MATCH_PARENT)
-          bindShowRendering(initialRendering, initialEnv, ::update)
-        }
+    type = type,
+    viewConstructor = { initialRendering, initialEnv, context, _ ->
+      ModalViewContainer(context).apply {
+        this.id = id
+        layoutParams = ViewGroup.LayoutParams(MATCH_PARENT, MATCH_PARENT)
+        bindShowRendering(initialRendering, initialEnv, ::update)
       }
+    }
   )
 
   public companion object {
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/WorkflowViewStub.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/WorkflowViewStub.kt
@@ -238,24 +238,24 @@ public class WorkflowViewStub @JvmOverloads constructor(
       WorkflowLifecycleOwner.get(it)?.destroyOnDetach()
     }
 
-    val newWorkflowView = screen.buildView(
+    val newViewHolder = screen.buildView(
       viewEnvironment,
       parent.context,
       parent
     ).withStarter { view, doStart ->
       WorkflowLifecycleOwner.installOn(view.view)
       doStart()
     }
-    newWorkflowView.start()
+    newViewHolder.start()
 
-    val newAndroidView = newWorkflowView.view
+    val newAndroidView = newViewHolder.view
 
     if (inflatedId != NO_ID) newAndroidView.id = inflatedId
     if (updatesVisibility) newAndroidView.visibility = visibility
     background?.let { newAndroidView.background = it }
     propagateSavedStateRegistryOwner(newAndroidView)
     replaceOldViewInParent(parent, newAndroidView)
-    delegateHolder = newWorkflowView
+    delegateHolder = newViewHolder
   }
 
   /**
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/ModalScreenOverlayDialogFactory.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/ModalScreenOverlayDialogFactory.kt
@@ -11,6 +11,7 @@ import android.view.View
 import android.view.Window
 import android.view.WindowManager.LayoutParams.FLAG_NOT_TOUCH_MODAL
 import com.squareup.workflow1.ui.R
+import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.backPressedHandler
@@ -35,9 +36,9 @@ public abstract class ModalScreenOverlayDialogFactory<O : ScreenOverlay<*>>(
 
   /**
    * Called from [buildDialog]. Builds (but does not show) the [Dialog] to
-   * display a [contentView] built for a [ScreenOverlay.content].
+   * display a [content] view built for a [ScreenOverlay.content].
    */
-  public abstract fun buildDialogWithContentView(contentView: View): Dialog
+  public abstract fun buildDialogWithContent(content: ScreenViewHolder<*>): Dialog
 
   /**
    * If the [ScreenOverlay] displayed by a [dialog] created by this
@@ -61,21 +62,21 @@ public abstract class ModalScreenOverlayDialogFactory<O : ScreenOverlay<*>>(
     initialEnvironment: ViewEnvironment,
     context: Context
   ): Dialog {
-    val contentView = initialRendering.content.buildView(initialEnvironment, context).apply {
+    val contentHolder = initialRendering.content.buildView(initialEnvironment, context).apply {
       start()
       // If the content view has no backPressedHandler, add a no-op one to
       // ensure that the `onBackPressed` call below will not leak up to handlers
       // that should be blocked by this modal session.
       if (view.backPressedHandler == null) view.backPressedHandler = { }
     }
 
-    return buildDialogWithContentView(contentView).also { dialog ->
+    return buildDialogWithContent(contentHolder).also { dialog ->
       val window = requireNotNull(dialog.window) { "Dialog must be attached to a window." }
 
       // There is no Dialog.getContentView method, and no reliable way to reverse
       // engineer one (no, android.R.id.content doesn't work). So we stick the
       // contentView in a tag here, where updateDialog can find it later.
-      window.peekDecorView()?.setTag(R.id.workflow_modal_dialog_content, contentView)
+      window.peekDecorView()?.setTag(R.id.workflow_modal_dialog_content, contentHolder)
         ?: throw IllegalStateException("Expected decorView to have been built.")
 
       val realWindowCallback = window.callback
@@ -85,15 +86,15 @@ public abstract class ModalScreenOverlayDialogFactory<O : ScreenOverlay<*>>(
             event.action == ACTION_UP
 
           return when {
-            isBackPress -> contentView.environment?.get(ModalScreenOverlayOnBackPressed)
-              ?.onBackPressed(contentView) == true
+            isBackPress -> contentHolder.environment[ModalScreenOverlayOnBackPressed]
+              .onBackPressed(contentHolder)
             else -> realWindowCallback.dispatchKeyEvent(event)
           }
         }
       }
 
       window.setFlags(FLAG_NOT_TOUCH_MODAL, FLAG_NOT_TOUCH_MODAL)
-      dialog.maintainBounds(contentView) { d, b -> updateBounds(d, Rect(b)) }
+      dialog.maintainBounds(contentHolder.view) { d, b -> updateBounds(d, Rect(b)) }
     }
   }
 
diff --git a/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/ModalScreenOverlayOnBackPressed.kt b/workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/ModalScreenOverlayOnBackPressed.kt
@@ -1,6 +1,6 @@
 package com.squareup.workflow1.ui.container
 
-import android.view.View
+import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.ViewEnvironmentKey
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.container.ModalScreenOverlayOnBackPressed.Handler
@@ -26,11 +26,11 @@ public object ModalScreenOverlayOnBackPressed : ViewEnvironmentKey<Handler>(
      *
      * @return true if the back press event was consumed
      */
-    public fun onBackPressed(contentView: View): Boolean
+    public fun onBackPressed(content: ScreenViewHolder<*>): Boolean
   }
 
-  override val default: Handler = Handler { view ->
-    view.context.onBackPressedDispatcherOwnerOrNull()
+  override val default: Handler = Handler { viewHolder ->
+    viewHolder.view.context.onBackPressedDispatcherOwnerOrNull()
       ?.onBackPressedDispatcher
       ?.let {
         if (it.hasEnabledCallbacks()) it.onBackPressed()
