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 <map>
  33 #include <apt-pkg/pkgcache.h>
  34 #include <apt-pkg/tagfile.h>
  35
  36 #ifndef APT_8_CLEANER_HEADERS
  37 #include <apt-pkg/metaindex.h>
  38 using std::string;
  39 using std::vector;
  40 #endif
  41
  42 class pkgAcquire;
  43 class pkgIndexFile;
  44 class metaIndex;
  45
  46 class pkgSourceList
  47 {
  48    public:
  49
  50    // List of supported source list types
  51    class Type
  52    {
  53       public:
  54
  55       // Global list of Items supported
  56       static Type **GlobalList;
  57       static unsigned long GlobalListLen;
  58       static Type *GetType(const char *Type);
  59
  60       const char *Name;
  61       const char *Label;
  62
  63       bool FixupURI(std::string &URI) const;
  64       virtual bool ParseStanza(std::vector<metaIndex *> &List,
  65                                pkgTagSection &Tags,
  66                                int stanza_n,
  67                                FileFd &Fd);
  68       virtual bool ParseLine(std::vector<metaIndex *> &List,
  69                              const char *Buffer,
  70                              unsigned long const &CurLine,std::string const &File) const;
  71       virtual bool CreateItem(std::vector<metaIndex *> &List,std::string const &URI,
  72                               std::string const &Dist,std::string const &Section,
  73                               std::map<std::string, std::string> const &Options) const = 0;
  74       Type();
  75       virtual ~Type() {};
  76    };
  77
  78    typedef std::vector<metaIndex *>::const_iterator const_iterator;
  79
  80    protected:
  81
  82    std::vector<metaIndex *> SrcList;
  83
  84    int ParseFileDeb822(std::string File);
  85    bool ParseFileOldStyle(std::string File);
  86
  87    public:
  88
  89    bool ReadMainList();
  90    bool Read(std::string File);
  91
  92    // CNC:2003-03-03
  93    void Reset();
  94    bool ReadAppend(std::string File);
  95    bool ReadSourceDir(std::string Dir);
  96
  97    // List accessors
  98    inline const_iterator begin() const {return SrcList.begin();};
  99    inline const_iterator end() const {return SrcList.end();};
 100    inline unsigned int size() const {return SrcList.size();};
 101    inline bool empty() const {return SrcList.empty();};
 102
 103    bool FindIndex(pkgCache::PkgFileIterator File,
 104                   pkgIndexFile *&Found) const;
 105    bool GetIndexes(pkgAcquire *Owner, bool GetAll=false) const;
 106
 107    // query last-modified time
 108    time_t GetLastModifiedTime();
 109
 110    pkgSourceList();
 111    pkgSourceList(std::string File);
 112    ~pkgSourceList();
 113 };
 114
 115 #endif