apt: apt-pkg/orderlist.h Source File

apt 3.3.0 commandline package manager

orderlist.h
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
3/* ######################################################################
4
5 Order List - Represents and Manipulates an ordered list of packages.
6
7 A list of packages can be ordered by a number of conflicting criteria
8 each given a specific priority. Each package also has a set of flags
9 indicating some useful things about it that are derived in the
10 course of sorting. The pkgPackageManager class uses this class for
11 all of it's installation ordering needs.
12
13 ##################################################################### */
14 /*}}}*/
15#ifndef PKGLIB_ORDERLIST_H
16#define PKGLIB_ORDERLIST_H
17
18#include <apt-pkg/macros.h>
19#include <apt-pkg/pkgcache.h>
20
21#include <string>
22
23class pkgDepCache;
24 class APT_PUBLIC pkgOrderList : protected pkgCache::Namespace
25{
26 void * const d;
27 protected:
28
29 pkgDepCache &Cache;
30 typedef bool (pkgOrderList::*DepFunc)(DepIterator D);
31
32 // These are the currently selected ordering functions
33 DepFunc Primary;
34 DepFunc Secondary;
35 DepFunc RevDepends;
36 DepFunc Remove;
37
38 // State
39 Package **End;
40 Package **List;
41 Package **AfterEnd;
42 std::string *FileList;
43 DepIterator Loops[20];
44 int LoopCount;
45 int Depth;
46 unsigned short *Flags;
47 bool Debug;
48
49 // Main visit function
50 bool VisitNode(PkgIterator Pkg, char const* from);
51 bool VisitDeps(DepFunc F,PkgIterator Pkg);
52 bool VisitRDeps(DepFunc F,PkgIterator Pkg);
53 bool VisitRProvides(DepFunc F,VerIterator Ver);
54 bool VisitProvides(DepIterator Pkg,bool Critical);
55
56 // Dependency checking functions.
57 bool DepUnPackCrit(DepIterator D);
58 bool DepUnPackPreD(DepIterator D);
59 bool DepUnPackPre(DepIterator D);
60 bool DepUnPackDep(DepIterator D);
61 bool DepConfigure(DepIterator D);
62 bool DepRemove(DepIterator D);
63
64 // Analysis helpers
65 bool AddLoop(DepIterator D);
66 bool CheckDep(DepIterator D);
67 bool DoRun();
68
69 // For pre sorting
70 int OrderCompareA(Package *a, Package *b) APT_PURE;
71 int OrderCompareB(Package *a, Package *b) APT_PURE;
72 int FileCmp(PkgIterator A,PkgIterator B) APT_PURE;
73
74 public:
75
76 typedef Package **iterator;
77
78 /* State flags
79 The Loop flag can be set on a package that is currently being processed by either SmartConfigure or
80 SmartUnPack. This allows the package manager to tell when a loop has been formed as it will try to
81 SmartUnPack or SmartConfigure a package with the Loop flag set. It will then either stop (as it knows
82 that the operation is unnecessary as its already in process), or in the case of the conflicts resolution
83 in SmartUnPack, use EarlyRemove to resolve the situation. */
84 enum Flags {Added = (1 << 0), AddPending = (1 << 1),
85 Immediate = (1 << 2), Loop = (1 << 3),
86 UnPacked = (1 << 4), Configured = (1 << 5),
87 Removed = (1 << 6), // Early Remove
88 InList = (1 << 7),
89 After = (1 << 8),
90 States = (UnPacked | Configured | Removed)};
91
92 // Flag manipulators
93 inline bool IsFlag(PkgIterator Pkg,unsigned long F) {return (Flags[Pkg->ID] & F) == F;};
94 inline bool IsFlag(Package *Pkg,unsigned long F) {return (Flags[Pkg->ID] & F) == F;};
95 void Flag(PkgIterator Pkg,unsigned long State, unsigned long F) {Flags[Pkg->ID] = (Flags[Pkg->ID] & (~F)) | State;};
96 inline void Flag(PkgIterator Pkg,unsigned long F) {Flags[Pkg->ID] |= F;};
97 inline void Flag(Package *Pkg,unsigned long F) {Flags[Pkg->ID] |= F;};
98 // RmFlag removes a flag from a package
99 inline void RmFlag(Package *Pkg,unsigned long F) {Flags[Pkg->ID] &= ~F;};
100 // IsNow will return true if the Pkg has been not been either configured or unpacked
101 inline bool IsNow(PkgIterator Pkg) {return (Flags[Pkg->ID] & (States & (~Removed))) == 0;};
102 bool IsMissing(PkgIterator Pkg) APT_PURE;
103 void WipeFlags(unsigned long F);
104 void SetFileList(std::string *FileList) {this->FileList = FileList;};
105
106 // Accessors
107 inline iterator begin() {return List;};
108 inline iterator end() {return End;};
109 inline void push_back(Package *Pkg) {*(End++) = Pkg;};
110 inline void push_back(PkgIterator Pkg) {*(End++) = Pkg;};
111 inline void pop_back() {End--;};
112 inline bool empty() {return End == List;};
113 inline unsigned int size() {return End - List;};
114
115 // Ordering modes
116 bool OrderCritical();
117 bool OrderUnpack(std::string *FileList = 0);
118 bool OrderConfigure();
119
120 int Score(PkgIterator Pkg);
121
122 explicit pkgOrderList(pkgDepCache *Cache);
123 virtual ~pkgOrderList();
124};
125
126#endif
pkgCache::Namespace
Definition pkgcache.h:853
pkgDepCache
Definition depcache.h:63
pkgcache.h
pkgCache - Structure definitions for the cache file