9 libsolv-bindings - access libsolv from perl/python/ruby
14 Libsolv's language bindings offer an abstract, object orientated interface
15 to the library. The supported languages are currently perl, python, and ruby.
16 All example code (except in the specifics sections, of course) lists first
17 the ``C-ish'' interface, then the syntax for perl, python, and ruby (in that
23 Libsolv's perl bindings can be loaded with the following statement:
27 Objects are either created by calling the new() method on a class or they
28 are returned by calling methods on other objects.
30 my $pool = solv::Pool->new();
31 my $repo = $pool->add_repo("my_first_repo");
33 Swig encapsulates all objects as tied hashes, thus the attributes can be
34 accessed by treating the object as standard hash reference:
36 $pool->{appdata} = 42;
37 printf "appdata is %d\n", $pool->{appdata};
39 A special exception to this are iterator objects, they are encapsulated as
40 tied arrays so that it is possible to iterate with a for() statement:
42 my $iter = $pool->solvables_iter();
43 for my $solvable (@$iter) { ... };
45 As a downside of this approach, iterator objects cannot have attributes.
47 If an array needs to be passed to a method it is usually done by reference,
48 if a method returns an array it returns it on the stack:
50 my @problems = $solver->solve(\@jobs);
52 Due to a bug in swig, stringification does not work for libsolv's objects.
53 Instead, you have to call the object's str() method.
55 print $dep->str() . "\n";
57 Swig implements all constants as numeric variables (instead of the more
58 natural constant subs), so don't forget the leading ``$'' when accessing a
59 constant. Also do not forget to prepend the namespace of the constant:
61 $pool->set_flag($solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1);
66 The python bindings can be loaded with:
70 Objects are either created by calling the constructor method for a class or they
71 are returned by calling methods on other objects.
74 repo = pool.add_repo("my_first_repo")
76 Attributes can be accessed as usual:
79 print "appdata is %d" % (pool.appdata)
81 Iterators also work as expected:
83 for solvable in pool.solvables_iter():
85 Arrays are passed and returned as list objects:
88 problems = solver.solve(jobs)
90 The bindings define stringification for many classes, some also have a
91 __repr__ method to ease debugging.
96 Constants are attributes of the classes:
98 pool.set_flag(solv.Pool.POOL_FLAG_OBSOLETEUSESCOLORS, 1);
103 The ruby bindings can be loaded with:
107 Objects are either created by calling the new method on a class or they
108 are returned by calling methods on other objects. Note that all classes start
109 with an uppercase letter in ruby, so the class is called ``Solv''.
111 pool = Solv::Pool.new
112 repo = pool.add_repo("my_first_repo")
114 Attributes can be accessed as usual:
117 puts "appdata is #{pool.appdata}"
119 Iterators also work as expected:
121 for solvable in pool.solvables_iter() do ...
123 Arrays are passed and returned as array objects:
126 problems = solver.solve(jobs)
128 Most classes define a to_s method, so objects can be easily stringified.
129 Many also define an inspect() method.
134 Constants live in the namespace of the class they belong to:
136 pool.set_flag(Solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1);
138 Note that boolean methods have an added trailing ``?'', to be consistent with
141 puts "empty" if repo.isempty?
146 Libsolv's tcl bindings can be loaded with the following statement:
148 TCL package require solv
150 Objects are either created by calling class name prefixed with ``new_'',
151 or they are returned by calling methods on other objects.
153 TCL set pool [solv::new_Pool]
154 TCL set repo [$pool add_repo "my_first_repo"]
156 Swig provides a ``cget'' method to read object attributes, and a
157 ``configure'' method to write them:
159 TCL $pool configure -appdata 42
160 TCL puts "appdata is [$pool cget -appdata]"
162 The tcl bindings provide a little helper to work with iterators in
165 TCL set iter [$pool solvables_iter]
166 TCL solv::iter s $iter { ... }
168 libsolv's arrays are mapped to tcl's lists:
170 TCL set jobs [list $job1 $job2]
171 TCL set problems [$solver solve $jobs]
172 TCL puts "We have [llength $problems] problems..."
174 Stringification is done by calling the object's ``str'' method.
178 There is one exception: you have to use ``stringify'' for Datamatch
179 objects, as swig reports a clash with the ``str'' attribute.
180 Some objects also support a ``=='' method for equality tests, and a
183 Swig implements all constants as numeric variables, constants belonging
184 to a libsolv class are prefixed with the class name:
186 TCL $pool set_flag $solv::Pool_POOL_FLAG_OBSOLETEUSESCOLORS 1
187 TCL puts [$solvable lookup_str $solv::SOLVABLE_SUMMARY]
192 This is the main namespace of the library, you cannot create objects of this
193 type but it contains some useful constants.
197 Relational flag constants, the first three can be or-ed together
200 the ``less than'' bit
203 the ``equals to'' bit
206 the ``greater than'' bit
209 used for relations that describe an extra architecture filter, the
210 version part of the relation is interpreted as architecture.
215 Access the meta section of a repository or repodata area. This is
216 like an extra Solvable that has the Id SOLVID_META.
219 Use the data position stored inside of the pool instead of accessing
220 some solvable by Id. The bindings have the Datapos objects as an
221 abstraction mechanism, so you do not need this constant.
229 Always one, describes the empty string
232 The keyname Id of the name of the solvable.
235 see the libsolv-constantids manpage for a list of fixed Ids.
240 The pool is libsolv's central resource manager. A pool consists of Solvables,
241 Repositories, Dependencies, each indexed by Ids.
243 === CLASS METHODS ===
246 my $pool = solv::Pool->new();
248 pool = Solv::Pool.new()
250 Create a new pool instance. In most cases you just need one pool.
251 Note that the returned object "owns" the pool, i.e. if the object is
252 freed, the pool is also freed. You can use the disown method to
253 break this ownership relation.
257 void *appdata; /* read/write */
262 Application specific data that may be used in any way by the code using the
265 Solvable solvables[]; /* read only */
266 my $solvable = $pool->{solvables}->[$solvid];
267 solvable = pool.solvables[solvid]
268 solvable = pool.solvables[solvid]
270 Look up a Solvable by its id.
272 Repo repos[]; /* read only */
273 my $repo = $pool->{repos}->[$repoid];
274 repo = pool.repos[repoid]
275 repo = pool.repos[repoid]
277 Look up a Repository by its id.
279 Repo *installed; /* read/write */
280 $pool->{installed} = $repo;
281 pool.installed = repo
282 pool.installed = repo
284 Define which repository contains all the installed packages.
286 const char *errstr; /* read only */
287 my $err = $pool->{errstr};
291 Return the last error string that was stored in the pool.
295 *POOL_FLAG_PROMOTEEPOCH*::
296 Promote the epoch of the providing dependency to the requesting
297 dependency if it does not contain an epoch. Used at some time
298 in old rpm versions, modern systems should never need this.
300 *POOL_FLAG_FORBIDSELFCONFLICTS*::
301 Disallow the installation of packages that conflict with themselves.
302 Debian always allows self-conflicting packages, rpm used to forbid
303 them but switched to also allowing them recently.
305 *POOL_FLAG_OBSOLETEUSESPROVIDES*::
306 Make obsolete type dependency match against provides instead of
307 just the name and version of packages. Very old versions of rpm
308 used the name/version, then it got switched to provides and later
309 switched back again to just name/version.
311 *POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES*::
312 An implicit obsoletes is the internal mechanism to remove the
313 old package on an update. The default is to remove all packages
314 with the same name, rpm-5 switched to also removing packages
315 providing the same name.
317 *POOL_FLAG_OBSOLETEUSESCOLORS*::
318 Rpm's multilib implementation (used in RedHat and Fedora)
319 distinguishes between 32bit and 64bit packages (the terminology
320 is that they have a different color). If obsoleteusescolors is
321 set, packages with different colors will not obsolete each other.
323 *POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS*::
324 Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if
325 packages of the same name can be installed in parallel. For
326 current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be
327 false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true
328 (this is the default if FEDORA is defined when libsolv is compiled).
330 *POOL_FLAG_NOINSTALLEDOBSOLETES*::
331 New versions of rpm consider the obsoletes of installed packages
332 when checking for dependency, thus you may not install a package
333 that is obsoleted by some other installed package, unless you
334 also erase the other package.
336 *POOL_FLAG_HAVEDISTEPOCH*::
337 Mandriva added a new field called distepoch that gets checked in
338 version comparison if the epoch/version/release of two packages
341 *POOL_FLAG_NOOBSOLETESMULTIVERSION*::
342 If a package is installed in multiversionmode, rpm used to ignore
343 both the implicit obsoletes and the obsolete dependency of a
344 package. This was changed to ignoring just the implicit obsoletes,
345 thus you may install multiple versions of the same name, but
346 obsoleted packages still get removed.
348 *POOL_FLAG_ADDFILEPROVIDESFILTERED*::
349 Make the addfileprovides method only add files from the standard
350 locations (i.e. the ``bin'' and ``etc'' directories). This is
351 useful if you have only few packages that use non-standard file
352 dependencies, but you still want the fast speed that addfileprovides()
362 Force a free of the pool. After this call, you must not access any object
363 that still references the pool.
370 Break the ownership relation between the binding object and the pool. After
371 this call, the pool will not get freed even if the object goes out of
372 scope. This also means that you must manually call the free method to free
375 void setdebuglevel(int level)
376 $pool->setdebuglevel($level);
377 pool.setdebuglevel(level)
378 pool.setdebuglevel(level)
380 Set the debug level. A value of zero means no debug output, the higher the
381 value, the more output is generated.
383 int set_flag(int flag, int value)
384 my $oldvalue = $pool->set_flag($flag, $value);
385 oldvalue = pool.set_flag(flag, value)
386 oldvalue = pool.set_flag(flag, value)
388 int get_flag(int flag)
389 my $value = $pool->get_flag($flag);
390 value = pool.get_flag(flag)
391 value = pool.get_flag(flag)
393 Set/get a pool specific flag. The flags define how the system works, e.g. how
394 the package manager treats obsoletes. The default flags should be sane for most
395 applications, but in some cases you may want to tweak a flag, for example if
396 you want to solv package dependencies for some other system than yours.
398 void set_rootdir(const char *rootdir)
399 $pool->set_rootdir(rootdir);
400 pool.set_rootdir(rootdir)
401 pool.set_rootdir(rootdir)
403 const char *get_rootdir()
404 my $rootdir = $pool->get_rootdir();
405 rootdir = pool.get_rootdir()
406 rootdir = pool.get_rootdir()
408 Set/get the rootdir to use. This is useful if you want package management
409 to work only in some directory, for example if you want to setup a chroot
410 jail. Note that the rootdir will only be prepended to file paths if the
411 *REPO_USE_ROOTDIR* flag is used.
413 void setarch(const char *arch = 0)
418 Set the architecture for your system. The architecture is used to determine
419 which packages are installable. It defaults to the result of ``uname -m''.
421 Repo add_repo(const char *name)
422 $repo = $pool->add_repo($name);
423 repo = pool.add_repo(name)
424 repo = pool.add_repo(name)
426 Add a Repository with the specified name to the pool. The repository is empty
427 on creation, use the repository methods to populate it with packages.
429 Repoiterator repos_iter()
430 for my $repo (@{$pool->repos_iter()})
431 for repo in pool.repos_iter():
432 for repo in pool.repos_iter()
434 Iterate over the existing repositories.
436 Solvableiterator solvables_iter()
437 for my $solvable (@{$pool->solvables_iter()})
438 for solvable in pool.solvables_iter():
439 for solvable in pool.solvables_iter()
441 Iterate over the existing solvables.
443 Dep Dep(const char *str, bool create = 1)
444 my $dep = $pool->Dep($string);
445 dep = pool.Dep(string)
446 dep = pool.Dep(string)
448 Create an object describing a string or dependency. If the string is currently
449 not in the pool and _create_ is false, *undef*/*None*/*nil* is returned.
451 void addfileprovides()
452 $pool->addfileprovides();
453 pool.addfileprovides()
454 pool.addfileprovides()
456 Id *addfileprovides_queue()
457 my @ids = $pool->addfileprovides_queue();
458 ids = pool.addfileprovides_queue()
459 ids = pool.addfileprovides_queue()
461 Some package managers like rpm allow dependencies on files contained in other
462 packages. To allow libsolv to deal with those dependencies in an efficient way,
463 you need to call the addfileprovides method after creating and reading all
464 repositories. This method will scan all dependency for file names and then scan
465 all packages for matching files. If a filename has been matched, it will be
466 added to the provides list of the corresponding package. The
467 addfileprovides_queue variant works the same way but returns an array
468 containing all file dependencies. This information can be stored in the
469 meta section of the repositories to speed up the next time the
470 repository is loaded and addfileprovides is called.
472 void createwhatprovides()
473 $pool->createwhatprovides();
474 pool.createwhatprovides()
475 pool.createwhatprovides()
477 Create the internal ``whatprovides'' hash over all of the provides of all
478 packages. This method must be called before doing any lookups on provides.
479 It's encouraged to do it right after all repos are set up, usually right after
480 the call to addfileprovides().
482 Solvable *whatprovides(DepId dep)
483 my @solvables = $pool->whatprovides($dep);
484 solvables = pool.whatprovides(dep)
485 solvables = pool.whatprovides(dep)
487 Return all solvables that provide the specified dependency. You can use either
488 a Dep object or a simple Id as argument.
490 Id *matchprovidingids(const char *match, int flags)
491 my @ids = $pool->matchprovidingids($match, $flags);
492 ids = pool.matchprovidingids(match, flags)
493 ids = pool.matchprovidingids(match, flags)
495 Search the names of all provides and return the ones matching the specified
496 string. See the Dataiterator class for the allowed flags.
498 Id towhatprovides(Id *ids)
499 my $offset = $pool->towhatprovides(\@ids);
500 offset = pool.towhatprovides(ids)
501 offset = pool.towhatprovides(ids)
503 ``Internalize'' an array containing Ids. The returned value can be used to
504 create solver jobs working on a specific set of packages. See the Solver class
505 for more information.
507 void set_namespaceproviders(DepId ns, DepId evr, bool value = 1)
508 $pool->set_namespaceproviders($ns, $evr, 1);
509 pool.set_namespaceproviders(ns, evr, True)
510 pool.set_namespaceproviders(ns, evr, true)
512 Manually set an namespace provides entry in the whatprovides index.
514 void flush_namespaceproviders(DepId ns, DepId evr)
515 $pool->flush_namespaceproviders($ns, $evr);
516 $pool.flush_namespaceproviders(ns, evr)
517 $pool.flush_namespaceproviders(ns, evr)
519 Flush the cache of all namespacprovudes matching the specified namespace
520 dependency. You can use zero as a wildcard argument.
522 bool isknownarch(DepId id)
523 my $bool = $pool->isknownarch($id);
524 bool = pool.isknownarch(id)
525 bool = pool.isknownarch?(id)
527 Return true if the specified Id describes a known architecture.
530 my $solver = $pool->Solver();
531 solver = pool.Solver()
532 solver = pool.Solver()
534 Create a new solver object.
536 Job Job(int how, Id what)
537 my $job = $pool->Job($how, $what);
538 job = pool.Job(how, what)
539 job = pool.Job(how, what)
541 Create a new Job object. Kind of low level, in most cases you would use a
542 Selection or Dep job constructor instead.
544 Selection Selection()
545 my $sel = $pool->Selection();
546 sel = pool.Selection()
547 sel = pool.Selection()
549 Create an empty selection. Useful as a starting point for merging other
552 Selection Selection_all()
553 my $sel = $pool->Selection_all();
554 sel = pool.Selection_all()
555 sel = pool.Selection_all()
557 Create a selection containing all packages. Useful as starting point for
558 intersecting other selections or for update/distupgrade jobs.
560 Selection select(const char *name, int flags)
561 my $sel = $pool->select($name, $flags);
562 sel = pool.select(name, flags)
563 sel = pool.select(name, flags)
565 Create a selection by matching packages against the specified string. See the
566 Selection class for a list of flags and how to create solver jobs from a
569 Selection matchdeps(const char *name, int flags, Id keyname, Id marker = -1)
570 my $sel = $pool->matchdeps($name, $flags, $keyname);
571 sel = pool.matchdeps(name, flags, keyname)
572 sel = pool.matchdeps(name, flags, keyname)
574 Create a selection by matching package dependencies against the specified string.
575 This can be used if you want to match other dependency types than "provides".
577 Selection matchdepid(DepId dep, int flags, Id keyname, Id marker = -1)
578 my $sel = $pool->matchdepid(dep, $flags, $keyname);
579 sel = pool.matchdepid(dep, flags, keyname)
580 sel = pool.matchdepid(dep, flags, keyname)
582 Create a selection by matching package dependencies against the specified
583 dependency. This may be faster than matchdeps and also works with complex
584 dependencies. The downside is that you cannot use globs or case insensitive
587 void setpooljobs(Jobs *jobs)
588 $pool->setpooljobs(\@jobs);
589 pool.setpooljobs(jobs)
590 pool.setpooljobs(jobs)
593 @jobs = $pool->getpooljobs();
594 jobs = pool.getpooljobs()
595 jobs = pool.getpooljobs()
597 Get/Set fixed jobs stored in the pool. Those jobs are automatically appended to
598 all solver jobs, they are meant for fixed configurations like which packages
599 can be multiversion installed, which packages were userinstalled or must not be
602 void set_loadcallback(Callable *callback)
603 $pool->setloadcallback(\&callbackfunction);
604 pool.setloadcallback(callbackfunction)
605 pool.setloadcallback { |repodata| ... }
607 Set the callback function called when repository metadata needs to be loaded on
608 demand. To make use of this feature, you need to create repodata stubs that
609 tell the library which data is available but not loaded. If later on the data
610 needs to be accessed, the callback function is called with a repodata argument.
611 You can then load the data (maybe fetching it first from a remote server).
612 The callback should return true if the data has been made available.
615 $pool->appdata_disown()
616 pool.appdata_disown()
617 pool.appdata_disown()
619 Decrement the reference count of the appdata object. This can be used to break
620 circular references (e.g. if the pool's appdata value points to some meta data
621 structure that contains a pool handle). If used incorrectly, this method can
622 lead to application crashes, so beware. (This method is a no-op for ruby and tcl.)
624 === DATA RETRIEVAL METHODS ===
626 In the following functions, the _keyname_ argument describes what to retrieve.
627 For the standard cases you can use the available Id constants. For example,
629 $solv::SOLVABLE_SUMMARY
630 solv.SOLVABLE_SUMMARY
631 Solv::SOLVABLE_SUMMARY
633 selects the ``Summary'' entry of a solvable. The _solvid_ argument selects the
634 desired solvable by Id.
636 const char *lookup_str(Id solvid, Id keyname)
637 my $string = $pool->lookup_str($solvid, $keyname);
638 string = pool.lookup_str(solvid, keyname)
639 string = pool.lookup_str(solvid, keyname)
641 Id lookup_id(Id solvid, Id keyname)
642 my $id = $pool->lookup_id($solvid, $keyname);
643 id = pool.lookup_id(solvid, keyname)
644 id = pool.lookup_id(solvid, keyname)
646 unsigned long long lookup_num(Id solvid, Id keyname, unsigned long long notfound = 0)
647 my $num = $pool->lookup_num($solvid, $keyname);
648 num = pool.lookup_num(solvid, keyname)
649 num = pool.lookup_num(solvid, keyname)
651 bool lookup_void(Id solvid, Id keyname)
652 my $bool = $pool->lookup_void($solvid, $keyname);
653 bool = pool.lookup_void(solvid, keyname)
654 bool = pool.lookup_void(solvid, keyname)
656 Id *lookup_idarray(Id solvid, Id keyname)
657 my @ids = $pool->lookup_idarray($solvid, $keyname);
658 ids = pool.lookup_idarray(solvid, keyname)
659 ids = pool.lookup_idarray(solvid, keyname)
661 Chksum lookup_checksum(Id solvid, Id keyname)
662 my $chksum = $pool->lookup_checksum($solvid, $keyname);
663 chksum = pool.lookup_checksum(solvid, keyname)
664 chksum = pool.lookup_checksum(solvid, keyname)
666 Lookup functions. Return the data element stored in the specified solvable.
667 You should probably use the methods of the Solvable class instead.
669 Dataiterator Dataiterator(Id keyname, const char *match = 0, int flags = 0)
670 my $di = $pool->Dataiterator($keyname, $match, $flags);
671 di = pool.Dataiterator(keyname, match, flags)
672 di = pool.Dataiterator(keyname, match, flags)
674 Dataiterator Dataiterator_solvid(Id solvid, Id keyname, const char *match = 0, int flags = 0)
675 my $di = $pool->Dataiterator($solvid, $keyname, $match, $flags);
676 di = pool.Dataiterator(solvid, keyname, match, flags)
677 di = pool.Dataiterator(solvid, keyname, match, flags)
683 Iterate over the matching data elements. See the Dataiterator class for more
684 information. The Dataiterator method iterates over all solvables in the pool,
685 whereas the Dataiterator_solvid only iterates over the specified solvable.
689 The following methods deal with Ids, i.e. integers representing objects in the
690 pool. They are considered ``low level'', in most cases you would not use them
691 but instead the object orientated methods.
694 $repo = $pool->id2repo($id);
695 repo = pool.id2repo(id)
696 repo = pool.id2repo(id)
698 Lookup an existing Repository by id. You can also do this by using the *repos*
701 Solvable id2solvable(Id id)
702 $solvable = $pool->id2solvable($id);
703 solvable = pool.id2solvable(id)
704 solvable = pool.id2solvable(id)
706 Lookup an existing Repository by id. You can also do this by using the
707 *solvables* attribute.
709 const char *solvid2str(Id id)
710 my $str = $pool->solvid2str($id);
711 str = pool.solvid2str(id)
712 str = pool.solvid2str(id)
714 Return a string describing the Solvable with the specified id. The string
715 consists of the name, version, and architecture of the Solvable.
717 Id str2id(const char *str, bool create = 1)
718 my $id = pool->str2id($string);
719 id = pool.str2id(string)
720 id = pool.str2id(string)
722 const char *id2str(Id id)
723 $string = pool->id2str($id);
724 string = pool.id2str(id)
725 string = pool.id2str(id)
727 Convert a string into an Id and back. If the string is currently not in the
728 pool and _create_ is false, zero is returned.
730 Id rel2id(Id name, Id evr, int flags, bool create = 1)
731 my $id = pool->rel2id($nameid, $evrid, $flags);
732 id = pool.rel2id(nameid, evrid, flags)
733 id = pool.rel2id(nameid, evrid, flags)
735 Create a ``relational'' dependency. Such dependencies consist of a name part,
736 the _flags_ describing the relation, and a version part. The flags are:
738 $solv::REL_EQ | $solv::REL_GT | $solv::REL_LT
739 solv.REL_EQ | solv.REL_GT | solv.REL_LT
740 Solv::REL_EQ | Solv::REL_GT | Solv::REL_LT
742 Thus, if you want a ``\<='' relation, you would use *REL_LT | REL_EQ*.
744 Id id2langid(Id id, const char *lang, bool create = 1)
745 my $id = $pool->id2langid($id, $language);
746 id = pool.id2langid(id, language)
747 id = pool.id2langid(id, language)
749 Create a language specific Id from some other id. This function simply converts
750 the id into a string, appends a dot and the specified language to the string
751 and converts the result back into an Id.
753 const char *dep2str(Id id)
754 $string = pool->dep2str($id);
755 string = pool.dep2str(id)
756 string = pool.dep2str(id)
758 Convert a dependency id into a string. If the id is just a string, this
759 function has the same effect as id2str(). For relational dependencies, the
760 result is the correct ``name relation evr'' string.
765 The dependency class is an object orientated way to work with strings and
766 dependencies. Internally, dependencies are represented as Ids, i.e. simple
767 numbers. Dependency objects can be constructed by using the Pool's Dep()
772 Pool *pool; /* read only */
777 Back reference to the pool this dependency belongs to.
779 Id id; /* read only */
784 The id of this dependency.
788 Dep Rel(int flags, DepId evrid, bool create = 1)
789 my $reldep = $dep->Rel($flags, $evrdep);
790 reldep = dep.Rel(flags, evrdep)
791 reldep = dep.Rel(flags, evrdep)
793 Create a relational dependency from to string dependencies and a flags
794 argument. See the pool's rel2id method for a description of the flags.
796 Selection Selection_name(int setflags = 0)
797 my $sel = $dep->Selection_name();
798 sel = dep.Selection_name()
799 sel = dep.Selection_name()
801 Create a Selection from a dependency. The selection consists of all packages
802 that have a name equal to the dependency. If the dependency is of a relational
803 type, the packages version must also fulfill the dependency.
805 Selection Selection_provides(int setflags = 0)
806 my $sel = $dep->Selection_provides();
807 sel = dep.Selection_provides()
808 sel = dep.Selection_provides()
810 Create a Selection from a dependency. The selection consists of all packages
811 that have at least one provides matching the dependency.
814 my $str = $dep->str();
818 Return a string describing the dependency.
825 Same as calling the str() method.
832 The dependencies are equal if they are part of the same pool and have the same
838 A Repository describes a group of packages, normally coming from the same
839 source. Repositories are created by the Pool's add_repo() method.
843 Pool *pool; /* read only */
848 Back reference to the pool this dependency belongs to.
850 Id id; /* read only */
855 The id of the repository.
857 const char *name; /* read/write */
862 The repositories name. To libsolv, the name is just a string with no specific
865 int priority; /* read/write */
870 The priority of the repository. A higher number means that packages of this
871 repository will be chosen over other repositories, even if they have a greater
874 int subpriority; /* read/write */
879 The sub-priority of the repository. This value is compared when the priorities
880 of two repositories are the same. It is useful to make the library prefer
881 on-disk repositories to remote ones.
883 int nsolvables; /* read only */
888 The number of solvables in this repository.
890 void *appdata; /* read/write */
895 Application specific data that may be used in any way by the code using the
898 Datapos *meta; /* read only */
903 Return a Datapos object of the repodata's metadata. You can use the lookup
904 methods of the Datapos class to lookup metadata attributes, like the repository
909 *REPO_REUSE_REPODATA*::
910 Reuse the last repository data area (``repodata'') instead of creating a
913 *REPO_NO_INTERNALIZE*::
914 Do not internalize the added repository data. This is useful if
915 you plan to add more data because internalization is a costly
919 Use the repodata's pool for Id storage instead of the global pool. Useful
920 if you don't want to pollute the global pool with many unneeded ids, like
921 when storing the filelist.
924 Use the repodata that is currently being loaded instead of creating a new
925 one. This only makes sense if used in a load callback.
927 *REPO_EXTEND_SOLVABLES*::
928 Do not create new solvables for the new data, but match existing solvables
929 and add the data to them. Repository metadata is often split into multiple
930 parts, with one primary file describing all packages and other parts
931 holding information that is normally not needed, like the changelog.
934 Prepend the pool's rootdir to the path when doing file operations.
937 Do not add a location element to the solvables. Useful if the solvables
938 are not in the final position, so you can add the correct location later
941 *SOLV_ADD_NO_STUBS*::
942 Do not create stubs for repository parts that can be downloaded on demand.
944 *SUSETAGS_RECORD_SHARES*::
945 This is specific to the add_susetags() method. Susetags allows one to refer to
946 already read packages to save disk space. If this data sharing needs to
947 work over multiple calls to add_susetags, you need to specify this flag so
948 that the share information is made available to subsequent calls.
952 void free(bool reuseids = 0)
957 Free the repository and all solvables it contains. If _reuseids_ is set to
958 true, the solvable ids and the repository id may be reused by the library when
959 added new solvables. Thus you should leave it false if you are not sure that
960 somebody holds a reference.
962 void empty(bool reuseids = 0)
967 Free all the solvables in a repository. The repository will be empty after this
968 call. See the free() method for the meaning of _reuseids_.
975 Return true if there are no solvables in this repository.
978 $repo->internalize();
982 Internalize added data. Data must be internalized before it is available to the
983 lookup and data iterator functions.
990 Write a repo as a ``solv'' file. These files can be read very fast and thus are
991 a good way to cache repository data. Returns false if there was some error
994 Solvableiterator solvables_iter()
995 for my $solvable (@{$repo->solvables_iter()})
996 for solvable in repo.solvables_iter():
997 for solvable in repo.solvables_iter()
999 Iterate over all solvables in a repository.
1001 Repodata add_repodata(int flags = 0)
1002 my $repodata = $repo->add_repodata();
1003 repodata = repo.add_repodata()
1004 repodata = repo.add_repodata()
1006 Add a new repodata area to the repository. This is normally automatically
1007 done by the repo_add methods, so you need this method only in very
1011 $repo->create_stubs();
1015 Calls the create_stubs() repodata method for the last repodata of the
1019 $repo->iscontiguous()
1023 Return true if the solvables of this repository are all in a single block with
1024 no holes, i.e. they have consecutive ids.
1026 Repodata first_repodata()
1027 my $repodata = $repo->first_repodata();
1028 repodata = repo.first_repodata()
1029 repodata = repo.first_repodata()
1031 Checks if all repodatas but the first repodata are extensions, and return the
1032 first repodata if this is the case. Useful if you want to do a store/retrieve
1033 sequence on the repository to reduce the memory using and enable paging, as
1034 this does not work if the repository contains multiple non-extension repodata
1037 Selection Selection(int setflags = 0)
1038 my $sel = $repo->Selection();
1039 sel = repo.Selection()
1040 sel = repo.Selection()
1042 Create a Selection consisting of all packages in the repository.
1044 Dataiterator Dataiterator(Id key, const char *match = 0, int flags = 0)
1045 my $di = $repo->Dataiterator($keyname, $match, $flags);
1046 di = repo.Dataiterator(keyname, match, flags)
1047 di = repo.Dataiterator(keyname, match, flags)
1049 Dataiterator Dataiterator_meta(Id key, const char *match = 0, int flags = 0)
1050 my $di = $repo->Dataiterator_meta($keyname, $match, $flags);
1051 di = repo.Dataiterator_meta(keyname, match, flags)
1052 di = repo.Dataiterator_meta(keyname, match, flags)
1058 Iterate over the matching data elements in this repository. See the
1059 Dataiterator class for more information. The Dataiterator() method
1060 iterates over all solvables in a repository, whereas the Dataiterator_meta
1061 method only iterates over the repository's meta data.
1064 my $str = $repo->str;
1068 Return the name of the repository, or "Repo#<id>" if no name is set.
1071 if ($repo1 == $repo2)
1075 Two repositories are equal if they belong to the same pool and have the same id.
1077 === DATA ADD METHODS ===
1079 Solvable add_solvable()
1080 $repo->add_solvable();
1084 Add a single empty solvable to the repository. Returns a Solvable object, see
1085 the Solvable class for more information.
1087 bool add_solv(const char *name, int flags = 0)
1088 $repo->add_solv($name);
1092 bool add_solv(FILE *fp, int flags = 0)
1093 $repo->add_solv($fp);
1097 Read a ``solv'' file and add its contents to the repository. These files can be
1098 written with the write() method and are normally used as fast cache for
1099 repository metadata.
1101 bool add_rpmdb(int flags = 0)
1106 bool add_rpmdb_reffp(FILE *reffp, int flags = 0)
1107 $repo->add_rpmdb_reffp($reffp);
1108 repo.add_rpmdb_reffp(reffp)
1109 repo.add_rpmdb_reffp(reffp)
1111 Add the contents of the rpm database to the repository. If a solv file
1112 containing an old version of the database is available, it can be passed as
1113 reffp to speed up reading.
1115 Solvable add_rpm(const char *filename, int flags = 0)
1116 my $solvable = $repo->add_rpm($filename);
1117 solvable = repo.add_rpm(filename)
1118 solvable = repo.add_rpm(filename)
1120 Add the metadata of a single rpm package to the repository.
1122 bool add_rpmdb_pubkeys(int flags = 0)
1123 $repo->add_rpmdb_pubkeys();
1124 repo.add_rpmdb_pubkeys()
1125 repo.add_rpmdb_pubkeys()
1127 Add all pubkeys contained in the rpm database to the repository. Note that
1128 newer rpm versions also allow to store the pubkeys in some directory instead
1129 of the rpm database.
1131 Solvable add_pubkey(const char *keyfile, int flags = 0)
1132 my $solvable = $repo->add_pubkey($keyfile);
1133 solvable = repo.add_pubkey(keyfile)
1134 solvable = repo.add_pubkey(keyfile)
1136 Add a pubkey from a file to the repository.
1138 bool add_rpmmd(FILE *fp, const char *language, int flags = 0)
1139 $repo->add_rpmmd($fp, undef);
1140 repo.add_rpmmd(fp, None)
1141 repo.add_rpmmd(fp, nil)
1143 Add metadata stored in the "rpm-md" format (i.e. from files in the ``repodata''
1144 directory) to a repository. Supported files are "primary", "filelists",
1145 "other", "suseinfo". Do not forget to specify the *REPO_EXTEND_SOLVABLES* for
1146 extension files like "filelists" and "other". Use the _language_ parameter if
1147 you have language extension files, otherwise simply use a *undef*/*None*/*nil*
1150 bool add_repomdxml(FILE *fp, int flags = 0)
1151 $repo->add_repomdxml($fp);
1152 repo.add_repomdxml(fp)
1153 repo.add_repomdxml(fp)
1155 Add the repomd.xml meta description from the "rpm-md" format to the repository.
1156 This file contains information about the repository like keywords, and also a
1157 list of all database files with checksums. The data is added to the "meta"
1158 section of the repository, i.e. no package gets created.
1160 bool add_updateinfoxml(FILE *fp, int flags = 0)
1161 $repo->add_updateinfoxml($fp);
1162 repo.add_updateinfoxml(fp)
1163 repo.add_updateinfoxml(fp)
1165 Add the updateinfo.xml file containing available maintenance updates to the
1166 repository. All updates are created as special packages that have a "patch:"
1167 prefix in their name.
1169 bool add_deltainfoxml(FILE *fp, int flags = 0)
1170 $repo->add_deltainfoxml($fp);
1171 repo.add_deltainfoxml(fp)
1172 repo.add_deltainfoxml(fp)
1174 Add the deltainfo.xml file (also called prestodelta.xml) containing available
1175 delta-rpms to the repository. The data is added to the "meta" section, i.e. no
1176 package gets created.
1178 bool add_debdb(int flags = 0)
1183 Add the contents of the debian installed package database to the repository.
1185 bool add_debpackages(FILE *fp, int flags = 0)
1186 $repo->add_debpackages($fp);
1187 repo.add_debpackages($fp)
1188 repo.add_debpackages($fp)
1190 Add the contents of the debian repository metadata (the "packages" file)
1193 Solvable add_deb(const char *filename, int flags = 0)
1194 my $solvable = $repo->add_deb($filename);
1195 solvable = repo.add_deb(filename)
1196 solvable = repo.add_deb(filename)
1198 Add the metadata of a single deb package to the repository.
1200 bool add_mdk(FILE *fp, int flags = 0)
1201 $repo->add_mdk($fp);
1205 Add the contents of the mageia/mandriva repository metadata (the
1206 "synthesis.hdlist" file) to the repository.
1208 bool add_mdk_info(FILE *fp, int flags = 0)
1209 $repo->add_mdk_info($fp);
1210 repo.add_mdk_info(fp)
1211 repo.add_mdk_info(fp)
1213 Extend the packages from the synthesis file with the info.xml and files.xml
1214 data. Do not forget to specify *REPO_EXTEND_SOLVABLES*.
1216 bool add_arch_repo(FILE *fp, int flags = 0)
1217 $repo->add_arch_repo($fp);
1218 repo.add_arch_repo(fp)
1219 repo.add_arch_repo(fp)
1221 Add the contents of the archlinux repository metadata (the ".db.tar" file) to
1224 bool add_arch_local(const char *dir, int flags = 0)
1225 $repo->add_arch_local($dir);
1226 repo.add_arch_local(dir)
1227 repo.add_arch_local(dir)
1229 Add the contents of the archlinux installed package database to the repository.
1230 The _dir_ parameter is usually set to "/var/lib/pacman/local".
1232 bool add_content(FILE *fp, int flags = 0)
1233 $repo->add_content($fp);
1234 repo.add_content(fp)
1235 repo.add_content(fp)
1237 Add the ``content'' meta description from the susetags format to the repository.
1238 This file contains information about the repository like keywords, and also
1239 a list of all database files with checksums. The data is added to the "meta"
1240 section of the repository, i.e. no package gets created.
1242 bool add_susetags(FILE *fp, Id defvendor, const char *language, int flags = 0)
1243 $repo->add_susetags($fp, $defvendor, $language);
1244 repo.add_susetags(fp, defvendor, language)
1245 repo.add_susetags(fp, defvendor, language)
1247 Add repository metadata in the susetags format to the repository. Like with
1248 add_rpmmd, you can specify a language if you have language extension files. The
1249 _defvendor_ parameter provides a default vendor for packages with missing
1250 vendors, it is usually provided in the content file.
1252 bool add_products(const char *dir, int flags = 0)
1253 $repo->add_products($dir);
1254 repo.add_products(dir)
1255 repo.add_products(dir)
1257 Add the installed SUSE products database to the repository. The _dir_ parameter
1258 is usually "/etc/products.d".
1263 A solvable describes all the information of one package. Each solvable
1264 belongs to one repository, it can be added and filled manually but in
1265 most cases solvables will get created by the repo_add methods.
1269 Repo *repo; /* read only */
1274 The repository this solvable belongs to.
1276 Pool *pool; /* read only */
1281 The pool this solvable belongs to, same as the pool of the repo.
1283 Id id; /* read only */
1288 The specific id of the solvable.
1290 char *name; /* read/write */
1295 char *evr; /* read/write */
1300 char *arch; /* read/write */
1305 char *vendor; /* read/write */
1310 Easy access to often used attributes of solvables. They are
1311 internally stored as Ids.
1313 Id nameid; /* read/write */
1318 Id evrid; /* read/write */
1323 Id archid; /* read/write */
1328 Id vendorid; /* read/write */
1329 $solvable->{vendorid}
1333 Raw interface to the ids. Useful if you want to search for
1334 a specific id and want to avoid the string compare overhead.
1338 const char *lookup_str(Id keyname)
1339 my $string = $solvable->lookup_str($keyname);
1340 string = solvable.lookup_str(keyname)
1341 string = solvable.lookup_str(keyname)
1343 Id lookup_id(Id keyname)
1344 my $id = $solvable->lookup_id($keyname);
1345 id = solvable.lookup_id(solvid)
1346 id = solvable.lookup_id(solvid)
1348 unsigned long long lookup_num(Id solvid, Id keyname, unsigned long long notfound = 0)
1349 my $num = $solvable->lookup_num($keyname);
1350 num = solvable.lookup_num(keyname)
1351 num = solvable.lookup_num(keyname)
1353 bool lookup_void(Id keyname)
1354 my $bool = $solvable->lookup_void($keyname);
1355 bool = solvable.lookup_void(keyname)
1356 bool = solvable.lookup_void(keyname)
1358 Chksum lookup_checksum(Id keyname)
1359 my $chksum = $solvable->lookup_checksum($keyname);
1360 chksum = solvable.lookup_checksum(keyname)
1361 chksum = solvable.lookup_checksum(keyname)
1363 Id *lookup_idarray(Id keyname, Id marker = -1)
1364 my @ids = $solvable->lookup_idarray($keyname);
1365 ids = solvable.lookup_idarray(keyname)
1366 ids = solvable.lookup_idarray(keyname)
1368 Dep *lookup_deparray(Id keyname, Id marker = -1)
1369 my @deps = $solvable->lookup_deparray($keyname);
1370 deps = solvable.lookup_deparray(keyname)
1371 deps = solvable.lookup_deparray(keyname)
1373 Generic lookup methods. Retrieve data stored for the specific keyname.
1374 The lookup_idarray() method will return an array of Ids, use
1375 lookup_deparray if you want an array of Dependency objects instead.
1376 Some Id arrays contain two parts of data divided by a specific marker,
1377 for example the provides array uses the SOLVABLE_FILEMARKER id to
1378 store both the ids provided by the package and the ids added by
1379 the addfileprovides method. The default, -1, translates to the
1380 correct marker for the keyname and returns the first part of the
1381 array, use 1 to select the second part or 0 to retrieve all ids
1382 including the marker.
1384 const char *lookup_location(unsigned int *OUTPUT);
1385 my ($location, $medianr) = $solvable->lookup_location();
1386 location, medianr = solvable.lookup_location()
1387 location, medianr = solvable.lookup_location()
1389 Return a tuple containing the on-media location and an optional
1390 media number for multi-part repositories (e.g. repositories
1391 spawning multiple DVDs).
1393 const char *lookup_sourcepkg();
1394 my $sourcepkg = $solvable->lookup_sourcepkg();
1395 sourcepkg = solvable.lookup_sourcepkg()
1396 sourcepkg = solvable.lookup_sourcepkg()
1398 Return a sourcepkg name associated with solvable.
1400 Dataiterator Dataiterator(Id keyname, const char *match = 0, int flags = 0)
1401 my $di = $solvable->Dataiterator($keyname, $match, $flags);
1402 di = solvable.Dataiterator(keyname, match, flags)
1403 di = solvable.Dataiterator(keyname, match, flags)
1409 Iterate over the matching data elements. See the Dataiterator class for more
1412 void add_deparray(Id keyname, DepId dep, Id marker = -1);
1413 $solvable->add_deparray($keyname, $dep);
1414 solvable.add_deparray(keyname, dep)
1415 solvable.add_deparray(keyname, dep)
1417 Add a new dependency to the attributes stored in keyname.
1419 void unset(Id keyname);
1420 $solvable->unset($keyname);
1421 solvable.unset(keyname)
1422 solvable.unset(keyname)
1424 Delete data stored for the specific keyname.
1427 $solvable->installable()
1428 solvable.installable()
1429 solvable.installable?
1431 Return true if the solvable is installable on the system. Solvables
1432 are not installable if the system does not support their architecture.
1435 $solvable->isinstalled()
1436 solvable.isinstalled()
1437 solvable.isinstalled?
1439 Return true if the solvable is installed on the system.
1441 bool identical(Solvable *other)
1442 $solvable->identical($other)
1443 solvable.identical(other)
1444 solvable.identical?(other)
1446 Return true if the two solvables are identical.
1448 int evrcmp(Solvable *other)
1449 $solvable->evrcmp($other)
1450 solvable.evrcmp(other)
1451 solvable.evrcmp(other)
1453 Returns -1 if the epoch/version/release of the solvable is less than the
1454 one from the other solvable, 1 if it is greater, and 0 if they are equal.
1455 Note that "equal" does not mean that the evr is identical.
1457 int matchesdep(Id keyname, DepId id, Id marker = -1)
1458 $solvable->matchesdep($keyname, $dep)
1459 solvable.matchesdep(keyname, dep)
1460 solvable.matchesdep?(keyname, dep)
1462 Return true if the dependencies stored in keyname match the specified dependency.
1464 Selection Selection(int setflags = 0)
1465 my $sel = $solvable->Selection();
1466 sel = solvable.Selection()
1467 sel = solvable.Selection()
1469 Create a Selection containing just the single solvable.
1472 my $str = $solvable->str();
1473 str = $solvable.str()
1474 str = $solvable.str()
1476 Return a string describing the solvable. The string consists of the name,
1477 version, and architecture of the Solvable.
1480 my $str = $solvable->str;
1484 Same as calling the str() method.
1487 if ($solvable1 == $solvable2)
1488 if solvable1 == solvable2:
1489 if solvable1 == solvable2
1491 Two solvables are equal if they are part of the same pool and have the same
1495 The Dataiterator Class
1496 ----------------------
1497 Dataiterators can be used to do complex string searches or
1498 to iterate over arrays. They can be created via the
1499 constructors in the Pool, Repo, and Solvable classes. The
1500 Repo and Solvable constructors will limit the search to
1501 the repository or the specific package.
1506 Return a match if the search string matches the value.
1508 *SEARCH_STRINGSTART*::
1509 Return a match if the value starts with the search string.
1511 *SEARCH_STRINGEND*::
1512 Return a match if the value ends with the search string.
1514 *SEARCH_SUBSTRING*::
1515 Return a match if the search string can be matched somewhere in the value.
1518 Do a glob match of the search string against the value.
1521 Do a regular expression match of the search string against the value.
1524 Ignore case when matching strings. Works for all the above match types.
1527 Match the complete filenames of the file list, not just the base name.
1529 *SEARCH_COMPLETE_FILELIST*::
1530 When matching the file list, check every file of the package not just the
1531 subset from the primary metadata.
1533 *SEARCH_CHECKSUMS*::
1534 Allow the matching of checksum entries.
1538 void prepend_keyname(Id keyname);
1539 $di->prepend_keyname($keyname);
1540 di.prepend_keyname(keyname)
1541 di.prepend_keyname(keyname)
1543 Do a sub-search in the array stored in keyname.
1545 void skip_solvable();
1546 $di->skip_solvable();
1550 Stop matching the current solvable and advance to the next
1558 Iterate through the matches. If there is a match, the object
1559 in d will be of type Datamatch.
1563 Objects of this type will be created for every value matched
1568 Pool *pool; /* read only */
1573 Back pointer to pool.
1575 Repo *repo; /* read only */
1580 The repository containing the matched object.
1582 Solvable *solvable; /* read only */
1587 The solvable containing the value that was matched.
1589 Id solvid; /* read only */
1594 The id of the solvable that matched.
1601 const char *key_idstr;
1606 The keyname that matched, either as id or string.
1613 const char *type_idstr;
1618 The key type of the value that was matched, either as id or string.
1630 The Id of the value that was matched (only valid for id types),
1631 either as id or string.
1638 The string value that was matched (only valid for string types).
1640 unsigned long long num;
1645 The numeric value that was matched (only valid for numeric types).
1652 The secondary numeric value that was matched (only valid for types
1653 containing two values).
1655 unsigned int binary;
1660 The value in binary form, useful for checksums and other data
1661 that cannot be represented as a string.
1666 my $pos = $d->pos();
1670 The position object of the current match. It can be used to do
1671 sub-searches starting at the match (if it is of an array type).
1672 See the Datapos class for more information.
1674 Datapos parentpos();
1675 my $pos = $d->parentpos();
1679 The position object of the array containing the current match.
1680 It can be used to do sub-searches, see the Datapos class for more
1688 Return the stringification of the matched value. Stringification
1689 depends on the search flags, for file list entries it will return
1690 just the base name unless SEARCH_FILES is used, for checksums
1691 it will return an empty string unless SEARCH_CHECKSUMS is used.
1692 Numeric values are currently stringified to an empty string.
1697 Selections are a way to easily deal with sets of packages.
1698 There are multiple constructors to create them, the most useful
1699 is probably the select() method in the Pool class.
1704 Create the selection by matching package names.
1706 *SELECTION_PROVIDES*::
1707 Create the selection by matching package provides.
1709 *SELECTION_FILELIST*::
1710 Create the selection by matching package files.
1713 Create the selection by matching the canonical representation
1714 of the package. This is normally a combination of the name,
1715 the version, and the architecture of a package.
1717 *SELECTION_DOTARCH*::
1718 Allow an ".<architecture>" suffix when matching names or
1722 Allow the specification of a relation when matching names
1723 or dependencies, e.g. "name >= 1.2".
1726 Allow glob matching for package names, package provides, and file names.
1728 *SELECTION_NOCASE*::
1729 Ignore case when matching package names, package provides, and file names.
1732 Return only one selection element describing the selected packages.
1733 The default is to create multiple elements for all globbed packages.
1734 Multiple elements are useful if you want to turn the selection into
1735 an install job, in that case you want an install job for every
1738 *SELECTION_SKIP_KIND*::
1739 Remove a "packagekind:" prefix from the package names.
1741 *SELECTION_MATCH_DEPSTR*::
1742 When matching dependencies, do a string match on the result of dep2str
1743 instead of using the normal dependency intersect algorithm.
1745 *SELECTION_INSTALLED_ONLY*::
1746 Limit the package search to installed packages.
1748 *SELECTION_SOURCE_ONLY*::
1749 Limit the package search to source packages only.
1751 *SELECTION_WITH_SOURCE*::
1752 Extend the package search to also match source packages. The default is
1753 only to match binary packages.
1755 *SELECTION_WITH_DISABLED*::
1756 Extend the package search to also include disabled packages.
1758 *SELECTION_WITH_BADARCH*::
1759 Extend the package search to also include packages that are not installable
1760 on the configured architecture.
1762 *SELECTION_WITH_ALL*::
1763 Shortcut for selecting the three modifiers above.
1766 Add the result of the match to the current selection instead of replacing it.
1768 *SELECTION_SUBTRACT*::
1769 Remove the result of the match to the current selection instead of replacing it.
1771 *SELECTION_FILTER*::
1772 Intersect the result of the match to the current selection instead of replacing it.
1776 Pool *pool; /* read only */
1781 Back pointer to pool.
1786 my $flags = $sel->flags();
1790 Return the result flags of the selection. The flags are a subset
1791 of the ones used when creating the selection, they describe which
1792 method was used to get the result. For example, if you create the
1793 selection with ``SELECTION_NAME | SELECTION_PROVIDES'', the resulting
1794 flags will either be SELECTION_NAME or SELECTION_PROVIDES depending
1795 if there was a package that matched the name or not. If there was
1796 no match at all, the flags will be zero.
1803 Return true if the selection is empty, i.e. no package could be matched.
1805 Selection clone(int flags = 0)
1806 my $cloned = $sel->clone();
1807 cloned = sel.clone()
1808 cloned = sel.clone()
1810 Return a copy of a selection.
1812 void filter(Selection *other)
1813 $sel->filter($other);
1817 Intersect two selections. Packages will only stay in the selection if there
1818 are also included in the other selecting. Does an in-place modification.
1820 void add(Selection *other)
1825 Build the union of two selections. All packages of the other selection will
1826 be added to the set of packages of the selection object. Does an in-place
1827 modification. Note that the selection flags are no longer meaningful after the
1830 void subtract(Selection *other)
1831 $sel->subtract($other);
1835 Remove the packages of the other selection from the packages of the selection
1836 object. Does an in-place modification.
1838 void add_raw(Id how, Id what)
1839 $sel->add_raw($how, $what);
1840 sel.add_raw(how, what)
1841 sel.add_raw(how, what)
1843 Add a raw element to the selection. Check the Job class for information about
1844 the how and what parameters. Note that the selection flags are no longer meaningful
1845 after the add_raw operation.
1847 Job *jobs(int action)
1848 my @jobs = $sel->jobs($action);
1849 jobs = sel.jobs(action)
1850 jobs = sel.jobs(action)
1852 Convert a selection into an array of Job objects. The action parameter is or-ed
1853 to the ``how'' part of the job, it describes the type of job (e.g. install,
1854 erase). See the Job class for the action and action modifier constants.
1856 Solvable *solvables()
1857 my @solvables = $sel->solvables();
1858 solvables = sel.solvables()
1859 solvables = sel.solvables()
1861 Convert a selection into an array of Solvable objects.
1863 void select(const char *name, int flags)
1864 $sel->select($name, $flags);
1865 sel.select(name, flags)
1866 sel.select(name, flags)
1868 Do a select operation and combine the result with the current selection. You
1869 can choose the desired combination method by using either the SELECTION_ADD,
1870 SELECTION_SUBTRACT, or SELECTION_FILTER flag. If none of the flags are
1871 used, SELECTION_FILTER|SELECTION_WITH_ALL is assumed.
1873 void matchdeps(const char *name, int flags, Id keyname, Id marker = -1)
1874 $sel->matchdeps($name, $flags, $keyname);
1875 sel.matchdeps(name, flags, keyname)
1876 sel.matchdeps(name, flags, keyname)
1878 Do a matchdeps operation and combine the result with the current selection.
1880 void matchdepid(DepId dep, int flags, Id keyname, Id marker = -1)
1881 $sel->matchdepid($dep, $flags, $keyname);
1882 sel.matchdepid(dep, flags, keyname)
1883 sel.matchdepid(dep, flags, keyname)
1885 Do a matchdepid operation and combine the result with the current selection.
1888 my $str = $sel->str;
1892 Return a string describing the selection.
1896 Jobs are the way to specify to the dependency solver what to do.
1897 Most of the times jobs will get created by calling the jobs() method
1898 on a Selection object, but there is also a Job() constructor in the
1903 Selection constants:
1906 The ``what'' part is the id of a solvable.
1908 *SOLVER_SOLVABLE_NAME*::
1909 The ``what'' part is the id of a package name.
1911 *SOLVER_SOLVABLE_PROVIDES*::
1912 The ``what'' part is the id of a package provides.
1914 *SOLVER_SOLVABLE_ONE_OF*::
1915 The ``what'' part is an offset into the ``whatprovides'' data, created
1916 by calling the towhatprovides() pool method.
1918 *SOLVER_SOLVABLE_REPO*::
1919 The ``what'' part is the id of a repository.
1921 *SOLVER_SOLVABLE_ALL*::
1922 The ``what'' part is ignored, all packages are selected.
1924 *SOLVER_SOLVABLE_SELECTMASK*::
1925 A mask containing all the above selection bits.
1933 Install a package of the specified set of packages. It tries to install
1934 the best matching package (i.e. the highest version of the packages from
1935 the repositories with the highest priority).
1938 Erase all of the packages from the specified set. If a package is not
1939 installed, erasing it will keep it from getting installed.
1942 Update the matching installed packages to their best version. If none
1943 of the specified packages are installed, try to update the installed
1944 packages to the specified versions. See the section about targeted
1945 updates about more information.
1947 *SOLVER_WEAKENDEPS*::
1948 Allow to break the dependencies of the matching packages. Handle with care.
1950 *SOLVER_MULTIVERSION*::
1951 Mark the matched packages for multiversion install. If they get to be
1952 installed because of some other job, the installation will keep the old
1953 version of the package installed (for rpm this is done by using ``-i''
1957 Do not change the state of the matched packages, i.e. when they are
1958 installed they stay installed, if not they are not selected for
1961 *SOLVER_DISTUPGRADE*::
1962 Update the matching installed packages to the best version included in one
1963 of the repositories. After this operation, all come from one of the available
1964 repositories except orphaned packages. Orphaned packages are packages that
1965 have no relation to the packages in the repositories, i.e. no package in the
1966 repositories have the same name or obsolete the orphaned package.
1967 This action brings the installed packages in sync with the ones in the
1968 repository. By default it also turns of arch/vendor/version locking for the
1969 affected packages to simulate a fresh installation. This means that distupgrade can
1970 actually downgrade packages if only lower versions of a package are available
1971 in the repositories. You can tweak this behavior with the SOLVER_FLAG_DUP_
1974 *SOLVER_DROP_ORPHANED*::
1975 Erase all the matching installed packages if they are orphaned. This only makes
1976 sense if there is a ``distupgrade all packages'' job. The default is to erase
1977 orphaned packages only if they block the installation of other packages.
1980 Fix dependency problems of matching installed packages. The default is to ignore
1981 dependency problems for installed packages.
1983 *SOLVER_USERINSTALLED*::
1984 The matching installed packages are considered to be installed by a user,
1985 thus not installed to fulfill some dependency. This is needed input for
1986 the calculation of unneeded packages for jobs that have the
1987 SOLVER_CLEANDEPS flag set.
1989 *SOLVER_ALLOWUNINSTALL*::
1990 Allow the solver to deinstall the matching installed packages if they get
1991 into the way of resolving a dependency. This is like the
1992 SOLVER_FLAG_ALLOW_UNINSTALL flag, but limited to a specific set of packages.
1995 Prefer the specified packages if the solver encounters an alternative. If
1996 a job contains multiple matching favor/disfavor elements, the last one takes
2000 Avoid the specified packages if the solver encounters an alternative. This
2001 can also be used to block recommended or supplemented packages from being
2005 A mask containing all the above action bits.
2007 Action modifier constants:
2010 Makes the job a weak job. The solver tries to fulfill weak jobs, but does
2011 not report a problem if it is not possible to do so.
2013 *SOLVER_ESSENTIAL*::
2014 Makes the job an essential job. If there is a problem with the job, the
2015 solver will not propose to remove the job as one solution (unless all
2016 other solutions are also to remove essential jobs).
2018 *SOLVER_CLEANDEPS*::
2019 The solver will try to also erase all packages dragged in through
2020 dependencies when erasing the package. This needs SOLVER_USERINSTALLED
2021 jobs to maximize user satisfaction.
2023 *SOLVER_FORCEBEST*::
2024 Insist on the best package for install, update, and distupgrade jobs. If
2025 this flag is not used, the solver will use the second-best package if the
2026 best package cannot be installed for some reason. When this flag is used,
2027 the solver will generate a problem instead.
2030 Forces targeted operation update and distupgrade jobs. See the section
2031 about targeted updates about more information.
2036 The job specified the exact epoch and version of the package set.
2039 The job specified the exact epoch, version, and release of the package set.
2042 The job specified the exact architecture of the packages from the set.
2044 *SOLVER_SETVENDOR*::
2045 The job specified the exact vendor of the packages from the set.
2048 The job specified the exact repository of the packages from the set.
2051 The job specified the exact name of the packages from the set.
2053 *SOLVER_NOAUTOSET*::
2054 Turn of automatic set flag generation for SOLVER_SOLVABLE jobs.
2057 A mask containing all the above set bits.
2059 See the section about set bits for more information.
2063 Pool *pool; /* read only */
2068 Back pointer to pool.
2070 Id how; /* read/write */
2075 Union of the selection, action, action modifier, and set flags.
2076 The selection part describes the semantics of the ``what'' Id.
2078 Id what; /* read/write */
2083 Id describing the set of packages, the meaning depends on the
2084 selection part of the ``how'' attribute.
2088 Solvable *solvables()
2089 my @solvables = $job->solvables();
2090 solvables = job.solvables()
2091 solvables = job.solvables()
2093 Return the set of solvables of the job as an array of Solvable
2096 bool isemptyupdate();
2097 $job->isemptyupdate()
2101 Convenience function to find out if the job describes an update
2102 job with no matching packages, i.e. a job that does nothing.
2103 Some package managers like ``zypper'' like to turn those jobs
2104 into install jobs, i.e. an update of a not-installed package
2105 will result into the installation of the package.
2108 my $str = $job->str;
2112 Return a string describing the job.
2119 Two jobs are equal if they belong to the same pool and both the
2120 ``how'' and the ``what'' attributes are the same.
2122 === TARGETED UPDATES ===
2123 Libsolv has two modes for upgrades and distupgrade: targeted and
2124 untargeted. Untargeted mode means that the installed packages from
2125 the specified set will be updated to the best version. Targeted means
2126 that packages that can be updated to a package in the specified set
2127 will be updated to the best package of the set.
2129 Here's an example to explain the subtle difference. Suppose that
2130 you have package A installed in version "1.1", "A-1.2" is available
2131 in one of the repositories and there is also package "B" that
2132 obsoletes package A.
2134 An untargeted update of "A" will update the installed "A-1.1" to
2135 package "B", because that is the newest version (B obsoletes A and
2138 A targeted update of "A" will update "A-1.1" to "A-1.2", as the
2139 set of packages contains both "A-1.1" and "A-1.2", and "A-1.2" is
2142 An untargeted update of "B" will do nothing, as "B" is not installed.
2144 An targeted update of "B" will update "A-1.1" to "B".
2146 Note that the default is to do "auto-targeting", thus if the specified
2147 set of packages does not include an installed package, the solver
2148 will assume targeted operation even if SOLVER_TARGETED is not used.
2150 This mostly matches the intent of the user, with one exception: In
2151 the example above, an update of "A-1.2" will update "A-1.1" to
2152 "A-1.2" (targeted mode), but a second update of "A-1.2" will suddenly
2153 update to "B", as untargeted mode is chosen because "A-1.2" is now
2156 If you want to have full control over when targeting mode is chosen,
2157 turn off auto-targeting with the SOLVER_FLAG_NO_AUTOTARGET solver option.
2158 In that case, all updates are considered to be untargeted unless they
2159 include the SOLVER_TARGETED flag.
2162 Set bits specify which parts of the specified packages where specified
2163 by the user. It is used by the solver when checking if an operation is
2164 allowed or not. For example, the solver will normally not allow the
2165 downgrade of an installed package. But it will not report a problem if
2166 the SOLVER_SETEVR flag is used, as it then assumes that the user specified
2167 the exact version and thus knows what he is doing.
2169 So if a package "screen-1-1" is installed for the x86_64 architecture and
2170 version "2-1" is only available for the i586 architecture, installing
2171 package "screen-2.1" will ask the user for confirmation because of the
2172 different architecture. When using the Selection class to create jobs
2173 the set bits are automatically added, e.g. selecting ``screen.i586'' will
2174 automatically add SOLVER_SETARCH, and thus no problem will be reported.
2178 Dependency solving is what this library is about. A solver object is needed
2179 for solving to store the result of the solver run. The solver object can be
2180 used multiple times for different jobs, reusing it allows the solver to
2181 re-use the dependency rules it already computed.
2185 Flags to modify some of the solver's behavior:
2187 *SOLVER_FLAG_ALLOW_DOWNGRADE*::
2188 Allow the solver to downgrade packages without asking for confirmation
2189 (i.e. reporting a problem).
2191 *SOLVER_FLAG_ALLOW_ARCHCHANGE*::
2192 Allow the solver to change the architecture of an installed package
2193 without asking for confirmation. Note that changes to/from noarch
2194 are always considered to be allowed.
2196 *SOLVER_FLAG_ALLOW_VENDORCHANGE*::
2197 Allow the solver to change the vendor of an installed package
2198 without asking for confirmation. Each vendor is part of one or more
2199 vendor equivalence classes, normally installed packages may only
2200 change their vendor if the new vendor shares at least one equivalence
2203 *SOLVER_FLAG_ALLOW_NAMECHANGE*::
2204 Allow the solver to change the name of an installed package, i.e.
2205 install a package with a different name that obsoletes the installed
2206 package. This option is on by default.
2208 *SOLVER_FLAG_ALLOW_UNINSTALL*::
2209 Allow the solver to erase installed packages to fulfill the jobs.
2210 This flag also includes the above flags. You may want to set this
2211 flag if you only have SOLVER_ERASE jobs, as in that case it's
2212 better for the user to check the transaction overview instead of
2213 approving every single package that needs to be erased.
2215 *SOLVER_FLAG_DUP_ALLOW_DOWNGRADE*::
2216 Like SOLVER_FLAG_ALLOW_DOWNGRADE, but used in distupgrade mode.
2218 *SOLVER_FLAG_DUP_ALLOW_ARCHCHANGE*::
2219 Like SOLVER_FLAG_ALLOW_ARCHCHANGE, but used in distupgrade mode.
2221 *SOLVER_FLAG_DUP_ALLOW_VENDORCHANGE*::
2222 Like SOLVER_FLAG_ALLOW_VENDORCHANGE, but used in distupgrade mode.
2224 *SOLVER_FLAG_DUP_ALLOW_NAMECHANGE*::
2225 Like SOLVER_FLAG_ALLOW_NAMECHANGE, but used in distupgrade mode.
2227 *SOLVER_FLAG_NO_UPDATEPROVIDE*::
2228 If multiple packages obsolete an installed package, the solver checks
2229 the provides of every such package and ignores all packages that
2230 do not provide the installed package name. Thus, you can have an
2231 official update candidate that provides the old name, and other
2232 packages that also obsolete the package but are not considered for
2233 updating. If you cannot use this feature, you can turn it off
2234 by setting this flag.
2236 *SOLVER_FLAG_NEED_UPDATEPROVIDE*::
2237 This is somewhat the opposite of SOLVER_FLAG_NO_UPDATEPROVIDE: Only
2238 packages that provide the installed package names are considered
2241 *SOLVER_FLAG_SPLITPROVIDES*::
2242 Make the solver aware of special provides of the form
2243 ``<packagename>:<path>'' used in SUSE systems to support package
2246 *SOLVER_FLAG_IGNORE_RECOMMENDED*::
2247 Do not process optional (aka weak) dependencies.
2249 *SOLVER_FLAG_ADD_ALREADY_RECOMMENDED*::
2250 Install recommended or supplemented packages even if they have no
2251 connection to the current transaction. You can use this feature
2252 to implement a simple way for the user to install new recommended
2253 packages that were not available in the past.
2255 *SOLVER_FLAG_NO_INFARCHCHECK*::
2256 Turn off the inferior architecture checking that is normally done
2257 by the solver. Normally, the solver allows only the installation
2258 of packages from the "best" architecture if a package is available
2259 for multiple architectures.
2261 *SOLVER_FLAG_BEST_OBEY_POLICY*::
2262 Make the SOLVER_FORCEBEST job option consider only packages that
2263 meet the policies for installed packages, i.e. no downgrades,
2264 no architecture change, no vendor change (see the first flags
2265 of this section). If the flag is not specified, the solver will
2266 enforce the installation of the best package ignoring the
2267 installed packages, which may conflict with the set policy.
2269 *SOLVER_FLAG_NO_AUTOTARGET*::
2270 Do not enable auto-targeting up update and distupgrade jobs. See
2271 the section on targeted updates for more information.
2273 *SOLVER_FLAG_KEEP_ORPHANS*::
2274 Do not allow orphaned packages to be deinstalled if they get
2275 in the way of resolving other packages.
2277 *SOLVER_FLAG_BREAK_ORPHANS*::
2278 Ignore dependencies of orphaned packages that get in the way
2279 of resolving non-orphaned ones. Setting the flag might result
2280 in no longer working packages in case they are orphaned.
2282 *SOLVER_FLAG_FOCUS_INSTALLED*::
2283 Resolve installed packages before resolving the given jobs.
2284 Setting this flag means that the solver will prefer picking
2285 a package version that fits the other installed packages
2286 over updating installed packages.
2288 *SOLVER_FLAG_FOCUS_BEST*::
2289 First resolve the given jobs, then the dependencies of the
2290 resulting packages, then resolve all already installed
2291 packages. This will result in more packages being updated
2292 as when the flag is not used.
2294 *SOLVER_FLAG_INSTALL_ALSO_UPDATES*::
2295 Update the package if a job is already fulfilled by an installed
2298 *SOLVER_FLAG_YUM_OBSOLETES*::
2299 Turn on yum-like package split handling. See the yum documentation
2302 *SOLVER_FLAG_URPM_REORDER*::
2303 Turn on urpm like package reordering for kernel packages. See
2304 the urpm documentation for more details.
2310 *SOLVER_RULE_UNKNOWN*::
2311 A rule of an unknown class. You should never encounter those.
2314 A package dependency rule.
2316 *SOLVER_RULE_UPDATE*::
2317 A rule to implement the update policy of installed packages. Every
2318 installed package has an update rule that consists of the packages
2319 that may replace the installed package.
2321 *SOLVER_RULE_FEATURE*::
2322 Feature rules are fallback rules used when an update rule is disabled. They
2323 include all packages that may replace the installed package ignoring the
2324 update policy, i.e. they contain downgrades, arch changes and so on.
2325 Without them, the solver would simply erase installed packages if their
2326 update rule gets disabled.
2329 Job rules implement the job given to the solver.
2331 *SOLVER_RULE_DISTUPGRADE*::
2332 These are simple negative assertions that make sure that only packages
2333 are kept that are also available in one of the repositories.
2335 *SOLVER_RULE_INFARCH*::
2336 Infarch rules are also negative assertions, they disallow the installation
2337 of packages when there are packages of the same name but with a better
2340 *SOLVER_RULE_CHOICE*::
2341 Choice rules are used to make sure that the solver prefers updating to
2342 installing different packages when some dependency is provided by
2343 multiple packages with different names. The solver may always break
2344 choice rules, so you will not see them when a problem is found.
2346 *SOLVER_RULE_LEARNT*::
2347 These rules are generated by the solver to keep it from running into
2348 the same problem multiple times when it has to backtrack. They are
2349 the main reason why a sat solver is faster than other dependency solver
2352 Special dependency rule types:
2354 *SOLVER_RULE_PKG_NOT_INSTALLABLE*::
2355 This rule was added to prevent the installation of a package of an
2356 architecture that does not work on the system.
2358 *SOLVER_RULE_PKG_NOTHING_PROVIDES_DEP*::
2359 The package contains a required dependency which was not provided by
2362 *SOLVER_RULE_PKG_REQUIRES*::
2363 Similar to SOLVER_RULE_PKG_NOTHING_PROVIDES_DEP, but in this case
2364 some packages provided the dependency but none of them could be
2365 installed due to other dependency issues.
2367 *SOLVER_RULE_PKG_SELF_CONFLICT*::
2368 The package conflicts with itself. This is not allowed by older rpm
2371 *SOLVER_RULE_PKG_CONFLICTS*::
2372 To fulfill the dependencies two packages need to be installed, but
2373 one of the packages contains a conflict with the other one.
2375 *SOLVER_RULE_PKG_SAME_NAME*::
2376 The dependencies can only be fulfilled by multiple versions of
2377 a package, but installing multiple versions of the same package
2380 *SOLVER_RULE_PKG_OBSOLETES*::
2381 To fulfill the dependencies two packages need to be installed, but
2382 one of the packages obsoletes the other one.
2384 *SOLVER_RULE_PKG_IMPLICIT_OBSOLETES*::
2385 To fulfill the dependencies two packages need to be installed, but
2386 one of the packages has provides a dependency that is obsoleted
2387 by the other one. See the POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES
2390 *SOLVER_RULE_PKG_INSTALLED_OBSOLETES*::
2391 To fulfill the dependencies a package needs to be installed that is
2392 obsoleted by an installed package. See the POOL_FLAG_NOINSTALLEDOBSOLETES
2395 *SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP*::
2396 The user asked for installation of a package providing a specific
2397 dependency, but no available package provides it.
2399 *SOLVER_RULE_JOB_UNKNOWN_PACKAGE*::
2400 The user asked for installation of a package with a specific name,
2401 but no available package has that name.
2403 *SOLVER_RULE_JOB_PROVIDED_BY_SYSTEM*::
2404 The user asked for the erasure of a dependency that is provided by the
2405 system (i.e. for special hardware or language dependencies), this
2406 cannot be done with a job.
2408 *SOLVER_RULE_JOB_UNSUPPORTED*::
2409 The user asked for something that is not yet implemented, e.g. the
2410 installation of all packages at once.
2412 Policy error constants
2414 *POLICY_ILLEGAL_DOWNGRADE*::
2415 The solver ask for permission before downgrading packages.
2417 *POLICY_ILLEGAL_ARCHCHANGE*::
2418 The solver ask for permission before changing the architecture of installed
2421 *POLICY_ILLEGAL_VENDORCHANGE*::
2422 The solver ask for permission before changing the vendor of installed
2425 *POLICY_ILLEGAL_NAMECHANGE*::
2426 The solver ask for permission before replacing an installed packages with
2427 a package that has a different name.
2429 Solution element type constants
2431 *SOLVER_SOLUTION_JOB*::
2432 The problem can be solved by removing the specified job.
2434 *SOLVER_SOLUTION_POOLJOB*::
2435 The problem can be solved by removing the specified job that is defined
2438 *SOLVER_SOLUTION_INFARCH*::
2439 The problem can be solved by allowing the installation of the specified
2440 package with an inferior architecture.
2442 *SOLVER_SOLUTION_DISTUPGRADE*::
2443 The problem can be solved by allowing to keep the specified package
2446 *SOLVER_SOLUTION_BEST*::
2447 The problem can be solved by allowing to install the specified package
2448 that is not the best available package.
2450 *SOLVER_SOLUTION_ERASE*::
2451 The problem can be solved by allowing to erase the specified package.
2453 *SOLVER_SOLUTION_REPLACE*::
2454 The problem can be solved by allowing to replace the package with some
2457 *SOLVER_SOLUTION_REPLACE_DOWNGRADE*::
2458 The problem can be solved by allowing to replace the package with some
2459 other package that has a lower version.
2461 *SOLVER_SOLUTION_REPLACE_ARCHCHANGE*::
2462 The problem can be solved by allowing to replace the package with some
2463 other package that has a different architecture.
2465 *SOLVER_SOLUTION_REPLACE_VENDORCHANGE*::
2466 The problem can be solved by allowing to replace the package with some
2467 other package that has a different vendor.
2469 *SOLVER_SOLUTION_REPLACE_NAMECHANGE*::
2470 The problem can be solved by allowing to replace the package with some
2471 other package that has a different name.
2476 *SOLVER_REASON_UNRELATED*::
2477 The package status did not change as it was not related to any job.
2479 *SOLVER_REASON_UNIT_RULE*::
2480 The package was installed/erased/kept because of a unit rule, i.e. a rule
2481 where all literals but one were false.
2483 *SOLVER_REASON_KEEP_INSTALLED*::
2484 The package was chosen when trying to keep as many packages installed as
2487 *SOLVER_REASON_RESOLVE_JOB*::
2488 The decision happened to fulfill a job rule.
2490 *SOLVER_REASON_UPDATE_INSTALLED*::
2491 The decision happened to fulfill a package update request.
2493 *SOLVER_REASON_CLEANDEPS_ERASE*::
2494 The package was erased when cleaning up dependencies from other erased
2497 *SOLVER_REASON_RESOLVE*::
2498 The package was installed to fulfill package dependencies.
2500 *SOLVER_REASON_WEAKDEP*::
2501 The package was installed because of a weak dependency (Recommends or
2504 *SOLVER_REASON_RESOLVE_ORPHAN*::
2505 The decision about the package was made when deciding the fate of orphaned
2508 *SOLVER_REASON_RECOMMENDED*::
2509 This is a special case of SOLVER_REASON_WEAKDEP.
2511 *SOLVER_REASON_SUPPLEMENTED*::
2512 This is a special case of SOLVER_REASON_WEAKDEP.
2517 Pool *pool; /* read only */
2522 Back pointer to pool.
2526 int set_flag(int flag, int value)
2527 my $oldvalue = $solver->set_flag($flag, $value);
2528 oldvalue = solver.set_flag(flag, value)
2529 oldvalue = solver.set_flag(flag, value)
2531 int get_flag(int flag)
2532 my $value = $solver->get_flag($flag);
2533 value = solver.get_flag(flag)
2534 value = solver.get_flag(flag)
2536 Set/get a solver specific flag. The flags define the policies the solver has
2537 to obey. The flags are explained in the CONSTANTS section of this class.
2539 Problem *solve(Job *jobs)
2540 my @problems = $solver->solve(\@jobs);
2541 problems = solver.solve(jobs)
2542 problems = solver.solve(jobs)
2544 Solve a problem specified in the job list (plus the jobs defined in the pool).
2545 Returns an array of problems that need user interaction, or an empty array
2546 if no problems were encountered. See the Problem class on how to deal with
2549 Transaction transaction()
2550 my $trans = $solver->transaction();
2551 trans = solver.transaction()
2552 trans = solver.transaction()
2554 Return the transaction to implement the calculated package changes. A transaction
2555 is available even if problems were found, this is useful for interactive user
2556 interfaces that show both the job result and the problems.
2558 int reason = describe_decision(Solvable *s, Rule *OUTPUT)
2559 my ($reason, $rule) = $solver->describe_decision($solvable);
2560 (reason, rule) = solver.describe_decision(solvable)
2561 (reason, rule) = solver.describe_decision(solvable)
2563 Return the reason why a specific solvable was installed or erased. For most of
2564 the reasons the rule that triggered the decision is also returned.
2566 Solvable *get_recommended(bool noselected=0);
2567 my @solvables = $solver->get_recommended();
2568 solvables = solver.get_recommended()
2569 solvables = solver.get_recommended()
2571 Return all solvables that are recommended by the solver run result. This includes
2572 solvables included in the result, set noselected if you want to filter those.
2574 Solvable *get_suggested(bool noselected=0);
2575 my @solvables = $solver->get_suggested();
2576 solvables = solver.get_suggested()
2577 solvables = solver.get_suggested()
2579 Return all solvables that are suggested by the solver run result. This includes
2580 solvables included in the result, set noselected if you want to filter those.
2585 Problems are the way of the solver to interact with the user. You can simply list
2586 all problems and terminate your program, but a better way is to present solutions to
2587 the user and let him pick the ones he likes.
2591 Solver *solv; /* read only */
2596 Back pointer to solver object.
2598 Id id; /* read only */
2603 Id of the problem. The first problem has Id 1, they are numbered consecutively.
2607 Rule findproblemrule()
2608 my $probrule = $problem->findproblemrule();
2609 probrule = problem.findproblemrule()
2610 probrule = problem.findproblemrule()
2612 Return the rule that caused the problem. Of course in most situations there is no
2613 single responsible rule, but many rules that interconnect with each created the
2614 problem. Nevertheless, the solver uses some heuristic approach to find a rule
2615 that somewhat describes the problem best to the user.
2617 Rule *findallproblemrules(bool unfiltered = 0)
2618 my @probrules = $problem->findallproblemrules();
2619 probrules = problem.findallproblemrules()
2620 probrules = problem.findallproblemrules()
2622 Return all rules responsible for the problem. The returned set of rules contains
2623 all the needed information why there was a problem, but it's hard to present
2624 them to the user in a sensible way. The default is to filter out all update and
2625 job rules (unless the returned rules only consist of those types).
2627 Solution *solutions()
2628 my @solutions = $problem->solutions();
2629 solutions = problem.solutions()
2630 solutions = problem.solutions()
2632 Return an array containing multiple possible solutions to fix the problem. See
2633 the solution class for more information.
2635 int solution_count()
2636 my $cnt = $problem->solution_count();
2637 cnt = problem.solution_count()
2638 cnt = problem.solution_count()
2640 Return the number of solutions without creating solution objects.
2643 my $str = $problem->str;
2647 Return a string describing the problem. This is a convenience function, it is
2648 a shorthand for calling findproblemrule(), then ruleinfo() on the problem
2649 rule and problemstr() on the ruleinfo object.
2653 Rules are the basic block of sat solving. Each package dependency gets translated
2654 into one or multiple rules.
2658 Solver *solv; /* read only */
2663 Back pointer to solver object.
2665 Id id; /* read only */
2672 int type; /* read only */
2677 The basic type of the rule. See the constant section of the solver class for the type list.
2682 my $ruleinfo = $rule->info();
2683 ruleinfo = rule.info()
2684 ruleinfo = rule.info()
2686 Return a Ruleinfo object that contains information about why the rule was created. But
2687 see the allinfos() method below.
2689 Ruleinfo *allinfos()
2690 my @ruleinfos = $rule->allinfos();
2691 ruleinfos = rule.allinfos()
2692 ruleinfos = rule.allinfos()
2694 As the same dependency rule can get created because of multiple dependencies, one
2695 Ruleinfo is not enough to describe the reason. Thus the allinfos() method returns
2696 an array of all infos about a rule.
2699 if ($rule1 == $rule2)
2703 Two rules are equal if they belong to the same solver and have the same id.
2707 A Ruleinfo describes one reason why a rule was created.
2711 Solver *solv; /* read only */
2716 Back pointer to solver object.
2718 int type; /* read only */
2723 The type of the ruleinfo. See the constant section of the solver class for the
2724 rule type list and the special type list.
2726 Dep *dep; /* read only */
2731 The dependency leading to the creation of the rule.
2733 Dep *dep_id; /* read only */
2734 $ruleinfo->{'dep_id'}
2738 The Id of the dependency leading to the creation of the rule, or zero.
2740 Solvable *solvable; /* read only */
2741 $ruleinfo->{solvable}
2745 The involved Solvable, e.g. the one containing the dependency.
2747 Solvable *othersolvable; /* read only */
2748 $ruleinfo->{othersolvable}
2749 ruleinfo.othersolvable
2750 ruleinfo.othersolvable
2752 The other involved Solvable (if any), e.g. the one containing providing
2753 the dependency for conflicts.
2755 const char *problemstr();
2756 my $str = $ruleinfo->problemstr();
2757 str = ruleinfo.problemstr()
2758 str = ruleinfo.problemstr()
2760 A string describing the ruleinfo from a problem perspective. This probably
2761 only makes sense if the rule is part of a problem.
2765 A solution solves one specific problem. It consists of multiple solution elements
2766 that all need to be executed.
2770 Solver *solv; /* read only */
2775 Back pointer to solver object.
2777 Id problemid; /* read only */
2778 $solution->{problemid}
2782 Id of the problem the solution solves.
2784 Id id; /* read only */
2789 Id of the solution. The first solution has Id 1, they are numbered consecutively.
2793 Solutionelement *elements(bool expandreplaces = 0)
2794 my @solutionelements = $solution->elements();
2795 solutionelements = solution.elements()
2796 solutionelements = solution.elements()
2798 Return an array containing the elements describing what needs to be done to
2799 implement the specific solution. If expandreplaces is true, elements of type
2800 SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace
2801 elements describing the policy mismatches.
2804 my $cnt = $solution->solution_count();
2805 cnt = solution.element_count()
2806 cnt = solution.element_count()
2808 Return the number of solution elements without creating objects. Note that the
2809 count does not match the number of objects returned by the elements() method
2810 of expandreplaces is set to true.
2813 The Solutionelement Class
2814 -------------------------
2815 A solution element describes a single action of a solution. The action is always
2816 either to remove one specific job or to add a new job that installs or erases
2817 a single specific package.
2821 Solver *solv; /* read only */
2822 $solutionelement->{solv}
2823 solutionelement.solv
2824 solutionelement.solv
2826 Back pointer to solver object.
2828 Id problemid; /* read only */
2829 $solutionelement->{problemid}
2830 solutionelement.problemid
2831 solutionelement.problemid
2833 Id of the problem the element (partly) solves.
2835 Id solutionid; /* read only */
2836 $solutionelement->{solutionid}
2837 solutionelement.solutionid
2838 solutionelement.solutionid
2840 Id of the solution the element is a part of.
2842 Id id; /* read only */
2843 $solutionelement->{id}
2847 Id of the solution element. The first element has Id 1, they are numbered consecutively.
2849 Id type; /* read only */
2850 $solutionelement->{type}
2851 solutionelement.type
2852 solutionelement.type
2854 Type of the solution element. See the constant section of the solver class for the
2857 Solvable *solvable; /* read only */
2858 $solutionelement->{solvable}
2859 solutionelement.solvable
2860 solutionelement.solvable
2862 The installed solvable that needs to be replaced for replacement elements.
2864 Solvable *replacement; /* read only */
2865 $solutionelement->{replacement}
2866 solutionelement.replacement
2867 solutionelement.replacement
2869 The solvable that needs to be installed to fix the problem.
2871 int jobidx; /* read only */
2872 $solutionelement->{jobidx}
2873 solutionelement.jobidx
2874 solutionelement.jobidx
2876 The index of the job that needs to be removed to fix the problem, or -1 if the
2877 element is of another type. Note that it's better to change the job to SOLVER_NOOP
2878 type so that the numbering of other elements does not get disturbed. This
2879 method works both for types SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB.
2883 Solutionelement *replaceelements()
2884 my @solutionelements = $solutionelement->replaceelements();
2885 solutionelements = solutionelement.replaceelements()
2886 solutionelements = solutionelement.replaceelements()
2888 If the solution element is of type SOLVER_SOLUTION_REPLACE, return an array of
2889 elements describing the policy mismatches, otherwise return a copy of the
2890 element. See also the ``expandreplaces'' option in the solution's elements()
2893 int illegalreplace()
2894 my $illegal = $solutionelement->illegalreplace();
2895 illegal = solutionelement.illegalreplace()
2896 illegal = solutionelement.illegalreplace()
2898 Return an integer that contains the policy mismatch bits or-ed together, or
2899 zero if there was no policy mismatch. See the policy error constants in
2903 my $job = $solutionelement->Job();
2904 illegal = solutionelement.Job()
2905 illegal = solutionelement.Job()
2907 Create a job that implements the solution element. Add this job to the array
2908 of jobs for all elements of type different to SOLVER_SOLUTION_JOB and
2909 SOLVER_SOLUTION_POOLJOB. For the latter two, a SOLVER_NOOB Job is created,
2910 you should replace the old job with the new one.
2913 my $str = $solutionelement->str();
2914 str = solutionelement.str()
2915 str = solutionelement.str()
2917 A string describing the change the solution element consists of.
2919 The Transaction Class
2920 ---------------------
2921 Transactions describe the output of a solver run. A transaction contains
2922 a number of transaction elements, each either the installation of a new
2923 package or the removal of an already installed package. The Transaction
2924 class supports a classify() method that puts the elements into different
2925 groups so that a transaction can be presented to the user in a meaningful
2930 Transaction element types, both active and passive
2932 *SOLVER_TRANSACTION_IGNORE*::
2933 This element does nothing. Used to map element types that do not match
2936 *SOLVER_TRANSACTION_INSTALL*::
2937 This element installs a package.
2939 *SOLVER_TRANSACTION_ERASE*::
2940 This element erases a package.
2942 *SOLVER_TRANSACTION_MULTIINSTALL*::
2943 This element installs a package with a different version keeping the other
2946 *SOLVER_TRANSACTION_MULTIREINSTALL*::
2947 This element reinstalls an installed package keeping the other versions
2950 Transaction element types, active view
2952 *SOLVER_TRANSACTION_REINSTALL*::
2953 This element re-installs a package, i.e. installs the same package again.
2955 *SOLVER_TRANSACTION_CHANGE*::
2956 This element installs a package with same name, version, architecture but
2959 *SOLVER_TRANSACTION_UPGRADE*::
2960 This element installs a newer version of an installed package.
2962 *SOLVER_TRANSACTION_DOWNGRADE*::
2963 This element installs an older version of an installed package.
2965 *SOLVER_TRANSACTION_OBSOLETES*::
2966 This element installs a package that obsoletes an installed package.
2968 Transaction element types, passive view
2970 *SOLVER_TRANSACTION_REINSTALLED*::
2971 This element re-installs a package, i.e. installs the same package again.
2973 *SOLVER_TRANSACTION_CHANGED*::
2974 This element replaces an installed package with one of the same name,
2975 version, architecture but different content.
2977 *SOLVER_TRANSACTION_UPGRADED*::
2978 This element replaces an installed package with a new version.
2980 *SOLVER_TRANSACTION_DOWNGRADED*::
2981 This element replaces an installed package with an old version.
2983 *SOLVER_TRANSACTION_OBSOLETED*::
2984 This element replaces an installed package with a package that obsoletes
2987 Pseudo element types for showing extra information used by classify()
2989 *SOLVER_TRANSACTION_ARCHCHANGE*::
2990 This element replaces an installed package with a package of a different
2993 *SOLVER_TRANSACTION_VENDORCHANGE*::
2994 This element replaces an installed package with a package of a different
2997 Transaction mode flags
2999 *SOLVER_TRANSACTION_SHOW_ACTIVE*::
3000 Filter for active view types. The default is to return passive view type,
3001 i.e. to show how the installed packages get changed.
3003 *SOLVER_TRANSACTION_SHOW_OBSOLETES*::
3004 Do not map the obsolete view type into INSTALL/ERASE elements.
3006 *SOLVER_TRANSACTION_SHOW_ALL*::
3007 If multiple packages replace an installed package, only the best of them
3008 is kept as OBSOLETE element, the other ones are mapped to INSTALL/ERASE
3009 elements. This is because most applications want to show just one package
3010 replacing the installed one. The SOLVER_TRANSACTION_SHOW_ALL makes the
3011 library keep all OBSOLETE elements.
3013 *SOLVER_TRANSACTION_SHOW_MULTIINSTALL*::
3014 The library maps MULTIINSTALL elements to simple INSTALL elements. This
3015 flag can be used to disable the mapping.
3017 *SOLVER_TRANSACTION_CHANGE_IS_REINSTALL*::
3018 Use this flag if you want to map CHANGE elements to the REINSTALL type.
3020 *SOLVER_TRANSACTION_OBSOLETE_IS_UPGRADE*::
3021 Use this flag if you want to map OBSOLETE elements to the UPGRADE type.
3023 *SOLVER_TRANSACTION_MERGE_ARCHCHANGES*::
3024 Do not add extra categories for every architecture change, instead cumulate
3025 them in one category.
3027 *SOLVER_TRANSACTION_MERGE_VENDORCHANGES*::
3028 Do not add extra categories for every vendor change, instead cumulate
3029 them in one category.
3031 *SOLVER_TRANSACTION_RPM_ONLY*::
3032 Special view mode that just returns IGNORE, ERASE, INSTALL, MULTIINSTALL
3033 elements. Useful if you want to find out what to feed to the underlying
3036 Transaction order flags
3038 *SOLVER_TRANSACTION_KEEP_ORDERDATA*::
3039 Do not throw away the dependency graph used for ordering the transaction.
3040 This flag is needed if you want to do manual ordering.
3044 Pool *pool; /* read only */
3049 Back pointer to pool.
3058 Returns true if the transaction does not do anything, i.e. has no elements.
3060 Solvable *newsolvables();
3061 my @newsolvables = $trans->newsolvables();
3062 newsolvables = trans.newsolvables()
3063 newsolvables = trans.newsolvables()
3065 Return all packages that are to be installed by the transaction. These are
3066 the packages that need to be downloaded from the repositories.
3068 Solvable *keptsolvables();
3069 my @keptsolvables = $trans->keptsolvables();
3070 keptsolvables = trans.keptsolvables()
3071 keptsolvables = trans.keptsolvables()
3073 Return all installed packages that the transaction will keep installed.
3076 my @steps = $trans->steps();
3077 steps = trans.steps()
3078 steps = trans.steps()
3080 Return all solvables that need to be installed (if the returned solvable
3081 is not already installed) or erased (if the returned solvable is installed).
3082 A step is also called a transaction element.
3084 int steptype(Solvable *solvable, int mode)
3085 my $type = $trans->steptype($solvable, $mode);
3086 type = trans.steptype(solvable, mode)
3087 type = trans.steptype(solvable, mode)
3089 Return the transaction type of the specified solvable. See the CONSTANTS
3090 sections for the mode argument flags and the list of returned types.
3092 TransactionClass *classify(int mode = 0)
3093 my @classes = $trans->classify();
3094 classes = trans.classify()
3095 classes = trans.classify()
3097 Group the transaction elements into classes so that they can be displayed
3098 in a structured way. You can use various mapping mode flags to tweak
3099 the result to match your preferences, see the mode argument flag in
3100 the CONSTANTS section. See the TransactionClass class for how to deal
3101 with the returned objects.
3103 Solvable othersolvable(Solvable *solvable);
3104 my $other = $trans->othersolvable($solvable);
3105 other = trans.othersolvable(solvable)
3106 other = trans.othersolvable(solvable)
3108 Return the ``other'' solvable for a given solvable. For installed packages
3109 the other solvable is the best package with the same name that replaces
3110 the installed package, or the best package of the obsoleting packages if
3111 the package does not get replaced by one with the same name.
3113 For to be installed packages, the ``other'' solvable is the best installed
3114 package with the same name that will be replaced, or the best packages
3115 of all the packages that are obsoleted if the new package does not replace
3116 a package with the same name.
3118 Thus, the ``other'' solvable is normally the package that is also shown
3119 for a given package.
3121 Solvable *allothersolvables(Solvable *solvable);
3122 my @others = $trans->allothersolvables($solvable);
3123 others = trans.allothersolvables(solvable)
3124 others = trans.allothersolvables(solvable)
3126 For installed packages, returns all of the packages that replace us. For to
3127 be installed packages, returns all of the packages that the new package
3128 replaces. The special ``other'' solvable is always the first entry of the
3131 int calc_installsizechange();
3132 my $change = $trans->calc_installsizechange();
3133 change = trans.calc_installsizechange()
3134 change = trans.calc_installsizechange()
3136 Return the size change of the installed system in kilobytes (kibibytes).
3138 void order(int flags = 0);
3143 Order the steps in the transactions so that dependent packages are updated
3144 before packages that depend on them. For rpm, you can also use rpmlib's
3145 ordering functionality, debian's dpkg does not provide a way to order a
3148 === ACTIVE/PASSIVE VIEW ===
3150 Active view lists what new packages get installed, while passive view shows
3151 what happens to the installed packages. Most often there's not much
3152 difference between the two modes, but things get interesting if multiple
3153 packages get replaced by one new package. Say you have installed packages
3154 A-1-1 and B-1-1, and now install A-2-1 which has a new dependency that
3155 obsoletes B. The transaction elements will be
3157 updated A-1-1 (other: A-2-1)
3158 obsoleted B-1-1 (other: A-2-1)
3160 in passive mode, but
3162 update A-2-1 (other: A-1-1)
3165 in active mode. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the
3166 passive mode list will be unchanged but the active mode list will just
3169 The Transactionclass Class
3170 --------------------------
3171 Objects of this type are returned by the classify() Transaction method.
3175 Transaction *transaction; /* read only */
3176 $class->{transaction}
3180 Back pointer to transaction object.
3182 int type; /* read only */
3187 The type of the transaction elements in the class.
3189 int count; /* read only */
3194 The number of elements in the class.
3196 const char *fromstr;
3201 The old vendor or architecture.
3208 The new vendor or architecture.
3215 The id of the old vendor or architecture.
3222 The id of the new vendor or architecture.
3227 my @solvables = $class->solvables();
3228 solvables = class.solvables()
3229 solvables = class.solvables()
3231 Return the solvables for all transaction elements in the class.
3235 Checksums (also called hashes) are used to make sure that downloaded data is
3236 not corrupt and also as a fingerprint mechanism to check if data has changed.
3238 === CLASS METHODS ===
3240 Chksum Chksum(Id type)
3241 my $chksum = solv::Chksum->new($type);
3242 chksum = solv.Chksum(type)
3243 chksum = Solv::Chksum.new(type)
3245 Create a checksum object. Currently the following types are supported:
3251 These keys are constants in the *solv* class.
3253 Chksum Chksum(Id type, const char *hex)
3254 my $chksum = solv::Chksum->new($type, $hex);
3255 chksum = solv.Chksum(type, hex)
3256 chksum = Solv::Chksum.new(type, hex)
3258 Create an already finalized checksum object from a hex string.
3260 Chksum Chksum_from_bin(Id type, char *bin)
3261 my $chksum = solv::Chksum->from_bin($type, $bin);
3262 chksum = solv.Chksum.from_bin(type, bin)
3263 chksum = Solv::Chksum.from_bin(type, bin)
3265 Create an already finalized checksum object from a binary checksum.
3269 Id type; /* read only */
3274 Return the type of the checksum object.
3278 void add(const char *str)
3283 Add a (binary) string to the checksum.
3285 void add_fp(FILE *fp)
3286 $chksum->add_fp($file);
3290 Add the contents of a file to the checksum.
3292 void add_stat(const char *filename)
3293 $chksum->add_stat($filename);
3294 chksum.add_stat(filename)
3295 chksum.add_stat(filename)
3297 Stat the file and add the dev/ino/size/mtime member to the checksum. If the
3298 stat fails, the members are zeroed.
3300 void add_fstat(int fd)
3301 $chksum->add_fstat($fd);
3302 chksum.add_fstat(fd)
3303 chksum.add_fstat(fd)
3305 Same as add_stat, but instead of the filename a file descriptor is used.
3307 unsigned char *raw()
3308 my $raw = $chksum->raw();
3312 Finalize the checksum and return the result as raw bytes. This means that the
3313 result can contain NUL bytes or unprintable characters.
3316 my $raw = $chksum->hex();
3320 Finalize the checksum and return the result as hex string.
3322 const char *typestr()
3323 my $typestr = $chksum->typestr();
3324 typestr = chksum.typestr
3325 typestr = chksum.typestr
3327 Return the type of the checksum as a string, e.g. "sha256".
3330 if ($chksum1 == $chksum2)
3331 if chksum1 == chksum2:
3332 if chksum1 == chksum2
3334 Checksums are equal if they are of the same type and the finalized results are
3338 my $str = $chksum->str;
3342 If the checksum is finished, the checksum is returned as "<type>:<hex>" string.
3343 Otherwise "<type>:unfinished" is returned.
3348 This functions were added because libsolv uses standard *FILE* pointers to
3349 read/write files, but languages like perl have their own implementation of
3350 files. The libsolv functions also support decompression and compression, the
3351 algorithm is selected by looking at the file name extension.
3353 FILE *xfopen(char *fn, char *mode = "r")
3354 my $file = solv::xfopen($path);
3355 file = solv.xfopen(path)
3356 file = Solv::xfopen(path)
3358 Open a file at the specified path. The `mode` argument is passed on to the
3361 FILE *xfopen_fd(char *fn, int fileno)
3362 my $file = solv::xfopen_fd($path, $fileno);
3363 file = solv.xfopen_fd(path, fileno)
3364 file = Solv::xfopen_fd(path, fileno)
3366 Create a file handle from the specified file descriptor. The path argument is
3367 only used to select the correct (de-)compression algorithm, use an empty path
3368 if you want to make sure to read/write raw data. The file descriptor is dup()ed
3369 before the file handle is created.
3374 my $fileno = $file->fileno();
3375 fileno = file.fileno()
3376 fileno = file.fileno()
3378 Return file file descriptor of the file. If the file is not open, `-1` is
3381 void cloexec(bool state)
3382 $file->cloexec($state)
3386 Set the close-on-exec flag of the file descriptor. The xfopen function
3387 returns files with close-on-exec turned on, so if you want to pass
3388 a file to some other process you need to call cloexec(0) before calling
3392 my $fileno = $file->dup();
3396 Return a copy of the descriptor of the file. If the file is not open, `-1` is
3404 Flush the file. Returns false if there was an error. Flushing a closed file
3405 always returns true.
3412 Close the file. This is needed for languages like Ruby that do not destruct
3413 objects right after they are no longer referenced. In that case, it is good
3414 style to close open files so that the file descriptors are freed right away.
3415 Returns false if there was an error.
3420 The Repodata stores attributes for packages and the repository itself, each
3421 repository can have multiple repodata areas. You normally only need to
3422 directly access them if you implement lazy downloading of repository data.
3423 Repodata areas are created by calling the repository's add_repodata() method
3424 or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING
3429 Repo *repo; /* read only */
3434 Back pointer to repository object.
3436 Id id; /* read only */
3441 The id of the repodata area. Repodata ids of different repositories overlap.
3446 $data->internalize();
3450 Internalize newly added data. The lookup functions will only see the new data
3451 after it has been internalized.
3453 bool write(FILE *fp);
3458 Write the contents of the repodata area as solv file.
3460 Id str2dir(const char *dir, bool create = 1)
3461 my $did = data->str2dir($dir);
3462 did = data.str2dir(dir)
3463 did = data.str2dir(dir)
3465 const char *dir2str(Id did, const char *suffix = 0)
3466 $dir = pool->dir2str($did);
3467 dir = pool.dir2str(did)
3468 dir = pool.dir2str(did)
3470 Convert a string (directory) into an Id and back. If the string is currently not in the
3471 pool and _create_ is false, zero is returned.
3473 void add_dirstr(Id solvid, Id keyname, Id dir, const char *str)
3474 $data->add_dirstr($solvid, $keyname, $dir, $string)
3475 data.add_dirstr(solvid, keyname, dir, string)
3476 data.add_dirstr(solvid, keyname, dir, string)
3478 Add a file path consisting of a dirname Id and a basename string.
3480 bool add_solv(FILE *fp, int flags = 0);
3481 $data->add_solv($fp);
3485 Replace a stub repodata object with the data from a solv file. This method
3486 automatically adds the REPO_USE_LOADING flag. It should only be used from
3489 void create_stubs();
3490 $data->create_stubs()
3494 Create stub repodatas from the information stored in the repodata meta
3497 void extend_to_repo();
3498 $data->extend_to_repo();
3499 data.extend_to_repo()
3500 data.extend_to_repo()
3502 Extend the repodata so that it has the same size as the repo it belongs to.
3503 This method is needed when setting up a new extension repodata so that it
3504 matches the repository size. It is also needed when switching to a just written
3505 repodata extension to make the repodata match the written extension (which is
3506 always of the size of the repo).
3509 if ($data1 == $data2)
3513 Two repodata objects are equal if they belong to the same repository and have
3516 === DATA RETRIEVAL METHODS ===
3518 const char *lookup_str(Id solvid, Id keyname)
3519 my $string = $data->lookup_str($solvid, $keyname);
3520 string = data.lookup_str(solvid, keyname)
3521 string = data.lookup_str(solvid, keyname)
3523 Id *lookup_idarray(Id solvid, Id keyname)
3524 my @ids = $data->lookup_idarray($solvid, $keyname);
3525 ids = data.lookup_idarray(solvid, keyname)
3526 ids = data.lookup_idarray(solvid, keyname)
3528 Chksum lookup_checksum(Id solvid, Id keyname)
3529 my $chksum = $data->lookup_checksum($solvid, $keyname);
3530 chksum = data.lookup_checksum(solvid, keyname)
3531 chksum = data.lookup_checksum(solvid, keyname)
3533 Lookup functions. Return the data element stored in the specified solvable.
3534 The methods probably only make sense to retrieve data from the special
3535 SOLVID_META solvid that stores repodata meta information.
3537 === DATA STORAGE METHODS ===
3539 void set_id(Id solvid, Id keyname, DepId id);
3540 $data->set_id($solvid, $keyname, $id);
3541 data.set_id(solvid, keyname, id)
3542 data.set_id(solvid, keyname, id)
3544 void set_str(Id solvid, Id keyname, const char *str);
3545 $data->set_str($solvid, $keyname, $str);
3546 data.set_str(solvid, keyname, str)
3547 data.set_str(solvid, keyname, str)
3549 void set_poolstr(Id solvid, Id keyname, const char *str);
3550 $data->set_poolstr($solvid, $keyname, $str);
3551 data.set_poolstr(solvid, keyname, str)
3552 data.set_poolstr(solvid, keyname, str)
3554 void set_checksum(Id solvid, Id keyname, Chksum *chksum);
3555 $data->set_checksum($solvid, $keyname, $chksum);
3556 data.set_checksum(solvid, keyname, chksum)
3557 data.set_checksum(solvid, keyname, chksum)
3559 void set_sourcepkg(Id solvid, const char *sourcepkg);
3560 $data.set_sourcepkg($solvid, $sourcepkg);
3561 data.set_sourcepkg(solvid, sourcepkg)
3562 data.set_sourcepkg(solvid, sourcepkg)
3564 void add_idarray(Id solvid, Id keyname, DepId id);
3565 $data->add_idarray($solvid, $keyname, $id);
3566 data.add_idarray(solvid, keyname, id)
3567 data.add_idarray(solvid, keyname, id)
3570 my $handle = $data->new_handle();
3571 handle = data.new_handle()
3572 handle = data.new_handle()
3574 void add_flexarray(Id solvid, Id keyname, Id handle);
3575 $data->add_flexarray($solvid, $keyname, $handle);
3576 data.add_flexarray(solvid, keyname, handle)
3577 data.add_flexarray(solvid, keyname, handle)
3579 Data storage methods. Probably only useful to store data in the special
3580 SOLVID_META solvid that stores repodata meta information. Note that
3581 repodata areas can have their own Id pool (see the REPO_LOCALPOOL flag),
3582 so be careful if you need to store ids. Arrays are created by calling
3583 the add function for every element. A flexarray is an array of
3584 sub-structures, call new_handle to create a new structure, use the
3585 handle as solvid to fill the structure with data and call add_flexarray
3586 to put the structure in an array.
3591 Datapos objects describe a specific position in the repository data area.
3592 Thus they are only valid until the repository is modified in some way.
3593 Datapos objects can be created by the pos() and parentpos() methods of
3594 a Datamatch object or by accessing the ``meta'' attribute of a repository.
3598 Repo *repo; /* read only */
3603 Back pointer to repository object.
3607 Dataiterator(Id keyname, const char *match, int flags)
3608 my $di = $datapos->Dataiterator($keyname, $match, $flags);
3609 di = datapos.Dataiterator(keyname, match, flags)
3610 di = datapos.Dataiterator(keyname, match, flags)
3612 Create a Dataiterator at the position of the datapos object.
3614 const char *lookup_deltalocation(unsigned int *OUTPUT);
3615 my ($location, $medianr) = $datapos->lookup_deltalocation();
3616 location, medianr = datapos.lookup_deltalocation()
3617 location, medianr = datapos.lookup_deltalocation()
3619 Return a tuple containing the on-media location and an optional media number
3620 for a delta rpm. This obviously only works if the data position points to
3621 structure describing a delta rpm.
3623 const char *lookup_deltaseq();
3624 my $seq = $datapos->lookup_deltaseq();
3625 seq = datapos.lookup_deltaseq();
3626 seq = datapos.lookup_deltaseq();
3628 Return the delta rpm sequence from the structure describing a delta rpm.
3630 === DATA RETRIEVAL METHODS ===
3632 const char *lookup_str(Id keyname)
3633 my $string = $datapos->lookup_str($keyname);
3634 string = datapos.lookup_str(keyname)
3635 string = datapos.lookup_str(keyname)
3637 Id lookup_id(Id solvid, Id keyname)
3638 my $id = $datapos->lookup_id($keyname);
3639 id = datapos.lookup_id(keyname)
3640 id = datapos.lookup_id(keyname)
3642 unsigned long long lookup_num(Id keyname, unsigned long long notfound = 0)
3643 my $num = $datapos->lookup_num($keyname);
3644 num = datapos.lookup_num(keyname)
3645 num = datapos.lookup_num(keyname)
3647 bool lookup_void(Id keyname)
3648 my $bool = $datapos->lookup_void($keyname);
3649 bool = datapos.lookup_void(keyname)
3650 bool = datapos.lookup_void(keyname)
3652 Id *lookup_idarray(Id keyname)
3653 my @ids = $datapos->lookup_idarray($keyname);
3654 ids = datapos.lookup_idarray(keyname)
3655 ids = datapos.lookup_idarray(keyname)
3657 Chksum lookup_checksum(Id keyname)
3658 my $chksum = $datapos->lookup_checksum($keyname);
3659 chksum = datapos.lookup_checksum(keyname)
3660 chksum = datapos.lookup_checksum(keyname)
3662 Lookup functions. Note that the returned Ids are always translated into
3663 the Ids of the global pool even if the repodata area contains its own pool.
3665 Dataiterator Dataiterator(Id keyname, const char *match = 0, int flags = 0)
3666 my $di = $datapos->Dataiterator($keyname, $match, $flags);
3667 di = datapos.Dataiterator(keyname, match, flags)
3668 di = datapos.Dataiterator(keyname, match, flags)
3674 Iterate over the matching data elements. See the Dataiterator class for more
3679 Michael Schroeder <mls@suse.de>
3682 vim: syntax=asciidoc