package aapt.pb

Get desktop application:
View/edit binary Protocol Buffers messages

Whether a resource comes from a compile-time overlay and is explicitly allowed to not overlay an existing resource.

Used in: Entry

• optional Source source = 1

  Where this was defined in source.

• string comment = 2

  Any comment associated with the declaration.

A value that represents an array of resource values.

Used in: CompoundValue

• repeated Array.Element element = 1

  The list of array elements.

A single element of the array.

Used in: Array

• optional Source source = 1

  Where the element was defined.

• string comment = 2

  Any comments associated with the element.

• optional Item item = 3

  The value assigned to this element.

A value that represents an XML attribute and what values it accepts.

Used in: CompoundValue

• uint32 format_flags = 1

  A bitmask of types that this XML attribute accepts. Corresponds to the flags in the enum FormatFlags.

• int32 min_int = 2

  The smallest integer allowed for this XML attribute. Only makes sense if the format includes FormatFlags::INTEGER.

• int32 max_int = 3

  The largest integer allowed for this XML attribute. Only makes sense if the format includes FormatFlags::INTEGER.

• repeated Attribute.Symbol symbol = 4

  The set of enums/flags defined in this attribute. Only makes sense if the format includes either FormatFlags::ENUM or FormatFlags::FLAGS. Having both is an error.

Bitmask of formats allowed for an attribute.

• NONE = 0

  Proto3 requires a default of 0.

• ANY = 65535

  Allows any type except ENUM and FLAGS.

• REFERENCE = 1

  Allows Reference values.

• STRING = 2

  Allows String/StyledString values.

• INTEGER = 4

  Allows any integer BinaryPrimitive values.

• BOOLEAN = 8

  Allows any boolean BinaryPrimitive values.

• COLOR = 16

  Allows any color BinaryPrimitive values.

• FLOAT = 32

  Allows any float BinaryPrimitive values.

• DIMENSION = 64

  Allows any dimension BinaryPrimitive values.

• FRACTION = 128

  Allows any fraction BinaryPrimitive values.

• ENUM = 65536

  Allows enums that are defined in the Attribute's

• FLAGS = 131072

  symbols. ENUM and FLAGS cannot BOTH be set.

  Allows flags that are defined in the Attribute's

A Symbol used to represent an enum or a flag.

Used in: Attribute

• optional Source source = 1

  Where the enum/flag item was defined.

• string comment = 2

  Any comments associated with the enum or flag.

• optional Reference name = 3

  The name of the enum/flag as a reference. Enums/flag items are generated as ID resource values.

• uint32 value = 4

  The value of the enum/flag.

• uint32 type = 5

  The data type of the enum/flag as defined in android::Res_value.

Message holding a boolean, so it can be optionally encoded.

Used in: Reference

• bool value = 1

A CompoundValue is an abstract type. It represents a value that is a made of other values. These can only usually appear as top-level resources. The concrete type is one of the types below. Only one can be set.

Used in: Value

• oneof value

  • Attribute attr = 1

  • Style style = 2

  • Styleable styleable = 3

  • Array array = 4

  • Plural plural = 5

  • MacroBody macro = 6

A Configuration/Value pair.

Used in: Entry

• optional Configuration config = 1

• optional Value value = 2

A description of the requirements a device must have in order for a resource to be matched and selected.

Used in: ConfigValue

• uint32 mcc = 1

  Mobile country code.

• uint32 mnc = 2

  Mobile network code.

• string locale = 3

  BCP-47 locale tag.

• Configuration.LayoutDirection layout_direction = 4

  Left-to-right, right-to-left...

• uint32 screen_width = 5

  Screen width in pixels. Prefer screen_width_dp.

• uint32 screen_height = 6

  Screen height in pixels. Prefer screen_height_dp.

• uint32 screen_width_dp = 7

  Screen width in density independent pixels (dp).

• uint32 screen_height_dp = 8

  Screen height in density independent pixels (dp).

• uint32 smallest_screen_width_dp = 9

  The smallest screen dimension, regardless of orientation, in dp.

• Configuration.ScreenLayoutSize screen_layout_size = 10

  Whether the device screen is classified as small, normal, large, xlarge.

• Configuration.ScreenLayoutLong screen_layout_long = 11

  Whether the device screen is long.

• Configuration.ScreenRound screen_round = 12

  Whether the screen is round (Android Wear).

• Configuration.WideColorGamut wide_color_gamut = 13

  Whether the screen supports wide color gamut.

• Configuration.Hdr hdr = 14

  Whether the screen has high dynamic range.

