Android Binary

https://pkg.go.dev/github.com/shogo82148/androidbinary
Admin
Android Binary is a Go library for parsing Android binary file formats including APK files, XML...
Tokens:10,029
Snippets:102
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### XML Output Example

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Example output representing the structure of an Android manifest file.

```xml
Output:
	<Manifest package="net.sorablue.shogo.FWMeasure" xmlns:android="http://schemas.android.com/apk/res/android" android:compileSdkVersion="0" android:compileSdkVersionCodename="" android:versionCode="1" android:versionName="テスト版">
	<application android:allowTaskReparenting="false" android:allowBackup="false" android:backupAgent="" android:debuggable="false" android:description="" android:enabled="false" android:hasCode="false" android:hardwareAccelerated="false" android:icon="@0x7F020000" android:killAfterRestore="false" android:largeHeap="false" android:label="@0x7F040000" android:logo="" android:manageSpaceActivity="" android:name="" android:permission="" android:persistent="false" android:process="" android:restoreAnyVersion="false" android:requiredAccountType="" android:restrictedAccountType="" android:supportsRtl="false" android:taskAffinity="" android:testOnly="false" android:theme="" android:uiOptions="" android:vmSafeMode="false">
		<activity android:theme="" android:name="FWMeasureActivity" android:label="" android:screenOrientation="0">
			<intent-filter>
				<action android:name="android.intent.action.MAIN"></action>
				<category android:name="android.intent.category.LAUNCHER"></category>
			</intent-filter>
		</activity>
		<activity android:theme="" android:name="MapActivity" android:label="" android:screenOrientation="0"></activity>
		<activity android:theme="" android:name="SettingActivity" android:label="" android:screenOrientation=""></activity>
		<activity android:theme="" android:name="PlaceSettingActivity" android:label="" android:screenOrientation=""></activity>
	</application>
	<instrumentation android:name="" android:targetPackage="" android:handleProfiling="false" android:functionalTest="false"></instrumentation>
	<uses-sdk android:minSdkVersion="0" android:targetSdkVersion="0" android:maxSdkVersion="0"></uses-sdk>
	<uses-permission android:name="android.permission.CAMERA" android:maxSdkVersion="0"></uses-permission>
	<uses-permission android:name="android.permission.WAKE_LOCK" android:maxSdkVersion="0"></uses-permission>
	<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="0"></uses-permission>
	<uses-permission android:name="android.permission.INTERNET" android:maxSdkVersion="0"></uses-permission>
	<uses-permission android:name="android.permission.ACCESS_MOCK_LOCATION" android:maxSdkVersion="0"></uses-permission>
	<uses-permission android:name="android.permission.RECORD_AUDIO" android:maxSdkVersion="0"></uses-permission>
</Manifest>
```

--------------------------------

### Example Usage of TableFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

This example demonstrates a potential output value from a TableFile operation, showing 'FireworksMeasure'.

```text
FireworksMeasure
```

--------------------------------

### Get XML Reader

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Returns a reader for the XML file in text format.

```go
func (f *XMLFile) Reader() *bytes.Reader
```

--------------------------------

### Int32 Type and Methods

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an integer value in an XML file, which can be an immediate value or a reference. Provides methods to get, set, and marshal the integer value.

```go
type Int32 struct {
	// contains filtered or unexported fields
}
```

```go
func (v Int32) Int32() (int32, error)
```

```go
func (v Int32) MarshalXMLAttr(name xml.Name) (xml.Attr, error)
```

```go
func (v Int32) MustInt32() int32
```

```go
func (v *Int32) SetInt32(value int32)
```

```go
func (v *Int32) SetResID(resID ResID)
```

```go
func (v *Int32) UnmarshalXMLAttr(attr xml.Attr) error
```

```go
func (v Int32) WithResTableConfig(config *ResTableConfig) Bool
```

```go
func (v Int32) WithTableFile(table *TableFile) Int32
```

--------------------------------

### MustString for String Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Provides a method to get the string value, panicking if parsing fails. This is a convenience method over the standard String() method. Added in v0.0.2.

```go
func (v String) MustString() string
```

--------------------------------

### XML Tree Attribute

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an attribute of start tags in an XML tree.

```APIDOC
## type ResXMLTreeAttribute

### Description
ResXMLTreeAttribute is an attribute of start tags.

### Fields
- **NS** (ResStringPoolRef)
- **Name** (ResStringPoolRef)
- **RawValue** (ResStringPoolRef)
- **TypedValue** (ResValue)
```

--------------------------------

### Define ResXMLTreeAttribute Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the structure for an attribute within an XML start tag. It includes references to string pool entries for namespace, name, and raw value, along with a typed value.

```go
type ResXMLTreeAttribute struct {
	NS         ResStringPoolRef
	Name       ResStringPoolRef
	RawValue   ResStringPoolRef
	TypedValue ResValue
}
```

--------------------------------

### Initialize XMLFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Creates a new XMLFile instance from an io.ReaderAt.

```go
func NewXMLFile(r io.ReaderAt) (*XMLFile, error)
```

--------------------------------

### OpenFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Opens an APK file from the local filesystem.

```APIDOC
## func OpenFile

### Description
Opens the file specified by filename and returns an Apk instance.

### Parameters
- **filename** (string) - Required - The path to the APK file.

### Response
- **apk** (*Apk) - The opened APK object.
- **err** (error) - Error object if the operation fails.
```

