lib/rpmds.h

   1 #ifndef H_RPMDS
   2 #define H_RPMDS
   3
   4 /** \ingroup rpmdep rpmtrans
   5  * \file lib/rpmds.h
   6  * Structure(s) used for dependency tag sets.
   7  */
   8
   9 #include <time.h>
  10
  11 #include <rpm/rpmtypes.h>
  12 #include <rpm/rpmps.h>
  13
  14 #ifdef __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 /**
  19  */
  20 extern int _rpmds_nopromote;
  21
  22 /** \ingroup rpmds
  23  * Dependency Attributes.
  24  */
  25 enum rpmsenseFlags_e {
  26     RPMSENSE_ANY        = 0,
  27     RPMSENSE_LESS       = (1 << 1),
  28     RPMSENSE_GREATER    = (1 << 2),
  29     RPMSENSE_EQUAL      = (1 << 3),
  30     /* bit 4 unused */
  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. */
  42
  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)
  53 };
  54
  55 typedef rpmFlags rpmsenseFlags;
  56
  57 #define RPMSENSE_SENSEMASK      15       /* Mask to get senses, ie serial, */
  58                                          /* less, greater, equal.          */
  59
  60 #define RPMSENSE_TRIGGER        \
  61         (RPMSENSE_TRIGGERPREIN | RPMSENSE_TRIGGERIN | RPMSENSE_TRIGGERUN | RPMSENSE_TRIGGERPOSTUN)
  62
  63 #define _ALL_REQUIRES_MASK      (\
  64     RPMSENSE_INTERP | \
  65     RPMSENSE_SCRIPT_PRE | \
  66     RPMSENSE_SCRIPT_POST | \
  67     RPMSENSE_SCRIPT_PREUN | \
  68     RPMSENSE_SCRIPT_POSTUN | \
  69     RPMSENSE_SCRIPT_VERIFY | \
  70     RPMSENSE_FIND_REQUIRES | \
  71     RPMSENSE_RPMLIB | \
  72     RPMSENSE_KEYRING | \
  73     RPMSENSE_PRETRANS | \
  74     RPMSENSE_POSTTRANS | \
  75     RPMSENSE_PREREQ | \
  76     RPMSENSE_MISSINGOK | \
  77     RPMSENSE_STRONG)
  78
  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)
  84
  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)
  88
  89 /** \ingroup rpmds
  90  * Reference a dependency set instance.
  91  * @param ds            dependency set
  92  * @return              new dependency set reference
  93  */
  94 rpmds rpmdsLink(rpmds ds);
  95
  96 /** \ingroup rpmds
  97  * Destroy a dependency set.
  98  * @param ds            dependency set
  99  * @return              NULL always
 100  */
 101 rpmds rpmdsFree(rpmds ds);
 102
 103 /** \ingroup rpmds
 104  * Create and load a dependency set.
 105  * @param h             header
 106  * @param tagN          type of dependency
 107  * @param flags         unused
 108  * @return              new dependency set
 109  */
 110 rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
 111
 112 /** \ingroup rpmds
 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)
 117  */
 118 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 119
 120 /** \ingroup rpmds
 121  * Create, load and initialize a dependency for this header.
 122  * @param h             header
 123  * @param tagN          type of dependency
 124  * @param Flags         comparison flags
 125  * @return              new dependency set
 126  */
 127 rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
 128
 129 /** \ingroup rpmds
 130  * Create, load and initialize a dependency set of size 1.
 131  * @param tagN          type of dependency
 132  * @param N             name
 133  * @param EVR           epoch:version-release
 134  * @param Flags         comparison flags
 135  * @return              new dependency set
 136  */
 137 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 138
 139 /** \ingroup rpmds
 140  * Return a new dependency set of size 1 from the current iteration index
 141  * @param ds            dependency set
 142  * @return              new dependency set
 143  */
 144 rpmds rpmdsCurrent(rpmds ds);
 145
 146 /** \ingroup rpmds
 147  * Return dependency set count.
 148  * @param ds            dependency set
 149  * @return              current count
 150  */
 151 int rpmdsCount(const rpmds ds);
 152
 153 /** \ingroup rpmds
 154  * Return dependency set index.
 155  * @param ds            dependency set
 156  * @return              current index
 157  */
 158 int rpmdsIx(const rpmds ds);
 159
 160 /** \ingroup rpmds
 161  * Set dependency set index.
 162  * @param ds            dependency set
 163  * @param ix            new index
 164  * @return              current index
 165  */
 166 int rpmdsSetIx(rpmds ds, int ix);
 167
 168 /** \ingroup rpmds
 169  * Return current formatted dependency string.
 170  * @param ds            dependency set
 171  * @return              current dependency DNEVR, NULL on invalid
 172  */
 173 const char * rpmdsDNEVR(const rpmds ds);
 174
 175 /** \ingroup rpmds
 176  * Return current dependency name.
 177  * @param ds            dependency set
 178  * @return              current dependency name, NULL on invalid
 179  */
 180 const char * rpmdsN(const rpmds ds);
 181
 182 /** \ingroup rpmds
 183  * Return current dependency epoch-version-release.
 184  * @param ds            dependency set
 185  * @return              current dependency EVR, NULL on invalid
 186  */
 187 const char * rpmdsEVR(const rpmds ds);
 188
 189 /** \ingroup rpmds
 190  * Return current dependency flags.
 191  * @param ds            dependency set
 192  * @return              current dependency flags, 0 on invalid
 193  */
 194 rpmsenseFlags rpmdsFlags(const rpmds ds);
 195
 196 /** \ingroup rpmds
 197  * Return current dependency type.
 198  * @param ds            dependency set
 199  * @return              current dependency type, 0 on invalid
 200  */
 201 rpmTagVal rpmdsTagN(const rpmds ds);
 202
 203 /** \ingroup rpmds
 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)
 208  */
 209 unsigned int rpmdsInstance(rpmds ds);
 210
 211 /** \ingroup rpmds
 212  * Return current "Don't promote Epoch:" flag.
 213  *
 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.
 220  *
 221  * @param ds            dependency set
 222  * @return              current "Don't promote Epoch:" flag
 223  */
 224 int rpmdsNoPromote(const rpmds ds);
 225
 226 /** \ingroup rpmds
 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
 231  */
 232 int rpmdsSetNoPromote(rpmds ds, int nopromote);
 233
 234 /** \ingroup rpmds
 235  * Return current dependency color.
 236  * @param ds            dependency set
 237  * @return              current dependency color
 238  */
 239 rpm_color_t rpmdsColor(const rpmds ds);
 240
 241 /** \ingroup rpmds
 242  * Return current dependency color.
 243  * @param ds            dependency set
 244  * @param color         new dependency color
 245  * @return              previous dependency color
 246  */
 247 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
 248
 249 /** \ingroup rpmds
 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
 254  */
 255 /* FIX: rpmMessage annotation is a lie */
 256 void rpmdsNotify(rpmds ds, const char * where, int rc);
 257
 258 /** \ingroup rpmds
 259  * Return next dependency set iterator index.
 260  * @param ds            dependency set
 261  * @return              dependency set iterator index, -1 on termination
 262  */
 263 int rpmdsNext(rpmds ds);
 264
 265 /** \ingroup rpmds
 266  * Initialize dependency set iterator.
 267  * @param ds            dependency set
 268  * @return              dependency set
 269  */
 270 rpmds rpmdsInit(rpmds ds);
 271
 272 /** \ingroup rpmds
 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)
 277  */
 278 int rpmdsFind(rpmds ds, const rpmds ods);
 279
 280 /** \ingroup rpmds
 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
 285  */
 286 int rpmdsMerge(rpmds * dsp, rpmds ods);
 287
 288 /** \ingroup rpmds
 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)
 295  **/
 296 int rpmdsSearch(rpmds ds, rpmds ods);
 297
 298 /** \ingroup rpmds
 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
 303  */
 304 int rpmdsCompare(const rpmds A, const rpmds B);
 305
 306 /** \ingroup rpmds
 307  * Compare package provides dependencies from header with a single dependency.
 308  * @param h             header
 309  * @param req           dependency set
 310  * @param nopromote     Don't promote Epoch: in comparison?
 311  * @return              1 if any dependency overlaps, 0 otherwise
 312  */
 313 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 314
 315 /** \ingroup rpmds
 316  * Compare package provides dependencies from header with a single dependency.
 317  * @param h             header
 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
 322  */
 323 int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
 324
 325 /** \ingroup rpmds
 326  * Compare package name-version-release from header with a single dependency.
 327  * @param h             header
 328  * @param req           dependency set
 329  * @param nopromote     Don't promote Epoch: in comparison?
 330  * @return              1 if dependency overlaps, 0 otherwise
 331  */
 332 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
 333
 334 /**
 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
 339  */
 340 int rpmdsRpmlib(rpmds * dsp, const void * tblp);
 341
 342 #ifdef __cplusplus
 343 }
 344 #endif
 345
 346 #endif  /* H_RPMDS */