Coverage: Do not print messages from gcov

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

diff --git a/apt-pkg/pkgcache.h b/apt-pkg/pkgcache.h
index e8a3e10645561bc03130ae0b39b924575f7640bd..91228f7133ac4196571e97ee690c568b57b92dd1 100644 (file)
--- a/apt-pkg/pkgcache.h
+++ b/apt-pkg/pkgcache.h
@@ -1,64 +1,141 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: pkgcache.h,v 1.25 2001/07/01 22:28:24 jgg Exp $
-/* ######################################################################
-   
-   Cache - Structure definitions for the cache file
-   
-   Please see doc/apt-pkg/cache.sgml for a more detailed description of 
-   this format. Also be sure to keep that file up-to-date!!
-   
+/**\file pkgcache.h
+   \brief pkgCache - Structure definitions for the cache file
+
+   The goal of the cache file is two fold:
+   Firstly to speed loading and processing of the package file array and
+   secondly to reduce memory consumption of the package file array.
+
+   The implementation is aimed at an environment with many primary package
+   files, for instance someone that has a Package file for their CD-ROM, a
+   Package file for the latest version of the distribution on the CD-ROM and a
+   package file for the development version. Always present is the information
+   contained in the status file which might be considered a separate package
+   file.
+
+   Please understand, this is designed as a <b>Cache file</b> it is not meant to be
+   used on any system other than the one it was created for. It is not meant to
+   be authoritative either, i.e. if a system crash or software failure occurs it
+   must be perfectly acceptable for the cache file to be in an inconsistent
+   state. Furthermore at any time the cache file may be erased without losing
+   any information.
+
+   Also the structures and storage layout is optimized for use by the APT
+   and may not be suitable for all purposes. However it should be possible
+   to extend it with associate cache files that contain other information.
+
+   To keep memory use down the cache file only contains often used fields and
+   fields that are inexpensive to store, the Package file has a full list of
+   fields. Also the client may assume that all items are perfectly valid and
+   need not perform checks against their correctness. Removal of information
+   from the cache is possible, but blanks will be left in the file, and
+   unused strings will also be present. The recommended implementation is to
+   simply rebuild the cache each time any of the data files change. It is
+   possible to add a new package file to the cache without any negative side
+   effects.
+
+   <b>Note on Pointer access</b>

    Clients should always use the CacheIterators classes for access to the
    Clients should always use the CacheIterators classes for access to the

-   cache. They provide a simple STL-like method for traversing the links
-   of the datastructure.
-   
-   See pkgcachegen.h for information about generating cache structures.
-   
-   ##################################################################### */
+   cache and the data in it. They also provide a simple STL-like method for
+   traversing the links of the datastructure.
+
+   Every item in every structure is stored as the index to that structure.
+   What this means is that once the files is mmaped every data access has to
+   go through a fix up stage to get a real memory pointer. This is done
+   by taking the index, multiplying it by the type size and then adding
+   it to the start address of the memory block. This sounds complex, but
+   in C it is a single array dereference. Because all items are aligned to
+   their size and indexes are stored as multiples of the size of the structure
+   the format is immediately portable to all possible architectures - BUT the
+   generated files are -NOT-.
+
+   This scheme allows code like this to be written:
+   <example>
+     void *Map = mmap(...);
+     Package *PkgList = (Package *)Map;
+     Header *Head = (Header *)Map;
+     char *Strings = (char *)Map;
+     cout << (Strings + PkgList[Head->HashTable[0]]->Name) << endl;
+   </example>
+   Notice the lack of casting or multiplication. The net result is to return
+   the name of the first package in the first hash bucket, without error
+   checks.
+
+   The generator uses allocation pools to group similarly sized structures in
+   large blocks to eliminate any alignment overhead. The generator also
+   assures that no structures overlap and all indexes are unique. Although
+   at first glance it may seem like there is the potential for two structures
+   to exist at the same point the generator never allows this to happen.
+   (See the discussion of free space pools)
+
+   See \ref pkgcachegen.h for more information about generating cache structures. */

                                                                        /*}}}*/
 #ifndef PKGLIB_PKGCACHE_H
 #define PKGLIB_PKGCACHE_H
 
                                                                        /*}}}*/
 #ifndef PKGLIB_PKGCACHE_H
 #define PKGLIB_PKGCACHE_H
 

+#include <apt-pkg/mmap.h>
+#include <apt-pkg/macros.h>

 
 #include <string>
 #include <time.h>
 
 #include <string>
 #include <time.h>

-#include <apt-pkg/mmap.h>
+#include <stdint.h>
+
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+#include <apt-pkg/string_view.h>
+#endif

 
 

+#ifndef APT_8_CLEANER_HEADERS

 using std::string;
 using std::string;