--------------------------------

### NewXMLFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Initializes a new XMLFile instance from an io.ReaderAt.

```APIDOC
## func NewXMLFile

### Description
Returns a new XMLFile instance based on the provided reader.

### Parameters
- **r** (io.ReaderAt) - Required - The reader source for the XML file.

### Response
- **XMLFile** (object) - The initialized XML file object.
- **error** (error) - Returns an error if initialization fails.
```

--------------------------------

### OpenFile function signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Opens an APK file from the given filename and returns an Apk object.

```go
func OpenFile(filename string) (apk *Apk, err error)
```

--------------------------------

### Apk.Manifest method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Returns the parsed AndroidManifest.xml from the APK.

```go
func (k *Apk) Manifest() Manifest
```

--------------------------------

### OpenZipReader

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Opens an APK from an io.ReaderAt interface.

```APIDOC
## func OpenZipReader

### Description
Opens an APK using an io.ReaderAt, similar to zip.NewReader.

### Parameters
- **r** (io.ReaderAt) - Required - The reader interface for the APK data.
- **size** (int64) - Required - The size of the APK data.

### Response
- **apk** (*Apk) - The opened APK object.
- **err** (error) - Error object if the operation fails.
```

--------------------------------

### Apk.Icon method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Retrieves the icon image of the APK for a given resource configuration.

```go
func (k *Apk) Icon(resConfig *androidbinary.ResTableConfig) (image.Image, error)
```

--------------------------------

### Parse AndroidManifest.xml - Low Level API

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

This snippet demonstrates how to parse a binary XML file, such as AndroidManifest.xml, using the low-level API. It involves opening the file, creating an XML parser, and unmarshalling the data into a Manifest struct. Ensure the XML file path is correct.

```go
package main

import (
	"encoding/xml"
	"io/ioutil"
	"os"

	"github.com/shogo82148/androidbinary"
	"github.com/shogo82148/androidbinary/apk"
)

func main() {
	f, _ := os.Open("AndroidManifest.xml")
	xml, _ := androidbinary.NewXMLFile(f)
	reader := xml.Reader()

	// read XML from reader
	var manifest apk.Manifest
	data, _ := ioutil.ReadAll(reader)
	xml.Unmarshal(data, &manifest)
}
```

--------------------------------

### OpenZipReader function signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Opens an APK from an io.ReaderAt and size, similar to zip.NewReader.

```go
func OpenZipReader(r io.ReaderAt, size int64) (*Apk, error)
```

--------------------------------

### Define UsesPermission structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents system permissions granted by the user, including optional maxSdkVersion constraints.

```go
type UsesPermission struct {
	Name androidbinary.String `xml:"http://schemas.android.com/apk/res/android name,attr"`
	Max  androidbinary.Int32  `xml:"http://schemas.android.com/apk/res/android maxSdkVersion,attr"`
}
```

--------------------------------

### Apk.PackageName method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Returns the package name of the application contained within the APK.

```go
func (k *Apk) PackageName() string
```

--------------------------------

### Apk.Label method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Retrieves the label (name) of the APK for a given resource configuration.

```go
func (k *Apk) Label(resConfig *androidbinary.ResTableConfig) (s string, err error)
```

--------------------------------

### NewTableFile Function

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Creates and returns a new TableFile instance from a given io.ReaderAt. This is the entry point for parsing resource table files.

```go
func NewTableFile(r io.ReaderAt) (*TableFile, error)
```

--------------------------------

### Parse APK Files - High Level API

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Use this snippet to open an APK file and extract high-level information like the app icon, package name, and translated app labels. Ensure the APK file path is correct.

```go
package main

import (
	"github.com/shogo82148/androidbinary/apk"
)

func main() {
	pkg, _ := apk.OpenFile("your-android-app.apk")
	defer pkg.Close()

	icon, _ := pkg.Icon(nil) // returns the icon of APK as image.Image
	pkgName := pkg.PackageName() // returns the package name

	resConfigEN := &androidbinary.ResTableConfig{
		Language: [2]uint8{uint8('e'), uint8('n')},
	}
	appLabel, _ = pkg.Label(resConfigEN) // get app label for en translation
}
```

--------------------------------

### Define UsesSDK structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents the target SDK version requirements for an application.

```go
type UsesSDK struct {
	Min    androidbinary.Int32 `xml:"http://schemas.android.com/apk/res/android minSdkVersion,attr"`
	Target androidbinary.Int32 `xml:"http://schemas.android.com/apk/res/android targetSdkVersion,attr"`
	Max    androidbinary.Int32 `xml:"http://schemas.android.com/apk/res/android maxSdkVersion,attr"`
}
```

--------------------------------

### Define TablePackage Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a package within a resource table. It includes header information, string pools for type and key names, and a slice of TableTypes.

```go
type TablePackage struct {
	Header      ResTablePackage
	TypeStrings *ResStringPool
	KeyStrings  *ResStringPool
	TableTypes  []*TableType
}
```

--------------------------------

### Define Apk struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents an Android application package (APK) file.

