]> git.saurik.com Git - apt.git/blame - apt-pkg/pkgcache.h
search for pkg names in the cache case-sensitive
[apt.git] / apt-pkg / pkgcache.h
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
94449d7c
DK
3/**\file pkgcache.h
4 \brief pkgCache - Structure definitions for the cache file
5
6 The goal of the cache file is two fold:
7 Firstly to speed loading and processing of the package file array and
8 secondly to reduce memory consumption of the package file array.
9
10 The implementation is aimed at an environment with many primary package
11 files, for instance someone that has a Package file for their CD-ROM, a
12 Package file for the latest version of the distribution on the CD-ROM and a
13 package file for the development version. Always present is the information
14 contained in the status file which might be considered a separate package
15 file.
16
17 Please understand, this is designed as a <b>Cache file</b> it is not meant to be
18 used on any system other than the one it was created for. It is not meant to
19 be authoritative either, i.e. if a system crash or software failure occurs it
20 must be perfectly acceptable for the cache file to be in an inconsistent
21 state. Furthermore at any time the cache file may be erased without losing
22 any information.
23
24 Also the structures and storage layout is optimized for use by the APT
25 and may not be suitable for all purposes. However it should be possible
26 to extend it with associate cache files that contain other information.
27
28 To keep memory use down the cache file only contains often used fields and
29 fields that are inexpensive to store, the Package file has a full list of
30 fields. Also the client may assume that all items are perfectly valid and
31 need not perform checks against their correctness. Removal of information
32 from the cache is possible, but blanks will be left in the file, and
33 unused strings will also be present. The recommended implementation is to
34 simply rebuild the cache each time any of the data files change. It is
35 possible to add a new package file to the cache without any negative side
36 effects.
37
38 <b>Note on Pointer access</b>
578bfd0a 39 Clients should always use the CacheIterators classes for access to the
94449d7c
DK
40 cache and the data in it. They also provide a simple STL-like method for
41 traversing the links of the datastructure.
42
43 Every item in every structure is stored as the index to that structure.
44 What this means is that once the files is mmaped every data access has to
45 go through a fix up stage to get a real memory pointer. This is done
46 by taking the index, multiplying it by the type size and then adding
47 it to the start address of the memory block. This sounds complex, but
48 in C it is a single array dereference. Because all items are aligned to
49 their size and indexes are stored as multiples of the size of the structure
50 the format is immediately portable to all possible architectures - BUT the
51 generated files are -NOT-.
52
53 This scheme allows code like this to be written:
54 <example>
55 void *Map = mmap(...);
56 Package *PkgList = (Package *)Map;
57 Header *Head = (Header *)Map;
58 char *Strings = (char *)Map;
59 cout << (Strings + PkgList[Head->HashTable[0]]->Name) << endl;
60 </example>
61 Notice the lack of casting or multiplication. The net result is to return
62 the name of the first package in the first hash bucket, without error
63 checks.
64
65 The generator uses allocation pools to group similarly sized structures in
66 large blocks to eliminate any alignment overhead. The generator also
67 assures that no structures overlap and all indexes are unique. Although
68 at first glance it may seem like there is the potential for two structures
69 to exist at the same point the generator never allows this to happen.
70 (See the discussion of free space pools)
71
72 See \ref pkgcachegen.h for more information about generating cache structures. */
578bfd0a 73 /*}}}*/
578bfd0a
AL
74#ifndef PKGLIB_PKGCACHE_H
75#define PKGLIB_PKGCACHE_H
76
a02db58f
DK
77#include <apt-pkg/mmap.h>
78#include <apt-pkg/macros.h>
79
578bfd0a
AL
80#include <string>
81#include <time.h>
4ad8619b 82#include <stdint.h>
0a843901 83
a4f6bdc8
DK
84#ifndef APT_8_CLEANER_HEADERS
85using std::string;
86#endif
87
4ad8619b
DK
88// storing file sizes of indexes, which are way below 4 GB for now
89typedef uint32_t map_filesize_t;
90// each package/group/dependency gets an id
91typedef uint32_t map_id_t;
92// some files get an id, too, but in far less absolute numbers
93typedef uint16_t map_fileid_t;
94// relative pointer from cache start
95typedef uint32_t map_pointer_t;
96// same as the previous, but documented to be to a string item
97typedef map_pointer_t map_stringitem_t;
98
b2e465d6 99class pkgVersioningSystem;
92fcbfc1 100class pkgCache /*{{{*/
578bfd0a
AL
101{
102 public:
103 // Cache element predeclarations
104 struct Header;
5bf15716 105 struct Group;
578bfd0a
AL
106 struct Package;
107 struct PackageFile;
108 struct Version;
a52f938b 109 struct Description;
578bfd0a
AL
110 struct Provides;
111 struct Dependency;
112 struct StringItem;
dcb79bae 113 struct VerFile;
a52f938b 114 struct DescFile;
578bfd0a
AL
115
116 // Iterators
773e2c1f 117 template<typename Str, typename Itr> class Iterator;
5bf15716 118 class GrpIterator;
578bfd0a
AL
119 class PkgIterator;
120 class VerIterator;
a52f938b 121 class DescIterator;
578bfd0a
AL
122 class DepIterator;
123 class PrvIterator;
124 class PkgFileIterator;
dcb79bae 125 class VerFileIterator;
a52f938b 126 class DescFileIterator;
b2e465d6
AL
127
128 class Namespace;
dcb79bae 129
f55a958f 130 // These are all the constants used in the cache structures
308c7d30
IJ
131
132 // WARNING - if you change these lists you must also edit
133 // the stringification in pkgcache.cc and also consider whether
134 // the cache file will become incompatible.
6c139d6e
AL
135 struct Dep
136 {
137 enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
f8ae7e8b 138 Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8,Enhances=9};
94449d7c
DK
139 /** \brief available compare operators
140
141 The lower 4 bits are used to indicate what operator is being specified and
142 the upper 4 bits are flags. OR indicates that the next package is
143 or'd with the current package. */
6c139d6e
AL
144 enum DepCompareOp {Or=0x10,NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
145 Greater=0x4,Equals=0x5,NotEquals=0x6};
146 };
147
148 struct State
149 {
94449d7c
DK
150 /** \brief priority of a package version
151
152 Zero is used for unparsable or absent Priority fields. */
9005f08e 153 enum VerPriority {Required=1,Important=2,Standard=3,Optional=4,Extra=5};
6c139d6e
AL
154 enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
155 enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
156 enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,
9d06bc80
MV
157 HalfInstalled=4,ConfigFiles=5,Installed=6,
158 TriggersAwaited=7,TriggersPending=8};
6c139d6e
AL
159 };
160
161 struct Flag
162 {
138d4b3d 163 enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
5ed56f93 164 enum PkgFFlags {NotSource=(1<<0),NotAutomatic=(1<<1),ButAutomaticUpgrades=(1<<2)};
6c139d6e 165 };
578bfd0a
AL
166
167 protected:
168
169 // Memory mapped cache file
8f3ba4e8 170 std::string CacheFile;
578bfd0a
AL
171 MMap &Map;
172
4ad8619b
DK
173 map_id_t sHash(const std::string &S) const APT_PURE;
174 map_id_t sHash(const char *S) const APT_PURE;
578bfd0a
AL
175
176 public:
177
178 // Pointers to the arrays of items
179 Header *HeaderP;
5bf15716 180 Group *GrpP;
578bfd0a 181 Package *PkgP;
dcb79bae 182 VerFile *VerFileP;
a52f938b 183 DescFile *DescFileP;
578bfd0a
AL
184 PackageFile *PkgFileP;
185 Version *VerP;
a52f938b 186 Description *DescP;
578bfd0a
AL
187 Provides *ProvideP;
188 Dependency *DepP;
189 StringItem *StringItemP;
190 char *StrP;
dcb79bae 191
a9fe5928 192 virtual bool ReMap(bool const &Errorchecks = true);
d3e8fbb3
DK
193 inline bool Sync() {return Map.Sync();}
194 inline MMap &GetMap() {return Map;}
195 inline void *DataEnd() {return ((unsigned char *)Map.Data()) + Map.Size();}
b2e465d6 196
578bfd0a 197 // String hashing function (512 range)
4ad8619b
DK
198 inline map_id_t Hash(const std::string &S) const {return sHash(S);}
199 inline map_id_t Hash(const char *S) const {return sHash(S);}
578bfd0a 200
94449d7c 201 // Useful transformation things
0149949b
AL
202 const char *Priority(unsigned char Priority);
203
578bfd0a 204 // Accessors
8f3ba4e8
DK
205 GrpIterator FindGrp(const std::string &Name);
206 PkgIterator FindPkg(const std::string &Name);
207 PkgIterator FindPkg(const std::string &Name, const std::string &Arch);
5bf15716 208
d3e8fbb3 209 Header &Head() {return *HeaderP;}
25396fb0
DK
210 inline GrpIterator GrpBegin();
211 inline GrpIterator GrpEnd();
578bfd0a
AL
212 inline PkgIterator PkgBegin();
213 inline PkgIterator PkgEnd();
ad00ae81
AL
214 inline PkgFileIterator FileBegin();
215 inline PkgFileIterator FileEnd();
b2e465d6 216
d3e8fbb3 217 inline bool MultiArchCache() const { return MultiArchEnabled; }
d64e130a 218 inline char const * NativeArch();
8d4c859d 219
b2e465d6
AL
220 // Make me a function
221 pkgVersioningSystem *VS;
222
223 // Converters
a02db58f
DK
224 static const char *CompTypeDeb(unsigned char Comp) APT_CONST;
225 static const char *CompType(unsigned char Comp) APT_CONST;
b2e465d6 226 static const char *DepType(unsigned char Dep);
ad00ae81 227
b2e465d6 228 pkgCache(MMap *Map,bool DoMap = true);
d3e8fbb3 229 virtual ~pkgCache() {}
8d4c859d
DK
230
231private:
232 bool MultiArchEnabled;
8f3ba4e8 233 PkgIterator SingleArchFindPkg(const std::string &Name);
578bfd0a 234};
92fcbfc1
DK
235 /*}}}*/
236// Header structure /*{{{*/
578bfd0a
AL
237struct pkgCache::Header
238{
94449d7c
DK
239 /** \brief Signature information
240
241 This must contain the hex value 0x98FE76DC which is designed to
242 verify that the system loading the image has the same byte order
243 and byte size as the system saving the image */
578bfd0a 244 unsigned long Signature;
94449d7c 245 /** These contain the version of the cache file */
578bfd0a
AL
246 short MajorVersion;
247 short MinorVersion;
94449d7c
DK
248 /** \brief indicates if the cache should be erased
249
250 Dirty is true if the cache file was opened for reading, the client
251 expects to have written things to it and have not fully synced it.
252 The file should be erased and rebuilt if it is true. */
578bfd0a 253 bool Dirty;
94449d7c
DK
254
255 /** \brief Size of structure values
256
257 All *Sz variables contains the sizeof() that particular structure.
258 It is used as an extra consistency check on the structure of the file.
259
260 If any of the size values do not exactly match what the client expects
261 then the client should refuse the load the file. */
578bfd0a 262 unsigned short HeaderSz;
52c41485 263 unsigned short GroupSz;
578bfd0a
AL
264 unsigned short PackageSz;
265 unsigned short PackageFileSz;
266 unsigned short VersionSz;
a52f938b 267 unsigned short DescriptionSz;
578bfd0a
AL
268 unsigned short DependencySz;
269 unsigned short ProvidesSz;
dcb79bae 270 unsigned short VerFileSz;
a52f938b 271 unsigned short DescFileSz;
94449d7c
DK
272
273 /** \brief Structure counts
274
275 These indicate the number of each structure contained in the cache.
276 PackageCount is especially useful for generating user state structures.
277 See Package::Id for more info. */
4ad8619b
DK
278 map_id_t GroupCount;
279 map_id_t PackageCount;
280 map_id_t VersionCount;
281 map_id_t DescriptionCount;
282 map_id_t DependsCount;
283 map_fileid_t PackageFileCount;
284 map_fileid_t VerFileCount;
285 map_fileid_t DescFileCount;
286 map_id_t ProvidesCount;
94449d7c
DK
287
288 /** \brief index of the first PackageFile structure
289
290 The PackageFile structures are singly linked lists that represent
291 all package files that have been merged into the cache. */
4ad8619b 292 map_pointer_t FileList;
94449d7c
DK
293 /** \brief index of the first StringItem structure
294
295 The cache contains a list of all the unique strings (StringItems).
296 The parser reads this list into memory so it can match strings
297 against it.*/
4ad8619b 298 map_pointer_t StringList;
94449d7c 299 /** \brief String representing the version system used */
4ad8619b 300 map_pointer_t VerSysName;
7a223b93 301 /** \brief native architecture the cache was built against */
4ad8619b 302 map_pointer_t Architecture;
7a223b93 303 /** \brief all architectures the cache was built against */
4ad8619b 304 map_pointer_t Architectures;
94449d7c 305 /** \brief The maximum size of a raw entry from the original Package file */
4ad8619b 306 map_filesize_t MaxVerFileSize;
94449d7c 307 /** \brief The maximum size of a raw entry from the original Translation file */
4ad8619b 308 map_filesize_t MaxDescFileSize;
578bfd0a 309
94449d7c
DK
310 /** \brief The Pool structures manage the allocation pools that the generator uses
311
312 Start indicates the first byte of the pool, Count is the number of objects
313 remaining in the pool and ItemSize is the structure size (alignment factor)
314 of the pool. An ItemSize of 0 indicates the pool is empty. There should be
315 the same number of pools as there are structure types. The generator
316 stores this information so future additions can make use of any unused pool
317 blocks. */
5bf15716 318 DynamicMMap::Pool Pools[9];
e8a7b0b2 319
94449d7c
DK
320 /** \brief hash tables providing rapid group/package name lookup
321
e8a7b0b2 322 Each group/package name is inserted into a hash table using pkgCache::Hash(const &string)
94449d7c
DK
323 By iterating over each entry in the hash table it is possible to iterate over
324 the entire list of packages. Hash Collisions are handled with a singly linked
325 list of packages based at the hash item. The linked list contains only
326 packages that match the hashing function.
327 In the PkgHashTable is it possible that multiple packages have the same name -
328 these packages are stored as a sequence in the list.
e8a7b0b2
DK
329 The size of both tables is the same. */
330 unsigned int HashTableSize;
4ad8619b
DK
331 map_pointer_t * PkgHashTable() const { return (map_pointer_t*) (this + 1); }
332 map_pointer_t * GrpHashTable() const { return PkgHashTable() + HashTableSize; }
578bfd0a 333
0688ccd8 334 /** \brief Size of the complete cache file */
4ad8619b 335 unsigned long long CacheFileSize;
0688ccd8 336
a02db58f 337 bool CheckSizes(Header &Against) const APT_PURE;
578bfd0a
AL
338 Header();
339};
92fcbfc1 340 /*}}}*/
94449d7c
DK
341// Group structure /*{{{*/
342/** \brief groups architecture depending packages together
5bf15716 343
94449d7c
DK
344 On or more packages with the same name form a group, so we have
345 a simple way to access a package built for different architectures
346 Group exists in a singly linked list of group records starting at
347 the hash index of the name in the pkgCache::Header::GrpHashTable */
348struct pkgCache::Group
349{
350 /** \brief Name of the group */
4ad8619b 351 map_stringitem_t Name;
94449d7c
DK
352
353 // Linked List
52c41485 354 /** \brief Link to the first package which belongs to the group */
4ad8619b 355 map_pointer_t FirstPackage; // Package
52c41485 356 /** \brief Link to the last package which belongs to the group */
4ad8619b 357 map_pointer_t LastPackage; // Package
52c41485 358 /** \brief Link to the next Group */
4ad8619b 359 map_pointer_t Next; // Group
52c41485 360 /** \brief unique sequel ID */
4ad8619b 361 map_id_t ID;
52c41485 362
5bf15716
DK
363};
364 /*}}}*/
94449d7c
DK
365// Package structure /*{{{*/
366/** \brief contains information for a single unique package
367
368 There can be any number of versions of a given package.
369 Package exists in a singly linked list of package records starting at
370 the hash index of the name in the pkgCache::Header::PkgHashTable
371
372 A package can be created for every architecture so package names are
1e3f4083 373 not unique, but it is guaranteed that packages with the same name
94449d7c
DK
374 are sequencel ordered in the list. Packages with the same name can be
375 accessed with the Group.
376*/
377struct pkgCache::Package
578bfd0a 378{
fe86debb
DK
379 /** \brief Name of the package
380 * Note that the access method Name() will remain. It is just this data member
381 * deprecated as this information is already stored and available via the
382 * associated Group – so it is wasting precious binary cache space */
383 APT_DEPRECATED map_stringitem_t Name;
94449d7c 384 /** \brief Architecture of the package */
4ad8619b 385 map_stringitem_t Arch;
94449d7c
DK
386 /** \brief Base of a singly linked list of versions
387
388 Each structure represents a unique version of the package.
389 The version structures contain links into PackageFile and the
390 original text file as well as detailed information about the size
391 and dependencies of the specific package. In this way multiple
392 versions of a package can be cleanly handled by the system.
393 Furthermore, this linked list is guaranteed to be sorted
394 from Highest version to lowest version with no duplicate entries. */
4ad8619b 395 map_pointer_t VersionList; // Version
94449d7c 396 /** \brief index to the installed version */
4ad8619b 397 map_pointer_t CurrentVer; // Version
94449d7c 398 /** \brief index of the group this package belongs to */
4ad8619b 399 map_pointer_t Group; // Group the Package belongs to
94449d7c
DK
400
401 // Linked list
402 /** \brief Link to the next package in the same bucket */
4ad8619b 403 map_pointer_t Next; // Package
94449d7c 404 /** \brief List of all dependencies on this package */
4ad8619b 405 map_pointer_t RevDepends; // Dependency
94449d7c 406 /** \brief List of all "packages" this package provide */
4ad8619b 407 map_pointer_t ProvidesList; // Provides
a52f938b 408
578bfd0a 409 // Install/Remove/Purge etc
94449d7c 410 /** \brief state that the user wishes the package to be in */
578bfd0a 411 unsigned char SelectedState; // What
94449d7c
DK
412 /** \brief installation state of the package
413
414 This should be "ok" but in case the installation failed
415 it will be different.
416 */
578bfd0a 417 unsigned char InstState; // Flags
94449d7c 418 /** \brief indicates if the package is installed */
578bfd0a 419 unsigned char CurrentState; // State
94449d7c
DK
420
421 /** \brief unique sequel ID
422
423 ID is a unique value from 0 to Header->PackageCount assigned by the generator.
424 This allows clients to create an array of size PackageCount and use it to store
425 state information for the package map. For instance the status file emitter uses
426 this to track which packages have been emitted already. */
4ad8619b 427 map_id_t ID;
94449d7c 428 /** \brief some useful indicators of the package's state */
f55a958f 429 unsigned long Flags;
578bfd0a 430};
92fcbfc1 431 /*}}}*/
94449d7c
DK
432// Package File structure /*{{{*/
433/** \brief stores information about the files used to generate the cache
434
435 Package files are referenced by Version structures to be able to know
436 after the generation still from which Packages file includes this Version
437 as we need this information later on e.g. for pinning. */
438struct pkgCache::PackageFile
578bfd0a 439{
94449d7c 440 /** \brief physical disk file that this PackageFile represents */
4ad8619b 441 map_pointer_t FileName; // StringItem
94449d7c
DK
442 /** \brief the release information
443
444 Please see the files document for a description of what the
445 release information means. */
4ad8619b
DK
446 map_stringitem_t Archive;
447 map_stringitem_t Codename;
448 map_stringitem_t Component;
449 map_stringitem_t Version;
450 map_stringitem_t Origin;
451 map_stringitem_t Label;
452 map_stringitem_t Architecture;
94449d7c 453 /** \brief The site the index file was fetched from */
4ad8619b 454 map_stringitem_t Site;
94449d7c
DK
455 /** \brief indicates what sort of index file this is
456
457 @TODO enumerate at least the possible indexes */
4ad8619b 458 map_stringitem_t IndexType;
94449d7c
DK
459 /** \brief Size of the file
460
461 Used together with the modification time as a
462 simple check to ensure that the Packages
463 file has not been altered since Cache generation. */
4ad8619b 464 map_filesize_t Size;
94449d7c
DK
465 /** \brief Modification time for the file */
466 time_t mtime;
467
255c9e4b 468 /** @TODO document PackageFile::Flags */
3c124dde 469 unsigned long Flags;
94449d7c 470
578bfd0a 471 // Linked list
94449d7c 472 /** \brief Link to the next PackageFile in the Cache */
4ad8619b 473 map_pointer_t NextFile; // PackageFile
94449d7c 474 /** \brief unique sequel ID */
4ad8619b 475 map_fileid_t ID;
578bfd0a 476};
92fcbfc1 477 /*}}}*/
94449d7c
DK
478// VerFile structure /*{{{*/
479/** \brief associates a version with a PackageFile
480
481 This allows a full description of all Versions in all files
482 (and hence all sources) under consideration. */
483struct pkgCache::VerFile
dcb79bae 484{
94449d7c 485 /** \brief index of the package file that this version was found in */
4ad8619b 486 map_pointer_t File; // PackageFile
94449d7c 487 /** \brief next step in the linked list */
4ad8619b 488 map_pointer_t NextFile; // PkgVerFile
94449d7c 489 /** \brief position in the package file */
4ad8619b 490 map_filesize_t Offset; // File offset
255c9e4b 491 /** @TODO document pkgCache::VerFile::Size */
4ad8619b 492 map_filesize_t Size;
dcb79bae 493};
92fcbfc1 494 /*}}}*/
94449d7c
DK
495// DescFile structure /*{{{*/
496/** \brief associates a description with a Translation file */
497struct pkgCache::DescFile
a52f938b 498{
94449d7c 499 /** \brief index of the file that this description was found in */
4ad8619b 500 map_pointer_t File; // PackageFile
94449d7c 501 /** \brief next step in the linked list */
4ad8619b 502 map_pointer_t NextFile; // PkgVerFile
94449d7c 503 /** \brief position in the file */
4ad8619b 504 map_filesize_t Offset; // File offset
255c9e4b 505 /** @TODO document pkgCache::DescFile::Size */
4ad8619b 506 map_filesize_t Size;
a52f938b 507};
92fcbfc1 508 /*}}}*/
94449d7c
DK
509// Version structure /*{{{*/
510/** \brief information for a single version of a package
511
512 The version list is always sorted from highest version to lowest
513 version by the generator. Equal version numbers are either merged
514 or handled as separate versions based on the Hash value. */
515struct pkgCache::Version
578bfd0a 516{
94449d7c 517 /** \brief complete version string */
4ad8619b 518 map_stringitem_t VerStr;
94449d7c 519 /** \brief section this version is filled in */
4ad8619b 520 map_stringitem_t Section;
894d672e
DK
521
522 /** \brief Multi-Arch capabilities of a package version */
523 enum VerMultiArch { None = 0, /*!< is the default and doesn't trigger special behaviour */
524 All = (1<<0), /*!< will cause that Ver.Arch() will report "all" */
525 Foreign = (1<<1), /*!< can satisfy dependencies in another architecture */
526 Same = (1<<2), /*!< can be co-installed with itself from other architectures */
00b6a181
DK
527 Allowed = (1<<3), /*!< other packages are allowed to depend on thispkg:any */
528 AllForeign = All | Foreign,
529 AllAllowed = All | Allowed };
94449d7c
DK
530 /** \brief stores the MultiArch capabilities of this version
531
894d672e
DK
532 Flags used are defined in pkgCache::Version::VerMultiArch
533 */
534 unsigned char MultiArch;
25396fb0 535
94449d7c
DK
536 /** \brief references all the PackageFile's that this version came from
537
538 FileList can be used to determine what distribution(s) the Version
539 applies to. If FileList is 0 then this is a blank version.
540 The structure should also have a 0 in all other fields excluding
541 pkgCache::Version::VerStr and Possibly pkgCache::Version::NextVer. */
4ad8619b 542 map_pointer_t FileList; // VerFile
94449d7c 543 /** \brief next (lower or equal) version in the linked list */
4ad8619b 544 map_pointer_t NextVer; // Version
94449d7c 545 /** \brief next description in the linked list */
4ad8619b 546 map_pointer_t DescriptionList; // Description
94449d7c 547 /** \brief base of the dependency list */
4ad8619b 548 map_pointer_t DependsList; // Dependency
94449d7c
DK
549 /** \brief links to the owning package
550
551 This allows reverse dependencies to determine the package */
4ad8619b 552 map_pointer_t ParentPkg; // Package
94449d7c 553 /** \brief list of pkgCache::Provides */
4ad8619b 554 map_pointer_t ProvidesList; // Provides
94449d7c
DK
555
556 /** \brief archive size for this version
557
558 For Debian this is the size of the .deb file. */
4ad8619b 559 uint64_t Size; // These are the .deb size
94449d7c 560 /** \brief uncompressed size for this version */
4ad8619b 561 uint64_t InstalledSize;
94449d7c
DK
562 /** \brief characteristic value representing this version
563
564 No two packages in existence should have the same VerStr
565 and Hash with different contents. */
204fbdcc 566 unsigned short Hash;
94449d7c 567 /** \brief unique sequel ID */
4ad8619b 568 map_id_t ID;
94449d7c 569 /** \brief parsed priority value */
578bfd0a
AL
570 unsigned char Priority;
571};
92fcbfc1 572 /*}}}*/
94449d7c
DK
573// Description structure /*{{{*/
574/** \brief datamember of a linked list of available description for a version */
575struct pkgCache::Description
a52f938b 576{
94449d7c
DK
577 /** \brief Language code of this description (translation)
578
579 If the value has a 0 length then this is read using the Package
580 file else the Translation-CODE file is used. */
4ad8619b 581 map_stringitem_t language_code;
94449d7c
DK
582 /** \brief MD5sum of the original description
583
584 Used to map Translations of a description to a version
585 and to check that the Translation is up-to-date. */
4ad8619b 586 map_stringitem_t md5sum;
a52f938b 587
255c9e4b 588 /** @TODO document pkgCache::Description::FileList */
4ad8619b 589 map_pointer_t FileList; // DescFile
94449d7c 590 /** \brief next translation for this description */
4ad8619b 591 map_pointer_t NextDesc; // Description
94449d7c 592 /** \brief the text is a description of this package */
4ad8619b 593 map_pointer_t ParentPkg; // Package
a52f938b 594
94449d7c 595 /** \brief unique sequel ID */
4ad8619b 596 map_id_t ID;
a52f938b 597};
92fcbfc1 598 /*}}}*/
94449d7c
DK
599// Dependency structure /*{{{*/
600/** \brief information for a single dependency record
601
602 The records are split up like this to ease processing by the client.
603 The base of the linked list is pkgCache::Version::DependsList.
604 All forms of dependencies are recorded here including Depends,
605 Recommends, Suggests, Enhances, Conflicts, Replaces and Breaks. */
606struct pkgCache::Dependency
578bfd0a 607{
94449d7c 608 /** \brief string of the version the dependency is applied against */
4ad8619b 609 map_stringitem_t Version; // StringItem
94449d7c
DK
610 /** \brief index of the package this depends applies to
611
612 The generator will - if the package does not already exist -
613 create a blank (no version records) package. */
4ad8619b 614 map_pointer_t Package; // Package
94449d7c 615 /** \brief next dependency of this version */
4ad8619b 616 map_pointer_t NextDepends; // Dependency
94449d7c 617 /** \brief next reverse dependency of this package */
4ad8619b 618 map_pointer_t NextRevDepends; // Dependency
94449d7c 619 /** \brief version of the package which has the reverse depends */
4ad8619b 620 map_pointer_t ParentVer; // Version
94449d7c
DK
621
622 /** \brief unique sequel ID */
4ad8619b 623 map_id_t ID;
94449d7c 624 /** \brief Dependency type - Depends, Recommends, Conflicts, etc */
578bfd0a 625 unsigned char Type;
94449d7c
DK
626 /** \brief comparison operator specified on the depends line
627
628 If the high bit is set then it is a logical OR with the previous record. */
578bfd0a 629 unsigned char CompareOp;
578bfd0a 630};
92fcbfc1 631 /*}}}*/
94449d7c
DK
632// Provides structure /*{{{*/
633/** \brief handles virtual packages
634
635 When a Provides: line is encountered a new provides record is added
636 associating the package with a virtual package name.
637 The provides structures are linked off the package structures.
638 This simplifies the analysis of dependencies and other aspects A provides
639 refers to a specific version of a specific package, not all versions need to
640 provide that provides.*/
641struct pkgCache::Provides
578bfd0a 642{
94449d7c 643 /** \brief index of the package providing this */
4ad8619b 644 map_pointer_t ParentPkg; // Package
94449d7c 645 /** \brief index of the version this provide line applies to */
4ad8619b 646 map_pointer_t Version; // Version
94449d7c
DK
647 /** \brief version in the provides line (if any)
648
649 This version allows dependencies to depend on specific versions of a
650 Provides, as well as allowing Provides to override existing packages.
651 This is experimental. Note that Debian doesn't allow versioned provides */
4ad8619b 652 map_stringitem_t ProvideVersion;
94449d7c 653 /** \brief next provides (based of package) */
4ad8619b 654 map_pointer_t NextProvides; // Provides
94449d7c 655 /** \brief next provides (based of version) */
4ad8619b 656 map_pointer_t NextPkgProv; // Provides
578bfd0a 657};
92fcbfc1 658 /*}}}*/
94449d7c
DK
659// StringItem structure /*{{{*/
660/** \brief used for generating single instances of strings
661
662 Some things like Section Name are are useful to have as unique tags.
663 It is part of a linked list based at pkgCache::Header::StringList
664
665 All strings are simply inlined any place in the file that is natural
666 for the writer. The client should make no assumptions about the positioning
667 of strings. All StringItems should be null-terminated. */
668struct pkgCache::StringItem
578bfd0a 669{
94449d7c 670 /** \brief string this refers to */
4ad8619b 671 map_stringitem_t String;
94449d7c 672 /** \brief Next link in the chain */
4ad8619b 673 map_stringitem_t NextItem;
578bfd0a 674};
92fcbfc1 675 /*}}}*/
959470da
DK
676
677
d64e130a 678inline char const * pkgCache::NativeArch()
d3e8fbb3 679 { return StrP + HeaderP->Architecture; }
959470da 680
094a497d 681#include <apt-pkg/cacheiterators.h>
578bfd0a 682
d3e8fbb3
DK
683inline pkgCache::GrpIterator pkgCache::GrpBegin()
684 {return GrpIterator(*this);}
685inline pkgCache::GrpIterator pkgCache::GrpEnd()
686 {return GrpIterator(*this,GrpP);}
687inline pkgCache::PkgIterator pkgCache::PkgBegin()
688 {return PkgIterator(*this);}
689inline pkgCache::PkgIterator pkgCache::PkgEnd()
690 {return PkgIterator(*this,PkgP);}
ad00ae81 691inline pkgCache::PkgFileIterator pkgCache::FileBegin()
d3e8fbb3 692 {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);}
ad00ae81 693inline pkgCache::PkgFileIterator pkgCache::FileEnd()
d3e8fbb3 694 {return PkgFileIterator(*this,PkgFileP);}
578bfd0a 695
b2e465d6 696// Oh I wish for Real Name Space Support
92fcbfc1 697class pkgCache::Namespace /*{{{*/
d3e8fbb3 698{
b2e465d6 699 public:
803ea2a8 700 typedef pkgCache::GrpIterator GrpIterator;
b2e465d6
AL
701 typedef pkgCache::PkgIterator PkgIterator;
702 typedef pkgCache::VerIterator VerIterator;
a52f938b 703 typedef pkgCache::DescIterator DescIterator;
b2e465d6
AL
704 typedef pkgCache::DepIterator DepIterator;
705 typedef pkgCache::PrvIterator PrvIterator;
706 typedef pkgCache::PkgFileIterator PkgFileIterator;
d3e8fbb3 707 typedef pkgCache::VerFileIterator VerFileIterator;
b2e465d6 708 typedef pkgCache::Version Version;
a52f938b 709 typedef pkgCache::Description Description;
b2e465d6
AL
710 typedef pkgCache::Package Package;
711 typedef pkgCache::Header Header;
712 typedef pkgCache::Dep Dep;
713 typedef pkgCache::Flag Flag;
714};
92fcbfc1 715 /*}}}*/
578bfd0a 716#endif