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     /* bit 27 unused */
  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
  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)
  83
  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)
  87
  88 /** \ingroup rpmds
  89  * Reference a dependency set instance.
  90  * @param ds            dependency set
  91  * @return              new dependency set reference
  92  */
  93 rpmds rpmdsLink(rpmds ds);
  94
  95 /** \ingroup rpmds
  96  * Destroy a dependency set.
  97  * @param ds            dependency set
  98  * @return              NULL always
  99  */
 100 rpmds rpmdsFree(rpmds ds);
 101 /** \ingroup rpmds
 102  * Create and load a dependency set.
 103  * @param h             header
 104  * @param tagN          type of dependency
 105  * @param flags         unused
 106  * @return              new dependency set
 107  */
 108 rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
 109
 110 /** \ingroup rpmds
 111  * Return new formatted dependency string.
 112  * @param dspfx         formatted dependency string prefix
 113  * @param ds            dependency set
 114  * @return              new formatted dependency (malloc'ed)
 115  */
 116 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 117
 118 /** \ingroup rpmds
 119  * Create, load and initialize a dependency for this header.
 120  * @param h             header
 121  * @param tagN          type of dependency
 122  * @param Flags         comparison flags
 123  * @return              new dependency set
 124  */
 125 rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
 126
 127 /** \ingroup rpmds
 128  * Create, load and initialize a dependency set of size 1.
 129  * @param tagN          type of dependency
 130  * @param N             name
 131  * @param EVR           epoch:version-release
 132  * @param Flags         comparison flags
 133  * @return              new dependency set
 134  */
 135 rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 136
 137 /** \ingroup rpmds
 138  * Return a new dependency set of size 1 from the current iteration index
 139  * @param ds            dependency set
 140  * @return              new dependency set
 141  */
 142 rpmds rpmdsCurrent(rpmds ds);
 143
 144 /** \ingroup rpmds
 145  * Return dependency set count.
 146  * @param ds            dependency set
 147  * @return              current count
 148  */
 149 int rpmdsCount(const rpmds ds);
 150
 151 /** \ingroup rpmds
 152  * Return dependency set index.
 153  * @param ds            dependency set
 154  * @return              current index
 155  */
 156 int rpmdsIx(const rpmds ds);
 157
 158 /** \ingroup rpmds
 159  * Set dependency set index.
 160  * @param ds            dependency set
 161  * @param ix            new index
 162  * @return              current index
 163  */
 164 int rpmdsSetIx(rpmds ds, int ix);
 165
 166 /** \ingroup rpmds
 167  * Return current formatted dependency string.
 168  * @param ds            dependency set
 169  * @return              current dependency DNEVR, NULL on invalid
 170  */
 171 const char * rpmdsDNEVR(const rpmds ds);
 172
 173 /** \ingroup rpmds
 174  * Return current dependency name.
 175  * @param ds            dependency set
 176  * @return              current dependency name, NULL on invalid
 177  */
 178 const char * rpmdsN(const rpmds ds);
 179
 180 /** \ingroup rpmds
 181  * Return current dependency epoch-version-release.
 182  * @param ds            dependency set
 183  * @return              current dependency EVR, NULL on invalid
 184  */
 185 const char * rpmdsEVR(const rpmds ds);
 186
 187 /** \ingroup rpmds
 188  * Return current dependency flags.
 189  * @param ds            dependency set
 190  * @return              current dependency flags, 0 on invalid
 191  */
 192 rpmsenseFlags rpmdsFlags(const rpmds ds);
 193
 194 /** \ingroup rpmds
 195  * Return current dependency type.
 196  * @param ds            dependency set
 197  * @return              current dependency type, 0 on invalid
 198  */
 199 rpmTagVal rpmdsTagN(const rpmds ds);
 200
 201 /** \ingroup rpmds
 202  * Return dependency header instance, ie whether the dependency comes from
 203  * an installed header or not.
 204  * @param ds            dependency set
 205  * @return              header instance of dependency (0 for not installed)
 206  */
 207 unsigned int rpmdsInstance(rpmds ds);
 208
 209 /** \ingroup rpmds
 210  * Return current "Don't promote Epoch:" flag.
 211  *
 212  * This flag controls for Epoch: promotion when a dependency set is
 213  * compared. If the flag is set (for already installed packages), then
 214  * an unspecified value will be treated as Epoch: 0. Otherwise (for added
 215  * packages), the Epoch: portion of the comparison is skipped if the value
 216  * is not specified, i.e. an unspecified Epoch: is assumed to be equal
 217  * in dependency comparisons.
 218  *
 219  * @param ds            dependency set
 220  * @return              current "Don't promote Epoch:" flag
 221  */
 222 int rpmdsNoPromote(const rpmds ds);
 223
 224 /** \ingroup rpmds
 225  * Set "Don't promote Epoch:" flag.
 226  * @param ds            dependency set
 227  * @param nopromote     Should an unspecified Epoch: be treated as Epoch: 0?
 228  * @return              previous "Don't promote Epoch:" flag
 229  */
 230 int rpmdsSetNoPromote(rpmds ds, int nopromote);
 231
 232 /** \ingroup rpmds
 233  * Return current dependency color.
 234  * @param ds            dependency set
 235  * @return              current dependency color
 236  */
 237 rpm_color_t rpmdsColor(const rpmds ds);
 238
 239 /** \ingroup rpmds
 240  * Return current dependency color.
 241  * @param ds            dependency set
 242  * @param color         new dependency color
 243  * @return              previous dependency color
 244  */
 245 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
 246
 247 /** \ingroup rpmds
 248  * Notify of results of dependency match.
 249  * @param ds            dependency set
 250  * @param where         where dependency was resolved (or NULL)
 251  * @param rc            0 == YES, otherwise NO
 252  */
 253 /* FIX: rpmMessage annotation is a lie */
 254 void rpmdsNotify(rpmds ds, const char * where, int rc);
 255
 256 /** \ingroup rpmds
 257  * Return next dependency set iterator index.
 258  * @param ds            dependency set
 259  * @return              dependency set iterator index, -1 on termination
 260  */
 261 int rpmdsNext(rpmds ds);
 262
 263 /** \ingroup rpmds
 264  * Initialize dependency set iterator.
 265  * @param ds            dependency set
 266  * @return              dependency set
 267  */
 268 rpmds rpmdsInit(rpmds ds);
 269
 270 /** \ingroup rpmds
 271  * Find a dependency set element using binary search.
 272  * @param ds            dependency set to search
 273  * @param ods           dependency set element to find.
 274  * @return              dependency index (or -1 if not found)
 275  */
 276 int rpmdsFind(rpmds ds, const rpmds ods);
 277
 278 /** \ingroup rpmds
 279  * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
 280  * @retval *dsp         (merged) dependency set
 281  * @param ods           dependency set to merge
 282  * @return              (merged) dependency index
 283  */
 284 int rpmdsMerge(rpmds * dsp, rpmds ods);
 285
 286 /** \ingroup rpmds
 287  * Search a sorted dependency set for an element that overlaps.
 288  * A boolean result is saved (if allocated) and accessible through
 289  * rpmdsResult(ods) afterwards.
 290  * @param ds            dependency set to search
 291  * @param ods           dependency set element to find.
 292  * @return              dependency index (or -1 if not found)
 293  **/
 294 int rpmdsSearch(rpmds ds, rpmds ods);
 295
 296 /** \ingroup rpmds
 297  * Compare two versioned dependency ranges, looking for overlap.
 298  * @param A             1st dependency
 299  * @param B             2nd dependency
 300  * @return              1 if dependencies overlap, 0 otherwise
 301  */
 302 int rpmdsCompare(const rpmds A, const rpmds B);
 303
 304 /** \ingroup rpmds
 305  * Compare package provides dependencies from header with a single dependency.
 306  * @param h             header
 307  * @param req           dependency set
 308  * @param nopromote     Don't promote Epoch: in comparison?
 309  * @return              1 if any dependency overlaps, 0 otherwise
 310  */
 311 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 312
 313 /** \ingroup rpmds
 314  * Compare package provides dependencies from header with a single dependency.
 315  * @param h             header
 316  * @param ix            index in header provides
 317  * @param req           dependency set
 318  * @param nopromote     Don't promote Epoch: in comparison?
 319  * @return              1 if any dependency overlaps, 0 otherwise
 320  */
 321 int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
 322
 323 /** \ingroup rpmds
 324  * Compare package name-version-release from header with a single dependency.
 325  * @param h             header
 326  * @param req           dependency set
 327  * @param nopromote     Don't promote Epoch: in comparison?
 328  * @return              1 if dependency overlaps, 0 otherwise
 329  */
 330 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
 331
 332 /**
 333  * Load rpmlib provides into a dependency set.
 334  * @retval *dsp         (loaded) depedency set
 335  * @param tblp          rpmlib provides table (NULL uses internal table)
 336  * @return              0 on success
 337  */
 338 int rpmdsRpmlib(rpmds * dsp, const void * tblp);
 339
 340 #ifdef __cplusplus
 341 }
 342 #endif
 343
 344 #endif  /* H_RPMDS */