apt-pkg/pkgcachegen.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: pkgcachegen.h,v 1.19 2002/07/08 03:13:30 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
  23 #include <apt-pkg/pkgcache.h>
  24 #include <apt-pkg/md5.h>
  25
  26 class pkgSourceList;
  27 class OpProgress;
  28 class MMap;
  29 class pkgIndexFile;
  30
  31 class pkgCacheGenerator                                                 /*{{{*/
  32 {
  33    private:
  34
  35    pkgCache::StringItem *UniqHash[26];
  36
  37    public:
  38
  39    class ListParser;
  40    friend class ListParser;
  41
  42    protected:
  43
  44    DynamicMMap &Map;
  45    pkgCache Cache;
  46    OpProgress *Progress;
  47
  48    string PkgFileName;
  49    pkgCache::PackageFile *CurrentFile;
  50
  51    // Flag file dependencies
  52    bool FoundFileDeps;
  53
  54    bool NewGroup(pkgCache::GrpIterator &Grp,const string &Name);
  55    bool NewPackage(pkgCache::PkgIterator &Pkg,const string &Name, const string &Arch);
  56    bool NewFileVer(pkgCache::VerIterator &Ver,ListParser &List);
  57    bool NewFileDesc(pkgCache::DescIterator &Desc,ListParser &List);
  58    unsigned long NewVersion(pkgCache::VerIterator &Ver,const string &VerStr,unsigned long Next);
  59    map_ptrloc NewDescription(pkgCache::DescIterator &Desc,const string &Lang,const MD5SumValue &md5sum,map_ptrloc Next);
  60
  61    public:
  62
  63    unsigned long WriteUniqString(const char *S,unsigned int Size);
  64    inline unsigned long WriteUniqString(const string &S) {return WriteUniqString(S.c_str(),S.length());};
  65
  66    void DropProgress() {Progress = 0;};
  67    bool SelectFile(const string &File,const string &Site,pkgIndexFile const &Index,
  68                    unsigned long Flags = 0);
  69    bool MergeList(ListParser &List,pkgCache::VerIterator *Ver = 0);
  70    inline pkgCache &GetCache() {return Cache;};
  71    inline pkgCache::PkgFileIterator GetCurFile()
  72          {return pkgCache::PkgFileIterator(Cache,CurrentFile);};
  73
  74    bool HasFileDeps() {return FoundFileDeps;};
  75    bool MergeFileProvides(ListParser &List);
  76
  77    pkgCacheGenerator(DynamicMMap *Map,OpProgress *Progress);
  78    ~pkgCacheGenerator();
  79 };
  80                                                                         /*}}}*/
  81 // This is the abstract package list parser class.                      /*{{{*/
  82 class pkgCacheGenerator::ListParser
  83 {
  84    pkgCacheGenerator *Owner;
  85    friend class pkgCacheGenerator;
  86
  87    // Some cache items
  88    pkgCache::VerIterator OldDepVer;
  89    map_ptrloc *OldDepLast;
  90
  91    // Flag file dependencies
  92    bool FoundFileDeps;
  93
  94    protected:
  95
  96    inline unsigned long WriteUniqString(string S) {return Owner->WriteUniqString(S);};
  97    inline unsigned long WriteUniqString(const char *S,unsigned int Size) {return Owner->WriteUniqString(S,Size);};
  98    inline unsigned long WriteString(const string &S) {return Owner->Map.WriteString(S);};
  99    inline unsigned long WriteString(const char *S,unsigned int Size) {return Owner->Map.WriteString(S,Size);};
 100    bool NewDepends(pkgCache::VerIterator Ver,const string &Package, const string &Arch,
 101                    const string &Version,unsigned int Op,
 102                    unsigned int Type);
 103    bool NewProvides(pkgCache::VerIterator Ver,const string &Package,
 104                     const string &Version);
 105
 106    public:
 107
 108    // These all operate against the current section
 109    virtual string Package() = 0;
 110    virtual string Architecture() = 0;
 111    virtual string Version() = 0;
 112    virtual bool NewVersion(pkgCache::VerIterator Ver) = 0;
 113    virtual string Description() = 0;
 114    virtual string DescriptionLanguage() = 0;
 115    virtual MD5SumValue Description_md5() = 0;
 116    virtual unsigned short VersionHash() = 0;
 117    virtual bool UsePackage(pkgCache::PkgIterator Pkg,
 118                            pkgCache::VerIterator Ver) = 0;
 119    virtual unsigned long Offset() = 0;
 120    virtual unsigned long Size() = 0;
 121
 122    virtual bool Step() = 0;
 123
 124    inline bool HasFileDeps() {return FoundFileDeps;};
 125    virtual bool CollectFileProvides(pkgCache &Cache,
 126                                     pkgCache::VerIterator Ver) {return true;};
 127
 128    ListParser() : FoundFileDeps(false) {};
 129    virtual ~ListParser() {};
 130 };
 131                                                                         /*}}}*/
 132 bool pkgMakeStatusCache(pkgSourceList &List,OpProgress &Progress,
 133                         MMap **OutMap = 0,bool AllowMem = false);
 134 bool pkgMakeOnlyStatusCache(OpProgress &Progress,DynamicMMap **OutMap);
 135
 136 #ifdef APT_COMPATIBILITY
 137 #if APT_COMPATIBILITY != 986
 138 #warning "Using APT_COMPATIBILITY"
 139 #endif
 140 MMap *pkgMakeStatusCacheMem(pkgSourceList &List,OpProgress &Progress)
 141 {
 142    MMap *Map = 0;
 143    if (pkgMakeStatusCache(List,Progress,&Map,true) == false)
 144       return 0;
 145    return Map;
 146 }
 147 #endif
 148
 149 #endif