Compile plural strings to android <plurals> elem

grit/format/android_xml.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Produces localized strings.xml files for Android.
 
 In cases where an "android" type output file is requested in a grd, the classes
 in android_xml will process the messages and translations to produce a valid
 strings.xml that is properly localized with the specified language.
@@ skipping 40 matching lines @@
   <message name="IDS_FOO_DEFAULT" formatter_data="android_java_product=default
       android_java_name=foo">has card</message>
 
 would generate
 
   <string name="foo" product="nosdcard">"no card"</string>
   <string name="foo" product="default">"has card"</string>
 """
 
 import os
+import re
 import types
 import xml.sax.saxutils
 
 from grit import lazy_re
 from grit.node import message
 
 
 # When this environmental variable has value "true", only tagged messages will
 # be outputted.
 _TAGGED_ONLY_ENV_VAR = 'ANDROID_JAVA_TAGGED_ONLY'
@@ skipping 18 matching lines @@
 
 
 # In most cases we only need a name attribute and string value.
 _SIMPLE_TEMPLATE = u'<string name="%s">%s</string>\n'
 
 
 # In a few cases a product attribute is needed.
 _PRODUCT_TEMPLATE = u'<string name="%s" product="%s">%s</string>\n'
 
 
+# Some strings have a plural equivalent
+_PLURALS_TEMPLATE = '<plurals name="%s">\n%s</plurals>\n'
+_PLURALS_ITEM_TEMPLATE = ' <item quantity="%s">%s</item>\n'
+_PLURALS_PATTERN = lazy_re.compile(r'\{[A-Z_]+,\s*plural,(?P<items>.*)\}$', flags=re.S)
+_PLURALS_ITEM_PATTERN = lazy_re.compile(r'(?P<quantity>\S+)\s*\{(?P<value>.*?)\}')
+
+
 def Format(root, lang='en', output_dir='.'):
   yield ('<?xml version="1.0" encoding="utf-8"?>\n'
           '<resources '
           'xmlns:android="http://schemas.android.com/apk/res/android">\n')
 
   tagged_only = _TAGGED_ONLY_DEFAULT
   if _TAGGED_ONLY_ENV_VAR in os.environ:
     tagged_only = os.environ[_TAGGED_ONLY_ENV_VAR].lower()
     if tagged_only == 'true':
       tagged_only = True
@@ skipping 15 matching lines @@
   """Returns true if node should be outputted.
 
   Args:
       node: a Node from the grd dom
       tagged_only: true, if only tagged messages should be outputted
   """
   return (isinstance(node, message.MessageNode) and
           (not tagged_only or _EMIT_TAG in node.formatter_data))
 
 
+def _FormatPluralMessage(message):
+  """Compile ICU plural syntax to the body of an Android <plurals> element.

[newt (away), 2015/08/04 03:14:26]

nit: "Compiles"

[conleyo, 2015/08/04 16:53:02]

Done.

+    
+  1. In a .grd file, we can write a plural string like this:
+    
+    <message name="IDS_THINGS">
+      {NUM_THINGS, plural,
+      =1 {1 thing}
+      other {# things}}
+    </message>
+    
+  2. The Android equivalent looks like this:
+    
+    <plurals name="things">
+      <item quantity="one">1 thing</item>
+      <item quantity="other">%d things</item>
+    </plurals>
+
+  This method takes the body of (1) and converts it to the body of (2).
+    
+  If the message is *not* a plural string, this function returns `None`.
+  If the message includes quantities without an equivalent format in Android,
+  it raises an exception.
+  """
+  ret = {}
+  plural_match = _PLURALS_PATTERN.match(message)
+  if not plural_match:
+    return None
+  body_in = plural_match.group('items').strip()
+  body_out = u''

[newt (away), 2015/08/04 03:14:26]

A better idiom for concatenating strings in python (to avoid quadratic
behavior):

   out_lines = ''
   ...
     out_lines.append(...)

   return '\n'.join(out_lines)

[conleyo, 2015/08/04 16:53:02]

Done.

+  for item_match in _PLURALS_ITEM_PATTERN.finditer(body_in):
+    quantity = item_match.group('quantity')
+    value = item_match.group('value').replace('#', '%d')
+    if quantity == '=0':
+      body_out += _PLURALS_ITEM_TEMPLATE % ('zero', value)
+    elif quantity == '=1':
+      body_out += _PLURALS_ITEM_TEMPLATE % ('one', value)
+    elif quantity == 'other':
+      body_out += _PLURALS_ITEM_TEMPLATE % ('other', value)
+    else:

[newt (away), 2015/08/04 03:14:26]

Why not handle "=2", "few" and "many"?

[conleyo, 2015/08/04 16:53:02]

Done.

+      raise Exception('Unsupported plural quantity for android '
+                      'strings.xml: %s' % quantity)
+  return body_out
+
+
 def _FormatMessage(item, lang):
   """Writes out a single string as a <resource/> element."""
 
   value = item.ws_at_start + item.Translate(lang) + item.ws_at_end
   # Replace < > & with &lt; &gt; &amp; to ensure we generate valid XML and
   # replace ' " with \' \" to conform to Android's string formatting rules.
   value = xml.sax.saxutils.escape(value, {"'": "\\'", '"': '\\"'})
+  plurals = _FormatPluralMessage(value)
   # Wrap the string in double quotes to preserve whitespace.
   value = '"' + value + '"'
 
   mangled_name = item.GetTextualIds()[0]
   match = _NAME_PATTERN.match(mangled_name)
   if not match:
     raise Exception('Unexpected resource name: %s' % mangled_name)
   name = match.group('name').lower()
   product = match.group('product')
 
   # Override product or name with values in formatter_data, if any.
   product = item.formatter_data.get(_PRODUCT_TAG, product)
   name = item.formatter_data.get(_NAME_TAG, name)
 
-  if product:
+  if plurals:
+    return _PLURALS_TEMPLATE % (name, plurals)
+  elif product:
     return _PRODUCT_TEMPLATE % (name, product, value)
   else:
     return _SIMPLE_TEMPLATE % (name, value)