Initialization and finalization functions

Data Structures
struct	xbps_state_cb_data
	Structure to be passed as argument to the state function callback. All members are read-only and set internally by libxbps. More...
struct	xbps_fetch_cb_data
	Structure to be passed to the fetch function callback. More...
struct	xbps_unpack_cb_data
	Structure to be passed to the unpack function callback. More...
struct	xbps_handle
	Generic XBPS structure handler for initialization. More...

Enumerations
enum	xbps_state_t

Functions
void void void void void int	xbps_init (struct xbps_handle *xhp)
void	xbps_end (struct xbps_handle *xhp)

Detailed Description

Use these functions to initialize some parameters before start using libxbps and finalize usage to release resources at the end.

---

Data Structure Documentation

xbps_state_cb_data

struct xbps_state_cb_data

Definition at line 398 of file xbps.h.

Collaboration diagram for xbps_state_cb_data:

Data Fields
struct xbps_handle *	xhp
const char *	desc
const char *	arg
int	err
xbps_state_t	state

Field Documentation

xhp

struct xbps_handle* xhp

Pointer to our struct xbps_handle passed to xbps_init().

Definition at line 404 of file xbps.h.

desc

const char* desc

Current state string description.

Definition at line 410 of file xbps.h.

arg

const char* arg

State string argument. String set on this variable may change depending on state.

Definition at line 417 of file xbps.h.

err

int err

Current state error value (set internally, read-only).

Definition at line 423 of file xbps.h.

state

xbps_state_t state

Current state.

Definition at line 429 of file xbps.h.

xbps_fetch_cb_data

struct xbps_fetch_cb_data

This structure is passed as argument to the fetch progress function callback and its members will be updated when there's any progress. All members marked as read-only in this struct are set internally by xbps_unpack_binary_pkg() and shouldn't be modified in the passed function callback.

Definition at line 442 of file xbps.h.

Collaboration diagram for xbps_fetch_cb_data:

Data Fields
struct xbps_handle *	xhp
off_t	file_size
off_t	file_offset
off_t	file_dloaded
const char *	file_name
bool	cb_start
bool	cb_update
bool	cb_end

Field Documentation

xhp

struct xbps_handle* xhp

Pointer to our struct xbps_handle passed to xbps_init().

Definition at line 448 of file xbps.h.

file_size

off_t file_size

Filename size for the file to be fetched.

Definition at line 454 of file xbps.h.

file_offset

off_t file_offset

Current offset for the filename being fetched.

Definition at line 460 of file xbps.h.

file_dloaded

off_t file_dloaded

Bytes downloaded for the file being fetched.

Definition at line 466 of file xbps.h.

file_name

const char* file_name

File name being fetched.

Definition at line 472 of file xbps.h.

cb_start

bool cb_start

If true the function callback should be prepared to start the transfer progress.

Definition at line 479 of file xbps.h.

cb_update

bool cb_update

If true the function callback should be prepared to update the transfer progress.

Definition at line 486 of file xbps.h.

cb_end

bool cb_end

If true the function callback should be prepated to end the transfer progress.

Definition at line 493 of file xbps.h.

xbps_unpack_cb_data

struct xbps_unpack_cb_data

This structure is passed as argument to the unpack progress function callback and its members will be updated when there's any progress. All members in this struct are set internally by libxbps and should be used in read-only mode in the supplied function callback.

Definition at line 506 of file xbps.h.

Collaboration diagram for xbps_unpack_cb_data:

Data Fields
struct xbps_handle *	xhp
const char *	pkgver
const char *	entry
int64_t	entry_size
ssize_t	entry_extract_count
ssize_t	entry_total_count
bool	entry_is_conf

Field Documentation

xhp

struct xbps_handle* xhp

Pointer to our struct xbps_handle passed to xbps_init().

Definition at line 512 of file xbps.h.

pkgver

const char* pkgver

Package name/version string of package being unpacked.

Definition at line 518 of file xbps.h.

entry

const char* entry

Entry pathname string.

Definition at line 524 of file xbps.h.

entry_size

int64_t entry_size

Entry file size.

Definition at line 530 of file xbps.h.

entry_extract_count

ssize_t entry_extract_count

Total number of extracted entries.

Definition at line 536 of file xbps.h.

entry_total_count

ssize_t entry_total_count

Total number of entries in package.

Definition at line 542 of file xbps.h.

entry_is_conf

bool entry_is_conf

If true "entry" is a configuration file.

Definition at line 548 of file xbps.h.

xbps_handle

struct xbps_handle

This structure sets some global properties for libxbps, to set some function callbacks and data to the fetch, transaction and unpack functions, the root and cache directory, flags, etc.

Definition at line 559 of file xbps.h.

Collaboration diagram for xbps_handle:

