phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-10 03:47:29 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

contrib: Latest clang-format-diff.py script

Browse source 
This was take from
900bb318b5/clang/tools/clang-format/clang-format-diff.py

Updating it introduces some new options. For example specifying the
clang-format binary, which is useful for systems where clang tools are
shipped with a version suffix.
This commit is contained in:
TheCharlatan 2024-01-15 17:34:43 +01:00
parent 3ba8de1b70
commit 008e81e025
No known key found for this signature in database
GPG key ID: 9B79B45691DB4173
1 changed files with 166 additions and 139 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

305
contrib/devtools/clang-format-diff.py
View file

@ -1,166 +1,193 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# #
#===- clang-format-diff.py - ClangFormat Diff Reformatter ----*- python -*--===# # ===- clang-format-diff.py - ClangFormat Diff Reformatter ----*- python -*--===#
# #
# The LLVM Compiler Infrastructure # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
# #
# This file is distributed under the University of Illinois Open Source # ===------------------------------------------------------------------------===#
# License.
#
# ============================================================
#
# University of Illinois/NCSA
# Open Source License
#
# Copyright (c) 2007-2015 University of Illinois at Urbana-Champaign.
# All rights reserved.
#
# Developed by:
#
# LLVM Team
#
# University of Illinois at Urbana-Champaign
#
# http://llvm.org
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal with
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
# of the Software, and to permit persons to whom the Software is furnished to do
# so, subject to the following conditions:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimers.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimers in the
# documentation and/or other materials provided with the distribution.
#
# * Neither the names of the LLVM Team, University of Illinois at
# Urbana-Champaign, nor the names of its contributors may be used to
# endorse or promote products derived from this Software without specific
# prior written permission.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
# SOFTWARE.
#
# ============================================================
#
#===------------------------------------------------------------------------===#
r"""
ClangFormat Diff Reformatter
============================
"""
This script reads input from a unified diff and reformats all the changed This script reads input from a unified diff and reformats all the changed
lines. This is useful to reformat all the lines touched by a specific patch. lines. This is useful to reformat all the lines touched by a specific patch.
Example usage for git/svn users: Example usage for git/svn users:
git diff -U0 HEAD^ | clang-format-diff.py -p1 -i git diff -U0 --no-color --relative HEAD^ | {clang_format_diff} -p1 -i
svn diff --diff-cmd=diff -x-U0 | clang-format-diff.py -i svn diff --diff-cmd=diff -x-U0 | {clang_format_diff} -i
It should be noted that the filename contained in the diff is used unmodified
to determine the source file to update. Users calling this script directly
should be careful to ensure that the path in the diff is correct relative to the
current working directory.
""" """
from __future__ import absolute_import, division, print_function
import argparse import argparse
import difflib import difflib
import io
import re import re
import subprocess import subprocess
import sys import sys
if sys.version_info.major >= 3:
# Change this to the full path if clang-format is not on the path. from io import StringIO
binary = 'clang-format' else:
from io import BytesIO as StringIO
def main(): def main():
parser = argparse.ArgumentParser(description= parser = argparse.ArgumentParser(
'Reformat changed lines in diff. Without -i ' description=__doc__.format(clang_format_diff="%(prog)s"),
'option just output the diff that would be ' formatter_class=argparse.RawDescriptionHelpFormatter,
'introduced.') )
parser.add_argument('-i', action='store_true', default=False, parser.add_argument(
help='apply edits to files instead of displaying a diff') "-i",
parser.add_argument('-p', metavar='NUM', default=0, action="store_true",
help='strip the smallest prefix containing P slashes') default=False,
parser.add_argument('-regex', metavar='PATTERN', default=None, help="apply edits to files instead of displaying a diff",
help='custom pattern selecting file paths to reformat ' )
'(case sensitive, overrides -iregex)') parser.add_argument(
parser.add_argument('-iregex', metavar='PATTERN', default= "-p",
r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hpp|m|mm|inc|js|ts|proto' metavar="NUM",
r'|protodevel|java)', default=0,
help='custom pattern selecting file paths to reformat ' help="strip the smallest prefix containing P slashes",
'(case insensitive, overridden by -regex)') )
parser.add_argument('-sort-includes', action='store_true', default=False, parser.add_argument(
help='let clang-format sort include blocks') "-regex",
parser.add_argument('-v', '--verbose', action='store_true', metavar="PATTERN",
help='be more verbose, ineffective without -i') default=None,
args = parser.parse_args() help="custom pattern selecting file paths to reformat "
"(case sensitive, overrides -iregex)",
)
parser.add_argument(
"-iregex",
metavar="PATTERN",
default=r".*\.(?:cpp|cc|c\+\+|cxx|cppm|ccm|cxxm|c\+\+m|c|cl|h|hh|hpp"
r"|hxx|m|mm|inc|js|ts|proto|protodevel|java|cs|json|s?vh?)",
help="custom pattern selecting file paths to reformat "
"(case insensitive, overridden by -regex)",
)
parser.add_argument(
"-sort-includes",
action="store_true",
default=False,
help="let clang-format sort include blocks",
)
parser.add_argument(
"-v",
"--verbose",
action="store_true",
help="be more verbose, ineffective without -i",
)
parser.add_argument(
"-style",
help="formatting style to apply (LLVM, GNU, Google, Chromium, "
"Microsoft, Mozilla, WebKit)",
)
parser.add_argument(
"-fallback-style",
help="The name of the predefined style used as a"
"fallback in case clang-format is invoked with"
"-style=file, but can not find the .clang-format"
"file to use.",
)
parser.add_argument(
"-binary",
default="clang-format",
help="location of binary to use for clang-format",
)
args = parser.parse_args()
# Extract changed lines for each file. # Extract changed lines for each file.
filename = None filename = None
lines_by_file = {} lines_by_file = {}
for line in sys.stdin: for line in sys.stdin:
match = re.search(r'^\+\+\+\ (.*?/){%s}(\S*)' % args.p, line) match = re.search(r"^\+\+\+\ (.*?/){%s}(\S*)" % args.p, line)
if match: if match:
filename = match.group(2) filename = match.group(2)
if filename is None: if filename is None:
continue continue
if args.regex is not None: if args.regex is not None:
if not re.match('^%s$' % args.regex, filename): if not re.match("^%s$" % args.regex, filename):
continue continue
else: else:
if not re.match('^%s$' % args.iregex, filename, re.IGNORECASE): if not re.match("^%s$" % args.iregex, filename, re.IGNORECASE):
continue continue
match = re.search(r'^@@.*\+(\d+)(,(\d+))?', line) match = re.search(r"^@@.*\+(\d+)(?:,(\d+))?", line)
if match: if match:
start_line = int(match.group(1)) start_line = int(match.group(1))
line_count = 1 line_count = 1
if match.group(3): if match.group(2):
line_count = int(match.group(3)) line_count = int(match.group(2))
if line_count == 0: # The input is something like
continue #
end_line = start_line + line_count - 1 # @@ -1, +0,0 @@
lines_by_file.setdefault(filename, []).extend( #
['-lines', str(start_line) + ':' + str(end_line)]) # which means no lines were added.
if line_count == 0:
continue
# Also format lines range if line_count is 0 in case of deleting
# surrounding statements.
end_line = start_line
if line_count != 0:
end_line += line_count - 1
lines_by_file.setdefault(filename, []).extend(
["-lines", str(start_line) + ":" + str(end_line)]
)
# Reformat files containing changes in place. # Reformat files containing changes in place.
for filename, lines in lines_by_file.items(): for filename, lines in lines_by_file.items():
if args.i and args.verbose: if args.i and args.verbose:
print('Formatting {}'.format(filename)) print("Formatting {}".format(filename))
command = [binary, filename] command = [args.binary, filename]
if args.i: if args.i:
command.append('-i') command.append("-i")
if args.sort_includes: if args.sort_includes:
command.append('-sort-includes') command.append("-sort-includes")
command.extend(lines) command.extend(lines)
command.extend(['-style=file', '-fallback-style=none']) if args.style:
p = subprocess.Popen(command, command.extend(["-style", args.style])
stdout=subprocess.PIPE, if args.fallback_style:
stderr=None, command.extend(["-fallback-style", args.fallback_style])
stdin=subprocess.PIPE,
text=True)
stdout, stderr = p.communicate()
if p.returncode != 0:
sys.exit(p.returncode)
if not args.i: try:
with open(filename, encoding="utf8") as f: p = subprocess.Popen(
code = f.readlines() command,
formatted_code = io.StringIO(stdout).readlines() stdout=subprocess.PIPE,
diff = difflib.unified_diff(code, formatted_code, stderr=None,
filename, filename, stdin=subprocess.PIPE,
'(before formatting)', '(after formatting)') universal_newlines=True,
diff_string = ''.join(diff) )
if len(diff_string) > 0: except OSError as e:
sys.stdout.write(diff_string) # Give the user more context when clang-format isn't
# found/isn't executable, etc.
raise RuntimeError(
'Failed to run "%s" - %s"' % (" ".join(command), e.strerror)
)
if __name__ == '__main__': stdout, stderr = p.communicate()
main() if p.returncode != 0:
sys.exit(p.returncode)
if not args.i:
with open(filename) as f:
code = f.readlines()
formatted_code = StringIO(stdout).readlines()
diff = difflib.unified_diff(
code,
formatted_code,
filename,
filename,
"(before formatting)",
"(after formatting)",
)
diff_string = "".join(diff)
if len(diff_string) > 0:
sys.stdout.write(diff_string)
sys.exit(1)
if __name__ == "__main__":
main()