[clang-tidy] support --load in clang-tidy-diff.py/run-clang-tidy.py

[bernhardmgruber]

Summary

Support for loading shared objects as plugins into clang-tidy was added in https://reviews.llvm.org/D111100. Unfortunately, the utility scripts clang-tidy-diff.py and run-clang-tidy.py did not receive corresponding arguments to forward such plugins to clang-tidy. This diff adds a -load=plugin option to both scripts.

[bernhardmgruber]

I did not base this revision on my latest main (422d05e792dbd6a97f5afd4cdd5e8aa677e97444) since I could not run the python scripts with the changes introduced in 9e1f4f13984186984ba37513372c1b7e0c4ba4fd.

[aaron.ballman]

In D123065#3427382, @bernhardmgruber wrote:

I did not base this revision on my latest main (422d05e792dbd6a97f5afd4cdd5e8aa677e97444) since I could not run the python scripts with the changes introduced in 9e1f4f13984186984ba37513372c1b7e0c4ba4fd.

Can you try with https://reviews.llvm.org/D123074 applied, just to double-check my LG? :-)

The changes here LGTM otherwise (very minor nit with the help text wording, feel free to ignore if you disagree with the rewording), thank you for the fix!

clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py

165

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

287

[bernhardmgruber]

Rebased on main and applied review comments.

[bernhardmgruber]

Added missing '.' in helptext.

[bernhardmgruber]

Ping.

Can someone merge this please for me? Thank you!

[whisperity]

In D123065#3474107, @bernhardmgruber wrote:

Ping.

Can someone merge this please for me? Thank you!

Yes, sure, just please specify what user.name and user.email would you like to be associated with the commit's author?

[bernhardmgruber]

Yes, sure, just please specify what user.name and user.email would you like to be associated with the commit's author?

user.name: Bernhard Manfred Gruber
user.email: [e-mail]

Thanks a lot!

[whisperity]

D'oh! I made a mistake when copying the URL and accidentally associated the commit with D12306 instead of D123065... Anyhow, this was committed in rGb1f1688e90b22dedc829f5abc9a912f18c034fbc.

clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py

parser.add_argument('-extra-arg', dest='extra_arg',
                       help='Additional argument to append to the compiler '
                       'command line.')
   parser.add_argument('-extra-arg-before', dest='extra_arg_before',
                       action='append', default=[],
                       help='Additional argument to prepend to the compiler '
                       'command line.')
   parser.add_argument('-quiet', action='store_true', default=False,
                       help='Run clang-tidy in quiet mode')
+  parser.add_argument('-load', dest='plugins',
+                      action='append', default=[],
+                      help='Load the specified plugin in clang-tidy')
+
   clang_tidy_args = []
   argv = sys.argv[1:]
   if '--' in argv:
     clang_tidy_args.extend(argv[argv.index('--'):])
     argv = argv[:argv.index('--')]
 
   args = parser.parse_args(argv)
 
def main():
   if args.build_path is not None:
     common_clang_tidy_args.append('-p=%s' % args.build_path)
   if args.use_color:
     common_clang_tidy_args.append('--use-color')
   for arg in args.extra_arg:
     common_clang_tidy_args.append('-extra-arg=%s' % arg)
   for arg in args.extra_arg_before:
     common_clang_tidy_args.append('-extra-arg-before=%s' % arg)
+  for plugin in args.plugins:
+    common_clang_tidy_args.append('-load=%s' % plugin)
 
   for name in lines_by_file:
     line_filter_json = json.dumps(
       [{"name": name, "lines": lines_by_file[name]}],
       separators=(',', ':'))
 
     # Run clang-tidy on files containing changes.
     command = [args.clang_tidy_binary]

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

def make_absolute(f, directory):
   if os.path.isabs(f):
     return f
   return os.path.normpath(os.path.join(directory, f))
 
 
 def get_tidy_invocation(f, clang_tidy_binary, checks, tmpdir, build_path,
                         header_filter, allow_enabling_alpha_checkers,
                         extra_arg, extra_arg_before, quiet, config_file_path,
-                        config, line_filter, use_color):
+                        config, line_filter, use_color, plugins):
   """Gets a command line for clang-tidy."""
   start = [clang_tidy_binary]
   if allow_enabling_alpha_checkers:
     start.append('-allow-enabling-analyzer-alpha-checkers')
   if header_filter is not None:
     start.append('-header-filter=' + header_filter)
   if line_filter is not None:
     start.append('-line-filter=' + line_filter)
for arg in extra_arg_before:
       start.append('-extra-arg-before=%s' % arg)
   start.append('-p=' + build_path)
   if quiet:
       start.append('-quiet')
   if config_file_path:
       start.append('--config-file=' + config_file_path)
   elif config:
       start.append('-config=' + config)
+  for plugin in plugins:
+      start.append('-load=' + plugin)
   start.append(f)
   return start
 
 
 def merge_replacement_files(tmpdir, mergefile):
   """Merge all replacement files in a directory into a single file"""
   # The fixes suggested by clang-tidy >= 4.0.0 are given under
   # the top level key 'Diagnostics' in the output yaml files
def run_tidy(args, clang_tidy_binary, tmpdir, build_path, queue, lock,
   """Takes filenames out of queue and runs clang-tidy on them."""
   while True:
     name = queue.get()
     invocation = get_tidy_invocation(name, clang_tidy_binary, args.checks,
                                      tmpdir, build_path, args.header_filter,
                                      args.allow_enabling_alpha_checkers,
                                      args.extra_arg, args.extra_arg_before,
                                      args.quiet, args.config_file, args.config,
-                                     args.line_filter, args.use_color)
+                                     args.line_filter, args.use_color,
+                                     args.plugins)
 
     proc = subprocess.Popen(invocation, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     output, err = proc.communicate()
     if proc.returncode != 0:
       if proc.returncode < 0:
         msg = "%s: terminated by signal %d\n" % (name, -proc.returncode)
         err += msg.encode('utf-8')
       failed_files.append(name)
parser.add_argument('-extra-arg', dest='extra_arg',
                       help='Additional argument to append to the compiler '
                       'command line.')
   parser.add_argument('-extra-arg-before', dest='extra_arg_before',
                       action='append', default=[],
                       help='Additional argument to prepend to the compiler '
                       'command line.')
   parser.add_argument('-quiet', action='store_true',
                       help='Run clang-tidy in quiet mode')
+  parser.add_argument('-load', dest='plugins',
+                      action='append', default=[],
+                      help='Load the specified plugin in clang-tidy')
   args = parser.parse_args()
 
   db_path = 'compile_commands.json'
 
   if args.build_path is not None:
     build_path = args.build_path
   else:
     # Find our database
if args.fix or (yaml and args.export_fixes):
     tmpdir = tempfile.mkdtemp()
 
   try:
     invocation = get_tidy_invocation("", clang_tidy_binary, args.checks,
                                      None, build_path, args.header_filter,
                                      args.allow_enabling_alpha_checkers,
                                      args.extra_arg, args.extra_arg_before,
                                      args.quiet, args.config_file, args.config,
-                                     args.line_filter, args.use_color)
+                                     args.line_filter, args.use_color,
+                                     args.plugins)
     invocation.append('-list-checks')
     invocation.append('-')
     if args.quiet:
       # Even with -quiet we still want to check if we can call clang-tidy.
       with open(os.devnull, 'w') as dev_null:
         subprocess.check_call(invocation, stdout=dev_null)
     else:
       subprocess.check_call(invocation)