blob: e8aa3936d8898c13f427c3a295a6657e8db67cf0 [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",
50 ":core-current-stubs-source",
51 ":core_public_api_files",
Jiyong Park7fb4b182019-12-20 14:35:43 +090052 ],
53 libs: ["framework-internal-utils"],
54 installable: false,
55 annotations_enabled: true,
56 previous_api: ":last-released-public-api",
57 merge_annotations_dirs: [
58 "metalava-manual",
59 ],
Aurimas Liutikas94bac9c2020-03-12 17:06:12 -070060 api_levels_annotations_enabled: false,
Jiyong Park7fb4b182019-12-20 14:35:43 +090061 filter_packages: packages_to_document,
62}
63
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090064stubs_defaults {
Anton Hansson537564e2020-03-06 17:16:06 +000065 name: "metalava-full-api-stubs-default",
66 defaults: ["metalava-base-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090067 srcs: [":framework-updatable-sources"],
68 sdk_version: "core_platform",
69}
70
Anton Hansson537564e2020-03-06 17:16:06 +000071stubs_defaults {
72 name: "metalava-non-updatable-api-stubs-default",
73 defaults: ["metalava-base-api-stubs-default"],
74 sdk_version: "system_current",
75}
76
Jiyong Park7fb4b182019-12-20 14:35:43 +090077/////////////////////////////////////////////////////////////////////
78// *-api-stubs-docs modules providing source files for the stub libraries
79/////////////////////////////////////////////////////////////////////
80
Jiyong Park2e6cdcc2019-12-20 15:30:28 +090081// api-stubs-docs, system-api-stubs-docs, and test-api-stubs-docs have APIs
82// from the non-updatable part of the platform as well as from the updatable
83// modules
Jiyong Park7fb4b182019-12-20 14:35:43 +090084droidstubs {
85 name: "api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +000086 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +090087 api_filename: "public_api.txt",
88 private_api_filename: "private.txt",
89 removed_api_filename: "removed.txt",
90 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: {
100 api_file: ":last-released-public-api",
101 removed_api_file: "api/removed.txt",
102 baseline_file: ":public-api-incompatibilities-with-last-released",
103 },
104 api_lint: {
105 enabled: true,
106 new_since: ":last-released-public-api",
107 baseline_file: "api/lint-baseline.txt",
108 },
109 },
110 jdiff_enabled: true,
111}
112
Anton Hansson81969c22020-02-03 20:45:56 +0000113priv_apps = " " +
114 "--show-annotation android.annotation.SystemApi\\(" +
115 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
116 "\\) "
117
118module_libs = " " +
119 " --show-annotation android.annotation.SystemApi\\(" +
120 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
121 "\\) "
122
Jiyong Park7fb4b182019-12-20 14:35:43 +0900123droidstubs {
124 name: "system-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000125 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900126 api_tag_name: "SYSTEM",
127 api_filename: "system-api.txt",
128 private_api_filename: "system-private.txt",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900129 removed_api_filename: "system-removed.txt",
130 arg_files: [
131 "core/res/AndroidManifest.xml",
132 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000133 args: metalava_framework_docs_args + priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900134 check_api: {
135 current: {
136 api_file: "api/system-current.txt",
137 removed_api_file: "api/system-removed.txt",
138 },
139 last_released: {
140 api_file: ":last-released-system-api",
141 removed_api_file: "api/system-removed.txt",
142 baseline_file: ":system-api-incompatibilities-with-last-released"
143 },
144 api_lint: {
145 enabled: true,
146 new_since: ":last-released-system-api",
147 baseline_file: "api/system-lint-baseline.txt",
148 },
149 },
150 jdiff_enabled: true,
151}
152
153droidstubs {
154 name: "test-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000155 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900156 api_tag_name: "TEST",
157 api_filename: "test-api.txt",
158 removed_api_filename: "test-removed.txt",
159 arg_files: [
160 "core/res/AndroidManifest.xml",
161 ],
162 args: metalava_framework_docs_args + " --show-annotation android.annotation.TestApi",
163 check_api: {
164 current: {
165 api_file: "api/test-current.txt",
166 removed_api_file: "api/test-removed.txt",
167 },
168 api_lint: {
169 enabled: true,
170 baseline_file: "api/test-lint-baseline.txt",
171 },
172 },
173}
174
175/////////////////////////////////////////////////////////////////////
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900176// Following droidstubs modules are for extra APIs for modules.
177// The framework currently have two more API surfaces for modules:
178// @SystemApi(client=MODULE_APPS) and @SystemApi(client=MODULE_LIBRARIES)
179/////////////////////////////////////////////////////////////////////
180
Anton Hansson81969c22020-02-03 20:45:56 +0000181// TODO(b/146727827) remove the *-api module when we can teach metalava
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900182// about the relationship among the API surfaces. Currently, these modules are only to generate
183// the API signature files and ensure that the APIs evolve in a backwards compatible manner.
184// They however are NOT used for building the API stub.
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900185
186droidstubs {
187 name: "module-lib-api",
Anton Hansson537564e2020-03-06 17:16:06 +0000188 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900189 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000190 args: metalava_framework_docs_args + module_libs,
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900191 check_api: {
192 current: {
193 api_file: "api/module-lib-current.txt",
194 removed_api_file: "api/module-lib-removed.txt",
195 },
Anton Hansson626afea2020-02-11 14:36:40 +0000196 last_released: {
197 api_file: ":last-released-module-lib-api",
198 removed_api_file: "api/module-lib-removed.txt",
199 baseline_file: ":module-lib-api-incompatibilities-with-last-released"
200 },
201 api_lint: {
202 enabled: true,
203 new_since: ":last-released-module-lib-api",
204 baseline_file: "api/module-lib-lint-baseline.txt",
205 },
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900206 },
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900207}
208
Anton Hansson81969c22020-02-03 20:45:56 +0000209
210// The following droidstub module generates source files for the API stub library for
211// modules. Note that it not only includes its own APIs but also other APIs that have
212// narrower scope (all @SystemApis, not just the ones with 'client=MODULE_LIBRARIES').
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900213
214droidstubs {
215 name: "module-lib-api-stubs-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000216 defaults: ["metalava-non-updatable-api-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900217 arg_files: ["core/res/AndroidManifest.xml"],
Anton Hansson81969c22020-02-03 20:45:56 +0000218 args: metalava_framework_docs_args + priv_apps + module_libs,
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900219}
220
221/////////////////////////////////////////////////////////////////////
Jiyong Park7fb4b182019-12-20 14:35:43 +0900222// android_*_stubs_current modules are the stubs libraries compiled
223// from *-api-stubs-docs
224/////////////////////////////////////////////////////////////////////
225
226java_defaults {
227 name: "framework-stubs-default",
Anton Hansson42afd612020-02-08 20:43:19 +0000228 libs: [ "stub-annotations" ],
229 static_libs: [ "private-stub-annotations-jar" ],
230 sdk_version: "core_current",
Jiyong Park7fb4b182019-12-20 14:35:43 +0900231 errorprone: {
232 javacflags: [
233 "-XepDisableAllChecks",
234 ],
235 },
236 java_resources: [
237 ":notices-for-framework-stubs",
238 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900239 system_modules: "none",
240 java_version: "1.8",
241 compile_dex: true,
242}
243
244java_library_static {
245 name: "android_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000246 srcs: [ ":api-stubs-docs" ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900247 defaults: ["framework-stubs-default"],
248}
249
250java_library_static {
251 name: "android_system_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000252 srcs: [ ":system-api-stubs-docs" ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900253 defaults: ["framework-stubs-default"],
254}
255
256java_library_static {
257 name: "android_test_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000258 srcs: [ ":test-api-stubs-docs" ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900259 defaults: ["framework-stubs-default"],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900260}
261
262java_library_static {
Anton Hansson9c4bbe92020-01-30 12:09:02 +0000263 name: "android_module_lib_stubs_current",
Anton Hansson42afd612020-02-08 20:43:19 +0000264 srcs: [ ":module-lib-api-stubs-docs" ],
Jiyong Park2e6cdcc2019-12-20 15:30:28 +0900265 defaults: ["framework-stubs-default"],
Anton Hansson537564e2020-03-06 17:16:06 +0000266 libs: ["android_system_stubs_current"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900267}
268
Jiyong Park7fb4b182019-12-20 14:35:43 +0900269/////////////////////////////////////////////////////////////////////
270// hwbinder.stubs provides APIs required for building HIDL Java
271// libraries.
272/////////////////////////////////////////////////////////////////////
273
274droidstubs {
275 name: "hwbinder-stubs-docs",
276 srcs: [
277 "core/java/android/os/HidlSupport.java",
278 "core/java/android/annotation/IntDef.java",
279 "core/java/android/annotation/IntRange.java",
280 "core/java/android/annotation/NonNull.java",
281 "core/java/android/annotation/SystemApi.java",
282 "core/java/android/os/HidlMemory.java",
283 "core/java/android/os/HwBinder.java",
284 "core/java/android/os/HwBlob.java",
285 "core/java/android/os/HwParcel.java",
286 "core/java/android/os/IHwBinder.java",
287 "core/java/android/os/IHwInterface.java",
288 "core/java/android/os/DeadObjectException.java",
289 "core/java/android/os/DeadSystemException.java",
290 "core/java/android/os/NativeHandle.java",
291 "core/java/android/os/RemoteException.java",
292 "core/java/android/util/AndroidException.java",
293 ],
294 installable: false,
295 sdk_version: "core_platform",
296 annotations_enabled: true,
297 previous_api: ":last-released-public-api",
298 merge_annotations_dirs: [
299 "metalava-manual",
300 ],
Anton Hansson81969c22020-02-03 20:45:56 +0000301 args: priv_apps,
Jiyong Park7fb4b182019-12-20 14:35:43 +0900302}
303
304java_library_static {
305 name: "hwbinder.stubs",
306 sdk_version: "core_current",
307 srcs: [
308 ":hwbinder-stubs-docs",
309 ],
310}
311
312/////////////////////////////////////////////////////////////////////
313// Stubs for hiddenapi processing.
314/////////////////////////////////////////////////////////////////////
315
316droidstubs {
317 name: "hiddenapi-lists-docs",
Anton Hansson537564e2020-03-06 17:16:06 +0000318 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900319 arg_files: [
320 "core/res/AndroidManifest.xml",
321 ],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900322 removed_dex_api_filename: "removed-dex.txt",
323 args: metalava_framework_docs_args +
324 " --show-unannotated " +
Anton Hansson81969c22020-02-03 20:45:56 +0000325 priv_apps +
Jiyong Park7fb4b182019-12-20 14:35:43 +0900326 " --show-annotation android.annotation.TestApi ",
327}
328
329droidstubs {
330 name: "hiddenapi-mappings",
Anton Hansson537564e2020-03-06 17:16:06 +0000331 defaults: ["metalava-full-api-stubs-default"],
Jiyong Park7fb4b182019-12-20 14:35:43 +0900332 srcs: [
333 ":opt-telephony-common-srcs",
334 ],
335
336 arg_files: [
337 "core/res/AndroidManifest.xml",
338 ],
339 dex_mapping_filename: "dex-mapping.txt",
340 args: metalava_framework_docs_args +
341 " --hide ReferencesHidden " +
342 " --hide UnhiddenSystemApi " +
343 " --show-unannotated " +
Anton Hansson81969c22020-02-03 20:45:56 +0000344 priv_apps +
Jiyong Park7fb4b182019-12-20 14:35:43 +0900345 " --show-annotation android.annotation.TestApi ",
346}
347
348/////////////////////////////////////////////////////////////////////
349// api/*-current.txt files for use by modules in other directories
350// like the CTS test
351/////////////////////////////////////////////////////////////////////
352
353filegroup {
354 name: "frameworks-base-api-current.txt",
355 srcs: [
356 "api/current.txt",
357 ],
358}
359
360filegroup {
361 name: "frameworks-base-api-system-current.txt",
362 srcs: [
363 "api/system-current.txt",
364 ],
365}
366
367filegroup {
368 name: "frameworks-base-api-system-removed.txt",
369 srcs: [
370 "api/system-removed.txt",
371 ],
372}