Data Fields
xbps_array_t	repositories
xbps_dictionary_t	pkgdb
xbps_dictionary_t	transd
int(*	state_cb )(const struct xbps_state_cb_data *, void *)
void *	state_cb_data
void(*	unpack_cb )(const struct xbps_unpack_cb_data *, void *)
void *	unpack_cb_data
void(*	fetch_cb )(const struct xbps_fetch_cb_data *, void *)
void *	fetch_cb_data
char *	pkgdb_plist
const char *	target_arch
char	confdir [XBPS_MAXPATH]
char	rootdir [XBPS_MAXPATH]
char	cachedir [XBPS_MAXPATH]
char	metadir [XBPS_MAXPATH]
char	native_arch [64]
int	flags

Field Documentation

repositories

xbps_array_t repositories

Proplib array of strings with repositories, overriding the list in the configuration file.

Definition at line 572 of file xbps.h.

Referenced by xbps_init(), xbps_repo_remove(), xbps_repo_store(), and xbps_rpool_foreach().

pkgdb

xbps_dictionary_t pkgdb

Proplib dictionary with the master package database stored in XBPS_META_PATH/XBPS_PKGDB.

Definition at line 585 of file xbps.h.

Referenced by xbps_alternatives_register(), xbps_alternatives_set(), xbps_alternatives_unregister(), xbps_configure_packages(), xbps_find_pkg_orphans(), xbps_pkgdb_foreach_cb(), xbps_pkgdb_foreach_cb_multi(), xbps_pkgdb_get_pkg(), xbps_pkgdb_get_virtualpkg(), xbps_pkgdb_lock(), xbps_pkgdb_update(), xbps_set_pkg_state_installed(), and xbps_transaction_update_packages().

transd

xbps_dictionary_t transd

Proplib dictionary with transaction objects, required by xbps_transaction_commit().

Definition at line 592 of file xbps.h.

Referenced by xbps_transaction_autoremove_pkgs(), xbps_transaction_commit(), xbps_transaction_prepare(), and xbps_transaction_remove_pkg().

state_cb

int(* state_cb) (const struct xbps_state_cb_data *, void *)

Pointer to the supplifed function callback to be used in the XBPS possible states.

Definition at line 597 of file xbps.h.

state_cb_data

void* state_cb_data

Pointer to user supplied data to be passed as argument to the xbps_state_cb function callback.

Definition at line 604 of file xbps.h.

unpack_cb

void(* unpack_cb) (const struct xbps_unpack_cb_data *, void *)

Pointer to the supplied function callback to be used in xbps_unpack_binary_pkg().

Definition at line 609 of file xbps.h.

unpack_cb_data

void* unpack_cb_data

Pointer to user supplied data to be passed as argument to the xbps_unpack_cb function callback.

Definition at line 616 of file xbps.h.

fetch_cb

void(* fetch_cb) (const struct xbps_fetch_cb_data *, void *)

Pointer to the supplied function callback to be used in xbps_fetch_file().

Definition at line 621 of file xbps.h.

fetch_cb_data

void* fetch_cb_data

Pointer to user supplied data to be passed as argument to the xbps_fetch_cb function callback.

Definition at line 628 of file xbps.h.

pkgdb_plist

char* pkgdb_plist

Absolute pathname to the pkgdb plist file.

Definition at line 634 of file xbps.h.

Referenced by xbps_pkgdb_lock(), and xbps_pkgdb_update().

target_arch

const char* target_arch

Target architecture, as set by XBPS_TARGET_ARCH from environment.

Definition at line 640 of file xbps.h.

Referenced by xbps_init(), xbps_pkg_arch_match(), xbps_pkg_exec_buffer(), xbps_repo_open(), and xbps_transaction_commit().

confdir

char confdir[XBPS_MAXPATH]

Full path to the xbps configuration directory.

Definition at line 646 of file xbps.h.

Referenced by xbps_init().

rootdir

char rootdir[XBPS_MAXPATH]

Root directory for all operations in XBPS. If unset, defaults to '/'.

Definition at line 659 of file xbps.h.

Referenced by xbps_init(), xbps_pkg_exec_buffer(), xbps_pkgdb_lock(), xbps_symlink_target(), and xbps_transaction_commit().

cachedir

char cachedir[XBPS_MAXPATH]

Cache directory to store downloaded binary packages. If unset, defaults to XBPS_CACHE_PATH (relative to rootdir).

Definition at line 666 of file xbps.h.

Referenced by xbps_binpkg_exists(), xbps_init(), xbps_pkg_path(), xbps_remote_binpkg_exists(), xbps_repository_pkg_path(), and xbps_transaction_commit().

metadir

char metadir[XBPS_MAXPATH]

Metadata directory for all operations in XBPS. If unset, defaults to XBPS_CACHE_PATH (relative to rootdir).

Definition at line 673 of file xbps.h.

Referenced by xbps_init(), xbps_pkgdb_get_pkg_files(), xbps_pkgdb_lock(), xbps_repo_key_import(), and xbps_verify_signature().

native_arch

char native_arch[64]

Machine architecture, defaults to uname(2) machine if XBPS_ARCH is not set from environment.

Definition at line 680 of file xbps.h.

Referenced by xbps_init(), xbps_pkg_arch_match(), xbps_pkg_exec_buffer(), xbps_repo_open(), and xbps_transaction_commit().

flags

int flags

Flags to be set globally by ORing them, possible value:

    - XBPS_FLAG_* (see above)

