]> git.saurik.com Git - apt.git/blame - apt-pkg/cacheiterators.h
* doc/examples/configure-index:
[apt.git] / apt-pkg / cacheiterators.h
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
b3d44315 3// $Id: cacheiterators.h,v 1.18.2.1 2004/05/08 22:44:27 mdz Exp $
578bfd0a
AL
4/* ######################################################################
5
6 Cache Iterators - Iterators for navigating the cache structure
7
8 The iterators all provides ++,==,!=,->,* and end for their type.
9 The end function can be used to tell if the list has been fully
10 traversed.
11
12 Unlike STL iterators these contain helper functions to access the data
13 that is being iterated over. This is because the data structures can't
14 be formed in a manner that is intuitive to use and also mmapable.
15
16 For each variable in the target structure that would need a translation
17 to be accessed correctly a translating function of the same name is
18 present in the iterator. If applicable the translating function will
19 return an iterator.
20
21 The DepIterator can iterate over two lists, a list of 'version depends'
22 or a list of 'package reverse depends'. The type is determined by the
23 structure passed to the constructor, which should be the structure
6c139d6e
AL
24 that has the depends pointer as a member. The provide iterator has the
25 same system.
578bfd0a 26
094a497d 27 This header is not user includable, please use apt-pkg/pkgcache.h
578bfd0a
AL
28
29 ##################################################################### */
30 /*}}}*/
578bfd0a
AL
31#ifndef PKGLIB_CACHEITERATORS_H
32#define PKGLIB_CACHEITERATORS_H
33
6c139d6e 34#ifdef __GNUG__
094a497d 35#pragma interface "apt-pkg/cacheiterators.h"
6c139d6e
AL
36#endif
37
578bfd0a
AL
38// Package Iterator
39class pkgCache::PkgIterator
40{
b2e465d6 41 friend class pkgCache;
578bfd0a
AL
42 Package *Pkg;
43 pkgCache *Owner;
44 long HashIndex;
45
b2e465d6
AL
46 protected:
47
48 // This constructor is the 'begin' constructor, never use it.
49 inline PkgIterator(pkgCache &Owner) : Owner(&Owner), HashIndex(-1)
50 {
51 Pkg = Owner.PkgP;
52 operator ++(0);
53 };
54
578bfd0a
AL
55 public:
56
57 enum OkState {NeedsNothing,NeedsUnpack,NeedsConfigure};
58
59 // Iteration
60 void operator ++(int);
61 inline void operator ++() {operator ++(0);};
62 inline bool end() const {return Owner == 0 || Pkg == Owner->PkgP?true:false;};
63
64 // Comparison
65 inline bool operator ==(const PkgIterator &B) const {return Pkg == B.Pkg;};
66 inline bool operator !=(const PkgIterator &B) const {return Pkg != B.Pkg;};
67
68 // Accessors
69 inline Package *operator ->() {return Pkg;};
70 inline Package const *operator ->() const {return Pkg;};
71 inline Package const &operator *() const {return *Pkg;};
72 inline operator Package *() {return Pkg == Owner->PkgP?0:Pkg;};
73 inline operator Package const *() const {return Pkg == Owner->PkgP?0:Pkg;};
b2e465d6 74 inline pkgCache *Cache() {return Owner;};
6c139d6e 75
578bfd0a
AL
76 inline const char *Name() const {return Pkg->Name == 0?0:Owner->StrP + Pkg->Name;};
77 inline const char *Section() const {return Pkg->Section == 0?0:Owner->StrP + Pkg->Section;};
e3bf76d1
AL
78 inline bool Purge() const {return Pkg->CurrentState == pkgCache::State::Purge ||
79 (Pkg->CurrentVer == 0 && Pkg->CurrentState == pkgCache::State::NotInstalled);};
578bfd0a 80 inline VerIterator VersionList() const;
578bfd0a
AL
81 inline VerIterator CurrentVer() const;
82 inline DepIterator RevDependsList() const;
83 inline PrvIterator ProvidesList() const;
f55a958f 84 inline unsigned long Index() const {return Pkg - Owner->PkgP;};
578bfd0a
AL
85 OkState State() const;
86
87 // Constructors
578bfd0a
AL
88 inline PkgIterator(pkgCache &Owner,Package *Trg) : Pkg(Trg), Owner(&Owner),
89 HashIndex(0)
90 {
91 if (Pkg == 0)
92 Pkg = Owner.PkgP;
93 };
94 inline PkgIterator() : Pkg(0), Owner(0), HashIndex(0) {};
95};
96
97// Version Iterator
98class pkgCache::VerIterator
99{
100 Version *Ver;
f9eec0e7 101 pkgCache *Owner;
578bfd0a
AL
102
103 void _dummy();
104
105 public:
106
107 // Iteration
f9eec0e7 108 void operator ++(int) {if (Ver != Owner->VerP) Ver = Owner->VerP + Ver->NextVer;};
578bfd0a 109 inline void operator ++() {operator ++(0);};
dc1f50b9 110 inline bool end() const {return Owner == NULL || (Ver == Owner->VerP?true:false);};
f9eec0e7 111 inline void operator =(const VerIterator &B) {Ver = B.Ver; Owner = B.Owner;};
578bfd0a
AL
112
113 // Comparison
114 inline bool operator ==(const VerIterator &B) const {return Ver == B.Ver;};
115 inline bool operator !=(const VerIterator &B) const {return Ver != B.Ver;};
116 int CompareVer(const VerIterator &B) const;
117
118 // Accessors
119 inline Version *operator ->() {return Ver;};
120 inline Version const *operator ->() const {return Ver;};
121 inline Version &operator *() {return *Ver;};
122 inline Version const &operator *() const {return *Ver;};
f9eec0e7
AL
123 inline operator Version *() {return Ver == Owner->VerP?0:Ver;};
124 inline operator Version const *() const {return Ver == Owner->VerP?0:Ver;};
b2e465d6
AL
125 inline pkgCache *Cache() {return Owner;};
126
f9eec0e7
AL
127 inline const char *VerStr() const {return Ver->VerStr == 0?0:Owner->StrP + Ver->VerStr;};
128 inline const char *Section() const {return Ver->Section == 0?0:Owner->StrP + Ver->Section;};
129 inline const char *Arch() const {return Ver->Arch == 0?0:Owner->StrP + Ver->Arch;};
130 inline PkgIterator ParentPkg() const {return PkgIterator(*Owner,Owner->PkgP + Ver->ParentPkg);};
578bfd0a
AL
131 inline DepIterator DependsList() const;
132 inline PrvIterator ProvidesList() const;
dcb79bae 133 inline VerFileIterator FileList() const;
f9eec0e7 134 inline unsigned long Index() const {return Ver - Owner->VerP;};
b518cca6 135 bool Downloadable() const;
b2e465d6
AL
136 inline const char *PriorityType() {return Owner->Priority(Ver->Priority);};
137 string RelStr();
138
3c124dde
AL
139 bool Automatic() const;
140 VerFileIterator NewestFile() const;
f9eec0e7
AL
141
142 inline VerIterator() : Ver(0), Owner(0) {};
143 inline VerIterator(pkgCache &Owner,Version *Trg = 0) : Ver(Trg),
144 Owner(&Owner)
578bfd0a
AL
145 {
146 if (Ver == 0)
147 Ver = Owner.VerP;
148 };
149};
150
151// Dependency iterator
152class pkgCache::DepIterator
153{
154 Dependency *Dep;
155 enum {DepVer, DepRev} Type;
156 pkgCache *Owner;
157
158 void _dummy();
159
160 public:
161
162 // Iteration
163 void operator ++(int) {if (Dep != Owner->DepP) Dep = Owner->DepP +
164 (Type == DepVer?Dep->NextDepends:Dep->NextRevDepends);};
165 inline void operator ++() {operator ++(0);};
166 inline bool end() const {return Owner == 0 || Dep == Owner->DepP?true:false;};
167
168 // Comparison
169 inline bool operator ==(const DepIterator &B) const {return Dep == B.Dep;};
170 inline bool operator !=(const DepIterator &B) const {return Dep != B.Dep;};
171
172 // Accessors
173 inline Dependency *operator ->() {return Dep;};
174 inline Dependency const *operator ->() const {return Dep;};
175 inline Dependency &operator *() {return *Dep;};
176 inline Dependency const &operator *() const {return *Dep;};
177 inline operator Dependency *() {return Dep == Owner->DepP?0:Dep;};
178 inline operator Dependency const *() const {return Dep == Owner->DepP?0:Dep;};
b2e465d6 179 inline pkgCache *Cache() {return Owner;};
6c139d6e 180
578bfd0a
AL
181 inline const char *TargetVer() const {return Dep->Version == 0?0:Owner->StrP + Dep->Version;};
182 inline PkgIterator TargetPkg() {return PkgIterator(*Owner,Owner->PkgP + Dep->Package);};
b2e465d6 183 inline PkgIterator SmartTargetPkg() {PkgIterator R(*Owner,0);SmartTargetPkg(R);return R;};
578bfd0a
AL
184 inline VerIterator ParentVer() {return VerIterator(*Owner,Owner->VerP + Dep->ParentVer);};
185 inline PkgIterator ParentPkg() {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[Dep->ParentVer].ParentPkg);};
578bfd0a 186 inline bool Reverse() {return Type == DepRev;};
f55a958f 187 inline unsigned long Index() const {return Dep - Owner->DepP;};
6c139d6e 188 bool IsCritical();
43d017d6 189 void GlobOr(DepIterator &Start,DepIterator &End);
6c139d6e
AL
190 Version **AllTargets();
191 bool SmartTargetPkg(PkgIterator &Result);
b2e465d6
AL
192 inline const char *CompType() {return Owner->CompType(Dep->CompareOp);};
193 inline const char *DepType() {return Owner->DepType(Dep->Type);};
0a8e3465 194
578bfd0a
AL
195 inline DepIterator(pkgCache &Owner,Dependency *Trg,Version * = 0) :
196 Dep(Trg), Type(DepVer), Owner(&Owner)
197 {
198 if (Dep == 0)
199 Dep = Owner.DepP;
200 };
201 inline DepIterator(pkgCache &Owner,Dependency *Trg,Package *) :
202 Dep(Trg), Type(DepRev), Owner(&Owner)
203 {
204 if (Dep == 0)
205 Dep = Owner.DepP;
206 };
207 inline DepIterator() : Dep(0), Type(DepVer), Owner(0) {};
208};
209
210// Provides iterator
211class pkgCache::PrvIterator
212{
213 Provides *Prv;
214 enum {PrvVer, PrvPkg} Type;
215 pkgCache *Owner;
216
217 void _dummy();
218
219 public:
220
221 // Iteration
222 void operator ++(int) {if (Prv != Owner->ProvideP) Prv = Owner->ProvideP +
223 (Type == PrvVer?Prv->NextPkgProv:Prv->NextProvides);};
224 inline void operator ++() {operator ++(0);};
13e8426f 225 inline bool end() const {return Owner == 0 || Prv == Owner->ProvideP?true:false;};
578bfd0a
AL
226
227 // Comparison
228 inline bool operator ==(const PrvIterator &B) const {return Prv == B.Prv;};
229 inline bool operator !=(const PrvIterator &B) const {return Prv != B.Prv;};
230
231 // Accessors
232 inline Provides *operator ->() {return Prv;};
233 inline Provides const *operator ->() const {return Prv;};
234 inline Provides &operator *() {return *Prv;};
235 inline Provides const &operator *() const {return *Prv;};
236 inline operator Provides *() {return Prv == Owner->ProvideP?0:Prv;};
237 inline operator Provides const *() const {return Prv == Owner->ProvideP?0:Prv;};
b2e465d6 238 inline pkgCache *Cache() {return Owner;};
6c139d6e 239
578bfd0a
AL
240 inline const char *Name() const {return Owner->StrP + Owner->PkgP[Prv->ParentPkg].Name;};
241 inline const char *ProvideVersion() const {return Prv->ProvideVersion == 0?0:Owner->StrP + Prv->ProvideVersion;};
242 inline PkgIterator ParentPkg() {return PkgIterator(*Owner,Owner->PkgP + Prv->ParentPkg);};
243 inline VerIterator OwnerVer() {return VerIterator(*Owner,Owner->VerP + Prv->Version);};
244 inline PkgIterator OwnerPkg() {return PkgIterator(*Owner,Owner->PkgP + Owner->VerP[Prv->Version].ParentPkg);};
f55a958f 245 inline unsigned long Index() const {return Prv - Owner->ProvideP;};
578bfd0a 246
c320a1e6 247 inline PrvIterator() : Prv(0), Type(PrvVer), Owner(0) {};
13e8426f 248
578bfd0a
AL
249 inline PrvIterator(pkgCache &Owner,Provides *Trg,Version *) :
250 Prv(Trg), Type(PrvVer), Owner(&Owner)
251 {
252 if (Prv == 0)
253 Prv = Owner.ProvideP;
254 };
255 inline PrvIterator(pkgCache &Owner,Provides *Trg,Package *) :
256 Prv(Trg), Type(PrvPkg), Owner(&Owner)
257 {
258 if (Prv == 0)
259 Prv = Owner.ProvideP;
260 };
261};
262
263// Package file
264class pkgCache::PkgFileIterator
265{
266 pkgCache *Owner;
267 PackageFile *File;
268
269 public:
270
271 // Iteration
272 void operator ++(int) {if (File!= Owner->PkgFileP) File = Owner->PkgFileP + File->NextFile;};
273 inline void operator ++() {operator ++(0);};
274 inline bool end() const {return File == Owner->PkgFileP?true:false;};
275
276 // Comparison
277 inline bool operator ==(const PkgFileIterator &B) const {return File == B.File;};
278 inline bool operator !=(const PkgFileIterator &B) const {return File != B.File;};
279
280 // Accessors
281 inline PackageFile *operator ->() {return File;};
282 inline PackageFile const *operator ->() const {return File;};
283 inline PackageFile const &operator *() const {return *File;};
284 inline operator PackageFile *() {return File == Owner->PkgFileP?0:File;};
285 inline operator PackageFile const *() const {return File == Owner->PkgFileP?0:File;};
b2e465d6 286 inline pkgCache *Cache() {return Owner;};
578bfd0a
AL
287
288 inline const char *FileName() const {return File->FileName == 0?0:Owner->StrP + File->FileName;};
b0b4efb9
AL
289 inline const char *Archive() const {return File->Archive == 0?0:Owner->StrP + File->Archive;};
290 inline const char *Component() const {return File->Component == 0?0:Owner->StrP + File->Component;};
578bfd0a 291 inline const char *Version() const {return File->Version == 0?0:Owner->StrP + File->Version;};
b0b4efb9 292 inline const char *Origin() const {return File->Origin == 0?0:Owner->StrP + File->Origin;};
a2ec6097 293 inline const char *Label() const {return File->Label == 0?0:Owner->StrP + File->Label;};
b2e465d6
AL
294 inline const char *Site() const {return File->Site == 0?0:Owner->StrP + File->Site;};
295 inline const char *Architecture() const {return File->Architecture == 0?0:Owner->StrP + File->Architecture;};
296 inline const char *IndexType() const {return File->IndexType == 0?0:Owner->StrP + File->IndexType;};
b0b4efb9 297
f55a958f 298 inline unsigned long Index() const {return File - Owner->PkgFileP;};
578bfd0a
AL
299
300 bool IsOk();
af87ab54
AL
301 string RelStr();
302
578bfd0a 303 // Constructors
b2e465d6
AL
304 inline PkgFileIterator() : Owner(0), File(0) {};
305 inline PkgFileIterator(pkgCache &Owner) : Owner(&Owner), File(Owner.PkgFileP) {};
578bfd0a
AL
306 inline PkgFileIterator(pkgCache &Owner,PackageFile *Trg) : Owner(&Owner), File(Trg) {};
307};
308
dcb79bae
AL
309// Version File
310class pkgCache::VerFileIterator
311{
312 pkgCache *Owner;
313 VerFile *FileP;
314
315 public:
316
317 // Iteration
318 void operator ++(int) {if (FileP != Owner->VerFileP) FileP = Owner->VerFileP + FileP->NextFile;};
319 inline void operator ++() {operator ++(0);};
320 inline bool end() const {return FileP == Owner->VerFileP?true:false;};
321
322 // Comparison
323 inline bool operator ==(const VerFileIterator &B) const {return FileP == B.FileP;};
324 inline bool operator !=(const VerFileIterator &B) const {return FileP != B.FileP;};
325
326 // Accessors
327 inline VerFile *operator ->() {return FileP;};
328 inline VerFile const *operator ->() const {return FileP;};
329 inline VerFile const &operator *() const {return *FileP;};
330 inline operator VerFile *() {return FileP == Owner->VerFileP?0:FileP;};
331 inline operator VerFile const *() const {return FileP == Owner->VerFileP?0:FileP;};
b2e465d6 332 inline pkgCache *Cache() {return Owner;};
dcb79bae
AL
333
334 inline PkgFileIterator File() const {return PkgFileIterator(*Owner,FileP->File + Owner->PkgFileP);};
335 inline unsigned long Index() const {return FileP - Owner->VerFileP;};
b518cca6 336
b2e465d6 337 inline VerFileIterator() : Owner(0), FileP(0) {};
dcb79bae
AL
338 inline VerFileIterator(pkgCache &Owner,VerFile *Trg) : Owner(&Owner), FileP(Trg) {};
339};
340
578bfd0a
AL
341// Inlined Begin functions cant be in the class because of order problems
342inline pkgCache::VerIterator pkgCache::PkgIterator::VersionList() const
343 {return VerIterator(*Owner,Owner->VerP + Pkg->VersionList);};
344inline pkgCache::VerIterator pkgCache::PkgIterator::CurrentVer() const
345 {return VerIterator(*Owner,Owner->VerP + Pkg->CurrentVer);};
578bfd0a
AL
346inline pkgCache::DepIterator pkgCache::PkgIterator::RevDependsList() const
347 {return DepIterator(*Owner,Owner->DepP + Pkg->RevDepends,Pkg);};
348inline pkgCache::PrvIterator pkgCache::PkgIterator::ProvidesList() const
349 {return PrvIterator(*Owner,Owner->ProvideP + Pkg->ProvidesList,Pkg);};
350inline pkgCache::PrvIterator pkgCache::VerIterator::ProvidesList() const
f9eec0e7 351 {return PrvIterator(*Owner,Owner->ProvideP + Ver->ProvidesList,Ver);};
578bfd0a 352inline pkgCache::DepIterator pkgCache::VerIterator::DependsList() const
f9eec0e7 353 {return DepIterator(*Owner,Owner->DepP + Ver->DependsList,Ver);};
dcb79bae 354inline pkgCache::VerFileIterator pkgCache::VerIterator::FileList() const
f9eec0e7 355 {return VerFileIterator(*Owner,Owner->VerFileP + Ver->FileList);};
578bfd0a
AL
356
357#endif