apt-pkg/sourcelist.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 /* ######################################################################
   4
   5    SourceList - Manage a list of sources
   6
   7    The Source List class provides access to a list of sources. It
   8    can read them from a file and generate a list of all the distinct
   9    sources.
  10
  11    All sources have a type associated with them that defines the layout
  12    of the archive. The exact format of the file is documented in
  13    files.sgml.
  14
  15    The types are mapped through a list of type definitions which handle
  16    the actual construction of the back end type. After loading a source
  17    list all you have is a list of package index files that have the ability
  18    to be Acquired.
  19
  20    ##################################################################### */
  21                                                                         /*}}}*/
  22 #ifndef PKGLIB_SOURCELIST_H
  23 #define PKGLIB_SOURCELIST_H
  24
  25 #include <apt-pkg/pkgcache.h>
  26 #include <apt-pkg/cacheiterators.h>
  27 #include <apt-pkg/macros.h>
  28
  29 #include <time.h>
  30
  31 #include <string>
  32 #include <vector>
  33 #include <map>
  34
  35 #ifndef APT_8_CLEANER_HEADERS
  36 #include <apt-pkg/tagfile.h>
  37 #endif
  38 #ifndef APT_8_CLEANER_HEADERS
  39 #include <apt-pkg/metaindex.h>
  40 using std::string;
  41 using std::vector;
  42 #endif
  43
  44 class FileFd;
  45 class pkgTagSection;
  46 class pkgAcquire;
  47 class pkgIndexFile;
  48 class metaIndex;
  49
  50 class pkgSourceList
  51 {
  52    void * const d;
  53    public:
  54
  55    // List of supported source list types
  56    class Type
  57    {
  58       public:
  59
  60       // Global list of Items supported
  61       static Type **GlobalList;
  62       static unsigned long GlobalListLen;
  63       static Type *GetType(const char *Type) APT_PURE;
  64
  65       char const * const Name;
  66       char const * const Label;
  67
  68       bool FixupURI(std::string &URI) const;
  69       virtual bool ParseStanza(std::vector<metaIndex *> &List,
  70                                pkgTagSection &Tags,
  71                                unsigned int const stanza_n,
  72                                FileFd &Fd);
  73       virtual bool ParseLine(std::vector<metaIndex *> &List,
  74                              const char *Buffer,
  75                              unsigned int const CurLine,std::string const &File) const;
  76       virtual bool CreateItem(std::vector<metaIndex *> &List,std::string const &URI,
  77                               std::string const &Dist,std::string const &Section,
  78                               std::map<std::string, std::string> const &Options) const = 0;
  79       Type(char const * const Name, char const * const Label);
  80       virtual ~Type();
  81    };
  82
  83    typedef std::vector<metaIndex *>::const_iterator const_iterator;
  84
  85    protected:
  86
  87    std::vector<metaIndex *> SrcList;
  88
  89    private:
  90    APT_HIDDEN bool ParseFileDeb822(std::string const &File);
  91    APT_HIDDEN bool ParseFileOldStyle(std::string const &File);
  92
  93    public:
  94
  95    bool ReadMainList();
  96    bool Read(std::string const &File);
  97
  98    // CNC:2003-03-03
  99    void Reset();
 100    bool ReadAppend(std::string const &File);
 101    bool ReadSourceDir(std::string const &Dir);
 102
 103    // List accessors
 104    inline const_iterator begin() const {return SrcList.begin();};
 105    inline const_iterator end() const {return SrcList.end();};
 106    inline unsigned int size() const {return SrcList.size();};
 107    inline bool empty() const {return SrcList.empty();};
 108
 109    bool FindIndex(pkgCache::PkgFileIterator File,
 110                   pkgIndexFile *&Found) const;
 111    bool GetIndexes(pkgAcquire *Owner, bool GetAll=false) const;
 112
 113    // query last-modified time
 114    time_t GetLastModifiedTime();
 115
 116    pkgSourceList();
 117    virtual ~pkgSourceList();
 118 };
 119
 120 #endif