rpmtd.h

Go to the documentation of this file.

#ifndef _RPMTD_H
#define _RPMTD_H

 
#include <rpm/rpmtag.h>
#include <rpm/argv.h>
 
#ifdef __cplusplus
extern "C" {
#endif

enum rpmtdFlags_e {
    RPMTD_NONE      = 0,
    RPMTD_ALLOCED   = (1 << 0), /* was memory allocated? */
    RPMTD_PTR_ALLOCED   = (1 << 1), /* were array pointers allocated? */
    RPMTD_IMMUTABLE = (1 << 2), /* header data or modifiable? */
    RPMTD_ARGV      = (1 << 3), /* string array is NULL-terminated? */
    RPMTD_INVALID   = (1 << 4), /* invalid data (in header) */
};
 
typedef rpmFlags rpmtdFlags;

struct rpmtd_s {
    rpm_tag_t tag;  
    rpm_tagtype_t type; 
    rpm_count_t count;  
    rpm_data_t data;    
    rpmtdFlags flags;   
    int ix;     
    rpm_count_t size;   
};

RPM_PUBLIC_API
rpmtd rpmtdNew(void);

RPM_PUBLIC_API
rpmtd rpmtdFree(rpmtd td);
 
RPM_PUBLIC_API
void rpmtdReset(rpmtd td);

RPM_PUBLIC_API
void rpmtdFreeData(rpmtd td);

RPM_PUBLIC_API
rpm_count_t rpmtdCount(rpmtd td);

RPM_PUBLIC_API
rpm_count_t rpmtdSize(rpmtd td);

RPM_PUBLIC_API
rpmTagVal rpmtdTag(rpmtd td);

RPM_PUBLIC_API
rpmTagType rpmtdType(rpmtd td);

RPM_PUBLIC_API
rpmTagClass rpmtdClass(rpmtd td);

RPM_PUBLIC_API
rpmtdFlags rpmtdGetFlags(rpmtd td);

RPM_PUBLIC_API
int rpmtdGetIndex(rpmtd td);

RPM_PUBLIC_API
int rpmtdSetIndex(rpmtd td, int index);

RPM_PUBLIC_API
int rpmtdInit(rpmtd td);

RPM_PUBLIC_API
int rpmtdNext(rpmtd td);

RPM_PUBLIC_API
uint32_t *rpmtdNextUint32(rpmtd td);

RPM_PUBLIC_API
uint64_t *rpmtdNextUint64(rpmtd td);

RPM_PUBLIC_API
const char *rpmtdNextString(rpmtd td);

RPM_PUBLIC_API
char *rpmtdGetChar(rpmtd td);

RPM_PUBLIC_API
uint16_t * rpmtdGetUint16(rpmtd td);

RPM_PUBLIC_API
uint32_t * rpmtdGetUint32(rpmtd td);

RPM_PUBLIC_API
uint64_t * rpmtdGetUint64(rpmtd td);

RPM_PUBLIC_API
const char * rpmtdGetString(rpmtd td);

RPM_PUBLIC_API
uint64_t rpmtdGetNumber(rpmtd td);

typedef enum rpmtdFormats_e {
    RPMTD_FORMAT_STRING     = 0,    /* plain string (any type) */
    RPMTD_FORMAT_ARMOR      = 1,    /* ascii armor format (bin types) */
    RPMTD_FORMAT_BASE64     = 2,    /* base64 encoding (bin types) */
    RPMTD_FORMAT_PGPSIG     = 3,    /* pgp/gpg signature (bin types) */
    RPMTD_FORMAT_DEPFLAGS   = 4,    /* dependency flags (int types) */
    RPMTD_FORMAT_FFLAGS     = 5,    /* file flags (int types) */
    RPMTD_FORMAT_PERMS      = 6,    /* permission string (int types) */
    RPMTD_FORMAT_TRIGGERTYPE    = 7,    /* trigger types (int types) */
    RPMTD_FORMAT_XML        = 8,    /* xml format (any type) */
    RPMTD_FORMAT_OCTAL      = 9,    /* octal format (int types) */
    RPMTD_FORMAT_HEX        = 10,   /* hex format (int types) */
    RPMTD_FORMAT_DATE       = 11,   /* date format (int types) */
    RPMTD_FORMAT_DAY        = 12,   /* day format (int types) */
    RPMTD_FORMAT_SHESCAPE   = 13,   /* shell escaped (any type) */
    RPMTD_FORMAT_ARRAYSIZE  = 14,   /* size of contained array (any type) */
    RPMTD_FORMAT_DEPTYPE    = 15,   /* dependency types (int types) */
    RPMTD_FORMAT_FSTATE     = 16,   /* file states (int types) */
    RPMTD_FORMAT_VFLAGS     = 17,   /* file verify flags (int types) */
    RPMTD_FORMAT_EXPAND     = 18,   /* macro expansion (string types) */
    RPMTD_FORMAT_FSTATUS    = 19,   /* file verify status (int types) */
    RPMTD_FORMAT_HUMANSI    = 20,   /* human readable value, K = 1000 (int types) */
    RPMTD_FORMAT_HUMANIEC   = 21,   /* human readable value, K = 1024 (int types) */
    RPMTD_FORMAT_TAGNAME    = 22,   /* tag name (any type) */
    RPMTD_FORMAT_TAGNUM     = 23,   /* tag number (any type) */
    RPMTD_FORMAT_JSON       = 24,   /* json format (any type) */
    RPMTD_FORMAT_HASHALGO   = 25,   /* digest algorithm name (int types) */
} rpmtdFormats;

RPM_PUBLIC_API
char *rpmtdFormat(rpmtd td, rpmtdFormats fmt, const char *errmsg);

RPM_PUBLIC_API
int rpmtdSetTag(rpmtd td, rpmTagVal tag);

RPM_PUBLIC_API
int rpmtdFromUint8(rpmtd td, rpmTagVal tag, uint8_t *data, rpm_count_t count);

RPM_PUBLIC_API
int rpmtdFromUint16(rpmtd td, rpmTagVal tag, uint16_t *data, rpm_count_t count);

RPM_PUBLIC_API
int rpmtdFromUint32(rpmtd td, rpmTagVal tag, uint32_t *data, rpm_count_t count);

RPM_PUBLIC_API
int rpmtdFromUint64(rpmtd td, rpmTagVal tag, uint64_t *data, rpm_count_t count);

RPM_PUBLIC_API
int rpmtdFromString(rpmtd td, rpmTagVal tag, const char *data);

RPM_PUBLIC_API
int rpmtdFromStringArray(rpmtd td, rpmTagVal tag, const char **data, rpm_count_t count);

RPM_PUBLIC_API
int rpmtdFromArgv(rpmtd td, rpmTagVal tag, ARGV_t argv);

RPM_PUBLIC_API
int rpmtdFromArgi(rpmtd td, rpmTagVal tag, ARGI_t argi);

RPM_PUBLIC_API
rpmtd rpmtdDup(rpmtd td);

RPM_PUBLIC_API
rpmsid * rpmtdToPool(rpmtd td, rpmstrPool pool);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RPMTD_H */