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.keyguard.shared
18 
19 import com.android.systemui.Flags
20 import com.android.systemui.flags.FlagToken
21 import com.android.systemui.flags.RefactorFlagUtils
22 
23 /** Helper for reading or using the compose lockscreen flag state. */
24 @Suppress("NOTHING_TO_INLINE")
25 object ComposeLockscreen {
26     /** The aconfig flag name */
27     const val FLAG_NAME = Flags.FLAG_COMPOSE_LOCKSCREEN
28 
29     /** A token used for dependency declaration */
30     val token: FlagToken
31         get() = FlagToken(FLAG_NAME, isEnabled)
32 
33     /** Is the refactor enabled */
34     @JvmStatic
35     inline val isEnabled
36         get() = Flags.composeLockscreen()
37 
38     /**
39      * Called to ensure code is only run when the flag is enabled. This protects users from the
40      * unintended behaviors caused by accidentally running new logic, while also crashing on an eng
41      * build to ensure that the refactor author catches issues in testing.
42      */
43     @JvmStatic
isUnexpectedlyInLegacyModenull44     inline fun isUnexpectedlyInLegacyMode() =
45         RefactorFlagUtils.isUnexpectedlyInLegacyMode(isEnabled, FLAG_NAME)
46 
47     /**
48      * Called to ensure code is only run when the flag is disabled. This will throw an exception if
49      * the flag is enabled to ensure that the refactor author catches issues in testing.
50      */
51     @JvmStatic
52     inline fun assertInLegacyMode() = RefactorFlagUtils.assertInLegacyMode(isEnabled, FLAG_NAME)
53 }
54