summaryrefslogtreecommitdiff
path: root/lib/libalpm/alpm.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libalpm/alpm.h')
-rw-r--r--lib/libalpm/alpm.h961
1 files changed, 576 insertions, 385 deletions
diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
index cb643d29..32db687a 100644
--- a/lib/libalpm/alpm.h
+++ b/lib/libalpm/alpm.h
@@ -45,49 +45,211 @@ extern "C" {
*/
/*
- * Structures
+ * Enumerations
+ * These ones are used in multiple contexts, so are forward-declared.
+ */
+
+/**
+ * Install reasons.
+ * Why the package was installed.
*/
+typedef enum _alpm_pkgreason_t {
+ /** Explicitly requested by the user. */
+ ALPM_PKG_REASON_EXPLICIT = 0,
+ /** Installed as a dependency for another package. */
+ ALPM_PKG_REASON_DEPEND = 1
+} alpm_pkgreason_t;
-typedef struct __pmdb_t pmdb_t;
-typedef struct __pmpkg_t pmpkg_t;
-typedef struct __pmdelta_t pmdelta_t;
-typedef struct __pmgrp_t pmgrp_t;
-typedef struct __pmtrans_t pmtrans_t;
-typedef struct __pmdepend_t pmdepend_t;
-typedef struct __pmdepmissing_t pmdepmissing_t;
-typedef struct __pmconflict_t pmconflict_t;
-typedef struct __pmfileconflict_t pmfileconflict_t;
+/** Types of version constraints in dependency specs. */
+typedef enum _alpm_depmod_t {
+ /** No version constraint */
+ ALPM_DEP_MOD_ANY = 1,
+ /** Test version equality (package=x.y.z) */
+ ALPM_DEP_MOD_EQ,
+ /** Test for at least a version (package>=x.y.z) */
+ ALPM_DEP_MOD_GE,
+ /** Test for at most a version (package<=x.y.z) */
+ ALPM_DEP_MOD_LE,
+ /** Test for greater than some version (package>x.y.z) */
+ ALPM_DEP_MOD_GT,
+ /** Test for less than some version (package<x.y.z) */
+ ALPM_DEP_MOD_LT
+} alpm_depmod_t;
+
+/**
+ * File conflict type.
+ * Whether the conflict results from a file existing on the filesystem, or with
+ * another target in the transaction.
+ */
+typedef enum _alpm_fileconflicttype_t {
+ ALPM_FILECONFLICT_TARGET = 1,
+ ALPM_FILECONFLICT_FILESYSTEM
+} alpm_fileconflicttype_t;
+
+/**
+ * PGP signature verification options
+ */
+typedef enum _alpm_siglevel_t {
+ ALPM_SIG_PACKAGE = (1 << 0),
+ ALPM_SIG_PACKAGE_OPTIONAL = (1 << 1),
+ ALPM_SIG_PACKAGE_MARGINAL_OK = (1 << 2),
+ ALPM_SIG_PACKAGE_UNKNOWN_OK = (1 << 3),
+
+ ALPM_SIG_DATABASE = (1 << 10),
+ ALPM_SIG_DATABASE_OPTIONAL = (1 << 11),
+ ALPM_SIG_DATABASE_MARGINAL_OK = (1 << 12),
+ ALPM_SIG_DATABASE_UNKNOWN_OK = (1 << 13),
+
+ ALPM_SIG_USE_DEFAULT = (1 << 31)
+} alpm_siglevel_t;
+
+/**
+ * PGP signature verification status return codes
+ */
+typedef enum _alpm_sigstatus_t {
+ ALPM_SIGSTATUS_VALID,
+ ALPM_SIGSTATUS_KEY_EXPIRED,
+ ALPM_SIGSTATUS_SIG_EXPIRED,
+ ALPM_SIGSTATUS_KEY_UNKNOWN,
+ ALPM_SIGSTATUS_INVALID
+} alpm_sigstatus_t;
+
+/**
+ * PGP signature verification status return codes
+ */
+typedef enum _alpm_sigvalidity_t {
+ ALPM_SIGVALIDITY_FULL,
+ ALPM_SIGVALIDITY_MARGINAL,
+ ALPM_SIGVALIDITY_NEVER,
+ ALPM_SIGVALIDITY_UNKNOWN
+} alpm_sigvalidity_t;
/*
- * Library
+ * Structures
*/
-int alpm_initialize(void);
-int alpm_release(void);
-const char *alpm_version(void);
+typedef struct __alpm_handle_t alpm_handle_t;
+typedef struct __alpm_db_t alpm_db_t;
+typedef struct __alpm_pkg_t alpm_pkg_t;
+typedef struct __alpm_trans_t alpm_trans_t;
+
+/** Dependency */
+typedef struct _alpm_depend_t {
+ char *name;
+ char *version;
+ unsigned long name_hash;
+ alpm_depmod_t mod;
+} alpm_depend_t;
+
+/** Missing dependency */
+typedef struct _alpm_depmissing_t {
+ char *target;
+ alpm_depend_t *depend;
+ /* this is used in case of remove dependency error only */
+ char *causingpkg;
+} alpm_depmissing_t;
+
+/** Conflict */
+typedef struct _alpm_conflict_t {
+ unsigned long package1_hash;
+ unsigned long package2_hash;
+ char *package1;
+ char *package2;
+ char *reason;
+} alpm_conflict_t;
+
+/** File conflict */
+typedef struct _alpm_fileconflict_t {
+ char *target;
+ alpm_fileconflicttype_t type;
+ char *file;
+ char *ctarget;
+} alpm_fileconflict_t;
+
+/** Package group */
+typedef struct _alpm_group_t {
+ /** group name */
+ char *name;
+ /** list of alpm_pkg_t packages */
+ alpm_list_t *packages;
+} alpm_group_t;
+
+/** Package upgrade delta */
+typedef struct _alpm_delta_t {
+ /** filename of the delta patch */
+ char *delta;
+ /** md5sum of the delta file */
+ char *delta_md5;
+ /** filename of the 'before' file */
+ char *from;
+ /** filename of the 'after' file */
+ char *to;
+ /** filesize of the delta file */
+ off_t delta_size;
+ /** download filesize of the delta file */
+ off_t download_size;
+} alpm_delta_t;
+
+/** File in a package */
+typedef struct _alpm_file_t {
+ char *name;
+ off_t size;
+ mode_t mode;
+} alpm_file_t;
+
+/** Package filelist container */
+typedef struct _alpm_filelist_t {
+ size_t count;
+ alpm_file_t *files;
+} alpm_filelist_t;
+
+/** Local package or package file backup entry */
+typedef struct _alpm_backup_t {
+ char *name;
+ char *hash;
+} alpm_backup_t;
+
+/** Signature result. Contains the number of signatures found and pointers to
+ * arrays containing key and status info. All contained arrays have size
+ * #count.*/
+typedef struct _alpm_sigresult_t {
+ int count;
+ alpm_sigstatus_t *status;
+ alpm_sigvalidity_t *validity;
+ char **uid;
+} alpm_sigresult_t;
/*
* Logging facilities
*/
-/* Levels */
-typedef enum _pmloglevel_t {
- PM_LOG_ERROR = 1,
- PM_LOG_WARNING = (1 << 1),
- PM_LOG_DEBUG = (1 << 2),
- PM_LOG_FUNCTION = (1 << 3)
-} pmloglevel_t;
+/**
+ * Logging Levels
+ */
+typedef enum _alpm_loglevel_t {
+ ALPM_LOG_ERROR = 1,
+ ALPM_LOG_WARNING = (1 << 1),
+ ALPM_LOG_DEBUG = (1 << 2),
+ ALPM_LOG_FUNCTION = (1 << 3)
+} alpm_loglevel_t;
-typedef void (*alpm_cb_log)(pmloglevel_t, const char *, va_list);
-int alpm_logaction(const char *fmt, ...);
+typedef void (*alpm_cb_log)(alpm_loglevel_t, const char *, va_list);
+int alpm_logaction(alpm_handle_t *handle, const char *fmt, ...);
/*
* Downloading
*/
+/** Type of download progress callbacks.
+ * @param filename the name of the file being downloaded
+ * @param xfered the number of transferred bytes
+ * @param total the total number of bytes to transfer
+ */
typedef void (*alpm_cb_download)(const char *filename,
off_t xfered, off_t total);
+
typedef void (*alpm_cb_totaldl)(off_t total);
+
/** A callback for downloading files
* @param url the URL of the file to be downloaded
* @param localpath the directory to which the file should be downloaded
@@ -99,111 +261,131 @@ typedef int (*alpm_cb_fetch)(const char *url, const char *localpath,
int force);
/** Fetch a remote pkg.
+ * @param handle the context handle
* @param url URL of the package to download
* @return the downloaded filepath on success, NULL on error
*/
-char *alpm_fetch_pkgurl(const char *url);
+char *alpm_fetch_pkgurl(alpm_handle_t *handle, const char *url);
/** @addtogroup alpm_api_options Options
* Libalpm option getters and setters
* @{
*/
-/** @name The logging callback. */
-/* @{ */
-alpm_cb_log alpm_option_get_logcb(void);
-void alpm_option_set_logcb(alpm_cb_log cb);
-/* @} */
+/** Returns the callback used for logging. */
+alpm_cb_log alpm_option_get_logcb(alpm_handle_t *handle);
+/** Sets the callback used for logging. */
+int alpm_option_set_logcb(alpm_handle_t *handle, alpm_cb_log cb);
-/** Get/set the download progress callback. */
-alpm_cb_download alpm_option_get_dlcb(void);
-void alpm_option_set_dlcb(alpm_cb_download cb);
+/** Returns the callback used to report download progress. */
+alpm_cb_download alpm_option_get_dlcb(alpm_handle_t *handle);
+/** Sets the callback used to report download progress. */
+int alpm_option_set_dlcb(alpm_handle_t *handle, alpm_cb_download cb);
-/** Get/set the downloader callback. */
-alpm_cb_fetch alpm_option_get_fetchcb(void);
-void alpm_option_set_fetchcb(alpm_cb_fetch cb);
+/** Returns the downloading callback. */
+alpm_cb_fetch alpm_option_get_fetchcb(alpm_handle_t *handle);
+/** Sets the downloading callback. */
+int alpm_option_set_fetchcb(alpm_handle_t *handle, alpm_cb_fetch cb);
-/** Get/set the callback used when download size is known. */
-alpm_cb_totaldl alpm_option_get_totaldlcb(void);
-void alpm_option_set_totaldlcb(alpm_cb_totaldl cb);
+/** Returns the callback used to report total download size. */
+alpm_cb_totaldl alpm_option_get_totaldlcb(alpm_handle_t *handle);
+/** Sets the callback used to report total download size. */
+int alpm_option_set_totaldlcb(alpm_handle_t *handle, alpm_cb_totaldl cb);
-/** Get/set the root of the destination filesystem. */
-const char *alpm_option_get_root(void);
-int alpm_option_set_root(const char *root);
+/** Returns the root of the destination filesystem. Read-only. */
+const char *alpm_option_get_root(alpm_handle_t *handle);
-/** Get/set the path to the database directory. */
-const char *alpm_option_get_dbpath(void);
-int alpm_option_set_dbpath(const char *dbpath);
+/** Returns the path to the database directory. Read-only. */
+const char *alpm_option_get_dbpath(alpm_handle_t *handle);
-/** Get/set the list of package cache directories. */
-alpm_list_t *alpm_option_get_cachedirs(void);
-void alpm_option_set_cachedirs(alpm_list_t *cachedirs);
+/** Get the name of the database lock file. Read-only. */
+const char *alpm_option_get_lockfile(alpm_handle_t *handle);
-/** Add a single directory to the package cache paths. */
-int alpm_option_add_cachedir(const char *cachedir);
+/** @name Accessors to the list of package cache directories.
+ * @{
+ */
+alpm_list_t *alpm_option_get_cachedirs(alpm_handle_t *handle);
+int alpm_option_set_cachedirs(alpm_handle_t *handle, alpm_list_t *cachedirs);
+int alpm_option_add_cachedir(alpm_handle_t *handle, const char *cachedir);
+int alpm_option_remove_cachedir(alpm_handle_t *handle, const char *cachedir);
+/** @} */
-/** Remove a single directory from the package cache paths. */
-int alpm_option_remove_cachedir(const char *cachedir);
+/** Returns the logfile name. */
+const char *alpm_option_get_logfile(alpm_handle_t *handle);
+/** Sets the logfile name. */
+int alpm_option_set_logfile(alpm_handle_t *handle, const char *logfile);
-/** Get/set the logfile name. */
-const char *alpm_option_get_logfile(void);
-int alpm_option_set_logfile(const char *logfile);
+/** Returns the path to libalpm's GnuPG home directory. */
+const char *alpm_option_get_gpgdir(alpm_handle_t *handle);
+/** Sets the path to libalpm's GnuPG home directory. */
+int alpm_option_set_gpgdir(alpm_handle_t *handle, const char *gpgdir);
-/** Get the name of the database lock file.
- *
- * This properly is read-only, and determined from
- * the database path.
- *
- * @sa alpm_option_set_dbpath(const char*)
- */
-const char *alpm_option_get_lockfile(void);
+/** Returns whether to use syslog (0 is FALSE, TRUE otherwise). */
+int alpm_option_get_usesyslog(alpm_handle_t *handle);
+/** Sets whether to use syslog (0 is FALSE, TRUE otherwise). */
+int alpm_option_set_usesyslog(alpm_handle_t *handle, int usesyslog);
-/** Get/set whether to use syslog (0 is FALSE, TRUE otherwise). */
-int alpm_option_get_usesyslog(void);
-void alpm_option_set_usesyslog(int usesyslog);
+/** @name Accessors to the list of no-upgrade files.
+ * These functions modify the list of files which should
+ * not be updated by package installation.
+ * @{
+ */
+alpm_list_t *alpm_option_get_noupgrades(alpm_handle_t *handle);
+int alpm_option_add_noupgrade(alpm_handle_t *handle, const char *pkg);
+int alpm_option_set_noupgrades(alpm_handle_t *handle, alpm_list_t *noupgrade);
+int alpm_option_remove_noupgrade(alpm_handle_t *handle, const char *pkg);
+/** @} */
-alpm_list_t *alpm_option_get_noupgrades(void);
-void alpm_option_add_noupgrade(const char *pkg);
-void alpm_option_set_noupgrades(alpm_list_t *noupgrade);
-int alpm_option_remove_noupgrade(const char *pkg);
+/** @name Accessors to the list of no-extract files.
+ * These functions modify the list of filenames which should
+ * be skipped packages which should
+ * not be upgraded by a sysupgrade operation.
+ * @{
+ */
+alpm_list_t *alpm_option_get_noextracts(alpm_handle_t *handle);
+int alpm_option_add_noextract(alpm_handle_t *handle, const char *pkg);
+int alpm_option_set_noextracts(alpm_handle_t *handle, alpm_list_t *noextract);
+int alpm_option_remove_noextract(alpm_handle_t *handle, const char *pkg);
+/** @} */
-alpm_list_t *alpm_option_get_noextracts(void);
-void alpm_option_add_noextract(const char *pkg);
-void alpm_option_set_noextracts(alpm_list_t *noextract);
-int alpm_option_remove_noextract(const char *pkg);
+/** @name Accessors to the list of ignored packages.
+ * These functions modify the list of packages that
+ * should be ignored by a sysupgrade.
+ * @{
+ */
+alpm_list_t *alpm_option_get_ignorepkgs(alpm_handle_t *handle);
+int alpm_option_add_ignorepkg(alpm_handle_t *handle, const char *pkg);
+int alpm_option_set_ignorepkgs(alpm_handle_t *handle, alpm_list_t *ignorepkgs);
+int alpm_option_remove_ignorepkg(alpm_handle_t *handle, const char *pkg);
+/** @} */
-alpm_list_t *alpm_option_get_ignorepkgs(void);
-void alpm_option_add_ignorepkg(const char *pkg);
-void alpm_option_set_ignorepkgs(alpm_list_t *ignorepkgs);
-int alpm_option_remove_ignorepkg(const char *pkg);
+/** @name Accessors to the list of ignored groups.
+ * These functions modify the list of groups whose packages
+ * should be ignored by a sysupgrade.
+ * @{
+ */
+alpm_list_t *alpm_option_get_ignoregroups(alpm_handle_t *handle);
+int alpm_option_add_ignoregroup(alpm_handle_t *handle, const char *grp);
+int alpm_option_set_ignoregroups(alpm_handle_t *handle, alpm_list_t *ignoregrps);
+int alpm_option_remove_ignoregroup(alpm_handle_t *handle, const char *grp);
+/** @} */
-alpm_list_t *alpm_option_get_ignoregrps(void);
-void alpm_option_add_ignoregrp(const char *grp);
-void alpm_option_set_ignoregrps(alpm_list_t *ignoregrps);
-int alpm_option_remove_ignoregrp(const char *grp);
+/** Returns the targeted architecture. */
+const char *alpm_option_get_arch(alpm_handle_t *handle);
+/** Sets the targeted architecture. */
+int alpm_option_set_arch(alpm_handle_t *handle, const char *arch);
-/** Get/set the targeted architecture. */
-const char *alpm_option_get_arch(void);
-void alpm_option_set_arch(const char *arch);
+int alpm_option_get_usedelta(alpm_handle_t *handle);
+int alpm_option_set_usedelta(alpm_handle_t *handle, int usedelta);
-int alpm_option_get_usedelta(void);
-void alpm_option_set_usedelta(int usedelta);
+int alpm_option_get_checkspace(alpm_handle_t *handle);
+int alpm_option_set_checkspace(alpm_handle_t *handle, int checkspace);
-int alpm_option_get_checkspace(void);
-void alpm_option_set_checkspace(int checkspace);
+alpm_siglevel_t alpm_option_get_default_siglevel(alpm_handle_t *handle);
+int alpm_option_set_default_siglevel(alpm_handle_t *handle, alpm_siglevel_t level);
/** @} */
-/** Install reasons
- * Why the package was installed.
- */
-typedef enum _pmpkgreason_t {
- /** Explicitly requested by the user. */
- PM_PKG_REASON_EXPLICIT = 0,
- /** Installed as a dependency for another package. */
- PM_PKG_REASON_DEPEND = 1
-} pmpkgreason_t;
-
/** @addtogroup alpm_api_databases Database Functions
* Functions to query and manipulate the database of libalpm.
* @{
@@ -215,93 +397,112 @@ typedef enum _pmpkgreason_t {
* libalpm functions.
* @return a reference to the local database
*/
-pmdb_t *alpm_option_get_localdb(void);
+alpm_db_t *alpm_option_get_localdb(alpm_handle_t *handle);
/** Get the list of sync databases.
- * Returns a list of pmdb_t structures, one for each registered
+ * Returns a list of alpm_db_t structures, one for each registered
* sync database.
- * @return a reference to an internal list of pmdb_t structures
+ * @param handle the context handle
+ * @return a reference to an internal list of alpm_db_t structures
*/
-alpm_list_t *alpm_option_get_syncdbs(void);
+alpm_list_t *alpm_option_get_syncdbs(alpm_handle_t *handle);
/** Register a sync database of packages.
+ * @param handle the context handle
* @param treename the name of the sync repository
- * @return a pmdb_t* on success (the value), NULL on error
+ * @param level what level of signature checking to perform on the
+ * database; note that this must be a '.sig' file type verification
+ * @return an alpm_db_t* on success (the value), NULL on error
*/
-pmdb_t *alpm_db_register_sync(const char *treename);
+alpm_db_t *alpm_db_register_sync(alpm_handle_t *handle, const char *treename,
+ alpm_siglevel_t level);
/** Unregister a package database.
* @param db pointer to the package database to unregister
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_db_unregister(pmdb_t *db);
+int alpm_db_unregister(alpm_db_t *db);
/** Unregister all package databases.
+ * @param handle the context handle
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_db_unregister_all(void);
+int alpm_db_unregister_all(alpm_handle_t *handle);
/** Get the name of a package database.
* @param db pointer to the package database
* @return the name of the package database, NULL on error
*/
-const char *alpm_db_get_name(const pmdb_t *db);
+const char *alpm_db_get_name(const alpm_db_t *db);
-/** Get a download URL for the package database.
+/** Get the signature verification level for a database.
+ * Will return the default verification level if this database is set up
+ * with ALPM_SIG_USE_DEFAULT.
* @param db pointer to the package database
- * @return a fully-specified download URL, NULL on error
+ * @return the signature verification level
*/
-const char *alpm_db_get_url(const pmdb_t *db);
+alpm_siglevel_t alpm_db_get_siglevel(alpm_db_t *db);
-/** Set the serverlist of a database.
- * @param db database pointer
- * @param url url of the server
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
+/** Check the validity of a database.
+ * This is most useful for sync databases and verifying signature status.
+ * If invalid, the handle error code will be set accordingly.
+ * @param db pointer to the package database
+ * @return 0 if valid, -1 if invalid (pm_errno is set accordingly)
+ */
+int alpm_db_get_valid(alpm_db_t *db);
+
+/** @name Accessors to the list of servers for a database.
+ * @{
*/
-int alpm_db_setserver(pmdb_t *db, const char *url);
+alpm_list_t *alpm_db_get_servers(const alpm_db_t *db);
+int alpm_db_set_servers(alpm_db_t *db, alpm_list_t *servers);
+int alpm_db_add_server(alpm_db_t *db, const char *url);
+int alpm_db_remove_server(alpm_db_t *db, const char *url);
+/** @} */
-int alpm_db_update(int level, pmdb_t *db);
+int alpm_db_update(int level, alpm_db_t *db);
/** Get a package entry from a package database.
* @param db pointer to the package database to get the package from
* @param name of the package
* @return the package entry on success, NULL on error
*/
-pmpkg_t *alpm_db_get_pkg(pmdb_t *db, const char *name);
+alpm_pkg_t *alpm_db_get_pkg(alpm_db_t *db, const char *name);
/** Get the package cache of a package database.
* @param db pointer to the package database to get the package from
* @return the list of packages on success, NULL on error
*/
-alpm_list_t *alpm_db_get_pkgcache(pmdb_t *db);
+alpm_list_t *alpm_db_get_pkgcache(alpm_db_t *db);
/** Get a group entry from a package database.
* @param db pointer to the package database to get the group from
* @param name of the group
* @return the groups entry on success, NULL on error
*/
-pmgrp_t *alpm_db_readgrp(pmdb_t *db, const char *name);
+alpm_group_t *alpm_db_readgroup(alpm_db_t *db, const char *name);
/** Get the group cache of a package database.
* @param db pointer to the package database to get the group from
* @return the list of groups on success, NULL on error
*/
-alpm_list_t *alpm_db_get_grpcache(pmdb_t *db);
+alpm_list_t *alpm_db_get_groupcache(alpm_db_t *db);
-/** Searches a database.
+/** Searches a database with regular expressions.
* @param db pointer to the package database to search in
- * @param needles the list of strings to search for
- * @return the list of packages on success, NULL on error
+ * @param needles a list of regular expressions to search for
+ * @return the list of packages matching all regular expressions on success, NULL on error
*/
-alpm_list_t *alpm_db_search(pmdb_t *db, const alpm_list_t* needles);
+alpm_list_t *alpm_db_search(alpm_db_t *db, const alpm_list_t* needles);
/** Set install reason for a package in db.
- * @param db pointer to the package database
- * @param name the name of the package
+ * @param handle the context handle
+ * @param pkg the package to update
* @param reason the new install reason
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_db_set_pkgreason(pmdb_t *db, const char *name, pmpkgreason_t reason);
+int alpm_db_set_pkgreason(alpm_handle_t *handle, alpm_pkg_t *pkg,
+ alpm_pkgreason_t reason);
/** @} */
@@ -313,26 +514,31 @@ int alpm_db_set_pkgreason(pmdb_t *db, const char *name, pmpkgreason_t reason);
/** Create a package from a file.
* If full is false, the archive is read only until all necessary
* metadata is found. If it is true, the entire archive is read, which
- * serves as a verfication of integrity and the filelist can be created.
+ * serves as a verification of integrity and the filelist can be created.
+ * The allocated structure should be freed using alpm_pkg_free().
+ * @param handle the context handle
* @param filename location of the package tarball
* @param full whether to stop the load after metadata is read or continue
- * through the full archive
+ * through the full archive
+ * @param level what level of package signature checking to perform on the
+ * package; note that this must be a '.sig' file type verification
* @param pkg address of the package pointer
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_pkg_load(const char *filename, int full, pmpkg_t **pkg);
+int alpm_pkg_load(alpm_handle_t *handle, const char *filename, int full,
+ alpm_siglevel_t, alpm_pkg_t **pkg);
/** Free a package.
* @param pkg package pointer to free
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_pkg_free(pmpkg_t *pkg);
+int alpm_pkg_free(alpm_pkg_t *pkg);
/** Check the integrity (with md5) of a package from the sync cache.
* @param pkg package pointer
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_pkg_checkmd5sum(pmpkg_t *pkg);
+int alpm_pkg_checkmd5sum(alpm_pkg_t *pkg);
/** Compare two version strings and determine which one is 'newer'. */
int alpm_pkg_vercmp(const char *a, const char *b);
@@ -343,7 +549,7 @@ int alpm_pkg_vercmp(const char *a, const char *b);
* @param pkg a package
* @return the list of packages requiring pkg
*/
-alpm_list_t *alpm_pkg_compute_requiredby(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_compute_requiredby(alpm_pkg_t *pkg);
/** @name Package Property Accessors
* Any pointer returned by these functions points to internal structures
@@ -356,13 +562,13 @@ alpm_list_t *alpm_pkg_compute_requiredby(pmpkg_t *pkg);
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_filename(pmpkg_t *pkg);
+const char *alpm_pkg_get_filename(alpm_pkg_t *pkg);
/** Returns the package name.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_name(pmpkg_t *pkg);
+const char *alpm_pkg_get_name(alpm_pkg_t *pkg);
/** Returns the package version as a string.
* This includes all available epoch, version, and pkgrel components. Use
@@ -370,124 +576,125 @@ const char *alpm_pkg_get_name(pmpkg_t *pkg);
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_version(pmpkg_t *pkg);
+const char *alpm_pkg_get_version(alpm_pkg_t *pkg);
/** Returns the package description.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_desc(pmpkg_t *pkg);
+const char *alpm_pkg_get_desc(alpm_pkg_t *pkg);
/** Returns the package URL.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_url(pmpkg_t *pkg);
+const char *alpm_pkg_get_url(alpm_pkg_t *pkg);
/** Returns the build timestamp of the package.
* @param pkg a pointer to package
* @return the timestamp of the build time
*/
-time_t alpm_pkg_get_builddate(pmpkg_t *pkg);
+time_t alpm_pkg_get_builddate(alpm_pkg_t *pkg);
/** Returns the install timestamp of the package.
* @param pkg a pointer to package
* @return the timestamp of the install time
*/
-time_t alpm_pkg_get_installdate(pmpkg_t *pkg);
+time_t alpm_pkg_get_installdate(alpm_pkg_t *pkg);
/** Returns the packager's name.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_packager(pmpkg_t *pkg);
+const char *alpm_pkg_get_packager(alpm_pkg_t *pkg);
/** Returns the package's MD5 checksum as a string.
* The returned string is a sequence of lowercase hexadecimal digits.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_md5sum(pmpkg_t *pkg);
+const char *alpm_pkg_get_md5sum(alpm_pkg_t *pkg);
/** Returns the architecture for which the package was built.
* @param pkg a pointer to package
* @return a reference to an internal string
*/
-const char *alpm_pkg_get_arch(pmpkg_t *pkg);
+const char *alpm_pkg_get_arch(alpm_pkg_t *pkg);
/** Returns the size of the package.
* @param pkg a pointer to package
* @return the size of the package in bytes.
*/
-off_t alpm_pkg_get_size(pmpkg_t *pkg);
+off_t alpm_pkg_get_size(alpm_pkg_t *pkg);
/** Returns the installed size of the package.
* @param pkg a pointer to package
* @return the total size of files installed by the package.
*/
-off_t alpm_pkg_get_isize(pmpkg_t *pkg);
+off_t alpm_pkg_get_isize(alpm_pkg_t *pkg);
/** Returns the package installation reason.
* @param pkg a pointer to package
* @return an enum member giving the install reason.
*/
-pmpkgreason_t alpm_pkg_get_reason(pmpkg_t *pkg);
+alpm_pkgreason_t alpm_pkg_get_reason(alpm_pkg_t *pkg);
/** Returns the list of package licenses.
* @param pkg a pointer to package
* @return a pointer to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_licenses(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_licenses(alpm_pkg_t *pkg);
/** Returns the list of package groups.
* @param pkg a pointer to package
* @return a pointer to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_groups(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_groups(alpm_pkg_t *pkg);
-/** Returns the list of package dependencies as pmdepend_t.
+/** Returns the list of package dependencies as alpm_depend_t.
* @param pkg a pointer to package
- * @return a reference to an internal list of pmdepend_t structures.
+ * @return a reference to an internal list of alpm_depend_t structures.
*/
-alpm_list_t *alpm_pkg_get_depends(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_depends(alpm_pkg_t *pkg);
/** Returns the list of package optional dependencies.
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_optdepends(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_optdepends(alpm_pkg_t *pkg);
/** Returns the list of package names conflicting with pkg.
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_conflicts(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_conflicts(alpm_pkg_t *pkg);
/** Returns the list of package names provided by pkg.
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_provides(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_provides(alpm_pkg_t *pkg);
/** Returns the list of available deltas for pkg.
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_deltas(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_deltas(alpm_pkg_t *pkg);
/** Returns the list of packages to be replaced by pkg.
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_replaces(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_replaces(alpm_pkg_t *pkg);
/** Returns the list of files installed by pkg.
* The filenames are relative to the install root,
* and do not include leading slashes.
* @param pkg a pointer to package
- * @return a reference to an internal list of strings.
+ * @return a pointer to a filelist object containing a count and an array of
+ * package file objects
*/
-alpm_list_t *alpm_pkg_get_files(pmpkg_t *pkg);
+alpm_filelist_t *alpm_pkg_get_files(alpm_pkg_t *pkg);
/** Returns the list of files backed up when installing pkg.
* The elements of the returned list have the form
@@ -496,17 +703,17 @@ alpm_list_t *alpm_pkg_get_files(pmpkg_t *pkg);
* @param pkg a pointer to package
* @return a reference to an internal list of strings.
*/
-alpm_list_t *alpm_pkg_get_backup(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_get_backup(alpm_pkg_t *pkg);
-/** Returns the database containing pkg
- * Returns a pointer to the pmdb_t structure the package is
- * originating from, or NULL is the package was loaded from a file.
+/** Returns the database containing pkg.
+ * Returns a pointer to the alpm_db_t structure the package is
+ * originating from, or NULL if the package was loaded from a file.
* @param pkg a pointer to package
* @return a pointer to the DB containing pkg, or NULL.
*/
-pmdb_t *alpm_pkg_get_db(pmpkg_t *pkg);
+alpm_db_t *alpm_pkg_get_db(alpm_pkg_t *pkg);
-/* End of pmpkg_t accessors */
+/* End of alpm_pkg_t accessors */
/* @} */
/** Open a package changelog for reading.
@@ -515,7 +722,7 @@ pmdb_t *alpm_pkg_get_db(pmpkg_t *pkg);
* @param pkg the package to read the changelog of (either file or db)
* @return a 'file stream' to the package changelog
*/
-void *alpm_pkg_changelog_open(pmpkg_t *pkg);
+void *alpm_pkg_changelog_open(alpm_pkg_t *pkg);
/** Read data from an open changelog 'file stream'.
* Similar to fread in functionality, this function takes a buffer and
@@ -528,13 +735,16 @@ void *alpm_pkg_changelog_open(pmpkg_t *pkg);
* error occurred.
*/
size_t alpm_pkg_changelog_read(void *ptr, size_t size,
- const pmpkg_t *pkg, const void *fp);
+ const alpm_pkg_t *pkg, const void *fp);
-/*int alpm_pkg_changelog_feof(const pmpkg_t *pkg, void *fp);*/
+/*int alpm_pkg_changelog_feof(const alpm_pkg_t *pkg, void *fp);*/
-int alpm_pkg_changelog_close(const pmpkg_t *pkg, void *fp);
+int alpm_pkg_changelog_close(const alpm_pkg_t *pkg, void *fp);
-int alpm_pkg_has_scriptlet(pmpkg_t *pkg);
+/** Returns whether the package has an install scriptlet.
+ * @return 0 if FALSE, TRUE otherwise
+ */
+int alpm_pkg_has_scriptlet(alpm_pkg_t *pkg);
/** Returns the size of download.
* Returns the size of the files that will be downloaded to install a
@@ -542,35 +752,34 @@ int alpm_pkg_has_scriptlet(pmpkg_t *pkg);
* @param newpkg the new package to upgrade to
* @return the size of the download
*/
-off_t alpm_pkg_download_size(pmpkg_t *newpkg);
+off_t alpm_pkg_download_size(alpm_pkg_t *newpkg);
-alpm_list_t *alpm_pkg_unused_deltas(pmpkg_t *pkg);
+alpm_list_t *alpm_pkg_unused_deltas(alpm_pkg_t *pkg);
/* End of alpm_pkg */
/** @} */
/*
- * Deltas
+ * Signatures
*/
-const char *alpm_delta_get_from(pmdelta_t *delta);
-const char *alpm_delta_get_to(pmdelta_t *delta);
-const char *alpm_delta_get_filename(pmdelta_t *delta);
-const char *alpm_delta_get_md5sum(pmdelta_t *delta);
-off_t alpm_delta_get_size(pmdelta_t *delta);
+int alpm_pkg_check_pgp_signature(alpm_pkg_t *pkg, alpm_sigresult_t *result);
+
+int alpm_db_check_pgp_signature(alpm_db_t *db, alpm_sigresult_t *result);
+
+int alpm_sigresult_cleanup(alpm_sigresult_t *result);
/*
* Groups
*/
-const char *alpm_grp_get_name(const pmgrp_t *grp);
-alpm_list_t *alpm_grp_get_pkgs(const pmgrp_t *grp);
-alpm_list_t *alpm_find_grp_pkgs(alpm_list_t *dbs, const char *name);
+
+alpm_list_t *alpm_find_group_pkgs(alpm_list_t *dbs, const char *name);
/*
* Sync
*/
-pmpkg_t *alpm_sync_newversion(pmpkg_t *pkg, alpm_list_t *dbs_sync);
+alpm_pkg_t *alpm_sync_newversion(alpm_pkg_t *pkg, alpm_list_t *dbs_sync);
/** @addtogroup alpm_api_trans Transaction Functions
* Functions to manipulate libalpm transactions
@@ -578,290 +787,263 @@ pmpkg_t *alpm_sync_newversion(pmpkg_t *pkg, alpm_list_t *dbs_sync);
*/
/** Transaction flags */
-typedef enum _pmtransflag_t {
+typedef enum _alpm_transflag_t {
/** Ignore dependency checks. */
- PM_TRANS_FLAG_NODEPS = 1,
+ ALPM_TRANS_FLAG_NODEPS = 1,
/** Ignore file conflicts and overwrite files. */
- PM_TRANS_FLAG_FORCE = (1 << 1),
+ ALPM_TRANS_FLAG_FORCE = (1 << 1),
/** Delete files even if they are tagged as backup. */
- PM_TRANS_FLAG_NOSAVE = (1 << 2),
+ ALPM_TRANS_FLAG_NOSAVE = (1 << 2),
/** Ignore version numbers when checking dependencies. */
- PM_TRANS_FLAG_NODEPVERSION = (1 << 3),
+ ALPM_TRANS_FLAG_NODEPVERSION = (1 << 3),
/** Remove also any packages depending on a package being removed. */
- PM_TRANS_FLAG_CASCADE = (1 << 4),
+ ALPM_TRANS_FLAG_CASCADE = (1 << 4),
/** Remove packages and their unneeded deps (not explicitly installed). */
- PM_TRANS_FLAG_RECURSE = (1 << 5),
+ ALPM_TRANS_FLAG_RECURSE = (1 << 5),
/** Modify database but do not commit changes to the filesystem. */
- PM_TRANS_FLAG_DBONLY = (1 << 6),
+ ALPM_TRANS_FLAG_DBONLY = (1 << 6),
/* (1 << 7) flag can go here */
- /** Use PM_PKG_REASON_DEPEND when installing packages. */
- PM_TRANS_FLAG_ALLDEPS = (1 << 8),
+ /** Use ALPM_PKG_REASON_DEPEND when installing packages. */
+ ALPM_TRANS_FLAG_ALLDEPS = (1 << 8),
/** Only download packages and do not actually install. */
- PM_TRANS_FLAG_DOWNLOADONLY = (1 << 9),
+ ALPM_TRANS_FLAG_DOWNLOADONLY = (1 << 9),
/** Do not execute install scriptlets after installing. */
- PM_TRANS_FLAG_NOSCRIPTLET = (1 << 10),
+ ALPM_TRANS_FLAG_NOSCRIPTLET = (1 << 10),
/** Ignore dependency conflicts. */
- PM_TRANS_FLAG_NOCONFLICTS = (1 << 11),
+ ALPM_TRANS_FLAG_NOCONFLICTS = (1 << 11),
/* (1 << 12) flag can go here */
/** Do not install a package if it is already installed and up to date. */
- PM_TRANS_FLAG_NEEDED = (1 << 13),
- /** Use PM_PKG_REASON_EXPLICIT when installing packages. */
- PM_TRANS_FLAG_ALLEXPLICIT = (1 << 14),
+ ALPM_TRANS_FLAG_NEEDED = (1 << 13),
+ /** Use ALPM_PKG_REASON_EXPLICIT when installing packages. */
+ ALPM_TRANS_FLAG_ALLEXPLICIT = (1 << 14),
/** Do not remove a package if it is needed by another one. */
- PM_TRANS_FLAG_UNNEEDED = (1 << 15),
- /** Remove also explicitly installed unneeded deps (use with PM_TRANS_FLAG_RECURSE). */
- PM_TRANS_FLAG_RECURSEALL = (1 << 16),
+ ALPM_TRANS_FLAG_UNNEEDED = (1 << 15),
+ /** Remove also explicitly installed unneeded deps (use with ALPM_TRANS_FLAG_RECURSE). */
+ ALPM_TRANS_FLAG_RECURSEALL = (1 << 16),
/** Do not lock the database during the operation. */
- PM_TRANS_FLAG_NOLOCK = (1 << 17)
-} pmtransflag_t;
+ ALPM_TRANS_FLAG_NOLOCK = (1 << 17)
+} alpm_transflag_t;
/** Transaction events.
* NULL parameters are passed to in all events unless specified otherwise.
*/
-typedef enum _pmtransevt_t {
+typedef enum _alpm_transevt_t {
/** Dependencies will be computed for a package. */
- PM_TRANS_EVT_CHECKDEPS_START = 1,
+ ALPM_TRANS_EVT_CHECKDEPS_START = 1,
/** Dependencies were computed for a package. */
- PM_TRANS_EVT_CHECKDEPS_DONE,
+ ALPM_TRANS_EVT_CHECKDEPS_DONE,
/** File conflicts will be computed for a package. */
- PM_TRANS_EVT_FILECONFLICTS_START,
+ ALPM_TRANS_EVT_FILECONFLICTS_START,
/** File conflicts were computed for a package. */
- PM_TRANS_EVT_FILECONFLICTS_DONE,
+ ALPM_TRANS_EVT_FILECONFLICTS_DONE,
/** Dependencies will be resolved for target package. */
- PM_TRANS_EVT_RESOLVEDEPS_START,
+ ALPM_TRANS_EVT_RESOLVEDEPS_START,
/** Dependencies were resolved for target package. */
- PM_TRANS_EVT_RESOLVEDEPS_DONE,
+ ALPM_TRANS_EVT_RESOLVEDEPS_DONE,
/** Inter-conflicts will be checked for target package. */
- PM_TRANS_EVT_INTERCONFLICTS_START,
+ ALPM_TRANS_EVT_INTERCONFLICTS_START,
/** Inter-conflicts were checked for target package. */
- PM_TRANS_EVT_INTERCONFLICTS_DONE,
+ ALPM_TRANS_EVT_INTERCONFLICTS_DONE,
/** Package will be installed.
* A pointer to the target package is passed to the callback.
*/
- PM_TRANS_EVT_ADD_START,
+ ALPM_TRANS_EVT_ADD_START,
/** Package was installed.
* A pointer to the new package is passed to the callback.
*/
- PM_TRANS_EVT_ADD_DONE,
+ ALPM_TRANS_EVT_ADD_DONE,
/** Package will be removed.
* A pointer to the target package is passed to the callback.
*/
- PM_TRANS_EVT_REMOVE_START,
+ ALPM_TRANS_EVT_REMOVE_START,
/** Package was removed.
* A pointer to the removed package is passed to the callback.
*/
- PM_TRANS_EVT_REMOVE_DONE,
+ ALPM_TRANS_EVT_REMOVE_DONE,
/** Package will be upgraded.
* A pointer to the upgraded package is passed to the callback.
*/
- PM_TRANS_EVT_UPGRADE_START,
+ ALPM_TRANS_EVT_UPGRADE_START,
/** Package was upgraded.
* A pointer to the new package, and a pointer to the old package is passed
* to the callback, respectively.
*/
- PM_TRANS_EVT_UPGRADE_DONE,
+ ALPM_TRANS_EVT_UPGRADE_DONE,
/** Target package's integrity will be checked. */
- PM_TRANS_EVT_INTEGRITY_START,
+ ALPM_TRANS_EVT_INTEGRITY_START,
/** Target package's integrity was checked. */
- PM_TRANS_EVT_INTEGRITY_DONE,
+ ALPM_TRANS_EVT_INTEGRITY_DONE,
/** Target deltas's integrity will be checked. */
- PM_TRANS_EVT_DELTA_INTEGRITY_START,
+ ALPM_TRANS_EVT_DELTA_INTEGRITY_START,
/** Target delta's integrity was checked. */
- PM_TRANS_EVT_DELTA_INTEGRITY_DONE,
+ ALPM_TRANS_EVT_DELTA_INTEGRITY_DONE,
/** Deltas will be applied to packages. */
- PM_TRANS_EVT_DELTA_PATCHES_START,
+ ALPM_TRANS_EVT_DELTA_PATCHES_START,
/** Deltas were applied to packages. */
- PM_TRANS_EVT_DELTA_PATCHES_DONE,
+ ALPM_TRANS_EVT_DELTA_PATCHES_DONE,
/** Delta patch will be applied to target package.
* The filename of the package and the filename of the patch is passed to the
* callback.
*/
- PM_TRANS_EVT_DELTA_PATCH_START,
+ ALPM_TRANS_EVT_DELTA_PATCH_START,
/** Delta patch was applied to target package. */
- PM_TRANS_EVT_DELTA_PATCH_DONE,
+ ALPM_TRANS_EVT_DELTA_PATCH_DONE,
/** Delta patch failed to apply to target package. */
- PM_TRANS_EVT_DELTA_PATCH_FAILED,
+ ALPM_TRANS_EVT_DELTA_PATCH_FAILED,
/** Scriptlet has printed information.
* A line of text is passed to the callback.
*/
- PM_TRANS_EVT_SCRIPTLET_INFO,
+ ALPM_TRANS_EVT_SCRIPTLET_INFO,
/** Files will be downloaded from a repository.
* The repository's tree name is passed to the callback.
*/
- PM_TRANS_EVT_RETRIEVE_START,
+ ALPM_TRANS_EVT_RETRIEVE_START,
/** Disk space usage will be computed for a package */
- PM_TRANS_EVT_DISKSPACE_START,
+ ALPM_TRANS_EVT_DISKSPACE_START,
/** Disk space usage was computed for a package */
- PM_TRANS_EVT_DISKSPACE_DONE,
-} pmtransevt_t;
+ ALPM_TRANS_EVT_DISKSPACE_DONE,
+} alpm_transevt_t;
/** Transaction Conversations (ie, questions) */
-typedef enum _pmtransconv_t {
- PM_TRANS_CONV_INSTALL_IGNOREPKG = 1,
- PM_TRANS_CONV_REPLACE_PKG = (1 << 1),
- PM_TRANS_CONV_CONFLICT_PKG = (1 << 2),
- PM_TRANS_CONV_CORRUPTED_PKG = (1 << 3),
- PM_TRANS_CONV_LOCAL_NEWER = (1 << 4),
- PM_TRANS_CONV_REMOVE_PKGS = (1 << 5),
- PM_TRANS_CONV_SELECT_PROVIDER = (1 << 6),
-} pmtransconv_t;
+typedef enum _alpm_transconv_t {
+ ALPM_TRANS_CONV_INSTALL_IGNOREPKG = 1,
+ ALPM_TRANS_CONV_REPLACE_PKG = (1 << 1),
+ ALPM_TRANS_CONV_CONFLICT_PKG = (1 << 2),
+ ALPM_TRANS_CONV_CORRUPTED_PKG = (1 << 3),
+ ALPM_TRANS_CONV_LOCAL_NEWER = (1 << 4),
+ ALPM_TRANS_CONV_REMOVE_PKGS = (1 << 5),
+ ALPM_TRANS_CONV_SELECT_PROVIDER = (1 << 6),
+} alpm_transconv_t;
/** Transaction Progress */
-typedef enum _pmtransprog_t {
- PM_TRANS_PROGRESS_ADD_START,
- PM_TRANS_PROGRESS_UPGRADE_START,
- PM_TRANS_PROGRESS_REMOVE_START,
- PM_TRANS_PROGRESS_CONFLICTS_START,
- PM_TRANS_PROGRESS_DISKSPACE_START,
- PM_TRANS_PROGRESS_INTEGRITY_START,
-} pmtransprog_t;
+typedef enum _alpm_transprog_t {
+ ALPM_TRANS_PROGRESS_ADD_START,
+ ALPM_TRANS_PROGRESS_UPGRADE_START,
+ ALPM_TRANS_PROGRESS_REMOVE_START,
+ ALPM_TRANS_PROGRESS_CONFLICTS_START,
+ ALPM_TRANS_PROGRESS_DISKSPACE_START,
+ ALPM_TRANS_PROGRESS_INTEGRITY_START,
+} alpm_transprog_t;
/** Transaction Event callback */
-typedef void (*alpm_trans_cb_event)(pmtransevt_t, void *, void *);
+typedef void (*alpm_trans_cb_event)(alpm_transevt_t, void *, void *);
/** Transaction Conversation callback */
-typedef void (*alpm_trans_cb_conv)(pmtransconv_t, void *, void *,
+typedef void (*alpm_trans_cb_conv)(alpm_transconv_t, void *, void *,
void *, int *);
/** Transaction Progress callback */
-typedef void (*alpm_trans_cb_progress)(pmtransprog_t, const char *, int, size_t, size_t);
+typedef void (*alpm_trans_cb_progress)(alpm_transprog_t, const char *, int, size_t, size_t);
-int alpm_trans_get_flags(void);
+/** Returns the bitfield of flags for the current transaction.
+ * @param handle the context handle
+ * @return the bitfield of transaction flags
+ */
+alpm_transflag_t alpm_trans_get_flags(alpm_handle_t *handle);
/** Returns a list of packages added by the transaction.
- * @return a list of pmpkg_t structures
+ * @param handle the context handle
+ * @return a list of alpm_pkg_t structures
*/
-alpm_list_t * alpm_trans_get_add(void);
+alpm_list_t * alpm_trans_get_add(alpm_handle_t *handle);
/** Returns the list of packages removed by the transaction.
- * @return a list of pmpkg_t structures
+ * @param handle the context handle
+ * @return a list of alpm_pkg_t structures
*/
-alpm_list_t * alpm_trans_get_remove(void);
+alpm_list_t * alpm_trans_get_remove(alpm_handle_t *handle);
/** Initialize the transaction.
+ * @param handle the context handle
* @param flags flags of the transaction (like nodeps, etc)
* @param event event callback function pointer
* @param conv question callback function pointer
* @param progress progress callback function pointer
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_trans_init(pmtransflag_t flags,
+int alpm_trans_init(alpm_handle_t *handle, alpm_transflag_t flags,
alpm_trans_cb_event cb_event, alpm_trans_cb_conv conv,
alpm_trans_cb_progress cb_progress);
/** Prepare a transaction.
+ * @param handle the context handle
* @param data the address of an alpm_list where a list
- * of pmdepmissing_t objects is dumped (conflicting packages)
+ * of alpm_depmissing_t objects is dumped (conflicting packages)
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_trans_prepare(alpm_list_t **data);
+int alpm_trans_prepare(alpm_handle_t *handle, alpm_list_t **data);
/** Commit a transaction.
+ * @param handle the context handle
* @param data the address of an alpm_list where detailed description
* of an error can be dumped (ie. list of conflicting files)
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_trans_commit(alpm_list_t **data);
+int alpm_trans_commit(alpm_handle_t *handle, alpm_list_t **data);
/** Interrupt a transaction.
+ * @param handle the context handle
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_trans_interrupt(void);
+int alpm_trans_interrupt(alpm_handle_t *handle);
/** Release a transaction.
+ * @param handle the context handle
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
-int alpm_trans_release(void);
+int alpm_trans_release(alpm_handle_t *handle);
/** @} */
/** @name Common Transactions */
/** @{ */
-int alpm_sync_sysupgrade(int enable_downgrade);
-int alpm_add_pkg(pmpkg_t *pkg);
-int alpm_remove_pkg(pmpkg_t *pkg);
-/** @} */
-/** @addtogroup alpm_api_depends Dependency Functions
- * Functions dealing with libalpm representation of dependency
- * information.
- * @{
+/** Search for packages to upgrade and add them to the transaction.
+ * @param handle the context handle
+ * @param enable_downgrade allow downgrading of packages if the remote version is lower
+ * @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
+int alpm_sync_sysupgrade(alpm_handle_t *handle, int enable_downgrade);
-/** Types of version constraints in dependency specs. */
-typedef enum _pmdepmod_t {
- /** No version constraint */
- PM_DEP_MOD_ANY = 1,
- /** Test version equality (package=x.y.z) */
- PM_DEP_MOD_EQ,
- /** Test for at least a version (package>=x.y.z) */
- PM_DEP_MOD_GE,
- /** Test for at most a version (package<=x.y.z) */
- PM_DEP_MOD_LE,
- /** Test for greater than some version (package>x.y.z) */
- PM_DEP_MOD_GT,
- /** Test for less than some version (package<x.y.z) */
- PM_DEP_MOD_LT
-} pmdepmod_t;
-
-alpm_list_t *alpm_checkdeps(alpm_list_t *pkglist, int reversedeps,
- alpm_list_t *remove, alpm_list_t *upgrade);
-pmpkg_t *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring);
-pmpkg_t *alpm_find_dbs_satisfier(alpm_list_t *dbs, const char *depstring);
-
-const char *alpm_miss_get_target(const pmdepmissing_t *miss);
-pmdepend_t *alpm_miss_get_dep(pmdepmissing_t *miss);
-const char *alpm_miss_get_causingpkg(const pmdepmissing_t *miss);
+/** Add a package to the transaction.
+ * If the package was loaded by alpm_pkg_load(), it will be freed upon
+ * alpm_trans_release() invocation.
+ * @param handle the context handle
+ * @param pkg the package to add
+ * @return 0 on success, -1 on error (pm_errno is set accordingly)
+ */
+int alpm_add_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
-alpm_list_t *alpm_checkconflicts(alpm_list_t *pkglist);
+/** Add a package removal action to the transaction.
+ * @param handle the context handle
+ * @param pkg the package to uninstall
+ * @return 0 on success, -1 on error (pm_errno is set accordingly)
+ */
+int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
-const char *alpm_conflict_get_package1(pmconflict_t *conflict);
-const char *alpm_conflict_get_package2(pmconflict_t *conflict);
-const char *alpm_conflict_get_reason(pmconflict_t *conflict);
+/** @} */
-/** Returns the type of version constraint.
- * @param dep a dependency info structure
- * @return the type of version constraint (PM_DEP_MOD_ANY if no version
- * is specified).
+/** @addtogroup alpm_api_depends Dependency Functions
+ * Functions dealing with libalpm representation of dependency
+ * information.
+ * @{
*/
-pmdepmod_t alpm_dep_get_mod(const pmdepend_t *dep);
-/** Returns the package name of a dependency constraint.
- * @param dep a dependency info structure
- * @return a pointer to an internal string.
- */
-const char *alpm_dep_get_name(const pmdepend_t *dep);
+alpm_list_t *alpm_checkdeps(alpm_handle_t *handle, alpm_list_t *pkglist,
+ alpm_list_t *remove, alpm_list_t *upgrade, int reversedeps);
+alpm_pkg_t *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring);
+alpm_pkg_t *alpm_find_dbs_satisfier(alpm_handle_t *handle,
+ alpm_list_t *dbs, const char *depstring);
-/** Returns the version specified by a dependency constraint.
- * The version information is returned as a string in the same format
- * as given by alpm_pkg_get_version().
- * @param dep a dependency info structure
- * @return a pointer to an internal string.
- */
-const char *alpm_dep_get_version(const pmdepend_t *dep);
+alpm_list_t *alpm_checkconflicts(alpm_handle_t *handle, alpm_list_t *pkglist);
/** Returns a newly allocated string representing the dependency information.
* @param dep a dependency info structure
* @return a formatted string, e.g. "glibc>=2.12"
*/
-char *alpm_dep_compute_string(const pmdepend_t *dep);
+char *alpm_dep_compute_string(const alpm_depend_t *dep);
/** @} */
-/** @addtogroup alpm_api_fileconflicts File Conflicts Functions
- * Functions to manipulate file conflict information.
- * @{
- */
-
-typedef enum _pmfileconflicttype_t {
- PM_FILECONFLICT_TARGET = 1,
- PM_FILECONFLICT_FILESYSTEM
-} pmfileconflicttype_t;
-
-const char *alpm_fileconflict_get_target(pmfileconflict_t *conflict);
-pmfileconflicttype_t alpm_fileconflict_get_type(pmfileconflict_t *conflict);
-const char *alpm_fileconflict_get_file(pmfileconflict_t *conflict);
-const char *alpm_fileconflict_get_ctarget(pmfileconflict_t *conflict);
-
/** @} */
/*
@@ -874,77 +1056,86 @@ char *alpm_compute_md5sum(const char *name);
/** @addtogroup alpm_api_errors Error Codes
* @{
*/
-enum _pmerrno_t {
- PM_ERR_MEMORY = 1,
- PM_ERR_SYSTEM,
- PM_ERR_BADPERMS,
- PM_ERR_NOT_A_FILE,
- PM_ERR_NOT_A_DIR,
- PM_ERR_WRONG_ARGS,
- PM_ERR_DISK_SPACE,
+enum _alpm_errno_t {
+ ALPM_ERR_MEMORY = 1,
+ ALPM_ERR_SYSTEM,
+ ALPM_ERR_BADPERMS,
+ ALPM_ERR_NOT_A_FILE,
+ ALPM_ERR_NOT_A_DIR,
+ ALPM_ERR_WRONG_ARGS,
+ ALPM_ERR_DISK_SPACE,
/* Interface */
- PM_ERR_HANDLE_NULL,
- PM_ERR_HANDLE_NOT_NULL,
- PM_ERR_HANDLE_LOCK,
+ ALPM_ERR_HANDLE_NULL,
+ ALPM_ERR_HANDLE_NOT_NULL,
+ ALPM_ERR_HANDLE_LOCK,
/* Databases */
- PM_ERR_DB_OPEN,
- PM_ERR_DB_CREATE,
- PM_ERR_DB_NULL,
- PM_ERR_DB_NOT_NULL,
- PM_ERR_DB_NOT_FOUND,
- PM_ERR_DB_VERSION,
- PM_ERR_DB_WRITE,
- PM_ERR_DB_REMOVE,
+ ALPM_ERR_DB_OPEN,
+ ALPM_ERR_DB_CREATE,
+ ALPM_ERR_DB_NULL,
+ ALPM_ERR_DB_NOT_NULL,
+ ALPM_ERR_DB_NOT_FOUND,
+ ALPM_ERR_DB_INVALID,
+ ALPM_ERR_DB_INVALID_SIG,
+ ALPM_ERR_DB_VERSION,
+ ALPM_ERR_DB_WRITE,
+ ALPM_ERR_DB_REMOVE,
/* Servers */
- PM_ERR_SERVER_BAD_URL,
- PM_ERR_SERVER_NONE,
+ ALPM_ERR_SERVER_BAD_URL,
+ ALPM_ERR_SERVER_NONE,
/* Transactions */
- PM_ERR_TRANS_NOT_NULL,
- PM_ERR_TRANS_NULL,
- PM_ERR_TRANS_DUP_TARGET,
- PM_ERR_TRANS_NOT_INITIALIZED,
- PM_ERR_TRANS_NOT_PREPARED,
- PM_ERR_TRANS_ABORT,
- PM_ERR_TRANS_TYPE,
- PM_ERR_TRANS_NOT_LOCKED,
+ ALPM_ERR_TRANS_NOT_NULL,
+ ALPM_ERR_TRANS_NULL,
+ ALPM_ERR_TRANS_DUP_TARGET,
+ ALPM_ERR_TRANS_NOT_INITIALIZED,
+ ALPM_ERR_TRANS_NOT_PREPARED,
+ ALPM_ERR_TRANS_ABORT,
+ ALPM_ERR_TRANS_TYPE,
+ ALPM_ERR_TRANS_NOT_LOCKED,
/* Packages */
- PM_ERR_PKG_NOT_FOUND,
- PM_ERR_PKG_IGNORED,
- PM_ERR_PKG_INVALID,
- PM_ERR_PKG_OPEN,
- PM_ERR_PKG_CANT_REMOVE,
- PM_ERR_PKG_INVALID_NAME,
- PM_ERR_PKG_INVALID_ARCH,
- PM_ERR_PKG_REPO_NOT_FOUND,
+ ALPM_ERR_PKG_NOT_FOUND,
+ ALPM_ERR_PKG_IGNORED,
+ ALPM_ERR_PKG_INVALID,
+ ALPM_ERR_PKG_INVALID_CHECKSUM,
+ ALPM_ERR_PKG_INVALID_SIG,
+ ALPM_ERR_PKG_OPEN,
+ ALPM_ERR_PKG_CANT_REMOVE,
+ ALPM_ERR_PKG_INVALID_NAME,
+ ALPM_ERR_PKG_INVALID_ARCH,
+ ALPM_ERR_PKG_REPO_NOT_FOUND,
+ /* Signatures */
+ ALPM_ERR_SIG_MISSING,
+ ALPM_ERR_SIG_INVALID,
/* Deltas */
- PM_ERR_DLT_INVALID,
- PM_ERR_DLT_PATCHFAILED,
+ ALPM_ERR_DLT_INVALID,
+ ALPM_ERR_DLT_PATCHFAILED,
/* Dependencies */
- PM_ERR_UNSATISFIED_DEPS,
- PM_ERR_CONFLICTING_DEPS,
- PM_ERR_FILE_CONFLICTS,
+ ALPM_ERR_UNSATISFIED_DEPS,
+ ALPM_ERR_CONFLICTING_DEPS,
+ ALPM_ERR_FILE_CONFLICTS,
/* Misc */
- PM_ERR_RETRIEVE,
- PM_ERR_WRITE,
- PM_ERR_INVALID_REGEX,
+ ALPM_ERR_RETRIEVE,
+ ALPM_ERR_INVALID_REGEX,
/* External library errors */
- PM_ERR_LIBARCHIVE,
- PM_ERR_LIBFETCH,
- PM_ERR_EXTERNAL_DOWNLOAD
+ ALPM_ERR_LIBARCHIVE,
+ ALPM_ERR_LIBCURL,
+ ALPM_ERR_EXTERNAL_DOWNLOAD,
+ ALPM_ERR_GPGME
};
-/** The number of the last error that occurred. */
-extern enum _pmerrno_t pm_errno;
+/** Returns the current error code from the handle. */
+enum _alpm_errno_t alpm_errno(alpm_handle_t *handle);
/** Returns the string corresponding to an error number. */
-const char *alpm_strerror(int err);
-
-/** Returns the string corresponding to pm_errno. */
-const char *alpm_strerrorlast(void);
+const char *alpm_strerror(enum _alpm_errno_t err);
/* End of alpm_api_errors */
/** @} */
+alpm_handle_t *alpm_initialize(const char *root, const char *dbpath,
+ enum _alpm_errno_t *err);
+int alpm_release(alpm_handle_t *handle);
+const char *alpm_version(void);
+
/* End of alpm_api */
/** @} */