zypp/ResObject.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file       zypp/ResObject.h
  10  *
  11 */
  12 #ifndef ZYPP_RESOBJECT_H
  13 #define ZYPP_RESOBJECT_H
  14
  15 #include "zypp/APIConfig.h"
  16
  17 #include "zypp/Resolvable.h"
  18 #include "zypp/Date.h"
  19 #include "zypp/Locale.h"
  20 #include "zypp/Vendor.h"
  21 #include "zypp/ByteCount.h"
  22 #include "zypp/DiskUsage.h"
  23 #include "zypp/OnMediaLocation.h"
  24 #include "zypp/Repository.h"
  25
  26 #include "zypp/sat/LookupAttr.h"
  27 #include "zypp/sat/SolvableSet.h"
  28
  29 ///////////////////////////////////////////////////////////////////
  30 namespace zypp
  31 { /////////////////////////////////////////////////////////////////
  32
  33   ///////////////////////////////////////////////////////////////////
  34   //
  35   //    CLASS NAME : ResObject
  36   //
  37   /**
  38    * Interface base for resolvable objects (common data).
  39    * That is, all data not needed for solving, but common
  40    * across all Resolvable kinds.
  41    *
  42    * \see \ref makeResObject for how to construct ResObjects.
  43   */
  44   class ResObject : public Resolvable
  45   {
  46   public:
  47     typedef ResObject                Self;
  48     typedef ResTraits<Self>          TraitsType;
  49     typedef TraitsType::PtrType      Ptr;
  50     typedef TraitsType::constPtrType constPtr;
  51
  52   public:
  53
  54     /** Convert \c this into a Ptr of a certain Kind.
  55      * This is a convenience to access type specific
  56      * attributes.
  57      * \return \c NULL if \c this is not of the specified kind.
  58      * \code
  59      *  PoolItem pi;
  60      *  Package::constPtr pkg = pi->asKind<Package>();
  61      *
  62      *  if ( pi->isKind<Package>() )
  63      *     DBG << pi->asKind<Package>()->keywords() << endl;
  64      * \endcode
  65      */
  66     template<class _Res>
  67     inline typename ResTraits<_Res>::constPtrType asKind() const;
  68
  69     template<class _Res>
  70     inline typename ResTraits<_Res>::PtrType asKind();
  71
  72   public:
  73     /** \name Locale support.
  74      * \see \ref sat::Solvable
  75      */
  76     //@{
  77     /** \see \ref sat::Solvable::supportsLocales */
  78     bool supportsLocales() const
  79     { return sat::Solvable::supportsLocales(); }
  80
  81     /** \see \ref sat::Solvable::supportsLocale */
  82     bool supportsLocale( const Locale & locale_r ) const
  83     { return sat::Solvable::supportsLocale( locale_r ); }
  84
  85     bool supportsLocale( const LocaleSet & locales_r ) const
  86     { return sat::Solvable::supportsLocale( locales_r ); }
  87
  88     /** \see \ref sat::Solvable::supportsRequestedLocales */
  89     bool supportsRequestedLocales() const
  90     { return sat::Solvable::supportsRequestedLocales(); }
  91
  92     /** \see \ref sat::Solvable::getSupportedLocales */
  93     LocaleSet getSupportedLocales() const
  94     { return sat::Solvable::getSupportedLocales(); }
  95     //@}
  96
  97   public:
  98     /**
  99      * \short Short text describing the resolvable.
 100      * This attribute is usually displayed in columns.
 101      */
 102     std::string summary( const Locale & lang_r = Locale() ) const;
 103
 104     /**
 105      * \short Long text describing the resolvable.
 106      */
 107     std::string description( const Locale & lang_r = Locale() ) const;
 108
 109     /**
 110      * \short Installation Notification
 111      *
 112      * This text can be used to tell the user some notes
 113      * When he selects the resovable for installation.
 114      */
 115     std::string insnotify( const Locale & lang_r = Locale() ) const;
 116
 117     /**
 118      * \short De-Installation Notification
 119      *
 120      * This text can be used to tell the user some notes
 121      * When he selects the resovable for deinstall.
 122      */
 123     std::string delnotify( const Locale & lang_r = Locale() ) const;
 124
 125     /**
 126      * \short License or agreement to accept
 127      *
 128      * Agreement, warning or license the user should
 129      * accept before installing the resolvable.
 130      */
 131     std::string licenseToConfirm( const Locale & lang_r = Locale() ) const;
 132
 133    /**
 134      * \short Acceptance of Product License needed?
 135      *
 136      * Returns whether a product license has to be accepted
 137      * (no acceptance is needed for openSUSE)
 138      */
 139     bool needToAcceptLicense() const;
 140
 141     /**
 142      * \short Vendor
 143      *
 144      * For example "Novell Inc."
 145      */
 146     Vendor vendor() const
 147     { return Resolvable::vendor().asString(); }
 148
 149     /** The distribution string.
 150      * E.g. \c code-11.
 151     */
 152     std::string distribution() const;
 153
 154     /**
 155      * The Common Platform Enumeration name
 156      * for this product.
 157      *
 158      * See http://cpe.mitre.org
 159      */
 160     std::string cpeId() const;
 161
 162     /** Installed size. */
 163     ByteCount installSize() const;
 164
 165     /** Size of the rpm package. */
 166     ByteCount downloadSize() const;
 167
 168     /** \see \ref sat::Solvable::repository */
 169     Repository repository() const
 170     { return sat::Solvable::repository(); }
 171
 172      /** \ref RepoInfo associated with the repository
 173       *  providing this resolvable.
 174       */
 175     RepoInfo repoInfo() const
 176     { return repository().info(); }
 177
 178     /**
 179      * Media number where the resolvable is located
 180      * 0 if no media access is required.
 181      */
 182     unsigned mediaNr() const;
 183
 184     /**
 185      * \short build time of the resolvable
 186      */
 187     Date buildtime() const;
 188
 189     /**
 190      * \short Installation time
 191      * 0 if the resolvable is not installed.
 192      */
 193     Date installtime() const;
 194
 195     /**
 196      * \short Disk usage per directory
 197      * A common attribute, although mostly packages require
 198      * noticeable disk space. An e.g product could try to reserve
 199      * a certain ammount of diskspace by providing DiskUsage data.
 200      */
 201     const DiskUsage & diskusage() const;
 202
 203   protected:
 204     friend ResObject::Ptr makeResObject( const sat::Solvable & solvable_r );
 205     /** Ctor */
 206     ResObject( const sat::Solvable & solvable_r );
 207     /** Dtor */
 208     virtual ~ResObject();
 209     /** Helper for stream output */
 210     virtual std::ostream & dumpOn( std::ostream & str ) const;
 211   };
 212   ///////////////////////////////////////////////////////////////////
 213
 214   /** Create \ref ResObject from \ref sat::Solvable.
 215    *
 216    * This function creates the apropriate kind of ResObject
 217    * depending on the sat::Solvables kind, and returns a smart
 218    * pointer to it.
 219    *
 220    * If the sat::Solvables kind is not convertible, a NULL
 221    * pointer is returned.
 222    *
 223    * \code
 224    * sat::Solvable s;
 225    * ResObject::Ptr p( makeResObject( s ) );
 226    * ResObject::Ptr q( make<ResObject>( s ) );
 227    * Package::Ptr   pkg( make<Package>( s ) );
 228    * \endcode
 229   */
 230   ResObject::Ptr makeResObject( const sat::Solvable & solvable_r );
 231
 232   /** Directly create a certain kind of ResObject from \ref sat::Solvable.
 233    *
 234    * If the sat::Solvables kind is not appropriate, a NULL
 235    * pointer is returned.
 236     * \code
 237    * sat::Solvable s;
 238    * ResObject::Ptr p( makeResObject( s ) );
 239    * ResObject::Ptr q( make<ResObject>( s ) );
 240    * Package::Ptr   pkg( make<Package>( s ) );
 241    * \endcode
 242    * \todo make<> was a poor choice (AFAIR because gcc had some trouble with
 243    * asKind<>(sat::Solvable)). Remove it in favour of asKind<>(sat::Solvable)
 244   */
 245   template<class _Res>
 246   inline typename ResTraits<_Res>::PtrType make( const sat::Solvable & solvable_r )
 247   { return( isKind<_Res>( solvable_r ) ? new _Res( solvable_r ) : 0 ); }
 248   /** \overload Specialisation for ResObject autodetecting the kind of resolvable. */
 249   template<>
 250   inline ResObject::Ptr make<ResObject>( const sat::Solvable & solvable_r )
 251   { return makeResObject( solvable_r ); }
 252
 253   /** Directly create a certain kind of ResObject from \ref sat::Solvable. */
 254   template<class _Res>
 255   inline typename ResTraits<_Res>::PtrType asKind( const sat::Solvable & solvable_r )
 256   { return make<_Res>( solvable_r ); }
 257
 258   /** Convert ResObject::Ptr into Ptr of a certain Kind.
 259    * \return \c NULL iff \a p is \c NULL or points to a Resolvable
 260    * not of the specified Kind.
 261    * \relates ResObject
 262    * \code
 263    * asKind<Package>(resPtr);
 264    * \endcode
 265   */
 266   template<class _Res>
 267   inline typename ResTraits<_Res>::PtrType asKind( const ResObject::Ptr & p )
 268   { return dynamic_pointer_cast<_Res>(p); }
 269
 270   template<class _Res>
 271   inline typename ResTraits<_Res>::constPtrType asKind( const ResObject::constPtr & p )
 272   { return dynamic_pointer_cast<const _Res>(p); }
 273
 274   template<class _Res>
 275   inline typename ResTraits<_Res>::constPtrType ResObject::asKind() const
 276   { return dynamic_cast<const _Res *>( this ); }
 277
 278   template<class _Res>
 279   inline typename ResTraits<_Res>::PtrType ResObject::asKind()
 280   { return dynamic_cast<_Res *>( this ); }
 281
 282   /////////////////////////////////////////////////////////////////
 283 } // namespace zypp
 284 ///////////////////////////////////////////////////////////////////
 285 #endif // ZYPP_RESOBJECT_H