/**************************************************************************/
/* editor_translation_parser.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 "editor_translation_parser.h"
#include "core/error/error_macros.h"
#include "core/object/class_db.h" // IWYU pragma: keep. `GDVIRTUAL_BIND` macro.
#include "core/object/script_language.h"
#include "core/templates/hash_set.h"
EditorTranslationParser *EditorTranslationParser::singleton = nullptr;
Error EditorTranslationParserPlugin::parse_file(const String &p_path, Vector<Vector<String>> *r_translations) {
TypedArray<PackedStringArray> ret;
if (GDVIRTUAL_CALL(_parse_file, p_path, ret)) {
// Copy over entries directly.
for (const PackedStringArray translation : ret) {
r_translations->push_back(translation);
}
return OK;
}
#ifndef DISABLE_DEPRECATED
TypedArray<String> ids;
TypedArray<Array> ids_ctx_plural;
if (GDVIRTUAL_CALL(_parse_file_bind_compat_99297, p_path, ids, ids_ctx_plural)) {
// Add user's extracted translatable messages.
for (int i = 0; i < ids.size(); i++) {
r_translations->push_back({ ids[i] });
}
// Add user's collected translatable messages with context or plurals.
for (int i = 0; i < ids_ctx_plural.size(); i++) {
Array arr = ids_ctx_plural[i];
ERR_FAIL_COND_V_MSG(arr.size() != 3, ERR_INVALID_DATA, "Array entries written into `msgids_context_plural` in `_parse_file` method should have the form [\"message\", \"context\", \"plural message\"]");
r_translations->push_back({ arr[0], arr[1], arr[2] });
}
return OK;
}
#endif // DISABLE_DEPRECATED
ERR_PRINT("Custom translation parser plugin's \"_parse_file\" is undefined.");
return ERR_UNAVAILABLE;
}
void EditorTranslationParserPlugin::get_recognized_extensions(List<String> *r_extensions) const {
Vector<String> extensions;
if (GDVIRTUAL_CALL(_get_recognized_extensions, extensions)) {
for (int i = 0; i < extensions.size(); i++) {
r_extensions->push_back(extensions[i]);
}
} else if (!GDVIRTUAL_IS_OVERRIDDEN(_customize_strings)) {
ERR_PRINT("Custom translation parser plugin's \"func get_recognized_extensions()\" is undefined.");
}
}
void EditorTranslationParserPlugin::customize_strings(Vector<Vector<String>> &r_strings) const {
if (!GDVIRTUAL_IS_OVERRIDDEN(_customize_strings)) {
return;
}
TypedArray<PackedStringArray> new_strings;
new_strings.resize(r_strings.size());
int i = 0;
for (const PackedStringArray &translation : r_strings) {
new_strings[i] = translation;
i++;
}
GDVIRTUAL_CALL(_customize_strings, new_strings, new_strings);
r_strings.resize(new_strings.size());
PackedStringArray *translation_write = r_strings.ptrw();
i = 0;
for (const Variant &translation : new_strings) {
translation_write[i] = translation;
i++;
}
}
void EditorTranslationParserPlugin::_bind_methods() {
GDVIRTUAL_BIND(_parse_file, "path");
GDVIRTUAL_BIND(_get_recognized_extensions);
GDVIRTUAL_BIND(_customize_strings, "strings");
#ifndef DISABLE_DEPRECATED
GDVIRTUAL_BIND_COMPAT(_parse_file_bind_compat_99297, "path", "msgids", "msgids_context_plural");
#endif
}
/////////////////////////
void EditorTranslationParser::get_recognized_extensions(List<String> *r_extensions) const {
HashSet<String> extensions;
List<String> temp;
for (int i = 0; i < standard_parsers.size(); i++) {
standard_parsers[i]->get_recognized_extensions(&temp);
}
for (int i = 0; i < custom_parsers.size(); i++) {
custom_parsers[i]->get_recognized_extensions(&temp);
}
// Remove duplicates.
for (const String &E : temp) {
extensions.insert(E);
}
for (const String &E : extensions) {
r_extensions->push_back(E);
}
}
bool EditorTranslationParser::can_parse(const String &p_extension) const {
List<String> extensions;
get_recognized_extensions(&extensions);
for (const String &extension : extensions) {
if (p_extension == extension) {
return true;
}
}
return false;
}
Ref<EditorTranslationParserPlugin> EditorTranslationParser::get_parser(const String &p_extension) const {
// Consider user-defined parsers first.
for (int i = 0; i < custom_parsers.size(); i++) {
List<String> temp;
custom_parsers[i]->get_recognized_extensions(&temp);
for (const String &E : temp) {
if (E == p_extension) {
return custom_parsers[i];
}
}
}
for (int i = 0; i < standard_parsers.size(); i++) {
List<String> temp;
standard_parsers[i]->get_recognized_extensions(&temp);
for (const String &E : temp) {
if (E == p_extension) {
return standard_parsers[i];
}
}
}
WARN_PRINT("No translation parser available for \"" + p_extension + "\" extension.");
return nullptr;
}
void EditorTranslationParser::customize_strings(Vector<Vector<String>> &r_strings) const {
for (const Ref<EditorTranslationParserPlugin> &parser : custom_parsers) {
parser->customize_strings(r_strings);
}
}
void EditorTranslationParser::add_parser(const Ref<EditorTranslationParserPlugin> &p_parser, ParserType p_type) {
if (p_type == ParserType::STANDARD) {
standard_parsers.push_back(p_parser);
} else if (p_type == ParserType::CUSTOM) {
custom_parsers.push_back(p_parser);
}
}
void EditorTranslationParser::remove_parser(const Ref<EditorTranslationParserPlugin> &p_parser, ParserType p_type) {
if (p_type == ParserType::STANDARD) {
standard_parsers.erase(p_parser);
} else if (p_type == ParserType::CUSTOM) {
custom_parsers.erase(p_parser);
}
}
void EditorTranslationParser::clean_parsers() {
standard_parsers.clear();
custom_parsers.clear();
}
EditorTranslationParser *EditorTranslationParser::get_singleton() {
if (!singleton) {
singleton = memnew(EditorTranslationParser);
}
return singleton;
}
EditorTranslationParser::~EditorTranslationParser() {
memdelete(singleton);
singleton = nullptr;
}