1 /*
2  * Copyright (C) 2024 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.systemui.dagger
18 
19 import com.android.systemui.unfold.SysUIUnfoldComponent
20 import com.android.systemui.unfold.SysUIUnfoldModule.BoundFromSysUiUnfoldModule
21 import dagger.BindsOptionalOf
22 import dagger.Module
23 import dagger.Provides
24 import java.util.Optional
25 import kotlin.jvm.optionals.getOrElse
26 
27 
28 /**
29  * Module for foldable-related classes that is available in all SystemUI variants.
30  * Provides `Optional<SysUIUnfoldComponent>` which is present when the device is a foldable
31  * device that has fold/unfold animation enabled.
32  */
33 @Module
34 abstract class CommonSystemUIUnfoldModule {
35 
36     /* Note this will be injected as @BoundFromSysUiUnfoldModule Optional<Optional<...>> */
37     @BindsOptionalOf
38     @BoundFromSysUiUnfoldModule
optionalSysUiUnfoldComponentnull39     abstract fun optionalSysUiUnfoldComponent(): Optional<SysUIUnfoldComponent>
40 
41     companion object {
42         @Provides
43         @SysUISingleton
44         fun sysUiUnfoldComponent(
45             /**
46              * This will be empty when [com.android.systemui.unfold.SysUIUnfoldModule] is not part
47              * of the graph, and contain the optional when it is.
48              */
49             @BoundFromSysUiUnfoldModule
50             optionalOfOptional: Optional<Optional<SysUIUnfoldComponent>>
51         ): Optional<SysUIUnfoldComponent> = optionalOfOptional.getOrElse { Optional.empty() }
52     }
53 }