rpmdb/header.h

Go to the documentation of this file.

#ifndef H_HEADER
#define H_HEADER

/* RPM - Copyright (C) 1995-2001 Red Hat Software */

#include <stdio.h>
#include "rpmio.h"

#ifdef __cplusplus
extern "C" {
#endif

#if 0   /* XXX hpux needs -Ae in CFLAGS to grok this */
typedef long long int int_64;
#endif
typedef int int_32;
typedef short int int_16;
typedef char int_8;

#if 0   /* XXX hpux needs -Ae in CFLAGS to grok this */
typedef unsigned long long int uint_64;
#endif
typedef unsigned int uint_32;
typedef unsigned short uint_16;
typedef unsigned char uint_8;

/*@-redef@*/    /* LCL: no clue */
typedef const char *    errmsg_t;

typedef int_32 *        hTAG_t;
typedef int_32 *        hTYP_t;
typedef const void *    hPTR_t;
typedef int_32 *        hCNT_t;

typedef /*@abstract@*/ /*@refcounted@*/ struct headerToken_s * Header;

typedef /*@abstract@*/ struct headerIterator_s * HeaderIterator;

typedef /*@abstract@*/ struct headerTagTableEntry_s * headerTagTableEntry;
struct headerTagTableEntry_s {
/*@observer@*/ /*@null@*/
    const char * name;          
    int val;                    
    int type;                   
};

enum headerSprintfExtensionType {
    HEADER_EXT_LAST = 0,        
    HEADER_EXT_FORMAT,          
    HEADER_EXT_MORE,            
    HEADER_EXT_TAG              
};

typedef /*only@*/ char * (*headerTagFormatFunction)(int_32 type,
                                const void * data, char * formatPrefix,
                                int padding, int element)
        /*@requires maxSet(data) >= 0 @*/;

typedef int (*headerTagTagFunction) (Header h,
                /*@null@*/ /*@out@*/ hTYP_t type,
                /*@null@*/ /*@out@*/ hPTR_t * data,
                /*@null@*/ /*@out@*/ hCNT_t count,
                /*@null@*/ /*@out@*/ int * freeData)
        /*@requires maxSet(type) >= 0 /\ maxSet(data) >= 0
                /\ maxSet(count) >= 0 /\ maxSet(freeData) >= 0 @*/;

typedef /*@abstract@*/ struct headerSprintfExtension_s * headerSprintfExtension;
struct headerSprintfExtension_s {
    enum headerSprintfExtensionType type;       
/*@observer@*/ /*@null@*/
    const char * name;                          
    union {
/*@observer@*/ /*@null@*/
        void * generic;                         
        headerTagFormatFunction formatFunction; 
        headerTagTagFunction tagFunction;       
        struct headerSprintfExtension_s * more; 
    } u;
};

/*@-redecl@*/
/*@observer@*/
extern const struct headerSprintfExtension_s headerDefaultFormats[];
/*@=redecl@*/

enum hMagic {
    HEADER_MAGIC_NO             = 0,
    HEADER_MAGIC_YES            = 1
};

typedef enum rpmTagType_e {
#define RPM_MIN_TYPE            0
    RPM_NULL_TYPE               =  0,
    RPM_CHAR_TYPE               =  1,
    RPM_INT8_TYPE               =  2,
    RPM_INT16_TYPE              =  3,
    RPM_INT32_TYPE              =  4,
/*    RPM_INT64_TYPE    = 5,   ---- These aren't supported (yet) */
    RPM_STRING_TYPE             =  6,
    RPM_BIN_TYPE                =  7,
    RPM_STRING_ARRAY_TYPE       =  8,
    RPM_I18NSTRING_TYPE         =  9
#define RPM_MAX_TYPE            9
} rpmTagType;

/*@-enummemuse -typeuse @*/
typedef enum rpmSubTagType_e {
    RPM_REGION_TYPE             = -10,
    RPM_BIN_ARRAY_TYPE          = -11,
    RPM_XREF_TYPE               = -12
} rpmSubTagType;
/*@=enummemuse =typeuse @*/

#define HEADER_IMAGE            61
#define HEADER_SIGNATURES       62
#define HEADER_IMMUTABLE        63
#define HEADER_REGIONS          64
#define HEADER_I18NTABLE        100
#define HEADER_SIGBASE          256
#define HEADER_TAGBASE          1000

/*@-typeuse -fielduse@*/
typedef union hRET_s {
    const void * ptr;
    const char ** argv;
    const char * str;
    uint_32 * ui32p;
    uint_16 * ui16p;
    int_32 * i32p;
    int_16 * i16p;
    int_8 * i8p;
} * hRET_t;
/*@=typeuse =fielduse@*/

/*@-typeuse -fielduse@*/
typedef struct HE_s {
    int_32 tag;
/*@null@*/
    hTYP_t typ;
    union {
/*@null@*/
        hPTR_t * ptr;
/*@null@*/
        hRET_t * ret;
    } u;
/*@null@*/
    hCNT_t cnt;
} * HE_t;
/*@=typeuse =fielduse@*/

typedef
Header (*HDRnew) (void)
        /*@*/;

typedef
/*@null@*/ Header (*HDRfree) (/*@killref@*/ /*@null@*/ Header h)
        /*@modifies h @*/;

typedef
Header (*HDRlink) (Header h)
        /*@modifies h @*/;

typedef
Header (*HDRunlink) (/*@killref@*/ /*@null@*/ Header h)
        /*@modifies h @*/;

typedef
void (*HDRsort) (Header h)
        /*@modifies h @*/;

typedef
void (*HDRunsort) (Header h)
        /*@modifies h @*/;

typedef
unsigned int (*HDRsizeof) (/*@null@*/ Header h, enum hMagic magicp)
        /*@modifies h @*/;

typedef
/*@only@*/ /*@null@*/ void * (*HDRunload) (Header h)
        /*@modifies h @*/;

typedef
/*@null@*/ Header (*HDRreload) (/*@only@*/ Header h, int tag)
        /*@modifies h @*/;

typedef
Header (*HDRcopy) (Header h)
        /*@modifies h @*/;

typedef
/*@null@*/ Header (*HDRload) (/*@kept@*/ void * uh)
        /*@modifies uh @*/;

typedef
/*@null@*/ Header (*HDRcopyload) (const void * uh)
        /*@*/;

typedef
/*@null@*/ Header (*HDRread) (FD_t fd, enum hMagic magicp)
        /*@modifies fd @*/;

typedef
int (*HDRwrite) (FD_t fd, /*@null@*/ Header h, enum hMagic magicp)
        /*@globals fileSystem @*/
        /*@modifies fd, h, fileSystem @*/;

typedef
int (*HDRisentry) (/*@null@*/Header h, int_32 tag)
        /*@*/;  

typedef
/*@null@*/ void * (*HDRfreetag) (Header h,
                /*@only@*/ /*@null@*/ const void * data, rpmTagType type)
        /*@modifies data @*/;

typedef
int (*HDRget) (Header h, int_32 tag,
                        /*@null@*/ /*@out@*/ hTYP_t type,
                        /*@null@*/ /*@out@*/ void ** p,
                        /*@null@*/ /*@out@*/ hCNT_t c)
        /*@modifies *type, *p, *c @*/;

typedef
int (*HDRgetmin) (Header h, int_32 tag,
                        /*@null@*/ /*@out@*/ hTYP_t type,
                        /*@null@*/ /*@out@*/ hPTR_t * p,
                        /*@null@*/ /*@out@*/ hCNT_t c)
        /*@modifies *type, *p, *c @*/;

typedef
int (*HDRadd) (Header h, int_32 tag, int_32 type, const void * p, int_32 c)
        /*@modifies h @*/;

typedef
int (*HDRappend) (Header h, int_32 tag, int_32 type, const void * p, int_32 c)
        /*@modifies h @*/;

typedef
int (*HDRaddorappend) (Header h, int_32 tag, int_32 type, const void * p, int_32 c)
        /*@modifies h @*/;

typedef
int (*HDRaddi18n) (Header h, int_32 tag, const char * string,
                const char * lang)
        /*@modifies h @*/;

typedef
int (*HDRmodify) (Header h, int_32 tag, int_32 type, const void * p, int_32 c)
        /*@modifies h @*/;

typedef
int (*HDRremove) (Header h, int_32 tag)
        /*@modifies h @*/;

typedef
/*@only@*/ char * (*HDRsprintf) (Header h, const char * fmt,
                     const struct headerTagTableEntry_s * tags,
                     const struct headerSprintfExtension_s * extensions,
                     /*@null@*/ /*@out@*/ errmsg_t * errmsg)
        /*@modifies *errmsg @*/;

typedef
void (*HDRcopytags) (Header headerFrom, Header headerTo, hTAG_t tagstocopy)
        /*@modifies headerFrom, headerTo @*/;

typedef
HeaderIterator (*HDRfreeiter) (/*@only@*/ HeaderIterator hi)
        /*@modifies hi @*/;

typedef
HeaderIterator (*HDRinititer) (Header h)
        /*@modifies h */;

typedef
int (*HDRnextiter) (HeaderIterator hi,
                /*@null@*/ /*@out@*/ hTAG_t tag,
                /*@null@*/ /*@out@*/ hTYP_t type,
                /*@null@*/ /*@out@*/ hPTR_t * p,
                /*@null@*/ /*@out@*/ hCNT_t c)
        /*@modifies hi, *tag, *type, *p, *c @*/;

typedef /*@abstract@*/ struct HV_s * HV_t;
struct HV_s {
    HDRlink     hdrlink;
    HDRunlink   hdrunlink;
    HDRfree     hdrfree;
    HDRnew      hdrnew;
    HDRsort     hdrsort;
    HDRunsort   hdrunsort;
    HDRsizeof   hdrsizeof;
    HDRunload   hdrunload;
    HDRreload   hdrreload;
    HDRcopy     hdrcopy;
    HDRload     hdrload;
    HDRcopyload hdrcopyload;
    HDRread     hdrread;
    HDRwrite    hdrwrite;
    HDRisentry  hdrisentry;
    HDRfreetag  hdrfreetag;
    HDRget      hdrget;
    HDRgetmin   hdrgetmin;
    HDRadd      hdradd;
    HDRappend   hdrappend;
    HDRaddorappend hdraddorappend;
    HDRaddi18n  hdraddi18n;
    HDRmodify   hdrmodify;
    HDRremove   hdrremove;
    HDRsprintf  hdrsprintf;
    HDRcopytags hdrcopytags;
    HDRfreeiter hdrfreeiter;
    HDRinititer hdrinititer;
    HDRnextiter hdrnextiter;
/*@null@*/
    void *      hdrvecs;
/*@null@*/
    void *      hdrdata;
    int         hdrversion;
};

/*@unused@*/ static inline /*@null@*/
void * headerFreeData( /*@only@*/ /*@null@*/ const void * data, rpmTagType type)
        /*@modifies data @*/
{
    if (data) {
        /*@-branchstate@*/
        if (type == -1 ||
            type == RPM_STRING_ARRAY_TYPE ||
            type == RPM_I18NSTRING_TYPE ||
            type == RPM_BIN_TYPE)
                free((void *)data);
        /*@=branchstate@*/
    }
    return NULL;
}

#if !defined(__HEADER_PROTOTYPES__)
#include "hdrinline.h"
#endif

#ifdef __cplusplus
}
#endif

#endif  /* H_HEADER */

---