blob: c733f5b5bffdfada45d99e7945ba5087c36e2ad7 [file] [log] [blame]
Anton Hansson0860aaf2021-10-08 16:48:03 +01001// Copyright (C) 2021 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package api
16
17import (
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +000018 "fmt"
Anton Hansson07a12952022-01-12 17:28:39 +000019 "sort"
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +000020 "strings"
Anton Hansson07a12952022-01-12 17:28:39 +000021
Anton Hansson0860aaf2021-10-08 16:48:03 +010022 "github.com/google/blueprint/proptools"
23
24 "android/soong/android"
25 "android/soong/genrule"
Anton Hanssoncb00f942022-01-13 09:45:12 +000026 "android/soong/java"
Anton Hansson0860aaf2021-10-08 16:48:03 +010027)
28
Anton Hansson05e944d2022-01-13 12:26:30 +000029const art = "art.module.public.api"
30const conscrypt = "conscrypt.module.public.api"
31const i18n = "i18n.module.public.api"
Nikita Ioffed3f0a6f2022-11-15 11:26:53 +000032const virtualization = "framework-virtualization"
Mark White3cc5e002023-08-07 11:18:09 +000033const location = "framework-location"
Anton Hansson09a9c4e2022-04-08 10:59:46 +010034
Anton Hansson95e89a82022-01-28 11:31:50 +000035var core_libraries_modules = []string{art, conscrypt, i18n}
Zi Wang0d6a5302023-02-16 14:54:01 -080036
Nikita Ioffed3f0a6f2022-11-15 11:26:53 +000037// List of modules that are not yet updatable, and hence they can still compile
38// against hidden APIs. These modules are filtered out when building the
39// updatable-framework-module-impl (because updatable-framework-module-impl is
40// built against module_current SDK). Instead they are directly statically
41// linked into the all-framework-module-lib, which is building against hidden
42// APIs.
Nikita Ioffe5593fbb2022-12-01 14:52:34 +000043// In addition, the modules in this list are allowed to contribute to test APIs
44// stubs.
Roshan Pius96dac952023-12-07 10:54:05 -080045var non_updatable_modules = []string{virtualization, location}
Anton Hansson05e944d2022-01-13 12:26:30 +000046
Anton Hansson0860aaf2021-10-08 16:48:03 +010047// The intention behind this soong plugin is to generate a number of "merged"
48// API-related modules that would otherwise require a large amount of very
49// similar Android.bp boilerplate to define. For example, the merged current.txt
50// API definitions (created by merging the non-updatable current.txt with all
51// the module current.txts). This simplifies the addition of new android
52// modules, by reducing the number of genrules etc a new module must be added to.
53
54// The properties of the combined_apis module type.
55type CombinedApisProperties struct {
Anton Hansson16ff3572022-01-11 18:36:35 +000056 // Module libraries in the bootclasspath
57 Bootclasspath []string
Anton Hansson07a12952022-01-12 17:28:39 +000058 // Module libraries on the bootclasspath if include_nonpublic_framework_api is true.
59 Conditional_bootclasspath []string
Anton Hansson16ff3572022-01-11 18:36:35 +000060 // Module libraries in system server
61 System_server_classpath []string
Anton Hansson0860aaf2021-10-08 16:48:03 +010062}
63
64type CombinedApis struct {
65 android.ModuleBase
Harshit Mahajanb52adbc2023-12-15 21:56:42 +000066 android.DefaultableModuleBase
Anton Hansson0860aaf2021-10-08 16:48:03 +010067
68 properties CombinedApisProperties
69}
70
71func init() {
72 registerBuildComponents(android.InitRegistrationContext)
73}
74
75func registerBuildComponents(ctx android.RegistrationContext) {
76 ctx.RegisterModuleType("combined_apis", combinedApisModuleFactory)
Harshit Mahajanb52adbc2023-12-15 21:56:42 +000077 ctx.RegisterModuleType("combined_apis_defaults", CombinedApisModuleDefaultsFactory)
Anton Hansson0860aaf2021-10-08 16:48:03 +010078}
79
80var PrepareForCombinedApisTest = android.FixtureRegisterWithContext(registerBuildComponents)
81
82func (a *CombinedApis) GenerateAndroidBuildActions(ctx android.ModuleContext) {
83}
84
85type genruleProps struct {
86 Name *string
87 Cmd *string
88 Dists []android.Dist
89 Out []string
90 Srcs []string
91 Tools []string
92 Visibility []string
93}
94
Anton Hanssoncb00f942022-01-13 09:45:12 +000095type libraryProps struct {
96 Name *string
97 Sdk_version *string
98 Static_libs []string
99 Visibility []string
Jihoon Kang1453baa2023-05-27 05:32:30 +0000100 Defaults []string
Anton Hanssoncb00f942022-01-13 09:45:12 +0000101}
102
Anton Hansson4468d7c2022-01-14 12:10:01 +0000103type fgProps struct {
104 Name *string
105 Srcs []string
106 Visibility []string
107}
108
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000109type defaultsProps struct {
110 Name *string
111 Api_surface *string
112 Api_contributions []string
113 Defaults_visibility []string
Jihoon Kang471a05b2023-08-01 06:37:17 +0000114 Previous_api *string
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000115}
116
Anton Hansson0860aaf2021-10-08 16:48:03 +0100117// Struct to pass parameters for the various merged [current|removed].txt file modules we create.
118type MergedTxtDefinition struct {
119 // "current.txt" or "removed.txt"
120 TxtFilename string
Anton Hansson09a9c4e2022-04-08 10:59:46 +0100121 // Filename in the new dist dir. "android.txt" or "android-removed.txt"
122 DistFilename string
Anton Hansson0860aaf2021-10-08 16:48:03 +0100123 // The module for the non-updatable / non-module part of the api.
124 BaseTxt string
125 // The list of modules that are relevant for this merged txt.
126 Modules []string
127 // The output tag for each module to use.e.g. {.public.api.txt} for current.txt
128 ModuleTag string
129 // public, system, module-lib or system-server
130 Scope string
131}
132
Jihoon Kang31cf2742024-02-07 19:52:19 +0000133func createMergedTxt(ctx android.LoadHookContext, txt MergedTxtDefinition, stubsTypeSuffix string, doDist bool) {
Anton Hansson0860aaf2021-10-08 16:48:03 +0100134 metalavaCmd := "$(location metalava)"
135 // Silence reflection warnings. See b/168689341
136 metalavaCmd += " -J--add-opens=java.base/java.util=ALL-UNNAMED "
Paul Duffinf3b1fc42023-08-14 22:03:06 +0100137 metalavaCmd += " --quiet merge-signatures --format=v2 "
Anton Hansson0860aaf2021-10-08 16:48:03 +0100138
139 filename := txt.TxtFilename
140 if txt.Scope != "public" {
141 filename = txt.Scope + "-" + filename
142 }
Jihoon Kang31cf2742024-02-07 19:52:19 +0000143 moduleName := ctx.ModuleName() + stubsTypeSuffix + filename
Chris Parsons3b7e34b2023-09-27 22:34:57 +0000144
Anton Hansson0860aaf2021-10-08 16:48:03 +0100145 props := genruleProps{}
Chris Parsons3b7e34b2023-09-27 22:34:57 +0000146 props.Name = proptools.StringPtr(moduleName)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100147 props.Tools = []string{"metalava"}
Anton Hansson16ff3572022-01-11 18:36:35 +0000148 props.Out = []string{filename}
Paul Duffinf3b1fc42023-08-14 22:03:06 +0100149 props.Cmd = proptools.StringPtr(metalavaCmd + "$(in) --out $(out)")
Anton Hanssonfd316452022-01-14 11:15:52 +0000150 props.Srcs = append([]string{txt.BaseTxt}, createSrcs(txt.Modules, txt.ModuleTag)...)
Jihoon Kang31cf2742024-02-07 19:52:19 +0000151 if doDist {
152 props.Dists = []android.Dist{
153 {
154 Targets: []string{"droidcore"},
155 Dir: proptools.StringPtr("api"),
156 Dest: proptools.StringPtr(filename),
157 },
158 {
159 Targets: []string{"api_txt", "sdk"},
160 Dir: proptools.StringPtr("apistubs/android/" + txt.Scope + "/api"),
161 Dest: proptools.StringPtr(txt.DistFilename),
162 },
163 }
Anton Hansson0860aaf2021-10-08 16:48:03 +0100164 }
165 props.Visibility = []string{"//visibility:public"}
Colin Crossc6420762023-12-07 12:38:40 -0800166 ctx.CreateModule(genrule.GenRuleFactory, &props)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100167}
168
Cole Faustdcda3702022-10-04 14:46:35 -0700169func createMergedAnnotationsFilegroups(ctx android.LoadHookContext, modules, system_server_modules []string) {
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000170 for _, i := range []struct {
Cole Faustdcda3702022-10-04 14:46:35 -0700171 name string
172 tag string
173 modules []string
174 }{
175 {
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000176 name: "all-modules-public-annotations",
177 tag: "{.public.annotations.zip}",
Cole Faustdcda3702022-10-04 14:46:35 -0700178 modules: modules,
179 }, {
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000180 name: "all-modules-system-annotations",
181 tag: "{.system.annotations.zip}",
Cole Faustdcda3702022-10-04 14:46:35 -0700182 modules: modules,
183 }, {
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000184 name: "all-modules-module-lib-annotations",
185 tag: "{.module-lib.annotations.zip}",
Cole Faustdcda3702022-10-04 14:46:35 -0700186 modules: modules,
187 }, {
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000188 name: "all-modules-system-server-annotations",
189 tag: "{.system-server.annotations.zip}",
Cole Faustdcda3702022-10-04 14:46:35 -0700190 modules: system_server_modules,
191 },
192 } {
193 props := fgProps{}
194 props.Name = proptools.StringPtr(i.name)
195 props.Srcs = createSrcs(i.modules, i.tag)
Colin Crossc6420762023-12-07 12:38:40 -0800196 ctx.CreateModule(android.FileGroupFactory, &props)
Cole Faustdcda3702022-10-04 14:46:35 -0700197 }
Anton Hansson74b15642022-06-23 08:27:23 +0000198}
199
Anton Hanssonc6e9d2f2022-01-25 15:53:43 +0000200func createMergedPublicStubs(ctx android.LoadHookContext, modules []string) {
201 props := libraryProps{}
202 props.Name = proptools.StringPtr("all-modules-public-stubs")
203 props.Static_libs = transformArray(modules, "", ".stubs")
204 props.Sdk_version = proptools.StringPtr("module_current")
205 props.Visibility = []string{"//frameworks/base"}
206 ctx.CreateModule(java.LibraryFactory, &props)
207}
208
Jihoon Kang059b9492023-12-29 00:40:34 +0000209func createMergedPublicExportableStubs(ctx android.LoadHookContext, modules []string) {
210 props := libraryProps{}
211 props.Name = proptools.StringPtr("all-modules-public-stubs-exportable")
212 props.Static_libs = transformArray(modules, "", ".stubs.exportable")
213 props.Sdk_version = proptools.StringPtr("module_current")
214 props.Visibility = []string{"//frameworks/base"}
215 ctx.CreateModule(java.LibraryFactory, &props)
216}
217
Anton Hanssonc6e9d2f2022-01-25 15:53:43 +0000218func createMergedSystemStubs(ctx android.LoadHookContext, modules []string) {
Nikita Ioffe5593fbb2022-12-01 14:52:34 +0000219 // First create the all-updatable-modules-system-stubs
220 {
221 updatable_modules := removeAll(modules, non_updatable_modules)
222 props := libraryProps{}
223 props.Name = proptools.StringPtr("all-updatable-modules-system-stubs")
224 props.Static_libs = transformArray(updatable_modules, "", ".stubs.system")
225 props.Sdk_version = proptools.StringPtr("module_current")
226 props.Visibility = []string{"//frameworks/base"}
227 ctx.CreateModule(java.LibraryFactory, &props)
228 }
229 // Now merge all-updatable-modules-system-stubs and stubs from non-updatable modules
230 // into all-modules-system-stubs.
231 {
232 props := libraryProps{}
233 props.Name = proptools.StringPtr("all-modules-system-stubs")
234 props.Static_libs = transformArray(non_updatable_modules, "", ".stubs.system")
235 props.Static_libs = append(props.Static_libs, "all-updatable-modules-system-stubs")
236 props.Sdk_version = proptools.StringPtr("module_current")
237 props.Visibility = []string{"//frameworks/base"}
238 ctx.CreateModule(java.LibraryFactory, &props)
239 }
240}
241
Jihoon Kang059b9492023-12-29 00:40:34 +0000242func createMergedSystemExportableStubs(ctx android.LoadHookContext, modules []string) {
243 // First create the all-updatable-modules-system-stubs
244 {
245 updatable_modules := removeAll(modules, non_updatable_modules)
246 props := libraryProps{}
247 props.Name = proptools.StringPtr("all-updatable-modules-system-stubs-exportable")
248 props.Static_libs = transformArray(updatable_modules, "", ".stubs.exportable.system")
249 props.Sdk_version = proptools.StringPtr("module_current")
250 props.Visibility = []string{"//frameworks/base"}
251 ctx.CreateModule(java.LibraryFactory, &props)
252 }
253 // Now merge all-updatable-modules-system-stubs and stubs from non-updatable modules
254 // into all-modules-system-stubs.
255 {
256 props := libraryProps{}
257 props.Name = proptools.StringPtr("all-modules-system-stubs-exportable")
258 props.Static_libs = transformArray(non_updatable_modules, "", ".stubs.exportable.system")
259 props.Static_libs = append(props.Static_libs, "all-updatable-modules-system-stubs-exportable")
260 props.Sdk_version = proptools.StringPtr("module_current")
261 props.Visibility = []string{"//frameworks/base"}
262 ctx.CreateModule(java.LibraryFactory, &props)
263 }
264}
265
Nikita Ioffe5593fbb2022-12-01 14:52:34 +0000266func createMergedTestStubsForNonUpdatableModules(ctx android.LoadHookContext) {
Anton Hanssonc6e9d2f2022-01-25 15:53:43 +0000267 props := libraryProps{}
Nikita Ioffe5593fbb2022-12-01 14:52:34 +0000268 props.Name = proptools.StringPtr("all-non-updatable-modules-test-stubs")
269 props.Static_libs = transformArray(non_updatable_modules, "", ".stubs.test")
Anton Hanssonc6e9d2f2022-01-25 15:53:43 +0000270 props.Sdk_version = proptools.StringPtr("module_current")
271 props.Visibility = []string{"//frameworks/base"}
272 ctx.CreateModule(java.LibraryFactory, &props)
273}
274
Jihoon Kang059b9492023-12-29 00:40:34 +0000275func createMergedTestExportableStubsForNonUpdatableModules(ctx android.LoadHookContext) {
276 props := libraryProps{}
277 props.Name = proptools.StringPtr("all-non-updatable-modules-test-stubs-exportable")
278 props.Static_libs = transformArray(non_updatable_modules, "", ".stubs.exportable.test")
279 props.Sdk_version = proptools.StringPtr("module_current")
280 props.Visibility = []string{"//frameworks/base"}
281 ctx.CreateModule(java.LibraryFactory, &props)
282}
283
Anton Hansson95e89a82022-01-28 11:31:50 +0000284func createMergedFrameworkImpl(ctx android.LoadHookContext, modules []string) {
285 // This module is for the "framework-all" module, which should not include the core libraries.
286 modules = removeAll(modules, core_libraries_modules)
Nikita Ioffed3f0a6f2022-11-15 11:26:53 +0000287 // Remove the modules that belong to non-updatable APEXes since those are allowed to compile
288 // against unstable APIs.
289 modules = removeAll(modules, non_updatable_modules)
290 // First create updatable-framework-module-impl, which contains all updatable modules.
291 // This module compiles against module_lib SDK.
292 {
293 props := libraryProps{}
294 props.Name = proptools.StringPtr("updatable-framework-module-impl")
295 props.Static_libs = transformArray(modules, "", ".impl")
296 props.Sdk_version = proptools.StringPtr("module_current")
297 props.Visibility = []string{"//frameworks/base"}
298 ctx.CreateModule(java.LibraryFactory, &props)
299 }
300
301 // Now create all-framework-module-impl, which contains updatable-framework-module-impl
302 // and all non-updatable modules. This module compiles against hidden APIs.
303 {
304 props := libraryProps{}
305 props.Name = proptools.StringPtr("all-framework-module-impl")
306 props.Static_libs = transformArray(non_updatable_modules, "", ".impl")
307 props.Static_libs = append(props.Static_libs, "updatable-framework-module-impl")
308 props.Sdk_version = proptools.StringPtr("core_platform")
309 props.Visibility = []string{"//frameworks/base"}
310 ctx.CreateModule(java.LibraryFactory, &props)
311 }
Anton Hansson95e89a82022-01-28 11:31:50 +0000312}
313
Jihoon Kang059b9492023-12-29 00:40:34 +0000314func createMergedFrameworkModuleLibExportableStubs(ctx android.LoadHookContext, modules []string) {
315 // The user of this module compiles against the "core" SDK and against non-updatable modules,
316 // so remove to avoid dupes.
317 modules = removeAll(modules, core_libraries_modules)
318 modules = removeAll(modules, non_updatable_modules)
319 props := libraryProps{}
320 props.Name = proptools.StringPtr("framework-updatable-stubs-module_libs_api-exportable")
321 props.Static_libs = transformArray(modules, "", ".stubs.exportable.module_lib")
322 props.Sdk_version = proptools.StringPtr("module_current")
323 props.Visibility = []string{"//frameworks/base"}
324 ctx.CreateModule(java.LibraryFactory, &props)
325}
326
Anton Hansson95e89a82022-01-28 11:31:50 +0000327func createMergedFrameworkModuleLibStubs(ctx android.LoadHookContext, modules []string) {
Mark White3cc5e002023-08-07 11:18:09 +0000328 // The user of this module compiles against the "core" SDK and against non-updatable modules,
329 // so remove to avoid dupes.
Anton Hansson95e89a82022-01-28 11:31:50 +0000330 modules = removeAll(modules, core_libraries_modules)
Mark White3cc5e002023-08-07 11:18:09 +0000331 modules = removeAll(modules, non_updatable_modules)
Anton Hanssoncb00f942022-01-13 09:45:12 +0000332 props := libraryProps{}
333 props.Name = proptools.StringPtr("framework-updatable-stubs-module_libs_api")
Anton Hanssonfd316452022-01-14 11:15:52 +0000334 props.Static_libs = transformArray(modules, "", ".stubs.module_lib")
Anton Hanssoncb00f942022-01-13 09:45:12 +0000335 props.Sdk_version = proptools.StringPtr("module_current")
336 props.Visibility = []string{"//frameworks/base"}
337 ctx.CreateModule(java.LibraryFactory, &props)
338}
339
Anton Hansson4468d7c2022-01-14 12:10:01 +0000340func createPublicStubsSourceFilegroup(ctx android.LoadHookContext, modules []string) {
341 props := fgProps{}
342 props.Name = proptools.StringPtr("all-modules-public-stubs-source")
343 props.Srcs = createSrcs(modules, "{.public.stubs.source}")
344 props.Visibility = []string{"//frameworks/base"}
Colin Crossc6420762023-12-07 12:38:40 -0800345 ctx.CreateModule(android.FileGroupFactory, &props)
Anton Hansson4468d7c2022-01-14 12:10:01 +0000346}
347
Jihoon Kang31cf2742024-02-07 19:52:19 +0000348func createMergedTxts(ctx android.LoadHookContext, bootclasspath, system_server_classpath []string, baseTxtModulePrefix, stubsTypeSuffix string, doDist bool) {
Anton Hansson0860aaf2021-10-08 16:48:03 +0100349 var textFiles []MergedTxtDefinition
Anton Hansson16ff3572022-01-11 18:36:35 +0000350
Anton Hansson0860aaf2021-10-08 16:48:03 +0100351 tagSuffix := []string{".api.txt}", ".removed-api.txt}"}
Anton Hansson09a9c4e2022-04-08 10:59:46 +0100352 distFilename := []string{"android.txt", "android-removed.txt"}
Anton Hansson0860aaf2021-10-08 16:48:03 +0100353 for i, f := range []string{"current.txt", "removed.txt"} {
354 textFiles = append(textFiles, MergedTxtDefinition{
Colin Crossc6420762023-12-07 12:38:40 -0800355 TxtFilename: f,
356 DistFilename: distFilename[i],
Jihoon Kang31cf2742024-02-07 19:52:19 +0000357 BaseTxt: ":" + baseTxtModulePrefix + f,
Colin Crossc6420762023-12-07 12:38:40 -0800358 Modules: bootclasspath,
359 ModuleTag: "{.public" + tagSuffix[i],
360 Scope: "public",
Anton Hansson0860aaf2021-10-08 16:48:03 +0100361 })
362 textFiles = append(textFiles, MergedTxtDefinition{
Colin Crossc6420762023-12-07 12:38:40 -0800363 TxtFilename: f,
364 DistFilename: distFilename[i],
Jihoon Kang31cf2742024-02-07 19:52:19 +0000365 BaseTxt: ":" + baseTxtModulePrefix + "system-" + f,
Colin Crossc6420762023-12-07 12:38:40 -0800366 Modules: bootclasspath,
367 ModuleTag: "{.system" + tagSuffix[i],
368 Scope: "system",
Anton Hansson0860aaf2021-10-08 16:48:03 +0100369 })
370 textFiles = append(textFiles, MergedTxtDefinition{
Colin Crossc6420762023-12-07 12:38:40 -0800371 TxtFilename: f,
372 DistFilename: distFilename[i],
Jihoon Kang31cf2742024-02-07 19:52:19 +0000373 BaseTxt: ":" + baseTxtModulePrefix + "module-lib-" + f,
Colin Crossc6420762023-12-07 12:38:40 -0800374 Modules: bootclasspath,
375 ModuleTag: "{.module-lib" + tagSuffix[i],
376 Scope: "module-lib",
Anton Hansson0860aaf2021-10-08 16:48:03 +0100377 })
378 textFiles = append(textFiles, MergedTxtDefinition{
Colin Crossc6420762023-12-07 12:38:40 -0800379 TxtFilename: f,
380 DistFilename: distFilename[i],
Jihoon Kang31cf2742024-02-07 19:52:19 +0000381 BaseTxt: ":" + baseTxtModulePrefix + "system-server-" + f,
Colin Crossc6420762023-12-07 12:38:40 -0800382 Modules: system_server_classpath,
383 ModuleTag: "{.system-server" + tagSuffix[i],
384 Scope: "system-server",
Anton Hansson0860aaf2021-10-08 16:48:03 +0100385 })
386 }
387 for _, txt := range textFiles {
Jihoon Kang31cf2742024-02-07 19:52:19 +0000388 createMergedTxt(ctx, txt, stubsTypeSuffix, doDist)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100389 }
390}
391
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000392func createApiContributionDefaults(ctx android.LoadHookContext, modules []string) {
393 defaultsSdkKinds := []android.SdkKind{
394 android.SdkPublic, android.SdkSystem, android.SdkModule,
395 }
396 for _, sdkKind := range defaultsSdkKinds {
397 props := defaultsProps{}
398 props.Name = proptools.StringPtr(
399 sdkKind.DefaultJavaLibraryName() + "_contributions")
400 if sdkKind == android.SdkModule {
401 props.Name = proptools.StringPtr(
402 sdkKind.DefaultJavaLibraryName() + "_contributions_full")
403 }
404 props.Api_surface = proptools.StringPtr(sdkKind.String())
405 apiSuffix := ""
406 if sdkKind != android.SdkPublic {
407 apiSuffix = "." + strings.ReplaceAll(sdkKind.String(), "-", "_")
408 }
409 props.Api_contributions = transformArray(
410 modules, "", fmt.Sprintf(".stubs.source%s.api.contribution", apiSuffix))
411 props.Defaults_visibility = []string{"//visibility:public"}
Jihoon Kang471a05b2023-08-01 06:37:17 +0000412 props.Previous_api = proptools.StringPtr(":android.api.public.latest")
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000413 ctx.CreateModule(java.DefaultsFactory, &props)
414 }
415}
416
Jihoon Kang1453baa2023-05-27 05:32:30 +0000417func createFullApiLibraries(ctx android.LoadHookContext) {
418 javaLibraryNames := []string{
419 "android_stubs_current",
420 "android_system_stubs_current",
421 "android_test_stubs_current",
Mark Whitee35b1382023-08-12 01:31:26 +0000422 "android_test_frameworks_core_stubs_current",
Jihoon Kang1453baa2023-05-27 05:32:30 +0000423 "android_module_lib_stubs_current",
424 "android_system_server_stubs_current",
425 }
426
427 for _, libraryName := range javaLibraryNames {
428 props := libraryProps{}
429 props.Name = proptools.StringPtr(libraryName)
430 staticLib := libraryName + ".from-source"
431 if ctx.Config().BuildFromTextStub() {
432 staticLib = libraryName + ".from-text"
433 }
434 props.Static_libs = []string{staticLib}
435 props.Defaults = []string{"android.jar_defaults"}
436 props.Visibility = []string{"//visibility:public"}
437
438 ctx.CreateModule(java.LibraryFactory, &props)
439 }
440}
441
Jihoon Kang059b9492023-12-29 00:40:34 +0000442func createFullExportableApiLibraries(ctx android.LoadHookContext) {
443 javaLibraryNames := []string{
444 "android_stubs_current_exportable",
445 "android_system_stubs_current_exportable",
446 "android_test_stubs_current_exportable",
447 "android_module_lib_stubs_current_exportable",
448 "android_system_server_stubs_current_exportable",
449 }
450
451 for _, libraryName := range javaLibraryNames {
452 props := libraryProps{}
453 props.Name = proptools.StringPtr(libraryName)
454 staticLib := libraryName + ".from-source"
455 props.Static_libs = []string{staticLib}
456 props.Defaults = []string{"android.jar_defaults"}
457 props.Visibility = []string{"//visibility:public"}
458
459 ctx.CreateModule(java.LibraryFactory, &props)
460 }
461}
462
Anton Hansson0860aaf2021-10-08 16:48:03 +0100463func (a *CombinedApis) createInternalModules(ctx android.LoadHookContext) {
Anton Hansson07a12952022-01-12 17:28:39 +0000464 bootclasspath := a.properties.Bootclasspath
Cole Faustdcda3702022-10-04 14:46:35 -0700465 system_server_classpath := a.properties.System_server_classpath
Anton Hansson07a12952022-01-12 17:28:39 +0000466 if ctx.Config().VendorConfig("ANDROID").Bool("include_nonpublic_framework_api") {
467 bootclasspath = append(bootclasspath, a.properties.Conditional_bootclasspath...)
468 sort.Strings(bootclasspath)
469 }
Jihoon Kang31cf2742024-02-07 19:52:19 +0000470 createMergedTxts(ctx, bootclasspath, system_server_classpath, "non-updatable-", "-", false)
471 createMergedTxts(ctx, bootclasspath, system_server_classpath, "non-updatable-exportable-", "-exportable-", true)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100472
Anton Hanssonc6e9d2f2022-01-25 15:53:43 +0000473 createMergedPublicStubs(ctx, bootclasspath)
474 createMergedSystemStubs(ctx, bootclasspath)
Nikita Ioffe5593fbb2022-12-01 14:52:34 +0000475 createMergedTestStubsForNonUpdatableModules(ctx)
Anton Hansson95e89a82022-01-28 11:31:50 +0000476 createMergedFrameworkModuleLibStubs(ctx, bootclasspath)
477 createMergedFrameworkImpl(ctx, bootclasspath)
Anton Hanssoncb00f942022-01-13 09:45:12 +0000478
Jihoon Kang059b9492023-12-29 00:40:34 +0000479 createMergedPublicExportableStubs(ctx, bootclasspath)
480 createMergedSystemExportableStubs(ctx, bootclasspath)
481 createMergedTestExportableStubsForNonUpdatableModules(ctx)
482 createMergedFrameworkModuleLibExportableStubs(ctx, bootclasspath)
483
Cole Faustdcda3702022-10-04 14:46:35 -0700484 createMergedAnnotationsFilegroups(ctx, bootclasspath, system_server_classpath)
Anton Hanssoncc18e032022-01-12 14:45:22 +0000485
Anton Hansson4468d7c2022-01-14 12:10:01 +0000486 createPublicStubsSourceFilegroup(ctx, bootclasspath)
Jihoon Kang1e4ac1d2023-04-07 18:50:38 +0000487
488 createApiContributionDefaults(ctx, bootclasspath)
Jihoon Kang1453baa2023-05-27 05:32:30 +0000489
490 createFullApiLibraries(ctx)
Jihoon Kang059b9492023-12-29 00:40:34 +0000491
492 createFullExportableApiLibraries(ctx)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100493}
494
495func combinedApisModuleFactory() android.Module {
496 module := &CombinedApis{}
497 module.AddProperties(&module.properties)
498 android.InitAndroidModule(module)
Harshit Mahajanb52adbc2023-12-15 21:56:42 +0000499 android.InitDefaultableModule(module)
Anton Hansson0860aaf2021-10-08 16:48:03 +0100500 android.AddLoadHook(module, func(ctx android.LoadHookContext) { module.createInternalModules(ctx) })
501 return module
502}
Anton Hanssonfd316452022-01-14 11:15:52 +0000503
504// Various utility methods below.
505
506// Creates an array of ":<m><tag>" for each m in <modules>.
507func createSrcs(modules []string, tag string) []string {
508 return transformArray(modules, ":", tag)
509}
510
511// Creates an array of "<prefix><m><suffix>", for each m in <modules>.
512func transformArray(modules []string, prefix, suffix string) []string {
513 a := make([]string, 0, len(modules))
514 for _, module := range modules {
515 a = append(a, prefix+module+suffix)
516 }
517 return a
518}
519
520func removeAll(s []string, vs []string) []string {
521 for _, v := range vs {
522 s = remove(s, v)
523 }
524 return s
525}
526
527func remove(s []string, v string) []string {
528 s2 := make([]string, 0, len(s))
529 for _, sv := range s {
530 if sv != v {
531 s2 = append(s2, sv)
532 }
533 }
534 return s2
535}
Harshit Mahajanb52adbc2023-12-15 21:56:42 +0000536
537// Defaults
538type CombinedApisModuleDefaults struct {
539 android.ModuleBase
540 android.DefaultsModuleBase
541}
542
543func CombinedApisModuleDefaultsFactory() android.Module {
544 module := &CombinedApisModuleDefaults{}
545 module.AddProperties(&CombinedApisProperties{})
546 android.InitDefaultsModule(module)
547 return module
548}