rpm  4.13.0
rpmtd.h
Go to the documentation of this file.
1 #ifndef _RPMTD_H
2 #define _RPMTD_H
3 
4 #include <rpm/rpmtypes.h>
5 #include <rpm/argv.h>
6 
7 #ifdef __cplusplus
8 extern "C" {
9 #endif
10 
13  RPMTD_ALLOCED = (1 << 0), /* was memory allocated? */
14  RPMTD_PTR_ALLOCED = (1 << 1), /* were array pointers allocated? */
15  RPMTD_IMMUTABLE = (1 << 2), /* header data or modifiable? */
16  RPMTD_ARGV = (1 << 3), /* string array is NULL-terminated? */
17  RPMTD_INVALID = (1 << 4), /* invalid data (in header) */
18 };
19 
21 
26 struct rpmtd_s {
27  rpm_tag_t tag; /* rpm tag of this data entry*/
28  rpm_tagtype_t type; /* data type */
29  rpm_count_t count; /* number of entries */
30  rpm_data_t data; /* pointer to actual data */
31  rpmtdFlags flags; /* flags on memory allocation etc */
32  int ix; /* iteration index */
33  rpm_count_t size; /* size of data (only works for RPMTD_IMMUTABLE atm) */
34 };
35 
40 rpmtd rpmtdNew(void);
41 
48 
54 void rpmtdReset(rpmtd td);
55 
61 void rpmtdFreeData(rpmtd td);
62 
69 
77 
84 
91 
98 
105 
111 int rpmtdGetIndex(rpmtd td);
112 
121 int rpmtdSetIndex(rpmtd td, int index);
122 
128 int rpmtdInit(rpmtd td);
129 
135 int rpmtdNext(rpmtd td);
136 
142 uint32_t *rpmtdNextUint32(rpmtd td);
143 
149 uint64_t *rpmtdNextUint64(rpmtd td);
150 
156 const char *rpmtdNextString(rpmtd td);
157 
166 char *rpmtdGetChar(rpmtd td);
167 
176 uint16_t * rpmtdGetUint16(rpmtd td);
177 
186 uint32_t * rpmtdGetUint32(rpmtd td);
187 
196 uint64_t * rpmtdGetUint64(rpmtd td);
197 
206 const char * rpmtdGetString(rpmtd td);
207 
217 uint64_t rpmtdGetNumber(rpmtd td);
218 
219 typedef enum rpmtdFormats_e {
220  RPMTD_FORMAT_STRING = 0, /* plain string (any type) */
221  RPMTD_FORMAT_ARMOR = 1, /* ascii armor format (bin types) */
222  RPMTD_FORMAT_BASE64 = 2, /* base64 encoding (bin types) */
223  RPMTD_FORMAT_PGPSIG = 3, /* pgp/gpg signature (bin types) */
224  RPMTD_FORMAT_DEPFLAGS = 4, /* dependency flags (int types) */
225  RPMTD_FORMAT_FFLAGS = 5, /* file flags (int types) */
226  RPMTD_FORMAT_PERMS = 6, /* permission string (int types) */
227  RPMTD_FORMAT_TRIGGERTYPE = 7, /* trigger types (int types) */
228  RPMTD_FORMAT_XML = 8, /* xml format (any type) */
229  RPMTD_FORMAT_OCTAL = 9, /* octal format (int types) */
230  RPMTD_FORMAT_HEX = 10, /* hex format (int types) */
231  RPMTD_FORMAT_DATE = 11, /* date format (int types) */
232  RPMTD_FORMAT_DAY = 12, /* day format (int types) */
233  RPMTD_FORMAT_SHESCAPE = 13, /* shell escaped (any type) */
234  RPMTD_FORMAT_ARRAYSIZE = 14, /* size of contained array (any type) */
235  RPMTD_FORMAT_DEPTYPE = 15, /* dependency types (int types) */
236  RPMTD_FORMAT_FSTATE = 16, /* file states (int types) */
237  RPMTD_FORMAT_VFLAGS = 17, /* file verify flags (int types) */
238  RPMTD_FORMAT_EXPAND = 18, /* macro expansion (string types) */
239  RPMTD_FORMAT_FSTATUS = 19, /* file verify status (int types) */
240 } rpmtdFormats;
241 
253 char *rpmtdFormat(rpmtd td, rpmtdFormats fmt, const char *errmsg);
254 
263 int rpmtdSetTag(rpmtd td, rpmTagVal tag);
264 
276 int rpmtdFromUint8(rpmtd td, rpmTagVal tag, uint8_t *data, rpm_count_t count);
277 
288 int rpmtdFromUint16(rpmtd td, rpmTagVal tag, uint16_t *data, rpm_count_t count);
289 
300 int rpmtdFromUint32(rpmtd td, rpmTagVal tag, uint32_t *data, rpm_count_t count);
301 
312 int rpmtdFromUint64(rpmtd td, rpmTagVal tag, uint64_t *data, rpm_count_t count);
313 
322 int rpmtdFromString(rpmtd td, rpmTagVal tag, const char *data);
323 
334 int rpmtdFromStringArray(rpmtd td, rpmTagVal tag, const char **data, rpm_count_t count);
335 
345 int rpmtdFromArgv(rpmtd td, rpmTagVal tag, ARGV_t argv);
346 
356 int rpmtdFromArgi(rpmtd td, rpmTagVal tag, ARGI_t argi);
357 
358 /* \ingroup rpmtd
359  * Perform deep copy of container.
360  * Create a modifiable copy of tag data container (on string arrays each
361  * string is separately allocated)
362  * @todo Only string arrays types are supported currently
363  * @param td Container to copy
364  * @return New container or NULL on error
365  */
366 rpmtd rpmtdDup(rpmtd td);
367 
368 /* \ingroup rpmtd
369  * Push string array container contents to a string pool, return string ids.
370  * @param td Tag data container
371  * @param pool String pool
372  * @return Array of string id's (malloced)
373  */
374 rpmsid * rpmtdToPool(rpmtd td, rpmstrPool pool);
375 
376 #ifdef __cplusplus
377 }
378 #endif
379 
380 #endif /* _RPMTD_H */
rpmtd_s::tag
rpm_tag_t tag
Definition: rpmtd.h:27
rpmFlags
uint32_t rpmFlags
Definition: rpmtypes.h:42
rpm_count_t
uint32_t rpm_count_t
Definition: rpmtypes.h:29
rpmtdReset
void rpmtdReset(rpmtd td)
RPMTD_FORMAT_FFLAGS
@ RPMTD_FORMAT_FFLAGS
Definition: rpmtd.h:225
rpm_tagtype_t
uint32_t rpm_tagtype_t
Definition: rpmtypes.h:28
rpmtdGetString
const char * rpmtdGetString(rpmtd td)
rpmtdNextString
const char * rpmtdNextString(rpmtd td)
rpmtdFlags
rpmFlags rpmtdFlags
Definition: rpmtd.h:20
RPMTD_FORMAT_PERMS
@ RPMTD_FORMAT_PERMS
Definition: rpmtd.h:226
rpmtdFromUint8
int rpmtdFromUint8(rpmtd td, rpmTagVal tag, uint8_t *data, rpm_count_t count)
rpmtdFreeData
void rpmtdFreeData(rpmtd td)
RPMTD_IMMUTABLE
@ RPMTD_IMMUTABLE
Definition: rpmtd.h:15
RPMTD_FORMAT_FSTATUS
@ RPMTD_FORMAT_FSTATUS
Definition: rpmtd.h:239
rpmtdFormat
char * rpmtdFormat(rpmtd td, rpmtdFormats fmt, const char *errmsg)
RPMTD_FORMAT_ARRAYSIZE
@ RPMTD_FORMAT_ARRAYSIZE
Definition: rpmtd.h:234
rpmtdNew
rpmtd rpmtdNew(void)
rpmtdGetChar
char * rpmtdGetChar(rpmtd td)
rpmstrPool
struct rpmstrPool_s * rpmstrPool
Definition: rpmtypes.h:83
RPMTD_FORMAT_DAY
@ RPMTD_FORMAT_DAY
Definition: rpmtd.h:232
rpmtdGetUint64
uint64_t * rpmtdGetUint64(rpmtd td)
rpmtdFromUint32
int rpmtdFromUint32(rpmtd td, rpmTagVal tag, uint32_t *data, rpm_count_t count)
RPMTD_ARGV
@ RPMTD_ARGV
Definition: rpmtd.h:16
rpmtd_s::flags
rpmtdFlags flags
Definition: rpmtd.h:31
rpmtdGetIndex
int rpmtdGetIndex(rpmtd td)
rpmtdFromStringArray
int rpmtdFromStringArray(rpmtd td, rpmTagVal tag, const char **data, rpm_count_t count)
RPMTD_FORMAT_SHESCAPE
@ RPMTD_FORMAT_SHESCAPE
Definition: rpmtd.h:233
ARGI_s
Definition: argv.h:19
RPMTD_FORMAT_TRIGGERTYPE
@ RPMTD_FORMAT_TRIGGERTYPE
Definition: rpmtd.h:227
RPMTD_FORMAT_BASE64
@ RPMTD_FORMAT_BASE64
Definition: rpmtd.h:222
rpmtdFromUint16
int rpmtdFromUint16(rpmtd td, rpmTagVal tag, uint16_t *data, rpm_count_t count)
rpmtdCount
rpm_count_t rpmtdCount(rpmtd td)
rpmtdSetIndex
int rpmtdSetIndex(rpmtd td, int index)
RPMTD_FORMAT_VFLAGS
@ RPMTD_FORMAT_VFLAGS
Definition: rpmtd.h:237
RPMTD_FORMAT_HEX
@ RPMTD_FORMAT_HEX
Definition: rpmtd.h:230
RPMTD_FORMAT_OCTAL
@ RPMTD_FORMAT_OCTAL
Definition: rpmtd.h:229
rpmtdType
rpmTagType rpmtdType(rpmtd td)
rpmtdGetUint16
uint16_t * rpmtdGetUint16(rpmtd td)
rpmsid
uint32_t rpmsid
Definition: rpmtypes.h:82
rpmtdNextUint64
uint64_t * rpmtdNextUint64(rpmtd td)
rpmtdClass
rpmTagClass rpmtdClass(rpmtd td)
rpmtdInit
int rpmtdInit(rpmtd td)
RPMTD_FORMAT_DEPFLAGS
@ RPMTD_FORMAT_DEPFLAGS
Definition: rpmtd.h:224
rpmtd_s::ix
int ix
Definition: rpmtd.h:32
ARGV_t
char ** ARGV_t
Definition: argv.h:15
rpmTagType
enum rpmTagType_e rpmTagType
RPMTD_PTR_ALLOCED
@ RPMTD_PTR_ALLOCED
Definition: rpmtd.h:14
rpmtdSize
rpm_count_t rpmtdSize(rpmtd td)
rpmtdNext
int rpmtdNext(rpmtd td)
rpmtdTag
rpmTagVal rpmtdTag(rpmtd td)
rpmtdFree
rpmtd rpmtdFree(rpmtd td)
rpmtdSetTag
int rpmtdSetTag(rpmtd td, rpmTagVal tag)
RPMTD_FORMAT_ARMOR
@ RPMTD_FORMAT_ARMOR
Definition: rpmtd.h:221
RPMTD_FORMAT_DATE
@ RPMTD_FORMAT_DATE
Definition: rpmtd.h:231
rpmtdGetNumber
uint64_t rpmtdGetNumber(rpmtd td)
rpmtd_s::size
rpm_count_t size
Definition: rpmtd.h:33
rpm_tag_t
int32_t rpm_tag_t
Definition: rpmtypes.h:27
rpmtdFormats
enum rpmtdFormats_e rpmtdFormats
rpm_data_t
void * rpm_data_t
Definition: rpmtypes.h:33
rpmtdGetFlags
rpmtdFlags rpmtdGetFlags(rpmtd td)
rpmtd_s::type
rpm_tagtype_t type
Definition: rpmtd.h:28
rpmtd_s
Definition: rpmtd.h:26
RPMTD_FORMAT_FSTATE
@ RPMTD_FORMAT_FSTATE
Definition: rpmtd.h:236
rpmtdGetUint32
uint32_t * rpmtdGetUint32(rpmtd td)
rpmtdFromUint64
int rpmtdFromUint64(rpmtd td, rpmTagVal tag, uint64_t *data, rpm_count_t count)
rpmtdNextUint32
uint32_t * rpmtdNextUint32(rpmtd td)
rpmTagVal
rpm_tag_t rpmTagVal
Definition: rpmtypes.h:30
rpmtdDup
rpmtd rpmtdDup(rpmtd td)
rpmtdToPool
rpmsid * rpmtdToPool(rpmtd td, rpmstrPool pool)
rpmtdFlags_e
rpmtdFlags_e
Definition: rpmtd.h:11
rpmtd_s::data
rpm_data_t data
Definition: rpmtd.h:30
RPMTD_NONE
@ RPMTD_NONE
Definition: rpmtd.h:12
rpmtdFormats_e
rpmtdFormats_e
Definition: rpmtd.h:219
rpmtdFromArgi
int rpmtdFromArgi(rpmtd td, rpmTagVal tag, ARGI_t argi)
rpmtdFromString
int rpmtdFromString(rpmtd td, rpmTagVal tag, const char *data)
RPMTD_ALLOCED
@ RPMTD_ALLOCED
Definition: rpmtd.h:13
RPMTD_FORMAT_STRING
@ RPMTD_FORMAT_STRING
Definition: rpmtd.h:220
RPMTD_FORMAT_EXPAND
@ RPMTD_FORMAT_EXPAND
Definition: rpmtd.h:238
RPMTD_FORMAT_DEPTYPE
@ RPMTD_FORMAT_DEPTYPE
Definition: rpmtd.h:235
rpmtdFromArgv
int rpmtdFromArgv(rpmtd td, rpmTagVal tag, ARGV_t argv)
RPMTD_FORMAT_XML
@ RPMTD_FORMAT_XML
Definition: rpmtd.h:228
RPMTD_INVALID
@ RPMTD_INVALID
Definition: rpmtd.h:17
rpmtd_s::count
rpm_count_t count
Definition: rpmtd.h:29
rpmTagClass
enum rpmTagClass_e rpmTagClass
RPMTD_FORMAT_PGPSIG
@ RPMTD_FORMAT_PGPSIG
Definition: rpmtd.h:223