• Configuration.Orientation orientation = 15

  Which orientation the device is in (portrait, landscape).

• Configuration.UiModeType ui_mode_type = 16

  Which type of UI mode the device is in (television, car, etc.).

• Configuration.UiModeNight ui_mode_night = 17

  Whether the device is in night mode.

• uint32 density = 18

  The device's screen density in dots-per-inch (dpi).

• Configuration.Touchscreen touchscreen = 19

  Whether a touchscreen exists, supports a stylus, or finger.

• Configuration.KeysHidden keys_hidden = 20

  Whether the keyboard hardware keys are currently hidden, exposed, or if the keyboard is a software keyboard.

• Configuration.Keyboard keyboard = 21

  The type of keyboard present (none, QWERTY, 12-key).

• Configuration.NavHidden nav_hidden = 22

  Whether the navigation is exposed or hidden.

• Configuration.Navigation navigation = 23

  The type of navigation present on the device (trackball, wheel, dpad, etc.).

• uint32 sdk_version = 24

  The minimum SDK version of the device.

• Configuration.GrammaticalGender grammatical_gender = 26

  Grammatical gender.

• string product = 25

Used in: Configuration

• GRAM_GENDER_USET = 0

• GRAM_GENDER_NEUTER = 1

• GRAM_GENDER_FEMININE = 2

• GRAM_GENDER_MASCULINE = 3

Used in: Configuration

• HDR_UNSET = 0

• HDR_HIGHDR = 1

• HDR_LOWDR = 2

Used in: Configuration

• KEYBOARD_UNSET = 0

• KEYBOARD_NOKEYS = 1

• KEYBOARD_QWERTY = 2

• KEYBOARD_TWELVEKEY = 3

Used in: Configuration

• KEYS_HIDDEN_UNSET = 0

• KEYS_HIDDEN_KEYSEXPOSED = 1

• KEYS_HIDDEN_KEYSHIDDEN = 2

• KEYS_HIDDEN_KEYSSOFT = 3

Used in: Configuration

• LAYOUT_DIRECTION_UNSET = 0

• LAYOUT_DIRECTION_LTR = 1

• LAYOUT_DIRECTION_RTL = 2

Used in: Configuration

• NAV_HIDDEN_UNSET = 0

• NAV_HIDDEN_NAVEXPOSED = 1

• NAV_HIDDEN_NAVHIDDEN = 2

Used in: Configuration

• NAVIGATION_UNSET = 0

• NAVIGATION_NONAV = 1

• NAVIGATION_DPAD = 2

• NAVIGATION_TRACKBALL = 3

• NAVIGATION_WHEEL = 4

Used in: Configuration

• ORIENTATION_UNSET = 0

• ORIENTATION_PORT = 1

• ORIENTATION_LAND = 2

• ORIENTATION_SQUARE = 3

Used in: Configuration

• SCREEN_LAYOUT_LONG_UNSET = 0

• SCREEN_LAYOUT_LONG_LONG = 1

• SCREEN_LAYOUT_LONG_NOTLONG = 2

Used in: Configuration

• SCREEN_LAYOUT_SIZE_UNSET = 0

• SCREEN_LAYOUT_SIZE_SMALL = 1

• SCREEN_LAYOUT_SIZE_NORMAL = 2

• SCREEN_LAYOUT_SIZE_LARGE = 3

• SCREEN_LAYOUT_SIZE_XLARGE = 4

Used in: Configuration

• SCREEN_ROUND_UNSET = 0

• SCREEN_ROUND_ROUND = 1

• SCREEN_ROUND_NOTROUND = 2

Used in: Configuration

• TOUCHSCREEN_UNSET = 0

• TOUCHSCREEN_NOTOUCH = 1

• TOUCHSCREEN_STYLUS = 2

• TOUCHSCREEN_FINGER = 3

Used in: Configuration

• UI_MODE_NIGHT_UNSET = 0

• UI_MODE_NIGHT_NIGHT = 1

• UI_MODE_NIGHT_NOTNIGHT = 2

Used in: Configuration

• UI_MODE_TYPE_UNSET = 0

• UI_MODE_TYPE_NORMAL = 1

• UI_MODE_TYPE_DESK = 2

• UI_MODE_TYPE_CAR = 3

• UI_MODE_TYPE_TELEVISION = 4

• UI_MODE_TYPE_APPLIANCE = 5

• UI_MODE_TYPE_WATCH = 6

• UI_MODE_TYPE_VRHEADSET = 7

Used in: Configuration

• WIDE_COLOR_GAMUT_UNSET = 0