```go
type Apk struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Apk.MainActivity method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Retrieves the name of the main activity defined in the APK's manifest.

```go
func (k *Apk) MainActivity() (activity string, err error)
```

--------------------------------

### ScreenLayout

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Describes screen layout using bitmasks.

```APIDOC
## type ScreenLayout uint8

### Description
ScreenLayout describes screen layout.

### Constants
- **MaskScreenSize**: 0x0f
- **ScreenSizeAny**: 0x01
- **ScreenSizeSmall**: 0x02
- **ScreenSizeNormal**: 0x03
- **ScreenSizeLarge**: 0x04
- **ScreenSizeXLarge**: 0x05
- **MaskScreenLong**: 0x30
- **ShiftScreenLong**: 4
- **ScreenLongAny**: 0x00
- **ScreenLongNo**: 0x10
- **ScreenLongYes**: 0x20
- **MaskLayoutDir**: 0xC0
- **ShiftLayoutDir**: 6
- **LayoutDirAny**: 0x00
- **LayoutDirLTR**: 0x40
- **LayoutDirRTL**: 0x80
```

--------------------------------

### UsesSDK Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents the target SDK version requirements for the application.

```APIDOC
## UsesSDK

### Description
Defines the SDK version constraints for the application.

### Fields
- **Min** (androidbinary.Int32) - The minimum SDK version required.
- **Target** (androidbinary.Int32) - The target SDK version.
- **Max** (androidbinary.Int32) - The maximum SDK version supported.
```

--------------------------------

### Application Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines the structure for the <application> tag in an AndroidManifest.xml file.

```APIDOC
## Application Structure

### Description
Represents the `<application>` element in an AndroidManifest.xml file, detailing various attributes and nested elements.

### Fields
- **AllowTaskReparenting** (androidbinary.Bool) - Controls task reparenting.
- **AllowBackup** (androidbinary.Bool) - Determines if the application can be backed up.
- **BackupAgent** (androidbinary.String) - Specifies the backup agent class.
- **Debuggable** (androidbinary.Bool) - Indicates if the application is debuggable.
- **Description** (androidbinary.String) - Provides a description of the application.
- **Enabled** (androidbinary.Bool) - Specifies if the application is enabled.
- **HasCode** (androidbinary.Bool) - Indicates if the application has code.
- **HardwareAccelerated** (androidbinary.Bool) - Enables hardware acceleration.
- **Icon** (androidbinary.String) - Path to the application's icon.
- **KillAfterRestore** (androidbinary.Bool) - Determines if the application is killed after restore.
- **LargeHeap** (androidbinary.Bool) - Enables the large heap for the application.
- **Label** (androidbinary.String) - The label of the application.
- **Logo** (androidbinary.String) - Path to the application's logo.
- **ManageSpaceActivity** (androidbinary.String) - Specifies the activity for managing space.
- **Name** (androidbinary.String) - The name of the application.
- **Permission** (androidbinary.String) - The permission required for the application.
- **Persistent** (androidbinary.Bool) - Marks the application as persistent.
- **Process** (androidbinary.String) - Specifies the process the application runs in.
- **RestoreAnyVersion** (androidbinary.Bool) - Allows restoring from any version.
- **RequiredAccountType** (androidbinary.String) - Specifies the required account type.
- **RestrictedAccountType** (androidbinary.String) - Specifies the restricted account type.
- **SupportsRtl** (androidbinary.Bool) - Indicates support for Right-to-Left (RTL) layouts.
- **TaskAffinity** (androidbinary.String) - The task affinity of the application.
- **TestOnly** (androidbinary.Bool) - Marks the application as test-only.
- **Theme** (androidbinary.String) - The theme for the application.
- **UIOptions** (androidbinary.String) - Specifies UI options.
- **VMSafeMode** (androidbinary.Bool) - Enables VM safe mode.
- **Activities** ([]AppActivity) - List of activities defined for the application.
- **ActivityAliases** ([]AppActivityAlias) - List of activity aliases defined for the application.
- **MetaData** ([]MetaData) - List of meta-data elements for the application.
```

--------------------------------

### GetResource Method for TableFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Retrieves a resource by its ID and configuration from the TableFile. It returns the resource as an interface{} and an error if retrieval fails.

```go
func (f *TableFile) GetResource(id ResID, config *ResTableConfig) (interface{}, error)
```

--------------------------------

### XMLFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an XML file in binary format.

```APIDOC
## type XMLFile

### Description
XMLFile is an XML file expressed in binary format.
```

--------------------------------

### TableFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a resource table file.

```APIDOC
## type TableFile

### Description
TableFile is a resource table file.

### Functions
- **NewTableFile**(r io.ReaderAt) (*TableFile, error): Returns new TableFile.

### Methods
- **GetResource**(id ResID, config *ResTableConfig) (interface{}, error): Returns a resource referenced by id.
- **GetString**(ref ResStringPoolRef) string: Returns a string referenced by ref.
```

--------------------------------

### Define TableType Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a collection of resource entries for a specific resource data type within a package. It contains header information and a slice of TableEntry.

```go
type TableType struct {
	Header  *ResTableType
	Entries []TableEntry
}
```

--------------------------------

### Manifest Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines the root structure for an AndroidManifest.xml file.

```APIDOC
## Manifest Structure

### Description
Represents the root `<manifest>` element of an AndroidManifest.xml file, containing overall package information and child elements.

