4 /** \ingroup rpmdep rpmtrans
6 * Structure(s) used for dependency tag sets.
11 #include <rpm/rpmtypes.h>
12 #include <rpm/rpmps.h>
20 extern int _rpmds_nopromote;
23 * Dependency Attributes.
25 enum rpmsenseFlags_e {
27 RPMSENSE_LESS = (1 << 1),
28 RPMSENSE_GREATER = (1 << 2),
29 RPMSENSE_EQUAL = (1 << 3),
31 RPMSENSE_POSTTRANS = (1 << 5), /*!< %posttrans dependency */
32 RPMSENSE_PREREQ = (1 << 6), /* legacy prereq dependency */
33 RPMSENSE_PRETRANS = (1 << 7), /*!< Pre-transaction dependency. */
34 RPMSENSE_INTERP = (1 << 8), /*!< Interpreter used by scriptlet. */
35 RPMSENSE_SCRIPT_PRE = (1 << 9), /*!< %pre dependency. */
36 RPMSENSE_SCRIPT_POST = (1 << 10), /*!< %post dependency. */
37 RPMSENSE_SCRIPT_PREUN = (1 << 11), /*!< %preun dependency. */
38 RPMSENSE_SCRIPT_POSTUN = (1 << 12), /*!< %postun dependency. */
39 RPMSENSE_SCRIPT_VERIFY = (1 << 13), /*!< %verify dependency. */
40 RPMSENSE_FIND_REQUIRES = (1 << 14), /*!< find-requires generated dependency. */
41 RPMSENSE_FIND_PROVIDES = (1 << 15), /*!< find-provides generated dependency. */
43 RPMSENSE_TRIGGERIN = (1 << 16), /*!< %triggerin dependency. */
44 RPMSENSE_TRIGGERUN = (1 << 17), /*!< %triggerun dependency. */
45 RPMSENSE_TRIGGERPOSTUN = (1 << 18), /*!< %triggerpostun dependency. */
46 RPMSENSE_MISSINGOK = (1 << 19), /*!< suggests/enhances hint. */
47 /* bits 20-23 unused */
48 RPMSENSE_RPMLIB = (1 << 24), /*!< rpmlib(feature) dependency. */
49 RPMSENSE_TRIGGERPREIN = (1 << 25), /*!< %triggerprein dependency. */
50 RPMSENSE_KEYRING = (1 << 26),
52 RPMSENSE_CONFIG = (1 << 28)
55 typedef rpmFlags rpmsenseFlags;
57 #define RPMSENSE_SENSEMASK 15 /* Mask to get senses, ie serial, */
58 /* less, greater, equal. */
60 #define RPMSENSE_TRIGGER \
61 (RPMSENSE_TRIGGERPREIN | RPMSENSE_TRIGGERIN | RPMSENSE_TRIGGERUN | RPMSENSE_TRIGGERPOSTUN)
63 #define _ALL_REQUIRES_MASK (\
65 RPMSENSE_SCRIPT_PRE | \
66 RPMSENSE_SCRIPT_POST | \
67 RPMSENSE_SCRIPT_PREUN | \
68 RPMSENSE_SCRIPT_POSTUN | \
69 RPMSENSE_SCRIPT_VERIFY | \
70 RPMSENSE_FIND_REQUIRES | \
74 RPMSENSE_POSTTRANS | \
78 #define _notpre(_x) ((_x) & ~RPMSENSE_PREREQ)
79 #define _INSTALL_ONLY_MASK \
80 _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING|RPMSENSE_PRETRANS|RPMSENSE_POSTTRANS)
81 #define _ERASE_ONLY_MASK \
82 _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
84 #define isLegacyPreReq(_x) (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
85 #define isInstallPreReq(_x) ((_x) & _INSTALL_ONLY_MASK)
86 #define isErasePreReq(_x) ((_x) & _ERASE_ONLY_MASK)
89 * Reference a dependency set instance.
90 * @param ds dependency set
91 * @return new dependency set reference
93 rpmds rpmdsLink(rpmds ds);
96 * Destroy a dependency set.
97 * @param ds dependency set
100 rpmds rpmdsFree(rpmds ds);
103 * Create and load a dependency set.
105 * @param tagN type of dependency
106 * @param flags unused
107 * @return new dependency set
109 rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
112 * Create and load a dependency set.
113 * @param pool shared string pool (or NULL for private pool)
115 * @param tagN type of dependency
116 * @param flags unused
117 * @return new dependency set
119 rpmds rpmdsNewPool(rpmstrPool pool, Header h, rpmTagVal tagN, int flags);
122 * Return new formatted dependency string.
123 * @param dspfx formatted dependency string prefix
124 * @param ds dependency set
125 * @return new formatted dependency (malloc'ed)
127 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
130 * Create, load and initialize a dependency for this header.
132 * @param tagN type of dependency
133 * @param Flags comparison flags
134 * @return new dependency set
136 rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
139 * Create, load and initialize a dependency for this header.
140 * @param pool string pool (or NULL for private pool)
142 * @param tagN type of dependency
143 * @param Flags comparison flags
144 * @return new dependency set
146 rpmds rpmdsThisPool(rpmstrPool pool,
147 Header h, rpmTagVal tagN, rpmsenseFlags Flags);
150 * Create, load and initialize a dependency set of size 1.
151 * @param tagN type of dependency
153 * @param EVR epoch:version-release
154 * @param Flags comparison flags
155 * @return new dependency set
157 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
160 * Create, load and initialize a dependency set of size 1.
161 * @param pool string pool (or NULL for private pool)
162 * @param tagN type of dependency
164 * @param EVR epoch:version-release
165 * @param Flags comparison flags
166 * @return new dependency set
168 rpmds rpmdsSinglePool(rpmstrPool pool, rpmTagVal tagN,
169 const char * N, const char * EVR, rpmsenseFlags Flags);
172 * Return a new dependency set of size 1 from the current iteration index
173 * @param ds dependency set
174 * @return new dependency set
176 rpmds rpmdsCurrent(rpmds ds);
179 * Return dependency set count.
180 * @param ds dependency set
181 * @return current count
183 int rpmdsCount(const rpmds ds);
186 * Return dependency set index.
187 * @param ds dependency set
188 * @return current index
190 int rpmdsIx(const rpmds ds);
193 * Set dependency set index.
194 * @param ds dependency set
195 * @param ix new index
196 * @return current index
198 int rpmdsSetIx(rpmds ds, int ix);
201 * Return current formatted dependency string.
202 * @param ds dependency set
203 * @return current dependency DNEVR, NULL on invalid
205 const char * rpmdsDNEVR(const rpmds ds);
208 * Return current dependency name pool id.
209 * @param ds dependency set
210 * @return current dependency name id, 0 on invalid
212 rpmsid rpmdsNId(rpmds ds);
215 * Return current dependency epoch-version-release pool id.
216 * @param ds dependency set
217 * @return current dependency EVR id, 0 on invalid
219 rpmsid rpmdsEVRId(rpmds ds);
222 * Return current dependency name.
223 * @param ds dependency set
224 * @return current dependency name, NULL on invalid
226 const char * rpmdsN(const rpmds ds);
229 * Return current dependency epoch-version-release.
230 * @param ds dependency set
231 * @return current dependency EVR, NULL on invalid
233 const char * rpmdsEVR(const rpmds ds);
236 * Return current dependency flags.
237 * @param ds dependency set
238 * @return current dependency flags, 0 on invalid
240 rpmsenseFlags rpmdsFlags(const rpmds ds);
243 * Return current dependency type.
244 * @param ds dependency set
245 * @return current dependency type, 0 on invalid
247 rpmTagVal rpmdsTagN(const rpmds ds);
250 * Return dependency header instance, ie whether the dependency comes from
251 * an installed header or not.
252 * @param ds dependency set
253 * @return header instance of dependency (0 for not installed)
255 unsigned int rpmdsInstance(rpmds ds);
258 * Return current "Don't promote Epoch:" flag.
260 * This flag controls for Epoch: promotion when a dependency set is
261 * compared. If the flag is set (for already installed packages), then
262 * an unspecified value will be treated as Epoch: 0. Otherwise (for added
263 * packages), the Epoch: portion of the comparison is skipped if the value
264 * is not specified, i.e. an unspecified Epoch: is assumed to be equal
265 * in dependency comparisons.
267 * @param ds dependency set
268 * @return current "Don't promote Epoch:" flag
270 int rpmdsNoPromote(const rpmds ds);
273 * Set "Don't promote Epoch:" flag.
274 * @param ds dependency set
275 * @param nopromote Should an unspecified Epoch: be treated as Epoch: 0?
276 * @return previous "Don't promote Epoch:" flag
278 int rpmdsSetNoPromote(rpmds ds, int nopromote);
281 * Return current dependency color.
282 * @param ds dependency set
283 * @return current dependency color
285 rpm_color_t rpmdsColor(const rpmds ds);
288 * Return current dependency color.
289 * @param ds dependency set
290 * @param color new dependency color
291 * @return previous dependency color
293 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
296 * Notify of results of dependency match.
297 * @param ds dependency set
298 * @param where where dependency was resolved (or NULL)
299 * @param rc 0 == YES, otherwise NO
301 /* FIX: rpmMessage annotation is a lie */
302 void rpmdsNotify(rpmds ds, const char * where, int rc);
305 * Return next dependency set iterator index.
306 * @param ds dependency set
307 * @return dependency set iterator index, -1 on termination
309 int rpmdsNext(rpmds ds);
312 * Initialize dependency set iterator.
313 * @param ds dependency set
314 * @return dependency set
316 rpmds rpmdsInit(rpmds ds);
319 * Find a dependency set element using binary search.
320 * @param ds dependency set to search
321 * @param ods dependency set element to find.
322 * @return dependency index (or -1 if not found)
324 int rpmdsFind(rpmds ds, const rpmds ods);
327 * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
328 * @retval *dsp (merged) dependency set
329 * @param ods dependency set to merge
330 * @return (merged) dependency index
332 int rpmdsMerge(rpmds * dsp, rpmds ods);
335 * Search a sorted dependency set for an element that overlaps.
336 * A boolean result is saved (if allocated) and accessible through
337 * rpmdsResult(ods) afterwards.
338 * @param ds dependency set to search
339 * @param ods dependency set element to find.
340 * @return dependency index (or -1 if not found)
342 int rpmdsSearch(rpmds ds, rpmds ods);
345 * Compare two versioned dependency ranges, looking for overlap.
346 * @param A 1st dependency
347 * @param B 2nd dependency
348 * @return 1 if dependencies overlap, 0 otherwise
350 int rpmdsCompare(const rpmds A, const rpmds B);
353 * Compare package provides dependencies from header with a single dependency.
355 * @param req dependency set
356 * @param nopromote Don't promote Epoch: in comparison?
357 * @return 1 if any dependency overlaps, 0 otherwise
359 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
362 * Compare package provides dependencies from header with a single dependency.
364 * @param ix index in header provides
365 * @param req dependency set
366 * @param nopromote Don't promote Epoch: in comparison?
367 * @return 1 if any dependency overlaps, 0 otherwise
369 int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
372 * Compare package name-version-release from header with a single dependency.
374 * @param req dependency set
375 * @param nopromote Don't promote Epoch: in comparison?
376 * @return 1 if dependency overlaps, 0 otherwise
378 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
381 * Swiss army knife dependency matching function.
382 * @param pool string pool (or NULL for private pool)
384 * @param prix index to provides (or -1 or any)
385 * @param req dependency set
386 * @param selfevr only look at package EVR?
387 * @param nopromote dont promote epoch in comparison?
388 * @return 1 if dependency overlaps, 0 otherwise
390 int rpmdsMatches(rpmstrPool pool, Header h, int prix,
391 rpmds req, int selfevr, int nopromote);
393 * Load rpmlib provides into a dependency set.
394 * @retval *dsp (loaded) depedency set
395 * @param tblp rpmlib provides table (NULL uses internal table)
396 * @return 0 on success
398 int rpmdsRpmlib(rpmds * dsp, const void * tblp);
401 * Load rpmlib provides into a dependency set.
402 * @param pool shared string pool (or NULL for private pool)
403 * @retval *dsp (loaded) depedency set
404 * @param tblp rpmlib provides table (NULL uses internal table)
405 * @return 0 on success
407 int rpmdsRpmlibPool(rpmstrPool pool, rpmds * dsp, const void * tblp);
410 * Return dependency set string pool handle
411 * @param fi dependency set
412 * @return string pool handle (weak reference)
414 rpmstrPool rpmdsPool(rpmds ds);