apt-pkg/pkgcachegen.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 /* ######################################################################
   4
   5    Package Cache Generator - Generator for the cache structure.
   6
   7    This builds the cache structure from the abstract package list parser.
   8    Each archive source has it's own list parser that is instantiated by
   9    the caller to provide data for the generator.
  10
  11    Parts of the cache are created by this generator class while other
  12    parts are created by the list parser. The list parser is responsible
  13    for creating version, depends and provides structures, and some of
  14    their contents
  15
  16    ##################################################################### */
  17                                                                         /*}}}*/
  18 #ifndef PKGLIB_PKGCACHEGEN_H
  19 #define PKGLIB_PKGCACHEGEN_H
  20
  21 #include <apt-pkg/md5.h>
  22 #include <apt-pkg/mmap.h>
  23 #include <apt-pkg/pkgcache.h>
  24 #include <apt-pkg/cacheiterators.h>
  25 #include <apt-pkg/macros.h>
  26
  27 #include <vector>
  28 #include <string>
  29 #include <map>
  30
  31 class FileFd;
  32 class pkgSourceList;
  33 class OpProgress;
  34 class pkgIndexFile;
  35
  36 class APT_HIDDEN pkgCacheGenerator                                      /*{{{*/
  37 {
  38    private:
  39    APT_HIDDEN map_stringitem_t WriteStringInMap(std::string const &String) { return WriteStringInMap(String.c_str()); };
  40    APT_HIDDEN map_stringitem_t WriteStringInMap(const char *String);
  41    APT_HIDDEN map_stringitem_t WriteStringInMap(const char *String, const unsigned long &Len);
  42    APT_HIDDEN map_pointer_t AllocateInMap(const unsigned long &size);
  43
  44    std::map<std::string,map_stringitem_t> strMixed;
  45    std::map<std::string,map_stringitem_t> strSections;
  46    std::map<std::string,map_stringitem_t> strPkgNames;
  47    std::map<std::string,map_stringitem_t> strVersions;
  48
  49    public:
  50
  51    class ListParser;
  52    friend class ListParser;
  53
  54    template<typename Iter> class Dynamic {
  55       public:
  56       static std::vector<Iter*> toReMap;
  57       explicit Dynamic(Iter &I) {
  58          toReMap.push_back(&I);
  59       }
  60
  61       ~Dynamic() {
  62          toReMap.pop_back();
  63       }
  64    };
  65
  66    protected:
  67
  68    DynamicMMap &Map;
  69    pkgCache Cache;
  70    OpProgress *Progress;
  71
  72    std::string RlsFileName;
  73    pkgCache::ReleaseFile *CurrentRlsFile;
  74    std::string PkgFileName;
  75    pkgCache::PackageFile *CurrentFile;
  76
  77    // Flag file dependencies
  78    bool FoundFileDeps;
  79
  80    bool NewGroup(pkgCache::GrpIterator &Grp,const std::string &Name);
  81    bool NewPackage(pkgCache::PkgIterator &Pkg,const std::string &Name, const std::string &Arch);
  82    bool NewFileVer(pkgCache::VerIterator &Ver,ListParser &List);
  83    bool NewFileDesc(pkgCache::DescIterator &Desc,ListParser &List);
  84    bool NewDepends(pkgCache::PkgIterator &Pkg, pkgCache::VerIterator &Ver,
  85                    std::string const &Version, uint8_t const Op,
  86                    uint8_t const Type, map_pointer_t* &OldDepLast);
  87    bool NewDepends(pkgCache::PkgIterator &Pkg, pkgCache::VerIterator &Ver,
  88                    map_pointer_t const Version, uint8_t const Op,
  89                    uint8_t const Type, map_pointer_t* &OldDepLast);
  90    map_pointer_t NewVersion(pkgCache::VerIterator &Ver,const std::string &VerStr,map_pointer_t const Next) APT_DEPRECATED
  91    { return NewVersion(Ver, VerStr, 0, 0, Next); }
  92    map_pointer_t NewVersion(pkgCache::VerIterator &Ver,const std::string &VerStr,
  93                             map_pointer_t const ParentPkg, unsigned short const Hash,
  94                             map_pointer_t const Next);
  95    map_pointer_t NewDescription(pkgCache::DescIterator &Desc,const std::string &Lang,const MD5SumValue &md5sum,map_stringitem_t const idxmd5str);
  96
  97    public:
  98
  99    enum StringType { MIXED, PKGNAME, VERSIONNUMBER, SECTION };
 100    map_stringitem_t StoreString(StringType const type, const char * S, unsigned int const Size);
 101    inline map_stringitem_t StoreString(enum StringType const type, const std::string &S) {return StoreString(type, S.c_str(),S.length());};
 102
 103    void DropProgress() {Progress = 0;};
 104    bool SelectFile(const std::string &File,pkgIndexFile const &Index, std::string const &Architecture, std::string const &Component, unsigned long Flags = 0);
 105    bool SelectReleaseFile(const std::string &File, const std::string &Site, unsigned long Flags = 0);
 106    bool MergeList(ListParser &List,pkgCache::VerIterator *Ver = 0);
 107    inline pkgCache &GetCache() {return Cache;};
 108    inline pkgCache::PkgFileIterator GetCurFile()
 109          {return pkgCache::PkgFileIterator(Cache,CurrentFile);};
 110    inline pkgCache::RlsFileIterator GetCurRlsFile()
 111          {return pkgCache::RlsFileIterator(Cache,CurrentRlsFile);};
 112
 113    bool HasFileDeps() {return FoundFileDeps;};
 114    bool MergeFileProvides(ListParser &List);
 115    bool FinishCache(OpProgress *Progress) APT_DEPRECATED APT_CONST;
 116
 117    APT_PUBLIC static bool MakeStatusCache(pkgSourceList &List,OpProgress *Progress,
 118                         MMap **OutMap = 0,bool AllowMem = false);
 119    APT_PUBLIC static bool MakeOnlyStatusCache(OpProgress *Progress,DynamicMMap **OutMap);
 120    APT_PUBLIC static DynamicMMap* CreateDynamicMMap(FileFd *CacheF, unsigned long Flags = 0);
 121
 122    void ReMap(void const * const oldMap, void const * const newMap);
 123
 124    pkgCacheGenerator(DynamicMMap *Map,OpProgress *Progress);
 125    virtual ~pkgCacheGenerator();
 126
 127    private:
 128    void * const d;
 129    APT_HIDDEN bool MergeListGroup(ListParser &List, std::string const &GrpName);
 130    APT_HIDDEN bool MergeListPackage(ListParser &List, pkgCache::PkgIterator &Pkg);
 131    APT_HIDDEN bool MergeListVersion(ListParser &List, pkgCache::PkgIterator &Pkg,
 132                          std::string const &Version, pkgCache::VerIterator* &OutVer);
 133
 134    APT_HIDDEN bool AddImplicitDepends(pkgCache::GrpIterator &G, pkgCache::PkgIterator &P,
 135                            pkgCache::VerIterator &V);
 136    APT_HIDDEN bool AddImplicitDepends(pkgCache::VerIterator &V, pkgCache::PkgIterator &D);
 137
 138    APT_HIDDEN bool AddNewDescription(ListParser &List, pkgCache::VerIterator &Ver,
 139          std::string const &lang, MD5SumValue const &CurMd5, map_stringitem_t &md5idx);
 140 };
 141                                                                         /*}}}*/
 142 // This is the abstract package list parser class.                      /*{{{*/
 143 class APT_HIDDEN pkgCacheGenerator::ListParser
 144 {
 145    pkgCacheGenerator *Owner;
 146    friend class pkgCacheGenerator;
 147
 148    // Some cache items
 149    pkgCache::VerIterator OldDepVer;
 150    map_pointer_t *OldDepLast;
 151
 152    // Flag file dependencies
 153    bool FoundFileDeps;
 154
 155    void * const d;
 156
 157    protected:
 158
 159    inline map_stringitem_t StoreString(pkgCacheGenerator::StringType const type, std::string const &S) {return Owner->StoreString(type, S);};
 160    inline map_stringitem_t StoreString(pkgCacheGenerator::StringType const type, const char *S,unsigned int Size) {return Owner->StoreString(type, S, Size);};
 161
 162    inline map_stringitem_t WriteString(const std::string &S) {return Owner->WriteStringInMap(S);};
 163    inline map_stringitem_t WriteString(const char *S,unsigned int Size) {return Owner->WriteStringInMap(S,Size);};
 164    bool NewDepends(pkgCache::VerIterator &Ver,const std::string &Package, const std::string &Arch,
 165                    const std::string &Version,uint8_t const Op,
 166                    uint8_t const Type);
 167    bool NewProvides(pkgCache::VerIterator &Ver,const std::string &PkgName,
 168                     const std::string &PkgArch, const std::string &Version,
 169                     uint8_t const Flags);
 170
 171    public:
 172
 173    // These all operate against the current section
 174    virtual std::string Package() = 0;
 175    virtual std::string Architecture() = 0;
 176    virtual bool ArchitectureAll() = 0;
 177    virtual std::string Version() = 0;
 178    virtual bool NewVersion(pkgCache::VerIterator &Ver) = 0;
 179    virtual std::string Description(std::string const &lang) = 0;
 180    virtual std::vector<std::string> AvailableDescriptionLanguages() = 0;
 181    virtual MD5SumValue Description_md5() = 0;
 182    virtual unsigned short VersionHash() = 0;
 183    /** compare currently parsed version with given version
 184     *
 185     * \param Hash of the currently parsed version
 186     * \param Ver to compare with
 187     */
 188    virtual bool SameVersion(unsigned short const Hash, pkgCache::VerIterator const &Ver);
 189    virtual bool UsePackage(pkgCache::PkgIterator &Pkg,
 190                            pkgCache::VerIterator &Ver) = 0;
 191    virtual map_filesize_t Offset() = 0;
 192    virtual map_filesize_t Size() = 0;
 193
 194    virtual bool Step() = 0;
 195
 196    inline bool HasFileDeps() {return FoundFileDeps;};
 197    virtual bool CollectFileProvides(pkgCache &/*Cache*/,
 198                                     pkgCache::VerIterator &/*Ver*/) {return true;};
 199
 200    ListParser();
 201    virtual ~ListParser();
 202 };
 203                                                                         /*}}}*/
 204
 205 bool pkgMakeStatusCache(pkgSourceList &List,OpProgress &Progress,
 206                         MMap **OutMap = 0,bool AllowMem = false);
 207 bool pkgMakeOnlyStatusCache(OpProgress &Progress,DynamicMMap **OutMap);
 208
 209 #endif