Allow move_source_file.py and sort-headers.py to work on blink.

tools/sort-headers.py

Index: tools/sort-headers.py
diff --git a/tools/sort-headers.py b/tools/sort-headers.py
index 5e8fc2641f261e502fcb30c64ed80ecc9a4944c9..bf296058b4cb6fcc927cff42b47164747d39a178 100755
--- a/tools/sort-headers.py
+++ b/tools/sort-headers.py
@@ -16,7 +16,13 @@ import sys
 from yes_no import YesNo
 
 
-def IncludeCompareKey(line):
+def IsInclude(line):
+  """Returns True if the line is an #include/#import/import line."""
+  return any([line.startswith('#include '), line.startswith('#import '),
+              line.startswith('import ')])
+
+
+def IncludeCompareKey(line, for_blink):
   """Sorting comparator key used for comparing two #include lines.
   Returns the filename without the #include/#import/import prefix.
   """
@@ -25,6 +31,15 @@ def IncludeCompareKey(line):
       line = line[len(prefix):]
       break
 
+  if for_blink:
+    # Blink likes to have its "config.h" include first.
+    if line.startswith('"config.h"'):
+      return '0'
+
+    # Blink sorts system headers after others. This is handled by sorting
+    # alphabetically so no need to do anything tricky.
+    return '1' + line
+
   # The win32 api has all sorts of implicit include order dependencies :-/
   # Give a few headers special sort keys that make sure they appear before all
   # other headers.
@@ -47,13 +62,10 @@ def IncludeCompareKey(line):
   return '4' + line
 
 
-def IsInclude(line):
-  """Returns True if the line is an #include/#import/import line."""
-  return any([line.startswith('#include '), line.startswith('#import '),
-              line.startswith('import ')])
-
+def SortHeader(infile, outfile, for_blink):
+  def CompareKey(line):
+    return IncludeCompareKey(line, for_blink)
 
-def SortHeader(infile, outfile):
   """Sorts the headers in infile, writing the sorted file to outfile."""

[Matt Giuca, 2015/07/13 06:25:46]

Docstring should go before the nested functions (which are technically
statements of this function).

[benwells, 2015/07/13 06:32:13]

Done.

   for line in infile:
     if IsInclude(line):
@@ -67,7 +79,7 @@ def SortHeader(infile, outfile):
         except StopIteration:
           infile_ended_on_include_line = True
           break
-      for header in sorted(headerblock, key=IncludeCompareKey):
+      for header in sorted(headerblock, key=CompareKey):
         outfile.write(header)
       if infile_ended_on_include_line:
         # We already wrote the last line above; exit to ensure it isn't written
@@ -79,7 +91,7 @@ def SortHeader(infile, outfile):
 
 
 def FixFileWithConfirmFunction(filename, confirm_function,
-                               perform_safety_checks):
+                               perform_safety_checks, for_blink=False):
   """Creates a fixed version of the file, invokes |confirm_function|
   to decide whether to use the new file, and cleans up.
 
@@ -99,7 +111,7 @@ def FixFileWithConfirmFunction(filename, confirm_function,
   fixfilename = filename + '.new'
   infile = open(filename, 'rb')
   outfile = open(fixfilename, 'wb')
-  SortHeader(infile, outfile)
+  SortHeader(infile, outfile, for_blink)
   infile.close()
   outfile.close()  # Important so the below diff gets the updated contents.
 
@@ -116,7 +128,7 @@ def FixFileWithConfirmFunction(filename, confirm_function,
       pass
 
 
-def DiffAndConfirm(filename, should_confirm, perform_safety_checks):
+def DiffAndConfirm(filename, should_confirm, perform_safety_checks, for_blink):
   """Shows a diff of what the tool would change the file named
   filename to.  Shows a confirmation prompt if should_confirm is true.
   Saves the resulting file if should_confirm is false or the user
@@ -132,7 +144,8 @@ def DiffAndConfirm(filename, should_confirm, perform_safety_checks):
 
     return (not should_confirm or YesNo('Use new file (y/N)?'))
 
-  FixFileWithConfirmFunction(filename, ConfirmFunction, perform_safety_checks)
+  FixFileWithConfirmFunction(filename, ConfirmFunction, perform_safety_checks,
+                             for_blink)
 
 def IsUnsafeToReorderHeaders(filename):
   # *_message_generator.cc is almost certainly a file that generates IPC
@@ -153,6 +166,9 @@ def main():
                     help='Do not perform the safety checks via which this '
                     'script refuses to operate on files for which it thinks '
                     'the include ordering is semantically significant.')
+  parser.add_option('--for_blink', action='store_true', default=False,
+                    dest='for_blink', help='Whether the blink header sorting '
+                    'rules should be applied.')
   opts, filenames = parser.parse_args()
 
   if len(filenames) < 1:
@@ -160,7 +176,8 @@ def main():
     return 1
 
   for filename in filenames:
-    DiffAndConfirm(filename, opts.should_confirm, opts.perform_safety_checks)
+    DiffAndConfirm(filename, opts.should_confirm, opts.perform_safety_checks,
+                   opts.for_blink)
 
 
 if __name__ == '__main__':