Skip to content

Make strip_include_prefix apply to textual_hdrs #537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
keith wants to merge 2 commits into
base: main
Choose a base branch
from
+52 −13
Open

Make strip_include_prefix apply to textual_hdrs #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7606013
Make strip_include_prefix apply to textual_hdrs
keith Nov 27, 2025
72348e4
Add boolean for disabling new behavior
keith Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cc/common/semantics.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
# TODO: b/320980684 - Add a test that fails if this is flipped to True.
USE_EXEC_ROOT_FOR_VIRTUAL_INCLUDES_SYMLINKS = False

STRIP_INCLUDE_PREFIX_APPLIES_TO_TEXTUAL_HEADERS = True

def _get_proto_aspects():
return []

Expand Down
63 changes: 50 additions & 13 deletions cc/private/compile/cc_compilation_helper.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ load(
"package_source_root",
"repository_exec_path",
)
load("//cc/common:semantics.bzl", "USE_EXEC_ROOT_FOR_VIRTUAL_INCLUDES_SYMLINKS")
load("//cc/common:semantics.bzl", "STRIP_INCLUDE_PREFIX_APPLIES_TO_TEXTUAL_HEADERS", "USE_EXEC_ROOT_FOR_VIRTUAL_INCLUDES_SYMLINKS")
load("//cc/private:cc_info.bzl", "create_compilation_context", "create_module_map")
load("//cc/private:cc_internal.bzl", _cc_internal = "cc_internal")

Expand Down Expand Up @@ -60,7 +60,9 @@ def _compute_public_headers(
binfiles_dir,
non_module_map_headers,
is_sibling_repository_layout,
shorten_virtual_includes):
shorten_virtual_includes,
*,
must_use_strip_prefix = True):
if include_prefix:
if not paths.is_normalized(include_prefix, False):
fail("include prefix should not contain uplevel references: " + include_prefix)
Expand Down Expand Up @@ -117,7 +119,7 @@ def _compute_public_headers(
headers = public_headers_artifacts + non_module_map_headers,
module_map_headers = public_headers_artifacts,
virtual_include_path = None,
virtual_to_original_headers = depset(),
virtual_to_original_headers = [],
)