• WIDE_COLOR_GAMUT_WIDECG = 1

• WIDE_COLOR_GAMUT_NOWIDECG = 2

References to non local resources

Used in: ResourceTable

• optional PackageId package_id = 1

• string package_name = 2

An entry declaration. An entry has a full resource ID that is the combination of package ID, type ID, and its own entry ID. An entry on its own has no value, but values are defined for various configurations/variants.

Used in: Type

• optional EntryId entry_id = 1

  The ID of this entry. Together with the package ID and type ID, this forms a full resource ID of the form 0xPPTTEEEE, where PP is the package ID, TT is the type ID, and EEEE is the entry ID. This may not be set if no ID was assigned.

• string name = 2

  The name of this entry. This corresponds to the 'entry' part of a full resource name of the form package:type/entry.

• optional Visibility visibility = 3

  The visibility of this entry (public, private, undefined).

• optional AllowNew allow_new = 4

  Whether this resource, when originating from a compile-time overlay, is allowed to NOT overlay any existing resources.

• optional OverlayableItem overlayable_item = 5

  Whether this resource can be overlaid by a runtime resource overlay (RRO).

• repeated ConfigValue config_value = 6

  The set of values defined for this entry, each corresponding to a different configuration/variant.

• optional StagedId staged_id = 7

  The staged resource ID of this finalized resource.

An entry ID in the range [0x0000, 0xffff].

Used in: Entry

• uint32 id = 1

A value that is a reference to an external entity, like an XML file or a PNG.

Used in: Item

• string path = 1

  Path to a file within the APK (typically res/type-config/entry.ext).

• FileReference.Type type = 2

  The type of file this path points to. For UAM bundle, this cannot be BINARY_XML.

Used in: FileReference

• UNKNOWN = 0

• PNG = 1

• BINARY_XML = 2

• PROTO_XML = 3

A value that represents an ID. This is just a placeholder, as ID values are used to occupy a resource ID (0xPPTTEEEE) as a unique identifier. Their value is unimportant.

Used in: Item

(message has no fields)

An Item is an abstract type. It represents a value that can appear inline in many places, such as XML attribute values or on the right hand side of style attribute definitions. The concrete type is one of the types below. Only one can be set.

Used in: Array.Element, Plural.Entry, Style.Entry, Value, XmlAttribute

• oneof value

  • Reference ref = 1

  • String str = 2

  • RawString raw_str = 3

  • StyledString styled_str = 4

  • FileReference file = 5

  • Id id = 6

  • Primitive prim = 7

Used in: CompoundValue

• string raw_string = 1

• optional StyleString style_string = 2

• repeated UntranslatableSection untranslatable_sections = 3

• repeated NamespaceAlias namespace_stack = 4

• optional SourcePosition source = 5

Used in: MacroBody

• string prefix = 1

• string package_name = 2

• bool is_private = 3

Represents a set of overlayable resources.

Used in: ResourceTable

• string name = 1

  The name of the <overlayable>.

• optional Source source = 2

  The location of the <overlayable> declaration in the source.

• string actor = 3

  The component responsible for enabling and disabling overlays targeting this <overlayable>.

Represents an overlayable <item> declaration within an <overlayable> tag.

Used in: Entry

• optional Source source = 1

  The location of the <item> declaration in source.

• string comment = 2

  Any comment associated with the declaration.

• repeated OverlayableItem.Policy policy = 3

  The policy defined by the enclosing <policy> tag of this <item>.

• uint32 overlayable_idx = 4

  The index into overlayable list that points to the <overlayable> tag that contains this <item>.

Used in: OverlayableItem

• NONE = 0

• PUBLIC = 1

• SYSTEM = 2

• VENDOR = 3

• PRODUCT = 4

• SIGNATURE = 5

• ODM = 6

• OEM = 7

• ACTOR = 8

• CONFIG_SIGNATURE = 9

Defines resources for an Android package.

Used in: ResourceTable

• optional PackageId package_id = 1

  The package ID of this package, in the range [0x00, 0xff]. - ID 0x00 is reserved for shared libraries, or when the ID is assigned at run-time. - ID 0x01 is reserved for the 'android' package (framework). - ID range [0x02, 0x7f) is reserved for auto-assignment to shared libraries at run-time. - ID 0x7f is reserved for the application package. - IDs > 0x7f are reserved for the application as well and are treated as feature splits. This may not be set if no ID was assigned.

• string package_name = 2

  The Java compatible Android package name of the app.

• repeated Type type = 3

  The series of types defined by the package.

A package ID in the range [0x00, 0xff].

Used in: DynamicRefTable, Package

