Merge lp:~dpm/intltool/add-qtdesigner-support into lp:intltool

[David Planella]

This branch adds support for extracting translatable strings from Qt Designer files through a new gettext/qtdesigner type (lp:953342).

Notes: the regexp used to extract the strings from the XML attributes of the <string> tag used by Qt .ui files is similar to the one used to extraxt strings from Glade .ui files in the sense that it relies on those tags being present in a particular order.

[Данило Шеган (danilo)]

Btw, at least the doc links are incorrect in intltool-extract.in:

 - http://qt-project.org/doc/qt-5.0/qtlinguist/linguist-ts-file-format.html
 - http://qt-project.org/doc/qt-5.0/qtdesigner/designer-ui-file-format.html

are currently correct links (I assume they have changed since you started work on this).

Btw, I would prefer if the support was done using the real XML parser: that would ensure that a lot more of the XML syntax is supported, and that we don't accidentally break when eg. the order of attributes changes in the XML file.

A good example is type_gsettings/traverse_gsettings functions.

review: Needs Fixing

[lp:~dpm/intltool/add-qtdesigner-support]

739. By David Planella on 2013-05-09

Updated links to Qt translation format specs

740. By David Planella on 2013-05-10

Updated test case for Qt Designer extraction: no escapes

741. By David Planella on 2013-05-10

Added Qt Designer .ui file extraction support using the internal XML parser

742. By David Planella on 2013-05-10

Updated man page with the new gettext/qtdesigner type for extraction

743. By David Planella on 2013-05-10

Added files for gettext/qtdesigner testcase and result to the corresponding Makefile.am files

[David Planella (dpm)]

Ok, addressed the two points above and re-submitted MP.

[Rohan Garg (rohangarg)]

Any ETA when this is going to land? This also fixes bug 1234106 for Kubuntu so it'll be nice to have it land soon.

[Данило Шеган (danilo)]

Hi David (and other interested parties): sorry for taking this long to take another look at this. It somehow slipped my radar (so thanks everyone for reminding me).

The branch looks pretty good. Since you are also doing special whitespace handling, it would be good to have at least one of the strings in a test case actually demonstrate that. Since I've taken this long to review it, I'll do this myself.

I'll be merging this branch, but I won't be releasing it until we clarify a few other things. I am most worried about the escaping support. One of the examples in the test case is an HTML string, but ideally, that'd be unescaped in PO files (for translators' benefit). Where's the code that actually reads MO files? Is there any good example code for me to check out to see how would everything fit together?

review: Approve

=== modified file 'doc/intltool-extract.8'
--- doc/intltool-extract.8	2011-10-08 19:24:23 +0000
+++ doc/intltool-extract.8	2013-05-10 09:59:25 +0000
@@ -54,6 +54,8 @@
 "gettext/scheme" (.scm)
 .br
 "gettext/xml" (Generic XML file)
+.br
+"gettext/qtdesigner" (Qt Designer .ui files)
 .IP "\fB\-v\fR" 4
 .PD 0
 .IP "\fB\--version\fR" 4

=== modified file 'intltool-extract.in'
--- intltool-extract.in	2012-08-23 03:39:02 +0000
+++ intltool-extract.in	2013-05-10 09:59:25 +0000
@@ -165,7 +165,7 @@
                     "gettext/glade", "gettext/ini", "gettext/keys"
                     "gettext/rfc822deb", "gettext/schemas",
                     "gettext/gsettings", "gettext/xml", "gettext/quoted",
-                    "gettext/quotedxml", "gettext/tlk"
+                    "gettext/quotedxml", "gettext/tlk", "gettext/qtdesigner"
   -l, --local       Writes output into current working directory
                     (conflicts with --update)
       --update      Writes output into the same directory the source file
@@ -225,6 +225,7 @@
     &type_quoted if $gettext_type eq "quoted";
     &type_quotedxml if $gettext_type eq "quotedxml";
     &type_tlk if $gettext_type eq "tlk";
+    &type_qtdesigner if $gettext_type eq "qtdesigner";
 }
 
 sub entity_decode_minimal
@@ -828,6 +829,77 @@
     }
 }
 
