glib/org.gtkkn.extensions.glib.util.log/Log

Log

object Log

Log acts as a global, thread-safe manager for log writers.

By default, no writers are installed, so no logs will appear. To enable logging, add one or more LogWriters using install. All logging calls will be delegated to the installed writers.

You can remove a writer using uninstall, and multiple writers can be active at the same time.

This approach solves:

Having multiple loggers: Just install multiple writers.
No duplication of installation logic: Add or remove writers through Log.
Easy extensibility: Implement your own LogWriter to customize messages or formatting.

Properties

defaultDomain

var defaultDomain: String?

A user-configurable default domain for logs. If set, any log call with domain = null will use this value instead of deriving it from the caller.

defaultReleaseLogLevel

val defaultReleaseLogLevel: LogLevel

Determines the default minimum level for release builds based on whether GLib's debug logging is enabled.

Functions

install

fun install(writer: LogWriter)

Installs a new writer to the global logging system.

installConsoleLogWriter

fun Log.installConsoleLogWriter(minLevelDebug: LogLevel = LogLevel.DEBUG, minLevelRelease: LogLevel = defaultReleaseLogLevel, time: Boolean = true)

Installs this writer for both debug and release builds.

installConsoleLogWriterForDebugBuilds

fun Log.installConsoleLogWriterForDebugBuilds(minLevel: LogLevel = LogLevel.DEBUG, time: Boolean = true)

Installs this writer for debug builds if the application is debuggable.

installConsoleLogWriterForReleaseBuilds

fun Log.installConsoleLogWriterForReleaseBuilds(minLevel: LogLevel = defaultReleaseLogLevel, time: Boolean = true)

Installs this writer for release builds if the application is not debuggable.

installGLibLogWriter

fun Log.installGLibLogWriter(minLevelDebug: LogLevel = LogLevel.DEBUG, minLevelRelease: LogLevel = defaultReleaseLogLevel)

Installs this writer for both debug and release builds.

installGLibLogWriterForDebugBuilds

fun Log.installGLibLogWriterForDebugBuilds(minPriority: LogLevel = LogLevel.DEBUG)

Installs this writer for debug builds if the application is debuggable.

installGLibLogWriterForReleaseBuilds

fun Log.installGLibLogWriterForReleaseBuilds(minPriority: LogLevel = defaultReleaseLogLevel)

Installs this writer for release builds if the application is not debuggable.

isGLogDebugEnabled

fun isGLogDebugEnabled(): Boolean

Checks if GLib debug logging is enabled.

uninstall

fun uninstall(writer: LogWriter)

Uninstalls an installed writer.

uninstallAll

fun uninstallAll()

Uninstalls all currently installed writers.