apt  0.9.7.7ubuntu3
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 4 primary sorts of index files, all represented by this
9  class:
10 
11  Binary index files
12  Binary translation files
13  Bianry index files decribing the local system
14  Source index files
15 
16  They are all bundled together here, and the interfaces for
17  sources.list, acquire, cache gen and record parsing all use this class
18  to acess the underlying representation.
19 
20  ##################################################################### */
21  /*}}}*/
22 #ifndef PKGLIB_INDEXFILE_H
23 #define PKGLIB_INDEXFILE_H
24 
25 
26 #include <string>
27 #include <apt-pkg/pkgcache.h>
28 #include <apt-pkg/srcrecords.h>
29 #include <apt-pkg/pkgrecords.h>
30 #include <apt-pkg/macros.h>
31 
32 #ifndef APT_8_CLEANER_HEADERS
33 using std::string;
34 #endif
35 
36 class pkgAcquire;
37 class pkgCacheGenerator;
38 class OpProgress;
39 
41 {
42  protected:
43  bool Trusted;
44 
45  public:
46 
47  class Type
48  {
49  public:
50 
51  // Global list of Items supported
52  static Type **GlobalList;
53  static unsigned long GlobalListLen;
54  static Type *GetType(const char *Type);
55 
56  const char *Label;
57 
58  virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator /*File*/) const {return 0;};
59  Type();
60  virtual ~Type() {};
61  };
62 
63  virtual const Type *GetType() const = 0;
64 
65  // Return descriptive strings of various sorts
66  virtual std::string ArchiveInfo(pkgCache::VerIterator Ver) const;
67  virtual std::string SourceInfo(pkgSrcRecords::Parser const &Record,
68  pkgSrcRecords::File const &File) const;
69  virtual std::string Describe(bool Short = false) const = 0;
70 
71  // Interface for acquire
72  virtual std::string ArchiveURI(std::string /*File*/) const {return std::string();};
73 
74  // Interface for the record parsers
75  virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};
76 
77  // Interface for the Cache Generator
78  virtual bool Exists() const = 0;
79  virtual bool HasPackages() const = 0;
80  virtual unsigned long Size() const = 0;
81  virtual bool Merge(pkgCacheGenerator &/*Gen*/,OpProgress* /*Prog*/) const { return false; };
82  __deprecated virtual bool Merge(pkgCacheGenerator &Gen, OpProgress &Prog) const
83  { return Merge(Gen, &Prog); };
84  virtual bool MergeFileProvides(pkgCacheGenerator &/*Gen*/,OpProgress* /*Prog*/) const {return true;};
85  __deprecated virtual bool MergeFileProvides(pkgCacheGenerator &Gen, OpProgress &Prog) const
86  {return MergeFileProvides(Gen, &Prog);};
87  virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
88 
89  static bool TranslationsAvailable();
90  static bool CheckLanguageCode(const char *Lang);
91  static std::string LanguageCode();
92 
93  bool IsTrusted() const { return Trusted; };
94 
95  pkgIndexFile(bool Trusted): Trusted(Trusted) {};
96  virtual ~pkgIndexFile() {};
97 };
98 
99 #endif