Update to 4.11.0.1
[platform/upstream/rpm.git] / lib / rpmds.h
index 6319e93..bceed00 100644 (file)
  * Structure(s) used for dependency tag sets.
  */
 
-/**
- */
-/*@-exportlocal@*/
-/*@unchecked@*/
-extern int _rpmds_debug;
-/*@=exportlocal@*/
+#include <time.h>
 
-#if defined(_RPMDS_INTERNAL)
-/**
- * A package dependency set.
- */
-struct rpmds_s {
-    int i;                     /*!< Element index. */
-
-/*@observer@*/
-    const char * Type;         /*!< Tag name. */
-/*@only@*/ /*@null@*/
-    const char * DNEVR;                /*!< Formatted dependency string. */
-
-    rpmTag tagN;               /*!< Header tag. */
-/*@refcounted@*/ /*@null@*/
-    Header h;                  /*!< Header for dependency set (or NULL) */
-
-/*@only@*/
-    const char ** N;           /*!< Name. */
-/*@only@*/
-    const char ** EVR;         /*!< Epoch-Version-Release. */
-/*@only@*/
-    int_32 * Flags;            /*!< Flags identifying context/comparison. */
-    rpmTagType Nt, EVRt, Ft;   /*!< Tag data types. */
-    int_32 Count;              /*!< No. of elements */
-/*@refs@*/ int nrefs;          /*!< Reference count. */
-};
-#endif /* _RPMDS_INTERNAL */
+#include <rpm/rpmtypes.h>
+#include <rpm/rpmps.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * Unreference a dependency set instance.
- * @param ds           dependency set
- * @param msg
- * @return             NULL always
  */
-/*@unused@*/ /*@null@*/
-rpmds rpmdsUnlink (/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds,
-               /*@null@*/ const char * msg)
-       /*@modifies ds @*/;
+extern int _rpmds_nopromote;
 
-/** @todo Remove debugging entry from the ABI. */
-/*@-exportlocal@*/
-/*@null@*/
-rpmds XrpmdsUnlink (/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds,
-               /*@null@*/ const char * msg, const char * fn, unsigned ln)
-       /*@modifies ds @*/;
-/*@=exportlocal@*/
-#define        rpmdsUnlink(_ds, _msg)  XrpmdsUnlink(_ds, _msg, __FILE__, __LINE__)
+/** \ingroup rpmds
+ * Dependency Attributes.
+ */
+enum rpmsenseFlags_e {
+    RPMSENSE_ANY       = 0,
+    RPMSENSE_LESS      = (1 << 1),
+    RPMSENSE_GREATER   = (1 << 2),
+    RPMSENSE_EQUAL     = (1 << 3),
+    /* bit 4 unused */
+    RPMSENSE_POSTTRANS = (1 << 5),     /*!< %posttrans dependency */
+    RPMSENSE_PREREQ    = (1 << 6),     /* legacy prereq dependency */
+    RPMSENSE_PRETRANS  = (1 << 7),     /*!< Pre-transaction dependency. */
+    RPMSENSE_INTERP    = (1 << 8),     /*!< Interpreter used by scriptlet. */
+    RPMSENSE_SCRIPT_PRE        = (1 << 9),     /*!< %pre dependency. */
+    RPMSENSE_SCRIPT_POST = (1 << 10),  /*!< %post dependency. */
+    RPMSENSE_SCRIPT_PREUN = (1 << 11), /*!< %preun dependency. */
+    RPMSENSE_SCRIPT_POSTUN = (1 << 12), /*!< %postun dependency. */
+    RPMSENSE_SCRIPT_VERIFY = (1 << 13),        /*!< %verify dependency. */
+    RPMSENSE_FIND_REQUIRES = (1 << 14), /*!< find-requires generated dependency. */
+    RPMSENSE_FIND_PROVIDES = (1 << 15), /*!< find-provides generated dependency. */
+
+    RPMSENSE_TRIGGERIN = (1 << 16),    /*!< %triggerin dependency. */
+    RPMSENSE_TRIGGERUN = (1 << 17),    /*!< %triggerun dependency. */
+    RPMSENSE_TRIGGERPOSTUN = (1 << 18),        /*!< %triggerpostun dependency. */
+    RPMSENSE_MISSINGOK = (1 << 19),    /*!< suggests/enhances hint. */
+    /* bits 20-23 unused */
+    RPMSENSE_RPMLIB = (1 << 24),       /*!< rpmlib(feature) dependency. */
+    RPMSENSE_TRIGGERPREIN = (1 << 25), /*!< %triggerprein dependency. */
+    RPMSENSE_KEYRING   = (1 << 26),
+    RPMSENSE_STRONG     = (1 << 27),
+    RPMSENSE_CONFIG    = (1 << 28)
+};
 
