Use rpmTagType always now that it's available everywhere
[platform/upstream/rpm.git] / lib / rpmtag.h
1 #ifndef _RPMTAG_H
2 #define _RPMTAG_H
3
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
7
8 /**
9  * Pseudo-tags used by the rpmdb and rpmgi iterator API's.
10  */
11 #define RPMDBI_PACKAGES         0       /* Installed package headers. */
12 #define RPMDBI_DEPENDS          1       /* Dependency resolution cache. */
13 #define RPMDBI_LABEL            2       /* Fingerprint search marker. */
14 #define RPMDBI_ADDED            3       /* Added package headers. */
15 #define RPMDBI_REMOVED          4       /* Removed package headers. */
16 #define RPMDBI_AVAILABLE        5       /* Available package headers. */
17 #define RPMDBI_HDLIST           6       /* (rpmgi) Header list. */
18 #define RPMDBI_ARGLIST          7       /* (rpmgi) Argument list. */
19 #define RPMDBI_FTSWALK          8       /* (rpmgi) File tree  walk. */
20
21 /**
22  * Header private tags.
23  * @note General use tags should start at 1000 (RPM's tag space starts there).
24  */
25 #define HEADER_IMAGE            61
26 #define HEADER_SIGNATURES       62
27 #define HEADER_IMMUTABLE        63
28 #define HEADER_REGIONS          64
29 #define HEADER_I18NTABLE        100
30 #define HEADER_SIGBASE          256
31 #define HEADER_TAGBASE          1000
32
33 /** \ingroup rpmtag
34  * Tags identify data in package headers.
35  * @note tags should not have value 0!
36  */
37 /** @todo: Somehow supply type **/
38 typedef enum rpmTag_e {
39
40     RPMTAG_HEADERIMAGE          = HEADER_IMAGE,         /*!< Current image. */
41     RPMTAG_HEADERSIGNATURES     = HEADER_SIGNATURES,    /*!< Signatures. */
42     RPMTAG_HEADERIMMUTABLE      = HEADER_IMMUTABLE,     /*!< Original image. */
43     RPMTAG_HEADERREGIONS        = HEADER_REGIONS,       /*!< Regions. */
44
45     RPMTAG_HEADERI18NTABLE      = HEADER_I18NTABLE, /*!< I18N string locales. */
46
47 /* Retrofit (and uniqify) signature tags for use by rpmTagGetName() and rpmQuery. */
48 /* the md5 sum was broken *twice* on big endian machines */
49 /* XXX 2nd underscore prevents tagTable generation */
50     RPMTAG_SIG_BASE             = HEADER_SIGBASE,
51     RPMTAG_SIGSIZE              = RPMTAG_SIG_BASE+1,    /* i */
52     RPMTAG_SIGLEMD5_1           = RPMTAG_SIG_BASE+2,    /* internal - obsolete */
53     RPMTAG_SIGPGP               = RPMTAG_SIG_BASE+3,    /* x */
54     RPMTAG_SIGLEMD5_2           = RPMTAG_SIG_BASE+4,    /* x internal - obsolete */
55     RPMTAG_SIGMD5               = RPMTAG_SIG_BASE+5,    /* x */
56 #define RPMTAG_PKGID    RPMTAG_SIGMD5                   /* x */
57     RPMTAG_SIGGPG               = RPMTAG_SIG_BASE+6,    /* x */
58     RPMTAG_SIGPGP5              = RPMTAG_SIG_BASE+7,    /* internal - obsolete */
59
60     RPMTAG_BADSHA1_1            = RPMTAG_SIG_BASE+8,    /* internal - obsolete */
61     RPMTAG_BADSHA1_2            = RPMTAG_SIG_BASE+9,    /* internal - obsolete */
62     RPMTAG_PUBKEYS              = RPMTAG_SIG_BASE+10,   /* s[] */
63     RPMTAG_DSAHEADER            = RPMTAG_SIG_BASE+11,   /* x */
64     RPMTAG_RSAHEADER            = RPMTAG_SIG_BASE+12,   /* x */
65     RPMTAG_SHA1HEADER           = RPMTAG_SIG_BASE+13,   /* s */
66 #define RPMTAG_HDRID    RPMTAG_SHA1HEADER       /* s */
67
68     RPMTAG_NAME                 = 1000, /* s */
69 #define RPMTAG_N        RPMTAG_NAME     /* s */
70     RPMTAG_VERSION              = 1001, /* s */
71 #define RPMTAG_V        RPMTAG_VERSION  /* s */
72     RPMTAG_RELEASE              = 1002, /* s */
73 #define RPMTAG_R        RPMTAG_RELEASE  /* s */
74     RPMTAG_EPOCH                = 1003, /* i */
75 #define RPMTAG_E        RPMTAG_EPOCH    /* i */
76     RPMTAG_SUMMARY              = 1004, /* s{} */
77     RPMTAG_DESCRIPTION          = 1005, /* s{} */
78     RPMTAG_BUILDTIME            = 1006, /* i */
79     RPMTAG_BUILDHOST            = 1007, /* s */
80     RPMTAG_INSTALLTIME          = 1008, /* i */
81     RPMTAG_SIZE                 = 1009, /* i */
82     RPMTAG_DISTRIBUTION         = 1010, /* s */
83     RPMTAG_VENDOR               = 1011, /* s */
84     RPMTAG_GIF                  = 1012, /* x */
85     RPMTAG_XPM                  = 1013, /* x */
86     RPMTAG_LICENSE              = 1014, /* s */
87     RPMTAG_PACKAGER             = 1015, /* s */
88     RPMTAG_GROUP                = 1016, /* s{} */
89     RPMTAG_CHANGELOG            = 1017, /* s[] internal */
90     RPMTAG_SOURCE               = 1018, /* s[] */
91     RPMTAG_PATCH                = 1019, /* s[] */
92     RPMTAG_URL                  = 1020, /* s */
93     RPMTAG_OS                   = 1021, /* s legacy used int */
94     RPMTAG_ARCH                 = 1022, /* s legacy used int */
95     RPMTAG_PREIN                = 1023, /* s */
96     RPMTAG_POSTIN               = 1024, /* s */
97     RPMTAG_PREUN                = 1025, /* s */
98     RPMTAG_POSTUN               = 1026, /* s */
99     RPMTAG_OLDFILENAMES         = 1027, /* s[] obsolete */
100     RPMTAG_FILESIZES            = 1028, /* i[] */
101     RPMTAG_FILESTATES           = 1029, /* c[] */
102     RPMTAG_FILEMODES            = 1030, /* h[] */
103     RPMTAG_FILEUIDS             = 1031, /* i[] internal */
104     RPMTAG_FILEGIDS             = 1032, /* i[] internal */
105     RPMTAG_FILERDEVS            = 1033, /* h[] */
106     RPMTAG_FILEMTIMES           = 1034, /* i[] */
107     RPMTAG_FILEDIGESTS          = 1035, /* s[] */
108 #define RPMTAG_FILEMD5S RPMTAG_FILEDIGESTS /* s[] */
109     RPMTAG_FILELINKTOS          = 1036, /* s[] */
110     RPMTAG_FILEFLAGS            = 1037, /* i[] */
111     RPMTAG_ROOT                 = 1038, /* internal - obsolete */
112     RPMTAG_FILEUSERNAME         = 1039, /* s[] */
113     RPMTAG_FILEGROUPNAME        = 1040, /* s[] */
114     RPMTAG_EXCLUDE              = 1041, /* internal - obsolete */
115     RPMTAG_EXCLUSIVE            = 1042, /* internal - obsolete */
116     RPMTAG_ICON                 = 1043, /* x */
117     RPMTAG_SOURCERPM            = 1044, /* s */
118     RPMTAG_FILEVERIFYFLAGS      = 1045, /* i[] */
119     RPMTAG_ARCHIVESIZE          = 1046, /* i */
120     RPMTAG_PROVIDENAME          = 1047, /* s[] */
121 #define RPMTAG_PROVIDES RPMTAG_PROVIDENAME      /* s[] */
122 #define RPMTAG_P        RPMTAG_PROVIDENAME      /* s[] */
123     RPMTAG_REQUIREFLAGS         = 1048, /* i[] */
124     RPMTAG_REQUIRENAME          = 1049, /* s[] */
125 #define RPMTAG_REQUIRES RPMTAG_REQUIRENAME      /* s[] */
126     RPMTAG_REQUIREVERSION       = 1050, /* s[] */
127     RPMTAG_NOSOURCE             = 1051, /* i internal */
128     RPMTAG_NOPATCH              = 1052, /* i internal */
129     RPMTAG_CONFLICTFLAGS        = 1053, /* i[] */
130     RPMTAG_CONFLICTNAME         = 1054, /* s[] */
131 #define RPMTAG_CONFLICTS RPMTAG_CONFLICTNAME    /* s[] */
132 #define RPMTAG_C        RPMTAG_CONFLICTNAME     /* s[] */
133     RPMTAG_CONFLICTVERSION      = 1055, /* s[] */
134     RPMTAG_DEFAULTPREFIX        = 1056, /* s internal - deprecated */
135     RPMTAG_BUILDROOT            = 1057, /* s internal */
136     RPMTAG_INSTALLPREFIX        = 1058, /* s internal - deprecated */
137     RPMTAG_EXCLUDEARCH          = 1059, /* s[] */
138     RPMTAG_EXCLUDEOS            = 1060, /* s[] */
139     RPMTAG_EXCLUSIVEARCH        = 1061, /* s[] */
140     RPMTAG_EXCLUSIVEOS          = 1062, /* s[] */
141     RPMTAG_AUTOREQPROV          = 1063, /* s internal */
142     RPMTAG_RPMVERSION           = 1064, /* s */
143     RPMTAG_TRIGGERSCRIPTS       = 1065, /* s[] */
144     RPMTAG_TRIGGERNAME          = 1066, /* s[] */
145     RPMTAG_TRIGGERVERSION       = 1067, /* s[] */
146     RPMTAG_TRIGGERFLAGS         = 1068, /* i[] */
147     RPMTAG_TRIGGERINDEX         = 1069, /* i[] */
148     RPMTAG_VERIFYSCRIPT         = 1079, /* s */
149     RPMTAG_CHANGELOGTIME        = 1080, /* i[] */
150     RPMTAG_CHANGELOGNAME        = 1081, /* s[] */
151     RPMTAG_CHANGELOGTEXT        = 1082, /* s[] */
152     RPMTAG_BROKENMD5            = 1083, /* internal - obsolete */
153     RPMTAG_PREREQ               = 1084, /* internal */
154     RPMTAG_PREINPROG            = 1085, /* s */
155     RPMTAG_POSTINPROG           = 1086, /* s */
156     RPMTAG_PREUNPROG            = 1087, /* s */
157     RPMTAG_POSTUNPROG           = 1088, /* s */
158     RPMTAG_BUILDARCHS           = 1089, /* s[] */
159     RPMTAG_OBSOLETENAME         = 1090, /* s[] */
160 #define RPMTAG_OBSOLETES RPMTAG_OBSOLETENAME    /* s[] */
161 #define RPMTAG_O        RPMTAG_OBSOLETENAME     /* s[] */
162     RPMTAG_VERIFYSCRIPTPROG     = 1091, /* s */
163     RPMTAG_TRIGGERSCRIPTPROG    = 1092, /* s[] */
164     RPMTAG_DOCDIR               = 1093, /* internal */
165     RPMTAG_COOKIE               = 1094, /* s */
166     RPMTAG_FILEDEVICES          = 1095, /* i[] */
167     RPMTAG_FILEINODES           = 1096, /* i[] */
168     RPMTAG_FILELANGS            = 1097, /* s[] */
169     RPMTAG_PREFIXES             = 1098, /* s[] */
170     RPMTAG_INSTPREFIXES         = 1099, /* s[] */
171     RPMTAG_TRIGGERIN            = 1100, /* internal */
172     RPMTAG_TRIGGERUN            = 1101, /* internal */
173     RPMTAG_TRIGGERPOSTUN        = 1102, /* internal */
174     RPMTAG_AUTOREQ              = 1103, /* internal */
175     RPMTAG_AUTOPROV             = 1104, /* internal */
176     RPMTAG_CAPABILITY           = 1105, /* i legacy - obsolete */
177     RPMTAG_SOURCEPACKAGE        = 1106, /* i legacy - obsolete */
178     RPMTAG_OLDORIGFILENAMES     = 1107, /* internal - obsolete */
179     RPMTAG_BUILDPREREQ          = 1108, /* internal */
180     RPMTAG_BUILDREQUIRES        = 1109, /* internal */
181     RPMTAG_BUILDCONFLICTS       = 1110, /* internal */
182     RPMTAG_BUILDMACROS          = 1111, /* internal - unused */
183     RPMTAG_PROVIDEFLAGS         = 1112, /* i[] */
184     RPMTAG_PROVIDEVERSION       = 1113, /* s[] */
185     RPMTAG_OBSOLETEFLAGS        = 1114, /* i[] */
186     RPMTAG_OBSOLETEVERSION      = 1115, /* s[] */
187     RPMTAG_DIRINDEXES           = 1116, /* i[] */
188     RPMTAG_BASENAMES            = 1117, /* s[] */
189     RPMTAG_DIRNAMES             = 1118, /* s[] */
190     RPMTAG_ORIGDIRINDEXES       = 1119, /* i[] relocation */
191     RPMTAG_ORIGBASENAMES        = 1120, /* s[] relocation */
192     RPMTAG_ORIGDIRNAMES         = 1121, /* s[] relocation */
193     RPMTAG_OPTFLAGS             = 1122, /* s */
194     RPMTAG_DISTURL              = 1123, /* s */
195     RPMTAG_PAYLOADFORMAT        = 1124, /* s */
196     RPMTAG_PAYLOADCOMPRESSOR    = 1125, /* s */
197     RPMTAG_PAYLOADFLAGS         = 1126, /* s */
198     RPMTAG_INSTALLCOLOR         = 1127, /* i transaction color when installed */
199     RPMTAG_INSTALLTID           = 1128, /* i */
200     RPMTAG_REMOVETID            = 1129, /* i */
201     RPMTAG_SHA1RHN              = 1130, /* internal - obsolete */
202     RPMTAG_RHNPLATFORM          = 1131, /* s deprecated */
203     RPMTAG_PLATFORM             = 1132, /* s */
204     RPMTAG_PATCHESNAME          = 1133, /* s[] deprecated placeholder (SuSE) */
205     RPMTAG_PATCHESFLAGS         = 1134, /* i[] deprecated placeholder (SuSE) */
206     RPMTAG_PATCHESVERSION       = 1135, /* s[] deprecated placeholder (SuSE) */
207     RPMTAG_CACHECTIME           = 1136, /* i */
208     RPMTAG_CACHEPKGPATH         = 1137, /* s */
209     RPMTAG_CACHEPKGSIZE         = 1138, /* i */
210     RPMTAG_CACHEPKGMTIME        = 1139, /* i */
211     RPMTAG_FILECOLORS           = 1140, /* i[] */
212     RPMTAG_FILECLASS            = 1141, /* i[] */
213     RPMTAG_CLASSDICT            = 1142, /* s[] */
214     RPMTAG_FILEDEPENDSX         = 1143, /* i[] */
215     RPMTAG_FILEDEPENDSN         = 1144, /* i[] */
216     RPMTAG_DEPENDSDICT          = 1145, /* i[] */
217     RPMTAG_SOURCEPKGID          = 1146, /* x */
218     RPMTAG_FILECONTEXTS         = 1147, /* s[] - obsolete */
219     RPMTAG_FSCONTEXTS           = 1148, /* s[] extension */
220     RPMTAG_RECONTEXTS           = 1149, /* s[] extension */
221     RPMTAG_POLICIES             = 1150, /* s[] selinux *.te policy file. */
222     RPMTAG_PRETRANS             = 1151, /* s */
223     RPMTAG_POSTTRANS            = 1152, /* s */
224     RPMTAG_PRETRANSPROG         = 1153, /* s */
225     RPMTAG_POSTTRANSPROG        = 1154, /* s */
226     RPMTAG_DISTTAG              = 1155, /* s */
227     RPMTAG_SUGGESTSNAME         = 1156, /* s[] extension */
228 #define RPMTAG_SUGGESTS RPMTAG_SUGGESTSNAME     /* s[] */
229     RPMTAG_SUGGESTSVERSION      = 1157, /* s[] extension */
230     RPMTAG_SUGGESTSFLAGS        = 1158, /* i[] extension */
231     RPMTAG_ENHANCESNAME         = 1159, /* s[] extension placeholder */
232 #define RPMTAG_ENHANCES RPMTAG_ENHANCESNAME     /* s[] */
233     RPMTAG_ENHANCESVERSION      = 1160, /* s[] extension placeholder */
234     RPMTAG_ENHANCESFLAGS        = 1161, /* i[] extension placeholder */
235     RPMTAG_PRIORITY             = 1162, /* i[] extension placeholder */
236     RPMTAG_CVSID                = 1163, /* s */
237 #define RPMTAG_SVNID    RPMTAG_CVSID    /* s */
238     RPMTAG_BLINKPKGID           = 1164, /* s[] */
239     RPMTAG_BLINKHDRID           = 1165, /* s[] */
240     RPMTAG_BLINKNEVRA           = 1166, /* s[] */
241     RPMTAG_FLINKPKGID           = 1167, /* s[] */
242     RPMTAG_FLINKHDRID           = 1168, /* s[] */
243     RPMTAG_FLINKNEVRA           = 1169, /* s[] */
244     RPMTAG_PACKAGEORIGIN        = 1170, /* s */
245     RPMTAG_TRIGGERPREIN         = 1171, /* internal */
246     RPMTAG_BUILDSUGGESTS        = 1172, /* internal */
247     RPMTAG_BUILDENHANCES        = 1173, /* internal */
248     RPMTAG_SCRIPTSTATES         = 1174, /* i[] scriptlet exit codes */
249     RPMTAG_SCRIPTMETRICS        = 1175, /* i[] scriptlet execution times */
250     RPMTAG_BUILDCPUCLOCK        = 1176, /* i */
251     RPMTAG_FILEDIGESTALGOS      = 1177, /* i[] */
252     RPMTAG_VARIANTS             = 1178, /* s[] */
253     RPMTAG_XMAJOR               = 1179, /* i */
254     RPMTAG_XMINOR               = 1180, /* i */
255     RPMTAG_REPOTAG              = 1181, /* s */
256     RPMTAG_KEYWORDS             = 1182, /* s[] */
257     RPMTAG_BUILDPLATFORMS       = 1183, /* s[] */
258     RPMTAG_PACKAGECOLOR         = 1184, /* i */
259     RPMTAG_PACKAGEPREFCOLOR     = 1185, /* i (unimplemented) */
260     RPMTAG_XATTRSDICT           = 1186, /* s[] (unimplemented) */
261     RPMTAG_FILEXATTRSX          = 1187, /* i[] (unimplemented) */
262     RPMTAG_DEPATTRSDICT         = 1188, /* s[] (unimplemented) */
263     RPMTAG_CONFLICTATTRSX       = 1189, /* i[] (unimplemented) */
264     RPMTAG_OBSOLETEATTRSX       = 1190, /* i[] (unimplemented) */
265     RPMTAG_PROVIDEATTRSX        = 1191, /* i[] (unimplemented) */
266     RPMTAG_REQUIREATTRSX        = 1192, /* i[] (unimplemented) */
267     RPMTAG_BUILDPROVIDES        = 1193, /* internal */
268     RPMTAG_BUILDOBSOLETES       = 1194, /* internal */
269
270     RPMTAG_FIRSTFREE_TAG        /*!< internal */
271 } rpmTag;
272
273 #define RPMTAG_EXTERNAL_TAG             1000000
274 #define RPMTAG_NOT_FOUND                -1
275
276 /** \ingroup signature
277  * Tags found in signature header from package.
278  */
279 typedef enum rpmSigTag_e {
280     RPMSIGTAG_SIZE      = 1000, /*!< internal Header+Payload size in bytes. */
281     RPMSIGTAG_LEMD5_1   = 1001, /*!< internal Broken MD5, take 1 @deprecated legacy. */
282     RPMSIGTAG_PGP       = 1002, /*!< internal PGP 2.6.3 signature. */
283     RPMSIGTAG_LEMD5_2   = 1003, /*!< internal Broken MD5, take 2 @deprecated legacy. */
284     RPMSIGTAG_MD5       = 1004, /*!< internal MD5 signature. */
285     RPMSIGTAG_GPG       = 1005, /*!< internal GnuPG signature. */
286     RPMSIGTAG_PGP5      = 1006, /*!< internal PGP5 signature @deprecated legacy. */
287     RPMSIGTAG_PAYLOADSIZE = 1007,/*!< internal uncompressed payload size in bytes. */
288     RPMSIGTAG_BADSHA1_1 = RPMTAG_BADSHA1_1,     /*!< internal Broken SHA1, take 1. */
289     RPMSIGTAG_BADSHA1_2 = RPMTAG_BADSHA1_2,     /*!< internal Broken SHA1, take 2. */
290     RPMSIGTAG_SHA1      = RPMTAG_SHA1HEADER,    /*!< internal sha1 header digest. */
291     RPMSIGTAG_DSA       = RPMTAG_DSAHEADER,     /*!< internal DSA header signature. */
292     RPMSIGTAG_RSA       = RPMTAG_RSAHEADER      /*!< internal RSA header signature. */
293 } rpmSigTag;
294
295
296 /** \ingroup header
297  * The basic types of data in tags from headers.
298  */
299 typedef enum rpmTagType_e {
300 #define RPM_MIN_TYPE            0
301     RPM_NULL_TYPE               =  0,
302     RPM_CHAR_TYPE               =  1,
303     RPM_INT8_TYPE               =  2,
304     RPM_INT16_TYPE              =  3,
305     RPM_INT32_TYPE              =  4,
306 /*    RPM_INT64_TYPE    = 5,   ---- These aren't supported (yet) */
307     RPM_STRING_TYPE             =  6,
308     RPM_BIN_TYPE                =  7,
309     RPM_STRING_ARRAY_TYPE       =  8,
310     RPM_I18NSTRING_TYPE         =  9,
311 #define RPM_MAX_TYPE            9
312 #define RPM_FORCEFREE_TYPE      0xff
313 #define RPM_MASK_TYPE           0x0000ffff
314 } rpmTagType;
315
316 /** \ingroup header
317  * New rpm data types under consideration/development.
318  * These data types may (or may not) be added to rpm at some point. In order
319  * to avoid incompatibility with legacy versions of rpm, these data (sub-)types
320  * are introduced into the header by overloading RPM_BIN_TYPE, with the binary
321  * value of the tag a 16 byte image of what should/will be in the header index,
322  * followed by per-tag private data.
323  */
324 typedef enum rpmSubTagType_e {
325     RPM_REGION_TYPE             = -10,
326     RPM_BIN_ARRAY_TYPE          = -11,
327   /*!<@todo Implement, kinda like RPM_STRING_ARRAY_TYPE for known (but variable)
328         length binary data. */
329     RPM_XREF_TYPE               = -12
330   /*!<@todo Implement, intent is to to carry a (???,tagNum,valNum) cross
331         reference to retrieve data from other tags. */
332 } rpmSubTagType;
333
334 /** \ingroup header
335  *  * Identify how to return the header data type.
336  *   */
337 typedef enum rpmTagReturnType_e {
338     RPM_ANY_RETURN_TYPE         = 0,
339     RPM_SCALAR_RETURN_TYPE      = 0x00010000,
340     RPM_ARRAY_RETURN_TYPE       = 0x00020000,
341     RPM_MAPPING_RETURN_TYPE     = 0x00040000,
342     RPM_MASK_RETURN_TYPE        = 0xffff0000
343 } rpmTagReturnType;
344
345 /** \ingroup rpmtag
346  * Return tag name from value.
347  * @param tag           tag value
348  * @return              tag name, "(unknown)" on not found
349  */
350 const char * rpmTagGetName(rpmTag tag);
351
352 /** \ingroup rpmtag
353  * Return tag data type from value.
354  * @param tag           tag value
355  * @return              tag data type, RPM_NULL_TYPE on not found.
356  */
357 rpmTagType rpmTagGetType(rpmTag tag);
358
359 /** \ingroup rpmtag
360  * Return tag value from name.
361  * @param tagstr        name of tag
362  * @return              tag value, -1 on not found
363  */
364 rpmTag rpmTagGetValue(const char * tagstr);
365
366 #ifdef __cplusplus
367 }
368 #endif
369
370 #endif /* _RPMTAG_H */