initial commit, 4.5 stable

editor/import/resource_importer_csv_translation.cpp

@@ -0,0 +1,164 @@
+/**************************************************************************/
+/*  resource_importer_csv_translation.cpp                                 */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#include "resource_importer_csv_translation.h"
+
+#include "core/io/file_access.h"
+#include "core/io/resource_saver.h"
+#include "core/string/optimized_translation.h"
+#include "core/string/translation_server.h"
+
+String ResourceImporterCSVTranslation::get_importer_name() const {
+	return "csv_translation";
+}
+
+String ResourceImporterCSVTranslation::get_visible_name() const {
+	return "CSV Translation";
+}
+
+void ResourceImporterCSVTranslation::get_recognized_extensions(List<String> *p_extensions) const {
+	p_extensions->push_back("csv");
+}
+
+String ResourceImporterCSVTranslation::get_save_extension() const {
+	return ""; //does not save a single resource
+}
+
+String ResourceImporterCSVTranslation::get_resource_type() const {
+	return "Translation";
+}
+
+bool ResourceImporterCSVTranslation::get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const {
+	return true;
+}
+
+int ResourceImporterCSVTranslation::get_preset_count() const {
+	return 0;
+}
+
+String ResourceImporterCSVTranslation::get_preset_name(int p_idx) const {
+	return "";
+}
+
+void ResourceImporterCSVTranslation::get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset) const {
+	r_options->push_back(ImportOption(PropertyInfo(Variant::BOOL, "compress"), true));
+	r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "delimiter", PROPERTY_HINT_ENUM, "Comma,Semicolon,Tab"), 0));
+}
+
+Error ResourceImporterCSVTranslation::import(ResourceUID::ID p_source_id, const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files, Variant *r_metadata) {
+	bool compress = p_options["compress"];
+
+	String delimiter;
+	switch ((int)p_options["delimiter"]) {
+		case 0:
+			delimiter = ",";
+			break;
+		case 1:
+			delimiter = ";";
+			break;
+		case 2:
+			delimiter = "\t";
+			break;
+	}
+
+	Ref<FileAccess> f = FileAccess::open(p_source_file, FileAccess::READ);
+	ERR_FAIL_COND_V_MSG(f.is_null(), ERR_INVALID_PARAMETER, "Cannot open file from path '" + p_source_file + "'.");
+
+	Vector<String> line = f->get_csv_line(delimiter);
+	ERR_FAIL_COND_V(line.size() <= 1, ERR_PARSE_ERROR);
+
+	Vector<String> locales;
+	Vector<Ref<Translation>> translations;
+	HashSet<int> skipped_locales;
+
+	for (int i = 1; i < line.size(); i++) {
+		String locale = TranslationServer::get_singleton()->standardize_locale(line[i]);
+
+		if (line[i].left(1) == "_") {
+			skipped_locales.insert(i);
+			continue;
+		} else if (locale.is_empty()) {
+			skipped_locales.insert(i);
+			ERR_CONTINUE_MSG(true, vformat("Error importing CSV translation: Invalid locale format '%s', should be 'language_Script_COUNTRY_VARIANT@extra'. This column will be ignored.", line[i]));
+		}
+
+		locales.push_back(locale);
+		Ref<Translation> translation;
+		translation.instantiate();
+		translation->set_locale(locale);
+		translations.push_back(translation);
+	}
+
+	do {
+		line = f->get_csv_line(delimiter);
+		String key = line[0];
+		if (!key.is_empty()) {
+			ERR_CONTINUE_MSG(line.size() != locales.size() + (int)skipped_locales.size() + 1, vformat("Error importing CSV translation: expected %d locale(s), but the '%s' key has %d locale(s).", locales.size(), key, line.size() - 1));
+
+			int write_index = 0; // Keep track of translations written in case some locales are skipped.
+			for (int i = 1; i < line.size(); i++) {
+				if (skipped_locales.has(i)) {
+					continue;
+				}
+				translations.write[write_index++]->add_message(key, line[i].c_unescape());
+			}
+		}
+	} while (!f->eof_reached());
+
+	for (int i = 0; i < translations.size(); i++) {
+		Ref<Translation> xlt = translations[i];
+
+		if (compress) {
+			Ref<OptimizedTranslation> cxl = memnew(OptimizedTranslation);
+			cxl->generate(xlt);
+			xlt = cxl;
+		}
+
+		String save_path = p_source_file.get_basename() + "." + translations[i]->get_locale() + ".translation";
+		ResourceUID::ID save_id = hash64_murmur3_64(translations[i]->get_locale().hash64(), p_source_id) & 0x7FFFFFFFFFFFFFFF;
+		bool uid_already_exists = ResourceUID::get_singleton()->has_id(save_id);
+		if (uid_already_exists) {
+			// Avoid creating a new file with a duplicate UID.
+			// Always use this UID, even if the user has moved it to a different path.
+			save_path = ResourceUID::get_singleton()->get_id_path(save_id);
+		}
+
+		ResourceSaver::save(xlt, save_path);
+		if (r_gen_files) {
+			r_gen_files->push_back(save_path);
+		}
+		if (!uid_already_exists) {
+			// No need to call set_uid if save_path already refers to save_id.
+			ResourceSaver::set_uid(save_path, save_id);
+		}
+	}
+
+	return OK;
+}