Merge "[SB][Screen Chips] Add top-level chips VM and two individual VMs." into main

/*

 * Copyright (C) 2024 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.statusbar.chips.call.domain.interactor

import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.statusbar.chips.domain.interactor.OngoingActivityChipInteractor

import com.android.systemui.statusbar.chips.ui.model.OngoingActivityChipModel

import javax.inject.Inject

import kotlinx.coroutines.flow.MutableStateFlow

import kotlinx.coroutines.flow.StateFlow

/** Interactor for the ongoing phone call chip shown in the status bar. */

@SysUISingleton

open class CallChipInteractor @Inject constructor() : OngoingActivityChipInteractor {

    // TODO(b/332662551): Implement this flow.

    override val chip: StateFlow<OngoingActivityChipModel> =

        MutableStateFlow(OngoingActivityChipModel.Hidden)

}

/*

 * Copyright (C) 2024 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.statusbar.chips.domain.interactor

import com.android.systemui.statusbar.chips.ui.model.OngoingActivityChipModel

import kotlinx.coroutines.flow.StateFlow

/** Interface for an interactor that knows the state of a single type of ongoing activity chip. */

interface OngoingActivityChipInteractor {

    /** A flow modeling the chip that should be shown. */

    val chip: StateFlow<OngoingActivityChipModel>

}

/*

 * Copyright (C) 2024 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.statusbar.chips.screenrecord.domain.interactor

import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.statusbar.chips.ui.model.OngoingActivityChipModel

import com.android.systemui.statusbar.chips.domain.interactor.OngoingActivityChipInteractor

import javax.inject.Inject

import kotlinx.coroutines.flow.MutableStateFlow

import kotlinx.coroutines.flow.StateFlow

/** Interactor for the screen recording chip shown in the status bar. */

@SysUISingleton

open class ScreenRecordChipInteractor @Inject constructor() : OngoingActivityChipInteractor {

    // TODO(b/332662551): Implement this flow.

    override val chip: StateFlow<OngoingActivityChipModel> =

        MutableStateFlow(OngoingActivityChipModel.Hidden)

}

/*

 * Copyright (C) 2024 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.statusbar.chips.ui.model

import android.view.View

import com.android.systemui.common.shared.model.Icon

/** Model representing the display of an ongoing activity as a chip in the status bar. */

sealed class OngoingActivityChipModel {

    /** This chip shouldn't be shown. */

    data object Hidden : OngoingActivityChipModel()

    /** This chip should be shown with the given information. */

    data class Shown(

        /** The icon to show on the chip. */

        val icon: Icon,

        /**

         * The time this event started, used to show the timer.

         *

         * This time should be relative to

         * [com.android.systemui.util.time.SystemClock.elapsedRealtime], *not*

         * [com.android.systemui.util.time.SystemClock.currentTimeMillis] because the

         * [ChipChronometer] is based off of elapsed realtime. See

         * [android.widget.Chronometer.setBase].

         */

        val startTimeMs: Long,

        /** Listener method to invoke when this chip is clicked. */

        val onClickListener: View.OnClickListener,

    ) : OngoingActivityChipModel()

}

/*

 * Copyright (C) 2024 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.statusbar.chips.ui.viewmodel

import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.dagger.qualifiers.Application

import com.android.systemui.statusbar.chips.call.domain.interactor.CallChipInteractor

import com.android.systemui.statusbar.chips.screenrecord.domain.interactor.ScreenRecordChipInteractor

import com.android.systemui.statusbar.chips.ui.model.OngoingActivityChipModel

import javax.inject.Inject

import kotlinx.coroutines.CoroutineScope

import kotlinx.coroutines.flow.SharingStarted

import kotlinx.coroutines.flow.StateFlow

import kotlinx.coroutines.flow.combine

import kotlinx.coroutines.flow.stateIn

/**

 * View model deciding which ongoing activity chip to show in the status bar.

 *

 * There may be multiple ongoing activities at the same time, but we can only ever show one chip at

 * any one time (for now). This class decides which ongoing activity to show if there are multiple.

 */

@SysUISingleton

class OngoingActivityChipsViewModel

@Inject

constructor(

    @Application scope: CoroutineScope,

    screenRecordChipInteractor: ScreenRecordChipInteractor,

    callChipInteractor: CallChipInteractor,

) {

    /**

     * A flow modeling the chip that should be shown in the status bar after accounting for possibly

     * multiple ongoing activities.

     *

     * [com.android.systemui.statusbar.phone.fragment.CollapsedStatusBarFragment] is responsible for

     * actually displaying the chip.

     */

    val chip: StateFlow<OngoingActivityChipModel> =

        combine(screenRecordChipInteractor.chip, callChipInteractor.chip) { screenRecord, call ->

                // This `when` statement shows the priority order of the chips

                when {

                    screenRecord is OngoingActivityChipModel.Shown -> screenRecord

                    else -> call

                }

            }

            .stateIn(scope, SharingStarted.WhileSubscribed(), OngoingActivityChipModel.Hidden)

}