[Android] Add a gyp option to disable generating v14 resources script.

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 80 matching lines @@
               list(root_node.getElementsByTagName('style')))
 
 
 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):
       raise Exception('error: style file ' + input_filename +
                       ' should be under ' + input_dir +
-                      '-v17 directory. Please refer to crbug.com/243952 '
-                      'for the details.')
+                      '-v17 directory. Please refer to '
+                      'http://crbug.com/243952 for the details.')
 
 
-def GenerateV14LayoutResourceDom(dom, filename):
+def GenerateV14LayoutResourceDom(dom, filename_for_warning):

[newt (away), 2013/07/08 22:55:49]

it's OK to print both a warning and an error if a layout file is not V14
compatible and --verify-only is used... and that seems cleaner. I'd just always
print the warning in this method (i.e. revert the changes in this method, and
always pass the filename to this method)

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Looks like we have to skip warning for pre-v17 because it will contain
Left/Right attribute, and keep warning for v17. So I guess we still need a way
to disable the warning.

[newt (away), 2013/07/09 00:52:49]

Where is that call? I only see this method called in two places: lines 170 (with
a filename) and 215 (with None, though we could replace it with a 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.
+    filename_for_warning: file name to display in case we print warnings.
+                          If None, do not print warning.
   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)
+      elif filename_for_warning:
+        WarnIfDeprecatedAttribute(name, value, filename_for_warning)
 
   return is_modified
 
 
-def GenerateV14StyleResourceDom(dom, filename):
+def GenerateV14StyleResourceDom(dom, filename_for_warning):
   """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.
+    filename_for_warning: file name to display in case we print warnings.
+                          If None, do not print warning.
+  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]
-      else:
-        WarnIfDeprecatedAttribute(name, value, filename)
+        is_modified = True
+      elif filename_for_warning:
+        WarnIfDeprecatedAttribute(name, value, filename_for_warning)
 
+  return is_modified
 
 def GenerateV14LayoutResource(input_filename, output_v14_filename,
                               output_v17_filename):
   """Convert API 17 layout resource to API 14 compatible layout resource.
 
   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.
@@ skipping 34 matching lines @@
                               output_v17_filename)
 
 
 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 VerifyNoRtlAttributeInDir(input_dir):

[newt (away), 2013/07/08 22:55:49]

how about "VerifyV14StyleResourcesInDir"?

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Done.

+  for input_filename in build_utils.FindInDirectory(input_dir, '*.xml'):
+    dom = minidom.parse(input_filename)
+    if (GenerateV14LayoutResourceDom(dom, None) or

[newt (away), 2013/07/08 22:55:49]

it's a bit odd to run both of these methods on the dom. I'd split this into two
methods: "VerifyV14StyleResourcesInDir()" and "VerifyV14LayoutResourcesInDir()",
or just add an extra argument "verify_only" to GenerateV14StyleResourcesInDir
and related methods.

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Done.

+        GenerateV14StyleResourceDom(dom, None)):
+      raise Exception('error : ' + input_filename +
+                      ' has an RTL attribute, i.e., attribute that has "start"'
+                      'or "end" in its name. Pre-v17 resources should not '
+                      'include it because it can cause crashes on certain '
+                      'devices. Please refer to http://crbug.com/243952 '
+                      'for the details.')
 
 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')
   parser.add_option('--res-v14-compatibility-dir',
                     help='output directory into which '
                          'v14 compatible resources will be generated')
   parser.add_option('--stamp', help='File to touch on success')
+  parser.add_option('--only-verify', help='Do not generate v14 resources. '

[newt (away), 2013/07/08 22:55:49]

"Do not generate v14 resources. Instead, just verify that the resources are
already compatible with v14, i.e. they don't use attributes that cause crashes
on certain devices."

nit: "--verify-only" seems better (put the most important part first)

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Done.

+      'Only verify it and raise an error if the current resource can '
+      'cause crashes on certain devices.')

[newt (away), 2013/07/08 22:55:49]

use 'action="store_true"' here. then options.only_verify will be either True or
False, and you can remove line 255.

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Done.

 
   options, args = parser.parse_args()
 
   if args:
     parser.error('No positional arguments should be given.')
 
   # Check that required options have been provided.
   required_options = ('res_dir', 'res_v14_compatibility_dir')
   build_utils.CheckOptions(options, parser, required=required_options)
   return options
 
 
 def main(argv):
   options = ParseArgs()
+  only_verify = bool(options.only_verify) and int(options.only_verify) > 0

[newt (away), 2013/07/08 22:55:49]

remove this

[Kibeom Kim (inactive), 2013/07/09 00:20:50]

Done.

 
   build_utils.DeleteDirectory(options.res_v14_compatibility_dir)
   build_utils.MakeDirectory(options.res_v14_compatibility_dir)
 
   for name in os.listdir(options.res_dir):
     if not os.path.isdir(os.path.join(options.res_dir, name)):
       continue
 
     dir_pieces = name.split('-')
     resource_type = dir_pieces[0]
     qualifiers = dir_pieces[1:]
 
     api_level_qualifier_index = -1
     api_level_qualifier = ''
     for index, qualifier in enumerate(qualifiers):
       if re.match('v[0-9]+$', qualifier):
         api_level_qualifier_index = index
         api_level_qualifier = qualifier
         break
 
     # Android pre-v17 API doesn't support RTL. Skip.
     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')
+    input_dir = os.path.abspath(os.path.join(options.res_dir, name))
 
-    # We only convert layout resources under layout*/, xml*/,
-    # and style resources under values*/.
-    if resource_type in ('layout', 'xml'):
-      if not api_level_qualifier:
-        GenerateV14LayoutResourcesInDir(input_dir, output_v14_dir,
-                                        output_v17_dir)
-    elif resource_type == 'values':
-      if api_level_qualifier == 'v17':
-        output_qualifiers = qualifiers[:]
-        del output_qualifiers[api_level_qualifier_index]
-        output_v14_dir = os.path.join(options.res_v14_compatibility_dir,
-                                      '-'.join([resource_type] +
-                                               output_qualifiers))
-        GenerateV14StyleResourcesInDir(input_dir, output_v14_dir)
-      elif not api_level_qualifier:
-        ErrorIfStyleResourceExistsInDir(input_dir)
+    if only_verify:
+      if not api_level_qualifier or int(api_level_qualifier[1:]) < 17:
+        if resource_type in ('layout', 'xml', 'values'):
+          VerifyNoRtlAttributeInDir(input_dir)
+    else:
+      # We also need to copy the original v17 resource to *-v17 directory
+      # because the generated v14 resource will hide the original resource.
+      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 layout resources under layout*/, xml*/,
+      # and style resources under values*/.
+      if resource_type in ('layout', 'xml'):
+        if not api_level_qualifier:
+          GenerateV14LayoutResourcesInDir(input_dir, output_v14_dir,
+                                          output_v17_dir)
+      elif resource_type == 'values':
+        if api_level_qualifier == 'v17':
+          output_qualifiers = qualifiers[:]
+          del output_qualifiers[api_level_qualifier_index]
+          output_v14_dir = os.path.join(options.res_v14_compatibility_dir,
+                                        '-'.join([resource_type] +
+                                                 output_qualifiers))
+          GenerateV14StyleResourcesInDir(input_dir, output_v14_dir)
+        elif not api_level_qualifier:
+          ErrorIfStyleResourceExistsInDir(input_dir)
 
   if options.stamp:
     build_utils.Touch(options.stamp)
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))