1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
// Copyright (C) 2019 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
mainline_stubs_args =
"--error UnhiddenSystemApi " +
"--hide BroadcastBehavior " +
"--hide DeprecationMismatch " +
"--hide HiddenSuperclass " +
"--hide HiddenTypedefConstant " +
"--hide HiddenTypeParameter " +
"--hide MissingPermission " +
"--hide RequiresPermission " +
"--hide SdkConstant " +
"--hide Todo " +
"--hide Typo " +
"--hide UnavailableSymbol "
// TODO: modularize this so not every module has the same whitelist
framework_packages_to_document = [
"android",
"dalvik",
"java",
"javax",
"junit",
"org.apache.http",
"org.json",
"org.w3c.dom",
"org.xml.sax",
"org.xmlpull",
]
// TODO: remove the hiding when server classes are cleaned up.
mainline_framework_stubs_args =
mainline_stubs_args +
"--hide-package com.android.server "
priv_apps = " " +
"--show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
"\\) "
module_libs = " " +
" --show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
"\\) "
mainline_service_stubs_args =
mainline_stubs_args +
"--show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.SYSTEM_SERVER" +
"\\) " +
"--hide-annotation android.annotation.Hide " +
"--hide InternalClasses " // com.android.* classes are okay in this interface
// Defaults for mainline module provided java_sdk_library instances.
java_defaults {
name: "framework-module-defaults",
// Additional annotations used for compiling both the implementation and the
// stubs libraries.
libs: ["framework-annotations-lib"],
// Framework modules are not generally shared libraries, i.e. they are not
// intended, and must not be allowed, to be used in a <uses-library> manifest
// entry.
shared_library: false,
// Prevent dependencies that do not specify an sdk_version from accessing the
// implementation library by default and force them to use stubs instead.
default_to_stubs: true,
// Enable api lint. This will eventually become the default for java_sdk_library
// but it cannot yet be turned on because some usages have not been cleaned up.
// TODO(b/156126315) - Remove when no longer needed.
api_lint: {
enabled: true,
},
// The API scope specific properties.
public: {
enabled: true,
sdk_version: "module_current",
},
system: {
enabled: true,
sdk_version: "module_current",
},
module_lib: {
enabled: true,
sdk_version: "module_current",
},
// Configure framework module specific metalava options.
droiddoc_options: [mainline_stubs_args],
// The stub libraries must be visible to frameworks/base so they can be combined
// into API specific libraries.
stubs_library_visibility: [
"//frameworks/base", // Framework
],
// Set the visibility of the modules creating the stubs source.
stubs_source_visibility: [
// Ignore any visibility rules specified on the java_sdk_library when
// setting the visibility of the stubs source modules.
"//visibility:override",
// Currently, the stub source is not required for anything other than building
// the stubs library so is private to avoid misuse.
"//visibility:private",
],
// Collates API usages from each module for further analysis.
plugins: ["java_api_finder"],
// Mainline modules should only rely on 'module_lib' APIs provided by other modules
// and the non updatable parts of the platform.
sdk_version: "module_current",
}
stubs_defaults {
name: "framework-module-stubs-defaults-publicapi",
args: mainline_framework_stubs_args,
installable: false,
sdk_version: "current",
filter_packages: framework_packages_to_document,
check_api: {
current: {
api_file: "api/current.txt",
removed_api_file: "api/removed.txt",
},
},
}
stubs_defaults {
name: "framework-module-stubs-defaults-systemapi",
args: mainline_framework_stubs_args + priv_apps,
libs: ["framework-annotations-lib"],
installable: false,
sdk_version: "system_current",
filter_packages: framework_packages_to_document,
check_api: {
current: {
api_file: "api/system-current.txt",
removed_api_file: "api/system-removed.txt",
},
},
}
java_defaults {
name: "framework-module-stubs-lib-defaults-publicapi",
installable: false,
sdk_version: "module_current",
}
java_defaults {
name: "framework-module-stubs-lib-defaults-systemapi",
installable: false,
sdk_version: "module_current",
}
java_defaults {
name: "framework-module-stubs-lib-defaults-module_libs_api",
installable: false,
sdk_version: "module_current",
}
// The defaults for module_libs comes in two parts - defaults for API checks
// and defaults for stub generation. This is because we want the API txt
// files to *only* include the module_libs_api, but the stubs to include
// module_libs_api as well as priv_apps.
stubs_defaults {
name: "framework-module-api-defaults-module_libs_api",
args: mainline_framework_stubs_args + module_libs,
libs: ["framework-annotations-lib"],
installable: false,
sdk_version: "module_current",
filter_packages: framework_packages_to_document,
// Do not generate stubs as they are not needed
generate_stubs: false,
check_api: {
current: {
api_file: "api/module-lib-current.txt",
removed_api_file: "api/module-lib-removed.txt",
},
},
}
stubs_defaults {
name: "framework-module-stubs-defaults-module_libs_api",
args: mainline_framework_stubs_args + module_libs + priv_apps,
libs: ["framework-annotations-lib"],
installable: false,
sdk_version: "module_current",
filter_packages: framework_packages_to_document,
}
stubs_defaults {
name: "service-module-stubs-srcs-defaults",
args: mainline_service_stubs_args,
installable: false,
filter_packages: ["com.android."],
check_api: {
current: {
api_file: "api/current.txt",
removed_api_file: "api/removed.txt",
},
},
}
// Empty for now, but a convenient place to add rules for all
// module java_library system_server stub libs.
java_defaults {
name: "service-module-stubs-defaults",
}
|
