Rework locale serialization and parsing with less repetition

... because copy-and-paste is worth discouraging.  Moved code that
writes and digests our Q Local XML form of the data into a common
class, localexml.Locale, for use by the scripts that write and read
it.  Hopefully, it'll be easier to keep what's written and read in
sync hereafter.

Inlined some trivial functions in the process; and only create a
day-number mapping dictionary once, instead of once per use.  Also
made it easier to see which attributes get which special handling (and
documented this); and revised an assertion to be more helpful.

Change-Id: I711b6a193a4ad94b5ff714c025f2732cd1a965a7
Reviewed-by: Lars Knoll <lars.knoll@qt.io>

1 files changed, 233 insertions, 0 deletions

diff --git a/util/local_database/localexml.py b/util/local_database/localexml.py
new file mode 100644
index 0000000000..6db10e2b9a
--- /dev/null
+++ b/util/local_database/localexml.py
@@ -0,0 +1,233 @@
+#############################################################################
+##
+## Copyright (C) 2017 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the test suite of the Qt Toolkit.
+##
+## $QT_BEGIN_LICENSE:GPL-EXCEPT$
+## Commercial License Usage
+## Licensees holding valid commercial Qt licenses may use this file in
+## accordance with the commercial license agreement provided with the
+## Software or, alternatively, in accordance with the terms contained in
+## a written agreement between you and The Qt Company. For licensing terms
+## and conditions see https://www.qt.io/terms-conditions. For further
+## information use the contact form at https://www.qt.io/contact-us.
+##
+## GNU General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU
+## General Public License version 3 as published by the Free Software
+## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+## included in the packaging of this file. Please review the following
+## information to ensure the GNU General Public License requirements will
+## be met: https://www.gnu.org/licenses/gpl-3.0.html.
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+"""Shared serialization-scanning code for QLocaleXML format.
+
+The Locale class is written by cldr2qlocalexml.py and read by qlocalexml2cpp.py
+"""
+from xml.sax.saxutils import escape
+
+import xpathlite
+
+# Tools used by Locale:
+def camel(seq):
+    yield seq.next()
+    for word in seq:
+        yield word.capitalize()
+
+def camelCase(words):
+    return ''.join(camel(iter(words)))
+
+def ordStr(c):
+    if len(c) == 1:
+        return str(ord(c))
+    raise xpathlite.Error('Unable to handle value "%s"' % addEscapes(c))
+
+# Fix for a problem with QLocale returning a character instead of
+# strings for QLocale::exponential() and others. So we fallback to
+# default values in these cases.
+def fixOrdStr(c, d):
+    return str(ord(c if len(c) == 1 else d))
+
+def convertFormat(format):
+    result = ""
+    i = 0
+    while i < len(format):
+        if format[i] == "'":
+            result += "'"
+            i += 1
+            while i < len(format) and format[i] != "'":
+                result += format[i]
+                i += 1
+            if i < len(format):
+                result += "'"
+                i += 1
+        else:
+            s = format[i:]
+            if s.startswith("EEEE"):
+                result += "dddd"
+                i += 4
+            elif s.startswith("EEE"):
+                result += "ddd"
+                i += 3
+            elif s.startswith("a"):
+                result += "AP"
+                i += 1
+            elif s.startswith("z"):
+                result += "t"
+                i += 1
+            elif s.startswith("v"):
+                i += 1
+            else:
+                result += format[i]
+                i += 1
+
+    return result
+
+class Locale:
+    # Tool used during class body (see del below), not method:
+    def propsMonthDay(lengths=('long', 'short', 'narrow'), scale=('months', 'days')):
+        for L in lengths:
+            for S in scale:
+                yield camelCase((L, S))
+                yield camelCase(('standalone', L, S))
+
+    # Expected to be numbers, read with int():
+    __asint = ("decimal", "group", "zero",
+               "list", "percent", "minus", "plus", "exp",
+               "currencyDigits", "currencyRounding")
+    # Single character; use the code-point number for each:
+    __asord = ("quotationStart", "quotationEnd",
+               "alternateQuotationStart", "alternateQuotationEnd")
+    # Convert day-name to Qt day-of-week number:
+    __asdow = ("firstDayOfWeek", "weekendStart", "weekendEnd")
+    # Convert from CLDR format-strings to QDateTimeParser ones:
+    __asfmt = ("longDateFormat", "shortDateFormat", "longTimeFormat", "shortTimeFormat")
+    # Just use the raw text:
+    __astxt = ("language", "languageEndonym", "script", "country", "countryEndonym",
+               "listPatternPartStart", "listPatternPartMiddle",
+               "listPatternPartEnd", "listPatternPartTwo", "am", "pm",
+               "currencyIsoCode", "currencySymbol", "currencyDisplayName",
+               "currencyFormat", "currencyNegativeFormat"
+               ) + tuple(propsMonthDay())
+    del propsMonthDay
+
+    # Day-of-Week numbering used by Qt:
+    __qDoW = {"mon": 1, "tue": 2, "wed": 3, "thu": 4, "fri": 5, "sat": 6, "sun": 7}
+
+    @classmethod
+    def fromXmlData(cls, lookup):
+        """Constructor from the contents of XML elements.
+
+        Single parameter, lookup, is called with the names of XML
+        elements that should contain the relevant data, within a CLDR
+        locale element (within a localeList element); these names are
+        used for the attributes of the object constructed.  Attribute
+        values are obtained by suitably digesting the returned element
+        texts.\n"""
+        data = {}
+        for k in cls.__asint:
+            data['listDelim' if k == 'list' else k] = int(lookup(k))
+
+        for k in cls.__asord:
+            value = lookup(k)
+            assert len(value) == 1, \
+                (k, value, 'value should be exactly one character')
+            data[k] = ord(value)
+
+        for k in cls.__asdow:
+            data[k] = cls.__qDoW[lookup(k)]
+
+        for k in cls.__asfmt:
+            data[k] = convertFormat(lookup(k))
+
+        for k in cls.__astxt:
+            data[k] = lookup(k)
+
+        return cls(data)
+
+    def toXml(self, indent='        ', tab='    '):
+        print indent + '<locale>'
+        inner = indent + tab
+        get = lambda k: getattr(self, k)
+        for key in ('language', 'script', 'country'):
+            print inner + "<%s>" % key + get(key) + "</%s>" % key
+            print inner + "<%scode>" % key + get(key + '_code') + "</%scode>" % key
+
+        for key in ('decimal', 'group', 'zero'):
+            print inner + "<%s>" % key + ordStr(get(key)) + "</%s>" % key
+        for key, std in (('list', ';'), ('percent', '%'),
+                         ('minus', '-'), ('plus', '+'), ('exp', 'e')):
+            print inner + "<%s>" % key + fixOrdStr(get(key), std) + "</%s>" % key
+
+        for key in ('language_endonym', 'country_endonym',
+                    'quotationStart', 'quotationEnd',
+                    'alternateQuotationStart', 'alternateQuotationEnd',
+                    'listPatternPartStart', 'listPatternPartMiddle',
+                    'listPatternPartEnd', 'listPatternPartTwo',
+                    'am', 'pm', 'firstDayOfWeek',
+                    'weekendStart', 'weekendEnd',
+                    'longDateFormat', 'shortDateFormat',
+                    'longTimeFormat', 'shortTimeFormat',
+                    'standaloneLongMonths', 'standaloneShortMonths',
+                    'standaloneNarrowMonths',
+                    'longMonths', 'shortMonths', 'narrowMonths',
+                    'longDays', 'shortDays', 'narrowDays',
+                    'standaloneLongDays', 'standaloneShortDays', 'standaloneNarrowDays',
+                    'currencyIsoCode', 'currencySymbol', 'currencyDisplayName',
+                    'currencyFormat', 'currencyNegativeFormat'):
+            ent = camelCase(key.split('_')) if '_' in key else key
+            print inner + "<%s>%s</%s>" % (ent, escape(get(key)).encode('utf-8'), ent)
+
+        for key in ('currencyDigits', 'currencyRounding'):
+            print inner + "<%s>%d</%s>" % (key, get(key), key)
+
+        print indent + "</locale>"
+
+    def __init__(self, data=None, **kw):
+        if data: self.__dict__.update(data)
+        if kw: self.__dict__.update(kw)
+
+    @classmethod
+    def C(cls,
+          # Empty entries at end to ensure final separator when join()ed:
+          months = ('January', 'February', 'March', 'April', 'May', 'June', 'July',
+                    'August', 'September', 'October', 'November', 'December', ''),
+          days = ('Sunday', 'Monday', 'Tuesday', 'Wednesday',
+                  'Thursday', 'Friday', 'Saturday', '')):
+        """Returns an object representing the C locale."""
+        return cls(language='C', language_code='0', language_endonym='',
+                   script='AnyScript', script_code='0',
+                   country='AnyCountry', country_code='0', country_endonym='',
+                   decimal='.', group=',', list=';', percent='%',
+                   zero='0', minus='-', plus='+', exp='e',
+                   quotationStart='"', quotationEnd='"',
+                   alternateQuotationStart='\'', alternateQuotationEnd='\'',
+                   listPatternPartStart='%1, %2',
+                   listPatternPartMiddle='%1, %2',
+                   listPatternPartEnd='%1, %2',
+                   listPatternPartTwo='%1, %2',
+                   am='AM', pm='PM', firstDayOfWeek='mon',
+                   weekendStart='sat', weekendEnd='sun',
+                   longDateFormat='EEEE, d MMMM yyyy', shortDateFormat='d MMM yyyy',
+                   longTimeFormat='HH:mm:ss z', shortTimeFormat='HH:mm:ss',
+                   longMonths=';'.join(months),
+                   shortMonths=';'.join(m[:3] for m in months),
+                   narrowMonths='1;2;3;4;5;6;7;8;9;10;11;12;',
+                   standaloneLongMonths=';'.join(months),
+                   standaloneShortMonths=';'.join(m[:3] for m in months),
+                   standaloneNarrowMonths=';'.join(m[:1] for m in months),
+                   longDays=';'.join(days),
+                   shortDays=';'.join(d[:3] for d in days),
+                   narrowDays='7;1;2;3;4;5;6;',
+                   standaloneLongDays=';'.join(days),
+                   standaloneShortDays=';'.join(d[:3] for d in days),
+                   standaloneNarrowDays=';'.join(d[:1] for d in days),
+                   currencyIsoCode='', currencySymbol='',
+                   currencyDisplayName=';' * 7,
+                   currencyDigits=2, currencyRounding=1,
+                   currencyFormat='%1%2', currencyNegativeFormat='')