godot/editor/editor_translation_parser.cpp
Rémi Verschelde b5334d14f7
Update copyright statements to 2021
Happy new year to the wonderful Godot community!

2020 has been a tough year for most of us personally, but a good year for
Godot development nonetheless with a huge amount of work done towards Godot
4.0 and great improvements backported to the long-lived 3.2 branch.

We've had close to 400 contributors to engine code this year, authoring near
7,000 commit! (And that's only for the `master` branch and for the engine code,
there's a lot more when counting docs, demos and other first-party repos.)

Here's to a great year 2021 for all Godot users 🎆
2021-01-01 20:19:21 +01:00

184 lines
7.0 KiB
C++

/*************************************************************************/
/* editor_translation_parser.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* 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/script_language.h"
#include "core/os/file_access.h"
#include "core/templates/set.h"
EditorTranslationParser *EditorTranslationParser::singleton = nullptr;
Error EditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) {
if (!get_script_instance())
return ERR_UNAVAILABLE;
if (get_script_instance()->has_method("parse_file")) {
Array ids;
Array ids_ctx_plural;
get_script_instance()->call("parse_file", p_path, ids, ids_ctx_plural);
// Add user's extracted translatable messages.
for (int i = 0; i < ids.size(); i++) {
r_ids->append(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\"]");
Vector<String> id_ctx_plural;
id_ctx_plural.push_back(arr[0]);
id_ctx_plural.push_back(arr[1]);
id_ctx_plural.push_back(arr[2]);
r_ids_ctx_plural->append(id_ctx_plural);
}
return OK;
} else {
ERR_PRINT("Custom translation parser plugin's \"func parse_file(path, extracted_strings)\" is undefined.");
return ERR_UNAVAILABLE;
}
}
void EditorTranslationParserPlugin::get_recognized_extensions(List<String> *r_extensions) const {
if (!get_script_instance())
return;
if (get_script_instance()->has_method("get_recognized_extensions")) {
Array extensions = get_script_instance()->call("get_recognized_extensions");
for (int i = 0; i < extensions.size(); i++) {
r_extensions->push_back(extensions[i]);
}
} else {
ERR_PRINT("Custom translation parser plugin's \"func get_recognized_extensions()\" is undefined.");
}
}
void EditorTranslationParserPlugin::_bind_methods() {
ClassDB::add_virtual_method(get_class_static(), MethodInfo(Variant::NIL, "parse_file", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::ARRAY, "msgids"), PropertyInfo(Variant::ARRAY, "msgids_context_plural")));
ClassDB::add_virtual_method(get_class_static(), MethodInfo(Variant::ARRAY, "get_recognized_extensions"));
}
/////////////////////////
void EditorTranslationParser::get_recognized_extensions(List<String> *r_extensions) const {
Set<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 (int i = 0; i < temp.size(); i++) {
extensions.insert(temp[i]);
}
for (auto E = extensions.front(); E; E = E->next()) {
r_extensions->push_back(E->get());
}
}
bool EditorTranslationParser::can_parse(const String &p_extension) const {
List<String> extensions;
get_recognized_extensions(&extensions);
for (int i = 0; i < extensions.size(); i++) {
if (p_extension == extensions[i]) {
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 (int j = 0; j < temp.size(); j++) {
if (temp[j] == 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 (int j = 0; j < temp.size(); j++) {
if (temp[j] == p_extension) {
return standard_parsers[i];
}
}
}
WARN_PRINT("No translation parser available for \"" + p_extension + "\" extension.");
return nullptr;
}
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() {
}
EditorTranslationParser::~EditorTranslationParser() {
memdelete(singleton);
singleton = nullptr;
}