Get localized strings in the render process

Building on top of the repacking of .pak files, we now ship
the whole array of repacked locales and pick the appropriate one at runtime.

Change-Id: I0096e3eac6a1fc83885fd11e0fa55a746f8e45d8
Reviewed-by: Andras Becsi <andras.becsi@digia.com>

3 files changed, 271 insertions, 12 deletions

diff --git a/tools/buildscripts/gyp_qtwebengine b/tools/buildscripts/gyp_qtwebengine
index b7dd5ea12..cf4e2f683 100755
--- a/tools/buildscripts/gyp_qtwebengine
+++ b/tools/buildscripts/gyp_qtwebengine
@@ -2,19 +2,13 @@
 
 import glob
 import os
-import subprocess
 import sys
 
 print 'using python: ' + sys.executable + ' version: ' + sys.version
 
 qtwebengine_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
-qtwebengine_src = os.path.join(qtwebengine_root, 'src')
-chrome_src = subprocess.check_output("git config qtwebengine.chromiumsrcdir || true", shell=True).strip()
-if chrome_src:
-  chrome_src = os.path.join(qtwebengine_root, chrome_src)
-if not chrome_src or not os.path.isdir(chrome_src):
-  chrome_src = os.path.join(qtwebengine_root, 'src/3rdparty/chromium')
-  print 'CHROMIUM_SRC_DIR not set, falling back to ' + chrome_src
+import qtwebengine_utils as utils
+chrome_src = utils.getChromiumSrcDir()
 
 script_dir = os.path.abspath(os.path.join(chrome_src, 'build'))
 if not os.path.isdir(script_dir):
