godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Move context and plural support to Translation

Browse Source 
- `TranslationPO` is now an empty class. It exists for compatibility.
- `OptimizedTranslation` stays the same, no context or plural support.
This commit is contained in:
Haoyu Qiu
2025-07-22 15:40:46 +08:00
parent e882e42e1b
commit 4e80190a46
9 changed files with 204 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
core/string/translation.cpp
View File

@@ -34,42 +34,102 @@
#include "core/string/plural_rules.h"
#include "core/string/translation_server.h"
void _check_for_incompatibility(const String &p_msgctxt, const String &p_msgid) {
// Gettext PO and MO files use an empty untranslated string without context
// to store metadata.
if (p_msgctxt.is_empty() && p_msgid.is_empty()) {
WARN_PRINT("Both context and the untranslated string are empty. This may cause issues with the translation system and external tools.");
}
// The EOT character (0x04) is used as a separator between context and
// untranslated string in the MO file format. This convention is also used
// by `get_message_list()`.
//
// It's unusual to have this character in the context or untranslated
// string. But it doesn't do any harm as long as you are aware of this when
// using the relevant APIs and tools.
if (p_msgctxt.contains_char(0x04)) {
WARN_PRINT(vformat("Found EOT character (0x04) within context '%s'. This may cause issues with the translation system and external tools.", p_msgctxt));
}
if (p_msgid.contains_char(0x04)) {
WARN_PRINT(vformat("Found EOT character (0x04) within untranslated string '%s'. This may cause issues with the translation system and external tools.", p_msgid));
}
}
Dictionary Translation::_get_messages() const {
Dictionary d;
for (const KeyValue<StringName, StringName> &E : translation_map) {
d[E.key] = E.value;
for (const KeyValue<MessageKey, Vector<StringName>> &E : translation_map) {
const Array &storage_key = { E.key.msgctxt, E.key.msgid };
Array storage_value;
storage_value.resize(E.value.size());
for (int i = 0; i < E.value.size(); i++) {
storage_value[i] = E.value[i];
}
d[storage_key] = storage_value;
}
return d;
}
Vector<String> Translation::_get_message_list() const {
Vector<String> msgs;
msgs.resize(translation_map.size());
int idx = 0;
for (const KeyValue<StringName, StringName> &E : translation_map) {
msgs.set(idx, E.key);
idx += 1;
}
void Translation::_set_messages(const Dictionary &p_messages) {
translation_map.clear();
return msgs;
for (const KeyValue<Variant, Variant> &kv : p_messages) {
switch (kv.key.get_type()) {
// Old version, no context or plural support.
case Variant::STRING_NAME: {
const MessageKey msg_key = { StringName(), kv.key };
_check_for_incompatibility(msg_key.msgctxt, msg_key.msgid);
translation_map[msg_key] = { kv.value };
} break;
// Current version.
case Variant::ARRAY: {
const Array &storage_key = kv.key;
const MessageKey msg_key = { storage_key[0], storage_key[1] };
const Array &storage_value = kv.value;
ERR_CONTINUE_MSG(storage_value.is_empty(), vformat("No translated strings for untranslated string '%s' with context '%s'.", msg_key.msgid, msg_key.msgctxt));
Vector<StringName> msgstrs;
msgstrs.resize(storage_value.size());
for (int i = 0; i < storage_value.size(); i++) {
msgstrs.write[i] = storage_value[i];
}
_check_for_incompatibility(msg_key.msgctxt, msg_key.msgid);
translation_map[msg_key] = msgstrs;
} break;
default: {
WARN_PRINT(vformat("Invalid key type in messages dictionary: %s.", Variant::get_type_name(kv.key.get_type())));
continue;
}
}
}
}
Vector<String> Translation::_get_message_list() const {
List<StringName> msgstrs;
get_message_list(&msgstrs);
Vector<String> keys;
keys.resize(msgstrs.size());
int idx = 0;
for (const StringName &msgstr : msgstrs) {
keys.write[idx++] = msgstr;
}
return keys;
}
Vector<String> Translation::get_translated_message_list() const {
Vector<String> msgs;
msgs.resize(translation_map.size());
int idx = 0;
for (const KeyValue<StringName, StringName> &E : translation_map) {
msgs.set(idx, E.value);
idx += 1;
}
return msgs;
}
void Translation::_set_messages(const Dictionary &p_messages) {
for (const KeyValue<Variant, Variant> &kv : p_messages) {
translation_map[kv.key] = kv.value;
Vector<String> msgstrs;
for (const KeyValue<MessageKey, Vector<StringName>> &E : translation_map) {
for (const StringName &msgstr : E.value) {
msgstrs.push_back(msgstr);
}
}
return msgstrs;
}
void Translation::set_locale(const String &p_locale) {
@@ -82,13 +142,21 @@ void Translation::set_locale(const String &p_locale) {
}
void Translation::add_message(const StringName &p_src_text, const StringName &p_xlated_text, const StringName &p_context) {
translation_map[p_src_text] = p_xlated_text;
_check_for_incompatibility(p_context, p_src_text);
translation_map[{ p_context, p_src_text }] = { p_xlated_text };
}
void Translation::add_plural_message(const StringName &p_src_text, const Vector<String> &p_plural_xlated_texts, const StringName &p_context) {
WARN_PRINT("Translation class doesn't handle plural messages. Calling add_plural_message() on a Translation instance is probably a mistake. \nUse a derived Translation class that handles plurals, such as TranslationPO class");
ERR_FAIL_COND_MSG(p_plural_xlated_texts.is_empty(), "Parameter vector p_plural_xlated_texts passed in is empty.");
translation_map[p_src_text] = p_plural_xlated_texts[0];
Vector<StringName> msgstrs;
msgstrs.resize(p_plural_xlated_texts.size());
for (int i = 0; i < p_plural_xlated_texts.size(); i++) {
msgstrs.write[i] = p_plural_xlated_texts[i];
}
_check_for_incompatibility(p_context, p_src_text);
translation_map[{ p_context, p_src_text }] = msgstrs;
}
StringName Translation::get_message(const StringName &p_src_text, const StringName &p_context) const {
@@ -97,16 +165,13 @@ StringName Translation::get_message(const StringName &p_src_text, const StringNa
return ret;
}
if (p_context != StringName()) {
WARN_PRINT("Translation class doesn't handle context. Using context in get_message() on a Translation instance is probably a mistake. \nUse a derived Translation class that handles context, such as TranslationPO class");
}
HashMap<StringName, StringName>::ConstIterator E = translation_map.find(p_src_text);
if (!E) {
const Vector<StringName> *msgstrs = translation_map.getptr({ p_context, p_src_text });
if (msgstrs == nullptr) {
return StringName();
}
return E->value;
DEV_ASSERT(!msgstrs->is_empty()); // Should be prevented when adding messages.
return msgstrs->get(0);
}
StringName Translation::get_plural_message(const StringName &p_src_text, const StringName &p_plural_text, int p_n, const StringName &p_context) const {
@@ -115,21 +180,30 @@ StringName Translation::get_plural_message(const StringName &p_src_text, const S
return ret;
}
WARN_PRINT("Translation class doesn't handle plural messages. Calling get_plural_message() on a Translation instance is probably a mistake. \nUse a derived Translation class that handles plurals, such as TranslationPO class");
return get_message(p_src_text);
ERR_FAIL_COND_V_MSG(p_n < 0, StringName(), "N passed into translation to get a plural message should not be negative. For negative numbers, use singular translation please. Search \"gettext PO Plural Forms\" online for details on translating negative numbers.");
const Vector<StringName> *msgstrs = translation_map.getptr({ p_context, p_src_text });
if (msgstrs == nullptr) {
return StringName();
}
const int index = _get_plural_rules()->evaluate(p_n);
ERR_FAIL_INDEX_V_MSG(index, msgstrs->size(), StringName(), "Plural index returned or number of plural translations is not valid.");
return msgstrs->get(index);
}
void Translation::erase_message(const StringName &p_src_text, const StringName &p_context) {
if (p_context != StringName()) {
WARN_PRINT("Translation class doesn't handle context. Using context in erase_message() on a Translation instance is probably a mistake. \nUse a derived Translation class that handles context, such as TranslationPO class");
}
translation_map.erase(p_src_text);
translation_map.erase({ p_context, p_src_text });
}
void Translation::get_message_list(List<StringName> *r_messages) const {
for (const KeyValue<StringName, StringName> &E : translation_map) {
r_messages->push_back(E.key);
for (const KeyValue<MessageKey, Vector<StringName>> &E : translation_map) {
if (E.key.msgctxt.is_empty()) {
r_messages->push_back(E.key.msgid);
} else {
// Separated by the EOT character. Compatible with the MO file format.
r_messages->push_back(vformat("%s\x04%s", E.key.msgctxt, E.key.msgid));
}
}
}
@@ -175,6 +249,10 @@ String Translation::get_plural_rules_override() const {
return plural_rules_override;
}
int Translation::get_nplurals() const {
return _get_plural_rules()->get_nplurals();
}
void Translation::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_locale", "locale"), &Translation::set_locale);
ClassDB::bind_method(D_METHOD("get_locale"), &Translation::get_locale);
@@ -195,7 +273,7 @@ void Translation::_bind_methods() {
GDVIRTUAL_BIND(_get_message, "src_message", "context");
ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "messages", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL), "_set_messages", "_get_messages");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "locale"), "set_locale", "get_locale");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "locale", PROPERTY_HINT_LOCALE_ID), "set_locale", "get_locale");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "plural_rules_override"), "set_plural_rules_override", "get_plural_rules_override");
}