blob: 097fb74278702a31e0d999b29cae1f99e7e24145 [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 Duffin5c89e702020-03-26 15:33:48 +000050 ":art-module-public-api-stubs-source",
Paul Duffin29adf462020-04-09 10:04:14 +010051 ":conscrypt.module.public.api.stubs.source",
Paul Duffin5c89e702020-03-26 15:33:48 +000052 ":android_icu4j_public_api_files",
Jiyong Park7fb4b182019-12-20 14:35:43 +090053 ],
54 libs: ["framework-internal-utils"],
55 installable: false,
56 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +010057 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +090058 merge_annotations_dirs: [
59 "metalava-manual",
60 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070061 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090062 filter_packages: packages_to_document,
63}
64
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090065stubs_defaults {
Anton Hansson537564e2020-03-06 17:16:06 +000066 name: "metalava-full-api-stubs-default",
67 defaults: ["metalava-base-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090068 srcs: [":framework-updatable-sources"],
69 sdk_version: "core_platform",
70}
71
Anton Hansson537564e2020-03-06 17:16:06 +000072stubs_defaults {
73 name: "metalava-non-updatable-api-stubs-default",
74 defaults: ["metalava-base-api-stubs-default"],
Anton Hanssone53bec02020-03-20 09:12:52 +000075 sdk_version: "core_platform",
76 libs: ["framework-all"],
Anton Hansson537564e2020-03-06 17:16:06 +000077}
78
Jiyong Park7fb4b182019-12-20 14:35:43 +090079/////////////////////////////////////////////////////////////////////
80// *-api-stubs-docs modules providing source files for the stub libraries
81/////////////////////////////////////////////////////////////////////
82
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090083// api-stubs-docs, system-api-stubs-docs, and test-api-stubs-docs have APIs
84// from the non-updatable part of the platform as well as from the updatable
85// modules
Jiyong Park7fb4b182019-12-20 14:35:43 +090086droidstubs {
87 name: "api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +000088 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +000089 removed_dex_api_filename: "removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +090090 arg_files: [
91 "core/res/AndroidManifest.xml",
92 ],
93 args: metalava_framework_docs_args,
94 check_api: {
95 current: {
96 api_file: "api/current.txt",
97 removed_api_file: "api/removed.txt",
98 },
99 last_released: {
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100100 api_file: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900101 removed_api_file: "api/removed.txt",
102 baseline_file: ":public-api-incompatibilities-with-last-released",
103 },
104 api_lint: {
105 enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100106 new_since: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900107 baseline_file: "api/lint-baseline.txt",
108 },
109 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000110 dist: {
111 targets: ["sdk", "win_sdk"],
112 dir: "apistubs/android/public/api",
113 dest: "android.txt",
114 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900115 jdiff_enabled: true,
116}
117
Anton Hansson81969c22020-02-03 20:45:56 +0000118priv_apps = " " +
119 "--show-annotation android.annotation.SystemApi\\(" +
120 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
121 "\\) "
122
123module_libs = " " +
124 " --show-annotation android.annotation.SystemApi\\(" +
125 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
126 "\\) "
127
Jiyong Park7fb4b182019-12-20 14:35:43 +0900128droidstubs {
129 name: "system-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000130 defaults: ["metalava-full-api-stubs-default"],
Artur Satayev0a97d5e2020-03-25 16:45:56 +0000131 removed_dex_api_filename: "system-removed-dex.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900132 arg_files: [
133 "core/res/AndroidManifest.xml",
134 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000135 args: metalava_framework_docs_args + priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900136 check_api: {
137 current: {
138 api_file: "api/system-current.txt",
139 removed_api_file: "api/system-removed.txt",
140 },
141 last_released: {
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100142 api_file: ":android.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900143 removed_api_file: "api/system-removed.txt",
144 baseline_file: ":system-api-incompatibilities-with-last-released"
145 },
146 api_lint: {
147 enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100148 new_since: ":android.api.system.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900149 baseline_file: "api/system-lint-baseline.txt",
150 },
151 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000152 dist: {
153 targets: ["sdk", "win_sdk"],
154 dir: "apistubs/android/system/api",
155 dest: "android.txt",
156 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900157 jdiff_enabled: true,
158}
159
160droidstubs {
161 name: "test-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000162 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900163 arg_files: [
164 "core/res/AndroidManifest.xml",
165 ],
166 args: metalava_framework_docs_args + " --show-annotation android.annotation.TestApi",
167 check_api: {
168 current: {
169 api_file: "api/test-current.txt",
170 removed_api_file: "api/test-removed.txt",
171 },
172 api_lint: {
173 enabled: true,
174 baseline_file: "api/test-lint-baseline.txt",
175 },
176 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000177 dist: {
178 targets: ["sdk", "win_sdk"],
179 dir: "apistubs/android/test/api",
180 dest: "android.txt",
181 },
Jiyong Park7fb4b182019-12-20 14:35:43 +0900182}
183
184/////////////////////////////////////////////////////////////////////
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900185// Following droidstubs modules are for extra APIs for modules.
186// The framework currently have two more API surfaces for modules:
187// @SystemApi(client=MODULE_APPS) and @SystemApi(client=MODULE_LIBRARIES)
188/////////////////////////////////////////////////////////////////////
189
Anton Hansson81969c22020-02-03 20:45:56 +0000190// TODO(b/146727827) remove the *-api module when we can teach metalava
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900191// about the relationship among the API surfaces. Currently, these modules are only to generate
192// the API signature files and ensure that the APIs evolve in a backwards compatible manner.
193// They however are NOT used for building the API stub.
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900194
195droidstubs {
196 name: "module-lib-api",
Anton Hansson537564e2020-03-06 17:16:06 +0000197 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900198 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000199 args: metalava_framework_docs_args + module_libs,
Paul Duffin4c5dc182020-04-08 18:28:15 +0100200
201 // Do not generate stubs as they are not needed
202 generate_stubs: false,
203
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900204 check_api: {
205 current: {
206 api_file: "api/module-lib-current.txt",
207 removed_api_file: "api/module-lib-removed.txt",
208 },
Anton Hansson626afea2020-02-11 14:36:40 +0000209 last_released: {
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100210 api_file: ":android.api.module-lib.latest",
Anton Hansson626afea2020-02-11 14:36:40 +0000211 removed_api_file: "api/module-lib-removed.txt",
212 baseline_file: ":module-lib-api-incompatibilities-with-last-released"
213 },
214 api_lint: {
215 enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100216 new_since: ":android.api.module-lib.latest",
Anton Hansson626afea2020-02-11 14:36:40 +0000217 baseline_file: "api/module-lib-lint-baseline.txt",
218 },
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900219 },
Anton Hanssonba367d32020-03-23 18:08:55 +0000220 dist: {
221 targets: ["sdk", "win_sdk"],
222 dir: "apistubs/android/module-lib/api",
223 dest: "android.txt",
224 },
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900225}
226
Anton Hansson81969c22020-02-03 20:45:56 +0000227
228// The following droidstub module generates source files for the API stub library for
229// modules. Note that it not only includes its own APIs but also other APIs that have
230// narrower scope (all @SystemApis, not just the ones with 'client=MODULE_LIBRARIES').
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900231
232droidstubs {
233 name: "module-lib-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000234 defaults: ["metalava-non-updatable-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900235 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000236 args: metalava_framework_docs_args + priv_apps + module_libs,
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900237}
238
239/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900240// android_*_stubs_current modules are the stubs libraries compiled
241// from *-api-stubs-docs
242/////////////////////////////////////////////////////////////////////
243
244java_defaults {
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100245 name: "android_defaults_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000246 libs: [ "stub-annotations" ],
Paul Duffina281e922020-03-25 10:13:33 +0000247 static_libs: [
248 "private-stub-annotations-jar",
249
250 // License notices from art module
251 "art-notices-for-framework-stubs-jar",
252 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900253 errorprone: {
254 javacflags: [
255 "-XepDisableAllChecks",
256 ],
257 },
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100258 sdk_version: "none",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900259 system_modules: "none",
260 java_version: "1.8",
261 compile_dex: true,
262}
263
264java_library_static {
265 name: "android_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000266 srcs: [ ":api-stubs-docs" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100267 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900268}
269
270java_library_static {
271 name: "android_system_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000272 srcs: [ ":system-api-stubs-docs" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100273 defaults: ["android_defaults_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900274}
275
276java_library_static {
277 name: "android_test_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000278 srcs: [ ":test-api-stubs-docs" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100279 defaults: ["android_defaults_stubs_current"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900280}
281
282java_library_static {
Anton Hansson9c4bbe92020-01-30 12:09:02 +0000283 name: "android_module_lib_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000284 srcs: [ ":module-lib-api-stubs-docs" ],
Anton Hanssonfbd32f32020-04-09 14:16:37 +0100285 defaults: ["android_defaults_stubs_current"],
Anton Hansson537564e2020-03-06 17:16:06 +0000286 libs: ["android_system_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900287}
288
Jiyong Park7fb4b182019-12-20 14:35:43 +0900289/////////////////////////////////////////////////////////////////////
290// hwbinder.stubs provides APIs required for building HIDL Java
291// libraries.
292/////////////////////////////////////////////////////////////////////
293
294droidstubs {
295 name: "hwbinder-stubs-docs",
296 srcs: [
297 "core/java/android/os/HidlSupport.java",
298 "core/java/android/annotation/IntDef.java",
299 "core/java/android/annotation/IntRange.java",
300 "core/java/android/annotation/NonNull.java",
301 "core/java/android/annotation/SystemApi.java",
302 "core/java/android/os/HidlMemory.java",
303 "core/java/android/os/HwBinder.java",
304 "core/java/android/os/HwBlob.java",
305 "core/java/android/os/HwParcel.java",
306 "core/java/android/os/IHwBinder.java",
307 "core/java/android/os/IHwInterface.java",
308 "core/java/android/os/DeadObjectException.java",
309 "core/java/android/os/DeadSystemException.java",
310 "core/java/android/os/NativeHandle.java",
311 "core/java/android/os/RemoteException.java",
312 "core/java/android/util/AndroidException.java",
313 ],
314 installable: false,
315 sdk_version: "core_platform",
316 annotations_enabled: true,
Anton Hanssonf68ddea2020-05-02 17:49:26 +0100317 previous_api: ":android.api.public.latest",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900318 merge_annotations_dirs: [
319 "metalava-manual",
320 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000321 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900322}
323
324java_library_static {
325 name: "hwbinder.stubs",
326 sdk_version: "core_current",
327 srcs: [
328 ":hwbinder-stubs-docs",
329 ],
330}
331
332/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900333// api/*-current.txt files for use by modules in other directories
334// like the CTS test
335/////////////////////////////////////////////////////////////////////
336
337filegroup {
338 name: "frameworks-base-api-current.txt",
339 srcs: [
340 "api/current.txt",
341 ],
342}
343
344filegroup {
345 name: "frameworks-base-api-system-current.txt",
346 srcs: [
347 "api/system-current.txt",
348 ],
349}
350
351filegroup {
352 name: "frameworks-base-api-system-removed.txt",
353 srcs: [
354 "api/system-removed.txt",
355 ],
356}