Update POT generation to handle context and plurals
This commit is contained in:
SkyJJ
parent
c0d837a2ea
commit
396f2eee82
|
|
@ -5,30 +5,37 @@
|
|||
</brief_description>
|
||||
<description>
|
||||
Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method parse_file] method in script.
|
||||
Add the extracted strings to argument [code]msgids[/code] or [code]msgids_context_plural[/code] if context or plural is used.
|
||||
The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu.
|
||||
Below shows an example of a custom parser that extracts strings in a CSV file to write into a POT.
|
||||
Below shows an example of a custom parser that extracts strings from a CSV file to write into a POT.
|
||||
[codeblock]
|
||||
tool
|
||||
extends EditorTranslationParserPlugin
|
||||
|
||||
|
||||
func parse_file(path, extracted_strings):
|
||||
func parse_file(path, msgids, msgids_context_plural):
|
||||
var file = File.new()
|
||||
file.open(path, File.READ)
|
||||
var text = file.get_as_text()
|
||||
var split_strs = text.split(",", false, 0)
|
||||
for s in split_strs:
|
||||
extracted_strings.append(s)
|
||||
msgids.append(s)
|
||||
#print("Extracted string: " + s)
|
||||
|
||||
|
||||
func get_recognized_extensions():
|
||||
return ["csv"]
|
||||
[/codeblock]
|
||||
To add a translatable string associated with context or plural, add it to [code]msgids_context_plural[/code]:
|
||||
[codeblock]
|
||||
msgids_ctx_plural.append(["Test 1", "context", "test 1 plurals"]) # This will add a message with msgid "Test 1", msgctxt "context", and msgid_plural "test 1 plurals".
|
||||
msgids_ctx_plural.append(["A test without context", "", "plurals"]) # This will add a message with msgid "A test without context" and msgid_plural "plurals".
|
||||
msgids_ctx_plural.append(["Only with context", "a friendly context", ""]) # This will add a message with msgid "Only with context" and msgctxt "a friendly context".
|
||||
[/codeblock]
|
||||
[b]Note:[/b] If you override parsing logic for standard script types (GDScript, C#, etc.), it would be better to load the [code]path[/code] argument using [method ResourceLoader.load]. This is because built-in scripts are loaded as [Resource] type, not [File] type.
|
||||
For example:
|
||||
[codeblock]
|
||||
func parse_file(path, extracted_strings):
|
||||
func parse_file(path, msgids, msgids_context_plural):
|
||||
var res = ResourceLoader.load(path, "Script")
|
||||
var text = res.get_source_code()
|
||||
# Parsing logic.
|
||||
|
|
@ -53,7 +60,9 @@
|
|||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="extracted_strings" type="Array">
|
||||
<argument index="1" name="msgids" type="Array">
|
||||
</argument>
|
||||
<argument index="2" name="msgids_context_plural" type="Array">
|
||||
</argument>
|
||||
<description>
|
||||
Override this method to define a custom parsing logic to extract the translatable strings.
|
||||
|
|
|
|||
|
|
@ -37,15 +37,30 @@
|
|||
|
||||
EditorTranslationParser *EditorTranslationParser::singleton = nullptr;
|
||||
|
||||
Error EditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_extracted_strings) {
|
||||
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 extracted_strings;
|
||||
get_script_instance()->call("parse_file", p_path, extracted_strings);
|
||||
for (int i = 0; i < extracted_strings.size(); i++) {
|
||||
r_extracted_strings->append(extracted_strings[i]);
|
||||
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_ctx_plural of EditorTranslationParserPlugin 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 {
|
||||
|
|
@ -69,7 +84,7 @@ void EditorTranslationParserPlugin::get_recognized_extensions(List<String> *r_ex
|
|||
}
|
||||
|
||||
void EditorTranslationParserPlugin::_bind_methods() {
|
||||
ClassDB::add_virtual_method(get_class_static(), MethodInfo(Variant::NIL, "parse_file", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::ARRAY, "extracted_strings")));
|
||||
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"));
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ protected:
|
|||
static void _bind_methods();
|
||||
|
||||
public:
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_extracted_strings);
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural);
|
||||
virtual void get_recognized_extensions(List<String> *r_extensions) const;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ void PackedSceneEditorTranslationParserPlugin::get_recognized_extensions(List<St
|
|||
ResourceLoader::get_recognized_extensions_for_type("PackedScene", r_extensions);
|
||||
}
|
||||
|
||||
Error PackedSceneEditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_extracted_strings) {
|
||||
Error PackedSceneEditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) {
|
||||
// Parse specific scene Node's properties (see in constructor) that are auto-translated by the engine when set. E.g Label's text property.
|
||||
// These properties are translated with the tr() function in the C++ code when being set or updated.
|
||||
|
||||
|
|
@ -71,8 +71,10 @@ Error PackedSceneEditorTranslationParserPlugin::parse_file(const String &p_path,
|
|||
String extension = s->get_language()->get_extension();
|
||||
if (EditorTranslationParser::get_singleton()->can_parse(extension)) {
|
||||
Vector<String> temp;
|
||||
EditorTranslationParser::get_singleton()->get_parser(extension)->parse_file(s->get_path(), &temp);
|
||||
Vector<Vector<String>> ids_context_plural;
|
||||
EditorTranslationParser::get_singleton()->get_parser(extension)->parse_file(s->get_path(), &temp, &ids_context_plural);
|
||||
parsed_strings.append_array(temp);
|
||||
r_ids_ctx_plural->append_array(ids_context_plural);
|
||||
}
|
||||
} else if (property_name == "filters") {
|
||||
// Extract FileDialog's filters property with values in format "*.png ; PNG Images","*.gd ; GDScript Files".
|
||||
|
|
@ -93,7 +95,7 @@ Error PackedSceneEditorTranslationParserPlugin::parse_file(const String &p_path,
|
|||
}
|
||||
}
|
||||
|
||||
r_extracted_strings->append_array(parsed_strings);
|
||||
r_ids->append_array(parsed_strings);
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ class PackedSceneEditorTranslationParserPlugin : public EditorTranslationParserP
|
|||
Set<String> lookup_properties;
|
||||
|
||||
public:
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_extracted_strings) override;
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) override;
|
||||
virtual void get_recognized_extensions(List<String> *r_extensions) const override;
|
||||
|
||||
PackedSceneEditorTranslationParserPlugin();
|
||||
|
|
|
|||
|
|
@ -31,23 +31,25 @@
|
|||
#include "pot_generator.h"
|
||||
|
||||
#include "core/error_macros.h"
|
||||
#include "core/os/file_access.h"
|
||||
#include "core/project_settings.h"
|
||||
#include "editor_translation_parser.h"
|
||||
#include "plugins/packed_scene_translation_parser_plugin.h"
|
||||
|
||||
POTGenerator *POTGenerator::singleton = nullptr;
|
||||
|
||||
//#define DEBUG_POT
|
||||
|
||||
#ifdef DEBUG_POT
|
||||
void _print_all_translation_strings(const OrderedHashMap<String, Set<String>> &p_all_translation_strings) {
|
||||
for (auto E_pair = p_all_translation_strings.front(); E_pair; E_pair = E_pair.next()) {
|
||||
String msg = static_cast<String>(E_pair.key()) + " : ";
|
||||
for (Set<String>::Element *E = E_pair.value().front(); E; E = E->next()) {
|
||||
msg += E->get() + " ";
|
||||
void POTGenerator::_print_all_translation_strings() {
|
||||
for (auto E = all_translation_strings.front(); E; E = E.next()) {
|
||||
Vector<MsgidData> v_md = all_translation_strings[E.key()];
|
||||
for (int i = 0; i < v_md.size(); i++) {
|
||||
print_line("++++++");
|
||||
print_line("msgid: " + E.key());
|
||||
print_line("context: " + v_md[i].ctx);
|
||||
print_line("msgid_plural: " + v_md[i].plural);
|
||||
for (Set<String>::Element *E = v_md[i].locations.front(); E; E = E->next()) {
|
||||
print_line("location: " + E->get());
|
||||
}
|
||||
}
|
||||
print_line(msg);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
|
@ -65,27 +67,27 @@ void POTGenerator::generate_pot(const String &p_file) {
|
|||
|
||||
// Collect all translatable strings according to files order in "POT Generation" setting.
|
||||
for (int i = 0; i < files.size(); i++) {
|
||||
Vector<String> translation_strings;
|
||||
Vector<String> msgids;
|
||||
Vector<Vector<String>> msgids_context_plural;
|
||||
String file_path = files[i];
|
||||
String file_extension = file_path.get_extension();
|
||||
|
||||
if (EditorTranslationParser::get_singleton()->can_parse(file_extension)) {
|
||||
EditorTranslationParser::get_singleton()->get_parser(file_extension)->parse_file(file_path, &translation_strings);
|
||||
EditorTranslationParser::get_singleton()->get_parser(file_extension)->parse_file(file_path, &msgids, &msgids_context_plural);
|
||||
} else {
|
||||
ERR_PRINT("Unrecognized file extension " + file_extension + " in generate_pot()");
|
||||
return;
|
||||
}
|
||||
|
||||
// Store translation strings parsed in this iteration along with their corresponding source file - to write into POT later on.
|
||||
for (int j = 0; j < translation_strings.size(); j++) {
|
||||
all_translation_strings[translation_strings[j]].insert(file_path);
|
||||
for (int j = 0; j < msgids.size(); j++) {
|
||||
_add_new_msgid(msgids[j], "", "", file_path);
|
||||
}
|
||||
for (int j = 0; j < msgids_context_plural.size(); j++) {
|
||||
Vector<String> entry = msgids_context_plural[j];
|
||||
_add_new_msgid(entry[0], entry[1], entry[2], file_path);
|
||||
}
|
||||
}
|
||||
|
||||
#ifdef DEBUG_POT
|
||||
_print_all_translation_strings(all_translation_strings);
|
||||
#endif
|
||||
|
||||
_write_to_pot(p_file);
|
||||
}
|
||||
|
||||
|
|
@ -119,37 +121,88 @@ void POTGenerator::_write_to_pot(const String &p_file) {
|
|||
|
||||
file->store_string(header);
|
||||
|
||||
for (OrderedHashMap<String, Set<String>>::Element E_pair = all_translation_strings.front(); E_pair; E_pair = E_pair.next()) {
|
||||
String msg = E_pair.key();
|
||||
for (OrderedHashMap<String, Vector<MsgidData>>::Element E_pair = all_translation_strings.front(); E_pair; E_pair = E_pair.next()) {
|
||||
String msgid = E_pair.key();
|
||||
Vector<MsgidData> v_msgid_data = E_pair.value();
|
||||
for (int i = 0; i < v_msgid_data.size(); i++) {
|
||||
String context = v_msgid_data[i].ctx;
|
||||
String plural = v_msgid_data[i].plural;
|
||||
const Set<String> &locations = v_msgid_data[i].locations;
|
||||
|
||||
// Write file locations.
|
||||
for (Set<String>::Element *E = E_pair.value().front(); E; E = E->next()) {
|
||||
file->store_line("#: " + E->get().trim_prefix("res://"));
|
||||
}
|
||||
// Write file locations.
|
||||
for (Set<String>::Element *E = locations.front(); E; E = E->next()) {
|
||||
file->store_line("#: " + E->get().trim_prefix("res://"));
|
||||
}
|
||||
|
||||
// Split \\n and \n.
|
||||
Vector<String> temp = msg.split("\\n");
|
||||
Vector<String> msg_lines;
|
||||
for (int i = 0; i < temp.size(); i++) {
|
||||
msg_lines.append_array(temp[i].split("\n"));
|
||||
if (i < temp.size() - 1) {
|
||||
// Add \n.
|
||||
msg_lines.set(msg_lines.size() - 1, msg_lines[msg_lines.size() - 1] + "\\n");
|
||||
// Write context.
|
||||
if (!context.empty()) {
|
||||
file->store_line("msgctxt \"" + context + "\"");
|
||||
}
|
||||
|
||||
// Write msgid.
|
||||
_write_msgid(file, msgid, false);
|
||||
|
||||
// Write msgid_plural
|
||||
if (!plural.empty()) {
|
||||
_write_msgid(file, plural, true);
|
||||
file->store_line("msgstr[0] \"\"");
|
||||
file->store_line("msgstr[1] \"\"\n");
|
||||
} else {
|
||||
file->store_line("msgstr \"\"\n");
|
||||
}
|
||||
}
|
||||
|
||||
// Write msgid.
|
||||
file->store_string("msgid ");
|
||||
for (int i = 0; i < msg_lines.size(); i++) {
|
||||
file->store_line("\"" + msg_lines[i] + "\"");
|
||||
}
|
||||
|
||||
file->store_line("msgstr \"\"\n");
|
||||
}
|
||||
|
||||
file->close();
|
||||
}
|
||||
|
||||
void POTGenerator::_write_msgid(FileAccess *r_file, const String &p_id, bool p_plural) {
|
||||
// Split \\n and \n.
|
||||
Vector<String> temp = p_id.split("\\n");
|
||||
Vector<String> msg_lines;
|
||||
for (int i = 0; i < temp.size(); i++) {
|
||||
msg_lines.append_array(temp[i].split("\n"));
|
||||
if (i < temp.size() - 1) {
|
||||
// Add \n.
|
||||
msg_lines.set(msg_lines.size() - 1, msg_lines[msg_lines.size() - 1] + "\\n");
|
||||
}
|
||||
}
|
||||
|
||||
if (p_plural) {
|
||||
r_file->store_string("msgid_plural ");
|
||||
} else {
|
||||
r_file->store_string("msgid ");
|
||||
}
|
||||
|
||||
for (int i = 0; i < msg_lines.size(); i++) {
|
||||
r_file->store_line("\"" + msg_lines[i] + "\"");
|
||||
}
|
||||
}
|
||||
|
||||
void POTGenerator::_add_new_msgid(const String &p_msgid, const String &p_context, const String &p_plural, const String &p_location) {
|
||||
// Insert new location if msgid under same context exists already.
|
||||
if (all_translation_strings.has(p_msgid)) {
|
||||
Vector<MsgidData> &v_mdata = all_translation_strings[p_msgid];
|
||||
for (int i = 0; i < v_mdata.size(); i++) {
|
||||
if (v_mdata[i].ctx == p_context) {
|
||||
if (!v_mdata[i].plural.empty() && !p_plural.empty() && v_mdata[i].plural != p_plural) {
|
||||
WARN_PRINT("Redefinition of plural message (msgid_plural), under the same message (msgid) and context (msgctxt)");
|
||||
}
|
||||
v_mdata.write[i].locations.insert(p_location);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add a new entry of msgid, context, plural and location - context and plural might be empty if the inserted msgid doesn't associated
|
||||
// context or plurals.
|
||||
MsgidData mdata;
|
||||
mdata.ctx = p_context;
|
||||
mdata.plural = p_plural;
|
||||
mdata.locations.insert(p_location);
|
||||
all_translation_strings[p_msgid].push_back(mdata);
|
||||
}
|
||||
|
||||
POTGenerator *POTGenerator::get_singleton() {
|
||||
if (!singleton) {
|
||||
singleton = memnew(POTGenerator);
|
||||
|
|
|
|||
|
|
@ -32,14 +32,29 @@
|
|||
#define POT_GENERATOR_H
|
||||
|
||||
#include "core/ordered_hash_map.h"
|
||||
#include "core/os/file_access.h"
|
||||
#include "core/set.h"
|
||||
|
||||
//#define DEBUG_POT
|
||||
|
||||
class POTGenerator {
|
||||
static POTGenerator *singleton;
|
||||
// Stores all translatable strings and the source files containing them.
|
||||
OrderedHashMap<String, Set<String>> all_translation_strings;
|
||||
|
||||
struct MsgidData {
|
||||
String ctx;
|
||||
String plural;
|
||||
Set<String> locations;
|
||||
};
|
||||
// Store msgid as key and the additional data around the msgid - if it's under a context, has plurals and its file locations.
|
||||
OrderedHashMap<String, Vector<MsgidData>> all_translation_strings;
|
||||
|
||||
void _write_to_pot(const String &p_file);
|
||||
void _write_msgid(FileAccess *r_file, const String &p_id, bool p_plural);
|
||||
void _add_new_msgid(const String &p_msgid, const String &p_context, const String &p_plural, const String &p_location);
|
||||
|
||||
#ifdef DEBUG_POT
|
||||
void _print_all_translation_strings();
|
||||
#endif
|
||||
|
||||
public:
|
||||
static POTGenerator *get_singleton();
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ matches.sort()
|
|||
|
||||
unique_str = []
|
||||
unique_loc = {}
|
||||
ctx_group = {} # Store msgctx, msg, and locations.
|
||||
main_po = """
|
||||
# LANGUAGE translation of the Godot Engine editor.
|
||||
# Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.
|
||||
|
|
@ -52,6 +53,36 @@ msgstr ""
|
|||
"""
|
||||
|
||||
|
||||
def _write_message(msgctx, msg, msg_plural, location):
|
||||
global main_po
|
||||
main_po += "\n#: " + location + "\n"
|
||||
if msgctx != "":
|
||||
main_po += 'msgctxt "' + msgctx + '"\n'
|
||||
main_po += 'msgid "' + msg + '"\n'
|
||||
if msg_plural != "":
|
||||
main_po += 'msgid_plural "' + msg_plural + '"\n'
|
||||
main_po += 'msgstr[0] ""\n'
|
||||
main_po += 'msgstr[1] ""\n'
|
||||
else:
|
||||
main_po += 'msgstr ""\n'
|
||||
|
||||
|
||||
def _add_additional_location(msgctx, msg, location):
|
||||
global main_po
|
||||
# Add additional location to previous occurrence
|
||||
msg_pos = -1
|
||||
if msgctx != "":
|
||||
msg_pos = main_po.find('\nmsgctxt "' + msgctx + '"\nmsgid "' + msg + '"')
|
||||
else:
|
||||
msg_pos = main_po.find('\nmsgid "' + msg + '"')
|
||||
|
||||
if msg_pos == -1:
|
||||
print("Someone apparently thought writing Python was as easy as GDScript. Ping Akien.")
|
||||
# NOTE FOR MENTORS: When I tested on my computer (windows) I need the extra \n#: to make the locations print line by line.
|
||||
# but it worked before without \n# so I will leave it like before
|
||||
main_po = main_po[:msg_pos] + " " + location + main_po[msg_pos:]
|
||||
|
||||
|
||||
def process_file(f, fname):
|
||||
|
||||
global main_po, unique_str, unique_loc
|
||||
|
|
@ -60,10 +91,11 @@ def process_file(f, fname):
|
|||
lc = 1
|
||||
while l:
|
||||
|
||||
patterns = ['RTR("', 'TTR("', 'TTRC("']
|
||||
patterns = ['RTR("', 'TTR("', 'TTRC("', 'TTRN("', 'RTRN("']
|
||||
idx = 0
|
||||
pos = 0
|
||||
while pos >= 0:
|
||||
# Loop until a pattern is found. If not, next line.
|
||||
pos = l.find(patterns[idx], pos)
|
||||
if pos == -1:
|
||||
if idx < len(patterns) - 1:
|
||||
|
|
@ -72,29 +104,64 @@ def process_file(f, fname):
|
|||
continue
|
||||
pos += len(patterns[idx])
|
||||
|
||||
# Read msg until "
|
||||
msg = ""
|
||||
while pos < len(l) and (l[pos] != '"' or l[pos - 1] == "\\"):
|
||||
msg += l[pos]
|
||||
pos += 1
|
||||
|
||||
# Read plural.
|
||||
msg_plural = ""
|
||||
if patterns[idx] in ['TTRN("', 'RTRN("']:
|
||||
pos = l.find('"', pos + 1)
|
||||
pos += 1
|
||||
while pos < len(l) and (l[pos] != '"' or l[pos - 1] == "\\"):
|
||||
msg_plural += l[pos]
|
||||
pos += 1
|
||||
|
||||
# Read context.
|
||||
msgctx = ""
|
||||
pos += 1
|
||||
read_ctx = False
|
||||
while pos < len(l):
|
||||
if l[pos] == ")":
|
||||
break
|
||||
elif l[pos] == '"':
|
||||
read_ctx = True
|
||||
break
|
||||
pos += 1
|
||||
|
||||
pos += 1
|
||||
if read_ctx:
|
||||
while pos < len(l) and (l[pos] != '"' or l[pos - 1] == "\\"):
|
||||
msgctx += l[pos]
|
||||
pos += 1
|
||||
|
||||
# File location.
|
||||
location = os.path.relpath(fname).replace("\\", "/")
|
||||
if line_nb:
|
||||
location += ":" + str(lc)
|
||||
|
||||
if not msg in unique_str:
|
||||
main_po += "\n#: " + location + "\n"
|
||||
main_po += 'msgid "' + msg + '"\n'
|
||||
main_po += 'msgstr ""\n'
|
||||
unique_str.append(msg)
|
||||
unique_loc[msg] = [location]
|
||||
elif not location in unique_loc[msg]:
|
||||
# Add additional location to previous occurrence too
|
||||
msg_pos = main_po.find('\nmsgid "' + msg + '"')
|
||||
if msg_pos == -1:
|
||||
print("Someone apparently thought writing Python was as easy as GDScript. Ping Akien.")
|
||||
main_po = main_po[:msg_pos] + " " + location + main_po[msg_pos:]
|
||||
unique_loc[msg].append(location)
|
||||
|
||||
if msgctx != "":
|
||||
# If it's a new context or a new message within an existing context, then write new msgid.
|
||||
# Else add location to existing msgid.
|
||||
if not msgctx in ctx_group:
|
||||
_write_message(msgctx, msg, msg_plural, location)
|
||||
ctx_group[msgctx] = {msg: [location]}
|
||||
elif not msg in ctx_group[msgctx]:
|
||||
_write_message(msgctx, msg, msg_plural, location)
|
||||
ctx_group[msgctx][msg] = [location]
|
||||
elif not location in ctx_group[msgctx][msg]:
|
||||
_add_additional_location(msgctx, msg, location)
|
||||
ctx_group[msgctx][msg].append(location)
|
||||
else:
|
||||
if not msg in unique_str:
|
||||
_write_message(msgctx, msg, msg_plural, location)
|
||||
unique_str.append(msg)
|
||||
unique_loc[msg] = [location]
|
||||
elif not location in unique_loc[msg]:
|
||||
_add_additional_location(msgctx, msg, location)
|
||||
unique_loc[msg].append(location)
|
||||
l = f.readline()
|
||||
lc += 1
|
||||
|
||||
|
|
@ -102,6 +169,8 @@ def process_file(f, fname):
|
|||
print("Updating the editor.pot template...")
|
||||
|
||||
for fname in matches:
|
||||
# NOTE FOR MENTORS: When I tested on windows I need to add encoding="utf8" at the end to be able to open the file.
|
||||
# maybe on Linux there's no need.
|
||||
with open(fname, "r") as f:
|
||||
process_file(f, fname)
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ void GDScriptEditorTranslationParserPlugin::get_recognized_extensions(List<Strin
|
|||
GDScriptLanguage::get_singleton()->get_recognized_extensions(r_extensions);
|
||||
}
|
||||
|
||||
Error GDScriptEditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_extracted_strings) {
|
||||
Error GDScriptEditorTranslationParserPlugin::parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) {
|
||||
// Parse and match all GDScript function API that involves translation string.
|
||||
// E.g get_node("Label").text = "something", var test = tr("something"), "something" will be matched and collected.
|
||||
|
||||
|
|
@ -63,7 +63,11 @@ Error GDScriptEditorTranslationParserPlugin::parse_file(const String &p_path, Ve
|
|||
_parse_file_dialog(source_code, &temp);
|
||||
parsed_strings.append_array(temp);
|
||||
|
||||
// Filter out / and +
|
||||
// Special handling for tr and tr_n.
|
||||
_handle_tr_pattern(source_code, tr_pattern, r_ids_ctx_plural);
|
||||
_handle_tr_pattern(source_code, trn_pattern, r_ids_ctx_plural);
|
||||
|
||||
// Filter out / and + used when user writes over multiple lines in GDScript
|
||||
String filter = "(?:\\\\\\n|\"[\\s\\\\]*\\+\\s*\")";
|
||||
regex.clear();
|
||||
regex.compile(filter);
|
||||
|
|
@ -71,7 +75,7 @@ Error GDScriptEditorTranslationParserPlugin::parse_file(const String &p_path, Ve
|
|||
parsed_strings.set(i, regex.sub(parsed_strings[i], "", true));
|
||||
}
|
||||
|
||||
r_extracted_strings->append_array(parsed_strings);
|
||||
r_ids->append_array(parsed_strings);
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
|
@ -112,6 +116,46 @@ void GDScriptEditorTranslationParserPlugin::_get_captured_strings(const Array &p
|
|||
}
|
||||
}
|
||||
|
||||
void GDScriptEditorTranslationParserPlugin::_handle_tr_pattern(const String &p_source_code, const String &p_pattern, Vector<Vector<String>> *r_ids_ctx_plural) {
|
||||
regex.clear();
|
||||
regex.compile(p_pattern);
|
||||
Array results = regex.search_all(p_source_code);
|
||||
Ref<RegExMatch> reg_match;
|
||||
|
||||
int valid_group_count = 0;
|
||||
if (p_pattern == tr_pattern) {
|
||||
valid_group_count = 2;
|
||||
} else if (p_pattern == trn_pattern) {
|
||||
valid_group_count = 3;
|
||||
} else {
|
||||
ERR_FAIL_MSG("Invalid p_pattern parameter. Unrecognized tr pattern.");
|
||||
return;
|
||||
}
|
||||
|
||||
// Get msgid, context and plural from RegEx search result.
|
||||
for (int i = 0; i < results.size(); i++) {
|
||||
reg_match = results[i];
|
||||
ERR_FAIL_COND_MSG(reg_match->get_group_count() != valid_group_count, "Number of captured groups from RegEx pattern doesn't match.");
|
||||
|
||||
String msgid = reg_match->get_string(1);
|
||||
String context, plural;
|
||||
if (valid_group_count == 2) {
|
||||
context = reg_match->get_string(2);
|
||||
} else if (valid_group_count == 3) {
|
||||
plural = reg_match->get_string(2);
|
||||
context = reg_match->get_string(3);
|
||||
}
|
||||
|
||||
if (!msgid.strip_edges().empty()) {
|
||||
Vector<String> id_ctx_plural;
|
||||
id_ctx_plural.push_back(msgid);
|
||||
id_ctx_plural.push_back(context);
|
||||
id_ctx_plural.push_back(plural.strip_edges().empty() ? "" : plural);
|
||||
r_ids_ctx_plural->push_back(id_ctx_plural);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
GDScriptEditorTranslationParserPlugin::GDScriptEditorTranslationParserPlugin() {
|
||||
// Regex search pattern templates.
|
||||
// The extra complication in the regex pattern is to ensure that the matching works when users write over multiple lines, use tabs etc.
|
||||
|
|
@ -121,7 +165,6 @@ GDScriptEditorTranslationParserPlugin::GDScriptEditorTranslationParserPlugin() {
|
|||
const String second_arg_template = "[\\s\\\\]*\\([\\s\\S]+?,[\\s\\\\]*\"" + text + "\"[\\s\\S]*?\\)";
|
||||
|
||||
// Common patterns.
|
||||
patterns.push_back("tr" + first_arg_template);
|
||||
patterns.push_back(dot + "text" + str_assign_template);
|
||||
patterns.push_back(dot + "placeholder_text" + str_assign_template);
|
||||
patterns.push_back(dot + "hint_tooltip" + str_assign_template);
|
||||
|
|
|
|||
|
|
@ -39,15 +39,18 @@ class GDScriptEditorTranslationParserPlugin : public EditorTranslationParserPlug
|
|||
|
||||
// Regex and search patterns that are used to match translation strings.
|
||||
const String text = "((?:[^\"\\\\]|\\\\[\\s\\S])*(?:\"[\\s\\\\]*\\+[\\s\\\\]*\"(?:[^\"\\\\]|\\\\[\\s\\S])*)*)";
|
||||
const String tr_pattern = "tr[\\s\\\\]*\\([\\s\\\\]*\"" + text + "\"(?:[\\s\\\\]*,[\\s\\\\]*\"" + text + "\")?[\\s\\\\]*\\)";
|
||||
const String trn_pattern = "tr_n[\\s\\\\]*\\([\\s\\\\]*\"" + text + "\"[\\s\\\\]*,[\\s\\\\]*\"" + text + "\".*?(?:\"" + text + "\"[\\s\\\\]*)?\\)";
|
||||
RegEx regex;
|
||||
Vector<String> patterns;
|
||||
Vector<String> file_dialog_patterns;
|
||||
|
||||
void _parse_file_dialog(const String &p_source_code, Vector<String> *r_output);
|
||||
void _get_captured_strings(const Array &p_results, Vector<String> *r_output);
|
||||
void _handle_tr_pattern(const String &p_source_code, const String &p_pattern, Vector<Vector<String>> *r_ids_ctx_plural);
|
||||
|
||||
public:
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_extracted_strings) override;
|
||||
virtual Error parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) override;
|
||||
virtual void get_recognized_extensions(List<String> *r_extensions) const override;
|
||||
|
||||
GDScriptEditorTranslationParserPlugin();
|
||||
|
|
|
|||
Loading…
Reference in a new issue