OLD | NEW |
1 #!/usr/bin/env python | 1 #!/usr/bin/env python |
2 # Copyright 2014 The Chromium Authors. All rights reserved. | 2 # Copyright 2014 The Chromium Authors. All rights reserved. |
3 # Use of this source code is governed by a BSD-style license that can be | 3 # Use of this source code is governed by a BSD-style license that can be |
4 # found in the LICENSE file. | 4 # found in the LICENSE file. |
5 | 5 |
6 """Redirects to the version of clang-format checked into the Chrome tree. | 6 """Redirects to the version of clang-format checked into the Chrome tree. |
7 | 7 |
8 clang-format binaries are pulled down from Google Cloud Storage whenever you | 8 clang-format binaries are pulled down from Google Cloud Storage whenever you |
9 sync Chrome, to platform-specific locations. This script knows how to locate | 9 sync Chrome, to platform-specific locations. This script knows how to locate |
10 those tools, assuming the script is invoked from inside a Chromium checkout.""" | 10 those tools, assuming the script is invoked from inside a Chromium checkout.""" |
11 | 11 |
12 import gclient_utils | 12 import gclient_utils |
13 import os | 13 import os |
14 import subprocess | 14 import subprocess |
15 import sys | 15 import sys |
16 | 16 |
17 | 17 |
18 class NotFoundError(Exception): | 18 class NotFoundError(Exception): |
19 """A file could not be found.""" | 19 """A file could not be found.""" |
20 def __init__(self, e): | 20 def __init__(self, e): |
21 Exception.__init__(self, | 21 Exception.__init__(self, |
22 'Problem while looking for clang-format in Chromium source tree:\n' | 22 'Problem while looking for clang-format in Chromium source tree:\n' |
23 ' %s' % e) | 23 ' %s' % e) |
24 | 24 |
25 | 25 |
26 def _FindChromiumTree(): | 26 def _FindChromiumSourceRoot(): |
27 """Return the root of the current chromium checkout, or die trying.""" | 27 """Return the source root of the current chromium checkout, or die trying.""" |
28 source_root = gclient_utils.FindFileUpwards('.gclient') | 28 # The use of .gn is somewhat incongruous here, but we need a file uniquely |
| 29 # existing at src/. GN does the same thing at least. |
| 30 source_root = gclient_utils.FindFileUpwards('.gn') |
29 if not source_root: | 31 if not source_root: |
30 raise NotFoundError( | 32 raise NotFoundError( |
31 '.gclient file not found in any parent of the current path.') | 33 '.gn file not found in any parent of the current path.') |
32 return source_root | 34 return source_root |
33 | 35 |
34 | 36 |
35 def FindClangFormatToolInChromiumTree(): | 37 def FindClangFormatToolInChromiumTree(): |
36 """Return a path to the clang-format executable, or die trying.""" | 38 """Return a path to the clang-format executable, or die trying.""" |
37 # The binaries in platform-specific subdirectories in src/tools/gn/bin. | 39 tool_path = os.path.join(_FindChromiumSourceRoot(), 'third_party', |
38 tool_path = os.path.join(_FindChromiumTree(), 'src', 'third_party', | |
39 'clang_format', 'bin', | 40 'clang_format', 'bin', |
40 gclient_utils.GetMacWinOrLinux(), | 41 gclient_utils.GetMacWinOrLinux(), |
41 'clang-format' + gclient_utils.GetExeSuffix()) | 42 'clang-format' + gclient_utils.GetExeSuffix()) |
42 if not os.path.exists(tool_path): | 43 if not os.path.exists(tool_path): |
43 # TODO(nick): After March 2014, eliminate the following advisory. | 44 # TODO(nick): After March 2014, eliminate the following advisory. |
44 error_text = '''\n GIT CL FORMAT - WINTER WEATHER ADVISORY | 45 error_text = '''\n GIT CL FORMAT - WINTER WEATHER ADVISORY |
45 | 46 |
46 clang-format binaries now come with every Chrome checkout! | 47 clang-format binaries now come with every Chrome checkout! |
47 | 48 |
48 Unfortunately, your depot_tools scripts tried to find clang-format binaries | 49 Unfortunately, your depot_tools scripts tried to find clang-format binaries |
49 in your Chrome checkout, but failed. This is expected if you haven't synced | 50 in your Chrome checkout, but failed. This is expected if you haven't synced |
50 since the binaries were added. | 51 since the binaries were added. |
51 | 52 |
52 'git cl format' will probably not work until you sync your Chrome tree. | 53 'git cl format' will probably not work until you sync your Chrome tree. |
53 Sorry about that. | 54 Sorry about that. |
54 | 55 |
55 Contact nick@chromium.org if you have any additional questions.\n\n''' | 56 Contact nick@chromium.org if you have any additional questions.\n\n''' |
56 | 57 |
57 error_text += 'File does not exist: %s' % tool_path | 58 error_text += 'File does not exist: %s' % tool_path |
58 | 59 |
59 raise NotFoundError(error_text) | 60 raise NotFoundError(error_text) |
60 return tool_path | 61 return tool_path |
61 | 62 |
62 | 63 |
63 def FindClangFormatScriptInChromiumTree(script_name): | 64 def FindClangFormatScriptInChromiumTree(script_name): |
64 """Return a path to a clang-format helper script, or die trying.""" | 65 """Return a path to a clang-format helper script, or die trying.""" |
65 script_path = os.path.join(_FindChromiumTree(), 'src', 'third_party', | 66 script_path = os.path.join(_FindChromiumSourceRoot(), 'third_party', |
66 'clang_format', 'script', script_name) | 67 'clang_format', 'script', script_name) |
67 if not os.path.exists(script_path): | 68 if not os.path.exists(script_path): |
68 # TODO(thakis): Remove the fallback to the old location after a few weeks. | 69 # TODO(thakis): Remove the fallback to the old location after a few weeks. |
69 script_path = os.path.join(_FindChromiumTree(), 'src', 'third_party', | 70 script_path = os.path.join(_FindChromiumSourceRoot(), 'third_party', |
70 'clang_format', 'scripts', script_name) | 71 'clang_format', 'scripts', script_name) |
71 if not os.path.exists(script_path): | 72 if not os.path.exists(script_path): |
72 raise NotFoundError('File does not exist: %s' % script_path) | 73 raise NotFoundError('File does not exist: %s' % script_path) |
73 return script_path | 74 return script_path |
74 | 75 |
75 | 76 |
76 def main(args): | 77 def main(args): |
77 try: | 78 try: |
78 tool = FindClangFormatToolInChromiumTree() | 79 tool = FindClangFormatToolInChromiumTree() |
79 except NotFoundError, e: | 80 except NotFoundError, e: |
80 print >> sys.stderr, e | 81 print >> sys.stderr, e |
81 sys.exit(1) | 82 sys.exit(1) |
82 | 83 |
83 # Add some visibility to --help showing where the tool lives, since this | 84 # Add some visibility to --help showing where the tool lives, since this |
84 # redirection can be a little opaque. | 85 # redirection can be a little opaque. |
85 help_syntax = ('-h', '--help', '-help', '-help-list', '--help-list') | 86 help_syntax = ('-h', '--help', '-help', '-help-list', '--help-list') |
86 if any(match in args for match in help_syntax): | 87 if any(match in args for match in help_syntax): |
87 print '\nDepot tools redirects you to the clang-format at:\n %s\n' % tool | 88 print '\nDepot tools redirects you to the clang-format at:\n %s\n' % tool |
88 | 89 |
89 return subprocess.call([tool] + sys.argv[1:]) | 90 return subprocess.call([tool] + sys.argv[1:]) |
90 | 91 |
91 | 92 |
92 if __name__ == '__main__': | 93 if __name__ == '__main__': |
93 sys.exit(main(sys.argv)) | 94 sys.exit(main(sys.argv)) |
OLD | NEW |