-/**
+typedef rpmFlags rpmsenseFlags;
+
+#define        RPMSENSE_SENSEMASK      15       /* Mask to get senses, ie serial, */
+                                         /* less, greater, equal.          */
+
+#define        RPMSENSE_TRIGGER        \
+       (RPMSENSE_TRIGGERPREIN | RPMSENSE_TRIGGERIN | RPMSENSE_TRIGGERUN | RPMSENSE_TRIGGERPOSTUN)
+
+#define        _ALL_REQUIRES_MASK      (\
+    RPMSENSE_INTERP | \
+    RPMSENSE_SCRIPT_PRE | \
+    RPMSENSE_SCRIPT_POST | \
+    RPMSENSE_SCRIPT_PREUN | \
+    RPMSENSE_SCRIPT_POSTUN | \
+    RPMSENSE_SCRIPT_VERIFY | \
+    RPMSENSE_FIND_REQUIRES | \
+    RPMSENSE_RPMLIB | \
+    RPMSENSE_KEYRING | \
+    RPMSENSE_PRETRANS | \
+    RPMSENSE_POSTTRANS | \
+    RPMSENSE_PREREQ | \
+    RPMSENSE_MISSINGOK | \
+    RPMSENSE_STRONG)
+
+#define        _notpre(_x)             ((_x) & ~RPMSENSE_PREREQ)
+#define        _INSTALL_ONLY_MASK \
+    _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING|RPMSENSE_PRETRANS|RPMSENSE_POSTTRANS)
+#define        _ERASE_ONLY_MASK  \
+    _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
+
+#define        isLegacyPreReq(_x)  (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
+#define        isInstallPreReq(_x)     ((_x) & _INSTALL_ONLY_MASK)
+#define        isErasePreReq(_x)       ((_x) & _ERASE_ONLY_MASK)
+
+/** \ingroup rpmds
  * Reference a dependency set instance.
  * @param ds           dependency set
- * @param msg
  * @return             new dependency set reference
  */
-/*@unused@*/
-rpmds rpmdsLink (/*@null@*/ rpmds ds, /*@null@*/ const char * msg)
-       /*@modifies ds @*/;
-
-/** @todo Remove debugging entry from the ABI. */
-rpmds XrpmdsLink (/*@null@*/ rpmds ds, /*@null@*/ const char * msg,
-               const char * fn, unsigned ln)
-        /*@modifies ds @*/;
-#define        rpmdsLink(_ds, _msg)    XrpmdsLink(_ds, _msg, __FILE__, __LINE__)
+rpmds rpmdsLink(rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Destroy a dependency set.
  * @param ds           dependency set
  * @return             NULL always
  */
-/*@null@*/
-rpmds rpmdsFree(/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds)
-       /*@modifies ds@*/;
-/**
+rpmds rpmdsFree(rpmds ds);
+
+/** \ingroup rpmds
  * Create and load a dependency set.
  * @param h            header
  * @param tagN         type of dependency
- * @param scareMem     Use pointers to refcounted header memory?
+ * @param flags                unused
  * @return             new dependency set
  */
-/*@null@*/
-rpmds rpmdsNew(Header h, rpmTag tagN, int scareMem)
-       /*@modifies h @*/;
+rpmds rpmdsNew(Header h, rpmTagVal tagN, int flags);
 
-/**
+/** \ingroup rpmds
  * Return new formatted dependency string.
  * @param dspfx                formatted dependency string prefix
  * @param ds           dependency set
  * @return             new formatted dependency (malloc'ed)
  */
-/*@only@*/
-char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds)
-       /*@*/;
+char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Create, load and initialize a dependency for this header. 
  * @param h            header
  * @param tagN         type of dependency
  * @param Flags                comparison flags
  * @return             new dependency set
  */
-/*@null@*/
-rpmds rpmdsThis(Header h, rpmTag tagN, int_32 Flags)
-       /*@*/;
+rpmds rpmdsThis(Header h, rpmTagVal tagN, rpmsenseFlags Flags);
 
-/**
+/** \ingroup rpmds
  * Create, load and initialize a dependency set of size 1.
  * @param tagN         type of dependency
  * @param N            name
@@ -129,144 +134,210 @@ rpmds rpmdsThis(Header h, rpmTag tagN, int_32 Flags)
  * @param Flags                comparison flags
  * @return             new dependency set
  */
