[Android] Generate v14 style resource from values-v17/ not values/.

build/android/gyp/generate_v14_compatible_resources.py

 #!/usr/bin/env python
 #
 # Copyright 2013 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.
 
 """Convert Android xml resources to API 14 compatible.
 
 There are two reasons that we cannot just use API 17 attributes,
 so we are generating another set of resources by this script.
@@ skipping 58 matching lines @@
   if name in ATTRIBUTES_TO_MAP_REVERSED:
     print >> sys.stderr, ('warning: ' + filename + ' should use ' +
                           ATTRIBUTES_TO_MAP_REVERSED[name] +
                           ' instead of ' + name)
   elif name in GRAVITY_ATTRIBUTES and ('left' in value or 'right' in value):
     print >> sys.stderr, ('warning: ' + filename +
                           ' should use start/end instead of left/right for ' +
                           name)
 
 
-def GenerateV14LayoutResource(dom, filename):
+def HasStyleResource(dom):
+  """Return True if the dom is a style resource, False otherwise."""
+  root_node = IterateXmlElements(dom).next()
+  if root_node.nodeName == 'resources':
+    for style_element in dom.getElementsByTagName('style'):

[newt (away), 2013/05/28 21:08:13]

make this:

    if list(root_node.getElementsByTagName('style')):
      return True

or even

    return bool(root_node.nodeName == 'resources' and
list(root_node.getElementsByTagName('style')))

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

+      return True
+  return False
+
+
+def ErrorIfStyleResourceExistsInDir(input_dir):
+  """If a style resource is in input_dir, exist with an error message."""
+  for input_filename in build_utils.FindInDirectory(input_dir, '*.xml'):
+    dom = minidom.parse(input_filename)
+    if HasStyleResource(dom):
+      sys.exit('error: style file ' + input_filename + ' should be under ' +

[newt (away), 2013/05/28 21:08:13]

I'd raise an exception here, instead of exiting directly.

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

+               input_dir + '-v17 directory. Please refer to crbug.com/243952 '
+               'for the details.')
+
+
+def GenerateV14LayoutResourceDom(dom, filename):
   """Convert layout resource to API 14 compatible layout resource.
 
   Args:
     dom: parsed minidom object to be modified.
     filename: file name to display in case we print warnings.
   Returns:
     True if dom is modified, False otherwise.
   """
   is_modified = False
 
   # Iterate all the elements' attributes to find attributes to convert.
   for element in IterateXmlElements(dom):
     for name, value in list(element.attributes.items()):
       # Convert any API 17 Start/End attributes to Left/Right attributes.
       # For example, from paddingStart="10dp" to paddingLeft="10dp"
       # Note: gravity attributes are not necessary to convert because
       # start/end values are backward-compatible. Explained at
       # https://plus.sandbox.google.com/+RomanNurik/posts/huuJd8iVVXY?e=Showroom
       if name in ATTRIBUTES_TO_MAP:
         element.setAttribute(ATTRIBUTES_TO_MAP[name], value)
         del element.attributes[name]
         is_modified = True
       else:
         WarnIfDeprecatedAttribute(name, value, filename)
 
   return is_modified
 
 
-def GenerateV14StyleResource(dom, filename):
+def GenerateV14StyleResourceDom(dom, filename):
   """Convert style resource to API 14 compatible style resource.
 
   Args:
     dom: parsed minidom object to be modified.
     filename: file name to display in case we print warnings.
-  Returns:
-    True if dom is modified, False otherwise.
   """
-  is_modified = False
-
   for style_element in dom.getElementsByTagName('style'):
     for item_element in style_element.getElementsByTagName('item'):
       name = item_element.attributes['name'].value
       value = item_element.childNodes[0].nodeValue
       if name in ATTRIBUTES_TO_MAP:
         item_element.attributes['name'].value = ATTRIBUTES_TO_MAP[name]
-        is_modified = True
       else:
         WarnIfDeprecatedAttribute(name, value, filename)
 
-  return is_modified
 
-
-def GenerateV14Resource(input_filename,
+def GenerateV14LayoutResource(input_filename,
                         output_v14_filename,

[newt (away), 2013/05/28 21:08:13]

align these parameters

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

                         output_v17_filename):
   """Convert layout/style resource to API 14 compatible layout/style resource.

[newt (away), 2013/05/28 21:08:13]

"layout/style" -> "layout"

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

 
   It's mostly a simple replacement, s/Start/Left s/End/Right,
   on the attribute names.
   If the generated resource is identical to the original resource,
   don't do anything. If not, write the generated resource to
   output_v14_filename, and copy the original resource to output_v17_filename.
   """
   dom = minidom.parse(input_filename)
-
-  root_node = IterateXmlElements(dom).next()
-  if root_node.nodeName == 'resources':
-    # Style resources are under 'values*/' directory.
-    is_modified = GenerateV14StyleResource(dom, input_filename)
-  else:
-    # Layout resources can be under 'layout*/' or 'xml*/' directory.
-    is_modified = GenerateV14LayoutResource(dom, input_filename)
+  is_modified = GenerateV14LayoutResourceDom(dom, input_filename)
 
   if is_modified:
     # Write the generated resource.
     build_utils.MakeDirectory(os.path.dirname(output_v14_filename))
     with open(output_v14_filename, 'w') as f:
       dom.writexml(f, '', '  ', '\n', encoding='utf-8')
 
     # Copy the original resource.
     build_utils.MakeDirectory(os.path.dirname(output_v17_filename))
     shutil.copy2(input_filename, output_v17_filename)
 
 
-def GenerateV14XmlResourcesInDir(input_dir, output_v14_dir, output_v17_dir):
-  """Convert resources to API 14 compatible XML resources in the directory."""
+def GenerateV14StyleResource(input_filename, output_v14_filename):
+  """Convert layout/style resource to API 14 compatible layout/style resource.