• uint32 id = 1

A value that represents a string and its many variations based on plurality.

Used in: CompoundValue

• repeated Plural.Entry entry = 1

  The set of arity/plural mappings.

The arity of the plural.

Used in: Entry

• ZERO = 0

• ONE = 1

• TWO = 2

• FEW = 3

• MANY = 4

• OTHER = 5

The plural value for a given arity.

Used in: Plural

• optional Source source = 1

  Where the plural was defined.

• string comment = 2

  Any comments associated with the plural.

• Arity arity = 3

  The arity of the plural.

• optional Item item = 4

  The value assigned to this plural.

A value that represents a primitive data type (float, int, boolean, etc.). Refer to Res_value in ResourceTypes.h for info on types and formatting

Used in: Item

• oneof oneof_value

  • Primitive.NullType null_value = 1

  • Primitive.EmptyType empty_value = 2

  • float float_value = 3

  • uint32 dimension_value = 13

  • uint32 fraction_value = 14

  • int32 int_decimal_value = 6

  • uint32 int_hexadecimal_value = 7

  • bool boolean_value = 8

  • uint32 color_argb8_value = 9

  • uint32 color_rgb8_value = 10

  • uint32 color_argb4_value = 11

  • uint32 color_rgb4_value = 12

  • float dimension_value_deprecated = 4

  • float fraction_value_deprecated = 5

Used in: Primitive

(message has no fields)

Used in: Primitive

(message has no fields)

A value that is a raw string, which is unescaped/uninterpreted. This is typically used to represent the value of a style attribute before the attribute is compiled and the set of allowed values is known.

Used in: Item

• string value = 1

A value that is a reference to another resource. This reference can be by name or resource ID.

Used in: Attribute.Symbol, Item, Style, Style.Entry, Styleable.Entry

• Reference.Type type = 1

• uint32 id = 2

  The resource ID (0xPPTTEEEE) of the resource being referred. This is optional.

• string name = 3

  The name of the resource being referred. This is optional if the resource ID is set.

• bool private = 4

  Whether this reference is referencing a private resource (@*package:type/entry).

• optional Boolean is_dynamic = 5

  Whether this reference is dynamic.

• uint32 type_flags = 6

  The type flags used when compiling the reference. Used for substituting the contents of macros.

• bool allow_raw = 7

  Whether raw string values would have been accepted in place of this reference definition. Used for substituting the contents of macros.

Used in: Reference

• REFERENCE = 0

  A plain reference (@package:type/entry).

• ATTRIBUTE = 1

  A reference to a theme attribute (?package:type/entry).

Top level message representing a resource table.

• optional StringPool source_pool = 1

  The string pool containing source paths referenced throughout the resource table. This does not end up in the final binary ARSC file.

• repeated Package package = 2

  Resource definitions corresponding to an Android package.

• repeated Overlayable overlayable = 3

  The <overlayable> declarations within the resource table.

• repeated ToolFingerprint tool_fingerprint = 4

  The version fingerprints of the tools that built the resource table.

• repeated DynamicRefTable dynamic_ref_table = 5

Developer friendly source file information for an entity in the resource table.

Used in: AllowNew, Array.Element, Attribute.Symbol, Overlayable, OverlayableItem, Plural.Entry, StagedId, Style, Style.Entry, Styleable.Entry, Value, Visibility

• uint32 path_idx = 1

  The index of the string path within the source string pool of a ResourceTable.

• optional SourcePosition position = 2

The position of a declared entity within a file.

Used in: MacroBody, Source, XmlAttribute, XmlNamespace, XmlNode

• uint32 line_number = 1

• uint32 column_number = 2

The staged resource ID definition of a finalized resource.

Used in: Entry

• optional Source source = 1

• uint32 staged_id = 2

A value that is a string.

Used in: Item

• string value = 1

A string pool that wraps the binary form of the C++ class android::ResStringPool.

Used in: ResourceTable

• bytes data = 1

A value that represents a style.

Used in: CompoundValue

• optional Reference parent = 1

  The optinal style from which this style inherits attributes.

• optional Source parent_source = 2

  The source file information of the parent inheritance declaration.

• repeated Style.Entry entry = 3

  The set of XML attribute/value pairs for this style.

An XML attribute/value pair defined in the style.

Used in: Style

• optional Source source = 1

  Where the entry was defined.

• string comment = 2

  Any comments associated with the entry.

• optional Reference key = 3

  A reference to the XML attribute.

• optional Item item = 4

  The Item defined for this XML attribute.

Used in: MacroBody

• string str = 1

