[4.0] Use strip (instead of eu-strip) to support --strip-debug of *.so at build time
[platform/upstream/rpm.git] / lib / rpmte.h
index f9d8fea..a66c1e9 100644 (file)
@@ -6,26 +6,13 @@
  * Structures used for an "rpmte" transaction element.
  */
 
-#include <rpmal.h>
+#include <rpm/rpmtypes.h>
+#include <rpm/argv.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/**
- */
-extern int _rpmte_debug;
-
-/**
- * Transaction element ordering chain linkage.
- */
-typedef struct tsortInfo_s *           tsortInfo;
-
-/**
- * Transaction element iterator.
- */
-typedef struct rpmtsi_s *              rpmtsi;
-
 /** \ingroup rpmte
  * Transaction element type.
  */
@@ -34,207 +21,102 @@ typedef enum rpmElementType_e {
     TR_REMOVED         = (1 << 1)      /*!< Package will be removed. */
 } rpmElementType;
 
-#if    defined(_RPMTE_INTERNAL)
-/** \ingroup rpmte
- * Dependncy ordering information.
- */
-struct tsortInfo_s {
-    union {
-       int     count;
-       rpmte   suc;
-    } tsi_u;
-#define        tsi_count       tsi_u.count
-#define        tsi_suc         tsi_u.suc
-    struct tsortInfo_s * tsi_next;
-    rpmte tsi_chain;
-    int                tsi_reqx;
-    int                tsi_qcnt;
-};
-
-/** \ingroup rpmte
- * A single package instance to be installed/removed atomically.
- */
-struct rpmte_s {
-    rpmElementType type;       /*!< Package disposition (installed/removed). */
-
-    Header h;                  /*!< Package header. */
-    const char * NEVR;         /*!< Package name-version-release. */
-    const char * NEVRA;                /*!< Package name-version-release.arch. */
-    const char * name;         /*!< Name: */
-    char * epoch;
-    char * version;            /*!< Version: */
-    char * release;            /*!< Release: */
-    const char * arch;         /*!< Architecture hint. */
-    const char * os;           /*!< Operating system hint. */
-    int archScore;             /*!< (TR_ADDED) Arch score. */
-    int osScore;               /*!< (TR_ADDED) Os score. */
-    int isSource;              /*!< (TR_ADDED) source rpm? */
-
-    rpmte parent;              /*!< Parent transaction element. */
-    int degree;                        /*!< No. of immediate children. */
-    int npreds;                        /*!< No. of predecessors. */
-    int tree;                  /*!< Tree index. */
-    int depth;                 /*!< Depth in dependency tree. */
-    int breadth;               /*!< Breadth in dependency tree. */
-    unsigned int db_instance;   /*!< Database Instance after add */
-    tsortInfo tsi;             /*!< Dependency ordering chains. */
-
-    rpmds this;                        /*!< This package's provided NEVR. */
-    rpmds provides;            /*!< Provides: dependencies. */
-    rpmds requires;            /*!< Requires: dependencies. */
-    rpmds conflicts;           /*!< Conflicts: dependencies. */
-    rpmds obsoletes;           /*!< Obsoletes: dependencies. */
-    rpmfi fi;                  /*!< File information. */
-
-    uint32_t color;            /*!< Color bit(s) from package dependencies. */
-    uint32_t pkgFileSize;      /*!< No. of bytes in package file (approx). */
-
-    fnpyKey key;               /*!< (TR_ADDED) Retrieval key. */
-    rpmRelocation * relocs;    /*!< (TR_ADDED) Payload file relocations. */
-    int nrelocs;               /*!< (TR_ADDED) No. of relocations. */
-    int autorelocatex;         /*!< (TR_ADDED) Auto relocation entry index. */
-    FD_t fd;                   /*!< (TR_ADDED) Payload file descriptor. */
-
-    union {
-       rpmalKey addedKey;
-       struct {
-           rpmalKey dependsOnKey;
-           int dboffset;
-       } removed;
-    } u;
-
-};
-
-/**
- * Iterator across transaction elements, forward on install, backward on erase.
- */
-struct rpmtsi_s {
-    rpmts ts;          /*!< transaction set. */
-    int reverse;       /*!< reversed traversal? */
-    int ocsave;                /*!< last returned iterator index. */
-    int oc;            /*!< iterator index. */
-};
-
-#endif /* _RPMTE_INTERNAL */
-
-/**
- * Destroy a transaction element.
- * @param te           transaction element
- * @return             NULL always
- */
-rpmte rpmteFree(rpmte te);
+typedef rpmFlags rpmElementTypes;
 
