Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 54a0fae8 authored by Jordan Demeulenaere's avatar Jordan Demeulenaere
Browse files

Introduce ComposeInitializer (1/2) 

This CL introduces ComposeInitializer, which can be used by Window root
views to make Compose usable in that window. Once a Window is
initialized, we can simply add ComposeViews to the Window hierarchy and
they will work as expected.

This CL also uses ComposeInitializer in the NotificationShadeWindowView.
This will be used by the Quick Settings footer actions, that have
already been implemented using Compose.

Bug: 230740991
Test: ComposeInitializerTest
Change-Id: I232bd12d3a46083101663a5bc557472263c27c38
parent 6bc0686d

packages/SystemUI/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -271,6 +271,7 @@ android_library { 
        "LowLightDreamLib",

        "motion_tool_lib",

        "androidx.core_core-animation-testing-nodeps",

        "androidx.compose.ui_ui",

    ],

}

packages/SystemUI/compose/facade/disabled/src/com/android/systemui/compose/ComposeFacade.kt

+5 −1
Original line number Diff line number Diff line
@@ -24,6 +24,10 @@ import com.android.systemui.people.ui.viewmodel.PeopleViewModel 
object ComposeFacade : BaseComposeFacade {

    override fun isComposeAvailable(): Boolean = false



    override fun composeInitializer(): ComposeInitializer {

        throwComposeUnavailableError()

    }



    override fun setPeopleSpaceActivityContent(

        activity: ComponentActivity,

        viewModel: PeopleViewModel,
@@ -32,7 +36,7 @@ object ComposeFacade : BaseComposeFacade { 
        throwComposeUnavailableError()

    }



    private fun throwComposeUnavailableError() {

    private fun throwComposeUnavailableError(): Nothing {

        error(

            "Compose is not available. Make sure to check isComposeAvailable() before calling any" +

                " other function on ComposeFacade."

packages/SystemUI/compose/facade/enabled/src/com/android/systemui/compose/ComposeFacade.kt

+2 −0
Original line number Diff line number Diff line
@@ -26,6 +26,8 @@ import com.android.systemui.people.ui.viewmodel.PeopleViewModel 
object ComposeFacade : BaseComposeFacade {

    override fun isComposeAvailable(): Boolean = true



    override fun composeInitializer(): ComposeInitializer = ComposeInitializerImpl



    override fun setPeopleSpaceActivityContent(

        activity: ComponentActivity,

        viewModel: PeopleViewModel,

packages/SystemUI/compose/facade/enabled/src/com/android/systemui/compose/ComposeInitializerImpl.kt

0 → 100644
+78 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.compose



import android.view.View

import androidx.lifecycle.Lifecycle

import androidx.lifecycle.ViewTreeLifecycleOwner

import androidx.savedstate.SavedStateRegistry

import androidx.savedstate.SavedStateRegistryController

import androidx.savedstate.SavedStateRegistryOwner

import com.android.compose.animation.ViewTreeSavedStateRegistryOwner

import com.android.systemui.lifecycle.ViewLifecycleOwner



internal object ComposeInitializerImpl : ComposeInitializer {

    override fun onAttachedToWindow(root: View) {

        if (ViewTreeLifecycleOwner.get(root) != null) {

            error("root $root already has a LifecycleOwner")

        }



        val parent = root.parent

        if (parent is View && parent.id != android.R.id.content) {

            error(

                "ComposeInitializer.onAttachedToWindow(View) must be called on the content child." +

                    "Outside of activities and dialogs, this is usually the top-most View of a " +

                    "window."

            )

        }



        // The lifecycle owner, which is STARTED when [root] is visible and RESUMED when [root] is

        // both visible and focused.

        val lifecycleOwner = ViewLifecycleOwner(root)



        // We create a trivial implementation of [SavedStateRegistryOwner] that does not do any save

        // or restore because SystemUI process is always running and top-level windows using this

        // initializer are created once, when the process is started.

        val savedStateRegistryOwner =

            object : SavedStateRegistryOwner {

                private val savedStateRegistry =

                    SavedStateRegistryController.create(this).apply { performRestore(null) }



                override fun getLifecycle(): Lifecycle = lifecycleOwner.lifecycle



                override fun getSavedStateRegistry(): SavedStateRegistry {

                    return savedStateRegistry.savedStateRegistry

                }

            }



        // We must call [ViewLifecycleOwner.onCreate] after creating the [SavedStateRegistryOwner]

        // because `onCreate` might move the lifecycle state to STARTED which will make

        // [SavedStateRegistryController.performRestore] throw.

        lifecycleOwner.onCreate()



        // Set the owners on the root. They will be reused by any ComposeView inside the root

        // hierarchy.

        ViewTreeLifecycleOwner.set(root, lifecycleOwner)

        ViewTreeSavedStateRegistryOwner.set(root, savedStateRegistryOwner)

    }



    override fun onDetachedFromWindow(root: View) {

        (ViewTreeLifecycleOwner.get(root) as ViewLifecycleOwner).onDestroy()

        ViewTreeLifecycleOwner.set(root, null)

        ViewTreeSavedStateRegistryOwner.set(root, null)

    }

}

packages/SystemUI/src/com/android/systemui/compose/BaseComposeFacade.kt

+5 −0
Original line number Diff line number Diff line
@@ -35,6 +35,11 @@ interface BaseComposeFacade { 
     */

    fun isComposeAvailable(): Boolean



    /**

     * Return the [ComposeInitializer] to make Compose usable in windows outside normal activities.

     */

    fun composeInitializer(): ComposeInitializer



    /** Bind the content of [activity] to [viewModel]. */

    fun setPeopleSpaceActivityContent(

        activity: ComponentActivity,