@@ -38,10 +32,6 @@ sys.path.insert(1, os.path.join(chrome_src, 'third_party', 'WebKit',
 sys.path.insert(1, os.path.join(chrome_src, 'third_party', 'WebKit',
     'Source', 'core', 'scripts'))
 
-sys.path.insert(1, os.path.join(chrome_src, 'chrome', 'tools', 'build'))
-
-import repack_locales
-
 def additional_include_files(args=[]):
   """
   Returns a list of additional (.gypi) files to include, without
diff --git a/tools/buildscripts/qtwebengine_utils.py b/tools/buildscripts/qtwebengine_utils.py
new file mode 100755
index 000000000..75ee076f9
--- /dev/null
+++ b/tools/buildscripts/qtwebengine_utils.py
@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+
+#############################################################################
+#
+# Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+# Contact: http://www.qt-project.org/legal
+#
+# This file is part of the QtWebEngine module of the Qt Toolkit.
+#
+# $QT_BEGIN_LICENSE:LGPL$
+# 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 Digia.  For licensing terms and
+# conditions see http://qt.digia.com/licensing.  For further information
+# use the contact form at http://qt.digia.com/contact-us.
+#
+# GNU Lesser General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU Lesser
+# General Public License version 2.1 as published by the Free Software
+# Foundation and appearing in the file LICENSE.LGPL included in the
+# packaging of this file.  Please review the following information to
+# ensure the GNU Lesser General Public License version 2.1 requirements
+# will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+#
+# In addition, as a special exception, Digia gives you certain additional
+# rights.  These rights are described in the Digia Qt LGPL Exception
+# version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+#
+# GNU General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU
+# General Public License version 3.0 as published by the Free Software
+# Foundation and appearing in the file LICENSE.GPL included in the
+# packaging of this file.  Please review the following information to
+# ensure the GNU General Public License version 3.0 requirements will be
+# met: http://www.gnu.org/copyleft/gpl.html.
+#
+#
+# $QT_END_LICENSE$
+#
+#############################################################################
+
+import os
+import subprocess
+import sys
+
+def getChromiumSrcDir():
+
+  qtwebengine_root = os.path.abspath(os.path.join(os.path.dirname(__file__), "../.."))
+
+  chrome_src = subprocess.check_output("git config qtwebengine.chromiumsrcdir || true", shell=True).strip()
+  if chrome_src:
+    chrome_src = os.path.join(qtwebengine_root, chrome_src)
+  if not chrome_src or not os.path.isdir(chrome_src):
+    chrome_src = os.path.join(qtwebengine_root, 'src/3rdparty/chromium')
+    print 'CHROMIUM_SRC_DIR not set, falling back to ' + chrome_src
+  return chrome_src
+
diff --git a/tools/buildscripts/repack_locales.py b/tools/buildscripts/repack_locales.py
new file mode 100755
index 000000000..51edb546c
--- /dev/null
+++ b/tools/buildscripts/repack_locales.py
@@ -0,0 +1,210 @@
+#!/usr/bin/env python
+#############################################################################
+#
+# Copyright (c) 2012 The Chromium Authors. All rights reserved.
+# Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+# Contact: http://www.qt-project.org/legal
+#
+# This file is part of the QtWebEngine module of the Qt Toolkit.
+#
+# $QT_BEGIN_LICENSE:LGPL$
+# 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 Digia.  For licensing terms and
+# conditions see http://qt.digia.com/licensing.  For further information
+# use the contact form at http://qt.digia.com/contact-us.
+#
+# GNU Lesser General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU Lesser
+# General Public License version 2.1 as published by the Free Software
+# Foundation and appearing in the file LICENSE.LGPL included in the
+# packaging of this file.  Please review the following information to
+# ensure the GNU Lesser General Public License version 2.1 requirements
+# will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+#
+# In addition, as a special exception, Digia gives you certain additional
+# rights.  These rights are described in the Digia Qt LGPL Exception
+# version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+#
+# GNU General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU
+# General Public License version 3.0 as published by the Free Software
+# Foundation and appearing in the file LICENSE.GPL included in the
+# packaging of this file.  Please review the following information to
+# ensure the GNU General Public License version 3.0 requirements will be
+# met: http://www.gnu.org/copyleft/gpl.html.
+#
+#
+# $QT_END_LICENSE$
+#
+#############################################################################
+
+# This is esentially a trimmed down version of chrome's repack_locales script
+"""Helper script to repack paks for a list of locales.
+
+Gyp doesn't have any built-in looping capability, so this just provides a way to
+loop over a list of locales when repacking pak files, thus avoiding a
+proliferation of mostly duplicate, cut-n-paste gyp actions.
+"""
+
+import optparse
+import os
+import sys
+import qtwebengine_utils as utils
+
+chrome_src = utils.getChromiumSrcDir()
+
+sys.path.append(os.path.join(chrome_src, 'tools', 'grit'))
+from grit.format import data_pack
+
+# Some build paths defined by gyp.
+SHARE_INT_DIR = None
+INT_DIR = None
+
+# The target platform. If it is not defined, sys.platform will be used.
+OS = None
+
+# Extra input files.
+EXTRA_INPUT_FILES = []
+
+class Usage(Exception):
+  def __init__(self, msg):
+    self.msg = msg
+
+
+def calc_output(locale):
+  """Determine the file that will be generated for the given locale."""
+  #e.g. '<(INTERMEDIATE_DIR)/repack/qtwebengine_locales/da.pak',
+  if OS == 'mac' or OS == 'ios':
+    # For Cocoa to find the locale at runtime, it needs to use '_' instead
+    # of '-' (http://crbug.com/20441).  Also, 'en-US' should be represented
+    # simply as 'en' (http://crbug.com/19165, http://crbug.com/25578).
+    if locale == 'en-US':
+      locale = 'en'
+    return '%s/repack/qtwebengine_locales/%s.lproj/locale.pak' % (INT_DIR, locale.replace('-', '_'))
+  else:
+    return os.path.join(INT_DIR, 'repack/qtwebengine_locales', locale + '.pak')
+
+
+def calc_inputs(locale):
+  """Determine the files that need processing for the given locale."""
+  inputs = []
+
+  if OS != 'ios':
+    #e.g. '<(SHARED_INTERMEDIATE_DIR)/webkit/webkit_strings_da.pak'
+    inputs.append(os.path.join(SHARE_INT_DIR, 'webkit',
+                  'webkit_strings_%s.pak' % locale))
+
+    #e.g. '<(SHARED_INTERMEDIATE_DIR)/ui/ui_strings_da.pak',
+    inputs.append(os.path.join(SHARE_INT_DIR, 'ui', 'ui_strings',
+                  'ui_strings_%s.pak' % locale))
+
+    #e.g. '<(SHARED_INTERMEDIATE_DIR)/ui/app_locale_settings_da.pak',
+    inputs.append(os.path.join(SHARE_INT_DIR, 'ui', 'app_locale_settings',
+                  'app_locale_settings_%s.pak' % locale))
+
+  # Add any extra input files.
+  for extra_file in EXTRA_INPUT_FILES:
+    inputs.append('%s_%s.pak' % (extra_file, locale))
+
+  return inputs
+
+
+def list_outputs(locales):
+  """Returns the names of files that will be generated for the given locales.
+
+  This is to provide gyp the list of output files, so build targets can
+  properly track what needs to be built.
+  """
+  outputs = []
+  for locale in locales:
+    outputs.append(calc_output(locale))
+  # Quote each element so filename spaces don't mess up gyp's attempt to parse
+  # it into a list.
+  return " ".join(['"%s"' % x for x in outputs])
+
+
+def list_inputs(locales):
+  """Returns the names of files that will be processed for the given locales.
+
+  This is to provide gyp the list of input files, so build targets can properly
+  track their prerequisites.
+  """
+  inputs = []
+  for locale in locales:
+    inputs += calc_inputs(locale)
+  # Quote each element so filename spaces don't mess up gyp's attempt to parse
+  # it into a list.
+  return " ".join(['"%s"' % x for x in inputs])
+
+
+def repack_locales(locales):
+  """ Loop over and repack the given locales."""
+  for locale in locales:
+    inputs = []
+    inputs += calc_inputs(locale)
+    output = calc_output(locale)
+    data_pack.DataPack.RePack(output, inputs)
+
+
+def DoMain(argv):
+  global SHARE_INT_DIR
+  global INT_DIR
+  global OS
+  global EXTRA_INPUT_FILES
+
+  parser = optparse.OptionParser("usage: %prog [options] locales")
+  parser.add_option("-i", action="store_true", dest="inputs", default=False,
+                    help="Print the expected input file list, then exit.")
+  parser.add_option("-o", action="store_true", dest="outputs", default=False,
+                    help="Print the expected output file list, then exit.")
+  parser.add_option("-x", action="store", dest="int_dir",
+                    help="Intermediate build files output directory.")
+  parser.add_option("-s", action="store", dest="share_int_dir",
+                    help="Shared intermediate build files output directory.")
+  parser.add_option("-e", action="append", dest="extra_input", default=[],
+                    help="Full path to an extra input pak file without the\
+                         locale suffix and \".pak\" extension.")
+  parser.add_option("-p", action="store", dest="os",
+                    help="The target OS. (e.g. mac, linux, win, etc.)")
+  options, locales = parser.parse_args(argv)
+
+  if not locales:
+    parser.error('Please specificy at least one locale to process.\n')
+
+  print_inputs = options.inputs
+  print_outputs = options.outputs
+  INT_DIR = options.int_dir
+  SHARE_INT_DIR = options.share_int_dir
+  EXTRA_INPUT_FILES = options.extra_input
+  OS = options.os
+
+  if not OS:
+    if sys.platform == 'darwin':
+      OS = 'mac'
+    elif sys.platform.startswith('linux'):
+      OS = 'linux'
+    elif sys.platform in ('cygwin', 'win32'):
+      OS = 'win'
+    else:
+      OS = sys.platform
+
+  if not (INT_DIR and SHARE_INT_DIR):
+    parser.error('Please specify all of "-x" and "-s".\n')
+  if print_inputs and print_outputs:
+    parser.error('Please specify only one of "-i" or "-o".\n')
+
+  if print_inputs:
+    return list_inputs(locales)
+
+  if print_outputs:
+    return list_outputs(locales)
+
+  return repack_locales(locales)
+
+if __name__ == '__main__':
+  results = DoMain(sys.argv[1:])
+  if results:
+    print results