### Fields
- **Package** (androidbinary.String) - The package name of the application.
- **CompileSDKVersion** (androidbinary.Int32) - The SDK version used for compilation.
- **CompileSDKVersionCodename** (androidbinary.String) - The codename of the SDK version used for compilation.
- **VersionCode** (androidbinary.Int32) - The version code of the application.
- **VersionName** (androidbinary.String) - The version name of the application.
- **App** (Application) - The application element.
- **Instrument** (Instrumentation) - The instrumentation element.
- **SDK** (UsesSDK) - The uses-sdk element.
- **UsesPermissions** ([]UsesPermission) - A list of permissions used by the application.
```

--------------------------------

### UIMode

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Describes UI mode using bitmasks.

```APIDOC
## type UIMode uint8

### Description
UIMode describes UI mode.

### Constants
- **MaskUIModeType**: 0x0f
- **UIModeTypeAny**: 0x01
- **UIModeTypeNormal**: 0x02
- **UIModeTypeDesk**: 0x03
- **UIModeTypeCar**: 0x04
- **MaskUIModeNight**: 0x30
- **ShiftUIModeNight**: 4
- **UIModeNightAny**: 0x00
- **UIModeNightNo**: 0x10
- **UIModeNightYes**: 0x20
```

--------------------------------

### WithTableFile for String

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Ties a TableFile to a String value, returning a new String value with the table file associated. Added in v0.0.2.

```go
func (v String) WithTableFile(table *TableFile) String
```

--------------------------------

### Define XMLFile Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an XML file in its binary format. It contains internal fields for managing the binary XML data.

```go
type XMLFile struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### String Method for String Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Returns the string value, resolving references if necessary. It returns an error if parsing fails. Added in v0.0.2.

```go
func (v String) String() (string, error)
```

--------------------------------

### GetString Method for TableFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Retrieves a string from the string pool using a ResStringPoolRef. It returns the string value.

```go
func (f *TableFile) GetString(ref ResStringPoolRef) string
```

--------------------------------

### Define TableFile Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a resource table file. It contains internal fields for managing the resource table data.

```go
type TableFile struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Set Resource ID for Bool

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Sets the boolean value using a specific resource ID.

```go
func (v *Bool) SetResID(resID ResID)
```

--------------------------------

### Apk Methods

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Methods available on the Apk object to retrieve metadata.

```APIDOC
## Apk Methods

### Description
Methods to extract information from an opened Apk instance.

### Methods
- **Close()** - Closes the APK file (only if created with OpenFile).
- **Icon(resConfig *androidbinary.ResTableConfig)** - Returns the icon image of the APK.
- **Label(resConfig *androidbinary.ResTableConfig)** - Returns the label of the APK.
- **MainActivity()** - Returns the name of the main activity.
- **Manifest()** - Returns the manifest of the APK.
- **PackageName()** - Returns the package name of the APK.
```

--------------------------------

### TableType

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a collection of resource entries for a specific resource data type.

```APIDOC
## type TableType

### Description
TableType is a collection of resource entries for a particular resource data type.

### Fields
- **Header** (*ResTableType)
- **Entries** ([]TableEntry)
```

--------------------------------

### Define ScreenLayout Type and Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the ScreenLayout type as a uint8 and associated constants for screen size, orientation, and direction masks and values. These are used to describe screen configurations.

```go
type ScreenLayout uint8

const (
	MaskScreenSize   ScreenLayout = 0x0f
	ScreenSizeAny    ScreenLayout = 0x01
	ScreenSizeSmall  ScreenLayout = 0x02
	ScreenSizeNormal ScreenLayout = 0x03
	ScreenSizeLarge  ScreenLayout = 0x04
	ScreenSizeXLarge ScreenLayout = 0x05

	MaskScreenLong  ScreenLayout = 0x30
	ShiftScreenLong              = 4
	ScreenLongAny   ScreenLayout = 0x00
	ScreenLongNo    ScreenLayout = 0x10
	ScreenLongYes   ScreenLayout = 0x20

	MaskLayoutDir  ScreenLayout = 0xC0
	ShiftLayoutDir              = 6
	LayoutDirAny   ScreenLayout = 0x00
	LayoutDirLTR   ScreenLayout = 0x40
	LayoutDirRTL   ScreenLayout = 0x80
)
```

--------------------------------

### TablePackage

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a table package containing resource types and strings.

```APIDOC
## type TablePackage

### Description
TablePackage is a table package.

### Fields
- **Header** (ResTablePackage)
- **TypeStrings** (*ResStringPool)
- **KeyStrings** (*ResStringPool)
- **TableTypes** ([]*TableType)
```

--------------------------------

### type XMLFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an Android binary XML file and provides methods for decoding.

```APIDOC
## func NewXMLFile

### Description
Creates a new XMLFile instance from an io.ReaderAt.

### Parameters
- **r** (io.ReaderAt) - Required - The reader source for the XML file.

### Response
- **XMLFile** - The initialized XMLFile object.
- **error** - Error if initialization fails.

## func Decode

### Description
Decodes the binary XML file into a provided interface.

### Parameters
- **v** (interface{}) - Required - The target structure to decode into.
- **table** (TableFile) - Required - The resource table for resolving references.
- **config** (ResTableConfig) - Optional - The configuration for decoding.

