1 files changed, 105 insertions, 17 deletions

diff --git a/core/io/translation_loader_po.cpp b/core/io/translation_loader_po.cpp
index 11aeddee09..9adf912224 100644
--- a/core/io/translation_loader_po.cpp
+++ b/core/io/translation_loader_po.cpp
@@ -5,8 +5,8 @@
 /*                           GODOT ENGINE                                */
 /*                      https://godotengine.org                          */
 /*************************************************************************/
-/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
-/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
+/* 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       */
@@ -31,27 +31,35 @@
 #include "translation_loader_po.h"
 
 #include "core/os/file_access.h"
-#include "core/translation.h"
+#include "core/string/translation.h"
+#include "core/string/translation_po.h"
 
 RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 	enum Status {
 		STATUS_NONE,
 		STATUS_READING_ID,
 		STATUS_READING_STRING,
+		STATUS_READING_CONTEXT,
+		STATUS_READING_PLURAL,
 	};
 
 	Status status = STATUS_NONE;
 
 	String msg_id;
 	String msg_str;
+	String msg_context;
+	Vector<String> msgs_plural;
 	String config;
 
 	if (r_error) {
 		*r_error = ERR_FILE_CORRUPT;
 	}
 
-	Ref<Translation> translation = Ref<Translation>(memnew(Translation));
+	Ref<TranslationPO> translation = Ref<TranslationPO>(memnew(TranslationPO));
 	int line = 1;
+	int plural_forms = 0;
+	int plural_index = -1;
+	bool entered_context = false;
 	bool skip_this = false;
 	bool skip_next = false;
 	bool is_eof = false;
@@ -62,41 +70,108 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 		is_eof = f->eof_reached();
 
 		// If we reached last line and it's not a content line, break, otherwise let processing that last loop
