blob: 5c6408940b343b36148eb9abf1ccfa3a2f4f8332 [file] [log] [blame]
Adam Lesinski59e04c62016-02-04 15:59:23 -08001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Adam Lesinski5bd44232017-09-07 09:39:07 -070017syntax = "proto3";
18
Adam Lesinskib58c3ef2017-09-12 17:39:52 -070019import "frameworks/base/tools/aapt2/Configuration.proto";
20
Adam Lesinski5bd44232017-09-07 09:39:07 -070021package aapt.pb;
Adam Lesinski59e04c62016-02-04 15:59:23 -080022
Adam Lesinski4ffea042017-08-10 15:37:28 -070023option java_package = "com.android.aapt";
Adam Lesinski59e04c62016-02-04 15:59:23 -080024
Adam Lesinski0c808952017-07-10 05:40:39 -070025// A string pool that wraps the binary form of the C++ class android::ResStringPool.
Adam Lesinski59e04c62016-02-04 15:59:23 -080026message StringPool {
Adam Lesinski5bd44232017-09-07 09:39:07 -070027 bytes data = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -080028}
29
Adam Lesinski4ffea042017-08-10 15:37:28 -070030// The position of a declared entity within a file.
31message SourcePosition {
Adam Lesinski5bd44232017-09-07 09:39:07 -070032 uint32 line_number = 1;
33 uint32 column_number = 2;
Adam Lesinski4ffea042017-08-10 15:37:28 -070034}
35
Adam Lesinski0c808952017-07-10 05:40:39 -070036// Developer friendly source file information for an entity in the resource table.
Adam Lesinski59e04c62016-02-04 15:59:23 -080037message Source {
Adam Lesinski0c808952017-07-10 05:40:39 -070038 // The index of the string path within the source string pool of a ResourceTable.
Adam Lesinski5bd44232017-09-07 09:39:07 -070039 uint32 path_idx = 1;
40 SourcePosition position = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -070041}
42
Ryan Mitchell34039b22019-03-18 08:57:47 -070043// The name and version fingerprint of a build tool.
44message ToolFingerprint {
45 string tool = 1;
46 string version = 2;
47}
48
Rico Winde70bbb12022-11-11 09:37:54 +010049// References to non local resources
50message DynamicRefTable {
51 PackageId package_id = 1;
52 string package_name = 2;
53}
54
55
Adam Lesinski0c808952017-07-10 05:40:39 -070056// Top level message representing a resource table.
57message ResourceTable {
Adam Lesinski0c808952017-07-10 05:40:39 -070058 // The string pool containing source paths referenced throughout the resource table. This does
59 // not end up in the final binary ARSC file.
Adam Lesinski5bd44232017-09-07 09:39:07 -070060 StringPool source_pool = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -070061
62 // Resource definitions corresponding to an Android package.
Adam Lesinski4ffea042017-08-10 15:37:28 -070063 repeated Package package = 2;
Ryan Mitchell54237ff2018-12-13 15:44:29 -080064
65 // The <overlayable> declarations within the resource table.
66 repeated Overlayable overlayable = 3;
Ryan Mitchell34039b22019-03-18 08:57:47 -070067
68 // The version fingerprints of the tools that built the resource table.
69 repeated ToolFingerprint tool_fingerprint = 4;
Rico Winde70bbb12022-11-11 09:37:54 +010070
71 repeated DynamicRefTable dynamic_ref_table = 5;
Adam Lesinski0c808952017-07-10 05:40:39 -070072}
73
Adam Lesinski5bd44232017-09-07 09:39:07 -070074// A package ID in the range [0x00, 0xff].
75message PackageId {
76 uint32 id = 1;
77}
78
Adam Lesinski0c808952017-07-10 05:40:39 -070079// Defines resources for an Android package.
80message Package {
81 // The package ID of this package, in the range [0x00, 0xff].
Adam Lesinski5bd44232017-09-07 09:39:07 -070082 // - ID 0x00 is reserved for shared libraries, or when the ID is assigned at run-time.
83 // - ID 0x01 is reserved for the 'android' package (framework).
84 // - ID range [0x02, 0x7f) is reserved for auto-assignment to shared libraries at run-time.
85 // - ID 0x7f is reserved for the application package.
86 // - IDs > 0x7f are reserved for the application as well and are treated as feature splits.
87 // This may not be set if no ID was assigned.
88 PackageId package_id = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -070089
90 // The Java compatible Android package name of the app.
Adam Lesinski5bd44232017-09-07 09:39:07 -070091 string package_name = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -070092
93 // The series of types defined by the package.
Adam Lesinski4ffea042017-08-10 15:37:28 -070094 repeated Type type = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -070095}
96
Adam Lesinski5bd44232017-09-07 09:39:07 -070097// A type ID in the range [0x01, 0xff].
98message TypeId {
99 uint32 id = 1;
100}
101
Adam Lesinski0c808952017-07-10 05:40:39 -0700102// A set of resources grouped under a common type. Such types include string, layout, xml, dimen,
103// attr, etc. This maps to the second part of a resource identifier in Java (R.type.entry).
104message Type {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700105 // The ID of the type. This may not be set if no ID was assigned.
106 TypeId type_id = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700107
108 // The name of the type. This corresponds to the 'type' part of a full resource name of the form
109 // package:type/entry. The set of legal type names is listed in Resource.cpp.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700110 string name = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700111
112 // The entries defined for this type.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700113 repeated Entry entry = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700114}
115
Adam Lesinski71be7052017-12-12 16:48:07 -0800116// The Visibility of a symbol/entry (public, private, undefined).
117message Visibility {
Adam Lesinski0c808952017-07-10 05:40:39 -0700118 // The visibility of the resource outside of its package.
Adam Lesinski71be7052017-12-12 16:48:07 -0800119 enum Level {
Adam Lesinski0c808952017-07-10 05:40:39 -0700120 // No visibility was explicitly specified. This is typically treated as private.
121 // The distinction is important when two separate R.java files are generated: a public and
122 // private one. An unknown visibility, in this case, would cause the resource to be omitted
123 // from either R.java.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700124 UNKNOWN = 0;
Adam Lesinski0c808952017-07-10 05:40:39 -0700125
126 // A resource was explicitly marked as private. This means the resource can not be accessed
127 // outside of its package unless the @*package:type/entry notation is used (the asterisk being
128 // the private accessor). If two R.java files are generated (private + public), the resource
129 // will only be emitted to the private R.java file.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700130 PRIVATE = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700131
132 // A resource was explicitly marked as public. This means the resource can be accessed
133 // from any package, and is emitted into all R.java files, public and private.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700134 PUBLIC = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700135 }
136
Adam Lesinski71be7052017-12-12 16:48:07 -0800137 Level level = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700138
139 // The path at which this entry's visibility was defined (eg. public.xml).
Adam Lesinski5bd44232017-09-07 09:39:07 -0700140 Source source = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700141
142 // The comment associated with the <public> tag.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700143 string comment = 3;
Ryan Mitchell2e9bec12021-03-22 09:31:00 -0700144
145 // Indicates that the resource id may change across builds and that the public R.java identifier
146 // for this resource should not be final. This is set to `true` for resources in `staging-group`
147 // tags.
148 bool staged_api = 4;
Adam Lesinski71be7052017-12-12 16:48:07 -0800149}
Adam Lesinski0c808952017-07-10 05:40:39 -0700150
Adam Lesinski71be7052017-12-12 16:48:07 -0800151// Whether a resource comes from a compile-time overlay and is explicitly allowed to not overlay an
152// existing resource.
153message AllowNew {
154 // Where this was defined in source.
155 Source source = 1;
156
157 // Any comment associated with the declaration.
158 string comment = 2;
159}
160
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800161// Represents a set of overlayable resources.
Adam Lesinski71be7052017-12-12 16:48:07 -0800162message Overlayable {
Winsonb2d7f532019-02-04 16:32:43 -0800163 // The name of the <overlayable>.
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800164 string name = 1;
165
Winsonb2d7f532019-02-04 16:32:43 -0800166 // The location of the <overlayable> declaration in the source.
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800167 Source source = 2;
168
169 // The component responsible for enabling and disabling overlays targeting this <overlayable>.
170 string actor = 3;
171}
172
173// Represents an overlayable <item> declaration within an <overlayable> tag.
174message OverlayableItem {
Ryan Mitchelle4e989c2018-10-29 02:21:50 -0700175 enum Policy {
Winson6bee4252019-02-13 07:57:24 -0800176 NONE = 0;
177 PUBLIC = 1;
178 SYSTEM = 2;
179 VENDOR = 3;
180 PRODUCT = 4;
181 SIGNATURE = 5;
Ryan Mitchell939df092019-04-09 17:13:50 -0700182 ODM = 6;
183 OEM = 7;
Winsonf56ade32019-12-04 11:32:41 -0800184 ACTOR = 8;
Zoran Jovanovic9336d9e2020-06-09 18:51:57 +0200185 CONFIG_SIGNATURE = 9;
Ryan Mitchelle4e989c2018-10-29 02:21:50 -0700186 }
187
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800188 // The location of the <item> declaration in source.
Adam Lesinski71be7052017-12-12 16:48:07 -0800189 Source source = 1;
190
191 // Any comment associated with the declaration.
192 string comment = 2;
Ryan Mitchelle4e989c2018-10-29 02:21:50 -0700193
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800194 // The policy defined by the enclosing <policy> tag of this <item>.
Ryan Mitchell1bb1fe02018-11-16 11:21:41 -0800195 repeated Policy policy = 3;
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800196
197 // The index into overlayable list that points to the <overlayable> tag that contains
198 // this <item>.
199 uint32 overlayable_idx = 4;
Adam Lesinski5bd44232017-09-07 09:39:07 -0700200}
201
Ryan Mitchell2fedba92021-04-23 07:47:38 -0700202// The staged resource ID definition of a finalized resource.
203message StagedId {
204 Source source = 1;
205 uint32 staged_id = 2;
206}
207
Adam Lesinski5bd44232017-09-07 09:39:07 -0700208// An entry ID in the range [0x0000, 0xffff].
209message EntryId {
210 uint32 id = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700211}
212
213// An entry declaration. An entry has a full resource ID that is the combination of package ID,
214// type ID, and its own entry ID. An entry on its own has no value, but values are defined for
215// various configurations/variants.
216message Entry {
217 // The ID of this entry. Together with the package ID and type ID, this forms a full resource ID
218 // of the form 0xPPTTEEEE, where PP is the package ID, TT is the type ID, and EEEE is the entry
219 // ID.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700220 // This may not be set if no ID was assigned.
221 EntryId entry_id = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700222
223 // The name of this entry. This corresponds to the 'entry' part of a full resource name of the
224 // form package:type/entry.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700225 string name = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700226
Adam Lesinski71be7052017-12-12 16:48:07 -0800227 // The visibility of this entry (public, private, undefined).
228 Visibility visibility = 3;
229
230 // Whether this resource, when originating from a compile-time overlay, is allowed to NOT overlay
231 // any existing resources.
232 AllowNew allow_new = 4;
233
234 // Whether this resource can be overlaid by a runtime resource overlay (RRO).
Ryan Mitchell54237ff2018-12-13 15:44:29 -0800235 OverlayableItem overlayable_item = 5;
Adam Lesinski0c808952017-07-10 05:40:39 -0700236
237 // The set of values defined for this entry, each corresponding to a different
238 // configuration/variant.
Adam Lesinski71be7052017-12-12 16:48:07 -0800239 repeated ConfigValue config_value = 6;
Ryan Mitchell2fedba92021-04-23 07:47:38 -0700240
241 // The staged resource ID of this finalized resource.
242 StagedId staged_id = 7;
Adam Lesinski0c808952017-07-10 05:40:39 -0700243}
244
245// A Configuration/Value pair.
246message ConfigValue {
Adam Lesinskib58c3ef2017-09-12 17:39:52 -0700247 Configuration config = 1;
Adam Lesinski5bd44232017-09-07 09:39:07 -0700248 Value value = 2;
Jeremy Meyerd52bd682024-08-14 11:16:58 -0700249 reserved 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700250}
251
252// The generic meta-data for every value in a resource table.
253message Value {
254 // Where the value was defined.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700255 Source source = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700256
257 // Any comment associated with the value.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700258 string comment = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700259
260 // Whether the value can be overridden.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700261 bool weak = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700262
Adam Lesinski5bd44232017-09-07 09:39:07 -0700263 // The value is either an Item or a CompoundValue.
264 oneof value {
265 Item item = 4;
266 CompoundValue compound_value = 5;
267 }
Adam Lesinski0c808952017-07-10 05:40:39 -0700268}
269
270// An Item is an abstract type. It represents a value that can appear inline in many places, such
271// as XML attribute values or on the right hand side of style attribute definitions. The concrete
272// type is one of the types below. Only one can be set.
273message Item {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700274 oneof value {
275 Reference ref = 1;
276 String str = 2;
277 RawString raw_str = 3;
278 StyledString styled_str = 4;
279 FileReference file = 5;
280 Id id = 6;
281 Primitive prim = 7;
282 }
Jeremy Meyerd52bd682024-08-14 11:16:58 -0700283
284 // The status of the flag the value is behind if any
285 uint32 flag_status = 8;
Adam Lesinski0c808952017-07-10 05:40:39 -0700286}
287
288// A CompoundValue is an abstract type. It represents a value that is a made of other values.
289// These can only usually appear as top-level resources. The concrete type is one of the types
290// below. Only one can be set.
291message CompoundValue {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700292 oneof value {
293 Attribute attr = 1;
294 Style style = 2;
295 Styleable styleable = 3;
296 Array array = 4;
297 Plural plural = 5;
Ryan Mitchell326e35ff2021-04-12 07:50:42 -0700298 MacroBody macro = 6;
Adam Lesinski5bd44232017-09-07 09:39:07 -0700299 }
Adam Lesinski0c808952017-07-10 05:40:39 -0700300}
301
Clark DuValle9fedbe2020-01-09 11:52:52 -0800302// Message holding a boolean, so it can be optionally encoded.
303message Boolean {
304 bool value = 1;
305}
306
Adam Lesinski0c808952017-07-10 05:40:39 -0700307// A value that is a reference to another resource. This reference can be by name or resource ID.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800308message Reference {
Adam Lesinski0c808952017-07-10 05:40:39 -0700309 enum Type {
310 // A plain reference (@package:type/entry).
Adam Lesinski4ffea042017-08-10 15:37:28 -0700311 REFERENCE = 0;
Adam Lesinski0c808952017-07-10 05:40:39 -0700312
313 // A reference to a theme attribute (?package:type/entry).
Adam Lesinski4ffea042017-08-10 15:37:28 -0700314 ATTRIBUTE = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700315 }
316
Adam Lesinski5bd44232017-09-07 09:39:07 -0700317 Type type = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700318
Adam Lesinski5bd44232017-09-07 09:39:07 -0700319 // The resource ID (0xPPTTEEEE) of the resource being referred. This is optional.
320 uint32 id = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700321
Adam Lesinski5bd44232017-09-07 09:39:07 -0700322 // The name of the resource being referred. This is optional if the resource ID is set.
323 string name = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700324
325 // Whether this reference is referencing a private resource (@*package:type/entry).
Adam Lesinski5bd44232017-09-07 09:39:07 -0700326 bool private = 4;
Clark DuValle9fedbe2020-01-09 11:52:52 -0800327
328 // Whether this reference is dynamic.
329 Boolean is_dynamic = 5;
Ryan Mitchell326e35ff2021-04-12 07:50:42 -0700330
331 // The type flags used when compiling the reference. Used for substituting the contents of macros.
332 uint32 type_flags = 6;
333
334 // Whether raw string values would have been accepted in place of this reference definition. Used
335 // for substituting the contents of macros.
336 bool allow_raw = 7;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800337}
338
Adam Lesinski0c808952017-07-10 05:40:39 -0700339// A value that represents an ID. This is just a placeholder, as ID values are used to occupy a
340// resource ID (0xPPTTEEEE) as a unique identifier. Their value is unimportant.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800341message Id {
342}
343
Adam Lesinski0c808952017-07-10 05:40:39 -0700344// A value that is a string.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800345message String {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700346 string value = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800347}
348
Adam Lesinski0c808952017-07-10 05:40:39 -0700349// A value that is a raw string, which is unescaped/uninterpreted. This is typically used to
350// represent the value of a style attribute before the attribute is compiled and the set of
351// allowed values is known.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800352message RawString {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700353 string value = 1;
Adam Lesinski08535002017-08-04 16:15:17 -0700354}
355
356// A string with styling information, like html tags that specify boldness, italics, etc.
357message StyledString {
358 // The raw text of the string.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700359 string value = 1;
Adam Lesinski08535002017-08-04 16:15:17 -0700360
361 // A Span marks a region of the string text that is styled.
362 message Span {
363 // The name of the tag, and its attributes, encoded as follows:
364 // tag_name;attr1=value1;attr2=value2;[...]
Adam Lesinski5bd44232017-09-07 09:39:07 -0700365 string tag = 1;
Adam Lesinski08535002017-08-04 16:15:17 -0700366
367 // The first character position this span applies to, in UTF-16 offset.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700368 uint32 first_char = 2;
Adam Lesinski08535002017-08-04 16:15:17 -0700369
370 // The last character position this span applies to, in UTF-16 offset.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700371 uint32 last_char = 3;
Adam Lesinski08535002017-08-04 16:15:17 -0700372 }
373
374 repeated Span span = 2;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800375}
376
Adam Lesinski0c808952017-07-10 05:40:39 -0700377// A value that is a reference to an external entity, like an XML file or a PNG.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800378message FileReference {
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700379 enum Type {
380 UNKNOWN = 0;
381 PNG = 1;
382 BINARY_XML = 2;
383 PROTO_XML = 3;
384 }
385
Adam Lesinski08535002017-08-04 16:15:17 -0700386 // Path to a file within the APK (typically res/type-config/entry.ext).
Adam Lesinski5bd44232017-09-07 09:39:07 -0700387 string path = 1;
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700388
389 // The type of file this path points to. For UAM bundle, this cannot be
390 // BINARY_XML.
391 Type type = 2;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800392}
393
Adam Lesinski0c808952017-07-10 05:40:39 -0700394// A value that represents a primitive data type (float, int, boolean, etc.).
Michael Wachenschwanz8b749272018-04-18 18:52:47 -0700395// Refer to Res_value in ResourceTypes.h for info on types and formatting
Adam Lesinski59e04c62016-02-04 15:59:23 -0800396message Primitive {
Michael Wachenschwanzd06f1f32018-01-11 18:36:22 -0800397 message NullType {
398 }
399 message EmptyType {
400 }
401 oneof oneof_value {
402 NullType null_value = 1;
403 EmptyType empty_value = 2;
404 float float_value = 3;
Michael Wachenschwanz8b749272018-04-18 18:52:47 -0700405 uint32 dimension_value = 13;
406 uint32 fraction_value = 14;
Michael Wachenschwanzd06f1f32018-01-11 18:36:22 -0800407 int32 int_decimal_value = 6;
Dave Ingram22ed4122018-01-30 16:11:52 -0800408 uint32 int_hexadecimal_value = 7;
Michael Wachenschwanzd06f1f32018-01-11 18:36:22 -0800409 bool boolean_value = 8;
410 uint32 color_argb8_value = 9;
411 uint32 color_rgb8_value = 10;
412 uint32 color_argb4_value = 11;
413 uint32 color_rgb4_value = 12;
Michael Wachenschwanz8b749272018-04-18 18:52:47 -0700414 float dimension_value_deprecated = 4 [deprecated=true];
415 float fraction_value_deprecated = 5 [deprecated=true];
Michael Wachenschwanzd06f1f32018-01-11 18:36:22 -0800416 }
Adam Lesinski59e04c62016-02-04 15:59:23 -0800417}
418
Adam Lesinski0c808952017-07-10 05:40:39 -0700419// A value that represents an XML attribute and what values it accepts.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800420message Attribute {
Adam Lesinski0c808952017-07-10 05:40:39 -0700421 // A Symbol used to represent an enum or a flag.
422 message Symbol {
423 // Where the enum/flag item was defined.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700424 Source source = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700425
426 // Any comments associated with the enum or flag.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700427 string comment = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700428
429 // The name of the enum/flag as a reference. Enums/flag items are generated as ID resource
430 // values.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700431 Reference name = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700432
433 // The value of the enum/flag.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700434 uint32 value = 4;
Ryan Mitchellc1676802019-05-20 16:47:08 -0700435
436 // The data type of the enum/flag as defined in android::Res_value.
437 uint32 type = 5;
Adam Lesinski0c808952017-07-10 05:40:39 -0700438 }
439
Adam Lesinski4ffea042017-08-10 15:37:28 -0700440 // Bitmask of formats allowed for an attribute.
441 enum FormatFlags {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700442 NONE = 0x0; // Proto3 requires a default of 0.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700443 ANY = 0x0000ffff; // Allows any type except ENUM and FLAGS.
444 REFERENCE = 0x01; // Allows Reference values.
445 STRING = 0x02; // Allows String/StyledString values.
446 INTEGER = 0x04; // Allows any integer BinaryPrimitive values.
447 BOOLEAN = 0x08; // Allows any boolean BinaryPrimitive values.
448 COLOR = 0x010; // Allows any color BinaryPrimitive values.
449 FLOAT = 0x020; // Allows any float BinaryPrimitive values.
450 DIMENSION = 0x040; // Allows any dimension BinaryPrimitive values.
451 FRACTION = 0x080; // Allows any fraction BinaryPrimitive values.
452 ENUM = 0x00010000; // Allows enums that are defined in the Attribute's symbols.
453 // ENUM and FLAGS cannot BOTH be set.
454 FLAGS = 0x00020000; // Allows flags that are defined in the Attribute's symbols.
455 // ENUM and FLAGS cannot BOTH be set.
456 }
457
458 // A bitmask of types that this XML attribute accepts. Corresponds to the flags in the
459 // enum FormatFlags.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700460 uint32 format_flags = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700461
462 // The smallest integer allowed for this XML attribute. Only makes sense if the format includes
Adam Lesinski4ffea042017-08-10 15:37:28 -0700463 // FormatFlags::INTEGER.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700464 int32 min_int = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700465
466 // The largest integer allowed for this XML attribute. Only makes sense if the format includes
Adam Lesinski4ffea042017-08-10 15:37:28 -0700467 // FormatFlags::INTEGER.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700468 int32 max_int = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700469
470 // The set of enums/flags defined in this attribute. Only makes sense if the format includes
Adam Lesinski4ffea042017-08-10 15:37:28 -0700471 // either FormatFlags::ENUM or FormatFlags::FLAGS. Having both is an error.
472 repeated Symbol symbol = 4;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800473}
474
Adam Lesinski0c808952017-07-10 05:40:39 -0700475// A value that represents a style.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800476message Style {
Adam Lesinski0c808952017-07-10 05:40:39 -0700477 // An XML attribute/value pair defined in the style.
478 message Entry {
479 // Where the entry was defined.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700480 Source source = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800481
Adam Lesinski0c808952017-07-10 05:40:39 -0700482 // Any comments associated with the entry.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700483 string comment = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700484
485 // A reference to the XML attribute.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700486 Reference key = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700487
488 // The Item defined for this XML attribute.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700489 Item item = 4;
Adam Lesinski0c808952017-07-10 05:40:39 -0700490 }
491
492 // The optinal style from which this style inherits attributes.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700493 Reference parent = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700494
495 // The source file information of the parent inheritance declaration.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700496 Source parent_source = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700497
498 // The set of XML attribute/value pairs for this style.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700499 repeated Entry entry = 3;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800500}
501
Adam Lesinski0c808952017-07-10 05:40:39 -0700502// A value that represents a <declare-styleable> XML resource. These are not real resources and
503// only end up as Java fields in the generated R.java. They do not end up in the binary ARSC file.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800504message Styleable {
Adam Lesinski0c808952017-07-10 05:40:39 -0700505 // An attribute defined for this styleable.
506 message Entry {
507 // Where the attribute was defined within the <declare-styleable> block.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700508 Source source = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700509
510 // Any comments associated with the declaration.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700511 string comment = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700512
513 // The reference to the attribute.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700514 Reference attr = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700515 }
516
517 // The set of attribute declarations.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700518 repeated Entry entry = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800519}
520
Adam Lesinski0c808952017-07-10 05:40:39 -0700521// A value that represents an array of resource values.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800522message Array {
Adam Lesinski0c808952017-07-10 05:40:39 -0700523 // A single element of the array.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700524 message Element {
Adam Lesinski0c808952017-07-10 05:40:39 -0700525 // Where the element was defined.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700526 Source source = 1;
Adam Lesinski0c808952017-07-10 05:40:39 -0700527
528 // Any comments associated with the element.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700529 string comment = 2;
Adam Lesinski0c808952017-07-10 05:40:39 -0700530
531 // The value assigned to this element.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700532 Item item = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700533 }
534
535 // The list of array elements.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700536 repeated Element element = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800537}
538
Adam Lesinski0c808952017-07-10 05:40:39 -0700539// A value that represents a string and its many variations based on plurality.
Adam Lesinski59e04c62016-02-04 15:59:23 -0800540message Plural {
Adam Lesinski0c808952017-07-10 05:40:39 -0700541 // The arity of the plural.
542 enum Arity {
Adam Lesinski4ffea042017-08-10 15:37:28 -0700543 ZERO = 0;
544 ONE = 1;
545 TWO = 2;
546 FEW = 3;
547 MANY = 4;
548 OTHER = 5;
Adam Lesinski0c808952017-07-10 05:40:39 -0700549 }
Adam Lesinski59e04c62016-02-04 15:59:23 -0800550
Adam Lesinski0c808952017-07-10 05:40:39 -0700551 // The plural value for a given arity.
552 message Entry {
553 // Where the plural was defined.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700554 Source source = 1;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800555
Adam Lesinski0c808952017-07-10 05:40:39 -0700556 // Any comments associated with the plural.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700557 string comment = 2;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800558
Adam Lesinski0c808952017-07-10 05:40:39 -0700559 // The arity of the plural.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700560 Arity arity = 3;
Adam Lesinski0c808952017-07-10 05:40:39 -0700561
562 // The value assigned to this plural.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700563 Item item = 4;
Adam Lesinski0c808952017-07-10 05:40:39 -0700564 }
565
566 // The set of arity/plural mappings.
Adam Lesinski4ffea042017-08-10 15:37:28 -0700567 repeated Entry entry = 1;
568}
569
570// Defines an abstract XmlNode that must be either an XmlElement, or
571// a text node represented by a string.
572message XmlNode {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700573 oneof node {
574 XmlElement element = 1;
575 string text = 2;
576 }
Adam Lesinski4ffea042017-08-10 15:37:28 -0700577
578 // Source line and column info.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700579 SourcePosition source = 3;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700580}
581
582// An <element> in an XML document.
583message XmlElement {
584 // Namespaces defined on this element.
585 repeated XmlNamespace namespace_declaration = 1;
586
587 // The namespace URI of this element.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700588 string namespace_uri = 2;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700589
590 // The name of this element.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700591 string name = 3;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700592
593 // The attributes of this element.
594 repeated XmlAttribute attribute = 4;
595
596 // The children of this element.
597 repeated XmlNode child = 5;
598}
599
600// A namespace declaration on an XmlElement (xmlns:android="http://...").
601message XmlNamespace {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700602 string prefix = 1;
603 string uri = 2;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700604
605 // Source line and column info.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700606 SourcePosition source = 3;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700607}
608
609// An attribute defined on an XmlElement (android:text="...").
610message XmlAttribute {
Adam Lesinski5bd44232017-09-07 09:39:07 -0700611 string namespace_uri = 1;
612 string name = 2;
613 string value = 3;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700614
615 // Source line and column info.
Adam Lesinski5bd44232017-09-07 09:39:07 -0700616 SourcePosition source = 4;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700617
Adam Lesinski5bd44232017-09-07 09:39:07 -0700618 // The optional resource ID (0xPPTTEEEE) of the attribute.
619 uint32 resource_id = 5;
Adam Lesinski4ffea042017-08-10 15:37:28 -0700620
Adam Lesinski5bd44232017-09-07 09:39:07 -0700621 // The optional interpreted/compiled version of the `value` string.
622 Item compiled_item = 6;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800623}
Ryan Mitchell326e35ff2021-04-12 07:50:42 -0700624
625message MacroBody {
626 string raw_string = 1;
627 StyleString style_string = 2;
628 repeated UntranslatableSection untranslatable_sections = 3;
629 repeated NamespaceAlias namespace_stack = 4;
630 SourcePosition source = 5;
631}
632
633message NamespaceAlias {
634 string prefix = 1;
635 string package_name = 2;
636 bool is_private = 3;
637}
638
639message StyleString {
640 message Span {
641 string name = 1;
642 uint32 start_index = 2;
643 uint32 end_index = 3;
644 }
645 string str = 1;
646 repeated Span spans = 2;
647}
648
649message UntranslatableSection {
650 uint64 start_index = 1;
651 uint64 end_index = 2;
Jeremy Meyer56f36e82022-05-20 20:35:42 +0000652}