Annotate more methods with APT_OVERRIDE

[apt.git] / apt-pkg / metaindex.h

diff --git a/apt-pkg/metaindex.h b/apt-pkg/metaindex.h
index 5783735ff32e9925247c699438cdcc38ec423299..94aec2d1f0d79186b79bf4a45c7134b717778f76 100644 (file)
--- a/apt-pkg/metaindex.h
+++ b/apt-pkg/metaindex.h
@@ -1,57 +1,112 @@
 #ifndef PKGLIB_METAINDEX_H
 #define PKGLIB_METAINDEX_H
 
+#include <apt-pkg/indexfile.h>
+#include <apt-pkg/init.h>
+
+#include <stddef.h>
 
 #include <string>
-#include <apt-pkg/pkgcache.h>
-#include <apt-pkg/indexfile.h>
+#include <vector>
 
+#ifndef APT_10_CLEANER_HEADERS
+#include <apt-pkg/pkgcache.h>
+class pkgCacheGenerator;
+class OpProgress;
+#endif
 #ifndef APT_8_CLEANER_HEADERS
 #include <apt-pkg/srcrecords.h>
 #include <apt-pkg/pkgrecords.h>
-#include <apt-pkg/vendor.h>
 using std::string;
 #endif
 
 class pkgAcquire;
+class IndexTarget;
 class pkgCacheGenerator;
 class OpProgress;
 
 class metaIndex
 {
-   protected:
+public:
+   APT_IGNORE_DEPRECATED_PUSH
+   struct checkSum
+   {
+      std::string MetaKeyFilename;
+      HashStringList Hashes;
+      unsigned long long Size;
+
+      APT_DEPRECATED HashString Hash;
+   };
+   APT_IGNORE_DEPRECATED_POP
+
+   enum APT_HIDDEN TriState {
+      TRI_YES, TRI_DONTCARE, TRI_NO, TRI_UNSET
+   };
+private:
+   void * const d;
+protected:
    std::vector <pkgIndexFile *> *Indexes;
+   // parsed from the sources.list
    const char *Type;
    std::string URI;
    std::string Dist;
-   bool Trusted;
+   TriState Trusted;
+   std::string SignedBy;
 
-   public:
+   // parsed from a file
+   std::string Suite;
+   std::string Codename;
+   time_t Date;
+   time_t ValidUntil;
+   bool SupportsAcquireByHash;
+   std::map<std::string, checkSum *> Entries;
+   TriState LoadedSuccessfully;
 
-   
+public:
    // Various accessors
-   virtual std::string GetURI() const {return URI;}
-   virtual std::string GetDist() const {return Dist;}
-   virtual const char* GetType() const {return Type;}
+   std::string GetURI() const;
+   std::string GetDist() const;
+   const char* GetType() const;
+   TriState GetTrusted() const;
+   std::string GetSignedBy() const;
+
+   std::string GetCodename() const;
+   std::string GetSuite() const;
+   bool GetSupportsAcquireByHash() const;
+   time_t GetValidUntil() const;
+   time_t GetDate() const;
+
+   std::string GetExpectedDist() const;
+   bool CheckDist(std::string const &MaybeDist) const;
 
    // Interface for acquire
-   virtual std::string ArchiveURI(std::string const& /*File*/) const = 0;
-   virtual bool GetIndexes(pkgAcquire *Owner, bool const &GetAll=false) const = 0;
-   
-   virtual std::vector<pkgIndexFile *> *GetIndexFiles() = 0; 
+   virtual std::string Describe() const;
+   virtual std::string ArchiveURI(std::string const& File) const = 0;
+   virtual bool GetIndexes(pkgAcquire *Owner, bool const &GetAll=false) = 0;
+   virtual std::vector<IndexTarget> GetIndexTargets() const = 0;
+   virtual std::vector<pkgIndexFile *> *GetIndexFiles() = 0;
    virtual bool IsTrusted() const = 0;
+   virtual bool Load(std::string const &Filename, std::string * const ErrorText) = 0;
+   /** @return a new metaIndex object based on this one, but without information from #Load */
+   virtual metaIndex * UnloadedClone() const = 0;
+   // the given metaIndex is potentially invalid after this call and should be deleted
+   void swapLoad(metaIndex * const OldMetaIndex);
+
+   // Lookup functions for parsed Hashes
+   checkSum *Lookup(std::string const &MetaKey) const;
+   /** \brief tests if a checksum for this file is available */
+   bool Exists(std::string const &MetaKey) const;
+   std::vector<std::string> MetaKeys() const;
+   TriState GetLoadedSuccessfully() const;
+
+   // Interfaces for pkgCacheGen
+   virtual pkgCache::RlsFileIterator FindInCache(pkgCache &Cache, bool const ModifyCheck) const;
+   virtual bool Merge(pkgCacheGenerator &Gen,OpProgress *Prog) const;
+
 
-   metaIndex(std::string const &URI, std::string const &Dist, char const * const Type) :
-               Indexes(NULL), Type(Type), URI(URI), Dist(Dist) {
-   }
-
-   virtual ~metaIndex() {
-      if (Indexes == 0)
-        return;
-      for (std::vector<pkgIndexFile *>::iterator I = (*Indexes).begin(); I != (*Indexes).end(); ++I)
-        delete *I;
-      delete Indexes;
-   }
+   metaIndex(std::string const &URI, std::string const &Dist,
+             char const * const Type);
+   virtual ~metaIndex();
 };
 
 #endif