apt-pkg/sourcelist.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: sourcelist.h,v 1.12.2.1 2003/12/24 23:09:17 mdz Exp $
   4 /* ######################################################################
   5
   6    SourceList - Manage a list of sources
   7
   8    The Source List class provides access to a list of sources. It
   9    can read them from a file and generate a list of all the distinct
  10    sources.
  11
  12    All sources have a type associated with them that defines the layout
  13    of the archive. The exact format of the file is documented in
  14    files.sgml.
  15
  16    The types are mapped through a list of type definitions which handle
  17    the actual construction of the back end type. After loading a source
  18    list all you have is a list of package index files that have the ability
  19    to be Acquired.
  20
  21    The vendor machanism is similar, except the vendor types are hard
  22    wired. Before loading the source list the vendor list is loaded.
  23    This doesn't load key data, just the checks to perform.
  24
  25    ##################################################################### */
  26                                                                         /*}}}*/
  27 #ifndef PKGLIB_SOURCELIST_H
  28 #define PKGLIB_SOURCELIST_H
  29
  30 #include <string>
  31 #include <vector>
  32 #include <apt-pkg/pkgcache.h>
  33 #include <apt-pkg/metaindex.h>
  34
  35 using std::string;
  36 using std::vector;
  37
  38
  39 class pkgAquire;
  40 class pkgSourceList
  41 {
  42    public:
  43
  44    // List of supported source list types
  45    class Type
  46    {
  47       public:
  48
  49       // Global list of Items supported
  50       static Type **GlobalList;
  51       static unsigned long GlobalListLen;
  52       static Type *GetType(const char *Type);
  53
  54       const char *Name;
  55       const char *Label;
  56
  57       bool FixupURI(string &URI) const;
  58       virtual bool ParseLine(vector<metaIndex *> &List,
  59                              const char *Buffer,
  60                              unsigned long CurLine,string File) const;
  61       virtual bool CreateItem(vector<metaIndex *> &List,string URI,
  62                               string Dist,string Section) const = 0;
  63       Type();
  64       virtual ~Type() {};
  65    };
  66
  67    typedef vector<metaIndex *>::const_iterator const_iterator;
  68
  69    protected:
  70
  71    vector<metaIndex *> SrcList;
  72
  73    public:
  74
  75    bool ReadMainList();
  76    bool Read(string File);
  77
  78    // CNC:2003-03-03
  79    void Reset();
  80    bool ReadAppend(string File);
  81    bool ReadSourceDir(string Dir);
  82
  83    // List accessors
  84    inline const_iterator begin() const {return SrcList.begin();};
  85    inline const_iterator end() const {return SrcList.end();};
  86    inline unsigned int size() const {return SrcList.size();};
  87    inline bool empty() const {return SrcList.empty();};
  88
  89    bool FindIndex(pkgCache::PkgFileIterator File,
  90                   pkgIndexFile *&Found) const;
  91    bool GetIndexes(pkgAcquire *Owner, bool GetAll=false) const;
  92
  93    pkgSourceList();
  94    pkgSourceList(string File);
  95    ~pkgSourceList();
  96 };
  97
  98 #endif