first

addons/netfox.internals/logger.gd

@@ -0,0 +1,146 @@
+extends RefCounted
+class_name _NetfoxLogger
+
+enum {
+	LOG_MIN,
+	LOG_TRACE,
+	LOG_DEBUG,
+	LOG_INFO,
+	LOG_WARN,
+	LOG_ERROR,
+	LOG_MAX
+}
+
+const DEFAULT_LOG_LEVEL := LOG_DEBUG
+
+static var log_level: int
+static var module_log_level: Dictionary
+
+static var _tags: Dictionary = {}
+static var _ordered_tags: Array[Callable] = []
+
+var module: String
+var name: String
+
+const level_prefixes: Array[String] = [
+	"",
+	"TRC",
+	"DBG",
+	"INF",
+	"WRN",
+	"ERR",
+	""
+]
+
+static func for_netfox(p_name: String) -> _NetfoxLogger:
+	return _NetfoxLogger.new("netfox", p_name)
+
+static func for_noray(p_name: String) -> _NetfoxLogger:
+	return _NetfoxLogger.new("netfox.noray", p_name)
+
+static func for_extras(p_name: String) -> _NetfoxLogger:
+	return _NetfoxLogger.new("netfox.extras", p_name)
+
+static func make_setting(name: String) -> Dictionary:
+	return {
+		"name": name,
+		"value": DEFAULT_LOG_LEVEL,
+		"type": TYPE_INT,
+		"hint": PROPERTY_HINT_ENUM,
+		"hint_string": "All,Trace,Debug,Info,Warning,Error,None"
+	}
+
+static func register_tag(tag: Callable, priority: int = 0) -> void:
+	# Save tag
+	if not _tags.has(priority):
+		_tags[priority] = [tag]
+	else:
+		_tags[priority].push_back(tag)
+
+	# Recalculate tag order
+	_ordered_tags.clear()
+	
+	var prio_groups = _tags.keys()
+	prio_groups.sort()
+
+	for prio_group in prio_groups:
+		var tag_group = _tags[prio_group]
+		_ordered_tags.append_array(tag_group)
+
+static func free_tag(tag: Callable) -> void:
+	for priority in _tags.keys():
+		var priority_group := _tags[priority] as Array
+		priority_group.erase(tag)
+
+		# NOTE: Arrays are passed as reference, no need to re-assign after modifying
+		if priority_group.is_empty():
+			_tags.erase(priority)
+
+	_ordered_tags.erase(tag)
+
+static func _static_init():
+	log_level = ProjectSettings.get_setting("netfox/logging/log_level", DEFAULT_LOG_LEVEL)
+	module_log_level = {
+		"netfox": ProjectSettings.get_setting("netfox/logging/netfox_log_level", DEFAULT_LOG_LEVEL),
+		"netfox.noray": ProjectSettings.get_setting("netfox/logging/netfox_noray_log_level", DEFAULT_LOG_LEVEL),
+		"netfox.extras": ProjectSettings.get_setting("netfox/logging/netfox_extras_log_level", DEFAULT_LOG_LEVEL)
+	}
+
+func _init(p_module: String, p_name: String):
+	module = p_module
+	name = p_name
+
+func _check_log_level(level: int) -> bool:
+	var cmp_level = log_level
+	if level < cmp_level:
+		return false
+	
+	if module_log_level.has(module):
+		var module_level = module_log_level.get(module)
+		return level >= module_level
+	
+	return true
+
+func _format_text(text: String, values: Array, level: int) -> String:
+	level = clampi(level, LOG_MIN, LOG_MAX)
+	
+	var result := PackedStringArray()
+	
+	result.append("[%s]" % [level_prefixes[level]])
+	for tag in _ordered_tags:
+		result.append("[%s]" % [tag.call()])
+	result.append("[%s::%s] " % [module, name])
+	
+	if values.is_empty():
+		result.append(text)
+	else:
+		result.append(text % values)
+	
+	return "".join(result)
+
+func _log_text(text: String, values: Array, level: int):
+	if _check_log_level(level):
+		print(_format_text(text, values, level))
+
+func trace(text: String, values: Array = []):
+	_log_text(text, values, LOG_TRACE)
+
+func debug(text: String, values: Array = []):
+	_log_text(text, values, LOG_DEBUG)
+
+func info(text: String, values: Array = []):
+	_log_text(text, values, LOG_INFO)
+
+func warning(text: String, values: Array = []):
+	if _check_log_level(LOG_WARN):
+		var formatted_text = _format_text(text, values, LOG_WARN)
+		push_warning(formatted_text)
+		# Print so it shows up in the Output panel too
+		print(formatted_text)
+
+func error(text: String, values: Array = []):
+	if _check_log_level(LOG_ERROR):
+		var formatted_text = _format_text(text, values, LOG_ERROR)
+		push_error(formatted_text)
+		# Print so it shows up in the Output panel too
+		print(formatted_text)