* merged changes from Kamions upload (thanks!)
[apt.git] / apt-pkg / indexfile.h
1 // -*- mode: cpp; mode: fold -*-
2 // Description /*{{{*/
3 // $Id: indexfile.h,v 1.6.2.1 2003/12/24 23:09:17 mdz Exp $
4 /* ######################################################################
5
6 Index File - Abstraction for an index of archive/source file.
7
8 There are 3 primary sorts of index files, all represented by this
9 class:
10
11 Binary index files
12 Bianry index files decribing 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 acess the underlying representation.
18
19 ##################################################################### */
20 /*}}}*/
21 #ifndef PKGLIB_INDEXFILE_H
22 #define PKGLIB_INDEXFILE_H
23
24 #ifdef __GNUG__
25 #pragma interface "apt-pkg/indexfile.h"
26 #endif
27
28 #include <string>
29 #include <apt-pkg/pkgcache.h>
30 #include <apt-pkg/srcrecords.h>
31 #include <apt-pkg/pkgrecords.h>
32
33 using std::string;
34
35 class pkgAcquire;
36 class pkgCacheGenerator;
37 class OpProgress;
38 class pkgIndexFile
39 {
40 protected:
41 bool Trusted;
42
43 public:
44
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 *Label;
55
56 virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator /*File*/) const {return 0;};
57 Type();
58 virtual ~Type() {};
59 };
60
61 virtual const Type *GetType() const = 0;
62
63 // Return descriptive strings of various sorts
64 virtual string ArchiveInfo(pkgCache::VerIterator Ver) const;
65 virtual string SourceInfo(pkgSrcRecords::Parser const &Record,
66 pkgSrcRecords::File const &File) const;
67 virtual string Describe(bool Short = false) const = 0;
68
69 // Interface for acquire
70 virtual string ArchiveURI(string /*File*/) const {return string();};
71
72 // Interface for the record parsers
73 virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};
74
75 // Interface for the Cache Generator
76 virtual bool Exists() const = 0;
77 virtual bool HasPackages() const = 0;
78 virtual unsigned long Size() const = 0;
79 virtual bool Merge(pkgCacheGenerator &/*Gen*/,OpProgress &/*Prog*/) const {return false;};
80 virtual bool MergeFileProvides(pkgCacheGenerator &/*Gen*/,OpProgress &/*Prog*/) const {return true;};
81 virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
82
83 bool IsTrusted() const { return Trusted; };
84
85 pkgIndexFile(bool Trusted): Trusted(Trusted) {};
86 virtual ~pkgIndexFile() {};
87 };
88
89 #endif