sort_includes.py revision fd025797ea5197b838f87ce57f2df5bccf27ad20 
1#!/usr/bin/env python
2
3"""Script to sort the top-most block of #include lines.
4
5Assumes the LLVM coding conventions.
6
7Currently, this script only bothers sorting the llvm/... headers. Patches
8welcome for more functionality, and sorting other header groups.
9"""
10
11import argparse
12import os
13
14def sort_includes(f):
15  """Sort the #include lines of a specific file."""
16
17  # Skip files which are under INPUTS trees or test trees.
18  if 'INPUTS/' in f.name or 'test/' in f.name:
19    return
20
21  lines = f.readlines()
22  look_for_api_header = os.path.splitext(f.name)[1] == '.cpp'
23  found_headers = False
24  headers_begin = 0
25  headers_end = 0
26  api_headers = []
27  local_headers = []
28  project_headers = []
29  system_headers = []
30  for (i, l) in enumerate(lines):
31    if l.strip() == '':
32      continue
33    if l.startswith('#include'):
34      if not found_headers:
35        headers_begin = i
36        found_headers = True
37      headers_end = i
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
42        continue
43      if header.startswith('<') or header.startswith('"gtest/'):
44        system_headers.append(header)
45        continue
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)
49        continue
50      local_headers.append(header)
51      continue
52
53    # Only allow comments and #defines prior to any includes. If either are
54    # mixed with includes, the order might be sensitive.
55    if found_headers:
56      break
57    if l.startswith('//') or l.startswith('#define') or l.startswith('#ifndef'):
58      continue
59    break
60  if not found_headers:
61    return
62
63  local_headers.sort()
64  project_headers.sort()
65  system_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:]
69
70  f.seek(0)
71  f.truncate()
72  f.writelines(lines)
73
74def main():
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()
79  for f in args.files:
80    sort_includes(f)
81
82if __name__ == '__main__':
83  main()
84