blob: f34ecbd79108475f940eac4f0b8dfd616d919ae1 [file] [log] [blame]
Anton Hansson24c88f42019-12-13 16:17:27 +00001// 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
15mainline_stubs_args =
16 "--error UnhiddenSystemApi " +
17 "--hide BroadcastBehavior " +
18 "--hide DeprecationMismatch " +
19 "--hide HiddenSuperclass " +
20 "--hide HiddenTypedefConstant " +
21 "--hide HiddenTypeParameter " +
22 "--hide MissingPermission " +
23 "--hide RequiresPermission " +
24 "--hide SdkConstant " +
25 "--hide Todo " +
26 "--hide Typo " +
27 "--hide UnavailableSymbol "
28
Anton Hansson087646e2020-03-24 15:21:01 +000029// TODO: modularize this so not every module has the same whitelist
30framework_packages_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
Anton Hansson26e1ed62020-03-23 13:30:01 +000043// TODO: remove the hiding when server classes are cleaned up.
44mainline_framework_stubs_args =
45 mainline_stubs_args +
46 "--hide-package com.android.server "
Anton Hansson5036ab62019-12-17 10:03:52 +000047
Anton Hanssona12addc2020-02-03 14:44:47 +000048priv_apps = " " +
49 "--show-annotation android.annotation.SystemApi\\(" +
Jiyong Park7f1e9b22020-02-25 17:12:30 +090050 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
Anton Hanssona12addc2020-02-03 14:44:47 +000051 "\\) "
52
53module_libs = " " +
54 " --show-annotation android.annotation.SystemApi\\(" +
Jiyong Park7f1e9b22020-02-25 17:12:30 +090055 "client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
Makoto Onukia13287f2020-07-10 12:05:21 -070056 "\\)" +
57 " --show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
58 "client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
Anton Hanssona12addc2020-02-03 14:44:47 +000059 "\\) "
60
Anton Hansson26e1ed62020-03-23 13:30:01 +000061mainline_service_stubs_args =
62 mainline_stubs_args +
63 "--show-annotation android.annotation.SystemApi\\(" +
64 "client=android.annotation.SystemApi.Client.SYSTEM_SERVER" +
65 "\\) " +
66 "--hide-annotation android.annotation.Hide " +
67 "--hide InternalClasses " // com.android.* classes are okay in this interface
68
Paul Duffin13e67af2020-05-13 10:17:56 +010069// Defaults for mainline module provided java_sdk_library instances.
70java_defaults {
71 name: "framework-module-defaults",
72
73 // Additional annotations used for compiling both the implementation and the
74 // stubs libraries.
75 libs: ["framework-annotations-lib"],
76
Paul Duffin077b4df2020-05-22 17:12:12 +010077 // Framework modules are not generally shared libraries, i.e. they are not
78 // intended, and must not be allowed, to be used in a <uses-library> manifest
79 // entry.
80 shared_library: false,
81
Paul Duffin1a0ba1e2020-05-29 09:50:20 +010082 // Prevent dependencies that do not specify an sdk_version from accessing the
83 // implementation library by default and force them to use stubs instead.
84 default_to_stubs: true,
85
Paul Duffin13e67af2020-05-13 10:17:56 +010086 // Enable api lint. This will eventually become the default for java_sdk_library
87 // but it cannot yet be turned on because some usages have not been cleaned up.
88 // TODO(b/156126315) - Remove when no longer needed.
89 api_lint: {
90 enabled: true,
91 },
92
93 // The API scope specific properties.
94 public: {
95 enabled: true,
96 sdk_version: "module_current",
97 },
98 system: {
99 enabled: true,
100 sdk_version: "module_current",
101 },
102 module_lib: {
103 enabled: true,
104 sdk_version: "module_current",
105 },
106
Paul Duffin067d80b2020-05-17 13:00:36 +0100107 // Configure framework module specific metalava options.
108 droiddoc_options: [mainline_stubs_args],
109
Paul Duffin13e67af2020-05-13 10:17:56 +0100110 // The stub libraries must be visible to frameworks/base so they can be combined
111 // into API specific libraries.
112 stubs_library_visibility: [
113 "//frameworks/base", // Framework
114 ],
115
116 // Set the visibility of the modules creating the stubs source.
117 stubs_source_visibility: [
118 // Ignore any visibility rules specified on the java_sdk_library when
119 // setting the visibility of the stubs source modules.
120 "//visibility:override",
121
122 // Currently, the stub source is not required for anything other than building
123 // the stubs library so is private to avoid misuse.
124 "//visibility:private",
125 ],
126
127 // Collates API usages from each module for further analysis.
128 plugins: ["java_api_finder"],
129
130 // Mainline modules should only rely on 'module_lib' APIs provided by other modules
131 // and the non updatable parts of the platform.
132 sdk_version: "module_current",
133}
134
Anton Hansson24c88f42019-12-13 16:17:27 +0000135stubs_defaults {
136 name: "framework-module-stubs-defaults-publicapi",
Anton Hansson26e1ed62020-03-23 13:30:01 +0000137 args: mainline_framework_stubs_args,
Anton Hansson24c88f42019-12-13 16:17:27 +0000138 installable: false,
Anton Hansson4d90a282020-03-09 19:14:28 +0000139 sdk_version: "current",
Anton Hansson087646e2020-03-24 15:21:01 +0000140 filter_packages: framework_packages_to_document,
Anton Hansson5d708e52020-01-17 19:03:34 +0000141 check_api: {
142 current: {
143 api_file: "api/current.txt",
144 removed_api_file: "api/removed.txt",
145 },
146 },
Anton Hansson24c88f42019-12-13 16:17:27 +0000147}
148
149stubs_defaults {
150 name: "framework-module-stubs-defaults-systemapi",
Anton Hansson26e1ed62020-03-23 13:30:01 +0000151 args: mainline_framework_stubs_args + priv_apps,
Anton Hansson397eb472020-03-13 16:28:21 +0000152 libs: ["framework-annotations-lib"],
Jiyong Park7be934f2020-01-06 16:22:32 +0900153 installable: false,
Anton Hansson4d90a282020-03-09 19:14:28 +0000154 sdk_version: "system_current",
Anton Hansson087646e2020-03-24 15:21:01 +0000155 filter_packages: framework_packages_to_document,
Anton Hansson5d708e52020-01-17 19:03:34 +0000156 check_api: {
157 current: {
158 api_file: "api/system-current.txt",
159 removed_api_file: "api/system-removed.txt",
160 },
161 },
Jiyong Park7be934f2020-01-06 16:22:32 +0900162}
163
Anton Hanssonc8cc1eb2020-03-24 17:03:15 +0000164java_defaults {
165 name: "framework-module-stubs-lib-defaults-publicapi",
166 installable: false,
167 sdk_version: "module_current",
168}
169
170java_defaults {
171 name: "framework-module-stubs-lib-defaults-systemapi",
172 installable: false,
173 sdk_version: "module_current",
174}
175
176java_defaults {
177 name: "framework-module-stubs-lib-defaults-module_libs_api",
178 installable: false,
179 sdk_version: "module_current",
180}
181
Anton Hanssona12addc2020-02-03 14:44:47 +0000182// The defaults for module_libs comes in two parts - defaults for API checks
183// and defaults for stub generation. This is because we want the API txt
184// files to *only* include the module_libs_api, but the stubs to include
185// module_libs_api as well as priv_apps.
186
Jiyong Park7be934f2020-01-06 16:22:32 +0900187stubs_defaults {
Anton Hanssona12addc2020-02-03 14:44:47 +0000188 name: "framework-module-api-defaults-module_libs_api",
Anton Hansson26e1ed62020-03-23 13:30:01 +0000189 args: mainline_framework_stubs_args + module_libs,
Anton Hansson397eb472020-03-13 16:28:21 +0000190 libs: ["framework-annotations-lib"],
Jiyong Park7be934f2020-01-06 16:22:32 +0900191 installable: false,
Anton Hansson4d90a282020-03-09 19:14:28 +0000192 sdk_version: "module_current",
Anton Hansson087646e2020-03-24 15:21:01 +0000193 filter_packages: framework_packages_to_document,
Paul Duffin4c5dc182020-04-08 18:28:15 +0100194
195 // Do not generate stubs as they are not needed
196 generate_stubs: false,
197
Anton Hansson5d708e52020-01-17 19:03:34 +0000198 check_api: {
199 current: {
200 api_file: "api/module-lib-current.txt",
201 removed_api_file: "api/module-lib-removed.txt",
202 },
203 },
Jiyong Park7be934f2020-01-06 16:22:32 +0900204}
205
206stubs_defaults {
207 name: "framework-module-stubs-defaults-module_libs_api",
Anton Hansson26e1ed62020-03-23 13:30:01 +0000208 args: mainline_framework_stubs_args + module_libs + priv_apps,
Anton Hansson397eb472020-03-13 16:28:21 +0000209 libs: ["framework-annotations-lib"],
Anton Hansson24c88f42019-12-13 16:17:27 +0000210 installable: false,
Anton Hansson4d90a282020-03-09 19:14:28 +0000211 sdk_version: "module_current",
Anton Hansson087646e2020-03-24 15:21:01 +0000212 filter_packages: framework_packages_to_document,
Anton Hansson24c88f42019-12-13 16:17:27 +0000213}
Anton Hansson26e1ed62020-03-23 13:30:01 +0000214
215stubs_defaults {
216 name: "service-module-stubs-srcs-defaults",
217 args: mainline_service_stubs_args,
218 installable: false,
Anton Hanssonf68ef062020-03-27 15:09:26 +0000219 filter_packages: ["com.android."],
Anton Hansson26e1ed62020-03-23 13:30:01 +0000220 check_api: {
221 current: {
222 api_file: "api/current.txt",
223 removed_api_file: "api/removed.txt",
224 },
225 },
226}
227
228// Empty for now, but a convenient place to add rules for all
229// module java_library system_server stub libs.
230java_defaults {
231 name: "service-module-stubs-defaults",
232}