Mercurial > hg > CbC > CbC_llvm

annotate utils/sort_includes.py @ 171:66f3bfe93da9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 11:07:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
171
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 #!/usr/bin/env python
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 """Script to sort the top-most block of #include lines.
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
4
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 Assumes the LLVM coding conventions.
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
6
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 Currently, this script only bothers sorting the llvm/... headers. Patches
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
8 welcome for more functionality, and sorting other header groups.
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 """
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
10
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 import argparse
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 import os
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
13
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 def sort_includes(f):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
15 """Sort the #include lines of a specific file."""
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
16
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
17 # Skip files which are under INPUTS trees or test trees.
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 if 'INPUTS/' in f.name or 'test/' in f.name:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
19 return
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
20
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
21 ext = os.path.splitext(f.name)[1]
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
22 if ext not in ['.cpp', '.c', '.h', '.inc', '.def']:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
23 return
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
24
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
25 lines = f.readlines()
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
26 look_for_api_header = ext in ['.cpp', '.c']
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 found_headers = False
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
28 headers_begin = 0
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 headers_end = 0
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
30 api_headers = []
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
31 local_headers = []
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
32 subproject_headers = []
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
33 llvm_headers = []
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
34 system_headers = []
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
35 for (i, l) in enumerate(lines):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
36 if l.strip() == '':
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
37 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
38 if l.startswith('#include'):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
39 if not found_headers:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
40 headers_begin = i
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
41 found_headers = True
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
42 headers_end = i
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
43 header = l[len('#include'):].lstrip()
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
44 if look_for_api_header and header.startswith('"'):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
45 api_headers.append(header)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
46 look_for_api_header = False
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
47 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
48 if (header.startswith('<') or header.startswith('"gtest/') or
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
49 header.startswith('"isl/') or header.startswith('"json/')):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
50 system_headers.append(header)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
52 if (header.startswith('"clang/') or header.startswith('"clang-c/') or
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
53 header.startswith('"polly/')):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
54 subproject_headers.append(header)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
55 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
56 if (header.startswith('"llvm/') or header.startswith('"llvm-c/')):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
57 llvm_headers.append(header)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
58 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
59 local_headers.append(header)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
60 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
61
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
62 # Only allow comments and #defines prior to any includes. If either are
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
63 # mixed with includes, the order might be sensitive.
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
64 if found_headers:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
65 break
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
66 if l.startswith('//') or l.startswith('#define') or l.startswith('#ifndef'):
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
67 continue
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
68 break
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
69 if not found_headers:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
70 return
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
71
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
72 local_headers = sorted(set(local_headers))
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
73 subproject_headers = sorted(set(subproject_headers))
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
74 llvm_headers = sorted(set(llvm_headers))
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
75 system_headers = sorted(set(system_headers))
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
76 headers = api_headers + local_headers + subproject_headers + llvm_headers + system_headers
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
77 header_lines = ['#include ' + h for h in headers]
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
78 lines = lines[:headers_begin] + header_lines + lines[headers_end + 1:]
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
79
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
80 f.seek(0)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
81 f.truncate()
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
82 f.writelines(lines)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
83
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
84 def main():
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
85 parser = argparse.ArgumentParser(description=__doc__)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
86 parser.add_argument('files', nargs='+', type=argparse.FileType('r+'),
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
87 help='the source files to sort includes within')
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
88 args = parser.parse_args()
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
89 for f in args.files:
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
90 sort_includes(f)
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
91
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
92 if __name__ == '__main__':
66f3bfe93da9 git version 2c4ca6832fa6b306ee6a7010bfb80a3f2596f824
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents:
diff changeset
93 main()