-/*@null@*/
-rpmds rpmdsSingle(rpmTag tagN, const char * N, const char * EVR, int_32 Flags)
-       /*@*/;
+rpmds rpmdsSingle(rpmTagVal tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 
-/**
+/** \ingroup rpmds
+ * Return a new dependency set of size 1 from the current iteration index
+ * @param ds           dependency set
+ * @return             new dependency set
+ */
+rpmds rpmdsCurrent(rpmds ds);
+
+/** \ingroup rpmds
  * Return dependency set count.
  * @param ds           dependency set
  * @return             current count
  */
-int rpmdsCount(/*@null@*/ const rpmds ds)
-       /*@*/;
+int rpmdsCount(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Return dependency set index.
  * @param ds           dependency set
  * @return             current index
  */
-int rpmdsIx(/*@null@*/ const rpmds ds)
-       /*@*/;
+int rpmdsIx(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Set dependency set index.
  * @param ds           dependency set
  * @param ix           new index
  * @return             current index
  */
-int rpmdsSetIx(/*@null@*/ rpmds ds, int ix)
-       /*@modifies ds @*/;
+int rpmdsSetIx(rpmds ds, int ix);
 
-/**
+/** \ingroup rpmds
  * Return current formatted dependency string.
  * @param ds           dependency set
  * @return             current dependency DNEVR, NULL on invalid
  */
-/*@observer@*/ /*@null@*/
-extern const char * rpmdsDNEVR(/*@null@*/ const rpmds ds)
-       /*@*/;
+const char * rpmdsDNEVR(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Return current dependency name.
  * @param ds           dependency set
  * @return             current dependency name, NULL on invalid
  */
-/*@observer@*/ /*@null@*/
-extern const char * rpmdsN(/*@null@*/ const rpmds ds)
-       /*@*/;
+const char * rpmdsN(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Return current dependency epoch-version-release.
  * @param ds           dependency set
  * @return             current dependency EVR, NULL on invalid
  */
-/*@observer@*/ /*@null@*/
-extern const char * rpmdsEVR(/*@null@*/ const rpmds ds)
-       /*@*/;
+const char * rpmdsEVR(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Return current dependency flags.
  * @param ds           dependency set
  * @return             current dependency flags, 0 on invalid
  */
-int_32 rpmdsFlags(/*@null@*/ const rpmds ds)
-       /*@*/;
+rpmsenseFlags rpmdsFlags(const rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Return current dependency type.
  * @param ds           dependency set
  * @return             current dependency type, 0 on invalid
  */
-rpmTag rpmdsTagN(/*@null@*/ const rpmds ds)
-       /*@*/;
+rpmTagVal rpmdsTagN(const rpmds ds);
 
-/**
+/** \ingroup rpmds
+ * Return dependency header instance, ie whether the dependency comes from 
+ * an installed header or not.
+ * @param ds           dependency set
+ * @return             header instance of dependency (0 for not installed)
+ */
+unsigned int rpmdsInstance(rpmds ds);
+
+/** \ingroup rpmds
+ * Return current "Don't promote Epoch:" flag.
+ *
+ * This flag controls for Epoch: promotion when a dependency set is
+ * compared. If the flag is set (for already installed packages), then
+ * an unspecified value will be treated as Epoch: 0. Otherwise (for added
+ * packages), the Epoch: portion of the comparison is skipped if the value
+ * is not specified, i.e. an unspecified Epoch: is assumed to be equal
+ * in dependency comparisons.
+ *
+ * @param ds           dependency set
+ * @return             current "Don't promote Epoch:" flag
+ */
+int rpmdsNoPromote(const rpmds ds);
+
+/** \ingroup rpmds
+ * Set "Don't promote Epoch:" flag.
+ * @param ds           dependency set
+ * @param nopromote    Should an unspecified Epoch: be treated as Epoch: 0?
+ * @return             previous "Don't promote Epoch:" flag
+ */
+int rpmdsSetNoPromote(rpmds ds, int nopromote);
+
+/** \ingroup rpmds
+ * Return current dependency color.
+ * @param ds           dependency set
+ * @return             current dependency color
+ */
+rpm_color_t rpmdsColor(const rpmds ds);
+
+/** \ingroup rpmds
+ * Return current dependency color.
+ * @param ds           dependency set
+ * @param color                new dependency color
+ * @return             previous dependency color
+ */
+rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
+
+/** \ingroup rpmds
  * Notify of results of dependency match.
  * @param ds           dependency set
  * @param where                where dependency was resolved (or NULL)
  * @param rc           0 == YES, otherwise NO
  */
-/*@-globuse@*/ /* FIX: rpmMessage annotation is a lie */
-void rpmdsNotify(/*@null@*/ rpmds ds, /*@null@*/ const char * where, int rc)
-       /*@globals fileSystem @*/
-       /*@modifies fileSystem @*/;
-/*@=globuse@*/
+/* FIX: rpmMessage annotation is a lie */
+void rpmdsNotify(rpmds ds, const char * where, int rc);
 
-/**
+/** \ingroup rpmds
  * Return next dependency set iterator index.
  * @param ds           dependency set
  * @return             dependency set iterator index, -1 on termination
  */
-int rpmdsNext(/*@null@*/ rpmds ds)
-       /*@modifies ds @*/;
+int rpmdsNext(rpmds ds);
 
-/**
+/** \ingroup rpmds
  * Initialize dependency set iterator.
  * @param ds           dependency set
  * @return             dependency set
  */
-/*@null@*/
-rpmds rpmdsInit(/*@null@*/ rpmds ds)
-       /*@modifies ds @*/;
+rpmds rpmdsInit(rpmds ds);
 
-/**
+/** \ingroup rpmds
+ * Find a dependency set element using binary search.
+ * @param ds           dependency set to search
+ * @param ods          dependency set element to find.
+ * @return             dependency index (or -1 if not found)
+ */
+int rpmdsFind(rpmds ds, const rpmds ods);
+
+/** \ingroup rpmds
+ * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
+ * @retval *dsp                (merged) dependency set
+ * @param ods          dependency set to merge
+ * @return             (merged) dependency index
+ */
+int rpmdsMerge(rpmds * dsp, rpmds ods);
+
+/** \ingroup rpmds
+ * Search a sorted dependency set for an element that overlaps.
+ * A boolean result is saved (if allocated) and accessible through
+ * rpmdsResult(ods) afterwards.
+ * @param ds            dependency set to search
+ * @param ods           dependency set element to find.
+ * @return              dependency index (or -1 if not found)
+ **/
+int rpmdsSearch(rpmds ds, rpmds ods);
+
+/** \ingroup rpmds
  * Compare two versioned dependency ranges, looking for overlap.
  * @param A            1st dependency
  * @param B            2nd dependency
  * @return             1 if dependencies overlap, 0 otherwise
  */
-int rpmdsCompare(const rpmds A, const rpmds B)
-       /*@*/;
+int rpmdsCompare(const rpmds A, const rpmds B);
 
-/**
- * Report a Requires: or Conflicts: dependency problem.
- * @param ps           transaction set problems
- * @param pkgNEVR      package name/epoch/version/release
- * @param ds           dependency set
- * @param suggestedKeys
+/** \ingroup rpmds
+ * Compare package provides dependencies from header with a single dependency.
+ * @param h            header
+ * @param req          dependency set
+ * @param nopromote    Don't promote Epoch: in comparison?
+ * @return             1 if any dependency overlaps, 0 otherwise
  */
-void rpmdsProblem(/*@null@*/ rpmps ps, const char * pkgNEVR, const rpmds ds,
-               /*@only@*/ /*@null@*/ const fnpyKey * suggestedKeys)
-       /*@modifies ps @*/;
+int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 
-/**
+/** \ingroup rpmds
  * Compare package provides dependencies from header with a single dependency.
  * @param h            header
+ * @param ix            index in header provides
  * @param req          dependency set
+ * @param nopromote    Don't promote Epoch: in comparison?
+ * @return             1 if any dependency overlaps, 0 otherwise
  */
-int rangeMatchesDepFlags (Header h, const rpmds req)
-        /*@modifies h @*/;
+int rpmdsMatchesDep (const Header h, int ix, const rpmds req, int nopromote);
 
-/**
+/** \ingroup rpmds
  * Compare package name-version-release from header with a single dependency.
- * @deprecated Remove from API when obsoletes is correctly implemented.
  * @param h            header
- * @param req          dependency
+ * @param req          dependency set
+ * @param nopromote    Don't promote Epoch: in comparison?
  * @return             1 if dependency overlaps, 0 otherwise
  */
-int headerMatchesDepFlags(const Header h, const rpmds req)
-       /*@*/;
+int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
+
+/**
+ * Load rpmlib provides into a dependency set.
+ * @retval *dsp                (loaded) depedency set
+ * @param tblp         rpmlib provides table (NULL uses internal table)
+ * @return             0 on success
+ */
+int rpmdsRpmlib(rpmds * dsp, const void * tblp);
 
 #ifdef __cplusplus
 }