1#!/usr/bin/env python 2# 3#===- clang-tidy-diff.py - ClangTidy Diff Checker ------------*- 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""" 13ClangTidy Diff Checker 14====================== 15 16This script reads input from a unified diff, runs clang-tidy on all changed 17files and outputs clang-tidy warnings in changed lines only. This is useful to 18detect clang-tidy regressions in the lines touched by a specific patch. 19Example usage for git/svn users: 20 21 git diff -U0 HEAD^ | clang-tidy-diff.py -p1 22 svn diff --diff-cmd=diff -x-U0 | \ 23 clang-tidy-diff.py -fix -checks=-*,modernize-use-override 24 25""" 26 27import argparse 28import json 29import re 30import subprocess 31import sys 32 33 34def main(): 35 parser = argparse.ArgumentParser(description= 36 'Run clang-tidy against changed files, and ' 37 'output diagnostics only for modified ' 38 'lines.') 39 parser.add_argument('-clang-tidy-binary', metavar='PATH', 40 default='clang-tidy', 41 help='path to clang-tidy binary') 42 parser.add_argument('-p', metavar='NUM', default=0, 43 help='strip the smallest prefix containing P slashes') 44 parser.add_argument('-regex', metavar='PATTERN', default=None, 45 help='custom pattern selecting file paths to check ' 46 '(case sensitive, overrides -iregex)') 47 parser.add_argument('-iregex', metavar='PATTERN', default= 48 r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hpp|m|mm|inc)', 49 help='custom pattern selecting file paths to check ' 50 '(case insensitive, overridden by -regex)') 51 52 parser.add_argument('-fix', action='store_true', default=False, 53 help='apply suggested fixes') 54 parser.add_argument('-checks', 55 help='checks filter, when not specified, use clang-tidy ' 56 'default', 57 default='') 58 parser.add_argument('-path', dest='build_path', 59 help='Path used to read a compile command database.') 60 parser.add_argument('-export-fixes', metavar='FILE', dest='export_fixes', 61 help='Create a yaml file to store suggested fixes in, ' 62 'which can be applied with clang-apply-replacements.') 63 parser.add_argument('-extra-arg', dest='extra_arg', 64 action='append', default=[], 65 help='Additional argument to append to the compiler ' 66 'command line.') 67 parser.add_argument('-extra-arg-before', dest='extra_arg_before', 68 action='append', default=[], 69 help='Additional argument to prepend to the compiler ' 70 'command line.') 71 parser.add_argument('-quiet', action='store_true', default=False, 72 help='Run clang-tidy in quiet mode') 73 clang_tidy_args = [] 74 argv = sys.argv[1:] 75 if '--' in argv: 76 clang_tidy_args.extend(argv[argv.index('--'):]) 77 argv = argv[:argv.index('--')] 78 79 args = parser.parse_args(argv) 80 81 # Extract changed lines for each file. 82 filename = None 83 lines_by_file = {} 84 for line in sys.stdin: 85 match = re.search('^\+\+\+\ \"?(.*?/){%s}([^ \t\n\"]*)' % args.p, line) 86 if match: 87 filename = match.group(2) 88 if filename == None: 89 continue 90 91 if args.regex is not None: 92 if not re.match('^%s$' % args.regex, filename): 93 continue 94 else: 95 if not re.match('^%s$' % args.iregex, filename, re.IGNORECASE): 96 continue 97 98 match = re.search('^@@.*\+(\d+)(,(\d+))?', line) 99 if match: 100 start_line = int(match.group(1)) 101 line_count = 1 102 if match.group(3): 103 line_count = int(match.group(3)) 104 if line_count == 0: 105 continue 106 end_line = start_line + line_count - 1; 107 lines_by_file.setdefault(filename, []).append([start_line, end_line]) 108 109 if len(lines_by_file) == 0: 110 print("No relevant changes found.") 111 sys.exit(0) 112 113 line_filter_json = json.dumps( 114 [{"name" : name, "lines" : lines_by_file[name]} for name in lines_by_file], 115 separators = (',', ':')) 116 117 quote = ""; 118 if sys.platform == 'win32': 119 line_filter_json=re.sub(r'"', r'"""', line_filter_json) 120 else: 121 quote = "'"; 122 123 # Run clang-tidy on files containing changes. 124 command = [args.clang_tidy_binary] 125 command.append('-line-filter=' + quote + line_filter_json + quote) 126 if args.fix: 127 command.append('-fix') 128 if args.export_fixes: 129 command.append('-export-fixes=' + args.export_fixes) 130 if args.checks != '': 131 command.append('-checks=' + quote + args.checks + quote) 132 if args.quiet: 133 command.append('-quiet') 134 if args.build_path is not None: 135 command.append('-p=%s' % args.build_path) 136 command.extend(lines_by_file.keys()) 137 for arg in args.extra_arg: 138 command.append('-extra-arg=%s' % arg) 139 for arg in args.extra_arg_before: 140 command.append('-extra-arg-before=%s' % arg) 141 command.extend(clang_tidy_args) 142 143 sys.exit(subprocess.call(' '.join(command), shell=True)) 144 145if __name__ == '__main__': 146 main() 147