"Fossies" - the Fresh Open Source Software Archive

Member "rpm-4.15.1/doc/librpm/html/rpmtd_8h_source.html" (13 Nov 2019, 65283 Bytes) of package /linux/misc/rpm-4.15.1.tar.bz2:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the rpm-4.15.1.tar.bz2 project site itself.

rpm  4.15.0
rpmtd.h
Go to the documentation of this file.
1 #ifndef _RPMTD_H
2 #define _RPMTD_H
3 
10 #include <rpm/rpmtypes.h>
11 #include <rpm/argv.h>
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
19  RPMTD_ALLOCED = (1 << 0), /* was memory allocated? */
20  RPMTD_PTR_ALLOCED = (1 << 1), /* were array pointers allocated? */
21  RPMTD_IMMUTABLE = (1 << 2), /* header data or modifiable? */
22  RPMTD_ARGV = (1 << 3), /* string array is NULL-terminated? */
23  RPMTD_INVALID = (1 << 4), /* invalid data (in header) */
24 };
25 
27 
32 struct rpmtd_s {
33  rpm_tag_t tag; /* rpm tag of this data entry*/
34  rpm_tagtype_t type; /* data type */
35  rpm_count_t count; /* number of entries */
36  rpm_data_t data; /* pointer to actual data */
37  rpmtdFlags flags; /* flags on memory allocation etc */
38  int ix; /* iteration index */
39  rpm_count_t size; /* size of data (only works for RPMTD_IMMUTABLE atm) */
40 };
41 
46 rpmtd rpmtdNew(void);
47 
54 
60 void rpmtdReset(rpmtd td);
61 
67 void rpmtdFreeData(rpmtd td);
68 
75 
83 
90 
97 
104 
111 
117 int rpmtdGetIndex(rpmtd td);
118 
127 int rpmtdSetIndex(rpmtd td, int index);
128 
134 int rpmtdInit(rpmtd td);
135 
141 int rpmtdNext(rpmtd td);
142 
148 uint32_t *rpmtdNextUint32(rpmtd td);
149 
155 uint64_t *rpmtdNextUint64(rpmtd td);
156 
162 const char *rpmtdNextString(rpmtd td);
163 
172 char *rpmtdGetChar(rpmtd td);
173 
182 uint16_t * rpmtdGetUint16(rpmtd td);
183 
192 uint32_t * rpmtdGetUint32(rpmtd td);
193 
202 uint64_t * rpmtdGetUint64(rpmtd td);
203 
212 const char * rpmtdGetString(rpmtd td);
213 
223 uint64_t rpmtdGetNumber(rpmtd td);
224 
225 typedef enum rpmtdFormats_e {
226  RPMTD_FORMAT_STRING = 0, /* plain string (any type) */
227  RPMTD_FORMAT_ARMOR = 1, /* ascii armor format (bin types) */
228  RPMTD_FORMAT_BASE64 = 2, /* base64 encoding (bin types) */
229  RPMTD_FORMAT_PGPSIG = 3, /* pgp/gpg signature (bin types) */
230  RPMTD_FORMAT_DEPFLAGS = 4, /* dependency flags (int types) */
231  RPMTD_FORMAT_FFLAGS = 5, /* file flags (int types) */
232  RPMTD_FORMAT_PERMS = 6, /* permission string (int types) */
233  RPMTD_FORMAT_TRIGGERTYPE = 7, /* trigger types (int types) */
234  RPMTD_FORMAT_XML = 8, /* xml format (any type) */
235  RPMTD_FORMAT_OCTAL = 9, /* octal format (int types) */
236  RPMTD_FORMAT_HEX = 10, /* hex format (int types) */
237  RPMTD_FORMAT_DATE = 11, /* date format (int types) */
238  RPMTD_FORMAT_DAY = 12, /* day format (int types) */
239  RPMTD_FORMAT_SHESCAPE = 13, /* shell escaped (any type) */
240  RPMTD_FORMAT_ARRAYSIZE = 14, /* size of contained array (any type) */
241  RPMTD_FORMAT_DEPTYPE = 15, /* dependency types (int types) */
242  RPMTD_FORMAT_FSTATE = 16, /* file states (int types) */
243  RPMTD_FORMAT_VFLAGS = 17, /* file verify flags (int types) */
244  RPMTD_FORMAT_EXPAND = 18, /* macro expansion (string types) */
245  RPMTD_FORMAT_FSTATUS = 19, /* file verify status (int types) */
246  RPMTD_FORMAT_HUMANSI = 20, /* human readable value, K = 1000 (int types) */
247  RPMTD_FORMAT_HUMANIEC = 21, /* human readable value, K = 1024 (int types) */
248 } rpmtdFormats;
249 
261 char *rpmtdFormat(rpmtd td, rpmtdFormats fmt, const char *errmsg);
262 
271 int rpmtdSetTag(rpmtd td, rpmTagVal tag);
272 
284 int rpmtdFromUint8(rpmtd td, rpmTagVal tag, uint8_t *data, rpm_count_t count);
285 
296 int rpmtdFromUint16(rpmtd td, rpmTagVal tag, uint16_t *data, rpm_count_t count);
297 
308 int rpmtdFromUint32(rpmtd td, rpmTagVal tag, uint32_t *data, rpm_count_t count);
309 
320 int rpmtdFromUint64(rpmtd td, rpmTagVal tag, uint64_t *data, rpm_count_t count);
321 
330 int rpmtdFromString(rpmtd td, rpmTagVal tag, const char *data);
331 
342 int rpmtdFromStringArray(rpmtd td, rpmTagVal tag, const char **data, rpm_count_t count);
343 
353 int rpmtdFromArgv(rpmtd td, rpmTagVal tag, ARGV_t argv);
354 
364 int rpmtdFromArgi(rpmtd td, rpmTagVal tag, ARGI_t argi);
365 
366 /* \ingroup rpmtd
367  * Perform deep copy of container.
368  * Create a modifiable copy of tag data container (on string arrays each
369  * string is separately allocated)
370  * @todo Only string arrays types are supported currently
371  * @param td Container to copy
372  * @return New container or NULL on error
373  */
374 rpmtd rpmtdDup(rpmtd td);
375 
376 /* \ingroup rpmtd
377  * Push string array container contents to a string pool, return string ids.
378  * @param td Tag data container
379  * @param pool String pool
380  * @return Array of string id's (malloced)
381  */
382 rpmsid * rpmtdToPool(rpmtd td, rpmstrPool pool);
383 
384 #ifdef __cplusplus
385 }
386 #endif
387 
388 #endif /* _RPMTD_H */
uint32_t * rpmtdNextUint32(rpmtd td)
Iterate over uint32_t type tag data container.
int rpmtdInit(rpmtd td)
Initialize tag container for iteration.
int rpmtdSetTag(rpmtd td, rpmTagVal tag)
Set container tag and type.
rpmtd rpmtdFree(rpmtd td)
Destroy tag data container.
char ** ARGV_t
Definition: argv.h:17
const char * rpmtdNextString(rpmtd td)
Iterate over string / string array type tag data container.
rpmsid * rpmtdToPool(rpmtd td, rpmstrPool pool)
void * rpm_data_t
Definition: rpmtypes.h:33
rpm_count_t rpmtdSize(rpmtd td)
Retrieve container data size (eg required for allocation).
rpm_count_t count
Definition: rpmtd.h:35
rpm_count_t size
Definition: rpmtd.h:39
int32_t rpm_tag_t
Definition: rpmtypes.h:27
rpmFlags rpmtdFlags
Definition: rpmtd.h:26
enum rpmtdFormats_e rpmtdFormats
rpmTagType rpmtdType(rpmtd td)
Retrieve type of the container.
int rpmtdFromStringArray(rpmtd td, rpmTagVal tag, const char **data, rpm_count_t count)
Construct tag container from a string array.
rpm_tagtype_t type
Definition: rpmtd.h:34
uint64_t * rpmtdGetUint64(rpmtd td)
Return uint64_t data from tag container.
rpmtdFlags flags
Definition: rpmtd.h:37
int rpmtdFromUint64(rpmtd td, rpmTagVal tag, uint64_t *data, rpm_count_t count)
Construct tag container from uint64_t pointer.
char * rpmtdGetChar(rpmtd td)
Return char data from tag container.
rpm_count_t rpmtdCount(rpmtd td)
Retrieve array size of the container.
uint32_t rpmFlags
Definition: rpmtypes.h:42
struct rpmstrPool_s * rpmstrPool
Definition: rpmtypes.h:83
uint32_t rpmsid
Definition: rpmtypes.h:82
void rpmtdReset(rpmtd td)
(Re-)initialize tag data container.
int ix
Definition: rpmtd.h:38
rpmtdFormats_e
Definition: rpmtd.h:225
int rpmtdFromUint16(rpmtd td, rpmTagVal tag, uint16_t *data, rpm_count_t count)
Construct tag container from uint16_t pointer.
int rpmtdFromUint8(rpmtd td, rpmTagVal tag, uint8_t *data, rpm_count_t count)
Construct tag container from uint8_t pointer.
rpmTagVal rpmtdTag(rpmtd td)
Retrieve tag of the container.
enum rpmTagType_e rpmTagType
The basic types of data in tags from headers.
rpm_data_t data
Definition: rpmtd.h:36
rpm_tag_t tag
Definition: rpmtd.h:33
uint32_t rpm_count_t
Definition: rpmtypes.h:29
uint16_t * rpmtdGetUint16(rpmtd td)
Return uint16_t data from tag container.
rpmtd rpmtdNew(void)
Create new tag data container.
void rpmtdFreeData(rpmtd td)
Free contained data.
rpm_tag_t rpmTagVal
Definition: rpmtypes.h:30
uint64_t rpmtdGetNumber(rpmtd td)
Return numeric value from tag container.
uint32_t * rpmtdGetUint32(rpmtd td)
Return uint32_t data from tag container.
rpmtd rpmtdDup(rpmtd td)
rpmtdFlags_e
Definition: rpmtd.h:17
Container for rpm tag data (from headers or extensions).
Definition: rpmtd.h:32
int rpmtdFromUint32(rpmtd td, rpmTagVal tag, uint32_t *data, rpm_count_t count)
Construct tag container from uint32_t pointer.
int rpmtdFromArgi(rpmtd td, rpmTagVal tag, ARGI_t argi)
Construct tag container from ARGI_t array.
int rpmtdNext(rpmtd td)
Iterate over tag data container.
int rpmtdSetIndex(rpmtd td, int index)
Set iteration index of the container.
enum rpmTagClass_e rpmTagClass
The classes of data in tags from headers.
uint32_t rpm_tagtype_t
Definition: rpmtypes.h:28
rpmtdFlags rpmtdGetFlags(rpmtd td)
Retrieve flags of the container (allocation details etc)
uint64_t * rpmtdNextUint64(rpmtd td)
Iterate over uint64_t type tag data container.
char * rpmtdFormat(rpmtd td, rpmtdFormats fmt, const char *errmsg)
Format data from tag container to string presentation of given format.
int rpmtdFromArgv(rpmtd td, rpmTagVal tag, ARGV_t argv)
Construct tag container from ARGV_t array.
Definition: argv.h:21
int rpmtdGetIndex(rpmtd td)
Retrieve current iteration index of the container.
int rpmtdFromString(rpmtd td, rpmTagVal tag, const char *data)
Construct tag container from a string.
const char * rpmtdGetString(rpmtd td)
Return string data from tag container.
rpmTagClass rpmtdClass(rpmtd td)
Retrieve class of the container.