- initial import of revision 374 from cnc
[apt.git] / apt-pkg / pkgrecords.h
1 // -*- mode: cpp; mode: fold -*-
2 // Description                                                          /*{{{*/
3 // $Id: pkgrecords.h,v 1.2 2002/11/28 18:54:15 niemeyer Exp $
4 /* ######################################################################
5    
6    Package Records - Allows access to complete package description records
7                      directly from the file.
8    
9    The package record system abstracts the actual parsing of the 
10    package files. This is different than the generators parser in that
11    it is used to access information not generate information. No 
12    information touched by the generator should be parable from here as
13    it can always be retreived directly from the cache.
14    
15    ##################################################################### */
16                                                                         /*}}}*/
17 #ifndef PKGLIB_PKGRECORDS_H
18 #define PKGLIB_PKGRECORDS_H
19
20 #ifdef __GNUG__
21 #pragma interface "apt-pkg/pkgrecords.h"
22 #endif 
23
24 #include <apt-pkg/pkgcache.h>
25 #include <apt-pkg/fileutl.h>
26
27 class pkgRecords
28 {
29    public:
30    class Parser;
31    
32    private:
33    
34    pkgCache &Cache;
35    Parser **Files;
36       
37    // CNC:2002-11-28
38    int PackageFileCount;
39    
40    public:
41
42    // Lookup function
43    Parser &Lookup(pkgCache::VerFileIterator const &Ver);
44
45    // Construct destruct
46    pkgRecords(pkgCache &Cache);
47    ~pkgRecords();
48 };
49
50 class pkgRecords::Parser
51 {
52    protected:
53    
54    virtual bool Jump(pkgCache::VerFileIterator const &Ver) = 0;
55    
56    public:
57    friend class pkgRecords;
58    
59    // These refer to the archive file for the Version
60    virtual string FileName() {return string();};
61    virtual string MD5Hash() {return string();};
62    virtual string SHA1Hash() {return string();};
63    virtual string SourcePkg() {return string();};
64
65    // These are some general stats about the package
66    virtual string Maintainer() {return string();};
67    virtual string ShortDesc() {return string();};
68    virtual string LongDesc() {return string();};
69    virtual string Name() {return string();};
70    
71    // The record in binary form
72    virtual void GetRec(const char *&Start,const char *&Stop) {Start = Stop = 0;};
73
74    // CNC:2003-11-21
75    virtual bool HasFile(const char *File) {return false;};
76    
77    virtual ~Parser() {};
78 };
79
80 #endif