### Response
- **error** - Returns an error if decoding fails.
```

--------------------------------

### Define AppActivity struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents an activity component within an Android application.

```go
type AppActivity struct {
	Theme             androidbinary.String   `xml:"http://schemas.android.com/apk/res/android theme,attr"`
	Name              androidbinary.String   `xml:"http://schemas.android.com/apk/res/android name,attr"`
	Label             androidbinary.String   `xml:"http://schemas.android.com/apk/res/android label,attr"`
	ScreenOrientation androidbinary.String   `xml:"http://schemas.android.com/apk/res/android screenOrientation,attr"`
	IntentFilters     []ActivityIntentFilter `xml:"intent-filter"`
}
```

--------------------------------

### Bool.WithTableFile Method

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Ties TableFile to the Bool type. This method is used to associate table file information with a boolean value.

```go
func (v Bool) WithTableFile(table *TableFile) Bool
```

--------------------------------

### WithResTableConfig for String

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Ties a ResTableConfig to a String value, returning a new String value with the configuration applied. Added in v0.0.2.

```go
func (v String) WithResTableConfig(config *ResTableConfig) String
```

--------------------------------

### Apk.Close method signature

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Closes the APK file. This method is only available if the Apk was opened using OpenFile.

```go
func (k *Apk) Close() error
```

--------------------------------

### Marshal XML Attribute

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Implements the xml.MarshalerAttr interface for the Bool type.

```go
func (v Bool) MarshalXMLAttr(name xml.Name) (xml.Attr, error)
```

--------------------------------

### Decode XML File

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Decodes the XML file into a provided interface, using TableFile and ResTableConfig for resource resolution.

```go
func (f *XMLFile) Decode(v interface{}, table *TableFile, config *ResTableConfig) error
```

--------------------------------

### UsesPermission Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents a permission granted by the user to the system.

```APIDOC
## UsesPermission

### Description
Represents a system permission requested by the application.

### Fields
- **Name** (androidbinary.String) - The name of the permission.
- **Max** (androidbinary.Int32) - The maximum SDK version for which this permission is requested.
```

--------------------------------

### Retrieve XML Strings

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Methods to access or check for strings within the XML file's string pool.

```go
func (f *XMLFile) GetString(ref ResStringPoolRef) string
```

```go
func (f *XMLFile) HasString(ref ResStringPoolRef) bool
```

--------------------------------

### type TableFile

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an Android resource table file and provides methods to access its contents.

```APIDOC
## func NewTableFile

### Description
Creates a new TableFile instance from an io.ReaderAt.

### Parameters
- **r** (io.ReaderAt) - Required - The reader source for the table file.

### Response
- **TableFile** - The initialized TableFile object.
- **error** - Error if initialization fails.

## func GetResource

### Description
Retrieves a resource by its ID and configuration.

### Parameters
- **id** (ResID) - Required - The resource ID to fetch.
- **config** (ResTableConfig) - Optional - The configuration to match against.

### Response
- **interface{}** - The resource value.
- **error** - Error if the resource cannot be found or parsed.
```

--------------------------------

### Define Flags Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines flags for the string pool header. These flags indicate properties like whether the string pool is sorted or uses UTF-8 encoding.

```go
type Flags uint32

const (
	SortedFlag Flags = 1 << 0
	UTF8Flag   Flags = 1 << 8
)
```

--------------------------------

### Define ActivityAction struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines an action for an Android activity. Used within intent filters.

```go
type ActivityAction struct {
	Name androidbinary.String `xml:"http://schemas.android.com/apk/res/android name,attr"`
}
```

--------------------------------

### Instrumentation Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines the structure for the <instrumentation> tag in an AndroidManifest.xml file.

```APIDOC
## Instrumentation Structure

### Description
Represents the `<instrumentation>` element in an AndroidManifest.xml file, used for defining instrumentation code.

### Fields
- **Name** (androidbinary.String) - The name of the instrumentation class.
- **Target** (androidbinary.String) - The package name of the application to be profiled or tested.
- **HandleProfiling** (androidbinary.Bool) - Indicates if the instrumentation handles profiling.
- **FunctionalTest** (androidbinary.Bool) - Specifies if the instrumentation is a functional test.
```

--------------------------------

### Define NilResStringPoolRef Constant

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents the nil reference value for a string pool.

```go
const NilResStringPoolRef = ResStringPoolRef(0xFFFFFFFF)
```

--------------------------------

### Retrieve Boolean Value

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Resolves the reference if necessary and returns the boolean value.

```go
func (v Bool) Bool() (bool, error)
```

--------------------------------

### ResStringPool API

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Methods for interacting with Android binary string pools.

```APIDOC
## ResStringPool

### Description
Provides access to string pool resources within an Android binary file.

### Methods
- **GetString(ref ResStringPoolRef) string**: Returns a string referenced by ref. Panics if the pool does not contain the reference.
- **HasString(ref ResStringPoolRef) bool**: Returns whether the pool contains the specified reference.
```

--------------------------------

### Define TableEntry Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an entry within a resource table. It contains a pointer to the resource table entry (key), a pointer to the resource value, and flags.

```go
type TableEntry struct {
	Key   *ResTableEntry
	Value *ResValue
	Flags uint32
}
```

--------------------------------

### XMLFile.GetString

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Retrieves a string from the XML file's string pool based on a reference.

```APIDOC
## func (*XMLFile) GetString