[newt (away), 2013/05/28 21:08:13]

"Convert API 17 style resources to API 14 compatible style resources."

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

+
+  Write the generated style resource to output_v14_filename.
+  It's mostly a simple replacement, s/Start/Left s/End/Right,
+  on the attribute names.
+  """
+  dom = minidom.parse(input_filename)
+  GenerateV14StyleResourceDom(dom, input_filename)
+
+  # Write the generated resource.

[newt (away), 2013/05/28 21:08:13]

I'd pull out lines 179-182 into a separate function, and call it here and in
GenerateV14LayoutResource

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

+  build_utils.MakeDirectory(os.path.dirname(output_v14_filename))
+  with open(output_v14_filename, 'w') as f:
+    dom.writexml(f, '', '  ', '\n', encoding='utf-8')
+
+
+def GenerateV14LayoutResourcesInDir(input_dir, output_v14_dir, output_v17_dir):
+  """Convert layout resources to API 14 compatible resources in input_dir."""
   for input_filename in build_utils.FindInDirectory(input_dir, '*.xml'):
     rel_filename = os.path.relpath(input_filename, input_dir)
     output_v14_filename = os.path.join(output_v14_dir, rel_filename)
     output_v17_filename = os.path.join(output_v17_dir, rel_filename)
-    GenerateV14Resource(input_filename, output_v14_filename,
+    GenerateV14LayoutResource(input_filename, output_v14_filename,
                         output_v17_filename)

[newt (away), 2013/05/28 21:08:13]

align this argument

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

Done.

 
 
+def GenerateV14StyleResourcesInDir(input_dir, output_v14_dir):
+  """Convert style resources to API 14 compatible resources in input_dir."""
+  for input_filename in build_utils.FindInDirectory(input_dir, '*.xml'):
+    rel_filename = os.path.relpath(input_filename, input_dir)
+    output_v14_filename = os.path.join(output_v14_dir, rel_filename)
+    GenerateV14StyleResource(input_filename, output_v14_filename)
+
+
 def ParseArgs():
   """Parses command line options.
 
   Returns:
     An options object as from optparse.OptionsParser.parse_args()
   """
   parser = optparse.OptionParser()
   parser.add_option('--res-dir',
                     help='directory containing resources '
                          'used to generate v14 compatible resources')
@@ skipping 31 matching lines @@
     if 'ldrtl' in qualifiers:
       continue
 
     # We also need to copy the original v17 resource to *-v17 directory
     # because the generated v14 resource will hide the original resource.
     input_dir = os.path.join(options.res_dir, name)
     output_v14_dir = os.path.join(options.res_v14_compatibility_dir, name)
     output_v17_dir = os.path.join(options.res_v14_compatibility_dir, name +
                                                                      '-v17')
 
-    # We only convert resources under layout*/, xml*/,
+    # We only convert layout resources under layout*/, xml*/,
     # and style resources under values*/.
     # TODO(kkimlabs): don't process xml directly once all layouts have
     # been moved out of XML directory. see http://crbug.com/238458
-    if resource_type in ('layout', 'xml', 'values'):
-      GenerateV14XmlResourcesInDir(input_dir, output_v14_dir, output_v17_dir)
+    if resource_type in ('layout', 'xml'):
+      GenerateV14LayoutResourcesInDir(input_dir, output_v14_dir, output_v17_dir)
+    elif resource_type == 'values':
+      if len(qualifiers) > 0 and qualifiers[-1] == 'v17':

[newt (away), 2013/05/28 21:08:13]

if 'v17' in qualifiers: ...

also, I wouldn't depend on v17 being the final qualifier below. Maybe:

    v17_index = qualifiers.index('v17')
    del qualifiers[v17_index]
    output_v14_dir = os.path.join(options.res_v14_compatibility_dir,
'-'.join([resource_type] + qualifiers))

[Kibeom Kim (inactive), 2013/05/28 23:15:32]

I assumed v17 be the final because the versioning is the final qualifier, but
yes, I agree that not relying on that because Android can add another qualifier
group after the versioning.

Done.

On 2013/05/28 21:08:13, newt wrote:

+        output_v14_dir = os.path.join(options.res_v14_compatibility_dir,
+                                      '-'.join([resource_type] +
+                                               qualifiers[:-1]))
+        GenerateV14StyleResourcesInDir(input_dir, output_v14_dir)
+      else:
+        # TODO(kkimlabs): uncomment the below line and remove 'pass' once the
+        # downstream fix (https://gerrit-int.chromium.org/#/c/38786/) is landed.
+        # ErrorIfStyleResourceExistsInDir(input_dir)
+        pass
 
   if options.stamp:
     build_utils.Touch(options.stamp)
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))