blob: 2bd5aee0cd24ba3d8e77865afdfa8534a6d36022 [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",
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 Park7fb4b182019-12-20 14:35:43 +090058 libs: ["framework-internal-utils"],
59 installable: false,
60 annotations_enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +010061 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +090062 merge_annotations_dirs: [
63 "metalava-manual",
64 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070065 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090066 filter_packages: packages_to_document,
67}
68
Jiyong Parke3095162019-12-20 15:30:28 +090069stubs_defaults {
Anton Hansson822cdb32020-03-06 17:16:06 +000070 name: "metalava-full-api-stubs-default",
71 defaults: ["metalava-base-api-stubs-default"],
Anton Hanssone89d37d2020-05-07 12:06:00 +010072 srcs: [
Paul Duffine55d4e32020-05-14 17:55:46 +010073 ":conscrypt.module.public.api{.public.stubs.source}",
Anton Hanssone89d37d2020-05-07 12:06:00 +010074 ":framework-updatable-sources",
75 ],
Jiyong Parke3095162019-12-20 15:30:28 +090076 sdk_version: "core_platform",
77}
78
Anton Hansson822cdb32020-03-06 17:16:06 +000079stubs_defaults {
80 name: "metalava-non-updatable-api-stubs-default",
81 defaults: ["metalava-base-api-stubs-default"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000082 sdk_version: "core_platform",
Anton Hansson394febc2020-04-14 16:35:36 +010083 // There are a few classes from modules used as type arguments that
84 // need to be resolved by metalava. For now, we can use a previously
85 // finalized stub library to resolve them. If a new class gets added,
86 // this may be need to be revisited to use a manually maintained stub
87 // library with empty classes in order to resolve those references.
Anton Hansson76d3db42020-04-09 14:16:37 +010088 libs: ["sdk_system_30_android"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000089 aidl: {
Anton Hansson394febc2020-04-14 16:35:36 +010090 local_include_dirs: ["apex/media/aidl/stable"],
Anton Hansson92d79fd2020-03-20 09:12:52 +000091 },
Anton Hansson822cdb32020-03-06 17:16:06 +000092}
93
Jiyong Park7fb4b182019-12-20 14:35:43 +090094/////////////////////////////////////////////////////////////////////
95// *-api-stubs-docs modules providing source files for the stub libraries
96/////////////////////////////////////////////////////////////////////
97
Jiyong Parke3095162019-12-20 15:30:28 +090098// api-stubs-docs, system-api-stubs-docs, and test-api-stubs-docs have APIs
99// from the non-updatable part of the platform as well as from the updatable
100// modules
Jiyong Park7fb4b182019-12-20 14:35:43 +0900101droidstubs {
102 name: "api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000103 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +0000104 removed_dex_api_filename: "removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900105 arg_files: [
106 "core/res/AndroidManifest.xml",
107 ],
108 args: metalava_framework_docs_args,
109 check_api: {
110 current: {
111 api_file: "api/current.txt",
112 removed_api_file: "api/removed.txt",
113 },
114 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100115 api_file: ":android.api.public.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100116 removed_api_file: ":removed.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900117 baseline_file: ":public-api-incompatibilities-with-last-released",
118 },
119 api_lint: {
120 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100121 new_since: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900122 baseline_file: "api/lint-baseline.txt",
123 },
124 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000125 dist: {
126 targets: ["sdk", "win_sdk"],
127 dir: "apistubs/android/public/api",
128 dest: "android.txt",
129 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900130 jdiff_enabled: true,
131}
132
Anton Hansson76d3db42020-04-09 14:16:37 +0100133droidstubs {
134 name: "api-stubs-docs-non-updatable",
135 defaults: ["metalava-non-updatable-api-stubs-default"],
136 arg_files: ["core/res/AndroidManifest.xml"],
137 args: metalava_framework_docs_args,
138 check_api: {
139 current: {
140 api_file: "non-updatable-api/current.txt",
141 removed_api_file: "non-updatable-api/removed.txt",
142 },
143 api_lint: {
144 enabled: true,
145 new_since: ":android-non-updatable.api.public.latest",
146 },
147 },
148}
149
Anton Hansson81969c22020-02-03 20:45:56 +0000150priv_apps = " " +
151 "--show-annotation android.annotation.SystemApi\\(" +
152 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
153 "\\) "
154
155module_libs = " " +
156 " --show-annotation android.annotation.SystemApi\\(" +
157 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
Makoto Onuki41ccbfb2020-07-10 12:05:21 -0700158 "\\)" +
159 " --show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
160 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
Anton Hansson81969c22020-02-03 20:45:56 +0000161 "\\) "
162
Jiyong Park7fb4b182019-12-20 14:35:43 +0900163droidstubs {
164 name: "system-api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000165 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +0000166 removed_dex_api_filename: "system-removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900167 arg_files: [
168 "core/res/AndroidManifest.xml",
169 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000170 args: metalava_framework_docs_args + priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900171 check_api: {
172 current: {
173 api_file: "api/system-current.txt",
174 removed_api_file: "api/system-removed.txt",
175 },
176 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100177 api_file: ":android.api.system.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100178 removed_api_file: ":removed.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900179 baseline_file: ":system-api-incompatibilities-with-last-released"
180 },
181 api_lint: {
182 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100183 new_since: ":android.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900184 baseline_file: "api/system-lint-baseline.txt",
185 },
186 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000187 dist: {
188 targets: ["sdk", "win_sdk"],
189 dir: "apistubs/android/system/api",
190 dest: "android.txt",
191 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900192 jdiff_enabled: true,
193}
194
195droidstubs {
Anton Hansson76d3db42020-04-09 14:16:37 +0100196 name: "system-api-stubs-docs-non-updatable",
197 defaults: ["metalava-non-updatable-api-stubs-default"],
198 arg_files: ["core/res/AndroidManifest.xml"],
199 args: metalava_framework_docs_args + priv_apps,
200 check_api: {
201 current: {
202 api_file: "non-updatable-api/system-current.txt",
203 removed_api_file: "non-updatable-api/system-removed.txt",
204 },
205 api_lint: {
206 enabled: true,
207 new_since: ":android-non-updatable.api.system.latest",
208 baseline_file: "non-updatable-api/system-lint-baseline.txt",
209 },
210 },
211}
212
213droidstubs {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900214 name: "test-api-stubs-docs",
Anton Hansson822cdb32020-03-06 17:16:06 +0000215 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900216 arg_files: [
217 "core/res/AndroidManifest.xml",
218 ],
219 args: metalava_framework_docs_args + " --show-annotation android.annotation.TestApi",
220 check_api: {
221 current: {
222 api_file: "api/test-current.txt",
223 removed_api_file: "api/test-removed.txt",
224 },
225 api_lint: {
226 enabled: true,
227 baseline_file: "api/test-lint-baseline.txt",
228 },
229 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000230 dist: {
231 targets: ["sdk", "win_sdk"],
232 dir: "apistubs/android/test/api",
233 dest: "android.txt",
234 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900235}
236
237/////////////////////////////////////////////////////////////////////
Makoto Onuki41ccbfb2020-07-10 12:05:21 -0700238// Following droidstubs modules are for extra APIs for modules,
239// namely @SystemApi(client=MODULE_LIBRARIES) APIs.
Jiyong Parke3095162019-12-20 15:30:28 +0900240/////////////////////////////////////////////////////////////////////
241
Jiyong Parke3095162019-12-20 15:30:28 +0900242droidstubs {
243 name: "module-lib-api",
Anton Hansson822cdb32020-03-06 17:16:06 +0000244 defaults: ["metalava-full-api-stubs-default"],
Jiyong Parke3095162019-12-20 15:30:28 +0900245 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000246 args: metalava_framework_docs_args + module_libs,
Paul Duffin4c5dc182020-04-08 18:28:15 +0100247
248 // Do not generate stubs as they are not needed
249 generate_stubs: false,
250
Jiyong Parke3095162019-12-20 15:30:28 +0900251 check_api: {
252 current: {
253 api_file: "api/module-lib-current.txt",
254 removed_api_file: "api/module-lib-removed.txt",
255 },
Anton Hansson79e35c32020-02-11 14:36:40 +0000256 last_released: {
Anton Hansson48ee95e2020-05-02 17:49:26 +0100257 api_file: ":android.api.module-lib.latest",
Anton Hansson960c6752020-05-02 18:00:30 +0100258 removed_api_file: ":removed.api.module-lib.latest",
Anton Hansson79e35c32020-02-11 14:36:40 +0000259 baseline_file: ":module-lib-api-incompatibilities-with-last-released"
260 },
261 api_lint: {
262 enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100263 new_since: ":android.api.module-lib.latest",
Anton Hansson79e35c32020-02-11 14:36:40 +0000264 baseline_file: "api/module-lib-lint-baseline.txt",
265 },
Jiyong Parke3095162019-12-20 15:30:28 +0900266 },
Anton Hanssond9a3fee2020-03-23 18:08:55 +0000267 dist: {
268 targets: ["sdk", "win_sdk"],
269 dir: "apistubs/android/module-lib/api",
270 dest: "android.txt",
271 },
Jiyong Parke3095162019-12-20 15:30:28 +0900272}
273
Anton Hansson76d3db42020-04-09 14:16:37 +0100274droidstubs {
275 name: "module-lib-api-stubs-docs-non-updatable",
276 defaults: ["metalava-non-updatable-api-stubs-default"],
277 arg_files: ["core/res/AndroidManifest.xml"],
Makoto Onukif4a486e2020-07-15 10:38:04 -0700278 args: metalava_framework_docs_args + priv_apps + module_libs,
Anton Hansson76d3db42020-04-09 14:16:37 +0100279 check_api: {
280 current: {
281 api_file: "non-updatable-api/module-lib-current.txt",
282 removed_api_file: "non-updatable-api/module-lib-removed.txt",
283 },
284 api_lint: {
285 enabled: true,
286 new_since: ":android-non-updatable.api.module-lib.latest",
287 },
288 },
289}
Anton Hansson81969c22020-02-03 20:45:56 +0000290
Jiyong Parke3095162019-12-20 15:30:28 +0900291/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900292// android_*_stubs_current modules are the stubs libraries compiled
293// from *-api-stubs-docs
294/////////////////////////////////////////////////////////////////////
295
296java_defaults {
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100297 name: "android_defaults_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000298 libs: [ "stub-annotations" ],
Paul Duffina281e922020-03-25 10:13:33 +0000299 static_libs: [
Paul Duffina281e922020-03-25 10:13:33 +0000300 // License notices from art module
301 "art-notices-for-framework-stubs-jar",
302 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900303 errorprone: {
304 javacflags: [
305 "-XepDisableAllChecks",
306 ],
307 },
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100308 sdk_version: "none",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900309 system_modules: "none",
310 java_version: "1.8",
311 compile_dex: true,
312}
313
314java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100315 name: "android_monolith_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000316 srcs: [ ":api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100317 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100318 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900319}
320
321java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100322 name: "android_merged_stubs_current",
323 srcs: [ ":api-stubs-docs-non-updatable" ],
324 static_libs: [
325 "conscrypt.module.public.api.stubs",
Paul Duffin4e006622020-05-31 16:55:13 +0100326 "framework-graphics.stubs",
Paul Duffin8b864fb2020-05-31 11:35:50 +0100327 "framework-media.stubs",
328 "framework-mediaprovider.stubs",
329 "framework-permission.stubs",
330 "framework-sdkextensions.stubs",
331 "framework-statsd.stubs",
332 "framework-tethering.stubs",
333 "framework-wifi.stubs",
Anton Hanssonbf63f942020-05-20 12:06:23 +0100334 "private-stub-annotations-jar",
Anton Hansson76d3db42020-04-09 14:16:37 +0100335 ],
336 defaults: ["android_defaults_stubs_current"],
337}
338
339java_library_static {
340 name: "android_stubs_current",
341 static_libs: ["android_merged_stubs_current"],
342 defaults: ["android_defaults_stubs_current"],
343}
344
345java_library_static {
346 name: "android_system_monolith_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000347 srcs: [ ":system-api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100348 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100349 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900350}
351
352java_library_static {
Anton Hansson76d3db42020-04-09 14:16:37 +0100353 name: "android_system_merged_stubs_current",
354 srcs: [ ":system-api-stubs-docs-non-updatable" ],
355 static_libs: [
356 "conscrypt.module.public.api.stubs",
357 "framework-appsearch-stubs", // TODO: standardize appsearch stubs
Paul Duffin4e006622020-05-31 16:55:13 +0100358 "framework-graphics.stubs.system",
Paul Duffin8b864fb2020-05-31 11:35:50 +0100359 "framework-media.stubs.system",
360 "framework-mediaprovider.stubs.system",
361 "framework-permission.stubs.system",
362 "framework-sdkextensions.stubs.system",
363 "framework-statsd.stubs.system",
364 "framework-tethering.stubs.system",
365 "framework-wifi.stubs.system",
Anton Hanssonbf63f942020-05-20 12:06:23 +0100366 "private-stub-annotations-jar",
Anton Hansson76d3db42020-04-09 14:16:37 +0100367 ],
368 defaults: ["android_defaults_stubs_current"],
369}
370
371java_library_static {
372 name: "android_system_stubs_current",
373 static_libs: ["android_system_merged_stubs_current"],
374 defaults: ["android_defaults_stubs_current"],
375}
376
377java_library_static {
Jiyong Park7fb4b182019-12-20 14:35:43 +0900378 name: "android_test_stubs_current",
Anton Hansson08b48bb2020-02-08 20:43:19 +0000379 srcs: [ ":test-api-stubs-docs" ],
Anton Hanssonbf63f942020-05-20 12:06:23 +0100380 static_libs: [ "private-stub-annotations-jar" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100381 defaults: ["android_defaults_stubs_current"],
Jiyong Parke3095162019-12-20 15:30:28 +0900382}
383
384java_library_static {
Anton Hansson1b9cf092020-01-30 12:09:02 +0000385 name: "android_module_lib_stubs_current",
Makoto Onukif4a486e2020-07-15 10:38:04 -0700386 srcs: [ ":module-lib-api-stubs-docs-non-updatable" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100387 defaults: ["android_defaults_stubs_current"],
Anton Hansson394febc2020-04-14 16:35:36 +0100388 libs: ["sdk_system_29_android"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900389}
390
Anton Hansson76d3db42020-04-09 14:16:37 +0100391java_library_static {
392 name: "android_non_updatable_stubs_current",
393 srcs: [":api-stubs-docs-non-updatable"],
394 defaults: ["android_defaults_stubs_current"],
395 libs: ["sdk_system_29_android"],
396}
397
398java_library_static {
399 name: "android_system_non_updatable_stubs_current",
400 srcs: [":system-api-stubs-docs-non-updatable"],
401 defaults: ["android_defaults_stubs_current"],
402 libs: ["sdk_system_29_android"],
403}
404
Jiyong Park7fb4b182019-12-20 14:35:43 +0900405/////////////////////////////////////////////////////////////////////
406// hwbinder.stubs provides APIs required for building HIDL Java
407// libraries.
408/////////////////////////////////////////////////////////////////////
409
410droidstubs {
411 name: "hwbinder-stubs-docs",
412 srcs: [
413 "core/java/android/os/HidlSupport.java",
414 "core/java/android/annotation/IntDef.java",
415 "core/java/android/annotation/IntRange.java",
416 "core/java/android/annotation/NonNull.java",
417 "core/java/android/annotation/SystemApi.java",
418 "core/java/android/os/HidlMemory.java",
419 "core/java/android/os/HwBinder.java",
420 "core/java/android/os/HwBlob.java",
421 "core/java/android/os/HwParcel.java",
422 "core/java/android/os/IHwBinder.java",
423 "core/java/android/os/IHwInterface.java",
424 "core/java/android/os/DeadObjectException.java",
425 "core/java/android/os/DeadSystemException.java",
426 "core/java/android/os/NativeHandle.java",
427 "core/java/android/os/RemoteException.java",
428 "core/java/android/util/AndroidException.java",
429 ],
430 installable: false,
431 sdk_version: "core_platform",
432 annotations_enabled: true,
Anton Hansson48ee95e2020-05-02 17:49:26 +0100433 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900434 merge_annotations_dirs: [
435 "metalava-manual",
436 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000437 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900438}
439
440java_library_static {
441 name: "hwbinder.stubs",
442 sdk_version: "core_current",
443 srcs: [
444 ":hwbinder-stubs-docs",
445 ],
446}
447
448/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900449// api/*-current.txt files for use by modules in other directories
450// like the CTS test
451/////////////////////////////////////////////////////////////////////
452
453filegroup {
454 name: "frameworks-base-api-current.txt",
455 srcs: [
456 "api/current.txt",
457 ],
458}
459
460filegroup {
461 name: "frameworks-base-api-system-current.txt",
462 srcs: [
463 "api/system-current.txt",
464 ],
465}
466
467filegroup {
468 name: "frameworks-base-api-system-removed.txt",
469 srcs: [
470 "api/system-removed.txt",
471 ],
472}