arctia
8c1a97a6b9
- add SimpleLogger class - add LogLevel enum and current_log_level which serve to show only logs with level > to it - add trace, debug, info, warning, error functions and their abbreviate form - add _print function which is in charge to print the message - the message can have timestamp and type being showed before the message [<type> ][<timestamp>]: <message> - add the possibility to let specify a file where to save the file in append mode
109 lines
2.3 KiB
GDScript
109 lines
2.3 KiB
GDScript
class_name SimpleLogger extends Node
|
|
|
|
|
|
enum LogLevel {
|
|
TRACE,
|
|
DEBUG,
|
|
INFO,
|
|
WARN,
|
|
ERROR
|
|
}
|
|
|
|
|
|
@export var current_log_level:LogLevel = LogLevel.DEBUG
|
|
@export var enable_timestamp:bool = true
|
|
@export var save_log:bool = false
|
|
@export var folder:String = ""
|
|
@export var log_filename:String = "addons/Logs/data.log"
|
|
|
|
const TIMESTAMP_FORMAT:String = "%H:%M:%S"
|
|
const LOG_FORMAT_TIMESTAMP:String = "[%s]|[%-6s]: %s"
|
|
const LOG_FORMAT:String = "[%-6s]: %s"
|
|
|
|
var log_file_path = folder + log_filename
|
|
|
|
|
|
#region Logger main stuff
|
|
|
|
func _print(level: LogLevel, ...args: Array) -> void:
|
|
if level < current_log_level: return
|
|
|
|
var level_str:String = LogLevel.keys()[level]
|
|
var timestamp := Time.get_time_string_from_system()
|
|
var text: String = ""
|
|
for arg:Variant in args:
|
|
for arg2 in arg:
|
|
text += str(arg2)
|
|
|
|
var message:String = LOG_FORMAT_TIMESTAMP % [
|
|
timestamp,
|
|
level_str,
|
|
text,
|
|
] if self.enable_timestamp else LOG_FORMAT % [
|
|
level_str,
|
|
text,
|
|
]
|
|
|
|
match level:
|
|
LogLevel.ERROR: push_error(message)
|
|
LogLevel.WARN: push_warning(message)
|
|
_: print(message)
|
|
|
|
if self.save_log: self._save_logs_to_file(message)
|
|
|
|
|
|
func _save_logs_to_file(message: String) -> bool:
|
|
var file := FileAccess.open(self.log_file_path, FileAccess.READ_WRITE)
|
|
if file == null:
|
|
DirAccess.make_dir_recursive_absolute(self.folder)
|
|
var tmp_file = FileAccess.open(self.log_file_path, FileAccess.WRITE)
|
|
if tmp_file == null:
|
|
push_error("Failed to create file %s" % self.log_file_path)
|
|
return false
|
|
file = tmp_file
|
|
file.seek_end()
|
|
file.store_line(message)
|
|
return true
|
|
|
|
#endregion
|
|
|
|
|
|
#region level functions
|
|
|
|
func trace(...args: Array) -> void:
|
|
_print(LogLevel.TRACE, args)
|
|
|
|
func debug(...args: Array) -> void:
|
|
_print(LogLevel.DEBUG, args)
|
|
|
|
func info(...args: Array) -> void:
|
|
_print(LogLevel.INFO, args)
|
|
|
|
func warning(...args: Array) -> void:
|
|
_print(LogLevel.WARN, args)
|
|
|
|
func error(...args: Array) -> void:
|
|
_print(LogLevel.ERROR, args)
|
|
|
|
#endregion
|
|
|
|
|
|
#region abbreviated functions
|
|
|
|
func t(...args: Array) -> void:
|
|
_print(LogLevel.TRACE, args)
|
|
|
|
func d(...args: Array) -> void:
|
|
_print(LogLevel.DEBUG, args)
|
|
|
|
func i(...args: Array) -> void:
|
|
_print(LogLevel.INFO, args)
|
|
|
|
func w(...args: Array) -> void:
|
|
_print(LogLevel.WARN, args)
|
|
|
|
func e(...args: Array) -> void:
|
|
_print(LogLevel.ERROR, args)
|
|
|
|
#endregion
|