Blame lib/rpmps.h

2ff057
#ifndef H_RPMPS
2ff057
#define H_RPMPS
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * \file lib/rpmps.h
2ff057
 * Structures and prototypes used for an "rpmps" problem set.
2ff057
 */
2ff057
2ff057
#include <stdio.h>
2ff057
#include <rpm/rpmtypes.h>
2ff057
#include <rpm/rpmprob.h>
2ff057
2ff057
#ifdef __cplusplus
2ff057
extern "C" {
2ff057
#endif
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Problem set iterator
2ff057
 */
2ff057
typedef struct rpmpsi_s * rpmpsi;
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Reference a problem set instance.
2ff057
 * @param ps		transaction set
2ff057
 * @return		new transaction set reference
2ff057
 */
2ff057
rpmps rpmpsLink (rpmps ps);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Return number of problems in set.
2ff057
 * @param ps		problem set
2ff057
 * @return		number of problems
2ff057
 */
2ff057
int rpmpsNumProblems(rpmps ps);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Initialize problem set iterator.
2ff057
 * @param ps		problem set
2ff057
 * @return		problem set iterator
2ff057
 */
2ff057
rpmpsi rpmpsInitIterator(rpmps ps);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Destroy problem set iterator.
2ff057
 * @param psi		problem set iterator
2ff057
 * @return		problem set iterator (NULL)
2ff057
 */
2ff057
rpmpsi rpmpsFreeIterator(rpmpsi psi);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Return next problem from iterator
2ff057
 * @param psi		problem set iterator
2ff057
 * @return		next problem (weak ref), NULL on termination
2ff057
 */
2ff057
rpmProblem rpmpsiNext(rpmpsi psi);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Return next problem set iterator index
2ff057
 * @param psi		problem set iterator
2ff057
 * @return		iterator index, -1 on termination
2ff057
 */
2ff057
int rpmpsNextIterator(rpmpsi psi);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Return current problem from problem set
2ff057
 * @param psi		problem set iterator
2ff057
 * @return		current rpmProblem 
2ff057
 */
2ff057
rpmProblem rpmpsGetProblem(rpmpsi psi);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Create a problem set.
2ff057
 * @return		new problem set
2ff057
 */
2ff057
rpmps rpmpsCreate(void);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Destroy a problem set.
2ff057
 * @param ps		problem set
2ff057
 * @return		NULL always
2ff057
 */
2ff057
rpmps rpmpsFree(rpmps ps);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Print problems to file handle.
2ff057
 * @param fp		file handle (NULL uses stderr)
2ff057
 * @param ps		problem set
2ff057
 */
2ff057
void rpmpsPrint(FILE *fp, rpmps ps);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Append a problem to current set of problems.
2ff057
 * @param ps		problem set
2ff057
 * @param prob		rpmProblem 
2ff057
 */
2ff057
void rpmpsAppendProblem(rpmps ps, rpmProblem prob);
2ff057
2ff057
/** \ingroup rpmps
2ff057
 * Merge problem set into another.
2ff057
 * @param dest		destination problem set
2ff057
 * @param src		source problem set
2ff057
 * @return		number of problems merged
2ff057
 */
2ff057
int rpmpsMerge(rpmps dest, rpmps src);
2ff057
2ff057
#ifdef __cplusplus
2ff057
}
2ff057
#endif
2ff057
2ff057
#endif	/* H_RPMPS */