lupdate/Python: Fix extra comments being added to the wrong message

parseTranslate() can read past the message and capture extraComments
intended for the next message. Use only extraComments for the current
message, checking on line numbers.

Since the same issue exists for message ids, fix it using
the same approach.

Fixes: PYSIDE-2863
Pick-to: 6.5
Change-Id: I2eb3fc0edd557d32917a05392caab05e2da9b1e7
Reviewed-by: Joerg Bornemann <[email protected]>
(cherry picked from commit 0eac225)
Reviewed-by: Qt Cherry-pick Bot <[email protected]>

Author: FriedemannKleint

src/linguist/lupdate/python.cpp

@@ -6,6 +6,7 @@
 #include "lupdate.h"
 
 #include <QtCore/qhash.h>
+#include <QtCore/qlist.h>
 #include <QtCore/qstring.h>
 #include <QtCore/qtextstream.h>
 #include <QtCore/qstack.h>
@@ -53,8 +54,15 @@ static int yyParenDepth;
 static int yyLineNo;
 static int yyCurLineNo;
 
-static QByteArray extraComment;
-static QByteArray id;
+struct ExtraComment
+{
+    QByteArray extraComment;
+    int lineNo;
+};
+
+static QList<ExtraComment> extraComments;
+
+static QList<ExtraComment> ids;
 
 QHash<QByteArray, Token> tokens = {
     {"None", Tok_None},
@@ -302,10 +310,10 @@ static Token getToken(StringType stringType = StringType::NoString)
         case '#':
             switch (getChar()) {
             case ':':
-                extraComment = readLine().trimmed();
+                extraComments.append({readLine().trimmed(), yyCurLineNo});
                 break;
             case '=':
-                id = readLine().trimmed();
+                ids.append({readLine().trimmed(), yyCurLineNo});
                 break;
             case EOF:
                 return Tok_Eof;
@@ -583,16 +591,24 @@ static bool parseTranslate(QByteArray *text, QByteArray *context, QByteArray *co
     return false;
 }
 
-static inline void setMessageParameters(TranslatorMessage *message)
+static void setMessageParameters(TranslatorMessage *message,
+                                 int lineNo)
 {
-    if (!extraComment.isEmpty()) {
-        message->setExtraComment(QString::fromUtf8(extraComment));
-        extraComment.clear();
-    }
-    if (!id.isEmpty()) {
-        message->setId(QString::fromUtf8(id));
-        id.clear();
+    // PYSIDE-2863: parseTranslate() can read past the message
+    // and capture extraComments intended for the next message.
+    // Use only extraComments for the current message.
+    QByteArray extraComment;
+    while (!extraComments.isEmpty() && extraComments.constFirst().lineNo <= lineNo) {
+        if (!extraComment.isEmpty())
+            extraComment += ' ';
+        extraComment += extraComments.takeFirst().extraComment;
     }
+
+    if (!extraComment.isEmpty())
+        message->setExtraComment(QString::fromUtf8(extraComment));
+
+    while (!ids.isEmpty() && ids.constFirst().lineNo <= lineNo)
+        message->setId(QString::fromUtf8(ids.takeFirst().extraComment));
 }
 
 static void parse(Translator &tor, ConversionData &cd,
@@ -635,9 +651,10 @@ static void parse(Translator &tor, ConversionData &cd,
                 yyTok = getToken();
                 break;
             case Tok_tr:
-            case Tok_trUtf8:
+            case Tok_trUtf8: {
                 utf8 = true;
                 yyTok = getToken();
+                const int lineNo = yyCurLineNo;
                 if (match(Tok_LeftParen) && matchString(&text)) {
                     comment.clear();
                     bool plural = false;
@@ -670,21 +687,23 @@ static void parse(Translator &tor, ConversionData &cd,
                                                   QString::fromUtf8(comment),
                                                   {}, yyFileName, yyLineNo,
                                                   {}, TranslatorMessage::Unfinished, plural);
-                        setMessageParameters(&message);
+                        setMessageParameters(&message, lineNo);
                         tor.extend(message, cd);
                     }
                 }
+            }
                 break;
             case Tok_translate: {
                 bool plural{};
+                const int lineNo = yyCurLineNo;
                 if (parseTranslate(&text, &context, &comment, &utf8, &plural)
                     && !text.isEmpty()) {
                         TranslatorMessage message(QString::fromUtf8(context),
                                                   QString::fromUtf8(text),
                                                   QString::fromUtf8(comment),
                                                   {}, yyFileName, yyLineNo,
                                                   {}, TranslatorMessage::Unfinished, plural);
-                        setMessageParameters(&message);
+                        setMessageParameters(&message, lineNo);
                         tor.extend(message, cd);
                     }
                 }

tests/auto/linguist/lupdate/testdata/good/parsepython/main.py

@@ -77,6 +77,17 @@ def window_method(self):  # PYSIDE-2379, Don't put this into NestedClass
         msg = self.tr(r"A raw strin\g""continued\\")
         msg = self.tr(r"A raw string with escaped quote\"bla")
 
+    def test_pyside2863(self):
+        """PYSIDE-2863, Check whether id and extra comments are correctly associated."""
+        #= id_1
+        msg = self.tr("msg1")
+        #= id_2
+        msg = self.tr("msg2")
+        #: Extra comment 3
+        msg = self.tr("msg3")
+        #: Extra comment 4
+        msg = self.tr("msg4")
+
 
 if __name__ == '__main__':
     app = QApplication(sys.argv)

tests/auto/linguist/lupdate/testdata/good/parsepython/project.ts.result

@@ -101,9 +101,31 @@
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="main.py" line="81"/>
+        <location filename="main.py" line="80"/>
         <source>A raw string with escaped quote&quot;bla</source>
         <translation type="unfinished"></translation>
     </message>
+    <message id="id_1">
+        <location filename="main.py" line="85"/>
+        <source>msg1</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message id="id_2">
+        <location filename="main.py" line="87"/>
+        <source>msg2</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="main.py" line="89"/>
+        <source>msg3</source>
+        <extracomment>Extra comment 3</extracomment>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="main.py" line="92"/>
+        <source>msg4</source>
+        <extracomment>Extra comment 4</extracomment>
+        <translation type="unfinished"></translation>
+    </message>
 </context>
 </TS>