* huge merge to bring the apt debian-sid and ubuntu branches as close
[ntk/apt.git] / apt-pkg / pkgcache.h
index 852949b..83b7548 100644 (file)
@@ -1,11 +1,11 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: pkgcache.h,v 1.5 1998/07/07 04:17:03 jgg Exp $
+// $Id: pkgcache.h,v 1.25 2001/07/01 22:28:24 jgg Exp $
 /* ######################################################################
    
    Cache - Structure definitions for the cache file
    
-   Please see doc/pkglib/cache.sgml for a more detailed description of 
+   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!!
    
    Clients should always use the CacheIterators classes for access to the
    
    ##################################################################### */
                                                                        /*}}}*/
-// Header section: pkglib
 #ifndef PKGLIB_PKGCACHE_H
 #define PKGLIB_PKGCACHE_H
 
-#ifdef __GNUG__
-#pragma interface "pkglib/pkgcache.h"
-#endif 
 
 #include <string>
 #include <time.h>
-#include <pkglib/mmap.h>
+#include <apt-pkg/mmap.h>
 
+using std::string;
+    
+class pkgVersioningSystem;
 class pkgCache
 {
    public:
@@ -36,48 +35,59 @@ class pkgCache
    struct Package;
    struct PackageFile;
    struct Version;
+   struct Description;
    struct Provides;
    struct Dependency;
    struct StringItem;
    struct VerFile;
+   struct DescFile;
    
    // Iterators
    class PkgIterator;
    class VerIterator;
+   class DescIterator;
    class DepIterator;
    class PrvIterator;
    class PkgFileIterator;
    class VerFileIterator;
-   friend PkgIterator;
-   friend VerIterator;
-   friend DepIterator;
-   friend PrvIterator;
-   friend PkgFileIterator;
-   friend 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;
    
    // These are all the constants used in the cache structures
+
+   // WARNING - if you change these lists you must also edit
+   // the stringification in pkgcache.cc and also consider whether
+   // the cache file will become incompatible.
    struct Dep
    {
       enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
-        Conflicts=5,Replaces=6};
+        Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8};
       enum DepCompareOp {Or=0x10,NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
         Greater=0x4,Equals=0x5,NotEquals=0x6};
    };
    
    struct State
    {
-      enum VerPriority {Important=1,Required=2,Standard=3,Optional=5,Extra=5};
+      enum VerPriority {Important=1,Required=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,
-        UnInstalled=3,HalfInstalled=4,ConfigFiles=5,Installed=6};
+          HalfInstalled=4,ConfigFiles=5,Installed=6};
    };
    
    struct Flag
    {
-      enum PkgFlags {Auto=(1<<0),New=(1<<1),Obsolete=(1<<2),Essential=(1<<3),
-        ImmediateConf=(1<<4)};
-      enum PkgFFlags {NotSource=(1<<0)};
+      enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
+      enum PkgFFlags {NotSource=(1<<0),NotAutomatic=(1<<1)};
    };
    
    protected:
@@ -86,11 +96,8 @@ class pkgCache
    string CacheFile;
    MMap &Map;
 
-   bool Public;
-   bool ReadOnly;
-
-   static unsigned long sHash(string S);
-   static unsigned long sHash(const char *S);
+   unsigned long sHash(const string &S) const;
+   unsigned long sHash(const char *S) const;
    
    public:
    
@@ -98,8 +105,10 @@ class pkgCache
    Header *HeaderP;
    Package *PkgP;
    VerFile *VerFileP;
+   DescFile *DescFileP;
    PackageFile *PkgFileP;
    Version *VerP;
+   Description *DescP;
    Provides *ProvideP;
    Dependency *DepP;
    StringItem *StringItemP;
@@ -107,21 +116,33 @@ class pkgCache
 
    virtual bool ReMap();
    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)
-   inline unsigned long Hash(string S) const {return sHash(S);};
+   inline unsigned long Hash(const string &S) const {return sHash(S);};
    inline unsigned long Hash(const char *S) const {return sHash(S);};
 
    // Usefull transformation things
    const char *Priority(unsigned char Priority);
    
    // Accessors
-   PkgIterator FindPkg(string Name);
+   PkgIterator FindPkg(const string &Name);
    Header &Head() {return *HeaderP;};
    inline PkgIterator PkgBegin();
    inline PkgIterator PkgEnd();
+   inline PkgFileIterator FileBegin();
+   inline PkgFileIterator FileEnd();
 
-   pkgCache(MMap &Map);
+   // Make me a function
+   pkgVersioningSystem *VS;
+   
+   // Converters
+   static const char *CompTypeDeb(unsigned char Comp);
+   static const char *CompType(unsigned char Comp);
+   static const char *DepType(unsigned char Dep);
+   
+   pkgCache(MMap *Map,bool DoMap = true);
    virtual ~pkgCache() {};
 };
 
@@ -139,26 +160,36 @@ struct pkgCache::Header
    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
-   unsigned long FileList;              // struct PackageFile
-   unsigned long StringList;            // struct StringItem
+   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[7];
+   DynamicMMap::Pool Pools[8];
    
    // Rapid package name lookup
-   unsigned long HashTable[512];
+   map_ptrloc HashTable[2*1048];
 
    bool CheckSizes(Header &Against) const;
    Header();
