xmake-docs/docs/api/scripts/extension-modules/utils/binary.md

utils.binary

Binary utility modules.

utils.binary.deplibs

Get dependent libraries.

Function Prototype

::: tip API

local deps = deplibs(binaryfile: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
opt	Optional. Options: - plat: Platform - arch: Architecture - recursive: Recursively get all sub-dependencies (default: false) - resolve_path: Try to resolve the file full path (default: false) - resolve_hint_paths: Resolve paths from hints - resolve_search_paths: Search library paths (e.g. LD_LIBRARY_PATH) - check_cycle: Check for circular dependencies

Return Value

Return Value	Description
<table>	Dependent libraries list

utils.binary.readsyms

Read symbols from object file.

Function Prototype

::: tip API

local syms = readsyms(binaryfile: <string>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input object file path

Return Value

Return Value	Description
<table>	Symbols list

utils.binary.extractlib

Extract static library to directory.

Function Prototype

::: tip API

extractlib(libraryfile: <string>, outputdir: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
libraryfile	Required. Input static library file path
outputdir	Required. Output directory path
opt	Optional. Options

utils.binary.rpath.list

Get rpath list.

Function Prototype

::: tip API

local rpaths = rpath.list(binaryfile: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
opt	Optional. Options

Return Value

Return Value	Description
<table>	Rpath list

utils.binary.rpath.insert

Insert rpath.

Function Prototype

::: tip API

rpath.insert(binaryfile: <string>, rpath_path: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
rpath_path	Required. Rpath path to insert
opt	Optional. Options

utils.binary.rpath.change

Change rpath.

Function Prototype

::: tip API

rpath.change(binaryfile: <string>, rpath_old: <string>, rpath_new: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
rpath_old	Required. Old rpath path
rpath_new	Required. New rpath path
opt	Optional. Options

utils.binary.rpath.remove

Remove rpath.

Function Prototype

::: tip API

rpath.remove(binaryfile: <string>, rpath_path: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
rpath_path	Required. Rpath path to remove
opt	Optional. Options

utils.binary.rpath.clean

Clean all rpaths.

Function Prototype

::: tip API

rpath.clean(binaryfile: <string>, opt: <table>)

:::

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
opt	Optional. Options