Add interactive provider selection
[pacman-ng.git] / lib / libalpm / alpm.h
blob6724bf78b06099f5412a684b9dd13608092347cb
1 /*
2 * alpm.h
4 * Copyright (c) 2006-2011 Pacman Development Team <pacman-dev@archlinux.org>
5 * Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
6 * Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
7 * Copyright (c) 2005 by Christian Hamar <krics@linuxforum.hu>
8 * Copyright (c) 2005, 2006 by Miklos Vajna <vmiklos@frugalware.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #ifndef _ALPM_H
24 #define _ALPM_H
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
30 #include <sys/types.h> /* for off_t */
31 #include <time.h> /* for time_t */
32 #include <stdarg.h> /* for va_list */
34 #include <alpm_list.h>
36 #define DEPRECATED __attribute__((deprecated))
39 * Arch Linux Package Management library
43 * Structures
46 typedef struct __pmdb_t pmdb_t;
47 typedef struct __pmpkg_t pmpkg_t;
48 typedef struct __pmdelta_t pmdelta_t;
49 typedef struct __pmgrp_t pmgrp_t;
50 typedef struct __pmtrans_t pmtrans_t;
51 typedef struct __pmdepend_t pmdepend_t;
52 typedef struct __pmdepmissing_t pmdepmissing_t;
53 typedef struct __pmconflict_t pmconflict_t;
54 typedef struct __pmfileconflict_t pmfileconflict_t;
57 * Library
60 int alpm_initialize(void);
61 int alpm_release(void);
62 const char *alpm_version(void);
65 * Logging facilities
68 /* Levels */
69 typedef enum _pmloglevel_t {
70 PM_LOG_ERROR = 1,
71 PM_LOG_WARNING = (1 << 1),
72 PM_LOG_DEBUG = (1 << 2),
73 PM_LOG_FUNCTION = (1 << 3)
74 } pmloglevel_t;
76 typedef void (*alpm_cb_log)(pmloglevel_t, char *, va_list);
77 int alpm_logaction(char *fmt, ...);
80 * Downloading
83 typedef void (*alpm_cb_download)(const char *filename,
84 off_t xfered, off_t total);
85 typedef void (*alpm_cb_totaldl)(off_t total);
86 /** A callback for downloading files
87 * @param url the URL of the file to be downloaded
88 * @param localpath the directory to which the file should be downloaded
89 * @param force whether to force an update, even if the file is the same
90 * @return 0 on success, 1 if the file exists and is identical, -1 on
91 * error.
93 typedef int (*alpm_cb_fetch)(const char *url, const char *localpath,
94 int force);
97 * Options
100 alpm_cb_log alpm_option_get_logcb(void);
101 void alpm_option_set_logcb(alpm_cb_log cb);
103 alpm_cb_download alpm_option_get_dlcb(void);
104 void alpm_option_set_dlcb(alpm_cb_download cb);
106 alpm_cb_fetch alpm_option_get_fetchcb(void);
107 void alpm_option_set_fetchcb(alpm_cb_fetch cb);
109 alpm_cb_totaldl alpm_option_get_totaldlcb(void);
110 void alpm_option_set_totaldlcb(alpm_cb_totaldl cb);
112 const char *alpm_option_get_root(void);
113 int alpm_option_set_root(const char *root);
115 const char *alpm_option_get_dbpath(void);
116 int alpm_option_set_dbpath(const char *dbpath);
118 alpm_list_t *alpm_option_get_cachedirs(void);
119 int alpm_option_add_cachedir(const char *cachedir);
120 void alpm_option_set_cachedirs(alpm_list_t *cachedirs);
121 int alpm_option_remove_cachedir(const char *cachedir);
123 const char *alpm_option_get_logfile(void);
124 int alpm_option_set_logfile(const char *logfile);
126 const char *alpm_option_get_lockfile(void);
127 /* no set_lockfile, path is determined from dbpath */
129 int alpm_option_get_usesyslog(void);
130 void alpm_option_set_usesyslog(int usesyslog);
132 alpm_list_t *alpm_option_get_noupgrades(void);
133 void alpm_option_add_noupgrade(const char *pkg);
134 void alpm_option_set_noupgrades(alpm_list_t *noupgrade);
135 int alpm_option_remove_noupgrade(const char *pkg);
137 alpm_list_t *alpm_option_get_noextracts(void);
138 void alpm_option_add_noextract(const char *pkg);
139 void alpm_option_set_noextracts(alpm_list_t *noextract);
140 int alpm_option_remove_noextract(const char *pkg);
142 alpm_list_t *alpm_option_get_ignorepkgs(void);
143 void alpm_option_add_ignorepkg(const char *pkg);
144 void alpm_option_set_ignorepkgs(alpm_list_t *ignorepkgs);
145 int alpm_option_remove_ignorepkg(const char *pkg);
147 alpm_list_t *alpm_option_get_ignoregrps(void);
148 void alpm_option_add_ignoregrp(const char *grp);
149 void alpm_option_set_ignoregrps(alpm_list_t *ignoregrps);
150 int alpm_option_remove_ignoregrp(const char *grp);
152 const char *alpm_option_get_arch(void);
153 void alpm_option_set_arch(const char *arch);
155 int alpm_option_get_usedelta(void);
156 void alpm_option_set_usedelta(int usedelta);
158 int alpm_option_get_checkspace(void);
159 void alpm_option_set_checkspace(int checkspace);
161 pmdb_t *alpm_option_get_localdb(void);
162 alpm_list_t *alpm_option_get_syncdbs(void);
165 * Install reasons -- ie, why the package was installed
168 typedef enum _pmpkgreason_t {
169 PM_PKG_REASON_EXPLICIT = 0, /* explicitly requested by the user */
170 PM_PKG_REASON_DEPEND = 1 /* installed as a dependency for another package */
171 } pmpkgreason_t;
174 * Databases
177 pmdb_t *alpm_db_register_sync(const char *treename);
178 int alpm_db_unregister(pmdb_t *db);
179 int alpm_db_unregister_all(void);
181 const char *alpm_db_get_name(const pmdb_t *db);
182 const char *alpm_db_get_url(const pmdb_t *db);
184 int alpm_db_setserver(pmdb_t *db, const char *url);
186 int alpm_db_update(int level, pmdb_t *db);
188 pmpkg_t *alpm_db_get_pkg(pmdb_t *db, const char *name);
189 alpm_list_t *alpm_db_get_pkgcache(pmdb_t *db);
191 pmgrp_t *alpm_db_readgrp(pmdb_t *db, const char *name);
192 alpm_list_t *alpm_db_get_grpcache(pmdb_t *db);
193 alpm_list_t *alpm_db_search(pmdb_t *db, const alpm_list_t* needles);
194 int alpm_db_set_pkgreason(pmdb_t *db, const char *name, pmpkgreason_t reason);
197 * Packages
200 /* Info parameters */
202 int alpm_pkg_load(const char *filename, int full, pmpkg_t **pkg);
203 int alpm_pkg_free(pmpkg_t *pkg);
204 int alpm_pkg_checkmd5sum(pmpkg_t *pkg);
205 char *alpm_fetch_pkgurl(const char *url);
206 int alpm_pkg_vercmp(const char *a, const char *b);
207 alpm_list_t *alpm_pkg_compute_requiredby(pmpkg_t *pkg);
209 const char *alpm_pkg_get_filename(pmpkg_t *pkg);
210 const char *alpm_pkg_get_name(pmpkg_t *pkg);
211 const char *alpm_pkg_get_version(pmpkg_t *pkg);
212 const char *alpm_pkg_get_desc(pmpkg_t *pkg);
213 const char *alpm_pkg_get_url(pmpkg_t *pkg);
214 time_t alpm_pkg_get_builddate(pmpkg_t *pkg);
215 time_t alpm_pkg_get_installdate(pmpkg_t *pkg);
216 const char *alpm_pkg_get_packager(pmpkg_t *pkg);
217 const char *alpm_pkg_get_md5sum(pmpkg_t *pkg);
218 const char *alpm_pkg_get_arch(pmpkg_t *pkg);
219 off_t alpm_pkg_get_size(pmpkg_t *pkg);
220 off_t alpm_pkg_get_isize(pmpkg_t *pkg);
221 pmpkgreason_t alpm_pkg_get_reason(pmpkg_t *pkg);
222 alpm_list_t *alpm_pkg_get_licenses(pmpkg_t *pkg);
223 alpm_list_t *alpm_pkg_get_groups(pmpkg_t *pkg);
224 alpm_list_t *alpm_pkg_get_depends(pmpkg_t *pkg);
225 alpm_list_t *alpm_pkg_get_optdepends(pmpkg_t *pkg);
226 alpm_list_t *alpm_pkg_get_conflicts(pmpkg_t *pkg);
227 alpm_list_t *alpm_pkg_get_provides(pmpkg_t *pkg);
228 alpm_list_t *alpm_pkg_get_deltas(pmpkg_t *pkg);
229 alpm_list_t *alpm_pkg_get_replaces(pmpkg_t *pkg);
230 alpm_list_t *alpm_pkg_get_files(pmpkg_t *pkg);
231 alpm_list_t *alpm_pkg_get_backup(pmpkg_t *pkg);
232 pmdb_t *alpm_pkg_get_db(pmpkg_t *pkg);
233 void *alpm_pkg_changelog_open(pmpkg_t *pkg);
234 size_t alpm_pkg_changelog_read(void *ptr, size_t size,
235 const pmpkg_t *pkg, const void *fp);
236 /*int alpm_pkg_changelog_feof(const pmpkg_t *pkg, void *fp);*/
237 int alpm_pkg_changelog_close(const pmpkg_t *pkg, void *fp);
238 int alpm_pkg_has_scriptlet(pmpkg_t *pkg);
240 off_t alpm_pkg_download_size(pmpkg_t *newpkg);
241 alpm_list_t *alpm_pkg_unused_deltas(pmpkg_t *pkg);
244 * Deltas
247 const char *alpm_delta_get_from(pmdelta_t *delta);
248 const char *alpm_delta_get_to(pmdelta_t *delta);
249 const char *alpm_delta_get_filename(pmdelta_t *delta);
250 const char *alpm_delta_get_md5sum(pmdelta_t *delta);
251 off_t alpm_delta_get_size(pmdelta_t *delta);
254 * Groups
256 const char *alpm_grp_get_name(const pmgrp_t *grp);
257 alpm_list_t *alpm_grp_get_pkgs(const pmgrp_t *grp);
260 * Sync
263 pmpkg_t *alpm_sync_newversion(pmpkg_t *pkg, alpm_list_t *dbs_sync);
266 * Transactions
270 /* Flags */
271 typedef enum _pmtransflag_t {
272 PM_TRANS_FLAG_NODEPS = 1,
273 PM_TRANS_FLAG_FORCE = (1 << 1),
274 PM_TRANS_FLAG_NOSAVE = (1 << 2),
275 /* (1 << 3) flag can go here */
276 PM_TRANS_FLAG_CASCADE = (1 << 4),
277 PM_TRANS_FLAG_RECURSE = (1 << 5),
278 PM_TRANS_FLAG_DBONLY = (1 << 6),
279 /* (1 << 7) flag can go here */
280 PM_TRANS_FLAG_ALLDEPS = (1 << 8),
281 PM_TRANS_FLAG_DOWNLOADONLY = (1 << 9),
282 PM_TRANS_FLAG_NOSCRIPTLET = (1 << 10),
283 PM_TRANS_FLAG_NOCONFLICTS = (1 << 11),
284 /* (1 << 12) flag can go here */
285 PM_TRANS_FLAG_NEEDED = (1 << 13),
286 PM_TRANS_FLAG_ALLEXPLICIT = (1 << 14),
287 PM_TRANS_FLAG_UNNEEDED = (1 << 15),
288 PM_TRANS_FLAG_RECURSEALL = (1 << 16),
289 PM_TRANS_FLAG_NOLOCK = (1 << 17)
290 } pmtransflag_t;
293 * @addtogroup alpm_trans
294 * @{
297 * @brief Transaction events.
298 * NULL parameters are passed to in all events unless specified otherwise.
300 typedef enum _pmtransevt_t {
301 /** Dependencies will be computed for a package. */
302 PM_TRANS_EVT_CHECKDEPS_START = 1,
303 /** Dependencies were computed for a package. */
304 PM_TRANS_EVT_CHECKDEPS_DONE,
305 /** File conflicts will be computed for a package. */
306 PM_TRANS_EVT_FILECONFLICTS_START,
307 /** File conflicts were computed for a package. */
308 PM_TRANS_EVT_FILECONFLICTS_DONE,
309 /** Dependencies will be resolved for target package. */
310 PM_TRANS_EVT_RESOLVEDEPS_START,
311 /** Dependencies were resolved for target package. */
312 PM_TRANS_EVT_RESOLVEDEPS_DONE,
313 /** Inter-conflicts will be checked for target package. */
314 PM_TRANS_EVT_INTERCONFLICTS_START,
315 /** Inter-conflicts were checked for target package. */
316 PM_TRANS_EVT_INTERCONFLICTS_DONE,
317 /** Package will be installed.
318 * A pointer to the target package is passed to the callback.
320 PM_TRANS_EVT_ADD_START,
321 /** Package was installed.
322 * A pointer to the new package is passed to the callback.
324 PM_TRANS_EVT_ADD_DONE,
325 /** Package will be removed.
326 * A pointer to the target package is passed to the callback.
328 PM_TRANS_EVT_REMOVE_START,
329 /** Package was removed.
330 * A pointer to the removed package is passed to the callback.
332 PM_TRANS_EVT_REMOVE_DONE,
333 /** Package will be upgraded.
334 * A pointer to the upgraded package is passed to the callback.
336 PM_TRANS_EVT_UPGRADE_START,
337 /** Package was upgraded.
338 * A pointer to the new package, and a pointer to the old package is passed
339 * to the callback, respectively.
341 PM_TRANS_EVT_UPGRADE_DONE,
342 /** Target package's integrity will be checked. */
343 PM_TRANS_EVT_INTEGRITY_START,
344 /** Target package's integrity was checked. */
345 PM_TRANS_EVT_INTEGRITY_DONE,
346 /** Target deltas's integrity will be checked. */
347 PM_TRANS_EVT_DELTA_INTEGRITY_START,
348 /** Target delta's integrity was checked. */
349 PM_TRANS_EVT_DELTA_INTEGRITY_DONE,
350 /** Deltas will be applied to packages. */
351 PM_TRANS_EVT_DELTA_PATCHES_START,
352 /** Deltas were applied to packages. */
353 PM_TRANS_EVT_DELTA_PATCHES_DONE,
354 /** Delta patch will be applied to target package.
355 * The filename of the package and the filename of the patch is passed to the
356 * callback.
358 PM_TRANS_EVT_DELTA_PATCH_START,
359 /** Delta patch was applied to target package. */
360 PM_TRANS_EVT_DELTA_PATCH_DONE,
361 /** Delta patch failed to apply to target package. */
362 PM_TRANS_EVT_DELTA_PATCH_FAILED,
363 /** Scriptlet has printed information.
364 * A line of text is passed to the callback.
366 PM_TRANS_EVT_SCRIPTLET_INFO,
367 /** Files will be downloaded from a repository.
368 * The repository's tree name is passed to the callback.
370 PM_TRANS_EVT_RETRIEVE_START,
371 /** Disk space usage will be computed for a package */
372 PM_TRANS_EVT_DISKSPACE_START,
373 /** Disk space usage was computed for a package */
374 PM_TRANS_EVT_DISKSPACE_DONE,
375 } pmtransevt_t;
376 /*@}*/
378 /* Transaction Conversations (ie, questions) */
379 typedef enum _pmtransconv_t {
380 PM_TRANS_CONV_INSTALL_IGNOREPKG = 1,
381 PM_TRANS_CONV_REPLACE_PKG = (1 << 1),
382 PM_TRANS_CONV_CONFLICT_PKG = (1 << 2),
383 PM_TRANS_CONV_CORRUPTED_PKG = (1 << 3),
384 PM_TRANS_CONV_LOCAL_NEWER = (1 << 4),
385 PM_TRANS_CONV_REMOVE_PKGS = (1 << 5),
386 PM_TRANS_CONV_SELECT_PROVIDER = (1 << 6),
387 } pmtransconv_t;
389 /* Transaction Progress */
390 typedef enum _pmtransprog_t {
391 PM_TRANS_PROGRESS_ADD_START,
392 PM_TRANS_PROGRESS_UPGRADE_START,
393 PM_TRANS_PROGRESS_REMOVE_START,
394 PM_TRANS_PROGRESS_CONFLICTS_START,
395 PM_TRANS_PROGRESS_DISKSPACE_START,
396 PM_TRANS_PROGRESS_INTEGRITY_START,
397 } pmtransprog_t;
399 /* Transaction Event callback */
400 typedef void (*alpm_trans_cb_event)(pmtransevt_t, void *, void *);
402 /* Transaction Conversation callback */
403 typedef void (*alpm_trans_cb_conv)(pmtransconv_t, void *, void *,
404 void *, int *);
406 /* Transaction Progress callback */
407 typedef void (*alpm_trans_cb_progress)(pmtransprog_t, const char *, int, size_t, size_t);
409 int alpm_trans_get_flags(void);
410 alpm_list_t * alpm_trans_get_add(void);
411 alpm_list_t * alpm_trans_get_remove(void);
412 int alpm_trans_init(pmtransflag_t flags,
413 alpm_trans_cb_event cb_event, alpm_trans_cb_conv conv,
414 alpm_trans_cb_progress cb_progress);
415 int alpm_trans_prepare(alpm_list_t **data);
416 int alpm_trans_commit(alpm_list_t **data);
417 int alpm_trans_interrupt(void);
418 int alpm_trans_release(void);
420 int alpm_sync_sysupgrade(int enable_downgrade);
421 int alpm_sync_target(const char *target);
422 int alpm_sync_dbtarget(const char *db, const char *target);
423 int alpm_add_target(const char *target);
424 int alpm_remove_target(const char *target);
427 * Dependencies and conflicts
430 typedef enum _pmdepmod_t {
431 PM_DEP_MOD_ANY = 1,
432 PM_DEP_MOD_EQ,
433 PM_DEP_MOD_GE,
434 PM_DEP_MOD_LE,
435 PM_DEP_MOD_GT,
436 PM_DEP_MOD_LT
437 } pmdepmod_t;
439 alpm_list_t *alpm_checkdeps(alpm_list_t *pkglist, int reversedeps,
440 alpm_list_t *remove, alpm_list_t *upgrade);
441 pmpkg_t *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring);
443 const char *alpm_miss_get_target(const pmdepmissing_t *miss);
444 pmdepend_t *alpm_miss_get_dep(pmdepmissing_t *miss);
445 const char *alpm_miss_get_causingpkg(const pmdepmissing_t *miss);
447 alpm_list_t *alpm_checkconflicts(alpm_list_t *pkglist);
449 const char *alpm_conflict_get_package1(pmconflict_t *conflict);
450 const char *alpm_conflict_get_package2(pmconflict_t *conflict);
451 const char *alpm_conflict_get_reason(pmconflict_t *conflict);
453 pmdepmod_t alpm_dep_get_mod(const pmdepend_t *dep);
454 const char *alpm_dep_get_name(const pmdepend_t *dep);
455 const char *alpm_dep_get_version(const pmdepend_t *dep);
456 char *alpm_dep_compute_string(const pmdepend_t *dep);
459 * File conflicts
462 typedef enum _pmfileconflicttype_t {
463 PM_FILECONFLICT_TARGET = 1,
464 PM_FILECONFLICT_FILESYSTEM
465 } pmfileconflicttype_t;
467 const char *alpm_fileconflict_get_target(pmfileconflict_t *conflict);
468 pmfileconflicttype_t alpm_fileconflict_get_type(pmfileconflict_t *conflict);
469 const char *alpm_fileconflict_get_file(pmfileconflict_t *conflict);
470 const char *alpm_fileconflict_get_ctarget(pmfileconflict_t *conflict);
473 * Helpers
476 /* checksums */
477 char *alpm_compute_md5sum(const char *name);
480 * Errors
482 enum _pmerrno_t {
483 PM_ERR_MEMORY = 1,
484 PM_ERR_SYSTEM,
485 PM_ERR_BADPERMS,
486 PM_ERR_NOT_A_FILE,
487 PM_ERR_NOT_A_DIR,
488 PM_ERR_WRONG_ARGS,
489 PM_ERR_DISK_SPACE,
490 /* Interface */
491 PM_ERR_HANDLE_NULL,
492 PM_ERR_HANDLE_NOT_NULL,
493 PM_ERR_HANDLE_LOCK,
494 /* Databases */
495 PM_ERR_DB_OPEN,
496 PM_ERR_DB_CREATE,
497 PM_ERR_DB_NULL,
498 PM_ERR_DB_NOT_NULL,
499 PM_ERR_DB_NOT_FOUND,
500 PM_ERR_DB_WRITE,
501 PM_ERR_DB_REMOVE,
502 /* Servers */
503 PM_ERR_SERVER_BAD_URL,
504 PM_ERR_SERVER_NONE,
505 /* Transactions */
506 PM_ERR_TRANS_NOT_NULL,
507 PM_ERR_TRANS_NULL,
508 PM_ERR_TRANS_DUP_TARGET,
509 PM_ERR_TRANS_NOT_INITIALIZED,
510 PM_ERR_TRANS_NOT_PREPARED,
511 PM_ERR_TRANS_ABORT,
512 PM_ERR_TRANS_TYPE,
513 PM_ERR_TRANS_NOT_LOCKED,
514 /* Packages */
515 PM_ERR_PKG_NOT_FOUND,
516 PM_ERR_PKG_IGNORED,
517 PM_ERR_PKG_INVALID,
518 PM_ERR_PKG_OPEN,
519 PM_ERR_PKG_CANT_REMOVE,
520 PM_ERR_PKG_INVALID_NAME,
521 PM_ERR_PKG_INVALID_ARCH,
522 PM_ERR_PKG_REPO_NOT_FOUND,
523 /* Deltas */
524 PM_ERR_DLT_INVALID,
525 PM_ERR_DLT_PATCHFAILED,
526 /* Dependencies */
527 PM_ERR_UNSATISFIED_DEPS,
528 PM_ERR_CONFLICTING_DEPS,
529 PM_ERR_FILE_CONFLICTS,
530 /* Misc */
531 PM_ERR_RETRIEVE,
532 PM_ERR_WRITE,
533 PM_ERR_INVALID_REGEX,
534 /* External library errors */
535 PM_ERR_LIBARCHIVE,
536 PM_ERR_LIBFETCH,
537 PM_ERR_EXTERNAL_DOWNLOAD
540 extern enum _pmerrno_t pm_errno;
542 const char *alpm_strerror(int err);
543 const char *alpm_strerrorlast(void);
545 #ifdef __cplusplus
547 #endif
548 #endif /* _ALPM_H */
550 /* vim: set ts=2 sw=2 noet: */