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     /* bits 4-5 unused */
  31     RPMSENSE_PREREQ     = (1 << 6),     /* legacy prereq dependency */
  32     RPMSENSE_PRETRANS   = (1 << 7),     /*!< Pre-transaction dependency. */
  33     RPMSENSE_INTERP     = (1 << 8),     /*!< Interpreter used by scriptlet. */
  34     RPMSENSE_SCRIPT_PRE = (1 << 9),     /*!< %pre dependency. */
  35     RPMSENSE_SCRIPT_POST = (1 << 10),   /*!< %post dependency. */
  36     RPMSENSE_SCRIPT_PREUN = (1 << 11),  /*!< %preun dependency. */
  37     RPMSENSE_SCRIPT_POSTUN = (1 << 12), /*!< %postun dependency. */
  38     RPMSENSE_SCRIPT_VERIFY = (1 << 13), /*!< %verify dependency. */
  39     RPMSENSE_FIND_REQUIRES = (1 << 14), /*!< find-requires generated dependency. */
  40     RPMSENSE_FIND_PROVIDES = (1 << 15), /*!< find-provides generated dependency. */
  41
  42     RPMSENSE_TRIGGERIN  = (1 << 16),    /*!< %triggerin dependency. */
  43     RPMSENSE_TRIGGERUN  = (1 << 17),    /*!< %triggerun dependency. */
  44     RPMSENSE_TRIGGERPOSTUN = (1 << 18), /*!< %triggerpostun dependency. */
  45     RPMSENSE_MISSINGOK  = (1 << 19),    /*!< suggests/enhances hint. */
  46     /* bits 20-23 unused */
  47     RPMSENSE_RPMLIB = (1 << 24),        /*!< rpmlib(feature) dependency. */
  48     RPMSENSE_TRIGGERPREIN = (1 << 25),  /*!< %triggerprein dependency. */
  49     RPMSENSE_KEYRING    = (1 << 26),
  50     /* bit 27 unused */
  51     RPMSENSE_CONFIG     = (1 << 28)
  52 };
  53
  54 typedef rpmFlags rpmsenseFlags;
  55
  56 #define RPMSENSE_SENSEMASK      15       /* Mask to get senses, ie serial, */
  57                                          /* less, greater, equal.          */
  58
  59 #define RPMSENSE_TRIGGER        \
  60         (RPMSENSE_TRIGGERPREIN | RPMSENSE_TRIGGERIN | RPMSENSE_TRIGGERUN | RPMSENSE_TRIGGERPOSTUN)
  61
  62 #define _ALL_REQUIRES_MASK      (\
  63     RPMSENSE_INTERP | \
  64     RPMSENSE_SCRIPT_PRE | \
  65     RPMSENSE_SCRIPT_POST | \
  66     RPMSENSE_SCRIPT_PREUN | \
  67     RPMSENSE_SCRIPT_POSTUN | \
  68     RPMSENSE_SCRIPT_VERIFY | \
  69     RPMSENSE_FIND_REQUIRES | \
  70     RPMSENSE_RPMLIB | \
  71     RPMSENSE_KEYRING | \
  72     RPMSENSE_PRETRANS | \
  73     RPMSENSE_PREREQ)
  74
  75 #define _notpre(_x)             ((_x) & ~RPMSENSE_PREREQ)
  76 #define _INSTALL_ONLY_MASK \
  77     _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING|RPMSENSE_PRETRANS)
  78 #define _ERASE_ONLY_MASK  \
  79     _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
  80
  81 #define isLegacyPreReq(_x)  (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
  82 #define isInstallPreReq(_x)     ((_x) & _INSTALL_ONLY_MASK)
  83 #define isErasePreReq(_x)       ((_x) & _ERASE_ONLY_MASK)
  84
  85 /** \ingroup rpmds
  86  * Reference a dependency set instance.
  87  * @param ds            dependency set
  88  * @return              new dependency set reference
  89  */
  90 rpmds rpmdsLink(rpmds ds);
  91
  92 /** \ingroup rpmds
  93  * Destroy a dependency set.
  94  * @param ds            dependency set
  95  * @return              NULL always
  96  */
  97 rpmds rpmdsFree(rpmds ds);
  98 /** \ingroup rpmds
  99  * Create and load a dependency set.
 100  * @param h             header
 101  * @param tagN          type of dependency
 102  * @param flags         unused
 103  * @return              new dependency set
 104  */
 105 rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
 106
 107 /** \ingroup rpmds
 108  * Return new formatted dependency string.
 109  * @param dspfx         formatted dependency string prefix
 110  * @param ds            dependency set
 111  * @return              new formatted dependency (malloc'ed)
 112  */
 113 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 114
 115 /** \ingroup rpmds
 116  * Create, load and initialize a dependency for this header.
 117  * @param h             header
 118  * @param tagN          type of dependency
 119  * @param Flags         comparison flags
 120  * @return              new dependency set
 121  */
 122 rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
 123
 124 /** \ingroup rpmds
 125  * Create, load and initialize a dependency set of size 1.
 126  * @param tagN          type of dependency
 127  * @param N             name
 128  * @param EVR           epoch:version-release
 129  * @param Flags         comparison flags
 130  * @return              new dependency set
 131  */
 132 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 133
 134 /** \ingroup rpmds
 135  * Return a new dependency set of size 1 from the current iteration index
 136  * @param ds            dependency set
 137  * @return              new dependency set
 138  */
 139 rpmds rpmdsCurrent(rpmds ds);
 140
 141 /** \ingroup rpmds
 142  * Return dependency set count.
 143  * @param ds            dependency set
 144  * @return              current count
 145  */
 146 int rpmdsCount(const rpmds ds);
 147
 148 /** \ingroup rpmds
 149  * Return dependency set index.
 150  * @param ds            dependency set
 151  * @return              current index
 152  */
 153 int rpmdsIx(const rpmds ds);
 154
 155 /** \ingroup rpmds
 156  * Set dependency set index.
 157  * @param ds            dependency set
 158  * @param ix            new index
 159  * @return              current index
 160  */
 161 int rpmdsSetIx(rpmds ds, int ix);
 162
 163 /** \ingroup rpmds
 164  * Return current formatted dependency string.
 165  * @param ds            dependency set
 166  * @return              current dependency DNEVR, NULL on invalid
 167  */
 168 const char * rpmdsDNEVR(const rpmds ds);
 169
 170 /** \ingroup rpmds
 171  * Return current dependency name.
 172  * @param ds            dependency set
 173  * @return              current dependency name, NULL on invalid
 174  */
 175 const char * rpmdsN(const rpmds ds);
 176
 177 /** \ingroup rpmds
 178  * Return current dependency epoch-version-release.
 179  * @param ds            dependency set
 180  * @return              current dependency EVR, NULL on invalid
 181  */
 182 const char * rpmdsEVR(const rpmds ds);
 183
 184 /** \ingroup rpmds
 185  * Return current dependency flags.
 186  * @param ds            dependency set
 187  * @return              current dependency flags, 0 on invalid
 188  */
 189 rpmsenseFlags rpmdsFlags(const rpmds ds);
 190
 191 /** \ingroup rpmds
 192  * Return current dependency type.
 193  * @param ds            dependency set
 194  * @return              current dependency type, 0 on invalid
 195  */
 196 rpmTagVal rpmdsTagN(const rpmds ds);
 197
 198 /** \ingroup rpmds
 199  * Return dependency header instance, ie whether the dependency comes from
 200  * an installed header or not.
 201  * @param ds            dependency set
 202  * @return              header instance of dependency (0 for not installed)
 203  */
 204 unsigned int rpmdsInstance(rpmds ds);
 205
 206 /** \ingroup rpmds
 207  * Return current "Don't promote Epoch:" flag.
 208  *
 209  * This flag controls for Epoch: promotion when a dependency set is
 210  * compared. If the flag is set (for already installed packages), then
 211  * an unspecified value will be treated as Epoch: 0. Otherwise (for added
 212  * packages), the Epoch: portion of the comparison is skipped if the value
 213  * is not specified, i.e. an unspecified Epoch: is assumed to be equal
 214  * in dependency comparisons.
 215  *
 216  * @param ds            dependency set
 217  * @return              current "Don't promote Epoch:" flag
 218  */
 219 int rpmdsNoPromote(const rpmds ds);
 220
 221 /** \ingroup rpmds
 222  * Set "Don't promote Epoch:" flag.
 223  * @param ds            dependency set
 224  * @param nopromote     Should an unspecified Epoch: be treated as Epoch: 0?
 225  * @return              previous "Don't promote Epoch:" flag
 226  */
 227 int rpmdsSetNoPromote(rpmds ds, int nopromote);
 228
 229 /** \ingroup rpmds
 230  * Return current dependency color.
 231  * @param ds            dependency set
 232  * @return              current dependency color
 233  */
 234 rpm_color_t rpmdsColor(const rpmds ds);
 235
 236 /** \ingroup rpmds
 237  * Return current dependency color.
 238  * @param ds            dependency set
 239  * @param color         new dependency color
 240  * @return              previous dependency color
 241  */
 242 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
 243
 244 /** \ingroup rpmds
 245  * Notify of results of dependency match.
 246  * @param ds            dependency set
 247  * @param where         where dependency was resolved (or NULL)
 248  * @param rc            0 == YES, otherwise NO
 249  */
 250 /* FIX: rpmMessage annotation is a lie */
 251 void rpmdsNotify(rpmds ds, const char * where, int rc);
 252
 253 /** \ingroup rpmds
 254  * Return next dependency set iterator index.
 255  * @param ds            dependency set
 256  * @return              dependency set iterator index, -1 on termination
 257  */
 258 int rpmdsNext(rpmds ds);
 259
 260 /** \ingroup rpmds
 261  * Initialize dependency set iterator.
 262  * @param ds            dependency set
 263  * @return              dependency set
 264  */
 265 rpmds rpmdsInit(rpmds ds);
 266
 267 /** \ingroup rpmds
 268  * Find a dependency set element using binary search.
 269  * @param ds            dependency set to search
 270  * @param ods           dependency set element to find.
 271  * @return              dependency index (or -1 if not found)
 272  */
 273 int rpmdsFind(rpmds ds, const rpmds ods);
 274
 275 /** \ingroup rpmds
 276  * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
 277  * @retval *dsp         (merged) dependency set
 278  * @param ods           dependency set to merge
 279  * @return              (merged) dependency index
 280  */
 281 int rpmdsMerge(rpmds * dsp, rpmds ods);
 282
 283 /** \ingroup rpmds
 284  * Search a sorted dependency set for an element that overlaps.
 285  * A boolean result is saved (if allocated) and accessible through
 286  * rpmdsResult(ods) afterwards.
 287  * @param ds            dependency set to search
 288  * @param ods           dependency set element to find.
 289  * @return              dependency index (or -1 if not found)
 290  **/
 291 int rpmdsSearch(rpmds ds, rpmds ods);
 292
 293 /** \ingroup rpmds
 294  * Compare two versioned dependency ranges, looking for overlap.
 295  * @param A             1st dependency
 296  * @param B             2nd dependency
 297  * @return              1 if dependencies overlap, 0 otherwise
 298  */
 299 int rpmdsCompare(const rpmds A, const rpmds B);
 300
 301 /** \ingroup rpmds
 302  * Compare package provides dependencies from header with a single dependency.
 303  * @param h             header
 304  * @param req           dependency set
 305  * @param nopromote     Don't promote Epoch: in comparison?
 306  * @return              1 if any dependency overlaps, 0 otherwise
 307  */
 308 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 309
 310 /** \ingroup rpmds
 311  * Compare package name-version-release from header with a single dependency.
 312  * @param h             header
 313  * @param req           dependency set
 314  * @param nopromote     Don't promote Epoch: in comparison?
 315  * @return              1 if dependency overlaps, 0 otherwise
 316  */
 317 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
 318
 319 /**
 320  * Load rpmlib provides into a dependency set.
 321  * @retval *dsp         (loaded) depedency set
 322  * @param tblp          rpmlib provides table (NULL uses internal table)
 323  * @return              0 on success
 324  */
 325 int rpmdsRpmlib(rpmds * dsp, const void * tblp);
 326
 327 #ifdef __cplusplus
 328 }
 329 #endif
 330
 331 #endif  /* H_RPMDS */