Add script to find ui visible string changes

Change-Id: I685e65258078784acf9ce30703a8192bb1f8fd8a
Reviewed-by: Christian Stenger <christian.stenger@theqtcompany.com>

scripts/uichanges.py

+#!/usr/bin/env python
+################################################################################
+# Copyright (C) 2014 Digia Plc
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of Digia Plc, nor the names of its contributors
+#     may be used to endorse or promote products derived from this software
+#     without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+"""
+A simple program that parses untranslated.ts files
+
+current directory *must* be the top level qtcreator source directory
+
+Usage:
+    scripts/uichanges.py old_untranslated.ts qtcreator_untranslated.ts
+
+    IN TOP LEVEL QTC SOURCE DIRECTORY!
+"""
+
+import os, sys, string
+import subprocess
+
+from xml.sax import saxutils, handler, make_parser
+
+baseDir = os.getcwd()
+transDir = os.path.join(baseDir, 'share/qtcreator/translations')
+unchangedContexts = 0
+
+# --- The ContentHandler
+
+# Generate a tree consisting of hash of context names.
+# Each context name value contains a hash of messages
+# Each message value contains a the file name (or '<unknown>')
+class Generator(handler.ContentHandler):
+
+    def __init__(self):
+        handler.ContentHandler.__init__(self)
+        self._tree = {}
+        self._contextTree = {}
+        self._context = ''
+        self._file = ''
+        self._msg = ''
+        self._chars = ''
+
+    # ContentHandler methods
+
+    def startDocument(self):
+        self._tree = {}
+        self._contextTree = {}
+        self._context = ''
+        self._file = ''
+        self._chars = ''
+
+    def startElement(self, name, attrs):
+        if name == 'location':
+            fn = attrs.get('filename')
+            if fn:
+                fn = os.path.normpath(os.path.join(transDir, fn))
+                fn = os.path.relpath(fn, baseDir)
+            else:
+                fn = '<unknown>'
+            self._file = fn
+            return
+
+    def endElement(self, name):
+        if name == 'name':
+            if self._context == '':
+                self._context = self._chars
+                self._chars = ''
+        elif name == 'source':
+            if self._chars:
+                self._msg = self._chars
+                self._chars = ''
+        elif name == 'message':
+            if self._msg:
+                self._contextTree[self._msg] = self._file
+
+            self._chars = ''
+            self._file = '<unknown>'
+            self._msg = ''
+        elif name == 'context':
+            if self._context != '':
+                 self._tree[self._context] = self._contextTree
+            self._contextTree = {}
+            self._context = ''
+
+    def characters(self, content):
+        self._chars = content
+
+    def tree(self):
+        return self._tree
+
+def commitsForFile(file):
+    output = ''
+    if file == '<unknown>':
+        return output
+
+    try:
+        output = subprocess.check_output(u'git log -1 -- "{0}"'.format(file),
+                                         shell=True, stderr=subprocess.STDOUT,
+                                         universal_newlines=True)
+    except:
+        output = ''
+
+    return output
+
+def examineMsg(ctx, msg, oldFile, newFile):
+    if oldFile == newFile:
+        # return ('', u'    EQL Message: "{0}" ({1})\n'.format(msg, oldFile))
+        return ('', '')
+
+    if oldFile == '':
+        return (commitsForFile(newFile), u'    ADD: "{0}" ({1})\n'.format(msg, newFile))
+
+    if newFile == '':
+        return (commitsForFile(oldFile), u'    DEL: "{0}" ({1})\n'.format(msg, oldFile))
+
+    return (commitsForFile(newFile), u'    MOV: "{0}" ({1} -> {2})\n'.format(msg, oldFile, newFile))
+
+def diffContext(ctx, old, new):
+    oldMsgSet = set(old.keys())
+    newMsgSet = set(new.keys())
+
+    gitResults = set()
+    report = ''
+    unchanged = 0
+
+    for m in sorted(oldMsgSet.difference(newMsgSet)):
+        res = examineMsg(ctx, m, old[m], '')
+        gitResults.add(res[0])
+        report = report + res[1]
+        if not res[1]:
+            unchanged += 1
+
+    for m in sorted(newMsgSet.difference(oldMsgSet)):
+        res = examineMsg(ctx, m, '', new[m])
+        gitResults.add(res[0])
+        report = report + res[1]
+        if not res[1]:
+            unchanged += 1
+
+    for m in sorted(oldMsgSet.intersection(newMsgSet)):
+        res = examineMsg(ctx, m, old[m], new[m])
+        gitResults.add(res[0])
+        report = report + res[1]
+        if not res[1]:
+            unchanged += 1
+
+    gitResults.discard('')
+
+    if not report:
+        return ''
+
+    report = u'\nContext "{0}":\n{1}    {2} unchanged messages'.format(ctx, report, unchanged)
+
+    if gitResults:
+        report += '\n\n    Git Commits:\n'
+        for g in gitResults:
+            if g:
+                g = u'        {}'.format(unicode(g.replace('\n', '\n        '), errors='replace'))
+                report += g
+
+    return report
+
+# --- The main program
+
+generator = Generator()
+parser = make_parser()
+parser.setContentHandler(generator)
+parser.parse(sys.argv[1])
+
+oldTree = generator.tree()
+
+parser.parse(sys.argv[2])
+newTree = generator.tree()
+
+oldContextSet = set(oldTree.keys())
+newContextSet = set(newTree.keys())
+
+for c in sorted(oldContextSet.difference(newContextSet)):
+    report = diffContext(c, oldTree[c], {})
+    if report:
+        print(report.encode('utf-8'))
+    else:
+        unchangedContexts += 1
+
+for c in sorted(newContextSet.difference(oldContextSet)):
+    report = diffContext(c, {}, newTree[c])
+    if report:
+        print(report.encode('utf-8'))
+    else:
+        unchangedContexts += 1
+
+for c in sorted(newContextSet.intersection(oldContextSet)):
+    report = diffContext(c, oldTree[c], newTree[c])
+    if report:
+        print(report.encode('utf-8'))
+    else:
+        unchangedContexts += 1
+
+print(u'{0} unchanged contexts'.format(unchangedContexts))