[clang-tidy] For `run-clang-tidy.py` escape the paths that are used for analysis.

[Abpostelnicu]

Summary

Some paths can have special chars like file++c.cpp in this case the regex will fail if we don't escape it.

[njames93]

Looks good

[njames93]

Based on https://bugs.llvm.org/show_bug.cgi?id=46536 I've reverted this as it renders the core feature of the script as unusable (using .* to run over entire database)

[Abpostelnicu]

@njames93 wdyt if we add another parameter to distinguish if we want to use regex or not, and if not we escape the paths?
Also thank you so much for catching this up!

[njames93]

In D81917#2127477, @Abpostelnicu wrote:

@njames93 wdyt if we add another parameter to distinguish if we want to use regex or not, and if not we escape the paths?
Also thank you so much for catching this up!

As the argument is documented as being a regex string, we shouldn't really try to escape it, and users should be expected escape any file names themselves before invoking the script.
If for whatever reason you want to use .c++ as your file extension. then you should pass r'*\.c\+\+' to the script.

Can I ask what the specific use case you have that is causing the issue? Are you invoking run-clang-tidy from a script that generates the list of files to search for?

[Abpostelnicu]

In D81917#2127690, @njames93 wrote:

In D81917#2127477, @Abpostelnicu wrote:

@njames93 wdyt if we add another parameter to distinguish if we want to use regex or not, and if not we escape the paths?
Also thank you so much for catching this up!

As the argument is documented as being a regex string, we shouldn't really try to escape it, and users should be expected escape any file names themselves before invoking the script.
If for whatever reason you want to use .c++ as your file extension. then you should pass r'*\.c\+\+' to the script.

Can I ask what the specific use case you have that is causing the issue? Are you invoking run-clang-tidy from a script that generates the list of files to search for?

Thank you for the detailed reply! we are using this script in automation and some files from our repo indeed need to be escaped. I think it makes sense what you are saying to give to the consumer the files already escaped. I'm going to close this issue.

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

if max_task == 0:
     max_task = multiprocessing.cpu_count()
 
   tmpdir = None
   if args.fix or (yaml and args.export_fixes):
     check_clang_apply_replacements_binary(args)
     tmpdir = tempfile.mkdtemp()
 
   # Build up a big regexy filter from all command line arguments.
+  args.files = [re.escape(f) for f in args.files]
   file_name_re = re.compile('|'.join(args.files))
 
   return_code = 0
   try:
     # Spin up a bunch of tidy-launching threads.
     task_queue = queue.Queue(max_task)
     # List of files with a non-zero return code.
     failed_files = []