• repeated StyleString.Span spans = 2

Used in: StyleString

• string name = 1

• uint32 start_index = 2

• uint32 end_index = 3

A value that represents a <declare-styleable> XML resource. These are not real resources and only end up as Java fields in the generated R.java. They do not end up in the binary ARSC file.

Used in: CompoundValue

• repeated Styleable.Entry entry = 1

  The set of attribute declarations.

An attribute defined for this styleable.

Used in: Styleable

• optional Source source = 1

  Where the attribute was defined within the <declare-styleable> block.

• string comment = 2

  Any comments associated with the declaration.

• optional Reference attr = 3

  The reference to the attribute.

A string with styling information, like html tags that specify boldness, italics, etc.

Used in: Item

• string value = 1

  The raw text of the string.

• repeated StyledString.Span span = 2

A Span marks a region of the string text that is styled.

Used in: StyledString

• string tag = 1

  The name of the tag, and its attributes, encoded as follows: tag_name;attr1=value1;attr2=value2;[...]

• uint32 first_char = 2

  The first character position this span applies to, in UTF-16 offset.

• uint32 last_char = 3

  The last character position this span applies to, in UTF-16 offset.

The name and version fingerprint of a build tool.

Used in: ResourceTable

• string tool = 1

• string version = 2

A set of resources grouped under a common type. Such types include string, layout, xml, dimen, attr, etc. This maps to the second part of a resource identifier in Java (R.type.entry).

Used in: Package

• optional TypeId type_id = 1

  The ID of the type. This may not be set if no ID was assigned.

• string name = 2

  The name of the type. This corresponds to the 'type' part of a full resource name of the form package:type/entry. The set of legal type names is listed in Resource.cpp.

• repeated Entry entry = 3

  The entries defined for this type.

A type ID in the range [0x01, 0xff].

Used in: Type

• uint32 id = 1

Used in: MacroBody

• uint64 start_index = 1

• uint64 end_index = 2

The generic meta-data for every value in a resource table.

Used in: ConfigValue

• optional Source source = 1

  Where the value was defined.

• string comment = 2

  Any comment associated with the value.

• bool weak = 3

  Whether the value can be overridden.

• oneof value

  The value is either an Item or a CompoundValue.

  • Item item = 4

  • CompoundValue compound_value = 5

The Visibility of a symbol/entry (public, private, undefined).

Used in: Entry

• Visibility.Level level = 1

• optional Source source = 2

  The path at which this entry's visibility was defined (eg. public.xml).

• string comment = 3

  The comment associated with the <public> tag.

• bool staged_api = 4

  Indicates that the resource id may change across builds and that the public R.java identifier for this resource should not be final. This is set to `true` for resources in `staging-group` tags.

The visibility of the resource outside of its package.

Used in: Visibility

• UNKNOWN = 0

  No visibility was explicitly specified. This is typically treated as private. The distinction is important when two separate R.java files are generated: a public and private one. An unknown visibility, in this case, would cause the resource to be omitted from either R.java.

• PRIVATE = 1

  A resource was explicitly marked as private. This means the resource can not be accessed outside of its package unless the @*package:type/entry notation is used (the asterisk being the private accessor). If two R.java files are generated (private + public), the resource will only be emitted to the private R.java file.

• PUBLIC = 2

  A resource was explicitly marked as public. This means the resource can be accessed from any package, and is emitted into all R.java files, public and private.

An attribute defined on an XmlElement (android:text="...").

Used in: XmlElement

• string namespace_uri = 1

• string name = 2

• string value = 3

• optional SourcePosition source = 4

  Source line and column info.

• uint32 resource_id = 5

  The optional resource ID (0xPPTTEEEE) of the attribute.

• optional Item compiled_item = 6

  The optional interpreted/compiled version of the `value` string.

An <element> in an XML document.

Used in: XmlNode

• repeated XmlNamespace namespace_declaration = 1

  Namespaces defined on this element.

• string namespace_uri = 2

  The namespace URI of this element.

• string name = 3

  The name of this element.

• repeated XmlAttribute attribute = 4

  The attributes of this element.

• repeated XmlNode child = 5

  The children of this element.

A namespace declaration on an XmlElement (xmlns:android="http://...").

Used in: XmlElement

• string prefix = 1

• string uri = 2

• optional SourcePosition source = 3

  Source line and column info.

Defines an abstract XmlNode that must be either an XmlElement, or a text node represented by a string.

Used in: XmlElement

• oneof node

  • XmlElement element = 1

  • string text = 2

• optional SourcePosition source = 3

  Source line and column info.