### Description
Returns a string referenced by the provided ResStringPoolRef. Panics if the pool does not contain the reference.

### Parameters
- **ref** (ResStringPoolRef) - Required - The reference to the string in the pool.

### Response
- **string** (string) - The retrieved string value.
```

--------------------------------

### Define ResXMLTreeNamespaceExt Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the extended structure for XML tree nodes representing namespace start/end tags. It includes references for the prefix and URI.

```go
type ResXMLTreeNamespaceExt struct {
	Prefix ResStringPoolRef
	URI    ResStringPoolRef
}
```

--------------------------------

### Define UIMode Type and Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the UIMode type as a uint8 and associated constants for UI mode type and night mode masks and values. These are used to describe UI configurations.

```go
type UIMode uint8

const (
	MaskUIModeType   UIMode = 0x0f
	UIModeTypeAny    UIMode = 0x01
	UIModeTypeNormal UIMode = 0x02
	UIModeTypeDesk   UIMode = 0x03
	UIModeTypeCar    UIMode = 0x04

	MaskUIModeNight  UIMode = 0x30
	ShiftUIModeNight        = 4
	UIModeNightAny   UIMode = 0x00
	UIModeNightNo    UIMode = 0x10
	UIModeNightYes   UIMode = 0x20
)
```

--------------------------------

### Check for Resource ID

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Determines if a given string represents a valid resource ID.

```go
func IsResID(s string) bool
```

--------------------------------

### XML Tree Namespace Extension

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Extended XML tree node for namespace start/end nodes.

```APIDOC
## type ResXMLTreeNamespaceExt

### Description
ResXMLTreeNamespaceExt is extended XML tree node for namespace start/end nodes.

### Fields
- **Prefix** (ResStringPoolRef)
- **URI** (ResStringPoolRef)
```

--------------------------------

### Define MetaData structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents metadata entries in an Android application, mapping XML attributes to androidbinary.String types.

```go
type MetaData struct {
	Name  androidbinary.String `xml:"http://schemas.android.com/apk/res/android name,attr"`
	Value androidbinary.String `xml:"http://schemas.android.com/apk/res/android value,attr"`
}
```

--------------------------------

### ResTableConfig API

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Methods for comparing and matching Android resource table configurations.

```APIDOC
## ResTableConfig

### Description
Utility methods for evaluating resource table configurations, including locale matching and specificity checks.

### Methods
- **IsBetterThan(o *ResTableConfig, r *ResTableConfig) bool**: Returns true if the current config is better than o for the r configuration.
- **IsLocaleBetterThan(o *ResTableConfig, r *ResTableConfig) bool**: Returns true if the current config is a better locale match than o for the r configuration.
- **IsLocaleMoreSpecificThan(o *ResTableConfig) int**: Returns a positive integer if this config is more specific than o, negative if o is more specific, and 0 if equal.
- **IsMoreSpecificThan(o *ResTableConfig) bool**: Returns true if the current config is more specific than o.
- **Locale() string**: Returns the locale of the configuration.
- **Match(settings *ResTableConfig) bool**: Returns true if the current config matches the provided settings.
```

--------------------------------

### Define AppActivityAlias struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents an activity-alias component in an Android application's manifest.

```go
type AppActivityAlias struct {
	Name           androidbinary.String   `xml:"http://schemas.android.com/apk/res/android name,attr"`
	Label          androidbinary.String   `xml:"http://schemas.android.com/apk/res/android label,attr"`
	TargetActivity androidbinary.String   `xml:"http://schemas.android.com/apk/res/android targetActivity,attr"`
	IntentFilters  []ActivityIntentFilter `xml:"intent-filter"`
}
```

--------------------------------

### Define DataType Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the data types for values in Android resource files. These constants are used to interpret the type of data stored.

```go
type DataType uint8

const (
	TypeNull          DataType = 0x00
	TypeReference     DataType = 0x01
	TypeAttribute     DataType = 0x02
	TypeString        DataType = 0x03
	TypeFloat         DataType = 0x04
	TypeDemention     DataType = 0x05
	TypeFraction      DataType = 0x06
	TypeFirstInt      DataType = 0x10
	TypeIntDec        DataType = 0x10
	TypeIntHex        DataType = 0x11
	TypeIntBoolean    DataType = 0x12
	TypeFirstColorInt DataType = 0x1c
	TypeIntColorARGB8 DataType = 0x1c
	TypeIntColorRGB8  DataType = 0x1d
	TypeIntColorARGB4 DataType = 0x1e
	TypeIntColorRGB4  DataType = 0x1f
	TypeLastColorInt  DataType = 0x1f
	TypeLastInt       DataType = 0x1f
)
```

--------------------------------

### Parse Resource Files - Low Level API

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Use this snippet to parse resource files (resources.arsc) and retrieve specific resources by their ID. Ensure the resource file path is correct and the ResID is valid.

```go
package main

import (
	"fmt"
	"os"

	"github.com/shogo82148/androidbinary"
)

