Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 889db72f authored by Caitlin Shkuratov's avatar Caitlin Shkuratov
Browse files

[Pod] Add all public methods of TableLogBuffer to interface. 

Previously, TableLogBuffer's interface only had the methods used by the
plugin library. But to move TableLogBuffer to a pod, we need all its
public methods to be part of the interface.

Bug: 307607958
Flag: EXEMPT refactor
Test: m SystemUI-core
Test: m SystemUISharedLib
Change-Id: I3d1cb9cb99b0fbb9da58816fda7c371d9d567eb8
parent 8eaf6b90

packages/SystemUI/plugin/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -50,6 +50,7 @@ java_library { 
    static_libs: [

        "androidx.annotation_annotation",

        "androidx-constraintlayout_constraintlayout",

        "com.android.systemui.log.table-api",

        "PlatformAnimationLib",

        "PluginCoreLib",

        "SystemUICommon",

packages/SystemUI/plugin/src/com/android/systemui/plugins/log/TableLogBufferBase.kt

+48 −3
Original line number Diff line number Diff line
@@ -14,6 +14,9 @@ 


package com.android.systemui.plugins.log



import com.android.systemui.log.table.Diffable

import com.android.systemui.log.table.TableRowLogger



/**

 * Base interface for a logger that logs changes in table format.

 *
@@ -29,7 +32,11 @@ interface TableLogBufferBase { 
        logChange(prefix, columnName, value, isInitial = false)

    }



    /** Logs a String? change. */

    /**

     * Logs a String? change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    fun logChange(prefix: String = "", columnName: String, value: String?, isInitial: Boolean)



    /**
@@ -41,7 +48,11 @@ interface TableLogBufferBase { 
        logChange(prefix, columnName, value, isInitial = false)

    }



    /** Logs a Boolean change. */

    /**

     * Logs a Boolean change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    fun logChange(prefix: String = "", columnName: String, value: Boolean, isInitial: Boolean)



    /**
@@ -53,6 +64,40 @@ interface TableLogBufferBase { 
        logChange(prefix, columnName, value, isInitial = false)

    }



    /** Logs an Int? change. */

    /**

     * Logs an Int? change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    fun logChange(prefix: String = "", columnName: String, value: Int?, isInitial: Boolean)



    /**

     * Log the differences between [prevVal] and [newVal].

     *

     * The [newVal] object's method [Diffable.logDiffs] will be used to fetch the diffs.

     *

     * @param columnPrefix a prefix that will be applied to every column name that gets logged. This

     *   ensures that all the columns related to the same state object will be grouped together in

     *   the table.

     * @throws IllegalArgumentException if [columnPrefix] or column name contain "|". "|" is used as

     *   the separator token for parsing, so it can't be present in any part of the column name.

     */

    fun <T : Diffable<T>> logDiffs(columnPrefix: String = "", prevVal: T, newVal: T)



    /**

     * Logs change(s) to the buffer using [rowInitializer].

     *

     * @param columnPrefix see [logDiffs].

     * @param rowInitializer a function that will be called immediately to store relevant data on

     *   the row.

     * @param isInitial true if this change represents the starting value for a particular column

     *   (as opposed to a value that was updated after receiving new information). This is used to

     *   help us identify which values were just default starting values, and which values were

     *   derived from updated information. Most callers should use false for this value.

     */

    fun logChange(

        columnPrefix: String = "",

        isInitial: Boolean = false,

        rowInitializer: (TableRowLogger) -> Unit,

    )

}

packages/SystemUI/src/com/android/systemui/log/table/TableLogBuffer.kt

+4 −41
Original line number Diff line number Diff line
@@ -112,19 +112,8 @@ class TableLogBuffer( 
            tableLogBuffer = this,

        )



    /**

     * Log the differences between [prevVal] and [newVal].

     *

     * The [newVal] object's method [Diffable.logDiffs] will be used to fetch the diffs.

     *

     * @param columnPrefix a prefix that will be applied to every column name that gets logged. This

     *   ensures that all the columns related to the same state object will be grouped together in

     *   the table.

     * @throws IllegalArgumentException if [columnPrefix] or column name contain "|". "|" is used as

     *   the separator token for parsing, so it can't be present in any part of the column name.

     */

    @Synchronized

    fun <T : Diffable<T>> logDiffs(columnPrefix: String = "", prevVal: T, newVal: T) {

    override fun <T : Diffable<T>> logDiffs(columnPrefix: String, prevVal: T, newVal: T) {

        val row = tempRow

        row.timestamp = systemClock.currentTimeMillis()

        row.columnPrefix = columnPrefix
@@ -133,21 +122,10 @@ class TableLogBuffer( 
        newVal.logDiffs(prevVal, row)

    }



    /**

     * Logs change(s) to the buffer using [rowInitializer].

     *

     * @param columnPrefix see [logDiffs].

     * @param rowInitializer a function that will be called immediately to store relevant data on

     *   the row.

     * @param isInitial true if this change represents the starting value for a particular column

     *   (as opposed to a value that was updated after receiving new information). This is used to

     *   help us identify which values were just default starting values, and which values were

     *   derived from updated information. Most callers should use false for this value.

     */

    @Synchronized

    fun logChange(

        columnPrefix: String = "",

        isInitial: Boolean = false,

    override fun logChange(

        columnPrefix: String,

        isInitial: Boolean,

        rowInitializer: (TableRowLogger) -> Unit,

    ) {

        val row = tempRow
@@ -157,29 +135,14 @@ class TableLogBuffer( 
        rowInitializer(row)

    }



    /**

     * Logs a String? change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    override fun logChange(prefix: String, columnName: String, value: String?, isInitial: Boolean) {

        logChange(systemClock.currentTimeMillis(), prefix, columnName, value, isInitial)

    }



    /**

     * Logs a boolean change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    override fun logChange(prefix: String, columnName: String, value: Boolean, isInitial: Boolean) {

        logChange(systemClock.currentTimeMillis(), prefix, columnName, value, isInitial)

    }



    /**

     * Logs a Int change.

     *

     * @param isInitial see [TableLogBuffer.logChange(String, Boolean, (TableRowLogger) -> Unit].

     */

    override fun logChange(prefix: String, columnName: String, value: Int?, isInitial: Boolean) {

        logChange(systemClock.currentTimeMillis(), prefix, columnName, value, isInitial)

    }