Imported Upstream version 14.45.0
[platform/upstream/libzypp.git] / zypp / ZYpp.h
index d97d0fc..f193f97 100644 (file)
 #include "zypp/base/ReferenceCounted.h"
 #include "zypp/base/NonCopyable.h"
 #include "zypp/base/PtrTypes.h"
+#include "zypp/APIConfig.h"
+
+#include "zypp/ZConfig.h"
+#include "zypp/ManagedFile.h"
+
+#include "zypp/ZYppCommit.h"
+#include "zypp/ResTraits.h"
+
 #include "zypp/Target.h"
 #include "zypp/Resolver.h"
+#include "zypp/KeyRing.h"
+#include "zypp/DiskUsageCounter.h"
 
 ///////////////////////////////////////////////////////////////////
 namespace zypp
@@ -32,14 +42,16 @@ namespace zypp
   class ZYppFactory;
   class ResPool;
   class ResPoolProxy;
-  class SourceFeed_Ref;
-  class ResStore;
+  class KeyRing;
 
   ///////////////////////////////////////////////////////////////////
   //
   //   CLASS NAME : ZYpp
   //
-  /** */
+  /**
+   * \todo define Exceptions
+   * ZYpp API main interface
+   */
   class ZYpp : public base::ReferenceCounted, private base::NonCopyable
   {
   public:
@@ -49,7 +61,10 @@ namespace zypp
 
   public:
 
-    /** Pool of ResStatus for individual ResObjetcs. */
+    /**
+     * Access to the global resolvable pool.
+     * Same as \ref zypp::ResPool::instance
+     */
     ResPool pool() const;
 
     /** Pool of ui::Selectable.
@@ -58,31 +73,71 @@ namespace zypp
     */
     ResPoolProxy poolProxy() const;
 
-    /**  */
-    //SourceFeed_Ref sourceFeed() const;
+    DiskUsageCounter::MountPointSet diskUsage();
 
-    void addResolvables (const ResStore& store, bool installed = false);
+    void setPartitions(const DiskUsageCounter::MountPointSet &mp);
 
-    void removeResolvables (const ResStore& store);
+    DiskUsageCounter::MountPointSet getPartitions() const;
 
+  public:
     /**
      * \throws Exception
      */
     Target_Ptr target() const;
 
+    /** Same as \ref target but returns NULL if target is not
+     *  initialized, instead of throwing.
+     */
+    Target_Ptr getTarget() const;
+
     /**
      * \throws Exception
-     * if commit_only == true, just init, don't populate store or pool
+     * Just init the target, dont populate store or pool.
+     * If \c doRebuild_r is \c true, an already existing
+     * database is rebuilt (rpm --rebuilddb ).
      */
-    void initTarget(const Pathname & root, bool commit_only = false);
+    void initializeTarget(const Pathname & root, bool doRebuild_r = false);
 
     /**
      * \throws Exception
      */
     void finishTarget();
 
+
+  public:
+    typedef ZYppCommitResult CommitResult;
+
+    /** Commit changes and transactions.
+     * \param \ref CommitPolicy
+     * \return \ref CommitResult
+     * \throws Exception
+    */
+    ZYppCommitResult commit( const ZYppCommitPolicy & policy_r );
+
+    /** Install a source package on the Target.
+     * \throws Exception
+     */
+    void installSrcPackage( const SrcPackage_constPtr & srcPackage_r );
+
+    /** Provides a source package on the Target.
+     * \throws Exception
+     */
+    ManagedFile provideSrcPackage( const SrcPackage_constPtr & srcPackage_r );
+
+  public:
     /** */
     Resolver_Ptr resolver() const;
+    KeyRing_Ptr keyRing() const;
+
+  public:
+    /** Get the path where zypp related plugins store persistent data and caches   */
+    Pathname homePath() const;
+
+    /** Get the path where zypp related plugins store temp data   */
+    Pathname tmpPath() const;
+
+    /** set the home, if you need to change it */
+    void setHomePath( const Pathname & path );
 
   protected:
     /** Dtor */
@@ -92,6 +147,7 @@ namespace zypp
   private:
     /** Factory */
     friend class ZYppFactory;
+
     /** */
     typedef zypp_detail::ZYppImpl Impl;
     typedef shared_ptr<Impl>      Impl_Ptr;