| 1 | // -*- mode: cpp; mode: fold -*- |
| 2 | // Description /*{{{*/ |
| 3 | // $Id: indexfile.h,v 1.6.2.1 2003/12/24 23:09:17 mdz Exp $ |
| 4 | /* ###################################################################### |
| 5 | |
| 6 | Index File - Abstraction for an index of archive/source file. |
| 7 | |
| 8 | There are 4 primary sorts of index files, all represented by this |
| 9 | class: |
| 10 | |
| 11 | Binary index files |
| 12 | Binary translation files |
| 13 | Bianry index files decribing the local system |
| 14 | Source index files |
| 15 | |
| 16 | They are all bundled together here, and the interfaces for |
| 17 | sources.list, acquire, cache gen and record parsing all use this class |
| 18 | to acess the underlying representation. |
| 19 | |
| 20 | ##################################################################### */ |
| 21 | /*}}}*/ |
| 22 | #ifndef PKGLIB_INDEXFILE_H |
| 23 | #define PKGLIB_INDEXFILE_H |
| 24 | |
| 25 | |
| 26 | #include <string> |
| 27 | #include <apt-pkg/pkgcache.h> |
| 28 | #include <apt-pkg/srcrecords.h> |
| 29 | #include <apt-pkg/pkgrecords.h> |
| 30 | |
| 31 | using std::string; |
| 32 | |
| 33 | class pkgAcquire; |
| 34 | class pkgCacheGenerator; |
| 35 | class OpProgress; |
| 36 | class pkgIndexFile |
| 37 | { |
| 38 | protected: |
| 39 | bool Trusted; |
| 40 | |
| 41 | public: |
| 42 | |
| 43 | class Type |
| 44 | { |
| 45 | public: |
| 46 | |
| 47 | // Global list of Items supported |
| 48 | static Type **GlobalList; |
| 49 | static unsigned long GlobalListLen; |
| 50 | static Type *GetType(const char *Type); |
| 51 | |
| 52 | const char *Label; |
| 53 | |
| 54 | virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator /*File*/) const {return 0;}; |
| 55 | Type(); |
| 56 | virtual ~Type() {}; |
| 57 | }; |
| 58 | |
| 59 | virtual const Type *GetType() const = 0; |
| 60 | |
| 61 | // Return descriptive strings of various sorts |
| 62 | virtual string ArchiveInfo(pkgCache::VerIterator Ver) const; |
| 63 | virtual string SourceInfo(pkgSrcRecords::Parser const &Record, |
| 64 | pkgSrcRecords::File const &File) const; |
| 65 | virtual string Describe(bool Short = false) const = 0; |
| 66 | |
| 67 | // Interface for acquire |
| 68 | virtual string ArchiveURI(string /*File*/) const {return string();}; |
| 69 | |
| 70 | // Interface for the record parsers |
| 71 | virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;}; |
| 72 | |
| 73 | // Interface for the Cache Generator |
| 74 | virtual bool Exists() const = 0; |
| 75 | virtual bool HasPackages() const = 0; |
| 76 | virtual unsigned long Size() const = 0; |
| 77 | virtual bool Merge(pkgCacheGenerator &/*Gen*/,OpProgress &/*Prog*/) const {return false;}; |
| 78 | virtual bool MergeFileProvides(pkgCacheGenerator &/*Gen*/,OpProgress &/*Prog*/) const {return true;}; |
| 79 | virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const; |
| 80 | |
| 81 | static bool TranslationsAvailable(); |
| 82 | static bool CheckLanguageCode(const char *Lang); |
| 83 | static string LanguageCode(); |
| 84 | |
| 85 | bool IsTrusted() const { return Trusted; }; |
| 86 | |
| 87 | pkgIndexFile(bool Trusted): Trusted(Trusted) {}; |
| 88 | virtual ~pkgIndexFile() {}; |
| 89 | }; |
| 90 | |
| 91 | #endif |