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.statusbar.chips.notification.shared 18 19 import android.app.Flags 20 import com.android.systemui.flags.FlagToken 21 import com.android.systemui.flags.RefactorFlagUtils 22 23 // NOTE: We're merging this flag with the `ui_rich_ongoing` flag. 24 // We'll replace all usages of this class with PromotedNotificationUi as a follow-up. 25 26 /** Helper for reading or using the status bar promoted notification chips flag state. */ 27 @Suppress("NOTHING_TO_INLINE") 28 object StatusBarNotifChips { 29 /** The aconfig flag name */ 30 const val FLAG_NAME = Flags.FLAG_UI_RICH_ONGOING 31 32 /** A token used for dependency declaration */ 33 val token: FlagToken 34 get() = FlagToken(FLAG_NAME, isEnabled) 35 36 /** Is the refactor enabled */ 37 @JvmStatic 38 inline val isEnabled 39 get() = Flags.uiRichOngoing() 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 inline fun isUnexpectedlyInLegacyMode() = 48 RefactorFlagUtils.isUnexpectedlyInLegacyMode(isEnabled, FLAG_NAME) 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 not enabled to ensure that the refactor author catches issues in testing. 53 * Caution!! Using this check incorrectly will cause crashes in nextfood builds! 54 */ 55 @JvmStatic 56 @Deprecated("Avoid crashing.", ReplaceWith("if (this.isUnexpectedlyInLegacyMode()) return")) 57 inline fun unsafeAssertInNewMode() = 58 RefactorFlagUtils.unsafeAssertInNewMode(isEnabled, FLAG_NAME) 59 60 /** 61 * Called to ensure code is only run when the flag is disabled. This will throw an exception if 62 * the flag is enabled to ensure that the refactor author catches issues in testing. 63 */ 64 @JvmStatic 65 inline fun assertInLegacyMode() = RefactorFlagUtils.assertInLegacyMode(isEnabled, FLAG_NAME) 66 } 67