zypp/ZYpp.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file       zypp/ZYpp.h
  10  *
  11 */
  12 #ifndef ZYPP_ZYPP_H
  13 #define ZYPP_ZYPP_H
  14
  15 #include <iosfwd>
  16
  17 #include "zypp/base/ReferenceCounted.h"
  18 #include "zypp/base/NonCopyable.h"
  19 #include "zypp/base/PtrTypes.h"
  20
  21 #include "zypp/base/Deprecated.h"
  22 #include "zypp/ZYppCommit.h"
  23
  24 #include "zypp/Target.h"
  25 #include "zypp/Resolver.h"
  26 #include "zypp/KeyRing.h"
  27 #include "zypp/DiskUsageCounter.h"
  28
  29 ///////////////////////////////////////////////////////////////////
  30 namespace zypp
  31 { /////////////////////////////////////////////////////////////////
  32
  33   namespace zypp_detail
  34   {
  35     class ZYppImpl;
  36   }
  37
  38   class ZYppFactory;
  39   class ResPool;
  40   class ResPoolProxy;
  41   class SourceFeed_Ref;
  42   class ResStore;
  43   class Locale;
  44   class KeyRing;
  45
  46   ///////////////////////////////////////////////////////////////////
  47   //
  48   //    CLASS NAME : ZYpp
  49   //
  50   /**
  51    * \todo define Exceptions
  52   */
  53   class ZYpp : public base::ReferenceCounted, private base::NonCopyable
  54   {
  55   public:
  56
  57     typedef intrusive_ptr<ZYpp>       Ptr;
  58     typedef intrusive_ptr<const ZYpp> constPtr;
  59
  60   public:
  61
  62     /** Pool of ResStatus for individual ResObjetcs. */
  63     ResPool pool() const;
  64
  65     /** Pool of ui::Selectable.
  66      * Based on the ResPool, ui::Selectable groups ResObjetcs of
  67      * same kind and name.
  68     */
  69     ResPoolProxy poolProxy() const;
  70
  71     /**  */
  72     //SourceFeed_Ref sourceFeed() const;
  73
  74     void addResolvables (const ResStore& store, bool installed = false);
  75
  76     void removeResolvables (const ResStore& store);
  77
  78     DiskUsageCounter::MountPointSet diskUsage();
  79
  80     void setPartitions(const DiskUsageCounter::MountPointSet &mp);
  81
  82   public:
  83     /**
  84      * \throws Exception
  85      */
  86     Target_Ptr target() const;
  87
  88     /**
  89      * \throws Exception
  90      * if commit_only == true, just init, don't populate store or pool
  91      */
  92     void initTarget(const Pathname & root, bool commit_only = false);
  93
  94     /**
  95      * \throws Exception
  96      */
  97     void finishTarget();
  98
  99
 100   public:
 101     typedef ZYppCommitResult CommitResult;
 102
 103     /** Commit changes and transactions.
 104      * \param \ref CommitPolicy
 105      * \return \ref CommitResult
 106      * \throws Exception
 107     */
 108     ZYppCommitResult commit( const ZYppCommitPolicy & policy_r );
 109
 110   public:
 111     /** */
 112     Resolver_Ptr resolver() const;
 113     KeyRing_Ptr keyRing() const;
 114   public:
 115     /** Set the preferd locale for translated labels, descriptions,
 116      *  etc. passed to the UI.
 117      */
 118     void setTextLocale( const Locale & textLocale_r );
 119     /** */
 120     Locale getTextLocale() const;
 121
 122   public:
 123     typedef std::set<Locale> LocaleSet;
 124     /** Set the requested locales.
 125      * Languages to be supported by the system, e.g. language specific
 126      * packages to be installed. This function operates on the pool,
 127      * so only the locales that are available as resolvables
 128      * are marked as requested. The rest is ignored.
 129     */
 130     void setRequestedLocales( const LocaleSet & locales_r );
 131     /** */
 132     LocaleSet getRequestedLocales() const;
 133
 134     /**
 135      * Get the set of available locales.
 136      * This is computed from the package data so it actually
 137      * represents all locales packages claim to support.
 138      */
 139     LocaleSet getAvailableLocales() const;
 140
 141     /**
 142      * internal use only
 143      **/
 144     void availableLocale( const Locale & locale_r );
 145
 146   public:
 147     /** Get the path where zypp related plugins store persistent data and caches   */
 148     Pathname homePath() const;
 149     /** set the home, if you need to change it */
 150     void setHomePath( const Pathname & path );
 151
 152     /** Get the system architecture.   */
 153     Arch architecture() const;
 154     /** Set the system architecture.
 155         This should be used for testing/debugging only since the Target backend
 156         won't be able to install incompatible packages ;-)   */
 157     void setArchitecture( const Arch & arch );
 158
 159   protected:
 160     /** Dtor */
 161     virtual ~ZYpp();
 162     /** Stream output */
 163     virtual std::ostream & dumpOn( std::ostream & str ) const;
 164   private:
 165     /** Factory */
 166     friend class ZYppFactory;
 167
 168     /** */
 169     typedef zypp_detail::ZYppImpl Impl;
 170     typedef shared_ptr<Impl>      Impl_Ptr;
 171     /** Factory ctor */
 172     explicit
 173     ZYpp( const Impl_Ptr & impl_r );
 174   private:
 175     /** Pointer to implementation */
 176     RW_pointer<Impl> _pimpl;
 177   };
 178   ///////////////////////////////////////////////////////////////////
 179
 180   /////////////////////////////////////////////////////////////////
 181 } // namespace zypp
 182 ///////////////////////////////////////////////////////////////////
 183 #endif // ZYPP_ZYPP_H