blob: 48c598fafda3d1d1cd127a5100844dfffed06cde [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 Hansson822cdb32020-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 Duffin5c89e702020-03-26 15:33:48 +000050 ":art-module-public-api-stubs-source",
Paul Duffin5c89e702020-03-26 15:33:48 +000051 ":android_icu4j_public_api_files",
Jiyong Park7fb4b182019-12-20 14:35:43 +090052 ],
Chen Xu546ce5e2020-01-10 08:38:31 -080053 // TODO(b/147699819): remove below aidl includes.
54 aidl: {
55 local_include_dirs: ["telephony/java"],
56 },
Jiyong Park7fb4b182019-12-20 14:35:43 +090057 libs: ["framework-internal-utils"],
58 installable: false,
59 annotations_enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +010060 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +090061 merge_annotations_dirs: [
62 "metalava-manual",
63 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070064 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090065 filter_packages: packages_to_document,
66}
67
Jiyong Parke3095162019-12-20 15:30:28 +090068stubs_defaults {
Anton Hansson822cdb32020-03-06 17:16:06 +000069 name: "metalava-full-api-stubs-default",
70 defaults: ["metalava-base-api-stubs-default"],
Anton Hanssone89d37d2020-05-07 12:06:00 +010071 srcs: [
72 ":conscrypt.module.public.api.stubs.source",
73 ":framework-updatable-sources",
74 ],
Jiyong Parke3095162019-12-20 15:30:28 +090075 sdk_version: "core_platform",
76}
77
Anton Hansson822cdb32020-03-06 17:16:06 +000078stubs_defaults {
79 name: "metalava-non-updatable-api-stubs-default",
80 defaults: ["metalava-base-api-stubs-default"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000081 sdk_version: "core_platform",
Anton Hansson394febc2020-04-14 16:35:36 +010082 // 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.
Anton Hansson76d3db42020-04-09 14:16:37 +010087 libs: ["sdk_system_30_android"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000088 aidl: {
Anton Hansson394febc2020-04-14 16:35:36 +010089 local_include_dirs: ["apex/media/aidl/stable"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000090 },
Anton Hansson822cdb32020-03-06 17:16:06 +000091}
92
Jiyong Park7fb4b182019-12-20 14:35:43 +090093/////////////////////////////////////////////////////////////////////
94// *-api-stubs-docs modules providing source files for the stub libraries
95/////////////////////////////////////////////////////////////////////
96
Jiyong Parke3095162019-12-20 15:30:28 +090097// api-stubs-docs, system-api-stubs-docs, and test-api-stubs-docs have APIs
98// from the non-updatable part of the platform as well as from the updatable
99// modules
Jiyong Park7fb4b182019-12-20 14:35:43 +0900100droidstubs {
101 name: "api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000102 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +0000103 removed_dex_api_filename: "removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900104 arg_files: [
105 "core/res/AndroidManifest.xml",
106 ],
107 args: metalava_framework_docs_args,
108 check_api: {
109 current: {
110 api_file: "api/current.txt",
111 removed_api_file: "api/removed.txt",
112 },
113 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100114 api_file: ":android.api.public.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100115 removed_api_file: ":removed.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900116 baseline_file: ":public-api-incompatibilities-with-last-released",
117 },
118 api_lint: {
119 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100120 new_since: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900121 baseline_file: "api/lint-baseline.txt",
122 },
123 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000124 dist: {
125 targets: ["sdk", "win_sdk"],
126 dir: "apistubs/android/public/api",
127 dest: "android.txt",
128 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900129 jdiff_enabled: true,
130}
131
Anton Hansson76d3db42020-04-09 14:16:37 +0100132droidstubs {
133 name: "api-stubs-docs-non-updatable",
134 defaults: ["metalava-non-updatable-api-stubs-default"],
135 arg_files: ["core/res/AndroidManifest.xml"],
136 args: metalava_framework_docs_args,
137 check_api: {
138 current: {
139 api_file: "non-updatable-api/current.txt",
140 removed_api_file: "non-updatable-api/removed.txt",
141 },
142 api_lint: {
143 enabled: true,
144 new_since: ":android-non-updatable.api.public.latest",
145 },
146 },
147}
148
Anton Hansson81969c22020-02-03 20:45:56 +0000149priv_apps = " " +
150 "--show-annotation android.annotation.SystemApi\\(" +
151 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
152 "\\) "
153
154module_libs = " " +
155 " --show-annotation android.annotation.SystemApi\\(" +
156 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
157 "\\) "
158
Jiyong Park7fb4b182019-12-20 14:35:43 +0900159droidstubs {
160 name: "system-api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000161 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +0000162 removed_dex_api_filename: "system-removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900163 arg_files: [
164 "core/res/AndroidManifest.xml",
165 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000166 args: metalava_framework_docs_args + priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900167 check_api: {
168 current: {
169 api_file: "api/system-current.txt",
170 removed_api_file: "api/system-removed.txt",
171 },
172 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100173 api_file: ":android.api.system.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100174 removed_api_file: ":removed.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900175 baseline_file: ":system-api-incompatibilities-with-last-released"
176 },
177 api_lint: {
178 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100179 new_since: ":android.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900180 baseline_file: "api/system-lint-baseline.txt",
181 },
182 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000183 dist: {
184 targets: ["sdk", "win_sdk"],
185 dir: "apistubs/android/system/api",
186 dest: "android.txt",
187 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900188 jdiff_enabled: true,
189}
190
191droidstubs {
Anton Hansson76d3db42020-04-09 14:16:37 +0100192 name: "system-api-stubs-docs-non-updatable",
193 defaults: ["metalava-non-updatable-api-stubs-default"],
194 arg_files: ["core/res/AndroidManifest.xml"],
195 args: metalava_framework_docs_args + priv_apps,
196 check_api: {
197 current: {
198 api_file: "non-updatable-api/system-current.txt",
199 removed_api_file: "non-updatable-api/system-removed.txt",
200 },
201 api_lint: {
202 enabled: true,
203 new_since: ":android-non-updatable.api.system.latest",
204 baseline_file: "non-updatable-api/system-lint-baseline.txt",
205 },
206 },
207}
208
209droidstubs {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900210 name: "test-api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000211 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900212 arg_files: [
213 "core/res/AndroidManifest.xml",
214 ],
215 args: metalava_framework_docs_args + " --show-annotation android.annotation.TestApi",
216 check_api: {
217 current: {
218 api_file: "api/test-current.txt",
219 removed_api_file: "api/test-removed.txt",
220 },
221 api_lint: {
222 enabled: true,
223 baseline_file: "api/test-lint-baseline.txt",
224 },
225 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000226 dist: {
227 targets: ["sdk", "win_sdk"],
228 dir: "apistubs/android/test/api",
229 dest: "android.txt",
230 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900231}
232
233/////////////////////////////////////////////////////////////////////
Jiyong Parke3095162019-12-20 15:30:28 +0900234// Following droidstubs modules are for extra APIs for modules.
235// The framework currently have two more API surfaces for modules:
236// @SystemApi(client=MODULE_APPS) and @SystemApi(client=MODULE_LIBRARIES)
237/////////////////////////////////////////////////////////////////////
238
Anton Hansson81969c22020-02-03 20:45:56 +0000239// TODO(b/146727827) remove the *-api module when we can teach metalava
Jiyong Parke3095162019-12-20 15:30:28 +0900240// about the relationship among the API surfaces. Currently, these modules are only to generate
241// the API signature files and ensure that the APIs evolve in a backwards compatible manner.
242// They however are NOT used for building the API stub.
Jiyong Parke3095162019-12-20 15:30:28 +0900243
244droidstubs {
245 name: "module-lib-api",
Anton Hansson822cdb32020-03-06 17:16:06 +0000246 defaults: ["metalava-full-api-stubs-default"],
Jiyong Parke3095162019-12-20 15:30:28 +0900247 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000248 args: metalava_framework_docs_args + module_libs,
Paul Duffin4c5dc182020-04-08 18:28:15 +0100249
250 // Do not generate stubs as they are not needed
251 generate_stubs: false,
252
Jiyong Parke3095162019-12-20 15:30:28 +0900253 check_api: {
254 current: {
255 api_file: "api/module-lib-current.txt",
256 removed_api_file: "api/module-lib-removed.txt",
257 },
Anton Hansson79e35c32020-02-11 14:36:40 +0000258 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100259 api_file: ":android.api.module-lib.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100260 removed_api_file: ":removed.api.module-lib.latest",
Anton Hansson79e35c32020-02-11 14:36:40 +0000261 baseline_file: ":module-lib-api-incompatibilities-with-last-released"
262 },
263 api_lint: {
264 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100265 new_since: ":android.api.module-lib.latest",
Anton Hansson79e35c32020-02-11 14:36:40 +0000266 baseline_file: "api/module-lib-lint-baseline.txt",
267 },
Jiyong Parke3095162019-12-20 15:30:28 +0900268 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000269 dist: {
270 targets: ["sdk", "win_sdk"],
271 dir: "apistubs/android/module-lib/api",
272 dest: "android.txt",
273 },
Jiyong Parke3095162019-12-20 15:30:28 +0900274}
275
Anton Hansson76d3db42020-04-09 14:16:37 +0100276droidstubs {
277 name: "module-lib-api-stubs-docs-non-updatable",
278 defaults: ["metalava-non-updatable-api-stubs-default"],
279 arg_files: ["core/res/AndroidManifest.xml"],
280 args: metalava_framework_docs_args + module_libs,
281 check_api: {
282 current: {
283 api_file: "non-updatable-api/module-lib-current.txt",
284 removed_api_file: "non-updatable-api/module-lib-removed.txt",
285 },
286 api_lint: {
287 enabled: true,
288 new_since: ":android-non-updatable.api.module-lib.latest",
289 },
290 },
291}
Anton Hansson81969c22020-02-03 20:45:56 +0000292
293// The following droidstub module generates source files for the API stub library for
294// modules. Note that it not only includes its own APIs but also other APIs that have
295// narrower scope (all @SystemApis, not just the ones with 'client=MODULE_LIBRARIES').
Jiyong Parke3095162019-12-20 15:30:28 +0900296
297droidstubs {
298 name: "module-lib-api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000299 defaults: ["metalava-non-updatable-api-stubs-default"],
Jiyong Parke3095162019-12-20 15:30:28 +0900300 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000301 args: metalava_framework_docs_args + priv_apps + module_libs,
Jiyong Parke3095162019-12-20 15:30:28 +0900302}
303
304/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900305// android_*_stubs_current modules are the stubs libraries compiled
306// from *-api-stubs-docs
307/////////////////////////////////////////////////////////////////////
308
309java_defaults {
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100310 name: "android_defaults_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000311 libs: [ "stub-annotations" ],
Paul Duffina281e922020-03-25 10:13:33 +0000312 static_libs: [
Paul Duffina281e922020-03-25 10:13:33 +0000313 // License notices from art module
314 "art-notices-for-framework-stubs-jar",
315 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900316 errorprone: {
317 javacflags: [
318 "-XepDisableAllChecks",
319 ],
320 },
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100321 sdk_version: "none",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900322 system_modules: "none",
323 java_version: "1.8",
324 compile_dex: true,
325}
326
327java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100328 name: "android_monolith_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000329 srcs: [ ":api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100330 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100331 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900332}
333
334java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100335 name: "android_merged_stubs_current",
336 srcs: [ ":api-stubs-docs-non-updatable" ],
337 static_libs: [
338 "conscrypt.module.public.api.stubs",
339 "framework-graphics-stubs-publicapi",
340 "framework-media-stubs-publicapi",
341 "framework-mediaprovider-stubs-publicapi",
342 "framework-permission-stubs-publicapi",
343 "framework-sdkextensions-stubs-publicapi",
344 "framework-statsd-stubs-publicapi",
345 "framework-tethering-stubs-publicapi",
346 "framework-wifi-stubs-publicapi",
Anton Hanssonbf63f942020-05-20 12:06:23 +0100347 "private-stub-annotations-jar",
Anton Hansson76d3db42020-04-09 14:16:37 +0100348 ],
349 defaults: ["android_defaults_stubs_current"],
350}
351
352java_library_static {
353 name: "android_stubs_current",
354 static_libs: ["android_merged_stubs_current"],
355 defaults: ["android_defaults_stubs_current"],
356}
357
358java_library_static {
359 name: "android_system_monolith_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000360 srcs: [ ":system-api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100361 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100362 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900363}
364
365java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100366 name: "android_system_merged_stubs_current",
367 srcs: [ ":system-api-stubs-docs-non-updatable" ],
368 static_libs: [
369 "conscrypt.module.public.api.stubs",
370 "framework-appsearch-stubs", // TODO: standardize appsearch stubs
371 "framework-graphics-stubs-systemapi",
372 "framework-media-stubs-systemapi",
373 "framework-mediaprovider-stubs-systemapi",
374 "framework-permission-stubs-systemapi",
375 "framework-sdkextensions-stubs-systemapi",
376 "framework-statsd-stubs-systemapi",
377 "framework-tethering-stubs-systemapi",
378 "framework-wifi-stubs-systemapi",
Anton Hanssonbf63f942020-05-20 12:06:23 +0100379 "private-stub-annotations-jar",
Anton Hansson76d3db42020-04-09 14:16:37 +0100380 ],
381 defaults: ["android_defaults_stubs_current"],
382}
383
384java_library_static {
385 name: "android_system_stubs_current",
386 static_libs: ["android_system_merged_stubs_current"],
387 defaults: ["android_defaults_stubs_current"],
388}
389
390java_library_static {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900391 name: "android_test_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000392 srcs: [ ":test-api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100393 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100394 defaults: ["android_defaults_stubs_current"],
Jiyong Parke3095162019-12-20 15:30:28 +0900395}
396
397java_library_static {
Anton Hansson1b9cf092020-01-30 12:09:02 +0000398 name: "android_module_lib_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000399 srcs: [ ":module-lib-api-stubs-docs" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100400 defaults: ["android_defaults_stubs_current"],
Anton Hansson394febc2020-04-14 16:35:36 +0100401 libs: ["sdk_system_29_android"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900402}
403
Anton Hansson76d3db42020-04-09 14:16:37 +0100404java_library_static {
405 name: "android_non_updatable_stubs_current",
406 srcs: [":api-stubs-docs-non-updatable"],
407 defaults: ["android_defaults_stubs_current"],
408 libs: ["sdk_system_29_android"],
409}
410
411java_library_static {
412 name: "android_system_non_updatable_stubs_current",
413 srcs: [":system-api-stubs-docs-non-updatable"],
414 defaults: ["android_defaults_stubs_current"],
415 libs: ["sdk_system_29_android"],
416}
417
Jiyong Park7fb4b182019-12-20 14:35:43 +0900418/////////////////////////////////////////////////////////////////////
419// hwbinder.stubs provides APIs required for building HIDL Java
420// libraries.
421/////////////////////////////////////////////////////////////////////
422
423droidstubs {
424 name: "hwbinder-stubs-docs",
425 srcs: [
426 "core/java/android/os/HidlSupport.java",
427 "core/java/android/annotation/IntDef.java",
428 "core/java/android/annotation/IntRange.java",
429 "core/java/android/annotation/NonNull.java",
430 "core/java/android/annotation/SystemApi.java",
431 "core/java/android/os/HidlMemory.java",
432 "core/java/android/os/HwBinder.java",
433 "core/java/android/os/HwBlob.java",
434 "core/java/android/os/HwParcel.java",
435 "core/java/android/os/IHwBinder.java",
436 "core/java/android/os/IHwInterface.java",
437 "core/java/android/os/DeadObjectException.java",
438 "core/java/android/os/DeadSystemException.java",
439 "core/java/android/os/NativeHandle.java",
440 "core/java/android/os/RemoteException.java",
441 "core/java/android/util/AndroidException.java",
442 ],
443 installable: false,
444 sdk_version: "core_platform",
445 annotations_enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100446 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900447 merge_annotations_dirs: [
448 "metalava-manual",
449 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000450 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900451}
452
453java_library_static {
454 name: "hwbinder.stubs",
455 sdk_version: "core_current",
456 srcs: [
457 ":hwbinder-stubs-docs",
458 ],
459}
460
461/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900462// api/*-current.txt files for use by modules in other directories
463// like the CTS test
464/////////////////////////////////////////////////////////////////////
465
466filegroup {
467 name: "frameworks-base-api-current.txt",
468 srcs: [
469 "api/current.txt",
470 ],
471}
472
473filegroup {
474 name: "frameworks-base-api-system-current.txt",
475 srcs: [
476 "api/system-current.txt",
477 ],
478}
479
480filegroup {
481 name: "frameworks-base-api-system-removed.txt",
482 srcs: [
483 "api/system-removed.txt",
484 ],
485}