| Index: third_party/chrome/tools/sort-headers.py
|
| diff --git a/third_party/chrome/tools/sort-headers.py b/third_party/chrome/tools/sort-headers.py
|
| new file mode 100755
|
| index 0000000000000000000000000000000000000000..501f92cbd34ca1b22e3d6289f1451d6607cca901
|
| --- /dev/null
|
| +++ b/third_party/chrome/tools/sort-headers.py
|
| @@ -0,0 +1,143 @@
|
| +#!/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.
|
| +
|
| +"""Given a filename as an argument, sort the #include/#imports in that file.
|
| +
|
| +Shows a diff and prompts for confirmation before doing the deed.
|
| +Works great with tools/git/for-all-touched-files.py.
|
| +"""
|
| +
|
| +import optparse
|
| +import os
|
| +import sys
|
| +import termios
|
| +import tty
|
| +
|
| +
|
| +def YesNo(prompt):
|
| + """Prompts with a yes/no question, returns True if yes."""
|
| + print prompt,
|
| + sys.stdout.flush()
|
| + # http://code.activestate.com/recipes/134892/
|
| + fd = sys.stdin.fileno()
|
| + old_settings = termios.tcgetattr(fd)
|
| + ch = 'n'
|
| + try:
|
| + tty.setraw(sys.stdin.fileno())
|
| + ch = sys.stdin.read(1)
|
| + finally:
|
| + termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
|
| + print ch
|
| + return ch in ('Y', 'y')
|
| +
|
| +
|
| +def IncludeCompareKey(line):
|
| + """Sorting comparator key used for comparing two #include lines.
|
| + Returns the filename without the #include/#import prefix.
|
| + """
|
| + line = line.lower()
|
| + for prefix in ('#include ', '#import '):
|
| + if line.startswith(prefix):
|
| + line = line[len(prefix):]
|
| + break
|
| +
|
| + # 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.
|
| + if line.startswith('<windows.h>'): # Must be before e.g. shellapi.h
|
| + return '0'
|
| + if line.startswith('<unknwn.h>'): # Must be before e.g. intshcut.h
|
| + return '1'
|
| +
|
| + # C++ system headers should come after C system headers.
|
| + if line.startswith('<'):
|
| + if line.find('.h>') != -1:
|
| + return '2' + line
|
| + else:
|
| + return '3' + line
|
| +
|
| + return '4' + line
|
| +
|
| +
|
| +def IsInclude(line):
|
| + """Returns True if the line is an #include/#import line."""
|
| + return line.startswith('#include ') or line.startswith('#import ')
|
| +
|
| +
|
| +def SortHeader(infile, outfile):
|
| + """Sorts the headers in infile, writing the sorted file to outfile."""
|
| + for line in infile:
|
| + if IsInclude(line):
|
| + headerblock = []
|
| + while IsInclude(line):
|
| + headerblock.append(line)
|
| + line = infile.next()
|
| + for header in sorted(headerblock, key=IncludeCompareKey):
|
| + outfile.write(header)
|
| + # Intentionally fall through, to write the line that caused
|
| + # the above while loop to exit.
|
| + outfile.write(line)
|
| +
|
| +
|
| +def FixFileWithConfirmFunction(filename, confirm_function):
|
| + """Creates a fixed version of the file, invokes |confirm_function|
|
| + to decide whether to use the new file, and cleans up.
|
| +
|
| + |confirm_function| takes two parameters, the original filename and
|
| + the fixed-up filename, and returns True to use the fixed-up file,
|
| + false to not use it.
|
| + """
|
| + fixfilename = filename + '.new'
|
| + infile = open(filename, 'r')
|
| + outfile = open(fixfilename, 'w')
|
| + SortHeader(infile, outfile)
|
| + infile.close()
|
| + outfile.close() # Important so the below diff gets the updated contents.
|
| +
|
| + try:
|
| + if confirm_function(filename, fixfilename):
|
| + os.rename(fixfilename, filename)
|
| + finally:
|
| + try:
|
| + os.remove(fixfilename)
|
| + except OSError:
|
| + # If the file isn't there, we don't care.
|
| + pass
|
| +
|
| +
|
| +def DiffAndConfirm(filename, should_confirm):
|
| + """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
|
| + answers Y to the confirmation prompt.
|
| + """
|
| + def ConfirmFunction(filename, fixfilename):
|
| + diff = os.system('diff -u %s %s' % (filename, fixfilename))
|
| + if diff >> 8 == 0: # Check exit code.
|
| + print '%s: no change' % filename
|
| + return False
|
| +
|
| + return (not should_confirm or YesNo('Use new file (y/N)?'))
|
| +
|
| + FixFileWithConfirmFunction(filename, ConfirmFunction)
|
| +
|
| +
|
| +def main():
|
| + parser = optparse.OptionParser(usage='%prog filename1 filename2 ...')
|
| + parser.add_option('-f', '--force', action='store_false', default=True,
|
| + dest='should_confirm',
|
| + help='Turn off confirmation prompt.')
|
| + opts, filenames = parser.parse_args()
|
| +
|
| + if len(filenames) < 1:
|
| + parser.print_help()
|
| + return 1
|
| +
|
| + for filename in filenames:
|
| + DiffAndConfirm(filename, opts.should_confirm)
|
| +
|
| +
|
| +if __name__ == '__main__':
|
| + sys.exit(main())
|
|
|