handle.h

Go to the documentation of this file.

/*
 *  handle.h
 *
 *  Copyright (c) 2006-2011 Pacman Development Team <pacman-dev@archlinux.org>
 *  Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _ALPM_HANDLE_H
#define _ALPM_HANDLE_H

#include <stdio.h>
#include <sys/types.h>
#include <regex.h>

#include "alpm_list.h"
#include "alpm.h"

#ifdef HAVE_LIBCURL
#include <curl/curl.h>
#endif

#define EVENT(h, e, d1, d2) \
do { \
    if((h)->eventcb) { \
        (h)->eventcb(e, d1, d2); \
    } \
} while(0)
#define QUESTION(h, q, d1, d2, d3, r) \
do { \
    if((h)->questioncb) { \
        (h)->questioncb(q, d1, d2, d3, r); \
    } \
} while(0)
#define PROGRESS(h, e, p, per, n, r) \
do { \
    if((h)->progresscb) { \
        (h)->progresscb(e, p, per, n, r); \
    } \
} while(0)

struct __alpm_handle_t {
    /* internal usage */
    alpm_db_t *db_local;       /* local db pointer */
    alpm_list_t *dbs_sync;  /* List of (alpm_db_t *) */
    FILE *logstream;        /* log file stream pointer */
    FILE *lckstream;        /* lock file stream pointer if one exists */
    alpm_trans_t *trans;

#ifdef HAVE_LIBCURL
    /* libcurl handle */
    CURL *curl;             /* reusable curl_easy handle */
#endif

    /* callback functions */
    alpm_cb_log logcb;      /* Log callback function */
    alpm_cb_download dlcb;  /* Download callback function */
    alpm_cb_totaldl totaldlcb;  /* Total download callback function */
    alpm_cb_fetch fetchcb;  /* Download file callback function */
    alpm_cb_event eventcb;
    alpm_cb_question questioncb;
    alpm_cb_progress progresscb;

    /* filesystem paths */
    char *root;              /* Root path, default '/' */
    char *dbpath;            /* Base path to pacman's DBs */
    char *logfile;           /* Name of the log file */
    char *lockfile;          /* Name of the lock file */
    char *gpgdir;            /* Directory where GnuPG files are stored */
    alpm_list_t *cachedirs;  /* Paths to pacman cache directories */

    /* package lists */
    alpm_list_t *noupgrade;   /* List of packages NOT to be upgraded */
    alpm_list_t *noextract;   /* List of files NOT to extract */
    alpm_list_t *ignorepkg;   /* List of packages to ignore */
    alpm_list_t *ignoregroup; /* List of groups to ignore */

    /* options */
    char *arch;              /* Architecture of packages we should allow */
    int usesyslog;           /* Use syslog instead of logfile? */ /* TODO move to frontend */
    int usedelta;            /* Download deltas if possible */
    int checkspace;          /* Check disk space before installing */
    alpm_siglevel_t siglevel;   /* Default signature verification level */

    /* error code */
    alpm_errno_t pm_errno;

    /* for delta parsing efficiency */
    int delta_regex_compiled;
    regex_t delta_regex;
};

alpm_handle_t *_alpm_handle_new(void);
void _alpm_handle_free(alpm_handle_t *handle);

int _alpm_handle_lock(alpm_handle_t *handle);
int _alpm_handle_unlock(alpm_handle_t *handle);

alpm_errno_t _alpm_set_directory_option(const char *value,
        char **storage, int must_exist);

#endif /* _ALPM_HANDLE_H */

/* vim: set ts=2 sw=2 noet: */