apt-pkg/indexfile.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 /* ######################################################################
   4
   5    Index File - Abstraction for an index of archive/source file.
   6
   7    There are 4 primary sorts of index files, all represented by this
   8    class:
   9
  10    Binary index files
  11    Binary translation files
  12    Binary index files describing the local system
  13    Source index files
  14
  15    They are all bundled together here, and the interfaces for
  16    sources.list, acquire, cache gen and record parsing all use this class
  17    to access the underlying representation.
  18
  19    ##################################################################### */
  20                                                                         /*}}}*/
  21 #ifndef PKGLIB_INDEXFILE_H
  22 #define PKGLIB_INDEXFILE_H
  23
  24 #include <apt-pkg/srcrecords.h>
  25 #include <apt-pkg/pkgrecords.h>
  26 #include <apt-pkg/pkgcache.h>
  27 #include <apt-pkg/cacheiterators.h>
  28 #include <apt-pkg/macros.h>
  29
  30 #include <map>
  31 #include <string>
  32
  33 #ifndef APT_8_CLEANER_HEADERS
  34 using std::string;
  35 #endif
  36 #ifndef APT_10_CLEANER_HEADERS
  37 class pkgAcquire;
  38 #endif
  39
  40 class pkgCacheGenerator;
  41 class OpProgress;
  42
  43 class IndexTarget                                                       /*{{{*/
  44 /** \brief Information about an index file. */
  45 {
  46    public:
  47    /** \brief A URI from which the index file can be downloaded. */
  48    std::string URI;
  49
  50    /** \brief A description of the index file. */
  51    std::string Description;
  52
  53    /** \brief A shorter description of the index file. */
  54    std::string ShortDesc;
  55
  56    /** \brief The key by which this index file should be
  57        looked up within the meta index file. */
  58    std::string MetaKey;
  59
  60    /** \brief Is it okay if the file isn't found in the meta index */
  61    bool IsOptional;
  62
  63    /** \brief If the file is downloaded compressed, do not unpack it */
  64    bool KeepCompressed;
  65
  66    /** \brief options with which this target was created
  67        Prefer the usage of #Option if at all possible.
  68        Beware: Not all of these options are intended for public use */
  69    std::map<std::string, std::string> Options;
  70
  71    IndexTarget(std::string const &MetaKey, std::string const &ShortDesc,
  72          std::string const &LongDesc, std::string const &URI, bool const IsOptional,
  73          bool const KeepCompressed, std::map<std::string, std::string> const &Options);
  74
  75    enum OptionKeys {
  76       SITE,
  77       RELEASE,
  78       COMPONENT,
  79       LANGUAGE,
  80       ARCHITECTURE,
  81       BASE_URI,
  82       REPO_URI,
  83       CREATED_BY,
  84       TARGET_OF,
  85       FILENAME,
  86       EXISTING_FILENAME,
  87    };
  88    std::string Option(OptionKeys const Key) const;
  89    std::string Format(std::string format) const;
  90 };
  91                                                                         /*}}}*/
  92
  93 class pkgIndexFile
  94 {
  95    void * const d;
  96    protected:
  97    bool Trusted;
  98
  99    public:
 100
 101    class Type
 102    {
 103       public:
 104
 105       // Global list of Items supported
 106       static Type **GlobalList;
 107       static unsigned long GlobalListLen;
 108       static Type *GetType(const char *Type) APT_PURE;
 109
 110       const char *Label;
 111
 112       virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator /*File*/) const {return 0;};
 113       virtual pkgSrcRecords::Parser *CreateSrcPkgParser(std::string /*File*/) const {return 0;};
 114       Type();
 115       virtual ~Type() {};
 116    };
 117
 118    virtual const Type *GetType() const = 0;
 119
 120    // Return descriptive strings of various sorts
 121    virtual std::string ArchiveInfo(pkgCache::VerIterator Ver) const;
 122    virtual std::string SourceInfo(pkgSrcRecords::Parser const &Record,
 123                              pkgSrcRecords::File const &File) const;
 124    virtual std::string Describe(bool Short = false) const = 0;
 125
 126    // Interface for acquire
 127    virtual std::string ArchiveURI(std::string /*File*/) const {return std::string();};
 128
 129    // Interface for the record parsers
 130    virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};
 131
 132    // Interface for the Cache Generator
 133    virtual bool Exists() const = 0;
 134    virtual bool HasPackages() const = 0;
 135    virtual unsigned long Size() const = 0;
 136    virtual bool Merge(pkgCacheGenerator &/*Gen*/, OpProgress* /*Prog*/) const { return false; };
 137    APT_DEPRECATED virtual bool Merge(pkgCacheGenerator &Gen, OpProgress &Prog) const
 138       { return Merge(Gen, &Prog); };
 139    virtual bool MergeFileProvides(pkgCacheGenerator &/*Gen*/,OpProgress* /*Prog*/) const {return true;};
 140    APT_DEPRECATED virtual bool MergeFileProvides(pkgCacheGenerator &Gen, OpProgress &Prog) const
 141       {return MergeFileProvides(Gen, &Prog);};
 142    virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
 143
 144    static bool TranslationsAvailable();
 145    static bool CheckLanguageCode(const char *Lang);
 146    static std::string LanguageCode();
 147
 148    bool IsTrusted() const { return Trusted; };
 149
 150    explicit pkgIndexFile(bool Trusted);
 151    virtual ~pkgIndexFile();
 152 };
 153
 154 class pkgIndexTargetFile : public pkgIndexFile
 155 {
 156    void * const d;
 157 protected:
 158    IndexTarget const Target;
 159
 160    std::string IndexFileName() const;
 161
 162 public:
 163    virtual std::string ArchiveURI(std::string File) const APT_OVERRIDE;
 164    virtual std::string Describe(bool Short = false) const APT_OVERRIDE;
 165    virtual bool Exists() const APT_OVERRIDE;
 166    virtual unsigned long Size() const APT_OVERRIDE;
 167
 168    pkgIndexTargetFile(IndexTarget const &Target, bool const Trusted);
 169    virtual ~pkgIndexTargetFile();
 170 };
 171
 172 #endif