func main() {
	f, _ := os.Open("resources.arsc")
	rsc, _ := androidbinary.NewTableFile(f)
	resource, _ := rsc.GetResource(androidbinary.ResID(0xCAFEBABE), nil)
	fmt.Println(resource)
}
```

--------------------------------

### TableEntry

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an entry in a resource table.

```APIDOC
## type TableEntry

### Description
TableEntry is a entry in a resource table.

### Fields
- **Key** (*ResTableEntry)
- **Value** (*ResValue)
- **Flags** (uint32)
```

--------------------------------

### ResChunkHeader Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the header for resource chunks, containing type, header size, and total chunk size. This is a fundamental structure for parsing resource files.

```go
type ResChunkHeader struct {
	Type       ChunkType
	HeaderSize uint16
	Size       uint32
}
```

--------------------------------

### Retrieve Boolean Value with Panic

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Returns the boolean value, panicking if parsing fails.

```go
func (v Bool) MustBool() bool
```

--------------------------------

### Define InputFlags Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines input flags for controlling input behavior, such as key visibility and navigation hidden states. These are used to modify input handling.

```go
type InputFlags uint8

const (
	MaskKeysHidden InputFlags = 0x03
	KeysHiddenAny  InputFlags = 0x00
	KeysHiddenNo   InputFlags = 0x01
	KeysHiddenYes  InputFlags = 0x02
	KeysHiddenSoft InputFlags = 0x03

	MaskNavHidden InputFlags = 0x0c
	NavHiddenAny  InputFlags = 0x00
	NavHiddenNo   InputFlags = 0x04
	NavHiddenYes  InputFlags = 0x08
)
```

--------------------------------

### Define ActivityCategory struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines a category for an Android activity. Used within intent filters.

```go
type ActivityCategory struct {
	Name androidbinary.String `xml:"http://schemas.android.com/apk/res/android name,attr"`
}
```

--------------------------------

### String Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a string value in an XML file, which can be an immediate value or a reference.

```APIDOC
## type String

### Description
String is a boolean value in XML file. It may be an immediate value or a reference.

### Methods
- **MarshalXMLAttr()** (xml.Attr, error): Implements xml.MarshalerAttr.
- **MustString()** string: Returns the string value, panics on failure.
- **SetResID**(resID ResID): Sets a boolean value with the resource id.
- **SetString**(value string): Sets a string value.
- **String()** (string, error): Returns the string value, resolves reference if needed.
- **UnmarshalXMLAttr**(attr xml.Attr) error: Implements xml.UnmarshalerAttr.
- **WithResTableConfig**(config *ResTableConfig) String: Ties ResTableConfig to the Bool.
- **WithTableFile**(table *TableFile) String: Ties TableFile to the Bool.
```

--------------------------------

### MetaData Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Represents metadata entries within an Android application.

```APIDOC
## MetaData

### Description
Represents a metadata entry in an Android application.

### Fields
- **Name** (androidbinary.String) - The name attribute of the metadata.
- **Value** (androidbinary.String) - The value attribute of the metadata.
```

--------------------------------

### XMLFile.Decode

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Decodes the XML file content into a provided interface, utilizing resource tables and configuration.

```APIDOC
## func (*XMLFile) Decode

### Description
Decodes the XML file and stores the result in the value pointed to by v. It uses the provided TableFile and ResTableConfig to resolve resource references.

### Parameters
- **v** (interface{}) - Required - The destination to store the decoded result.
- **table** (TableFile) - Required - The resource table file.
- **config** (ResTableConfig) - Required - The resource table configuration.

### Response
- **error** (error) - Returns an error if decoding fails.
```

--------------------------------

### Bool.WithResTableConfig Method

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Ties ResTableConfig to the Bool type. This method is used to associate configuration details with a boolean value.

```go
func (v Bool) WithResTableConfig(config *ResTableConfig) Bool
```

--------------------------------

### Define ChunkType Constants

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the various chunk types used in Android resource files. These constants are essential for identifying different sections within a resource binary.

```go
type ChunkType uint16

const (
	ResNullChunkType       ChunkType = 0x0000
	ResStringPoolChunkType ChunkType = 0x0001
	ResTableChunkType      ChunkType = 0x0002
	ResXMLChunkType        ChunkType = 0x0003

	// Chunk types in RES_XML_TYPE
	ResXMLFirstChunkType     ChunkType = 0x0100
	ResXMLStartNamespaceType ChunkType = 0x0100
	ResXMLEndNamespaceType   ChunkType = 0x0101
	ResXMLStartElementType   ChunkType = 0x0102
	ResXMLEndElementType     ChunkType = 0x0103
	ResXMLCDataType          ChunkType = 0x0104
	ResXMLLastChunkType      ChunkType = 0x017f

	// This contains a uint32_t array mapping strings in the string
	// pool back to resource identifiers.  It is optional.
	ResXMLResourceMapType ChunkType = 0x0180

	// Chunk types in RES_TABLE_TYPE
	ResTablePackageType  ChunkType = 0x0200
	ResTableTypeType     ChunkType = 0x0201
	ResTableTypeSpecType ChunkType = 0x0202
)
```

--------------------------------

### XMLFile.Reader

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Returns a reader for the XML file in text format.

```APIDOC
## func (*XMLFile) Reader

### Description
Returns a bytes.Reader containing the XML file content expressed in text format.