-		if (is_eof && l.empty()) {
-			if (status == STATUS_READING_ID) {
+		if (is_eof && l.is_empty()) {
+			if (status == STATUS_READING_ID || status == STATUS_READING_CONTEXT || (status == STATUS_READING_PLURAL && plural_index != plural_forms - 1)) {
 				memdelete(f);
-				ERR_FAIL_V_MSG(RES(), "Unexpected EOF while reading 'msgid' at: " + path + ":" + itos(line));
+				ERR_FAIL_V_MSG(RES(), "Unexpected EOF while reading PO file at: " + path + ":" + itos(line));
 			} else {
 				break;
 			}
 		}
 
-		if (l.begins_with("msgid")) {
+		if (l.begins_with("msgctxt")) {
+			if (status != STATUS_READING_STRING && status != STATUS_READING_PLURAL) {
+				memdelete(f);
+				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgctxt', was expecting 'msgid_plural' or 'msgstr' before 'msgctxt' while parsing: " + path + ":" + itos(line));
+			}
+
+			// In PO file, "msgctxt" appears before "msgid". If we encounter a "msgctxt", we add what we have read
+			// and set "entered_context" to true to prevent adding twice.
+			if (!skip_this && msg_id != "") {
+				if (status == STATUS_READING_STRING) {
+					translation->add_message(msg_id, msg_str, msg_context);
+				} else if (status == STATUS_READING_PLURAL) {
+					if (plural_index != plural_forms - 1) {
+						memdelete(f);
+						ERR_FAIL_V_MSG(RES(), "Number of 'msgstr[]' doesn't match with number of plural forms: " + path + ":" + itos(line));
+					}
+					translation->add_plural_message(msg_id, msgs_plural, msg_context);
+				}
+			}
+			msg_context = "";
+			l = l.substr(7, l.length()).strip_edges();
+			status = STATUS_READING_CONTEXT;
+			entered_context = true;
+		}
+
+		if (l.begins_with("msgid_plural")) {
+			if (plural_forms == 0) {
+				memdelete(f);
+				ERR_FAIL_V_MSG(RES(), "PO file uses 'msgid_plural' but 'Plural-Forms' is invalid or missing in header: " + path + ":" + itos(line));
+			} else if (status != STATUS_READING_ID) {
+				memdelete(f);
+				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgid_plural', was expecting 'msgid' before 'msgid_plural' while parsing: " + path + ":" + itos(line));
+			}
+			// We don't record the message in "msgid_plural" itself as tr_n(), TTRN(), RTRN() interfaces provide the plural string already.
+			// We just have to reset variables related to plurals for "msgstr[]" later on.
+			l = l.substr(12, l.length()).strip_edges();
+			plural_index = -1;
+			msgs_plural.clear();
+			msgs_plural.resize(plural_forms);
+			status = STATUS_READING_PLURAL;
+		} else if (l.begins_with("msgid")) {
 			if (status == STATUS_READING_ID) {
 				memdelete(f);
 				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgid', was expecting 'msgstr' while parsing: " + path + ":" + itos(line));
 			}
 
 			if (msg_id != "") {
-				if (!skip_this) {
-					translation->add_message(msg_id, msg_str);
+				if (!skip_this && !entered_context) {
+					if (status == STATUS_READING_STRING) {
+						translation->add_message(msg_id, msg_str, msg_context);
+					} else if (status == STATUS_READING_PLURAL) {
+						if (plural_index != plural_forms - 1) {
+							memdelete(f);
+							ERR_FAIL_V_MSG(RES(), "Number of 'msgstr[]' doesn't match with number of plural forms: " + path + ":" + itos(line));
+						}
+						translation->add_plural_message(msg_id, msgs_plural, msg_context);
+					}
 				}
 			} else if (config == "") {
 				config = msg_str;
+				// Record plural rule.
+				int p_start = config.find("Plural-Forms");
+				if (p_start != -1) {
+					int p_end = config.find("\n", p_start);
+					translation->set_plural_rule(config.substr(p_start, p_end - p_start));
+					plural_forms = translation->get_plural_forms();
+				}
 			}
 
 			l = l.substr(5, l.length()).strip_edges();
 			status = STATUS_READING_ID;
+			// If we did not encounter msgctxt, we reset context to empty to reset it.
+			if (!entered_context) {
+				msg_context = "";
+			}
 			msg_id = "";
 			msg_str = "";
 			skip_this = skip_next;
 			skip_next = false;
+			entered_context = false;
 		}
 
-		if (l.begins_with("msgstr")) {
+		if (l.begins_with("msgstr[")) {
+			if (status != STATUS_READING_PLURAL) {
+				memdelete(f);
+				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgstr[]', was expecting 'msgid_plural' before 'msgstr[]' while parsing: " + path + ":" + itos(line));
+			}
+			plural_index++; // Increment to add to the next slot in vector msgs_plural.
+			l = l.substr(9, l.length()).strip_edges();
+		} else if (l.begins_with("msgstr")) {
 			if (status != STATUS_READING_ID) {
 				memdelete(f);
-				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgstr', was expecting 'msgid' while parsing: " + path + ":" + itos(line));
+				ERR_FAIL_V_MSG(RES(), "Unexpected 'msgstr', was expecting 'msgid' before 'msgstr' while parsing: " + path + ":" + itos(line));
 			}
 
 			l = l.substr(6, l.length()).strip_edges();
@@ -108,7 +183,7 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 				skip_next = true;
 			}
 			line++;
-			continue; //nothing to read or comment
+			continue; // Nothing to read or comment.
 		}
 
 		if (!l.begins_with("\"") || status == STATUS_NONE) {
@@ -119,7 +194,7 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 		l = l.substr(1, l.length());
 		// Find final quote, ignoring escaped ones (\").
 		// The escape_next logic is necessary to properly parse things like \\"
-		// where the blackslash is the one being escaped, not the quote.
+		// where the backslash is the one being escaped, not the quote.
 		int end_pos = -1;
 		bool escape_next = false;
 		for (int i = 0; i < l.length(); i++) {
@@ -146,8 +221,12 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 
 		if (status == STATUS_READING_ID) {
 			msg_id += l;
-		} else {
+		} else if (status == STATUS_READING_STRING) {
 			msg_str += l;
+		} else if (status == STATUS_READING_CONTEXT) {
+			msg_context += l;
+		} else if (status == STATUS_READING_PLURAL && plural_index >= 0) {
+			msgs_plural.write[plural_index] = msgs_plural[plural_index] + l;
 		}
 
 		line++;
@@ -155,14 +234,23 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 
 	memdelete(f);
 
+	// Add the last set of data from last iteration.
 	if (status == STATUS_READING_STRING) {
 		if (msg_id != "") {
 			if (!skip_this) {
-				translation->add_message(msg_id, msg_str);
+				translation->add_message(msg_id, msg_str, msg_context);
 			}
 		} else if (config == "") {
 			config = msg_str;
 		}
+	} else if (status == STATUS_READING_PLURAL) {
+		if (!skip_this && msg_id != "") {
+			if (plural_index != plural_forms - 1) {
+				memdelete(f);
+				ERR_FAIL_V_MSG(RES(), "Number of 'msgstr[]' doesn't match with number of plural forms: " + path + ":" + itos(line));
+			}
+			translation->add_plural_message(msg_id, msgs_plural, msg_context);
+		}
 	}
 
 	ERR_FAIL_COND_V_MSG(config == "", RES(), "No config found in file: " + path + ".");
@@ -189,7 +277,7 @@ RES TranslationLoaderPO::load_translation(FileAccess *f, Error *r_error) {
 	return translation;
 }
 
-RES TranslationLoaderPO::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, bool p_no_cache) {
+RES TranslationLoaderPO::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
 	if (r_error) {
 		*r_error = ERR_CANT_OPEN;
 	}