blob: ed8781e2ff86689b5bd275f2423b0ce92a67cd5b [file] [log] [blame]
Jiyong Park7fb4b182019-12-20 14:35:43 +09001// Copyright (C) 2019 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
15// How stubs are generated:
16//
17// raw source files --(metalava)--> stub source files --(javac)--> stub jar files
18//
Anton Hansson1c58ffc2020-11-13 11:44:32 +000019// - The metalava conversion is done by droidstub modules
20// - The javac compilation is done by java_library modules
21//
Jiyong Park7fb4b182019-12-20 14:35:43 +090022// The metalava conversion is also responsible for creating API signature files
Anton Hansson1c58ffc2020-11-13 11:44:32 +000023// and comparing them against the checked in API signature, and also checking compatibility
24// with the latest frozen API signature.
Jiyong Park7fb4b182019-12-20 14:35:43 +090025
26/////////////////////////////////////////////////////////////////////
27// Common metalava configs
28/////////////////////////////////////////////////////////////////////
29
30packages_to_document = [
31 "android",
32 "dalvik",
33 "java",
34 "javax",
35 "junit",
36 "org.apache.http",
37 "org.json",
38 "org.w3c.dom",
39 "org.xml.sax",
40 "org.xmlpull",
41]
42
43stubs_defaults {
Anton Hansson1c58ffc2020-11-13 11:44:32 +000044 name: "metalava-non-updatable-api-stubs-default",
Jiyong Park7fb4b182019-12-20 14:35:43 +090045 srcs: [
46 ":framework-non-updatable-sources",
Jiyong Park7fb4b182019-12-20 14:35:43 +090047 "core/java/**/*.logtags",
48 ":opt-telephony-srcs",
49 ":opt-net-voip-srcs",
Ramy Medhataaa83862020-05-04 05:54:30 -040050 "**/package.html",
Jiyong Park7fb4b182019-12-20 14:35:43 +090051 ],
Anton Hansson121ccbc2020-12-17 14:56:06 +000052 sdk_version: "none",
53 system_modules: "none",
54 java_version: "1.8",
Anton Hansson1c58ffc2020-11-13 11:44:32 +000055 arg_files: ["core/res/AndroidManifest.xml"],
Chen Xu546ce5e2020-01-10 08:38:31 -080056 // TODO(b/147699819): remove below aidl includes.
57 aidl: {
Anton Hansson1c58ffc2020-11-13 11:44:32 +000058 local_include_dirs: [
59 "apex/media/aidl/stable",
60 "telephony/java",
61 ],
Chen Xu546ce5e2020-01-10 08:38:31 -080062 },
Jiyong Parkc0f8a282020-09-29 13:43:00 +090063 // These are libs from framework-internal-utils that are required (i.e. being referenced)
64 // from framework-non-updatable-sources. Add more here when there's a need.
65 // DO NOT add the entire framework-internal-utils. It might cause unnecessary circular
66 // dependencies gets bigger.
67 libs: [
68 "android.hardware.cas-V1.2-java",
69 "android.hardware.health-V1.0-java-constants",
70 "android.hardware.radio-V1.5-java",
Jayachandran C0f14f812020-08-10 10:58:23 -070071 "android.hardware.radio-V1.6-java",
Jiyong Parkc0f8a282020-09-29 13:43:00 +090072 "android.hardware.thermal-V1.0-java-constants",
73 "android.hardware.thermal-V2.0-java",
74 "android.hardware.tv.input-V1.0-java-constants",
75 "android.hardware.tv.tuner-V1.0-java-constants",
76 "android.hardware.usb-V1.0-java-constants",
77 "android.hardware.usb-V1.1-java-constants",
78 "android.hardware.usb.gadget-V1.0-java",
79 "android.hardware.vibrator-V1.3-java",
80 "framework-protos",
Anton Hansson121ccbc2020-12-17 14:56:06 +000081 "stable.core.platform.api.stubs",
Anton Hansson1c58ffc2020-11-13 11:44:32 +000082 // There are a few classes from modules used as type arguments that
83 // need to be resolved by metalava. For now, we can use a previously
84 // finalized stub library to resolve them. If a new class gets added,
85 // this may be need to be revisited to use a manually maintained stub
86 // library with empty classes in order to resolve those references.
87 "sdk_system_30_android",
Jiyong Parkc0f8a282020-09-29 13:43:00 +090088 ],
Anton Hansson35146892020-10-26 10:27:57 +000089 high_mem: true, // Lots of sources => high memory use, see b/170701554
Jiyong Park7fb4b182019-12-20 14:35:43 +090090 installable: false,
91 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +010092 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +090093 merge_annotations_dirs: [
94 "metalava-manual",
95 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070096 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090097 filter_packages: packages_to_document,
98}
99
100/////////////////////////////////////////////////////////////////////
Anton Hansson51861e72020-11-13 09:55:29 +0000101// These modules provide source files for the stub libraries
Jiyong Park7fb4b182019-12-20 14:35:43 +0900102/////////////////////////////////////////////////////////////////////
103
Anton Hansson7f6823e2020-06-04 15:09:36 +0100104droidstubs {
105 name: "api-stubs-docs-non-updatable",
106 defaults: ["metalava-non-updatable-api-stubs-default"],
Anton Hansson7f6823e2020-06-04 15:09:36 +0100107 args: metalava_framework_docs_args,
108 check_api: {
109 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000110 api_file: "core/api/current.txt",
111 removed_api_file: "core/api/removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100112 },
Anton Hansson3258a472020-10-05 16:23:27 +0100113 last_released: {
114 api_file: ":android-non-updatable.api.public.latest",
115 removed_api_file: ":android-non-updatable-removed.api.public.latest",
116 baseline_file: ":public-api-incompatibilities-with-last-released",
117 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100118 api_lint: {
119 enabled: true,
120 new_since: ":android-non-updatable.api.public.latest",
121 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100122 },
123}
124
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000125priv_apps =
Anton Hansson81969c22020-02-03 20:45:56 +0000126 " --show-annotation android.annotation.SystemApi\\(" +
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000127 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
128 "\\)"
129
130priv_apps_in_stubs =
Makoto Onukia13287f2020-07-10 12:05:21 -0700131 " --show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
132 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000133 "\\)"
134
135test = " --show-annotation android.annotation.TestApi"
136
137module_libs =
138 " --show-annotation android.annotation.SystemApi\\(" +
139 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
140 "\\)"
Anton Hansson81969c22020-02-03 20:45:56 +0000141
Jiyong Park7fb4b182019-12-20 14:35:43 +0900142droidstubs {
Anton Hansson7f6823e2020-06-04 15:09:36 +0100143 name: "system-api-stubs-docs-non-updatable",
144 defaults: ["metalava-non-updatable-api-stubs-default"],
Anton Hansson7f6823e2020-06-04 15:09:36 +0100145 args: metalava_framework_docs_args + priv_apps,
146 check_api: {
147 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000148 api_file: "core/api/system-current.txt",
149 removed_api_file: "core/api/system-removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100150 },
Anton Hansson3258a472020-10-05 16:23:27 +0100151 last_released: {
152 api_file: ":android-non-updatable.api.system.latest",
153 removed_api_file: ":android-non-updatable-removed.api.system.latest",
154 baseline_file: ":system-api-incompatibilities-with-last-released"
155 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100156 api_lint: {
157 enabled: true,
158 new_since: ":android-non-updatable.api.system.latest",
Anton Hansson7bfceb82020-10-29 18:59:10 +0000159 baseline_file: "core/api/system-lint-baseline.txt",
Anton Hansson33ea9992020-04-09 14:16:37 +0100160 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100161 },
162}
163
164droidstubs {
Anton Hansson552ba2c2020-11-05 10:45:13 +0000165 name: "test-api-stubs-docs-non-updatable",
Anton Hansson7110ae72020-10-15 17:23:35 +0100166 defaults: ["metalava-non-updatable-api-stubs-default"],
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000167 args: metalava_framework_docs_args + test + priv_apps_in_stubs,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900168 check_api: {
169 current: {
Anton Hansson552ba2c2020-11-05 10:45:13 +0000170 api_file: "core/api/test-current.txt",
171 removed_api_file: "core/api/test-removed.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900172 },
173 api_lint: {
174 enabled: true,
Anton Hansson552ba2c2020-11-05 10:45:13 +0000175 baseline_file: "core/api/test-lint-baseline.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900176 },
177 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000178 dist: {
179 targets: ["sdk", "win_sdk"],
180 dir: "apistubs/android/test/api",
181 dest: "android.txt",
182 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900183}
184
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900185droidstubs {
Anton Hansson7f6823e2020-06-04 15:09:36 +0100186 name: "module-lib-api-stubs-docs-non-updatable",
187 defaults: ["metalava-non-updatable-api-stubs-default"],
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000188 args: metalava_framework_docs_args + priv_apps_in_stubs + module_libs,
Anton Hansson7f6823e2020-06-04 15:09:36 +0100189 check_api: {
190 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000191 api_file: "core/api/module-lib-current.txt",
192 removed_api_file: "core/api/module-lib-removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100193 },
Anton Hanssonc3ef1f562020-10-07 14:55:36 +0100194 last_released: {
195 api_file: ":android-non-updatable.api.module-lib.latest",
196 removed_api_file: ":android-non-updatable-removed.api.module-lib.latest",
197 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100198 api_lint: {
199 enabled: true,
200 new_since: ":android-non-updatable.api.module-lib.latest",
201 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100202 },
203}
Anton Hansson81969c22020-02-03 20:45:56 +0000204
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900205/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900206// android_*_stubs_current modules are the stubs libraries compiled
Anton Hansson1c58ffc2020-11-13 11:44:32 +0000207// from stub sources
Jiyong Park7fb4b182019-12-20 14:35:43 +0900208/////////////////////////////////////////////////////////////////////
209
210java_defaults {
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100211 name: "android_defaults_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000212 libs: [ "stub-annotations" ],
Paul Duffina281e922020-03-25 10:13:33 +0000213 static_libs: [
Paul Duffina281e922020-03-25 10:13:33 +0000214 // License notices from art module
215 "art-notices-for-framework-stubs-jar",
Anton Hanssoncf42e982020-08-13 19:40:13 +0100216 "framework-res-package-jar", // Export package of framework-res
Paul Duffina281e922020-03-25 10:13:33 +0000217 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900218 errorprone: {
219 javacflags: [
220 "-XepDisableAllChecks",
221 ],
222 },
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100223 sdk_version: "none",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900224 system_modules: "none",
225 java_version: "1.8",
226 compile_dex: true,
227}
228
Anton Hanssona9205502020-07-15 13:36:34 +0100229java_defaults {
230 name: "android_stubs_dists_default",
231 dist: {
232 targets: ["sdk", "win_sdk"],
233 tag: ".jar",
234 dest: "android.jar",
235 },
236}
237
Jiyong Park7fb4b182019-12-20 14:35:43 +0900238java_library_static {
Anton Hansson3a8e0362020-11-03 19:35:56 +0000239 name: "android_stubs_current",
Anton Hansson912622f2020-04-09 14:16:37 +0100240 srcs: [ ":api-stubs-docs-non-updatable" ],
241 static_libs: [
Anton Hanssonfc948d862020-12-17 16:57:35 +0000242 "art.module.public.api.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100243 "conscrypt.module.public.api.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100244 "framework-media.stubs",
245 "framework-mediaprovider.stubs",
246 "framework-permission.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100247 "framework-sdkextensions.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100248 "framework-statsd.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100249 "framework-tethering.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100250 "framework-wifi.stubs",
Paul Duffin5a4e8f22020-11-25 15:45:43 +0000251 "i18n.module.public.api.stubs",
Anton Hansson33ea9992020-04-09 14:16:37 +0100252 "private-stub-annotations-jar",
Anton Hansson912622f2020-04-09 14:16:37 +0100253 ],
Anton Hanssonc3002e52020-11-18 18:23:55 +0000254 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900255}
256
257java_library_static {
Anton Hansson3a8e0362020-11-03 19:35:56 +0000258 name: "android_system_stubs_current",
Anton Hansson912622f2020-04-09 14:16:37 +0100259 srcs: [ ":system-api-stubs-docs-non-updatable" ],
260 static_libs: [
Anton Hanssonfc948d862020-12-17 16:57:35 +0000261 "art.module.public.api.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100262 "conscrypt.module.public.api.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100263 "framework-media.stubs.system",
264 "framework-mediaprovider.stubs.system",
265 "framework-permission.stubs.system",
Anton Hansson912622f2020-04-09 14:16:37 +0100266 "framework-sdkextensions.stubs.system",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100267 "framework-statsd.stubs.system",
Anton Hansson912622f2020-04-09 14:16:37 +0100268 "framework-tethering.stubs.system",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100269 "framework-wifi.stubs.system",
Paul Duffin5a4e8f22020-11-25 15:45:43 +0000270 "i18n.module.public.api.stubs",
Anton Hansson33ea9992020-04-09 14:16:37 +0100271 "private-stub-annotations-jar",
Anton Hansson912622f2020-04-09 14:16:37 +0100272 ],
Anton Hanssonc3002e52020-11-18 18:23:55 +0000273 defaults: [
274 "android_defaults_stubs_current",
275 "android_stubs_dists_default",
276 ],
277 dist: {
278 dir: "apistubs/android/system",
279 },
280 dists: [
281 {
282 // Legacy dist path
283 targets: ["sdk", "win_sdk"],
284 tag: ".jar",
285 dest: "android_system.jar",
286 },
287 ],
Anton Hansson912622f2020-04-09 14:16:37 +0100288}
289
290java_library_static {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900291 name: "android_test_stubs_current",
Anton Hansson552ba2c2020-11-05 10:45:13 +0000292 srcs: [ ":test-api-stubs-docs-non-updatable" ],
Anton Hansson7110ae72020-10-15 17:23:35 +0100293 static_libs: [
294 // Modules do not have test APIs, but we want to include their SystemApis, like we include
295 // the SystemApi of framework-non-updatable-sources.
Anton Hanssonfc948d862020-12-17 16:57:35 +0000296 "art.module.public.api.stubs",
Anton Hansson7110ae72020-10-15 17:23:35 +0100297 "conscrypt.module.public.api.stubs",
298 "framework-media.stubs.system",
299 "framework-mediaprovider.stubs.system",
300 "framework-permission.stubs.system",
301 "framework-sdkextensions.stubs.system",
302 "framework-statsd.stubs.system",
303 "framework-tethering.stubs.system",
304 "framework-wifi.stubs.system",
Paul Duffin5a4e8f22020-11-25 15:45:43 +0000305 "i18n.module.public.api.stubs",
Anton Hansson7110ae72020-10-15 17:23:35 +0100306 "private-stub-annotations-jar",
307 ],
Anton Hanssona9205502020-07-15 13:36:34 +0100308 defaults: [
309 "android_defaults_stubs_current",
310 "android_stubs_dists_default",
311 ],
312 dist: {
313 dir: "apistubs/android/test",
314 },
315 dists: [
316 {
317 // Legacy dist path
318 targets: ["sdk", "win_sdk"],
319 tag: ".jar",
320 dest: "android_test.jar",
321 },
322 ],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900323}
324
325java_library_static {
Anton Hansson9c4bbe92020-01-30 12:09:02 +0000326 name: "android_module_lib_stubs_current",
Makoto Onuki8c61de62020-07-15 10:38:04 -0700327 srcs: [ ":module-lib-api-stubs-docs-non-updatable" ],
Anton Hanssona9205502020-07-15 13:36:34 +0100328 defaults: [
329 "android_defaults_stubs_current",
330 "android_stubs_dists_default",
331 ],
Anton Hanssonebb26a32020-04-14 16:35:36 +0100332 libs: ["sdk_system_29_android"],
Anton Hanssonfc948d862020-12-17 16:57:35 +0000333 static_libs: ["art.module.public.api.stubs"],
Anton Hanssona9205502020-07-15 13:36:34 +0100334 dist: {
335 dir: "apistubs/android/module-lib",
336 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900337}
338
Jiyong Park7fb4b182019-12-20 14:35:43 +0900339/////////////////////////////////////////////////////////////////////
340// hwbinder.stubs provides APIs required for building HIDL Java
341// libraries.
342/////////////////////////////////////////////////////////////////////
343
344droidstubs {
345 name: "hwbinder-stubs-docs",
346 srcs: [
347 "core/java/android/os/HidlSupport.java",
348 "core/java/android/annotation/IntDef.java",
349 "core/java/android/annotation/IntRange.java",
350 "core/java/android/annotation/NonNull.java",
351 "core/java/android/annotation/SystemApi.java",
352 "core/java/android/os/HidlMemory.java",
353 "core/java/android/os/HwBinder.java",
354 "core/java/android/os/HwBlob.java",
355 "core/java/android/os/HwParcel.java",
356 "core/java/android/os/IHwBinder.java",
357 "core/java/android/os/IHwInterface.java",
358 "core/java/android/os/DeadObjectException.java",
359 "core/java/android/os/DeadSystemException.java",
360 "core/java/android/os/NativeHandle.java",
361 "core/java/android/os/RemoteException.java",
362 "core/java/android/util/AndroidException.java",
363 ],
364 installable: false,
365 sdk_version: "core_platform",
366 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100367 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900368 merge_annotations_dirs: [
369 "metalava-manual",
370 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000371 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900372}
373
374java_library_static {
375 name: "hwbinder.stubs",
376 sdk_version: "core_current",
377 srcs: [
378 ":hwbinder-stubs-docs",
379 ],
380}