-    
+#endif
+
+// size of (potentially big) files like debs or the install size of them
+typedef uint64_t map_filesize_t;
+// storing file sizes of indexes, which are way below 4 GB for now
+typedef uint32_t map_filesize_small_t;
+// each package/group/dependency gets an id
+typedef uint32_t map_id_t;
+// some files get an id, too, but in far less absolute numbers
+typedef uint16_t map_fileid_t;
+// relative pointer from cache start
+typedef uint32_t map_pointer_t;
+// same as the previous, but documented to be to a string item
+typedef map_pointer_t map_stringitem_t;
+// we have only a small amount of flags for each item
+typedef uint8_t map_flags_t;
+typedef uint8_t map_number_t;
+

 class pkgVersioningSystem;
 class pkgCache                                                         /*{{{*/
 {
    public:
    // Cache element predeclarations
    struct Header;
 class pkgVersioningSystem;
 class pkgCache                                                         /*{{{*/
 {
    public:
    // Cache element predeclarations
    struct Header;

+   struct Group;

    struct Package;
    struct Package;

+   struct ReleaseFile;

    struct PackageFile;
    struct Version;
    struct Description;
    struct Provides;
    struct Dependency;
    struct PackageFile;
    struct Version;
    struct Description;
    struct Provides;
    struct Dependency;

+   struct DependencyData;

    struct StringItem;
    struct VerFile;
    struct DescFile;
    
    // Iterators
    struct StringItem;
    struct VerFile;
    struct DescFile;
    
    // Iterators

+   template<typename Str, typename Itr> class Iterator;
+   class GrpIterator;

    class PkgIterator;
    class VerIterator;
    class DescIterator;
    class DepIterator;
    class PrvIterator;
    class PkgIterator;
    class VerIterator;
    class DescIterator;
    class DepIterator;
    class PrvIterator;

+   class RlsFileIterator;

    class PkgFileIterator;
    class VerFileIterator;
    class DescFileIterator;
    class PkgFileIterator;
    class VerFileIterator;
    class DescFileIterator;

-   friend class PkgIterator;
-   friend class VerIterator;
-   friend class DescInterator;
-   friend class DepIterator;
-   friend class PrvIterator;
-   friend class PkgFileIterator;
-   friend class VerFileIterator;
-   friend class DescFileIterator;

    
    class Namespace;
    
    
    class Namespace;
    


@@ -71,13 +148,25 @@ class pkgCache                                                             /*{{{*/
    {
       enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
         Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8,Enhances=9};
    {
       enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
         Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8,Enhances=9};

-      enum DepCompareOp {Or=0x10,NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
-        Greater=0x4,Equals=0x5,NotEquals=0x6};
+      /** \brief available compare operators
+
+          The lower 4 bits are used to indicate what operator is being specified and
+          the upper 4 bits are flags. OR indicates that the next package is
+          or'd with the current package. */
+      enum DepCompareOp {NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
+        Greater=0x4,Equals=0x5,NotEquals=0x6,
+        Or=0x10, /*!< or'ed with the next dependency */
+        MultiArchImplicit=0x20, /*!< generated internally, not spelled out in the index */
+        ArchSpecific=0x40 /*!< was decorated with an explicit architecture in index */
+      };

    };
    
    struct State
    {
    };
    
    struct State
    {

-      enum VerPriority {Important=1,Required=2,Standard=3,Optional=4,Extra=5};
+      /** \brief priority of a package version
+
+          Zero is used for unparsable or absent Priority fields. */
+      enum VerPriority {Required=1,Important=2,Standard=3,Optional=4,Extra=5};

       enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
       enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
       enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,
       enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
       enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
       enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,


@@ -88,263 +177,643 @@ class pkgCache                                                           /*{{{*/
    struct Flag
    {
       enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
    struct Flag
    {
       enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};

-      enum PkgFFlags {NotSource=(1<<0),NotAutomatic=(1<<1)};
+      enum PkgFFlags {
+        NotSource=(1<<0), /*!< packages can't be fetched from here, e.g. dpkg/status file */
+        LocalSource=(1<<1), /*!< local sources can't and will not be verified by hashes */
+        NoPackages=(1<<2), /*!< the file includes no package records itself, but additions like Translations */
+      };
+      enum ReleaseFileFlags {
+        NotAutomatic=(1<<0), /*!< archive has a default pin of 1 */
+        ButAutomaticUpgrades=(1<<1), /*!< (together with the previous) archive has a default pin of 100 */
+      };
+      enum ProvidesFlags {
+        MultiArchImplicit=pkgCache::Dep::MultiArchImplicit, /*!< generated internally, not spelled out in the index */
+        ArchSpecific=pkgCache::Dep::ArchSpecific /*!< was decorated with an explicit architecture in index */
+      };

    };
    
    protected:
    
    // Memory mapped cache file
    };
    
    protected:
    
    // Memory mapped cache file

-   string CacheFile;
+   std::string CacheFile;

    MMap &Map;
    MMap &Map;

-
-   unsigned long sHash(const string &S) const;
-   unsigned long sHash(const char *S) const;
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+   APT_HIDDEN map_id_t sHash(APT::StringView S) const APT_PURE;
+#endif
+   map_id_t sHash(const std::string &S) const APT_PURE;
+   map_id_t sHash(const char *S) const APT_PURE;

    
    public:
    
    // Pointers to the arrays of items
    Header *HeaderP;
    
    public:
    
    // Pointers to the arrays of items
    Header *HeaderP;

+   Group *GrpP;

    Package *PkgP;
    VerFile *VerFileP;
    DescFile *DescFileP;
    Package *PkgP;
    VerFile *VerFileP;
    DescFile *DescFileP;

+   ReleaseFile *RlsFileP;

    PackageFile *PkgFileP;
    Version *VerP;
    Description *DescP;
    Provides *ProvideP;
    Dependency *DepP;
    PackageFile *PkgFileP;
    Version *VerP;
    Description *DescP;
    Provides *ProvideP;
    Dependency *DepP;

-   StringItem *StringItemP;
+   DependencyData *DepDataP;
+   APT_DEPRECATED_MSG("Not used anymore in cache generation and without a replacement") StringItem *StringItemP;

    char *StrP;
 
    char *StrP;
 

-   virtual bool ReMap();
-   inline bool Sync() {return Map.Sync();};
-   inline MMap &GetMap() {return Map;};
-   inline void *DataEnd() {return ((unsigned char *)Map.Data()) + Map.Size();};
+   virtual bool ReMap(bool const &Errorchecks = true);
+   inline bool Sync() {return Map.Sync();}
+   inline MMap &GetMap() {return Map;}
+   inline void *DataEnd() {return ((unsigned char *)Map.Data()) + Map.Size();}

       
    // String hashing function (512 range)
       
    // String hashing function (512 range)

-   inline unsigned long Hash(const string &S) const {return sHash(S);};
-   inline unsigned long Hash(const char *S) const {return sHash(S);};
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+   APT_HIDDEN inline map_id_t Hash(APT::StringView S) const {return sHash(S);}
+#endif
+   inline map_id_t Hash(const std::string &S) const {return sHash(S);}
+   inline map_id_t Hash(const char *S) const {return sHash(S);}
+
+   APT_HIDDEN uint32_t CacheHash();

 
 

-   // Usefull transformation things
-   const char *Priority(unsigned char Priority);
+   // Useful transformation things
+   static const char *Priority(unsigned char Priority);

    
    // Accessors
    
    // Accessors

-   PkgIterator FindPkg(const string &Name);
-   Header &Head() {return *HeaderP;};
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+   APT_HIDDEN GrpIterator FindGrp(APT::StringView Name);
+   APT_HIDDEN PkgIterator FindPkg(APT::StringView Name);
+   APT_HIDDEN PkgIterator FindPkg(APT::StringView Name, APT::StringView Arch);
+#endif
+
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+   APT::StringView ViewString(map_stringitem_t idx) const
+   {
+      char *name = StrP + idx;
+      uint16_t len = *reinterpret_cast<const uint16_t*>(name - sizeof(uint16_t));
+      return APT::StringView(name, len);
+   }
+#endif
+
+
+   GrpIterator FindGrp(const std::string &Name);
+   PkgIterator FindPkg(const std::string &Name);
+   PkgIterator FindPkg(const std::string &Name, const std::string &Arch);
+
+   Header &Head() {return *HeaderP;}
+   inline GrpIterator GrpBegin();
+   inline GrpIterator GrpEnd();

    inline PkgIterator PkgBegin();
    inline PkgIterator PkgEnd();
    inline PkgFileIterator FileBegin();
    inline PkgFileIterator FileEnd();
    inline PkgIterator PkgBegin();
    inline PkgIterator PkgEnd();
    inline PkgFileIterator FileBegin();
    inline PkgFileIterator FileEnd();

+   inline RlsFileIterator RlsFileBegin();
+   inline RlsFileIterator RlsFileEnd();
+
+   inline bool MultiArchCache() const { return MultiArchEnabled; }
+   inline char const * NativeArch();

 
    // Make me a function
    pkgVersioningSystem *VS;
    
    // Converters
 
    // Make me a function
    pkgVersioningSystem *VS;
    
    // Converters

-   static const char *CompTypeDeb(unsigned char Comp);
-   static const char *CompType(unsigned char Comp);
+   static const char *CompTypeDeb(unsigned char Comp) APT_CONST;
+   static const char *CompType(unsigned char Comp) APT_CONST;

    static const char *DepType(unsigned char Dep);
    static const char *DepType(unsigned char Dep);

-   
+

    pkgCache(MMap *Map,bool DoMap = true);
    pkgCache(MMap *Map,bool DoMap = true);

-   virtual ~pkgCache() {};
+   virtual ~pkgCache();
+
+private:
+   void * const d;
+   bool MultiArchEnabled;

 };
                                                                        /*}}}*/
 // Header structure                                                    /*{{{*/
 struct pkgCache::Header
 {
 };
                                                                        /*}}}*/
 // Header structure                                                    /*{{{*/
 struct pkgCache::Header
 {

-   // Signature information
-   unsigned long Signature;
-   short MajorVersion;
-   short MinorVersion;
+   /** \brief Signature information
+
+       This must contain the hex value 0x98FE76DC which is designed to
+       verify that the system loading the image has the same byte order
+       and byte size as the system saving the image */
+   uint32_t Signature;
+   /** These contain the version of the cache file */
+   map_number_t MajorVersion;
+   map_number_t MinorVersion;
+   /** \brief indicates if the cache should be erased
+
+       Dirty is true if the cache file was opened for reading, the client
+       expects to have written things to it and have not fully synced it.
+       The file should be erased and rebuilt if it is true. */

    bool Dirty;
    bool Dirty;

-   
-   // Size of structure values
-   unsigned short HeaderSz;
-   unsigned short PackageSz;
-   unsigned short PackageFileSz;
-   unsigned short VersionSz;
-   unsigned short DescriptionSz;
-   unsigned short DependencySz;
-   unsigned short ProvidesSz;
-   unsigned short VerFileSz;
-   unsigned short DescFileSz;
-   
-   // Structure counts
-   unsigned long PackageCount;
-   unsigned long VersionCount;
-   unsigned long DescriptionCount;
-   unsigned long DependsCount;
-   unsigned long PackageFileCount;
-   unsigned long VerFileCount;
-   unsigned long DescFileCount;
-   unsigned long ProvidesCount;
-   
-   // Offsets
-   map_ptrloc FileList;              // struct PackageFile
-   map_ptrloc StringList;            // struct StringItem
-   map_ptrloc VerSysName;            // StringTable
-   map_ptrloc Architecture;          // StringTable
-   unsigned long MaxVerFileSize;
-   unsigned long MaxDescFileSize;
-
-   /* Allocation pools, there should be one of these for each structure
-      excluding the header */
-   DynamicMMap::Pool Pools[8];
-   
-   // Rapid package name lookup
-   map_ptrloc HashTable[2*1048];

 
 

-   bool CheckSizes(Header &Against) const;
+   /** \brief Size of structure values
+
+       All *Sz variables contains the sizeof() that particular structure.
+       It is used as an extra consistency check on the structure of the file.
+
+       If any of the size values do not exactly match what the client expects
+       then the client should refuse the load the file. */
+   uint16_t HeaderSz;
+   map_number_t GroupSz;
+   map_number_t PackageSz;
+   map_number_t ReleaseFileSz;
+   map_number_t PackageFileSz;
+   map_number_t VersionSz;
+   map_number_t DescriptionSz;
+   map_number_t DependencySz;
+   map_number_t DependencyDataSz;
+   map_number_t ProvidesSz;
+   map_number_t VerFileSz;
+   map_number_t DescFileSz;
+
+   /** \brief Structure counts
+
+       These indicate the number of each structure contained in the cache.
+       PackageCount is especially useful for generating user state structures.
+       See Package::Id for more info. */
+   map_id_t GroupCount;
+   map_id_t PackageCount;
+   map_id_t VersionCount;
+   map_id_t DescriptionCount;
+   map_id_t DependsCount;
+   map_id_t DependsDataCount;
+   map_fileid_t ReleaseFileCount;
+   map_fileid_t PackageFileCount;
+   map_fileid_t VerFileCount;
+   map_fileid_t DescFileCount;
+   map_id_t ProvidesCount;
+
+   /** \brief index of the first PackageFile structure
+
+       The PackageFile structures are singly linked lists that represent
+       all package files that have been merged into the cache. */
+   map_pointer_t FileList;
+   /** \brief index of the first ReleaseFile structure */
+   map_pointer_t RlsFileList;
+
+   /** \brief String representing the version system used */
+   map_pointer_t VerSysName;
+   /** \brief native architecture the cache was built against */
+   map_pointer_t Architecture;
+   /** \brief all architectures the cache was built against */
+   map_pointer_t Architectures;
+   /** \brief The maximum size of a raw entry from the original Package file */
+   map_filesize_t MaxVerFileSize;
+   /** \brief The maximum size of a raw entry from the original Translation file */
+   map_filesize_t MaxDescFileSize;
+
+   /** \brief The Pool structures manage the allocation pools that the generator uses
+
+       Start indicates the first byte of the pool, Count is the number of objects
+       remaining in the pool and ItemSize is the structure size (alignment factor)
+       of the pool. An ItemSize of 0 indicates the pool is empty. There should be
+       the same number of pools as there are structure types. The generator
+       stores this information so future additions can make use of any unused pool
+       blocks. */
+   DynamicMMap::Pool Pools[12];
+
+   /** \brief hash tables providing rapid group/package name lookup
+
+       Each group/package name is inserted into a hash table using pkgCache::Hash(const &string)
+       By iterating over each entry in the hash table it is possible to iterate over
+       the entire list of packages. Hash Collisions are handled with a singly linked
+       list of packages based at the hash item. The linked list contains only
+       packages that match the hashing function.
+       In the PkgHashTable is it possible that multiple packages have the same name -
+       these packages are stored as a sequence in the list.
+       The size of both tables is the same. */
+   uint32_t HashTableSize;
+   uint32_t GetHashTableSize() const { return HashTableSize; }
+   void SetHashTableSize(unsigned int const sz) { HashTableSize = sz; }
+   map_pointer_t GetArchitectures() const { return Architectures; }
+   void SetArchitectures(map_pointer_t const idx) { Architectures = idx; }
+   map_pointer_t * PkgHashTableP() const { return (map_pointer_t*) (this + 1); }
+   map_pointer_t * GrpHashTableP() const { return PkgHashTableP() + GetHashTableSize(); }
+
+   /** \brief Hash of the file (TODO: Rename) */
+   map_filesize_small_t CacheFileSize;
+
+   bool CheckSizes(Header &Against) const APT_PURE;

    Header();
 };
                                                                        /*}}}*/
    Header();
 };
                                                                        /*}}}*/

