Add `cc_common.merge_compilation_contexts`.
This method, like `cc_common.merge_compilation_outputs`, is useful when a rule invokes `cc_common.compile` multiple times (e.g., to separately compile Objective-C ARC and non-ARC sources) and wishes to merge the resulting compilation contexts before returning.
Because this operation is intended to be used to merge contexts originating from the same target, the merged contexts are always treated as direct contexts.
RELNOTES: None.
PiperOrigin-RevId: 373784770
diff --git a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcModule.java b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcModule.java
index 8c496ca..f2ec5af 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcModule.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcModule.java
@@ -770,6 +770,17 @@
return ccCompilationContext.build();
}
+ @Override
+ public CcCompilationContext mergeCompilationContexts(Sequence<?> compilationContexts)
+ throws EvalException {
+ return CcCompilationContext.builder(
+ /* actionConstructionContext= */ null, /* configuration= */ null, /* label= */ null)
+ .mergeDependentCcCompilationContexts(
+ Sequence.cast(compilationContexts, CcCompilationContext.class, "compilation_contexts"),
+ ImmutableList.of())
+ .build();
+ }
+
private static NestedSet<Artifact> toNestedSetOfArtifacts(Object obj, String fieldName)
throws EvalException {
if (obj == Starlark.UNBOUND) {
diff --git a/src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcModuleApi.java b/src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcModuleApi.java
index 018f38a..fba7020 100644
--- a/src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcModuleApi.java
+++ b/src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcModuleApi.java
@@ -1263,4 +1263,21 @@
Sequence<?> argv,
StarlarkThread thread)
throws EvalException;
+
+ @StarlarkMethod(
+ name = "merge_compilation_contexts",
+ doc = "Merges multiple <code>CompilationContexts</code>s into one.",
+ parameters = {
+ @Param(
+ name = "compilation_contexts",
+ doc =
+ "List of <code>CompilationContexts</code>s to be merged. The headers of each "
+ + "context will be exported by the direct fields in the returned provider.",
+ positional = false,
+ named = true,
+ defaultValue = "[]"),
+ })
+ CompilationContextT mergeCompilationContexts(
+ Sequence<?> compilationContexts) // <CcCompilationContextApi> expected
+ throws EvalException;
}
diff --git a/src/test/java/com/google/devtools/build/lib/rules/cpp/StarlarkCcCommonTest.java b/src/test/java/com/google/devtools/build/lib/rules/cpp/StarlarkCcCommonTest.java
index 194998b..7ed2ffe 100644
--- a/src/test/java/com/google/devtools/build/lib/rules/cpp/StarlarkCcCommonTest.java
+++ b/src/test/java/com/google/devtools/build/lib/rules/cpp/StarlarkCcCommonTest.java
@@ -6558,6 +6558,64 @@
}
@Test
+ public void testMergeCompilationContexts() throws Exception {
+ AnalysisMock.get()
+ .ccSupport()
+ .setupCcToolchainConfig(
+ mockToolsConfig,
+ CcToolchainConfig.builder().withFeatures(MockCcSupport.HEADER_MODULES_FEATURES));
+
+ scratch.file(
+ "direct/cc_merger.bzl",
+ "def _cc_merger_impl(ctx):",
+ " compilation_contexts = [dep[CcInfo].compilation_context for dep in ctx.attr.deps]",
+ " merged_context = cc_common.merge_compilation_contexts(",
+ " compilation_contexts = compilation_contexts,",
+ " )",
+ " return [CcInfo(compilation_context = merged_context)]",
+ "cc_merger = rule(",
+ " _cc_merger_impl,",
+ " attrs = {",
+ " 'deps': attr.label_list(providers = [[CcInfo]]),",
+ " }",
+ ")");
+ scratch.file(
+ "direct/BUILD",
+ "load('//direct:cc_merger.bzl', 'cc_merger')",
+ "cc_library(",
+ " name = 'public1',",
+ " srcs = ['public1.cc', 'public1_impl.h'],",
+ " hdrs = ['public1.h'],",
+ " textual_hdrs = ['public1.inc'],",
+ ")",
+ "cc_library(",
+ " name = 'public2',",
+ " srcs = ['public2.cc', 'public2_impl.h'],",
+ " hdrs = ['public2.h'],",
+ " textual_hdrs = ['public2.inc'],",
+ ")",
+ "cc_merger(",
+ " name = 'merge',",
+ " deps = [':public1', ':public2'],",
+ ")");
+
+ ConfiguredTarget lib = getConfiguredTarget("//direct:merge");
+ CcCompilationContext ccCompilationContext = lib.get(CcInfo.PROVIDER).getCcCompilationContext();
+ assertThat(
+ baseArtifactNames(
+ ccCompilationContext.getExportingModuleMaps().stream()
+ .map(CppModuleMap::getArtifact)
+ .collect(ImmutableList.toImmutableList())))
+ .containsExactly("public1.cppmap", "public2.cppmap");
+ assertThat(baseArtifactNames(ccCompilationContext.getDirectPublicHdrs()))
+ .containsExactly("public1.h", "public2.h");
+ assertThat(baseArtifactNames(ccCompilationContext.getDirectPrivateHdrs()))
+ .containsExactly("public1_impl.h", "public2_impl.h");
+ assertThat(baseArtifactNames(ccCompilationContext.getTextualHdrs()))
+ .containsExactly("public1.inc", "public2.inc");
+ }
+
+ @Test
public void testObjectFilesInCreateLibraryToLinkApiGuardedByFlag() throws Exception {
AnalysisMock.get()
.ccSupport()
