Logger::warning, format cleanup + req comments

1 files changed, 136 insertions, 0 deletions

diff --git a/extension/src/openvic-extension/LoadLocalisation.cpp b/extension/src/openvic-extension/LoadLocalisation.cpp
new file mode 100644
index 0000000..dc7702c
--- /dev/null
+++ b/extension/src/openvic-extension/LoadLocalisation.cpp
@@ -0,0 +1,136 @@
+#include "LoadLocalisation.hpp"
+
+#include <godot_cpp/classes/dir_access.hpp>
+#include <godot_cpp/classes/file_access.hpp>
+#include <godot_cpp/classes/translation_server.hpp>
+#include <godot_cpp/variant/utility_functions.hpp>
+
+using namespace godot;
+using namespace OpenVic;
+
+LoadLocalisation* LoadLocalisation::singleton = nullptr;
+
+void LoadLocalisation::_bind_methods() {
+	ClassDB::bind_method(D_METHOD("load_file", "file_path", "locale"), &LoadLocalisation::load_file);
+	ClassDB::bind_method(D_METHOD("load_locale_dir", "dir_path", "locale"), &LoadLocalisation::load_locale_dir);
+	ClassDB::bind_method(D_METHOD("load_localisation_dir", "dir_path"), &LoadLocalisation::load_localisation_dir);
+}
+
+LoadLocalisation* LoadLocalisation::get_singleton() {
+	return singleton;
+}
+
+LoadLocalisation::LoadLocalisation() {
+	ERR_FAIL_COND(singleton != nullptr);
+	singleton = this;
+}
+
+LoadLocalisation::~LoadLocalisation() {
+	ERR_FAIL_COND(singleton != this);
+	singleton = nullptr;
+}
+
+Error LoadLocalisation::_load_file_into_translation(String const& file_path, Ref<Translation> translation) {
+	const Ref<FileAccess> file = FileAccess::open(file_path, FileAccess::ModeFlags::READ);
+	Error err = FileAccess::get_open_error();
+	if (err != OK || file.is_null()) {
+		UtilityFunctions::push_error("Failed to load localisation file: ", file_path);
+		return err == OK ? FAILED : err;
+	}
+	int line_number = 0;
+	while (!file->eof_reached()) {
+		static const String delimeter = ";";
+		const PackedStringArray line = file->get_csv_line(delimeter);
+		line_number++;
+		if (line.size() < 2 || line[0].is_empty() || line[1].is_empty()) {
+			if (!line[0].is_empty()) {
+				UtilityFunctions::push_warning("Key \"", line[0], "\" missing value on line ", line_number, " in file: ", file_path);
+				err = FAILED;
+			} else if (line.size() >= 2 && !line[1].is_empty()) {
+				UtilityFunctions::push_warning("Value \"", line[1], "\" missing key on line ", line_number, " in file: ", file_path);
+				err = FAILED;
+			}
+			continue;
+		}
+		translation->add_message(line[0], line[1].c_unescape());
+	}
+	return err;
+}
+
+Ref<Translation> LoadLocalisation::_get_translation(String const& locale) {
+	TranslationServer* server = TranslationServer::get_singleton();
+	if (server == nullptr) {
+		UtilityFunctions::push_error("Failed to get TranslationServer singleton");
+		return nullptr;
+	}
+	Ref<Translation> translation = server->get_translation_object(locale);
+	if (translation.is_null() || translation->get_locale() != locale) {
+		translation.instantiate();
+		translation->set_locale(locale);
+		server->add_translation(translation);
+	}
+	return translation;
+}
+
+Error LoadLocalisation::load_file(String const& file_path, String const& locale) {
+	return _load_file_into_translation(file_path, _get_translation(locale));
+}
+
+/* REQUIREMENTS
+ * FS-18, FS-24, FS-25
+ */
+Error LoadLocalisation::load_locale_dir(String const& dir_path, String const& locale) {
+	if (!DirAccess::dir_exists_absolute(dir_path)) {
+		UtilityFunctions::push_error("Locale directory does not exist: ", dir_path);
+		return FAILED;
+	}
+	/* This will add the locale to the list of loaded locales even if it has no
+	 * localisation files - this is useful for testing other aspects of localisation
+	 * such as number formatting and text direction. To disable this behaviour and
+	 * only show non-empty localisations, move the `_get_translation` call to after
+	 * the `files.size()` check.
+	 */
+	const Ref<Translation> translation = _get_translation(locale);
+	const PackedStringArray files = DirAccess::get_files_at(dir_path);
+	if (files.size() < 1) {
+		UtilityFunctions::push_error("Locale directory does not contain any files: ", dir_path);
+		return FAILED;
+	}
+	Error err = OK;
+	for (String const& file_name : files) {
+		if (file_name.get_extension().to_lower() == "csv") {
+			if (_load_file_into_translation(dir_path.path_join(file_name), translation) != OK)
+				err = FAILED;
+		}
+	}
+	return err;
+}
+
+/* REQUIREMENTS
+ * FS-23
+ */
+Error LoadLocalisation::load_localisation_dir(String const& dir_path) {
+	if (!DirAccess::dir_exists_absolute(dir_path)) {
+		UtilityFunctions::push_error("Localisation directory does not exist: ", dir_path);
+		return FAILED;
+	}
+	PackedStringArray const dirs = DirAccess::get_directories_at(dir_path);
+	if (dirs.size() < 1) {
+		UtilityFunctions::push_error("Localisation directory does not contain any sub-directories: ", dir_path);
+		return FAILED;
+	}
+	TranslationServer* server = TranslationServer::get_singleton();
+	if (server == nullptr) {
+		UtilityFunctions::push_error("Failed to get TranslationServer singleton");
+		return FAILED;
+	}
+	Error err = OK;
+	for (String const& locale_name : dirs) {
+		if (locale_name != server->standardize_locale(locale_name))
+			UtilityFunctions::push_error("Invalid locale directory name: ", locale_name);
+		else if (load_locale_dir(dir_path.path_join(locale_name), locale_name) == OK)
+			continue;
+		err = FAILED;
+	}
+	return err;
+}