+# Parse the tree as returned by readXml() for Qt Designer .ui files.
+sub traverse_qtdesigner {
+    my $nodename = shift;
+    my $content = shift;
+    my @list = @{ $content };
+    my $attrs_ref = shift @list;
+    my %attrs = %{ $attrs_ref };
+    if ($nodename eq 'string' and !exists $attrs{"notr"}) {
+        # Preserve whitespace.  Deal with it ourselves, below.
+        my $message = getXMLstring($content, 1);
+
+        # We strip leading and trailing whitespace but
+        # preserve whitespace within (e.g. newlines)
+        $message =~ s/^\s+//;
+        $message =~ s/\s+$//;
+
+        my $context = $attrs{'comment'};
+        # Remove enclosing quotes from msgctxt
+        $context =~ s/^["'](.*)["']/$1/ if $context;
+        $message = $context . "\004" . $message if $context;
+        add_message($message);
+	my $comment = $attrs{'extracomment'};
+        # Remove enclosing quotes from developer comments
+        $comment =~ s/^["'](.*)["']/$1/ if $comment;
+        $comments{$message} = $comment if $comment;
+    } else {
+        my $index = 0;
+        while (scalar(@list) > 1) {
+            my $type = shift @list;
+            my $content = shift @list;
+            if (!$type || "$type" eq "1") {
+                next;
+            } else {
+                traverse_qtdesigner($type, $content);
+            }
+        }
+    }
+}
+
+sub type_qtdesigner {
+    ### For translatable Qt Designer XML files ###
+    #
+    # Specs:
+    # 
+    # - http://qt-project.org/doc/qt-5.0/qtlinguist/linguist-ts-file-format.html
+    # - http://qt-project.org/doc/qt-5.0/qtdesigner/designer-ui-file-format.html
+    #
+    # <string> tag attributes:
+    #
+    # notr="true" means the string is not translatable
+    # extracomment maps to a developer comment in gettext
+    # comment corresponds to "disambiguation" in the Qt Linguist API, and maps
+    # to msgctxt in gettext
+    #
+    # Example:
+    #
+    # <string comment="Button" extracomment="TRANSLATORS: refers to the
+    # action of accepting something">Ok</string>
+
+    my $tree = readXml($input);
+    my @tree_nodes = @{ $tree };
+    my $node = shift @tree_nodes;
+    while (!$node || "$node" eq "1") {
+        shift @tree_nodes;
+        $node = shift @tree_nodes;
+    }
+    my $content = shift @tree_nodes;
+    traverse_qtdesigner($node, $content);
+
+}
+
 sub type_glade {
     ### For translatable Glade XML files ###
 

=== modified file 'tests/cases/Makefile.am'
--- tests/cases/Makefile.am	2011-10-08 18:08:58 +0000
+++ tests/cases/Makefile.am	2013-05-10 09:59:25 +0000
@@ -16,6 +16,7 @@
 	extract8.glade				\
 	extract9.po				\
 	extract9.xml.in				\
+	extract-qtdesigner.ui			\
 	fr.po					\
 	fr_BE.po				\
 	fr_FR.po				\
@@ -58,6 +59,7 @@
 	extract14.xml.in.h			\
 	extract9.xml				\
 	extract9.xml.in.h			\
+	extract-qtdesigner.ui.h			\
 	gsettings.gschema.xml.h			\
 	iso88591text.xml.in.h			\
 	merge-cdata.xml				\

=== added file 'tests/cases/extract-qtdesigner.ui'
--- tests/cases/extract-qtdesigner.ui	1970-01-01 00:00:00 +0000
+++ tests/cases/extract-qtdesigner.ui	2013-05-10 09:59:25 +0000
@@ -0,0 +1,210 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>main</class>
+ <widget class="QWidget" name="main">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>640</width>
+    <height>457</height>
+   </rect>
+  </property>
+  <property name="sizePolicy">
+   <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
+    <horstretch>0</horstretch>
+    <verstretch>0</verstretch>
+   </sizepolicy>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QHBoxLayout" name="horizontalLayout">
+   <property name="spacing">
+    <number>0</number>
+   </property>
+   <property name="margin">
+    <number>0</number>
+   </property>
+   <item>
+    <widget class="QTabWidget" name="tabWidget">
+     <property name="currentIndex">
+      <number>0</number>
+     </property>
+     <widget class="QWidget" name="tabWelcome">
+      <attribute name="title">
+       <string notr="true">Do not translate this</string>
+      </attribute>
+      <layout class="QHBoxLayout" name="horizontalLayout_5">
+       <property name="spacing">
+        <number>0</number>
+       </property>
+       <property name="margin">
+        <number>0</number>
+       </property>
+       <item>
+        <layout class="QVBoxLayout" name="verticalLayout_5">
+         <property name="spacing">
+          <number>0</number>
+         </property>
+         <item>
+          <widget class="QWidget" name="welcomeTop" native="true">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Preferred" vsizetype="Maximum">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <property name="minimumSize">
+            <size>
+             <width>0</width>
+             <height>100</height>
+            </size>
+           </property>
+           <layout class="QVBoxLayout" name="verticalLayout_6">
+            <property name="spacing">
+             <number>0</number>
+            </property>
+            <property name="margin">
+             <number>0</number>
+            </property>
+            <item>
+             <layout class="QHBoxLayout" name="horizontalLayout_4">
+              <property name="spacing">
+               <number>0</number>
+              </property>
+              <item>
+               <widget class="QWidget" name="welcomeTopText" native="true">
+                <widget class="QLabel" name="welcomeLabel">
+                 <property name="geometry">
+                  <rect>
+                   <x>30</x>
+                   <y>20</y>
+                   <width>330</width>
+                   <height>51</height>
+                  </rect>
+                 </property>
+                 <property name="font">
+                  <font>
+                   <family>Ubuntu</family>
+                   <pointsize>21</pointsize>
+                  </font>
+                 </property>
+                 <property name="text">
+                  <string extracomment="TRANSLATORS: this is the main title of the authentication dialog">This is a translatable title</string>
+                 </property>
+                </widget>
+               </widget>
+              </item>
+             </layout>
+            </item>
+           </layout>
+          </widget>
+         </item>
+         <item>
+          <widget class="QWidget" name="welcomeBottom" native="true">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <property name="minimumSize">
+            <size>
+             <width>0</width>
+             <height>0</height>
+            </size>
+           </property>
+           <widget class="QTextEdit" name="welcomeTextBox">
+            <property name="geometry">
+             <rect>
+              <x>30</x>
+              <y>20</y>
+              <width>571</width>
+              <height>181</height>
+             </rect>
+            </property>
+            <property name="frameShape">
+             <enum>QFrame::NoFrame</enum>
+            </property>
+            <property name="frameShadow">
+             <enum>QFrame::Plain</enum>
+            </property>
+            <property name="readOnly">
+             <bool>true</bool>
+            </property>
+            <property name="html">
+             <string>&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.0//EN&quot; &quot;http://www.w3.org/TR/REC-html40/strict.dtd&quot;&gt;
+&lt;html&gt;&lt;head&gt;&lt;meta name=&quot;qrichtext&quot; content=&quot;1&quot; /&gt;&lt;title&gt;HTML document extraction test&lt;/title&gt;&lt;style type=&quot;text/css&quot;&gt;
+p, li { white-space: pre-wrap; }
+&lt;/style&gt;&lt;/head&gt;&lt;body style=&quot; font-family:'Ubuntu'; font-size:11pt; font-weight:400; font-style:normal;&quot;&gt;
+&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Once upon a time, in a galaxy far, far away... &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+            </property>
+           </widget>
+           <widget class="QPushButton" name="friendlyTestsButton">
+            <property name="geometry">
+             <rect>
+              <x>30</x>
+              <y>210</y>
+              <width>571</width>
+              <height>31</height>
+             </rect>
+            </property>
+            <property name="font">
+             <font>
+              <pointsize>9</pointsize>
+             </font>
+            </property>
+            <property name="text">
+             <string comment="Button" extracomment="TRANSLATORS: refers to the action of accepting something">Ok</string>
+            </property>
+           </widget>
+           <widget class="QCheckBox" name="checkBox">
+            <property name="geometry">
+             <rect>
+              <x>30</x>
+              <y>280</y>
+              <width>321</width>
+              <height>20</height>
+             </rect>
+            </property>
+            <property name="font">
+             <font>
+              <family>Ubuntu</family>
+             </font>
+            </property>
+            <property name="text">
+             <string comment="WelcomeDialog">Don't show me this message in the future</string>
+            </property>
+           </widget>
+           <widget class="QCheckBox" name="checkBox_2">
+            <property name="geometry">
+             <rect>
+              <x>30</x>
+              <y>260</y>
+              <width>321</width>
+              <height>20</height>
+             </rect>
+            </property>
+            <property name="font">
+             <font>
+              <family>Ubuntu</family>
+             </font>
+            </property>
+            <property name="text">
+             <string extracomment="TRANSLATORS: authentication is required to perform this action">Require authentication</string>
+            </property>
+           </widget>
+          </widget>
+         </item>
+        </layout>
+       </item>
+      </layout>
+     </widget>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

=== modified file 'tests/results/Makefile.am'
--- tests/results/Makefile.am	2011-10-08 18:08:58 +0000
+++ tests/results/Makefile.am	2013-05-10 09:59:25 +0000
@@ -17,6 +17,7 @@
 	extract12.xml.in.h			\
 	extract14.xml.in.h			\
 	extract-gtkbuilder.ui.h			\
+	extract-qtdesigner.ui.h			\
 	gsettings.gschema.xml.h			\
 	iso88591text.xml.in.h			\
 	merge-cdata.xml				\

=== added file 'tests/results/extract-qtdesigner.ui.h'
--- tests/results/extract-qtdesigner.ui.h	1970-01-01 00:00:00 +0000
+++ tests/results/extract-qtdesigner.ui.h	2013-05-10 09:59:25 +0000
@@ -0,0 +1,13 @@
+char *s = N_("Form");
+/* TRANSLATORS: this is the main title of the authentication dialog */
+char *s = N_("This is a translatable title");
+char *s = N_("&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.0//EN&quot; &quot;http://www.w3.org/TR/REC-html40/strict.dtd&quot;&gt;\n"
+             "&lt;html&gt;&lt;head&gt;&lt;meta name=&quot;qrichtext&quot; content=&quot;1&quot; /&gt;&lt;title&gt;HTML document extraction test&lt;/title&gt;&lt;style type=&quot;text/css&quot;&gt;\n"
+             "p, li { white-space: pre-wrap; }\n"
+             "&lt;/style&gt;&lt;/head&gt;&lt;body style=&quot; font-family:'Ubuntu'; font-size:11pt; font-weight:400; font-style:normal;&quot;&gt;\n"
+             "&lt;p style=&quot; margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Once upon a time, in a galaxy far, far away... &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;");
+/* TRANSLATORS: refers to the action of accepting something */
+char *s = C_("Button", "Ok");
+char *s = C_("WelcomeDialog", "Don't show me this message in the future");
+/* TRANSLATORS: authentication is required to perform this action */
+char *s = N_("Require authentication");

=== modified file 'tests/selftest.pl.in'
--- tests/selftest.pl.in	2012-08-23 03:39:02 +0000
+++ tests/selftest.pl.in	2013-05-10 09:59:25 +0000
@@ -294,6 +294,11 @@
 system("$INTLTOOL_EXTRACT --type=gettext/glade --quiet --update cases/$case") == 0 or $failed = 1;
 check_extract_result($case);
 
+print "40. Extract messages from a Qt Designer UI file:                     ";
+$case = "extract-qtdesigner.ui";
+system("$INTLTOOL_EXTRACT --type=gettext/qtdesigner --quiet --update cases/$case") == 0 or $failed = 1;
+check_extract_result($case);
+
 
 system("rm -f cases/*.*") if $srcdir ne ".";
 system("rm -rf C az extract9 fr fr_BE fr_FR merge6 schemasmerge1 schemasmerge2 spacepreserve test test-quoted merge6.xml");