- support SEARCH_STRINGSTART and SEARCH_STRINGEND
[platform/upstream/libsolv.git] / src / repo.h
1 /*
2  * Copyright (c) 2007, Novell Inc.
3  *
4  * This program is licensed under the BSD license, read LICENSE.BSD
5  * for further information
6  */
7
8 /*
9  * repo.h
10  * 
11  */
12
13 #ifndef SATSOLVER_REPO_H
14 #define SATSOLVER_REPO_H
15
16 #include "pooltypes.h"
17 #include "pool.h"
18 #include "repodata.h"
19
20
21
22 typedef struct _Repo {
23   const char *name;             /* application private name pointer */
24   Id repoid;                    /* our id */
25   void *appdata;                /* application private pointer */
26
27   Pool *pool;                   /* pool containing this repo */
28
29   int start;                    /* start of this repo solvables within pool->solvables */
30   int end;                      /* last solvable + 1 of this repo */
31   int nsolvables;               /* number of solvables repo is contributing to pool */
32
33   int disabled;                 /* ignore the solvables? */
34   int priority;                 /* priority of this repo */
35   int subpriority;              /* sub-priority of this repo, used just for sorting, not pruning */
36
37   Id *idarraydata;              /* array of metadata Ids, solvable dependencies are offsets into this array */
38   int idarraysize;
39   Offset lastoff;               /* start of last array in idarraydata */
40
41   Id *rpmdbid;                  /* solvable side data */
42
43   Repodata *repodata;           /* our stores for non-solvable related data */
44   unsigned nrepodata;           /* number of our stores..  */
45 } Repo;
46
47 extern Repo *repo_create(Pool *pool, const char *name);
48 extern void repo_free(Repo *repo, int reuseids);
49 extern void repo_freeallrepos(Pool *pool, int reuseids);
50 extern void repo_free_solvable_block(Repo *repo, Id start, int count, int reuseids);
51 extern void *repo_sidedata_create(Repo *repo, size_t size);
52 extern void *repo_sidedata_extend(Repo *repo, void *b, size_t size, Id p, int count);
53
54 extern Offset repo_addid(Repo *repo, Offset olddeps, Id id);
55 extern Offset repo_addid_dep(Repo *repo, Offset olddeps, Id id, Id marker);
56 extern Offset repo_reserve_ids(Repo *repo, Offset olddeps, int num);
57 extern Offset repo_fix_supplements(Repo *repo, Offset provides, Offset supplements, Offset freshens);
58 extern Offset repo_fix_conflicts(Repo *repo, Offset conflicts);
59
60 static inline const char *repo_name(const Repo *repo)
61 {
62   return repo->name;
63 }
64
65 static inline Id repo_add_solvable(Repo *repo)
66 {
67   extern Id pool_add_solvable(Pool *pool);
68   Id p = pool_add_solvable(repo->pool);
69   if (!repo->start || repo->start == repo->end)
70     repo->start = repo->end = p;
71   /* warning: sidedata must be extended before adapting start/end */
72   if (repo->rpmdbid)
73     repo->rpmdbid = (Id *)repo_sidedata_extend(repo, repo->rpmdbid, sizeof(Id), p, 1);
74   if (p < repo->start)
75     repo->start = p;
76   if (p + 1 > repo->end)
77     repo->end = p + 1;
78   repo->nsolvables++;
79   repo->pool->solvables[p].repo = repo;
80   return p;
81 }
82
83 static inline Id repo_add_solvable_block(Repo *repo, int count)
84 {
85   extern Id pool_add_solvable_block(Pool *pool, int count);
86   Id p;
87   Solvable *s;
88   if (!count)
89     return 0;
90   p = pool_add_solvable_block(repo->pool, count);
91   if (!repo->start || repo->start == repo->end)
92     repo->start = repo->end = p;
93   /* warning: sidedata must be extended before adapting start/end */
94   if (repo->rpmdbid)
95     repo->rpmdbid = (Id *)repo_sidedata_extend(repo, repo->rpmdbid, sizeof(Id), p, count);
96   if (p < repo->start)
97     repo->start = p;
98   if (p + count > repo->end)
99     repo->end = p + count;
100   repo->nsolvables += count;
101   for (s = repo->pool->solvables + p; count--; s++)
102     s->repo = repo;
103   return p;
104 }
105
106
107 #define FOR_REPO_SOLVABLES(r, p, s)                                             \
108   for (p = (r)->start, s = (r)->pool->solvables + p; p < (r)->end; p++, s = (r)->pool->solvables + p)   \
109     if (s->repo == (r))
110
111
112 /* those two functions are here because they need the Repo definition */
113
114 static inline Repo *pool_id2repo(Pool *pool, Id repoid)
115 {
116   return pool->repos[repoid - 1];
117 }
118
119 static inline int pool_installable(const Pool *pool, Solvable *s)
120 {
121   if (!s->arch || s->arch == ARCH_SRC || s->arch == ARCH_NOSRC)
122     return 0;
123   if (s->repo && s->repo->disabled)
124     return 0;
125   if (pool->id2arch && (s->arch > pool->lastarch || !pool->id2arch[s->arch]))
126     return 0;
127   if (pool->considered)
128     { 
129       Id id = s - pool->solvables;
130       if (!MAPTST(pool->considered, id))
131         return 0;
132     }
133   return 1;
134 }
135
136 /* search callback values */
137
138 #define SEARCH_NEXT_KEY         1
139 #define SEARCH_NEXT_SOLVABLE    2
140 #define SEARCH_STOP             3
141 #define SEARCH_ENTERSUB         -1
142
143 typedef struct _KeyValue {
144   Id id;
145   const char *str;
146   int num;
147   int num2;
148
149   int entry;    /* array entry, starts with 0 */
150   int eof;      /* last entry reached */
151
152   struct _KeyValue *parent;
153 } KeyValue;
154
155 /* search matcher flags */
156 #define SEARCH_STRINGMASK               15
157 #define SEARCH_STRING                   1
158 #define SEARCH_STRINGSTART              2
159 #define SEARCH_STRINGEND                3
160 #define SEARCH_SUBSTRING                4
161 #define SEARCH_GLOB                     5
162 #define SEARCH_REGEX                    6
163 #define SEARCH_ERROR                    15
164 #define SEARCH_NOCASE                   (1<<7)
165
166 /* iterator control */
167 #define SEARCH_NO_STORAGE_SOLVABLE      (1<<8)
168 #define SEARCH_SUB                      (1<<9)
169 #define SEARCH_ARRAYSENTINEL            (1<<10)
170 #define SEARCH_DISABLED_REPOS           (1<<11)
171 #define SEARCH_COMPLETE_FILELIST        (1<<12)
172
173 /* stringification flags */
174 #define SEARCH_SKIP_KIND                (1<<16)
175 /* By default we stringify just to the basename of a file because
176    the construction of the full filename is costly.  Specify this
177    flag if you want to match full filenames */
178 #define SEARCH_FILES                    (1<<17)
179 #define SEARCH_CHECKSUMS                (1<<18)
180
181 /* dataiterator internal */
182 #define SEARCH_THISSOLVID               (1<<31)
183
184
185 /* standard flags used in the repo_add functions */
186 #define REPO_REUSE_REPODATA             (1 << 0)
187 #define REPO_NO_INTERNALIZE             (1 << 1)
188 #define REPO_LOCALPOOL                  (1 << 2)
189 #define REPO_USE_LOADING                (1 << 3)
190 #define REPO_EXTEND_SOLVABLES           (1 << 4)
191
192 Repodata *repo_add_repodata(Repo *repo, int flags);
193 Repodata *repo_last_repodata(Repo *repo);
194
195 void repo_search(Repo *repo, Id p, Id key, const char *match, int flags, int (*callback)(void *cbdata, Solvable *s, Repodata *data, Repokey *key, KeyValue *kv), void *cbdata);
196
197 /* returns the string value of the attribute, or NULL if not found */
198 const char *repo_lookup_str(Repo *repo, Id entry, Id key);
199 /* returns the integer value of the attribute, or 0 if not found */
200 unsigned int repo_lookup_num(Repo *repo, Id entry, Id key, unsigned int notfound);
201 Id repo_lookup_id(Repo *repo, Id entry, Id keyid);
202 int repo_lookup_void(Repo *repo, Id entry, Id keyid);
203 const unsigned char *repo_lookup_bin_checksum(Repo *repo, Id entry, Id keyid, Id *typep);
204
205 typedef struct _Datamatcher {
206   int flags;
207   const char *match;
208   void *matchdata;
209   int error;
210 } Datamatcher;
211
212 typedef struct _Dataiterator
213 {
214   int state;
215   int flags;
216
217   Pool *pool;
218   Repo *repo;
219   Repodata *data;
220
221   /* data pointers */
222   unsigned char *dp;
223   unsigned char *ddp;
224   Id *idp;
225   Id *keyp;
226
227   /* the result */
228   Repokey *key;
229   KeyValue kv;
230
231   /* our matcher */
232   Datamatcher matcher;
233
234   /* iterators/filters */
235   Id keyname;
236   Id repodataid;
237   Id solvid;
238   Id repoid;
239
240   Id keynames[3 + 1];
241   int nkeynames;
242   int rootlevel;
243
244   /* recursion data */
245   struct di_parent {
246     KeyValue kv;
247     unsigned char *dp;
248     Id *keyp;
249   } parents[3];
250   int nparents;
251
252 } Dataiterator;
253
254 int datamatcher_init(Datamatcher *ma, const char *match, int flags);
255 void datamatcher_free(Datamatcher *ma);
256 int datamatcher_match(Datamatcher *ma, const char *str);
257
258 /*
259  * Dataiterator
260  * 
261  * Iterator like interface to 'search' functionality
262  * 
263  * Dataiterator is per-pool, additional filters can be applied
264  * to limit the search domain. See dataiterator_init below.
265  * 
266  * Use these like:
267  *    Dataiterator di;
268  *    dataiterator_init(&di, repo->pool, repo, 0, 0, "bla", SEARCH_SUBSTRING);
269  *    while (dataiterator_step(&di))
270  *      dosomething(di.solvid, di.key, di.kv);
271  *    dataiterator_free(&di);
272  */
273
274 /*
275  * Initialize dataiterator
276  * 
277  * di:      Pointer to Dataiterator to be initialized
278  * pool:    Search domain for the iterator
279  * repo:    if non-null, limit search to this repo
280  * solvid:  if non-null, limit search to this solvable
281  * keyname: if non-null, limit search to this keyname
282  * match:   if non-null, limit search to this match
283  */
284 int dataiterator_init(Dataiterator *di, Pool *pool, Repo *repo, Id p, Id keyname, const char *match, int flags);
285 void dataiterator_init_clone(Dataiterator *di, Dataiterator *from);
286 void dataiterator_set_search(Dataiterator *di, Repo *repo, Id p);
287 void dataiterator_set_keyname(Dataiterator *di, Id keyname);
288 int dataiterator_set_match(Dataiterator *di, const char *match, int flags);
289
290 void dataiterator_prepend_keyname(Dataiterator *di, Id keyname);
291 void dataiterator_free(Dataiterator *di);
292 int dataiterator_step(Dataiterator *di);
293 void dataiterator_setpos(Dataiterator *di);
294 void dataiterator_setpos_parent(Dataiterator *di);
295 int dataiterator_match(Dataiterator *di, Datamatcher *ma);
296 void dataiterator_skip_attribute(Dataiterator *di);
297 void dataiterator_skip_solvable(Dataiterator *di);
298 void dataiterator_skip_repo(Dataiterator *di);
299 void dataiterator_jump_to_solvid(Dataiterator *di, Id solvid);
300 void dataiterator_jump_to_repo(Dataiterator *di, Repo *repo);
301 void dataiterator_entersub(Dataiterator *di);
302 void dataiterator_clonepos(Dataiterator *di, Dataiterator *from);
303 void dataiterator_seek(Dataiterator *di, int whence);
304
305 #define DI_SEEK_STAY    (1 << 16)
306 #define DI_SEEK_CHILD   1
307 #define DI_SEEK_PARENT  2
308 #define DI_SEEK_REWIND  3
309
310
311 void repo_set_id(Repo *repo, Id p, Id keyname, Id id);
312 void repo_set_num(Repo *repo, Id p, Id keyname, Id num);
313 void repo_set_str(Repo *repo, Id p, Id keyname, const char *str);
314 void repo_set_poolstr(Repo *repo, Id p, Id keyname, const char *str);
315 void repo_add_poolstr_array(Repo *repo, Id p, Id keyname, const char *str);
316 void repo_internalize(Repo *repo);
317 void repo_disable_paging(Repo *repo);
318
319 #endif /* SATSOLVER_REPO_H */