apt-pkg/pkgcachegen.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: pkgcachegen.h,v 1.18 2001/02/20 07:03:17 jgg Exp $
   4 /* ######################################################################
   5
   6    Package Cache Generator - Generator for the cache structure.
   7
   8    This builds the cache structure from the abstract package list parser.
   9    Each archive source has it's own list parser that is instantiated by
  10    the caller to provide data for the generator.
  11
  12    Parts of the cache are created by this generator class while other
  13    parts are created by the list parser. The list parser is responsible
  14    for creating version, depends and provides structures, and some of
  15    their contents
  16
  17    ##################################################################### */
  18                                                                         /*}}}*/
  19 #ifndef PKGLIB_PKGCACHEGEN_H
  20 #define PKGLIB_PKGCACHEGEN_H
  21
  22 #ifdef __GNUG__
  23 #pragma interface "apt-pkg/pkgcachegen.h"
  24 #endif
  25
  26 #include <apt-pkg/pkgcache.h>
  27
  28 class pkgSourceList;
  29 class OpProgress;
  30 class MMap;
  31 class pkgIndexFile;
  32
  33 class pkgCacheGenerator
  34 {
  35    private:
  36
  37    pkgCache::StringItem *UniqHash[26];
  38
  39    public:
  40
  41    class ListParser;
  42    friend class ListParser;
  43
  44    protected:
  45
  46    DynamicMMap &Map;
  47    pkgCache Cache;
  48    OpProgress *Progress;
  49
  50    string PkgFileName;
  51    pkgCache::PackageFile *CurrentFile;
  52
  53    bool NewPackage(pkgCache::PkgIterator &Pkg,string Pkg);
  54    bool NewFileVer(pkgCache::VerIterator &Ver,ListParser &List);
  55    unsigned long NewVersion(pkgCache::VerIterator &Ver,string VerStr,unsigned long Next);
  56
  57    public:
  58
  59    unsigned long WriteUniqString(const char *S,unsigned int Size);
  60    inline unsigned long WriteUniqString(string S) {return WriteUniqString(S.c_str(),S.length());};
  61
  62    void DropProgress() {Progress = 0;};
  63    bool SelectFile(string File,string Site,pkgIndexFile const &Index,
  64                    unsigned long Flags = 0);
  65    bool MergeList(ListParser &List,pkgCache::VerIterator *Ver = 0);
  66    inline pkgCache &GetCache() {return Cache;};
  67    inline pkgCache::PkgFileIterator GetCurFile()
  68          {return pkgCache::PkgFileIterator(Cache,CurrentFile);};
  69
  70    pkgCacheGenerator(DynamicMMap *Map,OpProgress *Progress);
  71    ~pkgCacheGenerator();
  72 };
  73
  74 // This is the abstract package list parser class.
  75 class pkgCacheGenerator::ListParser
  76 {
  77    pkgCacheGenerator *Owner;
  78    friend class pkgCacheGenerator;
  79
  80    // Some cache items
  81    pkgCache::VerIterator OldDepVer;
  82    map_ptrloc *OldDepLast;
  83
  84    protected:
  85
  86    inline unsigned long WriteUniqString(string S) {return Owner->WriteUniqString(S);};
  87    inline unsigned long WriteUniqString(const char *S,unsigned int Size) {return Owner->WriteUniqString(S,Size);};
  88    inline unsigned long WriteString(string S) {return Owner->Map.WriteString(S);};
  89    inline unsigned long WriteString(const char *S,unsigned int Size) {return Owner->Map.WriteString(S,Size);};
  90    bool NewDepends(pkgCache::VerIterator Ver,string Package,
  91                    string Version,unsigned int Op,
  92                    unsigned int Type);
  93    bool NewProvides(pkgCache::VerIterator Ver,string Package,string Version);
  94
  95    public:
  96
  97    // These all operate against the current section
  98    virtual string Package() = 0;
  99    virtual string Version() = 0;
 100    virtual bool NewVersion(pkgCache::VerIterator Ver) = 0;
 101    virtual unsigned short VersionHash() = 0;
 102    virtual bool UsePackage(pkgCache::PkgIterator Pkg,
 103                            pkgCache::VerIterator Ver) = 0;
 104    virtual unsigned long Offset() = 0;
 105    virtual unsigned long Size() = 0;
 106
 107    virtual bool Step() = 0;
 108
 109    virtual ~ListParser() {};
 110 };
 111
 112 bool pkgMakeStatusCache(pkgSourceList &List,OpProgress &Progress,
 113                         MMap **OutMap = 0,bool AllowMem = false);
 114 bool pkgMakeOnlyStatusCache(OpProgress &Progress,DynamicMMap **OutMap);
 115
 116 #ifdef APT_COMPATIBILITY
 117 #if APT_COMPATIBILITY != 986
 118 #warning "Using APT_COMPATIBILITY"
 119 #endif
 120 MMap *pkgMakeStatusCacheMem(pkgSourceList &List,OpProgress &Progress)
 121 {
 122    MMap *Map = 0;
 123    if (pkgMakeStatusCache(List,Progress,&Map,true) == false)
 124       return 0;
 125    return Map;
 126 }
 127 #endif
 128
 129 #endif