handle.h

Go to the documentation of this file.

/*
 *  handle.h
 *
 *  Copyright (c) 2002-2007 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 "alpm_list.h"
#include "db.h"
#include "log.h"
#include "alpm.h"
#include "trans.h"

typedef struct _pmhandle_t {
    /* internal usage */
    uid_t uid;              /* current UID */ /* TODO is this used? */
    pmdb_t *db_local;       /* local db pointer */
    alpm_list_t *dbs_sync;  /* List of (pmdb_t *) */
    FILE *logstream;        /* log file stream pointer */
    int lckfd;              /* lock file descriptor if one exists */
    pmtrans_t *trans;

    /* callback functions */
    alpm_cb_log logcb;      /* Log callback function */
    alpm_cb_download dlcb;  /* Download callback function */

    /* 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 */
    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 packages NOT to extract */ /*TODO is this used?*/
    alpm_list_t *ignorepkg;   /* List of packages to ignore */
    alpm_list_t *holdpkg;     /* List of packages which 'hold' pacman */
    alpm_list_t *ignoregrp;   /* List of groups to ignore */

    /* options */
    unsigned short usesyslog;    /* Use syslog instead of logfile? */ /* TODO move to frontend */
    unsigned short nopassiveftp; /* Don't use PASV ftp connections */
    char *xfercommand;        /* External download command */
    unsigned short usedelta;     /* Download deltas if possible */
} pmhandle_t;

/* global handle variable */
extern pmhandle_t *handle;

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

#endif /* _ALPM_HANDLE_H */

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

---