- initial import of revision 374 from cnc
[apt.git] / apt-pkg / sourcelist.h
1 // -*- mode: cpp; mode: fold -*-
2 // Description                                                          /*{{{*/
3 // $Id: sourcelist.h,v 1.2 2002/07/25 18:07:18 niemeyer 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 preform.
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/indexfile.h>
34
35 using std::string;
36 using std::vector;
37     
38 #ifdef __GNUG__
39 #pragma interface "apt-pkg/sourcelist.h"
40 #endif
41
42 class pkgAquire;
43 class pkgSourceList
44 {
45    public:
46    
47    // An available vendor
48    struct Vendor
49    {
50       string VendorID;
51       string FingerPrint;
52       string Description;
53
54       /* Lets revisit these..
55       bool MatchFingerPrint(string FingerPrint);
56       string FingerPrintDescr();*/
57    };
58    
59    // List of supported source list types
60    class Type
61    {
62       public:
63       
64       // Global list of Items supported
65       static Type **GlobalList;
66       static unsigned long GlobalListLen;
67       static Type *GetType(const char *Type);
68
69       const char *Name;
70       const char *Label;
71
72       bool FixupURI(string &URI) const;
73       virtual bool ParseLine(vector<pkgIndexFile *> &List,
74                              Vendor const *Vendor,
75                              const char *Buffer,
76                              unsigned long CurLine,string File) const;
77       virtual bool CreateItem(vector<pkgIndexFile *> &List,string URI,
78                               string Dist,string Section,
79                               Vendor const *Vendor) const = 0;
80
81       Type();
82       virtual ~Type() {};
83    };
84    
85    typedef vector<pkgIndexFile *>::const_iterator const_iterator;
86    
87    protected:
88
89    vector<pkgIndexFile *> SrcList;
90    vector<Vendor const *> VendorList;
91    
92    public:
93
94    bool ReadMainList();
95    bool Read(string File);
96    bool ReadVendors();
97
98    // CNC:2003-03-03
99    void Reset();
100    bool ReadAppend(string File);
101    bool ReadSourceDir(string 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) const;
112
113    // CNC:2002-07-04
114    bool GetReleases(pkgAcquire *Owner) const;
115    
116    pkgSourceList();
117    pkgSourceList(string File);
118    ~pkgSourceList();      
119 };
120
121 #endif