]> git.saurik.com Git - apt.git/blobdiff - apt-pkg/cacheiterators.h
Fix typos in documentation (codespell)
[apt.git] / apt-pkg / cacheiterators.h
index f0b40dbb549627c16d85ef261a7ae4c2a9889ad3..ea6a4afba72b0eeb801deac9a4ba21c6d6badd32 100644 (file)
@@ -30,6 +30,9 @@
 #ifndef PKGLIB_CACHEITERATORS_H
 #define PKGLIB_CACHEITERATORS_H
 #include<iterator>
+
+#include<string.h>
+
 // abstract Iterator template                                          /*{{{*/
 /* This template provides the very basic iterator methods we
    need to have for doing some walk-over-the-cache magic */
@@ -43,7 +46,7 @@ template<typename Str, typename Itr> class pkgCache::Iterator :
         *  The implementation of this method should be pretty short
         *  as it will only return the Pointer into the mmap stored
         *  in the owner but the name of this pointer is different for
-        *  each stucture and we want to abstract here at least for the
+        *  each structure and we want to abstract here at least for the
         *  basic methods from the actual structure.
         *  \return Pointer to the first structure of this type
         */
@@ -73,6 +76,12 @@ template<typename Str, typename Itr> class pkgCache::Iterator :
        inline bool IsGood() const { return S && Owner && ! end();};
        inline unsigned long Index() const {return S - OwnerPointer();};
 
+       void ReMap(void const * const oldMap, void const * const newMap) {
+               if (Owner == 0 || S == 0)
+                       return;
+               S += (Str*)(newMap) - (Str*)(oldMap);
+       }
+
        // Constructors - look out for the variable assigning
        inline Iterator() : S(0), Owner(0) {};
        inline Iterator(pkgCache &Owner,Str *T = 0) : S(T), Owner(&Owner) {};