### Response
- **reader** (*bytes.Reader) - A reader for the text-formatted XML content.
```

--------------------------------

### SetString for String Pointer

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Sets a string value for a String type pointer. Added in v0.0.2.

```go
func (v *String) SetString(value string)
```

--------------------------------

### Define ActivityIntentFilter struct

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary/apk

Defines an intent filter for an Android activity, specifying actions and categories.

```go
type ActivityIntentFilter struct {
	Actions    []ActivityAction   `xml:"action"`
	Categories []ActivityCategory `xml:"category"`
}
```

--------------------------------

### MarshalXMLAttr for String

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Implements the xml.MarshalerAttr interface for the String type, allowing it to be marshaled into an XML attribute. Added in v0.0.2.

```go
func (v String) MarshalXMLAttr(name xml.Name) (xml.Attr, error)
```

--------------------------------

### Define ResXMLTreeNode Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the basic structure for an XML tree node. It includes chunk header information, line number, and a reference to a comment string.

```go
type ResXMLTreeNode struct {
	Header     ResChunkHeader
	LineNumber uint32
	Comment    ResStringPoolRef
}
```

--------------------------------

### Define Bool Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a boolean value in an Android binary XML file, which can be an immediate value or a reference.

```go
type Bool struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Define ResXMLTreeEndElementExt Structure

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the extended structure for XML tree nodes representing element start/end tags. It contains references for namespace and element name.

```go
type ResXMLTreeEndElementExt struct {
	NS   ResStringPoolRef
	Name ResStringPoolRef
}
```

--------------------------------

### XML Tree Node

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Basic XML tree node structure.

```APIDOC
## type ResXMLTreeNode

### Description
ResXMLTreeNode is basic XML tree node.

### Fields
- **Header** (ResChunkHeader)
- **LineNumber** (uint32)
- **Comment** (ResStringPoolRef)
```

--------------------------------

### XML Tree End Element Extension

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Extended XML tree node for element start/end nodes.

```APIDOC
## type ResXMLTreeEndElementExt

### Description
ResXMLTreeEndElementExt is extended XML tree node for element start/end nodes.

### Fields
- **NS** (ResStringPoolRef)
- **Name** (ResStringPoolRef)
```

--------------------------------

### func (Int32) Int32

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Retrieves the integer value from an Int32 structure, resolving references if necessary.

```APIDOC
## Int32.Int32()

### Description
Returns the integer value of the Int32 structure. It resolves the reference if needed.

### Response
#### Success Response (200)
- **value** (int32) - The resolved integer value.
- **error** (error) - Error object if resolution fails.
```

--------------------------------

### Set Boolean Value

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Sets the boolean value for the Bool type.

```go
func (v *Bool) SetBool(value bool)
```

--------------------------------

### XMLFile.HasString

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Checks if a string reference exists in the XML file's string pool.

```APIDOC
## func (*XMLFile) HasString

### Description
Checks if the provided reference exists within the string pool.

### Parameters
- **ref** (ResStringPoolRef) - Required - The reference to check.

### Response
- **bool** (boolean) - True if the string exists, false otherwise.
```

--------------------------------

### func (*Int32) SetInt32

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Sets the integer value for an Int32 structure.

```APIDOC
## Int32.SetInt32()

### Description
Sets an integer value for the Int32 structure.

### Parameters
#### Request Body
- **value** (int32) - Required - The integer value to set.
```

--------------------------------

### Unmarshal XML Attribute

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Implements the xml.UnmarshalerAttr interface for the Bool type.

```go
func (v *Bool) UnmarshalXMLAttr(attr xml.Attr) error
```

--------------------------------

### ResID Type and Parsing

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents a resource ID, used to identify resources within an Android application. Provides methods to parse a string into a ResID and extract package and entry information.

```go
type ResID uint32
```

```go
func ParseResID(s string) (ResID, error)
```

```go
func (id ResID) Entry() int
```

```go
func (id ResID) Package() uint32
```

--------------------------------

### UnmarshalXMLAttr for String

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Implements the xml.UnmarshalerAttr interface for the String type, allowing it to be unmarshaled from an XML attribute. Added in v0.0.2.

```go
func (v *String) UnmarshalXMLAttr(attr xml.Attr) error
```

--------------------------------

### Define String Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Defines the String type, representing a string value in an XML file. It can be an immediate value or a reference to the string pool. This type is added in v0.0.2.

```go
type String struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### SetResID for String Pointer

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Sets a boolean value using a resource ID for a String type pointer. Added in v0.0.2.

```go
func (v *String) SetResID(resID ResID)
```

--------------------------------

### InvalidReferenceError Type

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Represents an error that occurs when an invalid resource reference is encountered. It holds the problematic resource reference.

```go
type InvalidReferenceError struct {
	Ref ResStringPoolRef
}
```

```go
func (e *InvalidReferenceError) Error() string
```

--------------------------------

### func IsResID

Source: https://pkg.go.dev/github.com/shogo82148/androidbinary

Checks if a given string represents a valid Android Resource ID.

```APIDOC
## func IsResID

### Description
Returns whether the provided string is a valid ResID.

### Parameters
#### Query Parameters
- **s** (string) - Required - The string to check.

### Response
- **bool** - Returns true if the string is a valid ResID, false otherwise.
```
Tokens:
Raw