1#!/usr/bin/env python
2#
3#===- clang-format-diff.py - ClangFormat Diff Reformatter ----*- python -*--===#
4#
5#                     The LLVM Compiler Infrastructure
6#
7# This file is distributed under the University of Illinois Open Source
8# License. See LICENSE.TXT for details.
9#
10#===------------------------------------------------------------------------===#
11
12r"""
13ClangFormat Diff Reformatter
14============================
15
16This script reads input from a unified diff and reformats all the changed
17lines. This is useful to reformat all the lines touched by a specific patch.
18Example usage for git/svn users:
19
20  git diff -U0 HEAD^ | clang-format-diff.py -p1 -i
21  svn diff --diff-cmd=diff -x-U0 | clang-format-diff.py -i
22
23"""
24
25import argparse
26import difflib
27import re
28import string
29import subprocess
30import StringIO
31import sys
32
33
34# Change this to the full path if clang-format is not on the path.
35binary = 'clang-format'
36
37
38def main():
39  parser = argparse.ArgumentParser(description=
40                                   'Reformat changed lines in diff. Without -i '
41                                   'option just output the diff that would be '
42                                   'introduced.')
43  parser.add_argument('-i', action='store_true', default=False,
44                      help='apply edits to files instead of displaying a diff')
45  parser.add_argument('-p', metavar='NUM', default=0,
46                      help='strip the smallest prefix containing P slashes')
47  parser.add_argument('-regex', metavar='PATTERN', default=None,
48                      help='custom pattern selecting file paths to reformat '
49                      '(case sensitive, overrides -iregex)')
50  parser.add_argument('-iregex', metavar='PATTERN', default=
51                      r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hpp|m|mm|inc|js|ts|proto'
52                      r'|protodevel|java)',
53                      help='custom pattern selecting file paths to reformat '
54                      '(case insensitive, overridden by -regex)')
55  parser.add_argument('-sort-includes', action='store_true', default=False,
56                      help='let clang-format sort include blocks')
57  parser.add_argument('-v', '--verbose', action='store_true',
58                      help='be more verbose, ineffective without -i')
59  parser.add_argument(
60      '-style',
61      help=
62      'formatting style to apply (LLVM, Google, Chromium, Mozilla, WebKit)')
63  args = parser.parse_args()
64
65  # Extract changed lines for each file.
66  filename = None
67  lines_by_file = {}
68  for line in sys.stdin:
69    match = re.search('^\+\+\+\ (.*?/){%s}(\S*)' % args.p, line)
70    if match:
71      filename = match.group(2)
72    if filename == None:
73      continue
74
75    if args.regex is not None:
76      if not re.match('^%s$' % args.regex, filename):
77        continue
78    else:
79      if not re.match('^%s$' % args.iregex, filename, re.IGNORECASE):
80        continue
81
82    match = re.search('^@@.*\+(\d+)(,(\d+))?', line)
83    if match:
84      start_line = int(match.group(1))
85      line_count = 1
86      if match.group(3):
87        line_count = int(match.group(3))
88      if line_count == 0:
89        continue
90      end_line = start_line + line_count - 1;
91      lines_by_file.setdefault(filename, []).extend(
92          ['-lines', str(start_line) + ':' + str(end_line)])
93
94  # Reformat files containing changes in place.
95  for filename, lines in lines_by_file.iteritems():
96    if args.i and args.verbose:
97      print 'Formatting', filename
98    command = [binary, filename]
99    if args.i:
100      command.append('-i')
101    if args.sort_includes:
102      command.append('-sort-includes')
103    command.extend(lines)
104    if args.style:
105      command.extend(['-style', args.style])
106    p = subprocess.Popen(command, stdout=subprocess.PIPE,
107                         stderr=None, stdin=subprocess.PIPE)
108    stdout, stderr = p.communicate()
109    if p.returncode != 0:
110      sys.exit(p.returncode);
111
112    if not args.i:
113      with open(filename) as f:
114        code = f.readlines()
115      formatted_code = StringIO.StringIO(stdout).readlines()
116      diff = difflib.unified_diff(code, formatted_code,
117                                  filename, filename,
118                                  '(before formatting)', '(after formatting)')
119      diff_string = string.join(diff, '')
120      if len(diff_string) > 0:
121        sys.stdout.write(diff_string)
122
123if __name__ == '__main__':
124  main()
125