skia2/tools/rewrite_includes.py
Mike Klein 140a4767f0 make presubmit failures clearer
A presubmit failure will now print something like

~/skia (reed↑2|…) $ git cl presubmit
Running presubmit commit checks ...
Some files need rewritten #includes:
	src/core/SkBitmapCache.cpp
	src/core/SkBitmapController.cpp
	tests/SkResourceCacheTest.cpp
To do this automatically, run
python tools/rewrite_includes.py src/core/SkBitmapCache.cpp src/core/SkBitmapController.cpp tests/SkResourceCacheTest.cpp

** Presubmit ERRORS **
`python tools/rewrite_includes.py --dry-run gn/core.gni src/core/SkBitmapCache.cpp src/core/SkBitmapCache.h src/core/SkBitmapController.cpp src/core/SkBitmapController.h src/core/SkBitmapProcState.cpp src/core/SkBitmapProcState.h src/shaders/SkBitmapProcShader.cpp src/shaders/SkBitmapProcShader.h src/shaders/SkImageShader.cpp tests/SkResourceCacheTest.cpp tools/rewrite_includes.py` failed

Change-Id: I84018a6e102efa8b477a2523f6b0fc927a674e1a
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/231676
Reviewed-by: Mike Reed <reed@google.com>
Commit-Queue: Mike Klein <mtklein@google.com>
2019-08-01 20:49:11 +00:00

113 lines
3.2 KiB
Python

#!/usr/bin/python2
#
# Copyright 2019 Google Inc.
#
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import StringIO
import argparse
import os
import sys
parser = argparse.ArgumentParser()
parser.add_argument('-n', '--dry-run', action='store_true',
help='Just check there is nothing to rewrite.')
parser.add_argument('sources', nargs='*',
help='Source files to rewrite, or all if empty.')
args = parser.parse_args()
roots = [
'bench',
'dm',
'docs',
'example',
'experimental',
'fuzz',
'gm',
'include',
'modules',
'platform_tools/android/apps',
'samplecode',
'src',
'tests',
'third_party/etc1',
'third_party/gif',
'tools'
]
# Don't count our local Vulkan headers as Skia headers;
# we don't want #include <vulkan/vulkan_foo.h> rewritten to point to them.
blacklist = ['include/third_party/vulkan']
# Map short name -> absolute path for all Skia headers.
headers = {}
for root in roots:
for path, _, files in os.walk(root):
if not any(snippet in path for snippet in blacklist):
for file_name in files:
if file_name.endswith('.h'):
if file_name in headers:
print path, file_name, headers[file_name]
assert file_name not in headers
headers[file_name] = os.path.abspath(os.path.join(path, file_name))
def to_rewrite():
if args.sources:
for path in args.sources:
yield path
else:
for root in roots:
for path, _, files in os.walk(root):
for file_name in files:
yield os.path.join(path, file_name)
# Rewrite any #includes relative to Skia's top-level directory.
need_rewriting = []
for file_path in to_rewrite():
if 'generated' in file_path:
continue
if (file_path.endswith('.h') or
file_path.endswith('.c') or
file_path.endswith('.m') or
file_path.endswith('.mm') or
file_path.endswith('.inc') or
file_path.endswith('.fp') or
file_path.endswith('.cc') or
file_path.endswith('.cpp')):
# Read the whole file into memory.
lines = open(file_path).readlines()
# Write it back out again line by line with substitutions for #includes.
output = StringIO.StringIO() if args.dry_run else open(file_path, 'w')
includes = []
for line in lines:
parts = line.replace('<', '"').replace('>', '"').split('"')
if (len(parts) == 3
and '#' in parts[0]
and 'include' in parts[0]
and os.path.basename(parts[1]) in headers):
header = headers[os.path.basename(parts[1])]
includes.append(parts[0] +
'"%s"' % os.path.relpath(header, '.') +
parts[2])
else:
for inc in sorted(includes):
print >>output, inc.strip('\n')
includes = []
print >>output, line.strip('\n')
if args.dry_run and output.getvalue() != open(file_path).read():
need_rewriting.append(file_path)
rc = 1
output.close()
if need_rewriting:
print 'Some files need rewritten #includes:'
for path in need_rewriting:
print '\t' + path
print 'To do this automatically, run'
print 'python tools/rewrite_includes.py ' + ' '.join(need_rewriting)
sys.exit(1)