packages/SystemUI/src/com/android/systemui/temporarydisplay/TemporaryViewLogger.kt

/*
 * Copyright (C) 2022 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.temporarydisplay

import com.android.systemui.plugins.log.LogBuffer
import com.android.systemui.plugins.log.LogLevel

/** A logger for temporary view changes -- see [TemporaryViewDisplayController]. */
open class TemporaryViewLogger(
    internal val buffer: LogBuffer,
    internal val tag: String,
) {
    /** Logs that we added the view with the given [id] in a window titled [windowTitle]. */
    fun logViewAddition(id: String, windowTitle: String) {
        buffer.log(
            tag,
            LogLevel.DEBUG,
            {
                str1 = windowTitle
                str2 = id
            },
            { "View added. window=$str1 id=$str2" }
        )
    }

    /** Logs that we removed the view with the given [id] for the given [reason]. */
    fun logViewRemoval(id: String, reason: String) {
        buffer.log(
            tag,
            LogLevel.DEBUG,
            {
                str1 = reason
                str2 = id
            },
            { "View with id=$str2 is removed due to: $str1" }
        )
    }

    /** Logs that we ignored removal of the view with the given [id]. */
    fun logViewRemovalIgnored(id: String, reason: String) {
        buffer.log(
            tag,
            LogLevel.DEBUG,
            {
                str1 = reason
                str2 = id
            },
            { "Removal of view with id=$str2 is ignored because $str1" }
        )
    }
}