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 set of size 1.
140 * @param tagN type of dependency
142 * @param EVR epoch:version-release
143 * @param Flags comparison flags
144 * @return new dependency set
146 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
149 * Return a new dependency set of size 1 from the current iteration index
150 * @param ds dependency set
151 * @return new dependency set
153 rpmds rpmdsCurrent(rpmds ds);
156 * Return dependency set count.
157 * @param ds dependency set
158 * @return current count
160 int rpmdsCount(const rpmds ds);
163 * Return dependency set index.
164 * @param ds dependency set
165 * @return current index
167 int rpmdsIx(const rpmds ds);
170 * Set dependency set index.
171 * @param ds dependency set
172 * @param ix new index
173 * @return current index
175 int rpmdsSetIx(rpmds ds, int ix);
178 * Return current formatted dependency string.
179 * @param ds dependency set
180 * @return current dependency DNEVR, NULL on invalid
182 const char * rpmdsDNEVR(const rpmds ds);
185 * Return current dependency name pool id.
186 * @param ds dependency set
187 * @return current dependency name id, 0 on invalid
189 rpmsid rpmdsNId(rpmds ds);
192 * Return current dependency epoch-version-release pool id.
193 * @param ds dependency set
194 * @return current dependency EVR id, 0 on invalid
196 rpmsid rpmdsEVRId(rpmds ds);
199 * Return current dependency name.
200 * @param ds dependency set
201 * @return current dependency name, NULL on invalid
203 const char * rpmdsN(const rpmds ds);
206 * Return current dependency epoch-version-release.
207 * @param ds dependency set
208 * @return current dependency EVR, NULL on invalid
210 const char * rpmdsEVR(const rpmds ds);
213 * Return current dependency flags.
214 * @param ds dependency set
215 * @return current dependency flags, 0 on invalid
217 rpmsenseFlags rpmdsFlags(const rpmds ds);
220 * Return current dependency type.
221 * @param ds dependency set
222 * @return current dependency type, 0 on invalid
224 rpmTagVal rpmdsTagN(const rpmds ds);
227 * Return dependency header instance, ie whether the dependency comes from
228 * an installed header or not.
229 * @param ds dependency set
230 * @return header instance of dependency (0 for not installed)
232 unsigned int rpmdsInstance(rpmds ds);
235 * Return current "Don't promote Epoch:" flag.
237 * This flag controls for Epoch: promotion when a dependency set is
238 * compared. If the flag is set (for already installed packages), then
239 * an unspecified value will be treated as Epoch: 0. Otherwise (for added
240 * packages), the Epoch: portion of the comparison is skipped if the value
241 * is not specified, i.e. an unspecified Epoch: is assumed to be equal
242 * in dependency comparisons.
244 * @param ds dependency set
245 * @return current "Don't promote Epoch:" flag
247 int rpmdsNoPromote(const rpmds ds);
250 * Set "Don't promote Epoch:" flag.
251 * @param ds dependency set
252 * @param nopromote Should an unspecified Epoch: be treated as Epoch: 0?
253 * @return previous "Don't promote Epoch:" flag
255 int rpmdsSetNoPromote(rpmds ds, int nopromote);
258 * Return current dependency color.
259 * @param ds dependency set
260 * @return current dependency color
262 rpm_color_t rpmdsColor(const rpmds ds);
265 * Return current dependency color.
266 * @param ds dependency set
267 * @param color new dependency color
268 * @return previous dependency color
270 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
273 * Notify of results of dependency match.
274 * @param ds dependency set
275 * @param where where dependency was resolved (or NULL)
276 * @param rc 0 == YES, otherwise NO
278 /* FIX: rpmMessage annotation is a lie */
279 void rpmdsNotify(rpmds ds, const char * where, int rc);
282 * Return next dependency set iterator index.
283 * @param ds dependency set
284 * @return dependency set iterator index, -1 on termination
286 int rpmdsNext(rpmds ds);
289 * Initialize dependency set iterator.
290 * @param ds dependency set
291 * @return dependency set
293 rpmds rpmdsInit(rpmds ds);
296 * Find a dependency set element using binary search.
297 * @param ds dependency set to search
298 * @param ods dependency set element to find.
299 * @return dependency index (or -1 if not found)
301 int rpmdsFind(rpmds ds, const rpmds ods);
304 * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
305 * @retval *dsp (merged) dependency set
306 * @param ods dependency set to merge
307 * @return (merged) dependency index
309 int rpmdsMerge(rpmds * dsp, rpmds ods);
312 * Search a sorted dependency set for an element that overlaps.
313 * A boolean result is saved (if allocated) and accessible through
314 * rpmdsResult(ods) afterwards.
315 * @param ds dependency set to search
316 * @param ods dependency set element to find.
317 * @return dependency index (or -1 if not found)
319 int rpmdsSearch(rpmds ds, rpmds ods);
322 * Compare two versioned dependency ranges, looking for overlap.
323 * @param A 1st dependency
324 * @param B 2nd dependency
325 * @return 1 if dependencies overlap, 0 otherwise
327 int rpmdsCompare(const rpmds A, const rpmds B);
330 * Compare package provides dependencies from header with a single dependency.
332 * @param req dependency set
333 * @param nopromote Don't promote Epoch: in comparison?
334 * @return 1 if any dependency overlaps, 0 otherwise
336 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
339 * Compare package provides dependencies from header with a single dependency.
341 * @param ix index in header provides
342 * @param req dependency set
343 * @param nopromote Don't promote Epoch: in comparison?
344 * @return 1 if any dependency overlaps, 0 otherwise
346 int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
349 * Compare package name-version-release from header with a single dependency.
351 * @param req dependency set
352 * @param nopromote Don't promote Epoch: in comparison?
353 * @return 1 if dependency overlaps, 0 otherwise
355 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
358 * Load rpmlib provides into a dependency set.
359 * @retval *dsp (loaded) depedency set
360 * @param tblp rpmlib provides table (NULL uses internal table)
361 * @return 0 on success
363 int rpmdsRpmlib(rpmds * dsp, const void * tblp);
366 * Return dependency set string pool handle
367 * @param fi dependency set
368 * @return string pool handle (weak reference)
370 rpmstrPool rpmdsPool(rpmds ds);