packageversion.h

Go to the documentation of this file.

/*!\file packageversion.h
        \brief Declerations for PackageVersion.
        Should be included wherever PackageVersion is used.*/
        
#ifndef __PACKAGEVERSION_H__
#define __PACKAGEVERSION_H__

#include "package.h"
#include "pmstring.h"

//!A small class acting as a bitmask for masking on different archs.
/*!Essentially a bitmask with flags allowing you to
  set masked states on various archs.*/
class MaskedStates
{
        public:
                MaskedStates();                                         //!<Constructor.
                void Reset(MaskedStatus state);         //!<Reset all vars to provided value.
                
                long Alpha : 3;         //!<0..3 2 bit type.
                long Amd64 : 3;         //!<0..3 2 bit type.
                long Arm : 3;           //!<0..3 2 bit type.
                long Hppa : 3;          //!<0..3 2 bit type.
                long Ia64 : 3;          //!<0..3 2 bit type.
                long Mips : 3;          //!<0..3 2 bit type.
                long Ppc : 3;           //!<0..3 2 bit type.
                long Ppc64 : 3;         //!<0..3 2 bit type.
                long PpcMacOs : 3;      //!<0..3 2 bit type.
                long S390 : 3;          //!<0..3 2 bit type.
                long Sh : 3;            //!<0..3 2 bit type.
                long Sparc : 3;         //!<0..3 2 bit type.
                long X86 : 3;           //!<0..3 2 bit type.
};

/*!Keywords for packages, all obvious. Keep in this order to allow
  the check if(Keyword%2==0) to be true if keyword is unstable.*/
enum Keyword
{
        eAlphaUnstable,
        eAlphaStable,
        eAmd64Unstable,
        eAmd64Stable,
        eArmUnstable,
        eArmStable,
        eHppaUnstable,
        eHppaStable,
        eIa64Unstable,
        eIa64Stable,
        eMipsUnstable,
        eMipsStable,
        ePpcUnstable,
        ePpcStable,
        ePpc64Unstable,
        ePpc64Stable,
        ePpcMacOsUnstable,
        ePpcMacOsStable,
        eS390Unstable,
        eS390Stable,
        eShUnstable,
        eShStable,
        eSparcUnstable,
        eSparcStable,
        eX86Unstable,
        eX86Stable
};

//!PackageVersion is the class that represents a version of a Package.
/*!PackageVersion is the main "object" class in the api. It contains all the
  information we know about a package before it becomes installed and as such,
  is a heavily used class.*/
class PackageVersion : public Package
{
        public:
                PackageVersion();                                                       //!<Constructor.
                PackageVersion(PMString version);                       //!<Constructor with version.
                PackageVersion(const PackageVersion &copy);     //!<Copy constructor with PackageVersion.
                PackageVersion(const Package &copy);            //!<Copy constructor with Package.
                virtual ~PackageVersion();                                      //!<Destructor.
        
                bool operator== (const PackageVersion& param);  //!<Equality operator.
                bool operator!= (const PackageVersion& param);  //!<Non equality operator.
                bool operator== (const Package& param);                 //!<Equality operator - with Package.
                bool operator!= (const Package& param);                 //!<Non equality operator - with Package.
        
                virtual Dbt GetKey();                   //!<Returns DB Key.
                virtual Dbt GetData();                  //!<Returns DB Data.
                virtual void ReadData(Dbt data);//!<Reads DB Data.
                virtual void ReadKey(Dbt key);  //!<Reads DB Key.
        
                void ProcessMasking(PMString maskedString);     //!<Process the usual portage masking string.
                void CalculateSize();                                           //!<Open the versions digest file and calculate the size.
        
                bool IsHardmasked(Keyword keyword);                             //!<Returns true if is eHardMasked.
                bool IsUnstable(Keyword keyword);                               //!<Returns true if is eUnstable.
                bool IsStable(Keyword keyword);                                 //!<Returns true if is eStable.
                bool CheckVersionWithKeyword(Keyword keyword);  //!<Returns true if versionMaskedState complies with keyword.
        
                MaskedStates versionMaskedState;        //!<Version's masked state on different archs.
                PMString version;                                       //!<Version.
                PMString sourceUrl;                                     //!<Url for sources.
                PMString possibleVirtuals;                      //!<Possible virtuals this package provides, can be dependent on useflags.
                PMString slot;                                          //!<Slot version goes into.
                PMString licence;                                       //!<Licence.
                PMString compileDepend;                         //!<Compile time dependencies ( usual portage string format ).
                PMString runDepend;                                     //!<Run time dependencies ( usual portage string format ).
                PMString postDepend;                            //!<Post time dependencies ( usual portage string format ).
                int fileSize;                                           //!<Filesize needed to be downloaded for this version.
        
        protected:
};

#endif

---