@@ -167,18 +198,16 @@ struct pkgCache::Header
 struct pkgCache::Package
 {
    // Pointers
-   unsigned long Name;              // Stringtable
-   unsigned long VersionList;       // Version
-   unsigned long TargetVer;         // Version
-   unsigned long CurrentVer;        // Version
-   unsigned long TargetDist;        // StringTable (StringItem)
-   unsigned long Section;           // StringTable (StringItem)
+   map_ptrloc Name;              // Stringtable
+   map_ptrloc VersionList;       // Version
+   map_ptrloc CurrentVer;        // Version
+   map_ptrloc Section;           // StringTable (StringItem)
       
    // Linked list 
-   unsigned long NextPackage;       // Package
-   unsigned long RevDepends;        // Dependency
-   unsigned long ProvidesList;      // Provides
-   
+   map_ptrloc NextPackage;       // Package
+   map_ptrloc RevDepends;        // Dependency
+   map_ptrloc ProvidesList;      // Provides
+
    // Install/Remove/Purge etc
    unsigned char SelectedState;     // What
    unsigned char InstState;         // Flags
@@ -191,78 +220,135 @@ struct pkgCache::Package
 struct pkgCache::PackageFile
 {
    // Names
-   unsigned long FileName;        // Stringtable
-   unsigned long Version;         // Stringtable
-   unsigned long Distribution;    // Stringtable
-   unsigned long Size;
+   map_ptrloc FileName;        // Stringtable
+   map_ptrloc Archive;         // 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;
    
    // Linked list
-   unsigned long NextFile;        // PackageFile
+   map_ptrloc NextFile;        // PackageFile
    unsigned short ID;
-   unsigned long Flags;
    time_t mtime;                  // Modification time for the file
 };
 
 struct pkgCache::VerFile
 {
-   unsigned long File;           // PackageFile
-   unsigned long NextFile;       // PkgVerFile
-   unsigned long Offset;
+   map_ptrloc File;           // PackageFile
+   map_ptrloc NextFile;       // PkgVerFile
+   map_ptrloc Offset;         // File offset
+   unsigned short Size;
+};
+
+struct pkgCache::DescFile
+{
+   map_ptrloc File;           // PackageFile
+   map_ptrloc NextFile;       // PkgVerFile
+   map_ptrloc Offset;         // File offset
    unsigned short Size;
 };
 
 struct pkgCache::Version
 {
-   unsigned long VerStr;            // Stringtable
-   unsigned long Section;           // StringTable (StringItem)
-   
+   map_ptrloc VerStr;            // Stringtable
+   map_ptrloc Section;           // StringTable (StringItem)
+   map_ptrloc Arch;              // StringTable
+      
    // Lists
-   unsigned long FileList;          // VerFile
-   unsigned long NextVer;           // Version
-   unsigned long DependsList;       // Dependency
-   unsigned long ParentPkg;         // Package
-   unsigned long ProvidesList;      // Provides
+   map_ptrloc FileList;          // VerFile
+   map_ptrloc NextVer;           // Version
+   map_ptrloc DescriptionList;   // Description
+   map_ptrloc DependsList;       // Dependency
+   map_ptrloc ParentPkg;         // Package
+   map_ptrloc ProvidesList;      // Provides
    
-   unsigned long Size;
-   unsigned long InstalledSize;
+   map_ptrloc Size;              // These are the .deb size
+   map_ptrloc InstalledSize;
+   unsigned short Hash;
    unsigned short ID;
    unsigned char Priority;
 };
 
+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 short ID;
+};
+
 struct pkgCache::Dependency
 {
-   unsigned long Version;         // Stringtable
-   unsigned long Package;         // Package
-   unsigned long NextDepends;     // Dependency
-   unsigned long NextRevDepends;  // Dependency
-   unsigned long ParentVer;       // Version
+   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;
-   unsigned short ID;
 };
 
 struct pkgCache::Provides
 {
-   unsigned long ParentPkg;        // Pacakge
-   unsigned long Version;          // Version
-   unsigned long ProvideVersion;   // Stringtable
-   unsigned long NextProvides;     // Provides
-   unsigned long NextPkgProv;      // Provides
+   map_ptrloc ParentPkg;        // Pacakge
+   map_ptrloc Version;          // Version
+   map_ptrloc ProvideVersion;   // Stringtable
+   map_ptrloc NextProvides;     // Provides
+   map_ptrloc NextPkgProv;      // Provides
 };
 
 struct pkgCache::StringItem
 {
-   unsigned long String;        // Stringtable
-   unsigned long NextItem;      // StringItem
+   map_ptrloc String;        // Stringtable
+   map_ptrloc NextItem;      // StringItem
 };
 
-#include <pkglib/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::PkgFileIterator pkgCache::FileBegin()
+       {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);};
+inline pkgCache::PkgFileIterator pkgCache::FileEnd()
+       {return PkgFileIterator(*this,PkgFileP);};
+
+// Oh I wish for Real Name Space Support
+class pkgCache::Namespace
+{   
+   public:
+
+   typedef pkgCache::PkgIterator PkgIterator;
+   typedef pkgCache::VerIterator VerIterator;
+   typedef pkgCache::DescIterator DescIterator;
+   typedef pkgCache::DepIterator DepIterator;
+   typedef pkgCache::PrvIterator PrvIterator;
+   typedef pkgCache::PkgFileIterator PkgFileIterator;
+   typedef pkgCache::VerFileIterator VerFileIterator;   
+   typedef pkgCache::Version Version;
+   typedef pkgCache::Description Description;
+   typedef pkgCache::Package Package;
+   typedef pkgCache::Header Header;
+   typedef pkgCache::Dep Dep;
+   typedef pkgCache::Flag Flag;
+};
 
 #endif