3 """Script to sort the top-most block of #include lines.
5 Assumes the LLVM coding conventions.
7 Currently, this script only bothers sorting the llvm/... headers. Patches
8 welcome for more functionality, and sorting other header groups.
15 """Sort the #include lines of a specific file."""
17 # Skip files which are under INPUTS trees or test trees.
18 if 'INPUTS/' in f.name or 'test/' in f.name:
22 look_for_api_header = os.path.splitext(f.name)[1] == '.cpp'
30 for (i, l) in enumerate(lines):
33 if l.startswith('#include'):
38 header = l[len('#include'):].lstrip()
39 if look_for_api_header and header.startswith('"'):
40 api_headers.append(header)
41 look_for_api_header = False
43 if header.startswith('<') or header.startswith('"gtest/'):
44 system_headers.append(header)
46 if (header.startswith('"llvm/') or header.startswith('"llvm-c/') or
47 header.startswith('"clang/') or header.startswith('"clang-c/')):
48 project_headers.append(header)
50 local_headers.append(header)
53 # Only allow comments and #defines prior to any includes. If either are
54 # mixed with includes, the order might be sensitive.
57 if l.startswith('//') or l.startswith('#define') or l.startswith('#ifndef'):
64 project_headers.sort()
66 headers = api_headers + local_headers + project_headers + system_headers
67 header_lines = ['#include ' + h for h in headers]
68 lines = lines[:headers_begin] + header_lines + lines[headers_end + 1:]
75 parser = argparse.ArgumentParser(description=__doc__)
76 parser.add_argument('files', nargs='+', type=argparse.FileType('r+'),
77 help='the source files to sort includes within')
78 args = parser.parse_args()
82 if __name__ == '__main__':