Aleksei Khoroshilov
a41bf5350b
This change updates how brave/chromium_src overrides can reference original files: it adds ability to use #include <...> along with #include "src/...". This is enabled by replacing -I../../brave/chromium_src with -iquote../../brave_chromium_src, which adds an include search path only for #include "..." directives. With this approach, other files in the build tree can reference brave/chromium_src overrides using #include "...", while the overrides themselves can reference original Chromium files using #include <...>. Since Chromium uses #include "..." for all in-tree files, we can leverage this convention and configure our overrides so that we can drop support for #include "src/" later by removing -I../../.. and making rbe_exec_root modification obsolete (the main goal).
110 lines
3.8 KiB
Python
110 lines
3.8 KiB
Python
# Copyright (c) 2023 The Brave Authors. All rights reserved.
|
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
# You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
import os
|
|
|
|
import brave_chromium_utils
|
|
import chromium_presubmit_overrides
|
|
|
|
PRESUBMIT_VERSION = '2.0.0'
|
|
|
|
|
|
# Adds support for chromium_presubmit_config.json5 and some helpers.
|
|
def CheckToModifyInputApi(input_api, _output_api):
|
|
chromium_presubmit_overrides.modify_input_api(input_api)
|
|
return []
|
|
|
|
|
|
# Ensure we add // IWYU pragma: export into overridden chromium headers to make
|
|
# IWYU aware that these headers actually export other headers.
|
|
def CheckOverriddenHeadersDeclareIWYUExport(input_api, output_api):
|
|
files_to_check = (r'.+\.h$', )
|
|
files_to_skip = ()
|
|
|
|
file_filter = lambda f: input_api.FilterSourceFile(
|
|
f, files_to_check=files_to_check, files_to_skip=files_to_skip)
|
|
|
|
include_prefixes = ('#include <', '#include "../gen/')
|
|
nolint = 'NOLINT'
|
|
expected_suffix = '// IWYU pragma: export'
|
|
|
|
items = []
|
|
for f in input_api.AffectedSourceFiles(file_filter):
|
|
overridden_file_include_prefixes = tuple(
|
|
f'{prefix}{f.UnixLocalPath().replace("chromium_src/", "")}'
|
|
for prefix in include_prefixes)
|
|
for lineno, line in enumerate(f.NewContents(), 1):
|
|
if not line.startswith(
|
|
overridden_file_include_prefixes) or nolint in line:
|
|
continue
|
|
if line.endswith(expected_suffix):
|
|
continue
|
|
items.append(f'{f.LocalPath()}:{lineno}')
|
|
|
|
if not items:
|
|
return []
|
|
|
|
return [
|
|
output_api.PresubmitError(
|
|
f'Overridden file include should end with {expected_suffix}',
|
|
items)
|
|
]
|
|
|
|
|
|
# Ensure overridden sources include original headers only via "" syntax.
|
|
def CheckOverriddenSourceIncludeOriginalHeaderOnlyViaQuotes(
|
|
input_api, output_api):
|
|
files_to_check = (r'.+\.(c|cc|cpp|m|mm)$', )
|
|
files_to_skip = ()
|
|
|
|
file_filter = lambda f: input_api.FilterSourceFile(
|
|
f, files_to_check=files_to_check, files_to_skip=files_to_skip)
|
|
|
|
include_template = '#include <{}>'
|
|
nolint = 'NOLINT'
|
|
|
|
items = []
|
|
for f in input_api.AffectedSourceFiles(file_filter):
|
|
include_with_path = include_template.format(
|
|
os.path.splitext(f.UnixLocalPath().replace("chromium_src/", ""))[0]
|
|
+ '.h')
|
|
for lineno, line in enumerate(f.NewContents(), 1):
|
|
if not line.startswith(include_with_path) or nolint in line:
|
|
continue
|
|
items.append(f'{f.LocalPath()}:{lineno}')
|
|
|
|
if not items:
|
|
return []
|
|
|
|
return [
|
|
output_api.PresubmitError(
|
|
'In source files, headers for the overridden files should be '
|
|
'included via "" syntax, not <>', items)
|
|
]
|
|
|
|
|
|
def CheckOverrides(input_api, output_api):
|
|
items = []
|
|
with brave_chromium_utils.sys_path('//brave/tools/chromium_src'):
|
|
import check_chromium_src
|
|
# None will make filter pick Chromium's DEFAULT_FILES_TO_CHECK.
|
|
file_filter = lambda f: input_api.FilterSourceFile(
|
|
f, files_to_check=None, files_to_skip=())
|
|
overrides = [
|
|
f.AbsoluteLocalPath()
|
|
for f in input_api.AffectedSourceFiles(file_filter)
|
|
]
|
|
# We can't provide the gen directory path from presubmit.
|
|
messages = check_chromium_src.ChromiumSrcOverridesChecker(
|
|
gen_buildir=None).check_overrides(overrides)
|
|
for message in messages['infos']:
|
|
items.append(output_api.PresubmitNotifyResult(message))
|
|
for message in messages['warnings']:
|
|
items.append(output_api.PresubmitPromptWarning(message))
|
|
for message in messages['errors']:
|
|
items.append(output_api.PresubmitError(message))
|
|
|
|
return items
|