blob: f62f2d59f03942837c16dbcd664bda96f8558314 [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//
19// The metalava conversion is done by droidstub modules *-api-stubs-docs.
20// The javac compilation is done by java_library modules android_*_stubs_current.
21// The metalava conversion is also responsible for creating API signature files
22// and comparing them against the last API signature in api/*-current.txt files
23// and also against the latest frozen API signature in prebuilts/sdk/*/*/api/android.txt
24// files.
25
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 Hansson537564e2020-03-06 17:16:06 +000044 name: "metalava-base-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",
Paul Duffin404b26a2020-09-16 14:26:47 +010050 ":art.module.public.api{.public.stubs.source}",
Paul Duffin5c89e702020-03-26 15:33:48 +000051 ":android_icu4j_public_api_files",
Ramy Medhataaa83862020-05-04 05:54:30 -040052 "**/package.html",
Jiyong Park7fb4b182019-12-20 14:35:43 +090053 ],
Chen Xu546ce5e2020-01-10 08:38:31 -080054 // TODO(b/147699819): remove below aidl includes.
55 aidl: {
56 local_include_dirs: ["telephony/java"],
57 },
Jiyong Parkc0f8a282020-09-29 13:43:00 +090058 // These are libs from framework-internal-utils that are required (i.e. being referenced)
59 // from framework-non-updatable-sources. Add more here when there's a need.
60 // DO NOT add the entire framework-internal-utils. It might cause unnecessary circular
61 // dependencies gets bigger.
62 libs: [
63 "android.hardware.cas-V1.2-java",
64 "android.hardware.health-V1.0-java-constants",
65 "android.hardware.radio-V1.5-java",
66 "android.hardware.thermal-V1.0-java-constants",
67 "android.hardware.thermal-V2.0-java",
68 "android.hardware.tv.input-V1.0-java-constants",
69 "android.hardware.tv.tuner-V1.0-java-constants",
70 "android.hardware.usb-V1.0-java-constants",
71 "android.hardware.usb-V1.1-java-constants",
72 "android.hardware.usb.gadget-V1.0-java",
73 "android.hardware.vibrator-V1.3-java",
74 "framework-protos",
75 ],
Anton Hansson35146892020-10-26 10:27:57 +000076 high_mem: true, // Lots of sources => high memory use, see b/170701554
Jiyong Park7fb4b182019-12-20 14:35:43 +090077 installable: false,
78 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +010079 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +090080 merge_annotations_dirs: [
81 "metalava-manual",
82 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070083 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090084 filter_packages: packages_to_document,
85}
86
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090087stubs_defaults {
Anton Hansson537564e2020-03-06 17:16:06 +000088 name: "metalava-full-api-stubs-default",
89 defaults: ["metalava-base-api-stubs-default"],
Anton Hanssone01390c2020-05-07 12:06:00 +010090 srcs: [
Paul Duffine55d4e32020-05-14 17:55:46 +010091 ":conscrypt.module.public.api{.public.stubs.source}",
Anton Hanssone01390c2020-05-07 12:06:00 +010092 ":framework-updatable-sources",
93 ],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090094 sdk_version: "core_platform",
95}
96
Anton Hansson537564e2020-03-06 17:16:06 +000097stubs_defaults {
98 name: "metalava-non-updatable-api-stubs-default",
99 defaults: ["metalava-base-api-stubs-default"],
Anton Hanssone53bec02020-03-20 09:12:52 +0000100 sdk_version: "core_platform",
Anton Hanssonebb26a32020-04-14 16:35:36 +0100101 // There are a few classes from modules used as type arguments that
102 // need to be resolved by metalava. For now, we can use a previously
103 // finalized stub library to resolve them. If a new class gets added,
104 // this may be need to be revisited to use a manually maintained stub
105 // library with empty classes in order to resolve those references.
Anton Hansson33ea9992020-04-09 14:16:37 +0100106 libs: ["sdk_system_30_android"],
Anton Hanssonebb26a32020-04-14 16:35:36 +0100107 aidl: {
Anton Hansson394febc2020-04-14 16:35:36 +0100108 local_include_dirs: ["apex/media/aidl/stable"],
Anton Hanssonebb26a32020-04-14 16:35:36 +0100109 },
Anton Hansson537564e2020-03-06 17:16:06 +0000110}
111
Jiyong Park7fb4b182019-12-20 14:35:43 +0900112/////////////////////////////////////////////////////////////////////
Anton Hansson51861e72020-11-13 09:55:29 +0000113// These modules provide source files for the stub libraries
Jiyong Park7fb4b182019-12-20 14:35:43 +0900114/////////////////////////////////////////////////////////////////////
115
Anton Hansson7f6823e2020-06-04 15:09:36 +0100116droidstubs {
117 name: "api-stubs-docs-non-updatable",
118 defaults: ["metalava-non-updatable-api-stubs-default"],
119 arg_files: ["core/res/AndroidManifest.xml"],
120 args: metalava_framework_docs_args,
121 check_api: {
122 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000123 api_file: "core/api/current.txt",
124 removed_api_file: "core/api/removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100125 },
Anton Hansson3258a472020-10-05 16:23:27 +0100126 last_released: {
127 api_file: ":android-non-updatable.api.public.latest",
128 removed_api_file: ":android-non-updatable-removed.api.public.latest",
129 baseline_file: ":public-api-incompatibilities-with-last-released",
130 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100131 api_lint: {
132 enabled: true,
133 new_since: ":android-non-updatable.api.public.latest",
134 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100135 },
136}
137
Anton Hansson81969c22020-02-03 20:45:56 +0000138priv_apps = " " +
139 "--show-annotation android.annotation.SystemApi\\(" +
140 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
141 "\\) "
142
143module_libs = " " +
144 " --show-annotation android.annotation.SystemApi\\(" +
145 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
Makoto Onukia13287f2020-07-10 12:05:21 -0700146 "\\)" +
147 " --show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
148 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
Anton Hansson81969c22020-02-03 20:45:56 +0000149 "\\) "
150
Jiyong Park7fb4b182019-12-20 14:35:43 +0900151droidstubs {
Anton Hansson7f6823e2020-06-04 15:09:36 +0100152 name: "system-api-stubs-docs-non-updatable",
153 defaults: ["metalava-non-updatable-api-stubs-default"],
154 arg_files: ["core/res/AndroidManifest.xml"],
155 args: metalava_framework_docs_args + priv_apps,
156 check_api: {
157 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000158 api_file: "core/api/system-current.txt",
159 removed_api_file: "core/api/system-removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100160 },
Anton Hansson3258a472020-10-05 16:23:27 +0100161 last_released: {
162 api_file: ":android-non-updatable.api.system.latest",
163 removed_api_file: ":android-non-updatable-removed.api.system.latest",
164 baseline_file: ":system-api-incompatibilities-with-last-released"
165 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100166 api_lint: {
167 enabled: true,
168 new_since: ":android-non-updatable.api.system.latest",
Anton Hansson7bfceb82020-10-29 18:59:10 +0000169 baseline_file: "core/api/system-lint-baseline.txt",
Anton Hansson33ea9992020-04-09 14:16:37 +0100170 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100171 },
172}
173
174droidstubs {
Anton Hansson552ba2c2020-11-05 10:45:13 +0000175 name: "test-api-stubs-docs-non-updatable",
Anton Hansson7110ae72020-10-15 17:23:35 +0100176 defaults: ["metalava-non-updatable-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900177 arg_files: [
178 "core/res/AndroidManifest.xml",
179 ],
Anton Hansson84ffba22020-10-09 10:13:51 +0100180 args: metalava_framework_docs_args
181 + " --show-annotation android.annotation.TestApi"
182 + " --show-for-stub-purposes-annotation android.annotation.SystemApi\\("
183 + "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS"
184 + "\\)",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900185 check_api: {
186 current: {
Anton Hansson552ba2c2020-11-05 10:45:13 +0000187 api_file: "core/api/test-current.txt",
188 removed_api_file: "core/api/test-removed.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900189 },
190 api_lint: {
191 enabled: true,
Anton Hansson552ba2c2020-11-05 10:45:13 +0000192 baseline_file: "core/api/test-lint-baseline.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900193 },
194 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000195 dist: {
196 targets: ["sdk", "win_sdk"],
197 dir: "apistubs/android/test/api",
198 dest: "android.txt",
199 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900200}
201
202/////////////////////////////////////////////////////////////////////
Anton Hansson43cc8bf2020-10-29 18:56:10 +0000203// Following droidstub module for extra APIs for modules,
Makoto Onukia13287f2020-07-10 12:05:21 -0700204// namely @SystemApi(client=MODULE_LIBRARIES) APIs.
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900205/////////////////////////////////////////////////////////////////////
206
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900207droidstubs {
Anton Hansson7f6823e2020-06-04 15:09:36 +0100208 name: "module-lib-api-stubs-docs-non-updatable",
209 defaults: ["metalava-non-updatable-api-stubs-default"],
210 arg_files: ["core/res/AndroidManifest.xml"],
Makoto Onuki8c61de62020-07-15 10:38:04 -0700211 args: metalava_framework_docs_args + priv_apps + module_libs,
Anton Hansson7f6823e2020-06-04 15:09:36 +0100212 check_api: {
213 current: {
Anton Hansson7bfceb82020-10-29 18:59:10 +0000214 api_file: "core/api/module-lib-current.txt",
215 removed_api_file: "core/api/module-lib-removed.txt",
Anton Hansson7f6823e2020-06-04 15:09:36 +0100216 },
Anton Hanssonc3ef1f562020-10-07 14:55:36 +0100217 last_released: {
218 api_file: ":android-non-updatable.api.module-lib.latest",
219 removed_api_file: ":android-non-updatable-removed.api.module-lib.latest",
220 },
Anton Hansson33ea9992020-04-09 14:16:37 +0100221 api_lint: {
222 enabled: true,
223 new_since: ":android-non-updatable.api.module-lib.latest",
224 },
Anton Hansson7f6823e2020-06-04 15:09:36 +0100225 },
226}
Anton Hansson81969c22020-02-03 20:45:56 +0000227
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900228/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900229// android_*_stubs_current modules are the stubs libraries compiled
230// from *-api-stubs-docs
231/////////////////////////////////////////////////////////////////////
232
233java_defaults {
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100234 name: "android_defaults_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000235 libs: [ "stub-annotations" ],
Paul Duffina281e922020-03-25 10:13:33 +0000236 static_libs: [
Paul Duffina281e922020-03-25 10:13:33 +0000237 // License notices from art module
238 "art-notices-for-framework-stubs-jar",
Anton Hanssoncf42e982020-08-13 19:40:13 +0100239 "framework-res-package-jar", // Export package of framework-res
Paul Duffina281e922020-03-25 10:13:33 +0000240 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900241 errorprone: {
242 javacflags: [
243 "-XepDisableAllChecks",
244 ],
245 },
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100246 sdk_version: "none",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900247 system_modules: "none",
248 java_version: "1.8",
249 compile_dex: true,
250}
251
Anton Hanssona9205502020-07-15 13:36:34 +0100252java_defaults {
253 name: "android_stubs_dists_default",
254 dist: {
255 targets: ["sdk", "win_sdk"],
256 tag: ".jar",
257 dest: "android.jar",
258 },
259}
260
Jiyong Park7fb4b182019-12-20 14:35:43 +0900261java_library_static {
Anton Hansson3a8e0362020-11-03 19:35:56 +0000262 name: "android_stubs_current",
Anton Hansson912622f2020-04-09 14:16:37 +0100263 srcs: [ ":api-stubs-docs-non-updatable" ],
264 static_libs: [
265 "conscrypt.module.public.api.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100266 "framework-media.stubs",
267 "framework-mediaprovider.stubs",
268 "framework-permission.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100269 "framework-sdkextensions.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100270 "framework-statsd.stubs",
Anton Hansson912622f2020-04-09 14:16:37 +0100271 "framework-tethering.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100272 "framework-wifi.stubs",
Anton Hansson33ea9992020-04-09 14:16:37 +0100273 "private-stub-annotations-jar",
Anton Hansson912622f2020-04-09 14:16:37 +0100274 ],
Anton Hanssonc3002e52020-11-18 18:23:55 +0000275 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900276}
277
278java_library_static {
Anton Hansson3a8e0362020-11-03 19:35:56 +0000279 name: "android_system_stubs_current",
Anton Hansson912622f2020-04-09 14:16:37 +0100280 srcs: [ ":system-api-stubs-docs-non-updatable" ],
281 static_libs: [
282 "conscrypt.module.public.api.stubs",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100283 "framework-media.stubs.system",
284 "framework-mediaprovider.stubs.system",
285 "framework-permission.stubs.system",
Anton Hansson912622f2020-04-09 14:16:37 +0100286 "framework-sdkextensions.stubs.system",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100287 "framework-statsd.stubs.system",
Anton Hansson912622f2020-04-09 14:16:37 +0100288 "framework-tethering.stubs.system",
Paul Duffinabebc6a2020-05-31 11:35:50 +0100289 "framework-wifi.stubs.system",
Anton Hansson33ea9992020-04-09 14:16:37 +0100290 "private-stub-annotations-jar",
Anton Hansson912622f2020-04-09 14:16:37 +0100291 ],
Anton Hanssonc3002e52020-11-18 18:23:55 +0000292 defaults: [
293 "android_defaults_stubs_current",
294 "android_stubs_dists_default",
295 ],
296 dist: {
297 dir: "apistubs/android/system",
298 },
299 dists: [
300 {
301 // Legacy dist path
302 targets: ["sdk", "win_sdk"],
303 tag: ".jar",
304 dest: "android_system.jar",
305 },
306 ],
Anton Hansson912622f2020-04-09 14:16:37 +0100307}
308
309java_library_static {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900310 name: "android_test_stubs_current",
Anton Hansson552ba2c2020-11-05 10:45:13 +0000311 srcs: [ ":test-api-stubs-docs-non-updatable" ],
Anton Hansson7110ae72020-10-15 17:23:35 +0100312 static_libs: [
313 // Modules do not have test APIs, but we want to include their SystemApis, like we include
314 // the SystemApi of framework-non-updatable-sources.
315 "conscrypt.module.public.api.stubs",
316 "framework-media.stubs.system",
317 "framework-mediaprovider.stubs.system",
318 "framework-permission.stubs.system",
319 "framework-sdkextensions.stubs.system",
320 "framework-statsd.stubs.system",
321 "framework-tethering.stubs.system",
322 "framework-wifi.stubs.system",
323 "private-stub-annotations-jar",
324 ],
Anton Hanssona9205502020-07-15 13:36:34 +0100325 defaults: [
326 "android_defaults_stubs_current",
327 "android_stubs_dists_default",
328 ],
329 dist: {
330 dir: "apistubs/android/test",
331 },
332 dists: [
333 {
334 // Legacy dist path
335 targets: ["sdk", "win_sdk"],
336 tag: ".jar",
337 dest: "android_test.jar",
338 },
339 ],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900340}
341
342java_library_static {
Anton Hansson9c4bbe92020-01-30 12:09:02 +0000343 name: "android_module_lib_stubs_current",
Makoto Onuki8c61de62020-07-15 10:38:04 -0700344 srcs: [ ":module-lib-api-stubs-docs-non-updatable" ],
Anton Hanssona9205502020-07-15 13:36:34 +0100345 defaults: [
346 "android_defaults_stubs_current",
347 "android_stubs_dists_default",
348 ],
Anton Hanssonebb26a32020-04-14 16:35:36 +0100349 libs: ["sdk_system_29_android"],
Anton Hanssona9205502020-07-15 13:36:34 +0100350 dist: {
351 dir: "apistubs/android/module-lib",
352 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900353}
354
Anton Hansson7f6823e2020-06-04 15:09:36 +0100355java_library_static {
356 name: "android_non_updatable_stubs_current",
357 srcs: [":api-stubs-docs-non-updatable"],
358 defaults: ["android_defaults_stubs_current"],
359 libs: ["sdk_system_29_android"],
360}
361
362java_library_static {
363 name: "android_system_non_updatable_stubs_current",
364 srcs: [":system-api-stubs-docs-non-updatable"],
365 defaults: ["android_defaults_stubs_current"],
366 libs: ["sdk_system_29_android"],
367}
368
Jiyong Park7fb4b182019-12-20 14:35:43 +0900369/////////////////////////////////////////////////////////////////////
370// hwbinder.stubs provides APIs required for building HIDL Java
371// libraries.
372/////////////////////////////////////////////////////////////////////
373
374droidstubs {
375 name: "hwbinder-stubs-docs",
376 srcs: [
377 "core/java/android/os/HidlSupport.java",
378 "core/java/android/annotation/IntDef.java",
379 "core/java/android/annotation/IntRange.java",
380 "core/java/android/annotation/NonNull.java",
381 "core/java/android/annotation/SystemApi.java",
382 "core/java/android/os/HidlMemory.java",
383 "core/java/android/os/HwBinder.java",
384 "core/java/android/os/HwBlob.java",
385 "core/java/android/os/HwParcel.java",
386 "core/java/android/os/IHwBinder.java",
387 "core/java/android/os/IHwInterface.java",
388 "core/java/android/os/DeadObjectException.java",
389 "core/java/android/os/DeadSystemException.java",
390 "core/java/android/os/NativeHandle.java",
391 "core/java/android/os/RemoteException.java",
392 "core/java/android/util/AndroidException.java",
393 ],
394 installable: false,
395 sdk_version: "core_platform",
396 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100397 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900398 merge_annotations_dirs: [
399 "metalava-manual",
400 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000401 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900402}
403
404java_library_static {
405 name: "hwbinder.stubs",
406 sdk_version: "core_current",
407 srcs: [
408 ":hwbinder-stubs-docs",
409 ],
410}