commonMain.love.forte.simbot.logger.logger.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of simbot-logger Show documentation
Simple Robot，一个通用的bot风格事件调度框架，以灵活的统一标准来编写bot应用。
There is a newer version: 4.6.0
/*
 *     Copyright (c) 2023-2024. ForteScarlet.
 *
 *     Project    https://github.com/simple-robot/simpler-robot
 *     Email      [email protected]
 *
 *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     Lesser GNU General Public License for more details.
 *
 *     You should have received a copy of the Lesser GNU General Public License
 *     along with this program.  If not, see .
 *
 */

package love.forte.simbot.logger


/**
 * 日志对象类型，用于输出日志到目标处（例如控制台）。
 *
 * ## JVM
 * 在JVM平台目标会将 [Logger] 作为 [org.slf4j.Logger] 使用。
 *
 * ## JS
 * 在JS平台中会通过 `kotlin.js.Console` 向控制台输出日志信息。详见平台实现说明。
 *
 * ## Native
 * 在native平台中则会直接使用 [println] 简单的向控制台输出日志信息。
 *
 * @author ForteScarlet
 */
@Suppress("KDocUnresolvedReference")
public expect interface Logger {
    /**
     * 当前logger的名称。
     */
    public fun getName(): String

    // region Level: TRACE

    /**
     * 是否允许 [LogLevel.TRACE] 级别的日志输出.
     */
    public fun isTraceEnabled(): Boolean

    /**
     * 输出 [LogLevel.TRACE] 级别日志。
     */
    public fun trace(log: String)

    /**
     * 输出 [LogLevel.TRACE] 级别日志。
     */
    public fun trace(log: String, vararg arg: Any?)
    // endregion

    // region Level: DEBUG

    /**
     * 是否允许 [LogLevel.DEBUG] 级别的日志输出.
     */
    public fun isDebugEnabled(): Boolean

    /**
     * 输出 [LogLevel.DEBUG] 级别日志。
     */
    public fun debug(log: String)

    /**
     * 输出 [LogLevel.DEBUG] 级别日志。
     */
    public fun debug(log: String, vararg arg: Any?)
    // endregion

    // region Level: INFO

    /**
     * 是否允许 [LogLevel.INFO] 级别的日志输出.
     */
    public fun isInfoEnabled(): Boolean

    /**
     * 输出 [LogLevel.INFO] 级别日志。
     */
    public fun info(log: String)

    /**
     * 输出 [LogLevel.INFO] 级别日志。
     */
    public fun info(log: String, vararg arg: Any?)
    // endregion

    // region Level: WARN

    /**
     * 是否允许 [LogLevel.WARN] 级别的日志输出.
     */
    public fun isWarnEnabled(): Boolean

    /**
     * 输出 [LogLevel.WARN] 级别日志。
     */
    public fun warn(log: String)

    /**
     * 输出 [LogLevel.WARN] 级别日志。
     */
    public fun warn(log: String, vararg arg: Any?)
    // endregion

    // region Level: ERROR

    /**
     * 是否允许 [LogLevel.ERROR] 级别的日志输出.
     */
    public fun isErrorEnabled(): Boolean

    /**
     * 输出 [LogLevel.WARN] 级别日志。
     */
    public fun error(log: String)

    /**
     * 输出 [LogLevel.WARN] 级别日志。
     */
    public fun error(log: String, vararg arg: Any?)
    // endregion
}

public inline val Logger.name: String get() = getName()
public inline val Logger.isTraceEnabled: Boolean get() = isTraceEnabled()
public inline val Logger.isDebugEnabled: Boolean get() = isDebugEnabled()
public inline val Logger.isInfoEnabled: Boolean get() = isInfoEnabled()
public inline val Logger.isWarnEnabled: Boolean get() = isWarnEnabled()
public inline val Logger.isErrorEnabled: Boolean get() = isErrorEnabled()