@@ -88,7 +97,7 @@ class pkgCache::GrpIterator: public Iterator<Group, GrpIterator> {
 
        protected:
        inline Group* OwnerPointer() const {
-               return Owner->GrpP;
+               return (Owner != 0) ? Owner->GrpP : 0;
        };
 
        public:
@@ -103,13 +112,16 @@ class pkgCache::GrpIterator: public Iterator<Group, GrpIterator> {
 
        inline const char *Name() const {return S->Name == 0?0:Owner->StrP + S->Name;};
        inline PkgIterator PackageList() const;
-       PkgIterator FindPkg(string Arch = "any");
+       PkgIterator FindPkg(std::string Arch = "any") const;
        /** \brief find the package with the "best" architecture
 
            The best architecture is either the "native" or the first
-           in the list of Architectures which is not an end-Pointer */
-       PkgIterator FindPreferredPkg();
-       PkgIterator NextPkg(PkgIterator const &Pkg);
+           in the list of Architectures which is not an end-Pointer
+
+           \param PreferNonVirtual tries to respond with a non-virtual package
+                  and only if this fails returns the best virtual package */
+       PkgIterator FindPreferredPkg(bool const &PreferNonVirtual = true) const;
+       PkgIterator NextPkg(PkgIterator const &Pkg) const;
 
        // Constructors
        inline GrpIterator(pkgCache &Owner, Group *Trg) : Iterator<Group, GrpIterator>(Owner, Trg), HashIndex(0) {
@@ -126,7 +138,7 @@ class pkgCache::PkgIterator: public Iterator<Package, PkgIterator> {
 
        protected:
        inline Package* OwnerPointer() const {
-               return Owner->PkgP;
+               return (Owner != 0) ? Owner->PkgP : 0;
        };
 
        public:
@@ -173,7 +185,7 @@ class pkgCache::PkgIterator: public Iterator<Package, PkgIterator> {
 class pkgCache::VerIterator : public Iterator<Version, VerIterator> {
        protected:
        inline Version* OwnerPointer() const {
-               return Owner->VerP;
+               return (Owner != 0) ? Owner->VerP : 0;
        };
 
        public:
@@ -183,20 +195,22 @@ class pkgCache::VerIterator : public Iterator<Version, VerIterator> {
 
        // Comparison
        int CompareVer(const VerIterator &B) const;
+       /** \brief compares two version and returns if they are similar
+
+           This method should be used to identify if two pseudo versions are
+           referring to the same "real" version */
+       inline bool SimilarVer(const VerIterator &B) const {
+               return (B.end() == false && S->Hash == B->Hash && strcmp(VerStr(), B.VerStr()) == 0);
+       };
 
        // Accessors
        inline const char *VerStr() const {return S->VerStr == 0?0:Owner->StrP + S->VerStr;};
        inline const char *Section() const {return S->Section == 0?0:Owner->StrP + S->Section;};
        inline const char *Arch() const {
-               if(S->MultiArch == pkgCache::Version::All)
+               if ((S->MultiArch & pkgCache::Version::All) == pkgCache::Version::All)
                        return "all";
                return S->ParentPkg == 0?0:Owner->StrP + ParentPkg()->Arch;
        };
-       inline const char *Arch(bool const pseudo) const {
-               if(pseudo == false)
-                       return Arch();
-               return S->ParentPkg == 0?0:Owner->StrP + ParentPkg()->Arch;
-       };
        inline PkgIterator ParentPkg() const {return PkgIterator(*Owner,Owner->PkgP + S->ParentPkg);};
 
        inline DescIterator DescriptionList() const;
@@ -206,10 +220,10 @@ class pkgCache::VerIterator : public Iterator<Version, VerIterator> {
        inline VerFileIterator FileList() const;
        bool Downloadable() const;
        inline const char *PriorityType() const {return Owner->Priority(S->Priority);};
-       string RelStr() const;
+       const char *MultiArchType() const;
+       std::string RelStr() const;
 
        bool Automatic() const;
-       bool Pseudo() const;
        VerFileIterator NewestFile() const;
 
        inline VerIterator(pkgCache &Owner,Version *Trg = 0) : Iterator<Version, VerIterator>(Owner, Trg) {
@@ -223,7 +237,7 @@ class pkgCache::VerIterator : public Iterator<Version, VerIterator> {
 class pkgCache::DescIterator : public Iterator<Description, DescIterator> {
        protected:
        inline Description* OwnerPointer() const {
-               return Owner->DescP;
+               return (Owner != 0) ? Owner->DescP : 0;
        };
 
        public:
@@ -252,7 +266,7 @@ class pkgCache::DepIterator : public Iterator<Dependency, DepIterator> {
 
        protected:
        inline Dependency* OwnerPointer() const {
-               return Owner->DepP;
+               return (Owner != 0) ? Owner->DepP : 0;
        };
 
        public:
@@ -263,17 +277,26 @@ class pkgCache::DepIterator : public Iterator<Dependency, DepIterator> {
 
        // Accessors
        inline const char *TargetVer() const {return S->Version == 0?0:Owner->StrP + S->Version;};
-       inline PkgIterator TargetPkg() {return PkgIterator(*Owner,Owner->PkgP + S->Package);};
-       inline PkgIterator SmartTargetPkg() {PkgIterator R(*Owner,0);SmartTargetPkg(R);return R;};
-       inline VerIterator ParentVer() {return VerIterator(*Owner,Owner->VerP + S->ParentVer);};
-       inline PkgIterator ParentPkg() {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[S->ParentVer].ParentPkg);};
-       inline bool Reverse() {return Type == DepRev;};
-       bool IsCritical();
+       inline PkgIterator TargetPkg() const {return PkgIterator(*Owner,Owner->PkgP + S->Package);};
+       inline PkgIterator SmartTargetPkg() const {PkgIterator R(*Owner,0);SmartTargetPkg(R);return R;};
+       inline VerIterator ParentVer() const {return VerIterator(*Owner,Owner->VerP + S->ParentVer);};
+       inline PkgIterator ParentPkg() const {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[S->ParentVer].ParentPkg);};
+       inline bool Reverse() const {return Type == DepRev;};
+       bool IsCritical() const;
+       bool IsNegative() const;
+       bool IsIgnorable(PrvIterator const &Prv) const;
+       bool IsIgnorable(PkgIterator const &Pkg) const;
+       bool IsMultiArchImplicit() const;
+       bool IsSatisfied(VerIterator const &Ver) const;
+       bool IsSatisfied(PrvIterator const &Prv) const;
        void GlobOr(DepIterator &Start,DepIterator &End);
-       Version **AllTargets();
-       bool SmartTargetPkg(PkgIterator &Result);
-       inline const char *CompType() {return Owner->CompType(S->CompareOp);};
-       inline const char *DepType() {return Owner->DepType(S->Type);};
+       Version **AllTargets() const;
+       bool SmartTargetPkg(PkgIterator &Result) const;
+       inline const char *CompType() const {return Owner->CompType(S->CompareOp);};
+       inline const char *DepType() const {return Owner->DepType(S->Type);};
+
+       //Nice printable representation
+       friend std::ostream& operator <<(std::ostream& out, DepIterator D);
 
        inline DepIterator(pkgCache &Owner, Dependency *Trg, Version* = 0) :
                Iterator<Dependency, DepIterator>(Owner, Trg), Type(DepVer) {
@@ -294,7 +317,7 @@ class pkgCache::PrvIterator : public Iterator<Provides, PrvIterator> {
 
        protected:
        inline Provides* OwnerPointer() const {
-               return Owner->ProvideP;
+               return (Owner != 0) ? Owner->ProvideP : 0;
        };
 
        public:
@@ -306,12 +329,13 @@ class pkgCache::PrvIterator : public Iterator<Provides, PrvIterator> {
        // Accessors
        inline const char *Name() const {return Owner->StrP + Owner->PkgP[S->ParentPkg].Name;};
        inline const char *ProvideVersion() const {return S->ProvideVersion == 0?0:Owner->StrP + S->ProvideVersion;};
-       inline PkgIterator ParentPkg() {return PkgIterator(*Owner,Owner->PkgP + S->ParentPkg);};
-       inline VerIterator OwnerVer() {return VerIterator(*Owner,Owner->VerP + S->Version);};
-       inline PkgIterator OwnerPkg() {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[S->Version].ParentPkg);};
+       inline PkgIterator ParentPkg() const {return PkgIterator(*Owner,Owner->PkgP + S->ParentPkg);};
+       inline VerIterator OwnerVer() const {return VerIterator(*Owner,Owner->VerP + S->Version);};
+       inline PkgIterator OwnerPkg() const {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[S->Version].ParentPkg);};
 
-       inline PrvIterator() : Iterator<Provides, PrvIterator>(), Type(PrvVer) {};
+       bool IsMultiArchImplicit() const;
 
+       inline PrvIterator() : Iterator<Provides, PrvIterator>(), Type(PrvVer) {};
        inline PrvIterator(pkgCache &Owner, Provides *Trg, Version*) :
                Iterator<Provides, PrvIterator>(Owner, Trg), Type(PrvVer) {
                if (S == 0)
@@ -328,7 +352,7 @@ class pkgCache::PrvIterator : public Iterator<Provides, PrvIterator> {
 class pkgCache::PkgFileIterator : public Iterator<PackageFile, PkgFileIterator> {
        protected:
        inline PackageFile* OwnerPointer() const {
-               return Owner->PkgFileP;
+               return (Owner != 0) ? Owner->PkgFileP : 0;
        };
 
        public:
@@ -349,7 +373,7 @@ class pkgCache::PkgFileIterator : public Iterator<PackageFile, PkgFileIterator>
        inline const char *IndexType() const {return S->IndexType == 0?0:Owner->StrP + S->IndexType;};
 
        bool IsOk();
-       string RelStr();
+       std::string RelStr();
 
        // Constructors
        inline PkgFileIterator() : Iterator<PackageFile, PkgFileIterator>() {};
@@ -361,7 +385,7 @@ class pkgCache::PkgFileIterator : public Iterator<PackageFile, PkgFileIterator>
 class pkgCache::VerFileIterator : public pkgCache::Iterator<VerFile, VerFileIterator> {
        protected:
        inline VerFile* OwnerPointer() const {
-               return Owner->VerFileP;
+               return (Owner != 0) ? Owner->VerFileP : 0;
        };
 
        public:
@@ -380,7 +404,7 @@ class pkgCache::VerFileIterator : public pkgCache::Iterator<VerFile, VerFileIter
 class pkgCache::DescFileIterator : public Iterator<DescFile, DescFileIterator> {
        protected:
        inline DescFile* OwnerPointer() const {
-               return Owner->DescFileP;
+               return (Owner != 0) ? Owner->DescFileP : 0;
        };
 
        public:
@@ -395,7 +419,7 @@ class pkgCache::DescFileIterator : public Iterator<DescFile, DescFileIterator> {
        inline DescFileIterator(pkgCache &Owner,DescFile *Trg) : Iterator<DescFile, DescFileIterator>(Owner, Trg) {};
 };
                                                                        /*}}}*/
-// Inlined Begin functions cant be in the class because of order problems /*{{{*/
+// Inlined Begin functions can't be in the class because of order problems /*{{{*/
 inline pkgCache::PkgIterator pkgCache::GrpIterator::PackageList() const
        {return PkgIterator(*Owner,Owner->PkgP + S->FirstPackage);};
 inline pkgCache::VerIterator pkgCache::PkgIterator::VersionList() const