libraries/flicker/src/android/tools/common/traces/surfaceflinger/LayersTrace.kt

/*
 * Copyright (C) 2023 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 android.tools.common.traces.surfaceflinger

import android.tools.common.ITrace
import android.tools.common.Timestamp
import kotlin.js.JsExport
import kotlin.js.JsName

/**
 * Contains a collection of parsed Layers trace entries and assertions to apply over a single entry.
 *
 * Each entry is parsed into a list of [LayerTraceEntry] objects.
 *
 * This is a generic object that is reused by both Flicker and Winscope and cannot access internal
 * Java/Android functionality
 */
@JsExport
data class LayersTrace(override val entries: Array<LayerTraceEntry>) : ITrace<LayerTraceEntry> {
    override fun toString(): String {
        return "LayersTrace(Start: ${entries.firstOrNull()}, " + "End: ${entries.lastOrNull()})"
    }

    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (other !is LayersTrace) return false

        if (!entries.contentEquals(other.entries)) return false

        return true
    }

    override fun hashCode(): Int {
        return entries.contentHashCode()
    }

    @JsName("vSyncSlice")
    fun vSyncSlice(from: Int, to: Int): LayersTrace {
        return LayersTrace(
            this.entries
                .dropWhile { it.vSyncId < from }
                .dropLastWhile { it.vSyncId > to }
                .toTypedArray()
        )
    }

    override fun slice(startTimestamp: Timestamp, endTimestamp: Timestamp): LayersTrace {
        return LayersTrace(
            entries
                .dropWhile { it.timestamp < startTimestamp }
                .dropLastWhile { it.timestamp > endTimestamp }
                .toTypedArray()
        )
    }
}