-struct pkgCache::Package                                               /*{{{*/
+// Group structure                                                     /*{{{*/
+/** \brief groups architecture depending packages together
+
+    On or more packages with the same name form a group, so we have
+    a simple way to access a package built for different architectures
+    Group exists in a singly linked list of group records starting at
+    the hash index of the name in the pkgCache::Header::GrpHashTable */
+struct pkgCache::Group

 {
 {

-   // Pointers
-   map_ptrloc Name;              // Stringtable
-   map_ptrloc VersionList;       // Version
-   map_ptrloc CurrentVer;        // Version
-   map_ptrloc Section;           // StringTable (StringItem)
-      
-   // Linked list 
-   map_ptrloc NextPackage;       // Package
-   map_ptrloc RevDepends;        // Dependency
-   map_ptrloc ProvidesList;      // Provides
+   /** \brief Name of the group */
+   map_stringitem_t Name;
+
+   // Linked List
+   /** \brief Link to the first package which belongs to the group */
+   map_pointer_t FirstPackage; // Package
+   /** \brief Link to the last package which belongs to the group */
+   map_pointer_t LastPackage;  // Package
+   /** \brief Link to the next Group */
+   map_pointer_t Next;         // Group
+   /** \brief unique sequel ID */
+   map_id_t ID;
+
+};
+                                                                       /*}}}*/
+// Package structure                                                   /*{{{*/
+/** \brief contains information for a single unique package
+
+    There can be any number of versions of a given package.
+    Package exists in a singly linked list of package records starting at
+    the hash index of the name in the pkgCache::Header::PkgHashTable
+
+    A package can be created for every architecture so package names are
+    not unique, but it is guaranteed that packages with the same name
+    are sequencel ordered in the list. Packages with the same name can be
+    accessed with the Group.
+*/
+struct pkgCache::Package
+{
+   /** \brief Name of the package
+    * Note that the access method Name() will remain. It is just this data member
+    * deprecated as this information is already stored and available via the
+    * associated Group – so it is wasting precious binary cache space */
+   APT_DEPRECATED_MSG("Use the .Name() method instead of accessing the member directly") map_stringitem_t Name;
+   /** \brief Architecture of the package */
+   map_stringitem_t Arch;
+   /** \brief Base of a singly linked list of versions
+
+       Each structure represents a unique version of the package.
+       The version structures contain links into PackageFile and the
+       original text file as well as detailed information about the size
+       and dependencies of the specific package. In this way multiple
+       versions of a package can be cleanly handled by the system.
+       Furthermore, this linked list is guaranteed to be sorted
+       from Highest version to lowest version with no duplicate entries. */
+   map_pointer_t VersionList;       // Version
+   /** \brief index to the installed version */
+   map_pointer_t CurrentVer;        // Version
+   /** \brief index of the group this package belongs to */
+   map_pointer_t Group;             // Group the Package belongs to
+
+   // Linked list
+   /** \brief Link to the next package in the same bucket */
+   map_pointer_t NextPackage;       // Package
+   /** \brief List of all dependencies on this package */
+   map_pointer_t RevDepends;        // Dependency
+   /** \brief List of all "packages" this package provide */
+   map_pointer_t ProvidesList;      // Provides

 
    // Install/Remove/Purge etc
 
    // Install/Remove/Purge etc

-   unsigned char SelectedState;     // What
-   unsigned char InstState;         // Flags
-   unsigned char CurrentState;      // State
-   
-   unsigned int ID;
-   unsigned long Flags;
+   /** \brief state that the user wishes the package to be in */
+   map_number_t SelectedState;     // What
+   /** \brief installation state of the package
+
+       This should be "ok" but in case the installation failed
+       it will be different.
+   */
+   map_number_t InstState;         // Flags
+   /** \brief indicates if the package is installed */
+   map_number_t CurrentState;      // State
+
+   /** \brief unique sequel ID
+
+       ID is a unique value from 0 to Header->PackageCount assigned by the generator.
+       This allows clients to create an array of size PackageCount and use it to store
+       state information for the package map. For instance the status file emitter uses
+       this to track which packages have been emitted already. */
+   map_id_t ID;
+   /** \brief some useful indicators of the package's state */
+   map_flags_t Flags;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::PackageFile                                           /*{{{*/
+// Release File structure                                              /*{{{*/
+/** \brief stores information about the release files used to generate the cache
+
+    PackageFiles reference ReleaseFiles as we need to keep record of which
+    version belongs to which release e.g. for pinning. */
+struct pkgCache::ReleaseFile

 {
 {

-   // Names
-   map_ptrloc FileName;        // Stringtable
-   map_ptrloc Archive;         // Stringtable
-   map_ptrloc Codename;        // Stringtable
-   map_ptrloc Component;       // Stringtable
-   map_ptrloc Version;         // Stringtable
-   map_ptrloc Origin;          // Stringtable
-   map_ptrloc Label;           // Stringtable
-   map_ptrloc Architecture;    // Stringtable
-   map_ptrloc Site;            // Stringtable
-   map_ptrloc IndexType;       // Stringtable
-   unsigned long Size;            
-   unsigned long Flags;
-   
+   /** \brief physical disk file that this ReleaseFile represents */
+   map_stringitem_t FileName;
+   /** \brief the release information
+
+       Please see the files document for a description of what the
+       release information means. */
+   map_stringitem_t Archive;
+   map_stringitem_t Codename;
+   map_stringitem_t Version;
+   map_stringitem_t Origin;
+   map_stringitem_t Label;
+   /** \brief The site the index file was fetched from */
+   map_stringitem_t Site;
+
+   /** \brief Size of the file
+
+       Used together with the modification time as a
+       simple check to ensure that the Packages
+       file has not been altered since Cache generation. */
+   map_filesize_t Size;
+   /** \brief Modification time for the file */
+   time_t mtime;
+
+   /** @TODO document PackageFile::Flags */
+   map_flags_t Flags;
+

    // Linked list
    // Linked list

-   map_ptrloc NextFile;        // PackageFile
-   unsigned int ID;
-   time_t mtime;                  // Modification time for the file
+   /** \brief Link to the next ReleaseFile in the Cache */
+   map_pointer_t NextFile;
+   /** \brief unique sequel ID */
+   map_fileid_t ID;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::VerFile                                               /*{{{*/
+// Package File structure                                              /*{{{*/
+/** \brief stores information about the files used to generate the cache
+
+    Package files are referenced by Version structures to be able to know
+    after the generation still from which Packages file includes this Version
+    as we need this information later on e.g. for pinning. */
+struct pkgCache::PackageFile

 {
 {

-   map_ptrloc File;           // PackageFile
-   map_ptrloc NextFile;       // PkgVerFile
-   map_ptrloc Offset;         // File offset
-   unsigned long Size;
+   /** \brief physical disk file that this PackageFile represents */
+   map_stringitem_t FileName;
+   /** \brief the release information */
+   map_pointer_t Release;
+
+   map_stringitem_t Component;
+   map_stringitem_t Architecture;
+
+   /** \brief indicates what sort of index file this is
+
+       @TODO enumerate at least the possible indexes */
+   map_stringitem_t IndexType;
+   /** \brief Size of the file
+
+       Used together with the modification time as a
+       simple check to ensure that the Packages
+       file has not been altered since Cache generation. */
+   map_filesize_t Size;
+   /** \brief Modification time for the file */
+   time_t mtime;
+
+   /** @TODO document PackageFile::Flags */
+   map_flags_t Flags;
+
+   // Linked list
+   /** \brief Link to the next PackageFile in the Cache */
+   map_pointer_t NextFile;        // PackageFile
+   /** \brief unique sequel ID */
+   map_fileid_t ID;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::DescFile                                              /*{{{*/
+// VerFile structure                                                   /*{{{*/
+/** \brief associates a version with a PackageFile
+
+    This allows a full description of all Versions in all files
+    (and hence all sources) under consideration. */
+struct pkgCache::VerFile

 {
 {

-   map_ptrloc File;           // PackageFile
-   map_ptrloc NextFile;       // PkgVerFile
-   map_ptrloc Offset;         // File offset
-   unsigned long Size;
+   /** \brief index of the package file that this version was found in */
+   map_pointer_t File;           // PackageFile
+   /** \brief next step in the linked list */
+   map_pointer_t NextFile;       // PkgVerFile
+   /** \brief position in the package file */
+   map_filesize_t Offset;         // File offset
+   /** @TODO document pkgCache::VerFile::Size */
+   map_filesize_t Size;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::Version                                               /*{{{*/
+// DescFile structure                                                  /*{{{*/
+/** \brief associates a description with a Translation file */
+struct pkgCache::DescFile

 {
 {

-   map_ptrloc VerStr;            // Stringtable
-   map_ptrloc Section;           // StringTable (StringItem)
-   map_ptrloc Arch;              // StringTable
-      
-   // Lists
-   map_ptrloc FileList;          // VerFile
-   map_ptrloc NextVer;           // Version
-   map_ptrloc DescriptionList;   // Description
-   map_ptrloc DependsList;       // Dependency
-   map_ptrloc ParentPkg;         // Package
-   map_ptrloc ProvidesList;      // Provides
-   
-   map_ptrloc Size;              // These are the .deb size
-   map_ptrloc InstalledSize;
+   /** \brief index of the file that this description was found in */
+   map_pointer_t File;           // PackageFile
+   /** \brief next step in the linked list */
+   map_pointer_t NextFile;       // PkgVerFile
+   /** \brief position in the file */
+   map_filesize_t Offset;         // File offset
+   /** @TODO document pkgCache::DescFile::Size */
+   map_filesize_t Size;
+};
+                                                                       /*}}}*/
+// Version structure                                                   /*{{{*/
+/** \brief information for a single version of a package
+
+    The version list is always sorted from highest version to lowest
+    version by the generator. Equal version numbers are either merged
+    or handled as separate versions based on the Hash value. */
+APT_IGNORE_DEPRECATED_PUSH
+struct pkgCache::Version
+{
+   /** \brief complete version string */
+   map_stringitem_t VerStr;
+   /** \brief section this version is filled in */
+   map_stringitem_t Section;
+   /** \brief source package name this version comes from
+      Always contains the name, even if it is the same as the binary name */
+   map_stringitem_t SourcePkgName;
+   /** \brief source version this version comes from
+      Always contains the version string, even if it is the same as the binary version */
+   map_stringitem_t SourceVerStr;
+
+   /** \brief Multi-Arch capabilities of a package version */
+   enum VerMultiArch { No = 0, /*!< is the default and doesn't trigger special behaviour */
+                      All = (1<<0), /*!< will cause that Ver.Arch() will report "all" */
+                      Foreign = (1<<1), /*!< can satisfy dependencies in another architecture */
+                      Same = (1<<2), /*!< can be co-installed with itself from other architectures */
+                      Allowed = (1<<3), /*!< other packages are allowed to depend on thispkg:any */
+                      AllForeign = All | Foreign,
+                      AllAllowed = All | Allowed };
+
+   /** \brief deprecated variant of No */
+   static const APT_DEPRECATED_MSG("The default value of the Multi-Arch field is no, not none") VerMultiArch None = No;
+
+   /** \brief stores the MultiArch capabilities of this version
+
+       Flags used are defined in pkgCache::Version::VerMultiArch
+   */
+   map_number_t MultiArch;
+
+   /** \brief references all the PackageFile's that this version came from
+
+       FileList can be used to determine what distribution(s) the Version
+       applies to. If FileList is 0 then this is a blank version.
+       The structure should also have a 0 in all other fields excluding
+       pkgCache::Version::VerStr and Possibly pkgCache::Version::NextVer. */
+   map_pointer_t FileList;          // VerFile
+   /** \brief next (lower or equal) version in the linked list */
+   map_pointer_t NextVer;           // Version
+   /** \brief next description in the linked list */
+   map_pointer_t DescriptionList;   // Description
+   /** \brief base of the dependency list */
+   map_pointer_t DependsList;       // Dependency
+   /** \brief links to the owning package
+
+       This allows reverse dependencies to determine the package */
+   map_pointer_t ParentPkg;         // Package
+   /** \brief list of pkgCache::Provides */
+   map_pointer_t ProvidesList;      // Provides
+
+   /** \brief archive size for this version
+
+       For Debian this is the size of the .deb file. */
+   map_filesize_t Size; // These are the .deb size
+   /** \brief uncompressed size for this version */
+   map_filesize_t InstalledSize;
+   /** \brief characteristic value representing this version
+
+       No two packages in existence should have the same VerStr
+       and Hash with different contents. */

    unsigned short Hash;
    unsigned short Hash;

-   unsigned int ID;
-   unsigned char Priority;
+   /** \brief unique sequel ID */
+   map_id_t ID;
+   /** \brief parsed priority value */
+   map_number_t Priority;

 };
 };

+APT_IGNORE_DEPRECATED_POP

                                                                        /*}}}*/
                                                                        /*}}}*/

-struct pkgCache::Description                                           /*{{{*/
+// Description structure                                               /*{{{*/
+/** \brief datamember of a linked list of available description for a version */
+struct pkgCache::Description

 {
 {

-   // Language Code store the description translation language code. If
-   // the value has a 0 lenght then this is readed using the Package
-   // file else the Translation-CODE are used.
-   map_ptrloc language_code;     // StringTable
-   map_ptrloc md5sum;            // StringTable
-
-   // Linked list 
-   map_ptrloc FileList;          // DescFile
-   map_ptrloc NextDesc;          // Description
-   map_ptrloc ParentPkg;         // Package
-
-   unsigned int ID;
+   /** \brief Language code of this description (translation)
+
+       If the value has a 0 length then this is read using the Package
+       file else the Translation-CODE file is used. */
+   map_stringitem_t language_code;
+   /** \brief MD5sum of the original description
+
+       Used to map Translations of a description to a version
+       and to check that the Translation is up-to-date. */
+   map_stringitem_t md5sum;
+
+   /** @TODO document pkgCache::Description::FileList */
+   map_pointer_t FileList;          // DescFile
+   /** \brief next translation for this description */
+   map_pointer_t NextDesc;          // Description
+   /** \brief the text is a description of this package */
+   map_pointer_t ParentPkg;         // Package
+
+   /** \brief unique sequel ID */
+   map_id_t ID;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::Dependency                                            /*{{{*/
+// Dependency structure                                                        /*{{{*/
+/** \brief information for a single dependency record
+
+    The records are split up like this to ease processing by the client.
+    The base of the linked list is pkgCache::Version::DependsList.
+    All forms of dependencies are recorded here including Depends,
+    Recommends, Suggests, Enhances, Conflicts, Replaces and Breaks. */
+struct pkgCache::DependencyData

 {
 {

-   map_ptrloc Version;         // Stringtable
-   map_ptrloc Package;         // Package
-   map_ptrloc NextDepends;     // Dependency
-   map_ptrloc NextRevDepends;  // Dependency
-   map_ptrloc ParentVer;       // Version
-   
-   // Specific types of depends
-   map_ptrloc ID;   
-   unsigned char Type;
-   unsigned char CompareOp;
+   /** \brief string of the version the dependency is applied against */
+   map_stringitem_t Version;
+   /** \brief index of the package this depends applies to
+
+       The generator will - if the package does not already exist -
+       create a blank (no version records) package. */
+   map_pointer_t Package;         // Package
+
+   /** \brief Dependency type - Depends, Recommends, Conflicts, etc */
+   map_number_t Type;
+   /** \brief comparison operator specified on the depends line
+
+       If the high bit is set then it is a logical OR with the previous record. */
+   map_flags_t CompareOp;
+
+   map_pointer_t NextData;
+};
+struct pkgCache::Dependency
+{
+   map_pointer_t DependencyData;  // DependencyData
+   /** \brief version of the package which has the depends */
+   map_pointer_t ParentVer;       // Version
+   /** \brief next reverse dependency of this package */
+   map_pointer_t NextRevDepends;  // Dependency
+   /** \brief next dependency of this version */
+   map_pointer_t NextDepends;     // Dependency
+
+   /** \brief unique sequel ID */
+   map_id_t ID;

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::Provides                                              /*{{{*/
+// Provides structure                                                  /*{{{*/
+/** \brief handles virtual packages
+
+    When a Provides: line is encountered a new provides record is added
+    associating the package with a virtual package name.
+    The provides structures are linked off the package structures.
+    This simplifies the analysis of dependencies and other aspects A provides
+    refers to a specific version of a specific package, not all versions need to
+    provide that provides.*/
+struct pkgCache::Provides

 {
 {

-   map_ptrloc ParentPkg;        // Pacakge
-   map_ptrloc Version;          // Version
-   map_ptrloc ProvideVersion;   // Stringtable
-   map_ptrloc NextProvides;     // Provides
-   map_ptrloc NextPkgProv;      // Provides
+   /** \brief index of the package providing this */
+   map_pointer_t ParentPkg;        // Package
+   /** \brief index of the version this provide line applies to */
+   map_pointer_t Version;          // Version
+   /** \brief version in the provides line (if any)
+
+       This version allows dependencies to depend on specific versions of a
+       Provides, as well as allowing Provides to override existing packages. */
+   map_stringitem_t ProvideVersion;
+   map_flags_t Flags;
+   /** \brief next provides (based of package) */
+   map_pointer_t NextProvides;     // Provides
+   /** \brief next provides (based of version) */
+   map_pointer_t NextPkgProv;      // Provides

 };
                                                                        /*}}}*/
 };
                                                                        /*}}}*/

-struct pkgCache::StringItem                                            /*{{{*/
+// UNUSED StringItem structure                                         /*{{{*/
+struct APT_DEPRECATED_MSG("No longer used in cache generation without a replacement") pkgCache::StringItem

 {
 {

-   map_ptrloc String;        // Stringtable
+   /** \brief string this refers to */
+   map_ptrloc String;        // StringItem
+   /** \brief Next link in the chain */

    map_ptrloc NextItem;      // StringItem
 };
                                                                        /*}}}*/
    map_ptrloc NextItem;      // StringItem
 };
                                                                        /*}}}*/

+
+inline char const * pkgCache::NativeArch()
+       { return StrP + HeaderP->Architecture; }
+

 #include <apt-pkg/cacheiterators.h>
 
 #include <apt-pkg/cacheiterators.h>
 

-inline pkgCache::PkgIterator pkgCache::PkgBegin() 
-       {return PkgIterator(*this);};
-inline pkgCache::PkgIterator pkgCache::PkgEnd() 
-       {return PkgIterator(*this,PkgP);};
+inline pkgCache::GrpIterator pkgCache::GrpBegin()
+       {return GrpIterator(*this);}
+inline pkgCache::GrpIterator pkgCache::GrpEnd()
+       {return GrpIterator(*this,GrpP);}
+inline pkgCache::PkgIterator pkgCache::PkgBegin()
+       {return PkgIterator(*this);}
+inline pkgCache::PkgIterator pkgCache::PkgEnd()
+       {return PkgIterator(*this,PkgP);}

 inline pkgCache::PkgFileIterator pkgCache::FileBegin()
 inline pkgCache::PkgFileIterator pkgCache::FileBegin()

-       {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);};
+       {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);}

 inline pkgCache::PkgFileIterator pkgCache::FileEnd()
 inline pkgCache::PkgFileIterator pkgCache::FileEnd()

-       {return PkgFileIterator(*this,PkgFileP);};
+       {return PkgFileIterator(*this,PkgFileP);}
+inline pkgCache::RlsFileIterator pkgCache::RlsFileBegin()
+       {return RlsFileIterator(*this,RlsFileP + HeaderP->RlsFileList);}
+inline pkgCache::RlsFileIterator pkgCache::RlsFileEnd()
+       {return RlsFileIterator(*this,RlsFileP);}
+

 
 // Oh I wish for Real Name Space Support
 class pkgCache::Namespace                                              /*{{{*/
 
 // Oh I wish for Real Name Space Support
 class pkgCache::Namespace                                              /*{{{*/

-{   
+{

    public:
    public:

-
+   typedef pkgCache::GrpIterator GrpIterator;

    typedef pkgCache::PkgIterator PkgIterator;
    typedef pkgCache::VerIterator VerIterator;
    typedef pkgCache::DescIterator DescIterator;
    typedef pkgCache::DepIterator DepIterator;
    typedef pkgCache::PrvIterator PrvIterator;
    typedef pkgCache::PkgIterator PkgIterator;
    typedef pkgCache::VerIterator VerIterator;
    typedef pkgCache::DescIterator DescIterator;
    typedef pkgCache::DepIterator DepIterator;
    typedef pkgCache::PrvIterator PrvIterator;

+   typedef pkgCache::RlsFileIterator RlsFileIterator;

    typedef pkgCache::PkgFileIterator PkgFileIterator;
    typedef pkgCache::PkgFileIterator PkgFileIterator;

-   typedef pkgCache::VerFileIterator VerFileIterator;   
+   typedef pkgCache::VerFileIterator VerFileIterator;

    typedef pkgCache::Version Version;
    typedef pkgCache::Description Description;
    typedef pkgCache::Package Package;
    typedef pkgCache::Version Version;
    typedef pkgCache::Description Description;
    typedef pkgCache::Package Package;