Definition at line 688 of file xbps.h.

Referenced by xbps_configure_pkg(), xbps_init(), xbps_repo_open(), xbps_rpool_get_pkg(), xbps_transaction_commit(), xbps_transaction_install_pkg(), xbps_transaction_prepare(), and xbps_transaction_update_pkg().

Enumeration Type Documentation

xbps_state_t

enum xbps_state_t

Integer representing the xbps callback returned state. Possible values:

• XBPS_STATE_UKKNOWN: state hasn't been prepared or unknown error.
• XBPS_STATE_TRANS_DOWNLOAD: transaction is downloading binary packages.
• XBPS_STATE_TRANS_VERIFY: transaction is verifying binary package integrity.
• XBPS_STATE_TRANS_RUN: transaction is performing operations: install, update, remove, replace.
• XBPS_STATE_TRANS_CONFIGURE: transaction is configuring all unpacked packages.
• XBPS_STATE_TRANS_FAIL: transaction has failed.
• XBPS_STATE_DOWNLOAD: a binary package is being downloaded.
• XBPS_STATE_VERIFY: a binary package is being verified.
• XBPS_STATE_REMOVE: a package is being removed.
• XBPS_STATE_REMOVE_DONE: a package has been removed successfully.
• XBPS_STATE_REMOVE_FILE: a package file is being removed.
• XBPS_STATE_REMOVE_OBSOLETE: an obsolete package file is being removed.
• XBPS_STATE_REPLACE: a package is being replaced.
• XBPS_STATE_INSTALL: a package is being installed.
• XBPS_STATE_INSTALL_DONE: a package has been installed successfully.
• XBPS_STATE_UPDATE: a package is being updated.
• XBPS_STATE_UPDATE_DONE: a package has been updated successfully.
• XBPS_STATE_UNPACK: a package is being unpacked.
• XBPS_STATE_CONFIGURE: a package is being configured.
• XBPS_STATE_CONFIGURE_DONE: a package has been configured successfully.
• XBPS_STATE_CONFIG_FILE: a package configuration file is being processed.
• XBPS_STATE_REPOSYNC: a remote repository's package index is being synchronized.
• XBPS_STATE_VERIFY_FAIL: binary package integrity has failed.
• XBPS_STATE_DOWNLOAD_FAIL: binary package download has failed.
• XBPS_STATE_REMOVE_FAIL: a package removal has failed.
• XBPS_STATE_REMOVE_FILE_FAIL: a package file removal has failed.
• XBPS_STATE_REMOVE_FILE_HASH_FAIL: a package file removal has failed due to hash.
• XBPS_STATE_REMOVE_FILE_OBSOLETE_FAIL: an obsolete package file removal has failed.
• XBPS_STATE_CONFIGURE_FAIL: package configure has failed.
• XBPS_STATE_CONFIG_FILE_FAIL: package configuration file operation has failed.
• XBPS_STATE_UPDATE_FAIL: package update has failed.
• XBPS_STATE_UNPACK_FAIL: package unpack has failed.
• XBPS_STATE_REPOSYNC_FAIL: syncing remote repositories has failed.
• XBPS_STATE_REPO_KEY_IMPORT: repository is signed and needs to import pubkey.
• XBPS_STATE_INVALID_DEP: package has an invalid dependency.
• XBPS_STATE_ALTGROUP_ADDED: package has registered an alternative group.
• XBPS_STATE_ALTGROUP_REMOVED: package has unregistered an alternative group.
• XBPS_STATE_ALTGROUP_SWITCHED: alternative group has been switched.
• XBPS_STATE_ALTGROUP_LINK_ADDED: link added by an alternative group.
• XBPS_STATE_ALTGROUP_LINK_REMOVED: link removed by an alternative group.
• XBPS_STATE_UNPACK_FILE_PRESERVED: package unpack preserved a file.
• XBPS_STATE_PKGDB: pkgdb upgrade in progress.
• XBPS_STATE_PKGDB_DONE: pkgdb has been upgraded successfully.

Definition at line 340 of file xbps.h.

Function Documentation

xbps_init()

void void void void void int xbps_init

(

struct xbps_handle *

xhp

)

Initialize the XBPS library with the following steps:

• Set function callbacks for fetching and unpacking.
• Set default cache connections for libfetch.
• Parse configuration file.

Parameters

[in]

xhp

Pointer to an xbps_handle struct.

Note

It's assumed that xhp is a valid pointer.

Returns

0 on success, an errno value otherwise.

Definition at line 46 of file initend.c.

References xbps_handle::cachedir, xbps_handle::confdir, xbps_handle::flags, xbps_handle::metadir, xbps_handle::native_arch, xbps_handle::repositories, xbps_handle::rootdir, xbps_handle::target_arch, xbps_path_clean(), xbps_path_join(), xbps_path_prepend(), and xbps_strlcpy().

Here is the call graph for this function:

xbps_end()

void xbps_end

(

struct xbps_handle *

xhp

)

Releases all resources used by libxbps.

Parameters

[in]

xhp

Pointer to an xbps_handle struct.

Definition at line 191 of file initend.c.