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),
51 RPMSENSE_STRONG = (1 << 27),
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 | \
76 RPMSENSE_MISSINGOK | \
79 #define _notpre(_x) ((_x) & ~RPMSENSE_PREREQ)
80 #define _INSTALL_ONLY_MASK \
81 _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING|RPMSENSE_PRETRANS|RPMSENSE_POSTTRANS)
82 #define _ERASE_ONLY_MASK \
83 _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
85 #define isLegacyPreReq(_x) (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
86 #define isInstallPreReq(_x) ((_x) & _INSTALL_ONLY_MASK)
87 #define isErasePreReq(_x) ((_x) & _ERASE_ONLY_MASK)
90 * Reference a dependency set instance.
91 * @param ds dependency set
92 * @return new dependency set reference
94 rpmds rpmdsLink(rpmds ds);
97 * Destroy a dependency set.
98 * @param ds dependency set
101 rpmds rpmdsFree(rpmds ds);
104 * Create and load a dependency set.
106 * @param tagN type of dependency
107 * @param flags unused
108 * @return new dependency set
110 rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
113 * Return new formatted dependency string.
114 * @param dspfx formatted dependency string prefix
115 * @param ds dependency set
116 * @return new formatted dependency (malloc'ed)
118 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
121 * Create, load and initialize a dependency for this header.
123 * @param tagN type of dependency
124 * @param Flags comparison flags
125 * @return new dependency set
127 rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
130 * Create, load and initialize a dependency set of size 1.
131 * @param tagN type of dependency
133 * @param EVR epoch:version-release
134 * @param Flags comparison flags
135 * @return new dependency set
137 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
140 * Return a new dependency set of size 1 from the current iteration index
141 * @param ds dependency set
142 * @return new dependency set
144 rpmds rpmdsCurrent(rpmds ds);
147 * Return dependency set count.
148 * @param ds dependency set
149 * @return current count
151 int rpmdsCount(const rpmds ds);
154 * Return dependency set index.
155 * @param ds dependency set
156 * @return current index
158 int rpmdsIx(const rpmds ds);
161 * Set dependency set index.
162 * @param ds dependency set
163 * @param ix new index
164 * @return current index
166 int rpmdsSetIx(rpmds ds, int ix);
169 * Return current formatted dependency string.
170 * @param ds dependency set
171 * @return current dependency DNEVR, NULL on invalid
173 const char * rpmdsDNEVR(const rpmds ds);
176 * Return current dependency name.
177 * @param ds dependency set
178 * @return current dependency name, NULL on invalid
180 const char * rpmdsN(const rpmds ds);
183 * Return current dependency epoch-version-release.
184 * @param ds dependency set
185 * @return current dependency EVR, NULL on invalid
187 const char * rpmdsEVR(const rpmds ds);
190 * Return current dependency flags.
191 * @param ds dependency set
192 * @return current dependency flags, 0 on invalid
194 rpmsenseFlags rpmdsFlags(const rpmds ds);
197 * Return current dependency type.
198 * @param ds dependency set
199 * @return current dependency type, 0 on invalid
201 rpmTagVal rpmdsTagN(const rpmds ds);
204 * Return dependency header instance, ie whether the dependency comes from
205 * an installed header or not.
206 * @param ds dependency set
207 * @return header instance of dependency (0 for not installed)
209 unsigned int rpmdsInstance(rpmds ds);
212 * Return current "Don't promote Epoch:" flag.
214 * This flag controls for Epoch: promotion when a dependency set is
215 * compared. If the flag is set (for already installed packages), then
216 * an unspecified value will be treated as Epoch: 0. Otherwise (for added
217 * packages), the Epoch: portion of the comparison is skipped if the value
218 * is not specified, i.e. an unspecified Epoch: is assumed to be equal
219 * in dependency comparisons.
221 * @param ds dependency set
222 * @return current "Don't promote Epoch:" flag
224 int rpmdsNoPromote(const rpmds ds);
227 * Set "Don't promote Epoch:" flag.
228 * @param ds dependency set
229 * @param nopromote Should an unspecified Epoch: be treated as Epoch: 0?
230 * @return previous "Don't promote Epoch:" flag
232 int rpmdsSetNoPromote(rpmds ds, int nopromote);
235 * Return current dependency color.
236 * @param ds dependency set
237 * @return current dependency color
239 rpm_color_t rpmdsColor(const rpmds ds);
242 * Return current dependency color.
243 * @param ds dependency set
244 * @param color new dependency color
245 * @return previous dependency color
247 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
250 * Notify of results of dependency match.
251 * @param ds dependency set
252 * @param where where dependency was resolved (or NULL)
253 * @param rc 0 == YES, otherwise NO
255 /* FIX: rpmMessage annotation is a lie */
256 void rpmdsNotify(rpmds ds, const char * where, int rc);
259 * Return next dependency set iterator index.
260 * @param ds dependency set
261 * @return dependency set iterator index, -1 on termination
263 int rpmdsNext(rpmds ds);
266 * Initialize dependency set iterator.
267 * @param ds dependency set
268 * @return dependency set
270 rpmds rpmdsInit(rpmds ds);
273 * Find a dependency set element using binary search.
274 * @param ds dependency set to search
275 * @param ods dependency set element to find.
276 * @return dependency index (or -1 if not found)
278 int rpmdsFind(rpmds ds, const rpmds ods);
281 * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
282 * @retval *dsp (merged) dependency set
283 * @param ods dependency set to merge
284 * @return (merged) dependency index
286 int rpmdsMerge(rpmds * dsp, rpmds ods);
289 * Search a sorted dependency set for an element that overlaps.
290 * A boolean result is saved (if allocated) and accessible through
291 * rpmdsResult(ods) afterwards.
292 * @param ds dependency set to search
293 * @param ods dependency set element to find.
294 * @return dependency index (or -1 if not found)
296 int rpmdsSearch(rpmds ds, rpmds ods);
299 * Compare two versioned dependency ranges, looking for overlap.
300 * @param A 1st dependency
301 * @param B 2nd dependency
302 * @return 1 if dependencies overlap, 0 otherwise
304 int rpmdsCompare(const rpmds A, const rpmds B);
307 * Compare package provides dependencies from header with a single dependency.
309 * @param req dependency set
310 * @param nopromote Don't promote Epoch: in comparison?
311 * @return 1 if any dependency overlaps, 0 otherwise
313 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
316 * Compare package provides dependencies from header with a single dependency.
318 * @param ix index in header provides
319 * @param req dependency set
320 * @param nopromote Don't promote Epoch: in comparison?
321 * @return 1 if any dependency overlaps, 0 otherwise
323 int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
326 * Compare package name-version-release from header with a single dependency.
328 * @param req dependency set
329 * @param nopromote Don't promote Epoch: in comparison?
330 * @return 1 if dependency overlaps, 0 otherwise
332 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
335 * Load rpmlib provides into a dependency set.
336 * @retval *dsp (loaded) depedency set
337 * @param tblp rpmlib provides table (NULL uses internal table)
338 * @return 0 on success
340 int rpmdsRpmlib(rpmds * dsp, const void * tblp);