rpm  4.8.1
Macros | Typedefs | Enumerations | Functions | Variables
rpmgi.h File Reference
#include <rpm/rpmtypes.h>
#include <rpm/argv.h>
Include dependency graph for rpmgi.h:

Go to the source code of this file.

Macros

#define RPMGI_COMFOLLOW   0x0001 /* follow command line symlinks */
 rpmgi FTS-flags More...
 
#define RPMGI_LOGICAL   0x0002 /* logical walk */
 
#define RPMGI_NOCHDIR   0x0004 /* don't change directories */
 
#define RPMGI_NOSTAT   0x0008 /* don't get stat info */
 
#define RPMGI_PHYSICAL   0x0010 /* physical walk */
 
#define RPMGI_SEEDOT   0x0020 /* return dot and dot-dot */
 
#define RPMGI_XDEV   0x0040 /* don't cross devices */
 
#define RPMGI_WHITEOUT   0x0080 /* return whiteout information */
 

Typedefs

typedef enum rpmgiFlags_e rpmgiFlags
 

Enumerations

enum  rpmgiFlags_e {
  RPMGI_NONE = 0, RPMGI_TSADD = (1 << 0), RPMGI_TSORDER = (1 << 1), RPMGI_NOGLOB = (1 << 2),
  RPMGI_NOMANIFEST = (1 << 3), RPMGI_NOHEADER = (1 << 4)
}
 

Functions

rpmgi rpmgiUnlink (rpmgi gi, const char *msg)
 Unreference a generalized iterator instance. More...
 
rpmgi rpmgiLink (rpmgi gi, const char *msg)
 Reference a generalized iterator instance. More...
 
rpmgi rpmgiFree (rpmgi gi)
 Destroy a generalized iterator. More...
 
rpmgi rpmgiNew (rpmts ts, rpmTag tag, const void *keyp, size_t keylen)
 Return a generalized iterator. More...
 
rpmRC rpmgiNext (rpmgi gi)
 Perform next iteration step. More...
 
const char * rpmgiHdrPath (rpmgi gi)
 Return current header path. More...
 
Header rpmgiHeader (rpmgi gi)
 Return current iteration header. More...
 
rpmts rpmgiTs (rpmgi gi)
 Return current iteration transaction set. More...
 
rpmRC rpmgiSetArgs (rpmgi gi, ARGV_const_t argv, int ftsOpts, rpmgiFlags flags)
 Load iterator args. More...
 
rpmgiFlags rpmgiGetFlags (rpmgi gi)
 Retrieve iterator flags. More...
 
int rpmgiNumErrors (rpmgi gi)
 Return number of errors (file not found etc) encountered during iteration. More...
 

Variables

int _rpmgi_debug
 
rpmgiFlags giFlags
 

Macro Definition Documentation

◆ RPMGI_COMFOLLOW

#define RPMGI_COMFOLLOW   0x0001 /* follow command line symlinks */

rpmgi FTS-flags

Definition at line 33 of file rpmgi.h.

◆ RPMGI_LOGICAL

#define RPMGI_LOGICAL   0x0002 /* logical walk */

Definition at line 34 of file rpmgi.h.

◆ RPMGI_NOCHDIR

#define RPMGI_NOCHDIR   0x0004 /* don't change directories */

Definition at line 35 of file rpmgi.h.

◆ RPMGI_NOSTAT

#define RPMGI_NOSTAT   0x0008 /* don't get stat info */

Definition at line 36 of file rpmgi.h.

◆ RPMGI_PHYSICAL

#define RPMGI_PHYSICAL   0x0010 /* physical walk */

Definition at line 37 of file rpmgi.h.

◆ RPMGI_SEEDOT

#define RPMGI_SEEDOT   0x0020 /* return dot and dot-dot */

Definition at line 38 of file rpmgi.h.

◆ RPMGI_WHITEOUT

#define RPMGI_WHITEOUT   0x0080 /* return whiteout information */

Definition at line 40 of file rpmgi.h.

◆ RPMGI_XDEV

#define RPMGI_XDEV   0x0040 /* don't cross devices */

Definition at line 39 of file rpmgi.h.

Typedef Documentation

◆ rpmgiFlags

typedef enum rpmgiFlags_e rpmgiFlags

Enumeration Type Documentation

◆ rpmgiFlags_e

Enumerator
RPMGI_NONE 
RPMGI_TSADD 
RPMGI_TSORDER 
RPMGI_NOGLOB 
RPMGI_NOMANIFEST 
RPMGI_NOHEADER 

Definition at line 21 of file rpmgi.h.

Function Documentation

◆ rpmgiFree()

rpmgi rpmgiFree ( rpmgi  gi)

Destroy a generalized iterator.

Parameters
gigeneralized iterator
Returns
NULL always

◆ rpmgiGetFlags()

rpmgiFlags rpmgiGetFlags ( rpmgi  gi)

Retrieve iterator flags.

Parameters
gigeneralized iterator
Returns
iterator flags

◆ rpmgiHdrPath()

const char* rpmgiHdrPath ( rpmgi  gi)

Return current header path.

Parameters
gigeneralized iterator
Returns
header path

◆ rpmgiHeader()

Header rpmgiHeader ( rpmgi  gi)

Return current iteration header.

Parameters
gigeneralized iterator
Returns
header

◆ rpmgiLink()

rpmgi rpmgiLink ( rpmgi  gi,
const char *  msg 
)

Reference a generalized iterator instance.

Parameters
gigeneralized iterator
msg
Returns
new generalized iterator reference

◆ rpmgiNew()

rpmgi rpmgiNew ( rpmts  ts,
rpmTag  tag,
const void *  keyp,
size_t  keylen 
)

Return a generalized iterator.

Parameters
tstransaction set
tagrpm tag
keypkey data (NULL for sequential access)
keylenkey data length (0 will use strlen(keyp))
Returns
new iterator

◆ rpmgiNext()

rpmRC rpmgiNext ( rpmgi  gi)

Perform next iteration step.

Parameters
gigeneralized iterator
Returns
RPMRC_OK on success, RPMRC_NOTFOUND on EOI

◆ rpmgiNumErrors()

int rpmgiNumErrors ( rpmgi  gi)

Return number of errors (file not found etc) encountered during iteration.

Parameters
gigeneralized iterator
Returns
number of errors

◆ rpmgiSetArgs()

rpmRC rpmgiSetArgs ( rpmgi  gi,
ARGV_const_t  argv,
int  ftsOpts,
rpmgiFlags  flags 
)

Load iterator args.

Parameters
gigeneralized iterator
argvarg list
ftsOptsfts(3) flags
flagsiterator flags
Returns
RPMRC_OK on success

◆ rpmgiTs()

rpmts rpmgiTs ( rpmgi  gi)

Return current iteration transaction set.

Parameters
gigeneralized iterator
Returns
transaction set

◆ rpmgiUnlink()

rpmgi rpmgiUnlink ( rpmgi  gi,
const char *  msg 
)

Unreference a generalized iterator instance.

Parameters
gigeneralized iterator
msg
Returns
NULL always

Variable Documentation

◆ _rpmgi_debug

int _rpmgi_debug

◆ giFlags

rpmgiFlags giFlags