-/**
- * Create a transaction element.
- * @param ts           transaction set
- * @param h            header
- * @param type         TR_ADDED/TR_REMOVED
- * @param key          (TR_ADDED) package retrieval key (e.g. file name)
- * @param relocs       (TR_ADDED) package file relocations
- * @param dboffset     (TR_REMOVED) rpmdb instance
- * @param pkgKey       associated added package (if any)
- * @return             new transaction element
- */
-rpmte rpmteNew(const rpmts ts, Header h, rpmElementType type,
-               fnpyKey key,
-               rpmRelocation * relocs,
-               int dboffset,
-               rpmalKey pkgKey);
-
-/**
+/** \ingroup rpmte
  * Retrieve header from transaction element.
  * @param te           transaction element
- * @return             header
+ * @return             header (new reference)
  */
-extern Header rpmteHeader(rpmte te);
+Header rpmteHeader(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Save header into transaction element.
  * @param te           transaction element
  * @param h            header
  * @return             NULL always
  */
-extern Header rpmteSetHeader(rpmte te, Header h);
+Header rpmteSetHeader(rpmte te, Header h);
 
-/**
+/** \ingroup rpmte
  * Retrieve type of transaction element.
  * @param te           transaction element
  * @return             type
  */
 rpmElementType rpmteType(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve name string of transaction element.
  * @param te           transaction element
  * @return             name string
  */
-extern const char * rpmteN(rpmte te);
+const char * rpmteN(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve epoch string of transaction element.
  * @param te           transaction element
  * @return             epoch string
  */
-extern const char * rpmteE(rpmte te);
+const char * rpmteE(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve version string of transaction element.
  * @param te           transaction element
  * @return             version string
  */
-extern const char * rpmteV(rpmte te);
+const char * rpmteV(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve release string of transaction element.
  * @param te           transaction element
  * @return             release string
  */
-extern const char * rpmteR(rpmte te);
+const char * rpmteR(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve arch string of transaction element.
  * @param te           transaction element
  * @return             arch string
  */
-extern const char * rpmteA(rpmte te);
+const char * rpmteA(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve os string of transaction element.
  * @param te           transaction element
  * @return             os string
  */
-extern const char * rpmteO(rpmte te);
+const char * rpmteO(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve isSource attribute of transaction element.
  * @param te           transaction element
  * @return             isSource attribute
  */
-extern int rpmteIsSource(rpmte te);
+int rpmteIsSource(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve color bits of transaction element.
  * @param te           transaction element
  * @return             color bits
  */
-uint32_t rpmteColor(rpmte te);
+rpm_color_t rpmteColor(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Set color bits of transaction element.
  * @param te           transaction element
  * @param color                new color bits
  * @return             previous color bits
  */
-uint32_t rpmteSetColor(rpmte te, uint32_t color);
+rpm_color_t rpmteSetColor(rpmte te, rpm_color_t color);
 
-/**
+/** \ingroup rpmte
  * Retrieve last instance installed to the database.
  * @param te           transaction element
  * @return             last install instance.
  */
 unsigned int rpmteDBInstance(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Set last instance installed to the database.
  * @param te           transaction element
  * @param instance     Database instance of last install element.
@@ -242,82 +124,22 @@ unsigned int rpmteDBInstance(rpmte te);
  */
 void rpmteSetDBInstance(rpmte te, unsigned int instance);
 
-/**
+/** \ingroup rpmte
  * Retrieve size in bytes of package file.
  * @todo Signature header is estimated at 256b.
  * @param te           transaction element
  * @return             size in bytes of package file.
  */
-uint32_t rpmtePkgFileSize(rpmte te);
-
-/**
- * Retrieve dependency tree depth of transaction element.
- * @param te           transaction element
- * @return             depth
- */
-int rpmteDepth(rpmte te);
-
-/**
- * Set dependency tree depth of transaction element.
- * @param te           transaction element
- * @param ndepth       new depth
- * @return             previous depth
- */
-int rpmteSetDepth(rpmte te, int ndepth);
-
-/**
- * Retrieve dependency tree breadth of transaction element.
- * @param te           transaction element
- * @return             breadth
- */
-int rpmteBreadth(rpmte te);
+rpm_loff_t rpmtePkgFileSize(rpmte te);
 
-/**
- * Set dependency tree breadth of transaction element.
- * @param te           transaction element
- * @param nbreadth     new breadth
- * @return             previous breadth
- */
-int rpmteSetBreadth(rpmte te, int nbreadth);
-
-/**
- * Retrieve tsort no. of predecessors of transaction element.
- * @param te           transaction element
- * @return             no. of predecessors
- */
-int rpmteNpreds(rpmte te);
-
-/**
- * Set tsort no. of predecessors of transaction element.
- * @param te           transaction element
- * @param npreds       new no. of predecessors
- * @return             previous no. of predecessors
- */
-int rpmteSetNpreds(rpmte te, int npreds);
-
-/**
- * Retrieve tree index of transaction element.
- * @param te           transaction element
- * @return             tree index
- */
-int rpmteTree(rpmte te);
-
-/**
- * Set tree index of transaction element.
- * @param te           transaction element
- * @param ntree                new tree index
- * @return             previous tree index
- */
-int rpmteSetTree(rpmte te, int ntree);
-
-/**
+/** \ingroup rpmte
  * Retrieve parent transaction element.
  * @param te           transaction element
  * @return             parent transaction element
  */
 rpmte rpmteParent(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Set parent transaction element.
  * @param te           transaction element
  * @param pte          new parent transaction element
@@ -325,177 +147,113 @@ rpmte rpmteParent(rpmte te);
  */
 rpmte rpmteSetParent(rpmte te, rpmte pte);
 
-/**
- * Retrieve number of children of transaction element.
- * @param te           transaction element
- * @return             tree index
- */
-int rpmteDegree(rpmte te);
-
-/**
- * Set number of children of transaction element.
- * @param te           transaction element
- * @param ndegree      new number of children
- * @return             previous number of children
- */
-int rpmteSetDegree(rpmte te, int ndegree);
-
-/**
- * Retrieve tsort info for transaction element.
- * @param te           transaction element
- * @return             tsort info
- */
-tsortInfo rpmteTSI(rpmte te);
-
-/**
- * Destroy tsort info of transaction element.
+/** \ingroup rpmte
+ * Return problem set info of transaction element.
  * @param te           transaction element
+ * @return             problem set (or NULL if none)
  */
-void rpmteFreeTSI(rpmte te);
+rpmps rpmteProblems(rpmte te);
 
-/**
- * Initialize tsort info of transaction element.
+/** \ingroup rpmte
+ * Destroy problem set info of transaction element.
  * @param te           transaction element
  */
-void rpmteNewTSI(rpmte te);
+void rpmteCleanProblems(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Destroy dependency set info of transaction element.
  * @param te           transaction element
  */
 void rpmteCleanDS(rpmte te);
 
-/**
- * Retrieve pkgKey of TR_ADDED transaction element.
- * @param te           transaction element
- * @return             pkgKey
- */
-rpmalKey rpmteAddedKey(rpmte te);
-
-/**
- * Set pkgKey of TR_ADDED transaction element.
+/** \ingroup rpmte
+ * Set dependent element of TR_REMOVED transaction element.
  * @param te           transaction element
- * @param npkgKey      new pkgKey
- * @return             previous pkgKey
+ * @param depends       dependent transaction element
  */
-rpmalKey rpmteSetAddedKey(rpmte te,
-               rpmalKey npkgKey);
+void rpmteSetDependsOn(rpmte te, rpmte depends);
 
-/**
- * Retrieve dependent pkgKey of TR_REMOVED transaction element.
+/** \ingroup rpmte
+ * Retrieve dependent element of TR_REMOVED transaction element.
  * @param te           transaction element
- * @return             dependent pkgKey
+ * @return             dependent transaction element
  */
-rpmalKey rpmteDependsOnKey(rpmte te);
+rpmte rpmteDependsOn(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve rpmdb instance of TR_REMOVED transaction element.
  * @param te           transaction element
  * @return             rpmdb instance
  */
 int rpmteDBOffset(rpmte te);
 
-/**
- * Retrieve name-version-release string from transaction element.
+/** \ingroup rpmte
+ * Retrieve [epoch:]version-release string from transaction element.
  * @param te           transaction element
- * @return             name-version-release string
+ * @return             [epoch:]version-release string
  */
-extern const char * rpmteNEVR(rpmte te);
+const char * rpmteEVR(rpmte te);
 
-/**
- * Retrieve name-version-release.arch string from transaction element.
+/** \ingroup rpmte
+ * Retrieve name-[epoch:]version-release string from transaction element.
  * @param te           transaction element
- * @return             name-version-release.arch string
+ * @return             name-[epoch:]version-release string
  */
-extern const char * rpmteNEVRA(rpmte te);
+const char * rpmteNEVR(rpmte te);
 
-/**
- * Retrieve file handle from transaction element.
+/** \ingroup rpmte
+ * Retrieve name-[epoch:]version-release.arch string from transaction element.
  * @param te           transaction element
- * @return             file handle
+ * @return             name-[epoch:]version-release.arch string
  */
-FD_t rpmteFd(rpmte te);
+const char * rpmteNEVRA(rpmte te);
 
-/**
+/** \ingroup rpmte
  * Retrieve key from transaction element.
  * @param te           transaction element
  * @return             key
  */
 fnpyKey rpmteKey(rpmte te);
 
-/**
+/** \ingroup rpmte
+ * Return failure status of transaction element.
+ * If the element itself failed, this is 1, larger count means one of
+ * it's parents failed.
+ * @param te           transaction element
+ * @return             number of failures for this transaction element
+ */
+int rpmteFailed(rpmte te);
+
+/** \ingroup rpmte
  * Retrieve dependency tag set from transaction element.
  * @param te           transaction element
  * @param tag          dependency tag
  * @return             dependency tag set
  */
-rpmds rpmteDS(rpmte te, rpmTag tag);
+rpmds rpmteDS(rpmte te, rpmTagVal tag);
 
-/**
+/** \ingroup rpmte
  * Retrieve file info tag set from transaction element.
  * @param te           transaction element
- * @param tag          file info tag (RPMTAG_BASENAMES)
  * @return             file info tag set
  */
-rpmfi rpmteFI(rpmte te, rpmTag tag);
+rpmfi rpmteFI(rpmte te);
 
-/**
- * Calculate transaction element dependency colors/refs from file info.
+/** \ingroup rpmte
+ * Retrieve list of collections
  * @param te           transaction element
- * @param tag          dependency tag (RPMTAG_PROVIDENAME, RPMTAG_REQUIRENAME)
- */
-void rpmteColorDS(rpmte te, rpmTag tag);
-
-/**
- * Return transaction element index.
- * @param tsi          transaction element iterator
- * @return             transaction element index
+ * @return             list of collections
  */
-int rpmtsiOc(rpmtsi tsi);
+ARGV_const_t rpmteCollections(rpmte te);
 
-/**
- * Destroy transaction element iterator.
- * @param tsi          transaction element iterator
- * @return             NULL always
- */
-rpmtsi rpmtsiFree(rpmtsi tsi);
-
-/**
- * Destroy transaction element iterator.
- * @param tsi          transaction element iterator
- * @param fn
- * @param ln
- * @return             NULL always
- */
-rpmtsi XrpmtsiFree(rpmtsi tsi,
-               const char * fn, unsigned int ln);
-#define        rpmtsiFree(_tsi)        XrpmtsiFree(_tsi, __FILE__, __LINE__)
-
-/**
- * Create transaction element iterator.
- * @param ts           transaction set
- * @return             transaction element iterator
- */
-rpmtsi rpmtsiInit(rpmts ts);
-
-/**
- * Create transaction element iterator.
- * @param ts           transaction set
- * @param fn
- * @param ln
- * @return             transaction element iterator
+/** \ingroup rpmte
+ * Determine a transaction element is part of a collection
+ * @param te           transaction element
+ * @param collname     collection name
+ * @return             1 if collname is part of a collection, 0 if not
  */
-rpmtsi XrpmtsiInit(rpmts ts,
-               const char * fn, unsigned int ln);
-#define        rpmtsiInit(_ts)         XrpmtsiInit(_ts, __FILE__, __LINE__)
+int rpmteHasCollection(rpmte te, const char * collname);
 
-/**
- * Return next transaction element of type.
- * @param tsi          transaction element iterator
- * @param type         transaction element type selector (0 for any)
- * @return             next transaction element of type, NULL on termination
- */
-rpmte rpmtsiNext(rpmtsi tsi, rpmElementType type);
 
 #ifdef __cplusplus
 }