2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
3 # Use of this source code is governed by a BSD-style license that can be
4 # found in the LICENSE file.
6 """Given a filename as an argument, sort the #include/#imports in that file.
8 Shows a diff and prompts for confirmation before doing the deed.
9 Works great with tools/git/for-all-touched-files.py.
18 """Prompts with a yes/no question, returns True if yes."""
21 # http://code.activestate.com/recipes/134892/
22 if sys
.platform
== 'win32':
28 fd
= sys
.stdin
.fileno()
29 old_settings
= termios
.tcgetattr(fd
)
32 tty
.setraw(sys
.stdin
.fileno())
33 ch
= sys
.stdin
.read(1)
35 termios
.tcsetattr(fd
, termios
.TCSADRAIN
, old_settings
)
37 return ch
in ('Y', 'y')
40 def IncludeCompareKey(line
):
41 """Sorting comparator key used for comparing two #include lines.
42 Returns the filename without the #include/#import prefix.
44 for prefix
in ('#include ', '#import '):
45 if line
.startswith(prefix
):
46 line
= line
[len(prefix
):]
49 # The win32 api has all sorts of implicit include order dependencies :-/
50 # Give a few headers special sort keys that make sure they appear before all
52 if line
.startswith('<windows.h>'): # Must be before e.g. shellapi.h
54 if line
.startswith('<atlbase.h>'): # Must be before atlapp.h.
56 if line
.startswith('<unknwn.h>'): # Must be before e.g. intshcut.h
59 # C++ system headers should come after C system headers.
60 if line
.startswith('<'):
61 if line
.find('.h>') != -1:
62 return '2' + line
.lower()
64 return '3' + line
.lower()
70 """Returns True if the line is an #include/#import line."""
71 return line
.startswith('#include ') or line
.startswith('#import ')
74 def SortHeader(infile
, outfile
):
75 """Sorts the headers in infile, writing the sorted file to outfile."""
79 while IsInclude(line
):
80 infile_ended_on_include_line
= False
81 headerblock
.append(line
)
82 # Ensure we don't die due to trying to read beyond the end of the file.
86 infile_ended_on_include_line
= True
88 for header
in sorted(headerblock
, key
=IncludeCompareKey
):
90 if infile_ended_on_include_line
:
91 # We already wrote the last line above; exit to ensure it isn't written
94 # Intentionally fall through, to write the line that caused
95 # the above while loop to exit.
99 def FixFileWithConfirmFunction(filename
, confirm_function
,
100 perform_safety_checks
):
101 """Creates a fixed version of the file, invokes |confirm_function|
102 to decide whether to use the new file, and cleans up.
104 |confirm_function| takes two parameters, the original filename and
105 the fixed-up filename, and returns True to use the fixed-up file,
108 If |perform_safety_checks| is True, then the function checks whether it is
109 unsafe to reorder headers in this file and skips the reorder with a warning
110 message in that case.
112 if perform_safety_checks
and IsUnsafeToReorderHeaders(filename
):
113 print ('Not reordering headers in %s as the script thinks that the '
114 'order of headers in this file is semantically significant.'
117 fixfilename
= filename
+ '.new'
118 infile
= open(filename
, 'rb')
119 outfile
= open(fixfilename
, 'wb')
120 SortHeader(infile
, outfile
)
122 outfile
.close() # Important so the below diff gets the updated contents.
125 if confirm_function(filename
, fixfilename
):
126 if sys
.platform
== 'win32':
128 os
.rename(fixfilename
, filename
)
131 os
.remove(fixfilename
)
133 # If the file isn't there, we don't care.
137 def DiffAndConfirm(filename
, should_confirm
, perform_safety_checks
):
138 """Shows a diff of what the tool would change the file named
139 filename to. Shows a confirmation prompt if should_confirm is true.
140 Saves the resulting file if should_confirm is false or the user
141 answers Y to the confirmation prompt.
143 def ConfirmFunction(filename
, fixfilename
):
144 diff
= os
.system('diff -u %s %s' % (filename
, fixfilename
))
145 if sys
.platform
!= 'win32':
147 if diff
== 0: # Check exit code.
148 print '%s: no change' % filename
151 return (not should_confirm
or YesNo('Use new file (y/N)?'))
153 FixFileWithConfirmFunction(filename
, ConfirmFunction
, perform_safety_checks
)
155 def IsUnsafeToReorderHeaders(filename
):
156 # *_message_generator.cc is almost certainly a file that generates IPC
157 # definitions. Changes in include order in these files can result in them not
158 # building correctly.
159 if filename
.find("message_generator.cc") != -1:
164 parser
= optparse
.OptionParser(usage
='%prog filename1 filename2 ...')
165 parser
.add_option('-f', '--force', action
='store_false', default
=True,
166 dest
='should_confirm',
167 help='Turn off confirmation prompt.')
168 parser
.add_option('--no_safety_checks',
169 action
='store_false', default
=True,
170 dest
='perform_safety_checks',
171 help='Do not perform the safety checks via which this '
172 'script refuses to operate on files for which it thinks '
173 'the include ordering is semantically significant.')
174 opts
, filenames
= parser
.parse_args()
176 if len(filenames
) < 1:
180 for filename
in filenames
:
181 DiffAndConfirm(filename
, opts
.should_confirm
, opts
.perform_safety_checks
)
184 if __name__
== '__main__':