module_map_headers = []
Expand All @@ -128,8 +130,13 @@ def _compute_public_headers(
else:
virtual_include_dir = paths.join(source_package_path, _VIRTUAL_INCLUDES_DIR, label.name)
for original_header in public_headers_artifacts:
module_map_headers.append(original_header)

repo_relative_path = _repo_relative_path(original_header)
if not repo_relative_path.startswith(strip_prefix):
if not must_use_strip_prefix:
continue

fail("header '{}' is not under the specified strip prefix '{}'".format(repo_relative_path, strip_prefix))
include_path = paths.relativize(repo_relative_path, strip_prefix)
if include_prefix != None:
Expand All @@ -146,14 +153,12 @@ def _compute_public_headers(
if config.coverage_enabled:
virtual_to_original_headers_list.append((virtual_header.path, original_header.path))

module_map_headers.append(original_header)

virtual_headers = module_map_headers + non_module_map_headers
return struct(
headers = virtual_headers,
module_map_headers = module_map_headers,
virtual_include_path = paths.join(binfiles_dir, virtual_include_dir),
virtual_to_original_headers = depset(virtual_to_original_headers_list),
virtual_to_original_headers = virtual_to_original_headers_list,
)

def _generates_header_module(feature_configuration, public_headers, private_headers, generate_action):
Expand Down Expand Up @@ -195,6 +200,7 @@ _ModuleMapInfo = provider(
fields = [
"module_map",
"public_headers",
"textual_headers",
"private_headers",
"dependency_module_maps",
"additional_exported_headers",
Expand Down Expand Up @@ -249,6 +255,12 @@ def _module_map_struct_to_module_map_content(parameters, tree_expander):
add_header(path = header.path, visibility = "", can_compile = True)
added_paths.add(header.path)

for header in expanded(parameters.textual_headers):
if header.path in added_paths:
continue
add_header(path = header.path, visibility = "", can_compile = False)
added_paths.add(header.path)

for header in expanded(parameters.private_headers):
if header.path in added_paths:
continue
Expand Down Expand Up @@ -303,6 +315,7 @@ def _create_module_map_action(
module_map,
private_headers,
public_headers,
textual_headers,
dependency_module_maps,
additional_exported_headers,
separate_module_headers,
Expand All @@ -322,6 +335,7 @@ def _create_module_map_action(
data_struct = _ModuleMapInfo(
module_map = module_map,
public_headers = public_headers,
textual_headers = textual_headers,
private_headers = private_headers,
dependency_module_maps = dependency_module_maps,
additional_exported_headers = additional_exported_headers,
Expand All @@ -339,6 +353,7 @@ def _create_module_map_action(
# simple null function.
tree_artifacts = [h for h in private_headers if h.is_directory]
tree_artifacts += [h for h in public_headers if h.is_directory]
tree_artifacts += [h for h in textual_headers if h.is_directory]
content.add_all(tree_artifacts, map_each = lambda x: None, allow_closure = True)

actions.write(module_map.file, content = content, is_executable = True, mnemonic = "CppModuleMap")
Expand Down Expand Up @@ -433,15 +448,34 @@ def _init_cc_compilation_context(
else:
include_dirs_for_context.append(public_headers.virtual_include_path)

textual_headers = _compute_public_headers(
actions,
config,
public_textual_headers,
include_prefix,
strip_include_prefix if STRIP_INCLUDE_PREFIX_APPLIES_TO_TEXTUAL_HEADERS else None,
label,
binfiles_dir,
non_module_map_headers,
sibling_repo_layout,
shorten_virtual_includes,
must_use_strip_prefix = False,
)
if textual_headers.virtual_include_path:
if external or feature_configuration.is_requested("system_include_paths"):
external_include_dirs.append(textual_headers.virtual_include_path)
else:
include_dirs_for_context.append(textual_headers.virtual_include_path)

if config.coverage_enabled:
# Populate the map only when code coverage collection is enabled, to report the actual
# source file name in the coverage output file.
virtual_to_original_headers = public_headers.virtual_to_original_headers
virtual_to_original_headers = public_headers.virtual_to_original_headers + textual_headers.virtual_to_original_headers
else:
virtual_to_original_headers = depset()
virtual_to_original_headers = []

declared_include_srcs.extend(public_headers.headers)
declared_include_srcs.extend(public_textual_headers)
declared_include_srcs.extend(textual_headers.headers)
declared_include_srcs.extend(private_headers_artifacts)
declared_include_srcs.extend(additional_inputs)

Expand Down Expand Up @@ -488,8 +522,10 @@ def _init_cc_compilation_context(

if _enabled(feature_configuration, "only_doth_headers_in_module_maps"):
public_headers_for_module_map_action = [header for header in public_headers.module_map_headers if (header.is_directory or header.extension == "h")]
textual_headers_for_module_map_action = [header for header in textual_headers.module_map_headers if (header.is_directory or header.extension == "h")]
else:
public_headers_for_module_map_action = public_headers.module_map_headers
textual_headers_for_module_map_action = textual_headers.module_map_headers

private_headers_for_module_map_action = private_headers_artifacts
if _enabled(feature_configuration, "exclude_private_headers_in_module_maps"):
Expand All @@ -499,6 +535,7 @@ def _init_cc_compilation_context(
actions = actions,
module_map = module_map,
public_headers = public_headers_for_module_map_action,
textual_headers = textual_headers_for_module_map_action,
separate_module_headers = separate_public_headers.module_map_headers,
dependency_module_maps = dependency_module_maps,
private_headers = private_headers_for_module_map_action,
Expand Down Expand Up @@ -559,15 +596,15 @@ def _init_cc_compilation_context(
external_includes = depset(external_include_dirs),
system_includes = depset(system_include_dirs_for_context),
includes = depset(include_dirs_for_context),
virtual_to_original_headers = virtual_to_original_headers,
virtual_to_original_headers = depset(virtual_to_original_headers),
dependent_cc_compilation_contexts = dependent_cc_compilation_contexts,
non_code_inputs = additional_inputs,
defines = depset(defines),
local_defines = depset(local_defines),
headers = depset(declared_include_srcs),
direct_public_headers = public_headers.headers,
direct_private_headers = private_headers_artifacts,
direct_textual_headers = public_textual_headers,
direct_textual_headers = textual_headers.headers,
module_map = module_map,
pic_header_module = pic_header_module,
header_module = header_module,
Expand All @@ -585,15 +622,15 @@ def _init_cc_compilation_context(
external_includes = depset(external_include_dirs),
system_includes = depset(system_include_dirs_for_context),
includes = depset(include_dirs_for_context),
virtual_to_original_headers = virtual_to_original_headers,
virtual_to_original_headers = depset(virtual_to_original_headers),
dependent_cc_compilation_contexts = dependent_cc_compilation_contexts + implementation_deps,
non_code_inputs = additional_inputs,
defines = depset(defines),
local_defines = depset(local_defines),
headers = depset(declared_include_srcs),
direct_public_headers = public_headers.headers,
direct_private_headers = private_headers_artifacts,
direct_textual_headers = public_textual_headers,
direct_textual_headers = textual_headers.headers,
module_map = module_map,
pic_header_module = pic_header_module,
header_module = header_module,
Expand Down