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.shade.shared.flag
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 and using the Dual Shade feature flag. */
24 object DualShade {
25 
26     /** The aconfig flag name. */
27     const val FLAG_NAME = Flags.FLAG_DUAL_SHADE
28 
29     /** The flag description -- not an aconfig flag name. */
30     const val DESCRIPTION = "DualShadeFlag"
31 
32     /** A token used for dependency declaration. */
33     val token: FlagToken
34         get() = FlagToken(FLAG_NAME, isEnabled)
35 
36     /** Whether the feature is enabled. */
37     @JvmStatic
38     inline val isEnabled
39         get() = Flags.dualShade()
40 
41     /**
42      * Called to ensure code is only run when the flag is enabled. This protects users from the
43      * unintended behaviors caused by accidentally running new logic, while also crashing on an eng
44      * build to ensure that the refactor author catches issues in testing.
45      */
46     @JvmStatic
isUnexpectedlyInLegacyModenull47     fun isUnexpectedlyInLegacyMode() =
48         RefactorFlagUtils.isUnexpectedlyInLegacyMode(isEnabled, DESCRIPTION)
49 
50     /**
51      * Called to ensure code is only run when the flag is disabled. This will throw an exception if
52      * the flag is enabled to ensure that the refactor author catches issues in testing.
53      */
54     @JvmStatic
55     fun assertInLegacyMode() = RefactorFlagUtils.assertInLegacyMode(isEnabled, DESCRIPTION)
56 }
57