2 .\" Title: Libsolv-Bindings
3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets v1.78.0 <http://docbook.sf.net/>
10 .TH "LIBSOLV\-BINDINGS" "3" "09/24/2013" "libsolv" "LIBSOLV"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 libsolv-bindings \- access libsolv from perl/python/ruby
34 Libsolv\(cqs language bindings offer an abstract, object orientated interface to the library\&. The supported languages are currently perl, python, and ruby\&. All example code (except in the specifics sections, of course) lists first the \(lqC\-ish\(rq interface, then the syntax for perl, python, and ruby (in that order)\&.
37 Libsolv\(cqs perl bindings can be loaded with the following statement:
49 Objects are either created by calling the new() method on a class or they are returned by calling methods on other objects\&.
55 my \fI$pool\fR \fB= solv::Pool\->new()\fR;
56 my \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->add_repo("my_first_repo")\fR;
62 Swig encapsulates all objects as tied hashes, thus the attributes can be accessed by treating the object as standard hash reference:
68 \fI$pool\fR\fB\->{appdata} = 42\fR;
69 \fBprintf "appdata is %d\en",\fR \fI$pool\fR\fB\->{appdata}\fR;
75 A special exception to this are iterator objects, they are encapsulated as tied arrays so that it is possible to iterate with a for() statement:
81 my \fI$iter\fR \fB=\fR \fI$pool\fR\fB\->solvables_iter()\fR;
82 \fBfor my\fR \fI$solvable\fR \fB(\fR\fI@$iter\fR\fB) { \&.\&.\&. }\fR;
88 As a downside of this approach, iterator objects cannot have attributes\&.
90 If an array needs to be passed to a method it is usually done by reference, if a method returns an array it returns it on the stack:
96 my \fI@problems\fR \fB=\fR \fI$solver\fR\fB\->solve(\e\fR\fI@jobs\fR\fB)\fR;
102 Due to a bug in swig, stringification does not work for libsolv\(cqs objects\&. Instead, you have to call the object\(cqs str() method\&.
108 \fBprint\fR \fI$dep\fR\fB\->str() \&. "\e\fR\fIn\fR\fB"\fR;
114 Swig implements all constants as numeric variables (instead of the more natural constant subs), so don\(cqt forget the leading \(lq$\(rq when accessing a constant\&. Also do not forget to prepend the namespace of the constant:
120 \fI$pool\fR\fB\->set_flag($solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR;
125 .SH "PYTHON SPECIFICS"
127 The python bindings can be loaded with:
139 Objects are either created by calling the constructor method for a class or they are returned by calling methods on other objects\&.
145 \fIpool\fR \fB= solv\&.Pool()\fR
146 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo("my_first_repo")\fR
152 Attributes can be accessed as usual:
158 \fIpool\fR\fB\&.appdata = 42\fR
159 \fBprint "appdata is %d" % (\fR\fIpool\fR\fB\&.appdata)\fR
165 Iterators also work as expected:
171 \fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter():\fR
177 Arrays are passed and returned as list objects:
183 \fIjobs\fR \fB= []\fR
184 \fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR
190 The bindings define stringification for many classes, some also have a \fIrepr\fR method to ease debugging\&.
196 \fBprint\fR \fIdep\fR
197 \fBprint repr(\fR\fIrepo\fR\fB)\fR
203 Constants are attributes of the classes:
209 \fIpool\fR\fB\&.set_flag(solv\&.Pool\&.POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR;
216 The ruby bindings can be loaded with:
222 \fBrequire \*(Aqsolv\*(Aq\fR
228 Objects are either created by calling the new method on a class or they are returned by calling methods on other objects\&. Note that all classes start with an uppercase letter in ruby, so the class is called \(lqSolv\(rq\&.
234 \fIpool\fR \fB= Solv::Pool\&.new\fR
235 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo("my_first_repo")\fR
241 Attributes can be accessed as usual:
247 \fIpool\fR\fB\&.appdata = 42\fR
248 \fBputs "appdata is #{\fR\fIpool\fR\fB\&.appdata}"\fR
254 Iterators also work as expected:
260 \fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter() do \&.\&.\&.\fR
266 Arrays are passed and returned as array objects:
272 \fIjobs\fR \fB= []\fR
273 \fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR
279 Most classes define a to_s method, so objects can be easily stringified\&. Many also define an inspect() method\&.
286 \fBputs\fR \fIrepo\fR\fB\&.inspect\fR
292 Constants live in the namespace of the class they belong to:
298 \fIpool\fR\fB\&.set_flag(Solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR;
304 Note that boolean methods have an added trailing \(lq?\(rq, to be consistent with other ruby modules:
310 \fBputs "empty\fR \fIrepo\fR\fB" if\fR \fIrepo\fR\fB\&.isempty?\fR
317 This is the main namespace of the library, you cannot create objects of this type but it contains some useful constants\&.
320 Relational flag constants, the first three can be or\-ed together
324 the \(lqless than\(rq bit
329 the \(lqequals to\(rq bit
334 the \(lqgreater then\(rq bit
339 used for relations that describe an extra architecture filter, the version part of the relation is interpreted as architecture\&.
346 Access the meta section of a repository or repodata area\&. This is like an extra Solvable that has the Id SOLVID_META\&.
351 Use the data position stored inside of the pool instead of accessing some solvable by Id\&. The bindings have the Datapos objects as an abstraction mechanism, so you do not need this constant\&.
363 Always one, describes the empty string
368 The keyname Id of the name of the solvable\&.
373 see the libsolv\-constantids manpage for a list of fixed Ids\&.
377 The pool is libsolv\(cqs central resource manager\&. A pool consists of Solvables, Repositories, Dependencies, each indexed by Ids\&.
385 my \fI$pool\fR \fB= solv::Pool\->new()\fR;
386 \fIpool\fR \fB= solv\&.Pool()\fR
387 \fIpool\fR \fB= Solv::Pool\&.new()\fR
393 Create a new pool instance\&. In most cases you just need one pool\&.
400 \fBvoid *appdata;\fR /* read/write */
401 \fI$pool\fR\fB\->{appdata}\fR
402 \fIpool\fR\fB\&.appdata\fR
403 \fIpool\fR\fB\&.appdata\fR
409 Application specific data that may be used in any way by the code using the pool\&.
415 \fBSolvable solvables[];\fR /* read only */
416 my \fI$solvable\fR \fB=\fR \fI$pool\fR\fB\->{solvables}\->[\fR\fI$solvid\fR\fB]\fR;
417 \fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.solvables[\fR\fIsolvid\fR\fB]\fR
418 \fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.solvables[\fR\fIsolvid\fR\fB]\fR
424 Look up a Solvable by its id\&.
430 \fBRepo repos[];\fR /* read only */
431 my \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->{repos}\->[\fR\fI$repoid\fR\fB]\fR;
432 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.repos[\fR\fIrepoid\fR\fB]\fR
433 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.repos[\fR\fIrepoid\fR\fB]\fR
439 Look up a Repository by its id\&.
445 \fBRepo *installed;\fR /* read/write */
446 \fI$pool\fR\fB\->{installed} =\fR \fI$repo\fR;
447 \fIpool\fR\fB\&.installed =\fR \fIrepo\fR
448 \fIpool\fR\fB\&.installed =\fR \fIrepo\fR
454 Define which repository contains all the installed packages\&.
460 \fBconst char *errstr;\fR /* read only */
461 my \fI$err\fR \fB=\fR \fI$pool\fR\fB\->{errstr}\fR;
462 \fIerr\fR \fB=\fR \fIpool\fR\fB\&.errstr\fR
463 \fIerr\fR \fB=\fR \fIpool\fR\fB\&.errstr\fR
469 Return the last error string that was stored in the pool\&.
472 \fBPOOL_FLAG_PROMOTEEPOCH\fR
474 Promote the epoch of the providing dependency to the requesting dependency if it does not contain an epoch\&. Used at some time in old rpm versions, modern systems should never need this\&.
477 \fBPOOL_FLAG_FORBIDSELFCONFLICTS\fR
479 Disallow the installation of packages that conflict with themselves\&. Debian always allows self\-conflicting packages, rpm used to forbid them but switched to also allowing them recently\&.
482 \fBPOOL_FLAG_OBSOLETEUSESPROVIDES\fR
484 Make obsolete type dependency match against provides instead of just the name and version of packages\&. Very old versions of rpm used the name/version, then it got switched to provides and later switched back again to just name/version\&.
487 \fBPOOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES\fR
489 An implicit obsoletes is the internal mechanism to remove the old package on an update\&. The default is to remove all packages with the same name, rpm\-5 switched to also removing packages providing the same name\&.
492 \fBPOOL_FLAG_OBSOLETEUSESCOLORS\fR
494 Rpm\(cqs multilib implementation (used in RedHat and Fedora) distinguishes between 32bit and 64bit packages (the terminology is that they have a different color)\&. If obsoleteusescolors is set, packages with different colors will not obsolete each other\&.
497 \fBPOOL_FLAG_IMPLICITOBSOLETEUSESCOLORS\fR
499 Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if packages of the same name can be installed in parallel\&. For current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true (this is the default if FEDORA is defined when libsolv is compiled)\&.
502 \fBPOOL_FLAG_NOINSTALLEDOBSOLETES\fR
504 New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you also erase the other package\&.
507 \fBPOOL_FLAG_HAVEDISTEPOCH\fR
509 Mandriva added a new field called distepoch that gets checked in version comparison if the epoch/version/release of two packages are the same\&.
512 \fBPOOL_FLAG_NOOBSOLETESMULTIVERSION\fR
514 If a package is installed in multiversionmode, rpm used to ignore both the implicit obsoletes and the obsolete dependency of a package\&. This was changed to ignoring just the implicit obsoletes, thus you may install multiple versions of the same name, but obsoleted packages still get removed\&.
517 \fBPOOL_FLAG_ADDFILEPROVIDESFILTERED\fR
519 Make the addfileprovides method only add files from the standard locations (i\&.e\&. the \(lqbin\(rq and \(lqetc\(rq directories)\&. This is useful if you have only few packages that use non\-standard file dependencies, but you still wand the fast speed that addfileprovides() generates\&.
528 \fI$pool\fR\fB\->free()\fR;
529 \fIpool\fR\fB\&.free()\fR
530 \fIpool\fR\fB\&.free()\fR
536 Free a pool\&. This is currently done with a method instead of relying on reference counting or garbage collection because it\(cqs hard to track every reference to a pool\&.
542 \fBvoid setdebuglevel(int\fR \fIlevel\fR\fB)\fR
543 \fI$pool\fR\fB\->setdebuglevel(\fR\fI$level\fR\fB)\fR;
544 \fIpool\fR\fB\&.setdebuglevel(\fR\fIlevel\fR\fB)\fR
545 \fIpool\fR\fB\&.setdebuglevel(\fR\fIlevel\fR\fB)\fR
551 Set the debug level\&. A value of zero means no debug output, the higher the value, the more output is generated\&.
557 \fBint set_flag(int\fR \fIflag\fR\fB, int\fR \fIvalue\fR\fB)\fR
558 my \fI$oldvalue\fR \fB=\fR \fI$pool\fR\fB\->set_flag(\fR\fI$flag\fR\fB,\fR \fI$value\fR\fB)\fR;
559 \fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR
560 \fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR
570 \fBint get_flag(int\fR \fIflag\fR\fB)\fR
571 my \fI$value\fR \fB=\fR \fI$pool\fR\fB\->get_flag(\fR\fI$flag\fR\fB)\fR;
572 \fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR
573 \fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR
579 Set/get a pool specific flag\&. The flags define how the system works, e\&.g\&. how the package manager treats obsoletes\&. The default flags should be sane for most applications, but in some cases you may want to tweak a flag, for example if you want to solv package dependencies for some other system than yours\&.
585 \fBvoid set_rootdir(const char *\fR\fIrootdir\fR\fB)\fR
586 \fI$pool\fR\fB\->set_rootdir(\fR\fIrootdir\fR\fB)\fR;
587 \fIpool\fR\fB\&.set_rootdir(\fR\fIrootdir\fR\fB)\fR
588 \fIpool\fR\fB\&.set_rootdir(\fR\fIrootdir\fR\fB)\fR
598 \fBconst char *get_rootdir()\fR
599 my \fI$rootdir\fR \fB=\fR \fI$pool\fR\fB\->get_rootdir()\fR;
600 \fIrootdir\fR \fB=\fR \fIpool\fR\fB\&.get_rootdir()\fR
601 \fIrootdir\fR \fB=\fR \fIpool\fR\fB\&.get_rootdir()\fR
607 Set/get the rootdir to use\&. This is useful if you want package management to work only in some directory, for example if you want to setup a chroot jail\&. Note that the rootdir will only be prepended to file paths if the \fBREPO_USE_ROOTDIR\fR flag is used\&.
613 \fBvoid setarch(const char *\fR\fIarch\fR \fB= 0)\fR
614 \fI$pool\fR\fB\->setarch()\fR;
615 \fIpool\fR\fB\&.setarch()\fR
616 \fIpool\fR\fB\&.setarch()\fR
622 Set the architecture for your system\&. The architecture is used to determine which packages are installable\&. It defaults to the result of \(lquname \-m\(rq\&.
628 \fBRepo add_repo(const char *\fR\fIname\fR\fB)\fR
629 \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->add_repo(\fR\fI$name\fR\fB)\fR;
630 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo(\fR\fIname\fR\fB)\fR
631 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo(\fR\fIname\fR\fB)\fR
637 Add a Repository with the specified name to the pool\&. The repository is empty on creation, use the repository methods to populate it with packages\&.
643 \fBRepoiterator repos_iter()\fR
644 \fBfor my\fR \fI$repo\fR \fB(\fR\fI@\fR\fB{\fR\fI$pool\fR\fB\->repos_iter()})\fR
645 \fBfor\fR \fIrepo\fR \fBin\fR \fIpool\fR\fB\&.repos_iter():\fR
646 \fBfor\fR \fIrepo\fR \fBin\fR \fIpool\fR\fB\&.repos_iter()\fR
652 Iterate over the existing repositories\&.
658 \fBSolvableiterator solvables_iter()\fR
659 \fBfor my\fR \fI$solvable\fR \fB(\fR\fI@\fR\fB{\fR\fI$pool\fR\fB\->solvables_iter()})\fR
660 \fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter():\fR
661 \fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter()\fR
667 Iterate over the existing solvables\&.
673 \fBDep Dep(const char *\fR\fIstr\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
674 my \fI$dep\fR \fB=\fR \fI$pool\fR\fB\->Dep(\fR\fI$string\fR\fB)\fR;
675 \fIdep\fR \fB=\fR \fIpool\fR\fB\&.Dep(\fR\fIstring\fR\fB)\fR
676 \fIdep\fR \fB=\fR \fIpool\fR\fB\&.Dep(\fR\fIstring\fR\fB)\fR
682 Create an object describing a string or dependency\&. If the string is currently not in the pool and \fIcreate\fR is false, \fBundef\fR/\fBNone\fR/\fBnil\fR is returned\&.
688 \fBvoid addfileprovides()\fR
689 \fI$pool\fR\fB\->addfileprovides()\fR;
690 \fIpool\fR\fB\&.addfileprovides()\fR
691 \fIpool\fR\fB\&.addfileprovides()\fR
701 \fBId *addfileprovides_queue()\fR
702 my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->addfileprovides_queue()\fR;
703 \fIids\fR \fB=\fR \fIpool\fR\fB\&.addfileprovides_queue()\fR
704 \fIids\fR \fB=\fR \fIpool\fR\fB\&.addfileprovides_queue()\fR
710 Some package managers like rpm allow dependencies on files contained in other packages\&. To allow libsolv to deal with those dependencies in an efficient way, you need to call the addfileprovides method after creating and reading all repositories\&. This method will scan all dependency for file names and than scan all packages for matching files\&. If a filename has been matched, it will be added to the provides list of the corresponding package\&. The addfileprovides_queue variant works the same way but returns an array containing all file dependencies\&. This information can be stored in the meta section of the repositories to speed up the next time the repository is loaded and addfileprovides is called\&.
716 \fBvoid createwhatprovides()\fR
717 \fI$pool\fR\fB\->createwhatprovides()\fR;
718 \fIpool\fR\fB\&.createwhatprovides()\fR
719 \fIpool\fR\fB\&.createwhatprovides()\fR
725 Create the internal \(lqwhatprovides\(rq hash over all of the provides of all packages\&. This method must be called before doing any lookups on provides\&. It\(cqs encouraged to do it right after all repos are set up, usually right after the call to addfileprovides()\&.
731 \fBSolvable *whatprovides(DepId\fR \fIdep\fR\fB)\fR
732 my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->whatprovides(\fR\fI$dep\fR\fB)\fR;
733 \fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatprovides(\fR\fIdep\fR\fB)\fR
734 \fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatprovides(\fR\fIdep\fR\fB)\fR
740 Return all solvables that provide the specified dependency\&. You can use either a Dep object or an simple Id as argument\&.
746 \fBId *matchprovidingids(const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR
747 my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->matchprovidingids(\fR\fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR;
748 \fIids\fR \fB=\fR \fIpool\fR\fB\&.matchprovidingids(\fR\fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
749 \fIids\fR \fB=\fR \fIpool\fR\fB\&.matchprovidingids(\fR\fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
755 Search the names of all provides and return the ones matching the specified string\&. See the Dataiterator class for the allowed flags\&.
761 \fBId towhatprovides(Id *\fR\fIids\fR\fB)\fR
762 my \fI$offset\fR \fB=\fR \fI$pool\fR\fB\->towhatprovides(\e\fR\fI@ids\fR\fB)\fR;
763 \fIoffset\fR \fB=\fR \fIpool\fR\fB\&.towhatprovides(\fR\fIids\fR\fB)\fR
764 \fIoffset\fR \fB=\fR \fIpool\fR\fB\&.towhatprovides(\fR\fIids\fR\fB)\fR
770 \(lqInternalize\(rq an array containing Ids\&. The returned value can be used to create solver jobs working on a specific set of packages\&. See the Solver class for more information\&.
776 \fBbool isknownarch(DepId\fR \fIid\fR\fB)\fR
777 my \fI$bool\fR \fB=\fR \fI$pool\fR\fB\->isknownarch(\fR\fI$id\fR\fB)\fR;
778 \fIbool\fR \fB=\fR \fIpool\fR\fB\&.isknownarch(\fR\fIid\fR\fB)\fR
779 \fIbool\fR \fB=\fR \fIpool\fR\fB\&.isknownarch?(\fR\fIid\fR\fB)\fR
785 Return true if the specified Id describes a known architecture\&.
791 \fBSolver Solver()\fR
792 my \fI$solver\fR \fB=\fR \fI$pool\fR\fB\->Solver()\fR;
793 \fIsolver\fR \fB=\fR \fIpool\fR\fB\&.Solver()\fR
794 \fIsolver\fR \fB=\fR \fIpool\fR\fB\&.Solver()\fR
800 Create a new solver object\&.
806 \fBJob Job(int\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR
807 my \fI$job\fR \fB=\fR \fI$pool\fR\fB\->Job(\fR\fI$how\fR\fB,\fR \fI$what\fR\fB)\fR;
808 \fIjob\fR \fB=\fR \fIpool\fR\fB\&.Job(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR
809 \fIjob\fR \fB=\fR \fIpool\fR\fB\&.Job(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR
815 Create a new Job object\&. Kind of low level, in most cases you would use a Selection or Dep job constructor instead\&.
821 \fBSelection Selection()\fR
822 my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->Selection()\fR;
823 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection()\fR
824 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection()\fR
830 Create an empty selection\&. Useful as a starting point for merging other selections\&.
836 \fBSelection Selection_all()\fR
837 my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->Selection_all()\fR;
838 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection_all()\fR
839 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection_all()\fR
845 Create a selection containing all packages\&. Useful as starting point for intersecting other selections or for update/distupgrade jobs\&.
851 \fBSelection select(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR\fB)\fR
852 my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->select(\fR\fI$name\fR\fB,\fR \fI$flags\fR\fB)\fR;
853 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR
854 \fIsel\fR \fB=\fR \fIpool\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR
860 Create a selection by matching packages against the specified string\&. See the Selection class for a list of flags and how to create solver jobs from a selection\&.
866 \fBvoid setpooljobs(Jobs *\fR\fIjobs\fR\fB)\fR
867 \fI$pool\fR\fB\->setpooljobs(\e\fR\fI@jobs\fR\fB)\fR;
868 \fIpool\fR\fB\&.setpooljobs(\fR\fIjobs\fR\fB)\fR
869 \fIpool\fR\fB\&.setpooljobs(\fR\fIjobs\fR\fB)\fR
879 \fBJob *getpooljobs()\fR
880 \fI@jobs\fR \fB=\fR \fI$pool\fR\fB\->getpooljobs()\fR;
881 \fIjobs\fR \fB=\fR \fIpool\fR\fB\&.getpooljobs()\fR
882 \fIjobs\fR \fB=\fR \fIpool\fR\fB\&.getpooljobs()\fR
888 Get/Set fixed jobs stored in the pool\&. Those jobs are automatically appended to all solver jobs, they are meant for fixed configurations like which packages can be multiversion installed, which packages were userinstalled or must not be erased\&.
894 \fBvoid set_loadcallback(Callable *\fR\fIcallback\fR\fB)\fR
895 \fI$pool\fR\fB\->setloadcallback(\e\fR\fI&callbackfunction\fR\fB)\fR;
896 \fIpool\fR\fB\&.setloadcallback(\fR\fIcallbackfunction\fR\fB)\fR
897 \fIpool\fR\fB\&.setloadcallback { |\fR\fIrepodata\fR\fB| \&.\&.\&. }\fR
903 Set the callback function called when repository metadata needs to be loaded on demand\&. To make use of this feature, you need to create repodata stubs that tell the library which data is available but not loaded\&. If later on the data needs to be accessed, the callback function is called with a repodata argument\&. You can then load the data (maybe fetching it first from an remote server)\&. The callback should return true if the data has been made available\&.
904 .SS "DATA RETRIEVAL METHODS"
906 In the following functions, the \fIkeyname\fR argument describes what to retrieve\&. For the standard cases you can use the available Id constants\&. For example,
912 \fB$solv::SOLVABLE_SUMMARY\fR
913 \fBsolv\&.SOLVABLE_SUMMARY\fR
914 \fBSolv::SOLVABLE_SUMMARY\fR
920 selects the \(lqSummary\(rq entry of a solvable\&. The \fIsolvid\fR argument selects the desired solvable by Id\&.
926 \fBconst char *lookup_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
927 my \fI$string\fR \fB=\fR \fI$pool\fR\fB\->lookup_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
928 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
929 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
939 \fBId lookup_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
940 my \fI$id\fR \fB=\fR \fI$pool\fR\fB\->lookup_id(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
941 \fIid\fR \fB=\fR \fIpool\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
942 \fIid\fR \fB=\fR \fIpool\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
952 \fBunsigned long long lookup_num(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR
953 my \fI$num\fR \fB=\fR \fI$pool\fR\fB\->lookup_num(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
954 \fInum\fR \fB=\fR \fIpool\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
955 \fInum\fR \fB=\fR \fIpool\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
965 \fBbool lookup_void(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
966 my \fI$bool\fR \fB=\fR \fI$pool\fR\fB\->lookup_void(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
967 \fIbool\fR \fB=\fR \fIpool\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
968 \fIbool\fR \fB=\fR \fIpool\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
978 \fBId *lookup_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
979 my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->lookup_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
980 \fIids\fR \fB=\fR \fIpool\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
981 \fIids\fR \fB=\fR \fIpool\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
991 \fBChksum lookup_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
992 my \fI$chksum\fR \fB=\fR \fI$pool\fR\fB\->lookup_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
993 \fIchksum\fR \fB=\fR \fIpool\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
994 \fIchksum\fR \fB=\fR \fIpool\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
1000 Lookup functions\&. Return the data element stored in the specified solvable\&. You should probably use the methods of the Solvable class instead\&.
1006 \fBDataiterator Dataiterator(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR
1007 my \fI$di\fR \fB=\fR \fI$pool\fR\fB\->Dataiterator(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR;
1008 \fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
1009 \fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
1019 \fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR
1020 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR
1021 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR
1027 Iterate over the matching data elements\&. See the Dataiterator class for more information\&.
1030 The following methods deal with Ids, i\&.e\&. integers representing objects in the pool\&. They are considered \(lqlow level\(rq, in most cases you would not use them but instead the object orientated methods\&.
1036 \fBRepo id2repo(Id\fR \fIid\fR\fB)\fR
1037 \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->id2repo(\fR\fI$id\fR\fB)\fR;
1038 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.id2repo(\fR\fIid\fR\fB)\fR
1039 \fIrepo\fR \fB=\fR \fIpool\fR\fB\&.id2repo(\fR\fIid\fR\fB)\fR
1045 Lookup an existing Repository by id\&. You can also do this by using the \fBrepos\fR attribute\&.
1051 \fBSolvable id2solvable(Id\fR \fIid\fR\fB)\fR
1052 \fI$solvable\fR \fB=\fR \fI$pool\fR\fB\->id2solvable(\fR\fI$id\fR\fB)\fR;
1053 \fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.id2solvable(\fR\fIid\fR\fB)\fR
1054 \fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.id2solvable(\fR\fIid\fR\fB)\fR
1060 Lookup an existing Repository by id\&. You can also do this by using the \fBsolvables\fR attribute\&.
1066 \fBconst char *solvid2str(Id\fR \fIid\fR\fB)\fR
1067 my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvid2str(\fR\fI$id\fR\fB)\fR;
1068 \fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvid2str(\fR\fIid\fR\fB)\fR
1069 \fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvid2str(\fR\fIid\fR\fB)\fR
1075 Return a string describing the Solvable with the specified id\&. The string consists of the name, version, and architecture of the Solvable\&.
1081 \fBId str2id(const char *\fR\fIstr\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
1082 my \fI$id\fR \fB=\fR \fIpool\fR\fB\->str2id(\fR\fI$string\fR\fB)\fR;
1083 \fIid\fR \fB=\fR \fIpool\fR\fB\&.str2id(\fR\fIstring\fR\fB)\fR
1084 \fIid\fR \fB=\fR \fIpool\fR\fB\&.str2id(\fR\fIstring\fR\fB)\fR
1094 \fBconst char *id2str(Id\fR \fIid\fR\fB)\fR
1095 \fI$string\fR \fB=\fR \fIpool\fR\fB\->id2str(\fR\fI$id\fR\fB)\fR;
1096 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.id2str(\fR\fIid\fR\fB)\fR
1097 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.id2str(\fR\fIid\fR\fB)\fR
1103 Convert a string into an Id and back\&. If the string is currently not in the pool and \fIcreate\fR is false, zero is returned\&.
1109 \fBId rel2id(Id\fR \fIname\fR\fB, Id\fR \fIevr\fR\fB, int\fR \fIflags\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
1110 my \fI$id\fR \fB=\fR \fIpool\fR\fB\->rel2id(\fR\fI$nameid\fR\fB,\fR \fI$evrid\fR\fB,\fR \fI$flags\fR\fB)\fR;
1111 \fIid\fR \fB=\fR \fIpool\fR\fB\&.rel2id(\fR\fInameid\fR\fB,\fR \fIevrid\fR\fB,\fR \fIflags\fR\fB)\fR
1112 \fIid\fR \fB=\fR \fIpool\fR\fB\&.rel2id(\fR\fInameid\fR\fB,\fR \fIevrid\fR\fB,\fR \fIflags\fR\fB)\fR
1118 Create a \(lqrelational\(rq dependency\&. Such dependencies consist of a name part, the \fIflags\fR describing the relation, and a version part\&. The flags are:
1124 \fB$solv::REL_EQ | $solv::REL_GT | $solv::REL_LT\fR
1125 \fBsolv\&.REL_EQ | solv\&.REL_GT | solv\&.REL_LT\fR
1126 \fBSolv::REL_EQ | Solv::REL_GT | Solv::REL_LT\fR
1132 Thus, if you want a \(lq<=\(rq relation, you would use \fBREL_LT | REL_EQ\fR\&.
1138 \fBId id2langid(Id\fR \fIid\fR\fB, const char *\fR\fIlang\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
1139 my \fI$id\fR \fB=\fR \fI$pool\fR\fB\->id2langid(\fR\fI$id\fR\fB,\fR \fI$language\fR\fB)\fR;
1140 \fIid\fR \fB=\fR \fIpool\fR\fB\&.id2langid(\fR\fIid\fR\fB,\fR \fIlanguage\fR\fB)\fR
1141 \fIid\fR \fB=\fR \fIpool\fR\fB\&.id2langid(\fR\fIid\fR\fB,\fR \fIlanguage\fR\fB)\fR
1147 Create a language specific Id from some other id\&. This function simply converts the id into a string, appends a dot and the specified language to the string and converts the result back into an Id\&.
1153 \fBconst char *dep2str(Id\fR \fIid\fR\fB)\fR
1154 \fI$string\fR \fB=\fR \fIpool\fR\fB\->dep2str(\fR\fI$id\fR\fB)\fR;
1155 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.dep2str(\fR\fIid\fR\fB)\fR
1156 \fIstring\fR \fB=\fR \fIpool\fR\fB\&.dep2str(\fR\fIid\fR\fB)\fR
1162 Convert a dependency id into a string\&. If the id is just a string, this function has the same effect as id2str()\&. For relational dependencies, the result is the correct \(lqname relation evr\(rq string\&.
1163 .SH "THE DEPENDENCY CLASS"
1165 The dependency class is an object orientated way to work with strings and dependencies\&. Internally, dependencies are represented as Ids, i\&.e\&. simple numbers\&. Dependency objects can be constructed by using the Pool\(cqs Dep() method\&.
1172 \fBPool *pool;\fR /* read only */
1173 \fI$dep\fR\fB\->{pool}\fR
1174 \fIdep\fR\fB\&.pool\fR
1175 \fIdep\fR\fB\&.pool\fR
1181 Back reference to the pool this dependency belongs to\&.
1187 \fBId id;\fR /* read only */
1188 \fI$dep\fR\fB\->{id}\fR
1189 \fIdep\fR\fB\&.id\fR
1190 \fIdep\fR\fB\&.id\fR
1196 The id of this dependency\&.
1203 \fBDep Rel(int\fR \fIflags\fR\fB, DepId\fR \fIevrid\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
1204 my \fI$reldep\fR \fB=\fR \fI$dep\fR\fB\->Rel(\fR\fI$flags\fR\fB,\fR \fI$evrdep\fR\fB)\fR;
1205 \fIreldep\fR \fB=\fR \fIdep\fR\fB\&.Rel(\fR\fIflags\fR\fB,\fR \fIevrdep\fR\fB)\fR
1206 \fIreldep\fR \fB=\fR \fIdep\fR\fB\&.Rel(\fR\fIflags\fR\fB,\fR \fIevrdep\fR\fB)\fR
1212 Create a relational dependency from to string dependencies and a flags argument\&. See the pool\(cqs rel2id method for a description of the flags\&.
1218 \fBSelection Selection_name(int\fR \fIsetflags\fR \fB= 0)\fR
1219 my \fI$sel\fR \fB=\fR \fI$dep\fR\fB\->Selection_name()\fR;
1220 \fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_name()\fR
1221 \fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_name()\fR
1227 Create a Selection from a dependency\&. The selection consists of all packages that have a name equal to the dependency\&. If the dependency is of a relational type, the packages version must also fulfill the dependency\&.
1233 \fBSelection Selection_provides(int\fR \fIsetflags\fR \fB= 0)\fR
1234 my \fI$sel\fR \fB=\fR \fI$dep\fR\fB\->Selection_provides()\fR;
1235 \fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_provides()\fR
1236 \fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_provides()\fR
1242 Create a Selection from a dependency\&. The selection consists of all packages that have at least one provides matching the dependency\&.
1248 \fBconst char *str()\fR
1249 my \fI$str\fR \fB=\fR \fI$dep\fR\fB\->str()\fR;
1250 \fIstr\fR \fB=\fR \fI$dep\fR\fB\&.str()\fR
1251 \fIstr\fR \fB=\fR \fI$dep\fR\fB\&.str()\fR
1257 Return a string describing the dependency\&.
1263 \fB<stringification>\fR
1264 my \fI$str\fR \fB=\fR \fI$dep\fR\fB\->str\fR;
1265 \fIstr\fR \fB= str(\fR\fIdep\fR\fB)\fR
1266 \fIstr\fR \fB=\fR \fIdep\fR\fB\&.to_s\fR
1272 Same as calling the str() method\&.
1279 \fBif (\fR\fI$dep1\fR \fB==\fR \fI$dep2\fR\fB)\fR
1280 \fBif\fR \fIdep1\fR \fB==\fR \fIdep2\fR\fB:\fR
1281 \fBif\fR \fIdep1\fR \fB==\fR \fIdep2\fR
1287 The dependencies are equal if they are part of the same pool and have the same ids\&.
1288 .SH "THE REPOSITORY CLASS"
1290 A Repository describes a group of packages, normally coming from the same source\&. Repositories are created by the Pool\(cqs add_repo() method\&.
1297 \fBPool *pool;\fR /* read only */
1298 \fI$repo\fR\fB\->{pool}\fR
1299 \fIrepo\fR\fB\&.pool\fR
1300 \fIrepo\fR\fB\&.pool\fR
1306 Back reference to the pool this dependency belongs to\&.
1312 \fBId id;\fR /* read only */
1313 \fI$repo\fR\fB\->{id}\fR
1314 \fIrepo\fR\fB\&.id\fR
1315 \fIrepo\fR\fB\&.id\fR
1321 The id of the repository\&.
1327 \fBconst char *name;\fR /* read/write */
1328 \fI$repo\fR\fB\->{name}\fR
1329 \fIrepo\fR\fB\&.name\fR
1330 \fIrepo\fR\fB\&.name\fR
1336 The repositories name\&. To libsolv, the name is just a string with no specific meaning\&.
1342 \fBint priority;\fR /* read/write */
1343 \fI$repo\fR\fB\->{priority}\fR
1344 \fIrepo\fR\fB\&.priority\fR
1345 \fIrepo\fR\fB\&.priority\fR
1351 The priority of the repository\&. A higher number means that packages of this repository will be chosen over other repositories, even if they have a greater package version\&.
1357 \fBint subpriority;\fR /* read/write */
1358 \fI$repo\fR\fB\->{subpriority}\fR
1359 \fIrepo\fR\fB\&.subpriority\fR
1360 \fIrepo\fR\fB\&.subpriority\fR
1366 The sub\-priority of the repository\&. This value is compared when the priorities of two repositories are the same\&. It is useful to make the library prefer on\-disk repositories to remote ones\&.
1372 \fBint nsolvables;\fR /* read only */
1373 \fI$repo\fR\fB\->{nsolvables}\fR
1374 \fIrepo\fR\fB\&.nsolvables\fR
1375 \fIrepo\fR\fB\&.nsolvables\fR
1381 The number of solvables in this repository\&.
1387 \fBvoid *appdata;\fR /* read/write */
1388 \fI$repo\fR\fB\->{appdata}\fR
1389 \fIrepo\fR\fB\&.appdata\fR
1390 \fIrepo\fR\fB\&.appdata\fR
1396 Application specific data that may be used in any way by the code using the repository\&.
1402 \fBDatapos *meta;\fR /* read only */
1403 \fI$repo\fR\fB\->{meta}\fR
1404 \fIrepo\fR\fB\&.meta\fR
1405 \fIrepo\fR\fB\&.meta\fR
1411 Return a Datapos object of the repodata\(cqs metadata\&. You can use the lookup methods of the Datapos class to lookup metadata attributes, like the repository timestamp\&.
1414 \fBREPO_REUSE_REPODATA\fR
1416 Reuse the last repository data area (\(lqrepodata\(rq) instead of creating a new one\&.
1419 \fBREPO_NO_INTERNALIZE\fR
1421 Do not internalize the added repository data\&. This is useful if you plan to add more data because internalization is a costly operation\&.
1424 \fBREPO_LOCALPOOL\fR
1426 Use the repodata\(cqs pool for Id storage instead of the global pool\&. Useful if you don\(cqt want to pollute the global pool with many unneeded ids, like when storing the filelist\&.
1429 \fBREPO_USE_LOADING\fR
1431 Use the repodata that is currently being loaded instead of creating a new one\&. This only makes sense if used in a load callback\&.
1434 \fBREPO_EXTEND_SOLVABLES\fR
1436 Do not create new solvables for the new data, but match existing solvables and add the data to them\&. Repository metadata is often split into multiple parts, with one primary file describing all packages and other parts holding information that is normally not needed, like the changelog\&.
1439 \fBREPO_USE_ROOTDIR\fR
1441 Prepend the pool\(cqs rootdir to the path when doing file operations\&.
1444 \fBREPO_NO_LOCATION\fR
1446 Do not add a location element to the solvables\&. Useful if the solvables are not in the final position, so you can add the correct location later in your code\&.
1449 \fBSOLV_ADD_NO_STUBS\fR
1451 Do not create stubs for repository parts that can be downloaded on demand\&.
1454 \fBSUSETAGS_RECORD_SHARES\fR
1456 This is specific to the add_susetags() method\&. Susetags allows to refer to already read packages to save disk space\&. If this data sharing needs to work over multiple calls to add_susetags, you need to specify this flag so that the share information is made available to subsequent calls\&.
1464 \fBvoid free(bool\fR \fIreuseids\fR \fB= 0)\fR
1465 \fI$repo\fR\fB\->free()\fR;
1466 \fIrepo\fR\fB\&.free()\fR
1467 \fIrepo\fR\fB\&.free()\fR
1473 Free the repository and all solvables it contains\&. If \fIreuseids\fR is set to true, the solvable ids and the repository id may be reused by the library when added new solvables\&. Thus you should leave it false if you are not sure that somebody holds a reference\&.
1479 \fBvoid empty(bool\fR \fIreuseids\fR \fB= 0)\fR
1480 \fI$repo\fR\fB\->empty()\fR;
1481 \fIrepo\fR\fB\&.empty()\fR
1482 \fIrepo\fR\fB\&.empty()\fR
1488 Free all the solvables in a repository\&. The repository will be empty after this call\&. See the free() method for the meaning of \fIreuseids\fR\&.
1494 \fBbool isempty()\fR
1495 \fI$repo\fR\fB\->isempty()\fR
1496 \fIrepo\fR\fB\&.empty()\fR
1497 \fIrepo\fR\fB\&.empty?\fR
1503 Return true if there are no solvables in this repository\&.
1509 \fBvoid internalize()\fR
1510 \fI$repo\fR\fB\->internalize()\fR;
1511 \fIrepo\fR\fB\&.internalize()\fR
1512 \fIrepo\fR\fB\&.internalize()\fR
1518 Internalize added data\&. Data must be internalized before it is available to the lookup and data iterator functions\&.
1524 \fBbool write(FILE *\fR\fIfp\fR\fB)\fR
1525 \fI$repo\fR\fB\->write(\fR\fI$fp\fR\fB)\fR
1526 \fIrepo\fR\fB\&.write(\fR\fIfp\fR\fB)\fR
1527 \fIrepo\fR\fB\&.write(\fR\fIfp\fR\fB)\fR
1533 Write a repo as a \(lqsolv\(rq file\&. These files can be read very fast and thus are a good way to cache repository data\&. Returns false if there was some error writing the file\&.
1539 \fBSolvableiterator solvables_iter()\fR
1540 \fBfor my\fR \fI$solvable\fR \fB(\fR\fI@\fR\fB{\fR\fI$repo\fR\fB\->solvables_iter()})\fR
1541 \fBfor\fR \fIsolvable\fR \fBin\fR \fIrepo\fR\fB\&.solvables_iter():\fR
1542 \fBfor\fR \fIsolvable\fR \fBin\fR \fIrepo\fR\fB\&.solvables_iter()\fR
1548 Iterate over all solvables in a repository\&.
1554 \fBRepodata add_repodata(int\fR \fIflags\fR \fB= 0)\fR
1555 my \fI$repodata\fR \fB=\fR \fI$repo\fR\fB\->add_repodata()\fR;
1556 \fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.add_repodata()\fR
1557 \fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.add_repodata()\fR
1563 Add a new repodata area to the repository\&. This is normally automatically done by the repo_add methods, so you need this method only in very rare circumstances\&.
1569 \fBvoid create_stubs()\fR
1570 \fI$repo\fR\fB\->create_stubs()\fR;
1571 \fIrepo\fR\fB\&.create_stubs()\fR
1572 \fIrepo\fR\fB\&.create_stubs()\fR
1578 Calls the create_stubs() repodata method for the last repodata of the repository\&.
1584 \fBbool iscontiguous()\fR
1585 \fI$repo\fR\fB\->iscontiguous()\fR
1586 \fIrepo\fR\fB\&.iscontiguous()\fR
1587 \fIrepo\fR\fB\&.iscontiguous?\fR
1593 Return true if the solvables of this repository are all in a single block with no holes, i\&.e\&. they have consecutive ids\&.
1599 \fBRepodata first_repodata()\fR
1600 my \fI$repodata\fR \fB=\fR \fI$repo\fR\fB\->first_repodata()\fR;
1601 \fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.first_repodata()\fR
1602 \fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.first_repodata()\fR
1608 Checks if all repodatas but the first repodata are extensions, and return the first repodata if this is the case\&. Useful if you want to do a store/retrieve sequence on the repository to reduce the memory using and enable paging, as this does not work if the repository contains multiple non\-extension repodata areas\&.
1614 \fBSelection Selection(int\fR \fIsetflags\fR \fB= 0)\fR
1615 my \fI$sel\fR \fB=\fR \fI$repo\fR\fB\->Selection()\fR;
1616 \fIsel\fR \fB=\fR \fIrepo\fR\fB\&.Selection()\fR
1617 \fIsel\fR \fB=\fR \fIrepo\fR\fB\&.Selection()\fR
1623 Create a Selection consisting of all packages in the repository\&.
1629 \fBDataiterator Dataiterator(Id\fR \fIp\fR\fB, Id\fR \fIkey\fR\fB, const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR
1630 my \fI$di\fR \fB=\fR \fI$repo\fR\fB\->Dataiterator(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR;
1631 \fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
1632 \fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
1642 \fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR
1643 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR
1644 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR
1650 Iterate over the matching data elements in this repository\&. See the Dataiterator class for more information\&.
1656 \fB<stringification>\fR
1657 my \fI$str\fR \fB=\fR \fI$repo\fR\fB\->str\fR;
1658 \fIstr\fR \fB= str(\fR\fIrepo\fR\fB)\fR
1659 \fIstr\fR \fB=\fR \fIrepo\fR\fB\&.to_s\fR
1665 Return the name of the repository, or "Repo#<id>" if no name is set\&.
1672 \fBif (\fR\fI$repo1\fR \fB==\fR \fI$repo2\fR\fB)\fR
1673 \fBif\fR \fIrepo1\fR \fB==\fR \fIrepo2\fR\fB:\fR
1674 \fBif\fR \fIrepo1\fR \fB==\fR \fIrepo2\fR
1680 Two repositories are equal if they belong to the same pool and have the same id\&.
1681 .SS "DATA ADD METHODS"
1687 \fBSolvable add_solvable()\fR
1688 \fI$repo\fR\fB\->add_solvable()\fR;
1689 \fIrepo\fR\fB\&.add_solvable()\fR
1690 \fIrepo\fR\fB\&.add_solvable()\fR
1696 Add a single empty solvable to the repository\&. Returns a Solvable object, see the Solvable class for more information\&.
1702 \fBbool add_solv(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1703 \fI$repo\fR\fB\->add_solv(\fR\fI$name\fR\fB)\fR;
1704 \fIrepo\fR\fB\&.add_solv(\fR\fIname\fR\fB)\fR
1705 \fIrepo\fR\fB\&.add_solv(\fR\fIname\fR\fB)\fR
1715 \fBbool add_solv(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1716 \fI$repo\fR\fB\->add_solv(\fR\fI$fp\fR\fB)\fR;
1717 \fIrepo\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR
1718 \fIrepo\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR
1724 Read a \(lqsolv\(rq file and add its contents to the repository\&. These files can be written with the write() method and are normally used as fast cache for repository metadata\&.
1730 \fBbool add_rpmdb(int\fR \fIflags\fR \fB= 0)\fR
1731 \fI$repo\fR\fB\->add_rpmdb()\fR;
1732 \fIrepo\fR\fB\&.add_rpmdb()\fR
1733 \fIrepo\fR\fB\&.add_rpmdb()\fR
1743 \fBbool add_rpmdb_reffp(FILE *\fR\fIreffp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1744 \fI$repo\fR\fB\->add_rpmdb_reffp(\fR\fI$reffp\fR\fB)\fR;
1745 \fIrepo\fR\fB\&.add_rpmdb_reffp(\fR\fIreffp\fR\fB)\fR
1746 \fIrepo\fR\fB\&.add_rpmdb_reffp(\fR\fIreffp\fR\fB)\fR
1752 Add the contents of the rpm database to the repository\&. If a solv file containing an old version of the database is available, it can be passed as reffp to speed up reading\&.
1758 \fBSolvable add_rpm(const char *\fR\fIfilename\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1759 my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_rpm(\fR\fI$filename\fR\fB)\fR;
1760 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_rpm(\fR\fIfilename\fR\fB)\fR
1761 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_rpm(\fR\fIfilename\fR\fB)\fR
1767 Add the metadata of a single rpm package to the repository\&.
1773 \fBbool add_rpmdb_pubkeys(int\fR \fIflags\fR \fB= 0)\fR
1774 \fI$repo\fR\fB\->add_rpmdb_pubkeys()\fR;
1775 \fIrepo\fR\fB\&.add_rpmdb_pubkeys()\fR
1776 \fIrepo\fR\fB\&.add_rpmdb_pubkeys()\fR
1782 Add all pubkeys contained in the rpm database to the repository\&. Note that newer rpm versions also allow to store the pubkeys in some directory instead of the rpm database\&.
1788 \fBSolvable add_pubkey(const char *\fR\fIkeyfile\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1789 my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_pubkey(\fR\fI$keyfile\fR\fB)\fR;
1790 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_pubkey(\fR\fIkeyfile\fR\fB)\fR
1791 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_pubkey(\fR\fIkeyfile\fR\fB)\fR
1797 Add a pubkey from a file to the repository\&.
1803 \fBbool add_rpmmd(FILE *\fR\fIfp\fR\fB, const char *\fR\fIlanguage\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1804 \fI$repo\fR\fB\->add_rpmmd(\fR\fI$fp\fR\fB,\fR \fIundef\fR\fB)\fR;
1805 \fIrepo\fR\fB\&.add_rpmmd(\fR\fIfp\fR\fB,\fR \fINone\fR\fB)\fR
1806 \fIrepo\fR\fB\&.add_rpmmd(\fR\fIfp\fR\fB,\fR \fInil\fR\fB)\fR
1812 Add metadata stored in the "rpm\-md" format (i\&.e\&. from files in the \(lqrepodata\(rq directory) to a repository\&. Supported files are "primary", "filelists", "other", "suseinfo"\&. Do not forget to specify the \fBREPO_EXTEND_SOLVABLES\fR for extension files like "filelists" and "other"\&. Use the \fIlanguage\fR parameter if you have language extension files, otherwise simply use a \fBundef\fR/\fBNone\fR/\fBnil\fR parameter\&.
1818 \fBbool add_repomdxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1819 \fI$repo\fR\fB\->add_repomdxml(\fR\fI$fp\fR\fB)\fR;
1820 \fIrepo\fR\fB\&.add_repomdxml(\fR\fIfp\fR\fB)\fR
1821 \fIrepo\fR\fB\&.add_repomdxml(\fR\fIfp\fR\fB)\fR
1827 Add the repomd\&.xml meta description from the "rpm\-md" format to the repository\&. This file contains information about the repository like keywords, and also a list of all database files with checksums\&. The data is added the the "meta" section of the repository, i\&.e\&. no package gets created\&.
1833 \fBbool add_updateinfoxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1834 \fI$repo\fR\fB\->add_updateinfoxml(\fR\fI$fp\fR\fB)\fR;
1835 \fIrepo\fR\fB\&.add_updateinfoxml(\fR\fIfp\fR\fB)\fR
1836 \fIrepo\fR\fB\&.add_updateinfoxml(\fR\fIfp\fR\fB)\fR
1842 Add the updateinfo\&.xml file containing available maintenance updates to the repository\&. All updates are created as special packages that have a "patch:" prefix in their name\&.
1848 \fBbool add_deltainfoxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1849 \fI$repo\fR\fB\->add_deltainfoxml(\fR\fI$fp\fR\fB)\fR;
1850 \fIrepo\fR\fB\&.add_deltainfoxml(\fR\fIfp\fR\fB)\fR
1851 \fIrepo\fR\fB\&.add_deltainfoxml(\fR\fIfp\fR\fB)\fR
1857 Add the deltainfo\&.xml file (also called prestodelta\&.xml) containing available delta\-rpms to the repository\&. The data is added to the "meta" section, i\&.e\&. no package gets created\&.
1863 \fBbool add_debdb(int\fR \fIflags\fR \fB= 0)\fR
1864 \fI$repo\fR\fB\->add_debdb()\fR;
1865 \fIrepo\fR\fB\&.add_debdb()\fR
1866 \fIrepo\fR\fB\&.add_debdb()\fR
1872 Add the contents of the debian installed package database to the repository\&.
1878 \fBbool add_debpackages(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1879 \fI$repo\fR\fB\->add_debpackages(\fR\fI$fp\fR\fB)\fR;
1880 \fIrepo\fR\fB\&.add_debpackages(\fR\fI$fp\fR\fB)\fR
1881 \fIrepo\fR\fB\&.add_debpackages(\fR\fI$fp\fR\fB)\fR
1887 Add the contents of the debian repository metadata (the "packages" file) to the repository\&.
1893 \fBSolvable add_deb(const char *\fR\fIfilename\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1894 my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_deb(\fR\fI$filename\fR\fB)\fR;
1895 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_deb(\fR\fIfilename\fR\fB)\fR
1896 \fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_deb(\fR\fIfilename\fR\fB)\fR
1902 Add the metadata of a single deb package to the repository\&.
1908 \fBbool add_mdk(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1909 \fI$repo\fR\fB\->add_mdk(\fR\fI$fp\fR\fB)\fR;
1910 \fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR
1911 \fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR
1917 Add the contents of the mageia/mandriva repository metadata (the "synthesis\&.hdlist" file) to the repository\&.
1923 \fBbool add_mdk_info(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1924 \fI$repo\fR\fB\->add_mdk(\fR\fI$fp\fR\fB)\fR;
1925 \fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR
1926 \fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR
1932 Extend the packages from the synthesis file with the info\&.xml and files\&.xml data\&. Do not forget to specify \fBREPO_EXTEND_SOLVABLES\fR\&.
1938 \fBbool add_arch_repo(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1939 \fI$repo\fR\fB\->add_arch_repo(\fR\fI$fp\fR\fB)\fR;
1940 \fIrepo\fR\fB\&.add_arch_repo(\fR\fIfp\fR\fB)\fR
1941 \fIrepo\fR\fB\&.add_arch_repo(\fR\fIfp\fR\fB)\fR
1947 Add the contents of the archlinux repository metadata (the "\&.db\&.tar" file) to the repository\&.
1953 \fBbool add_arch_local(const char *\fR\fIdir\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1954 \fI$repo\fR\fB\->add_arch_local(\fR\fI$dir\fR\fB)\fR;
1955 \fIrepo\fR\fB\&.add_arch_local(\fR\fIdir\fR\fB)\fR
1956 \fIrepo\fR\fB\&.add_arch_local(\fR\fIdir\fR\fB)\fR
1962 Add the contents of the archlinux installed package database to the repository\&. The \fIdir\fR parameter is usually set to "/var/lib/pacman/local"\&.
1968 \fBbool add_content(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1969 \fI$repo\fR\fB\->add_content(\fR\fI$fp\fR\fB)\fR;
1970 \fIrepo\fR\fB\&.add_content(\fR\fIfp\fR\fB)\fR
1971 \fIrepo\fR\fB\&.add_content(\fR\fIfp\fR\fB)\fR
1977 Add the \(lqcontent\(rq meta description from the susetags format to the repository\&. This file contains information about the repository like keywords, and also a list of all database files with checksums\&. The data is added the the "meta" section of the repository, i\&.e\&. no package gets created\&.
1983 \fBbool add_susetags(FILE *\fR\fIfp\fR\fB, Id\fR \fIdefvendor\fR\fB, const char *\fR\fIlanguage\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1984 \fI$repo\fR\fB\->add_susetags(\fR\fI$fp\fR\fB,\fR \fI$defvendor\fR\fB,\fR \fI$language\fR\fB)\fR;
1985 \fIrepo\fR\fB\&.add_susetags(\fR\fIfp\fR\fB,\fR \fIdefvendor\fR\fB,\fR \fIlanguage\fR\fB)\fR
1986 \fIrepo\fR\fB\&.add_susetags(\fR\fIfp\fR\fB,\fR \fIdefvendor\fR\fB,\fR \fIlanguage\fR\fB)\fR
1992 Add repository metadata in the susetags format to the repository\&. Like with add_rpmmd, you can specify a language if you have language extension files\&. The \fIdefvendor\fR parameter provides a default vendor for packages with missing vendors, it is usually provided in the content file\&.
1998 \fBbool add_products(const char *\fR\fIdir\fR\fB, int\fR \fIflags\fR \fB= 0)\fR
1999 \fI$repo\fR\fB\->add_products(\fR\fI$dir\fR\fB)\fR;
2000 \fIrepo\fR\fB\&.add_products(\fR\fIdir\fR\fB)\fR
2001 \fIrepo\fR\fB\&.add_products(\fR\fIdir\fR\fB)\fR
2007 Add the installed SUSE products database to the repository\&. The \fIdir\fR parameter is usually "/etc/products\&.d"\&.
2008 .SH "THE SOLVABLE CLASS"
2010 A solvable describes all the information of one package\&. Each solvable belongs to one repository, it can be added and filled manually but in most cases solvables will get created by the repo_add methods\&.
2017 \fBRepo *repo;\fR /* read only */
2018 \fI$solvable\fR\fB\->{repo}\fR
2019 \fIsolvable\fR\fB\&.repo\fR
2020 \fIsolvable\fR\fB\&.repo\fR
2026 The repository this solvable belongs to\&.
2032 \fBPool *pool;\fR /* read only */
2033 \fI$solvable\fR\fB\->{pool}\fR
2034 \fIsolvable\fR\fB\&.pool\fR
2035 \fIsolvable\fR\fB\&.pool\fR
2041 The pool this solvable belongs to, same as the pool of the repo\&.
2047 \fBId id;\fR /* read only */
2048 \fI$solvable\fR\fB\->{id}\fR
2049 \fIsolvable\fR\fB\&.id\fR
2050 \fIsolvable\fR\fB\&.id\fR
2056 The specific id of the solvable\&.
2062 \fBchar *name;\fR /* read/write */
2063 \fI$solvable\fR\fB\->{name}\fR
2064 \fIsolvable\fR\fB\&.name\fR
2065 \fIsolvable\fR\fB\&.name\fR
2075 \fBchar *evr;\fR /* read/write */
2076 \fI$solvable\fR\fB\->{evr}\fR
2077 \fIsolvable\fR\fB\&.evr\fR
2078 \fIsolvable\fR\fB\&.evr\fR
2088 \fBchar *arch;\fR /* read/write */
2089 \fI$solvable\fR\fB\->{arch}\fR
2090 \fIsolvable\fR\fB\&.arch\fR
2091 \fIsolvable\fR\fB\&.arch\fR
2101 \fBchar *vendor;\fR /* read/write */
2102 \fI$solvable\fR\fB\->{vendor}\fR
2103 \fIsolvable\fR\fB\&.vendor\fR
2104 \fIsolvable\fR\fB\&.vendor\fR
2110 Easy access to often used attributes of solvables\&. They are internally stored as Ids\&.
2116 \fBId nameid;\fR /* read/write */
2117 \fI$solvable\fR\fB\->{nameid}\fR
2118 \fIsolvable\fR\fB\&.nameid\fR
2119 \fIsolvable\fR\fB\&.nameid\fR
2129 \fBId evrid;\fR /* read/write */
2130 \fI$solvable\fR\fB\->{evrid}\fR
2131 \fIsolvable\fR\fB\&.evrid\fR
2132 \fIsolvable\fR\fB\&.evrid\fR
2142 \fBId archid;\fR /* read/write */
2143 \fI$solvable\fR\fB\->{archid}\fR
2144 \fIsolvable\fR\fB\&.archid\fR
2145 \fIsolvable\fR\fB\&.archid\fR
2155 \fBId vendorid;\fR /* read/write */
2156 \fI$solvable\fR\fB\->{vendorid}\fR
2157 \fIsolvable\fR\fB\&.vendorid\fR
2158 \fIsolvable\fR\fB\&.vendorid\fR
2164 Raw interface to the ids\&. Useful if you want to search for a specific id and want to avoid the string compare overhead\&.
2171 \fBconst char *lookup_str(Id\fR \fIkeyname\fR\fB)\fR
2172 my \fI$string\fR \fB=\fR \fI$solvable\fR\fB\->lookup_str(\fR\fI$keyname\fR\fB)\fR;
2173 \fIstring\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR
2174 \fIstring\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR
2184 \fBId lookup_id(Id\fR \fIkeyname\fR\fB)\fR
2185 my \fI$id\fR \fB=\fR \fI$solvable\fR\fB\->lookup_id(\fR\fI$keyname\fR\fB)\fR;
2186 \fIid\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB)\fR
2187 \fIid\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB)\fR
2197 \fBunsigned long long lookup_num(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR
2198 my \fI$num\fR \fB=\fR \fI$solvable\fR\fB\->lookup_num(\fR\fI$keyname\fR\fB)\fR;
2199 \fInum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR
2200 \fInum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR
2210 \fBbool lookup_void(Id\fR \fIkeyname\fR\fB)\fR
2211 my \fI$bool\fR \fB=\fR \fI$solvable\fR\fB\->lookup_void(\fR\fI$keyname\fR\fB)\fR;
2212 \fIbool\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR
2213 \fIbool\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR
2223 \fBChksum lookup_checksum(Id\fR \fIkeyname\fR\fB)\fR
2224 my \fI$chksum\fR \fB=\fR \fI$solvable\fR\fB\->lookup_checksum(\fR\fI$keyname\fR\fB)\fR;
2225 \fIchksum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR
2226 \fIchksum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR
2236 \fBId *lookup_idarray(Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR
2237 my \fI@ids\fR \fB=\fR \fI$solvable\fR\fB\->lookup_idarray(\fR\fI$keyname\fR\fB)\fR;
2238 \fIids\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR
2239 \fIids\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR
2249 \fBDep *lookup_deparray(Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR
2250 my \fI@deps\fR \fB=\fR \fI$solvable\fR\fB\->lookup_deparray(\fR\fI$keyname\fR\fB)\fR;
2251 \fIdeps\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_deparray(\fR\fIkeyname\fR\fB)\fR
2252 \fIdeps\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_deparray(\fR\fIkeyname\fR\fB)\fR
2258 Generic lookup methods\&. Retrieve data stored for the specific keyname\&. The lookup_idarray() method will return an array of Ids, use lookup_deparray if you want an array of Dependency objects instead\&. Some Id arrays contain two parts of data divided by a specific marker, for example the provides array uses the SOLVABLE_FILEMARKER id to store both the ids provided by the package and the ids added by the addfileprovides method\&. The default, \-1, translates to the correct marker for the keyname and returns the first part of the array, use 1 to select the second part or 0 to retrieve all ids including the marker\&.
2264 \fBconst char *lookup_location(unsigned int *\fR\fIOUTPUT\fR\fB)\fR;
2265 my \fB(\fR\fI$location\fR\fB,\fR \fI$medianr\fR\fB) =\fR \fI$solvable\fR\fB\->lookup_location()\fR;
2266 \fIlocation\fR\fB,\fR \fImedianr\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_location()\fR
2267 \fIlocation\fR\fB,\fR \fImedianr\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_location()\fR
2273 Return a tuple containing the on\-media location and an optional media number for multi\-part repositories (e\&.g\&. repositories spawning multiple DVDs)\&.
2279 \fBvoid add_deparray(Id\fR \fIkeyname\fR\fB, DepId\fR \fIdep\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR;
2280 \fI$solvable\fR\fB\->add_deparray(\fR\fI$keyname\fR\fB,\fR \fI$dep\fR\fB)\fR;
2281 \fIsolvable\fR\fB\&.add_deparray(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR
2282 \fIsolvable\fR\fB\&.add_deparray(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR
2288 Add a new dependency to the attributes stored in keyname\&.
2294 \fBvoid unset(Id\fR \fIkeyname\fR\fB)\fR;
2295 \fI$solvable\fR\fB\->unset(\fR\fI$keyname\fR\fB)\fR;
2296 \fIsolvable\fR\fB\&.unset(\fR\fIkeyname\fR\fB)\fR
2297 \fIsolvable\fR\fB\&.unset(\fR\fIkeyname\fR\fB)\fR
2303 Delete data stored for the specific keyname\&.
2309 \fBbool installable()\fR;
2310 \fI$solvable\fR\fB\->installable()\fR
2311 \fIsolvable\fR\fB\&.installable()\fR
2312 \fIsolvable\fR\fB\&.installable?\fR
2318 Return true if the solvable is installable on the system\&. Solvables are not installable if the system does not support their architecture\&.
2324 \fBbool isinstalled()\fR;
2325 \fI$solvable\fR\fB\->isinstalled()\fR
2326 \fIsolvable\fR\fB\&.isinstalled()\fR
2327 \fIsolvable\fR\fB\&.isinstalled?\fR
2333 Return true if the solvable is installed on the system\&.
2339 \fBSelection Selection(int\fR \fIsetflags\fR \fB= 0)\fR
2340 my \fI$sel\fR \fB=\fR \fI$solvable\fR\fB\->Selection()\fR;
2341 \fIsel\fR \fB=\fR \fIsolvable\fR\fB\&.Selection()\fR
2342 \fIsel\fR \fB=\fR \fIsolvable\fR\fB\&.Selection()\fR
2348 Create a Selection containing just the single solvable\&.
2354 \fBconst char *str()\fR
2355 my \fI$str\fR \fB=\fR \fI$solvable\fR\fB\->str()\fR;
2356 \fIstr\fR \fB=\fR \fI$solvable\fR\fB\&.str()\fR
2357 \fIstr\fR \fB=\fR \fI$solvable\fR\fB\&.str()\fR
2363 Return a string describing the solvable\&. The string consists of the name, version, and architecture of the Solvable\&.
2369 \fB<stringification>\fR
2370 my \fI$str\fR \fB=\fR \fI$solvable\fR\fB\->str\fR;
2371 \fIstr\fR \fB= str(\fR\fIsolvable\fR\fB)\fR
2372 \fIstr\fR \fB=\fR \fIsolvable\fR\fB\&.to_s\fR
2378 Same as calling the str() method\&.
2385 \fBif (\fR\fI$solvable1\fR \fB==\fR \fI$solvable2\fR\fB)\fR
2386 \fBif\fR \fIsolvable1\fR \fB==\fR \fIsolvable2\fR\fB:\fR
2387 \fBif\fR \fIsolvable1\fR \fB==\fR \fIsolvable2\fR
2393 Two solvables are equal if they are part of the same pool and have the same ids\&.
2394 .SH "THE DATAITERATOR CLASS"
2396 Dataiterators can be used to do complex string searches or to iterate over arrays\&. They can be created via the constructors in the Pool, Repo, and Solvable classes\&. The Repo and Solvable constructors will limit the search to the repository or the specific package\&.
2401 Return a match if the search string matches the value\&.
2404 \fBSEARCH_STRINGSTART\fR
2406 Return a match if the value starts with the search string\&.
2409 \fBSEARCH_STRINGEND\fR
2411 Return a match if the value ends with the search string\&.
2414 \fBSEARCH_SUBSTRING\fR
2416 Return a match if the search string can be matched somewhere in the value\&.
2421 Do a glob match of the search string against the value\&.
2426 Do a regular expression match of the search string against the value\&.
2431 Ignore case when matching strings\&. Works for all the above match types\&.
2436 Match the complete filenames of the file list, not just the base name\&.
2439 \fBSEARCH_COMPLETE_FILELIST\fR
2441 When matching the file list, check every file of the package not just the subset from the primary metadata\&.
2444 \fBSEARCH_CHECKSUMS\fR
2446 Allow the matching of checksum entries\&.
2454 \fBvoid prepend_keyname(Id\fR \fIkeyname\fR\fB)\fR;
2455 \fI$di\fR\fB\->prepend_keyname(\fR\fI$keyname\fR\fB)\fR;
2456 \fIdi\fR\fB\&.prepend_keyname(\fR\fIkeyname\fR\fB)\fR
2457 \fIdi\fR\fB\&.prepend_keyname(\fR\fIkeyname\fR\fB)\fR
2463 Do a sub\-search in the array stored in keyname\&.
2469 \fBvoid skip_solvable()\fR;
2470 \fI$di\fR\fB\->kip_solvable()\fR;
2471 \fIdi\fR\fB\&.skip_solvable()\fR
2472 \fIdi\fR\fB\&.skip_solvable()\fR
2478 Stop matching the current solvable and advance to the next one\&.
2485 \fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR
2486 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR
2487 \fBfor\fR \fId\fR \fBin\fR \fIdi\fR
2493 Iterate through the matches\&. If there is a match, the object in d will be of type Datamatch\&.
2494 .SH "THE DATAMATCH CLASS"
2496 Objects of this type will be created for every value matched by a dataiterator\&.
2503 \fBPool *pool;\fR /* read only */
2504 \fI$d\fR\fB\->{pool}\fR
2505 \fId\fR\fB\&.pool\fR
2506 \fId\fR\fB\&.pool\fR
2512 Back pointer to pool\&.
2518 \fBRepo *repo;\fR /* read only */
2519 \fI$d\fR\fB\->{repo}\fR
2520 \fId\fR\fB\&.repo\fR
2521 \fId\fR\fB\&.repo\fR
2527 The repository containing the matched object\&.
2533 \fBSolvable *solvable;\fR /* read only */
2534 \fI$d\fR\fB\->{solvable}\fR
2535 \fId\fR\fB\&.solvable\fR
2536 \fId\fR\fB\&.solvable\fR
2542 The solvable containing the value that was matched\&.
2548 \fBId solvid;\fR /* read only */
2549 \fI$d\fR\fB\->{solvid}\fR
2550 \fId\fR\fB\&.solvid\fR
2551 \fId\fR\fB\&.solvid\fR
2557 The id of the solvable that matched\&.
2565 \fI$d\fR\fB\->key_id()\fR
2566 \fId\fR\fB\&.key_id()\fR
2567 \fId\fR\fB\&.key_id()\fR
2577 \fBconst char *key_idstr()\fR;
2578 \fI$d\fR\fB\->key_idstr()\fR
2579 \fId\fR\fB\&.key_idstr()\fR
2580 \fId\fR\fB\&.key_idstr()\fR
2586 The keyname that matched, either as id or string\&.
2593 \fI$d\fR\fB\->type_id()\fR
2594 \fId\fR\fB\&.type_id()\fR
2595 \fId\fR\fB\&.type_id()\fR
2605 \fBconst char *type_idstr()\fR;
2606 \fI$d\fR\fB\->type_idstr()\fR;
2607 \fId\fR\fB\&.type_idstr()\fR
2608 \fId\fR\fB\&.type_idstr()\fR
2614 The key type of the value that was matched, either as id or string\&.
2621 \fI$d\fR\fB\->id()\fR
2622 \fId\fR\fB\&.id()\fR
2623 \fId\fR\fB\&.id()\fR
2634 \fI$d\fR\fB\->idstr()\fR
2635 \fId\fR\fB\&.idstr()\fR
2636 \fId\fR\fB\&.idstr()\fR
2642 The Id of the value that was matched (only valid for id types), either as id or string\&.
2648 \fBconst char *str()\fR;
2649 \fI$d\fR\fB\->str()\fR
2650 \fId\fR\fB\&.str()\fR
2651 \fId\fR\fB\&.str()\fR
2657 The string value that was matched (only valid for string types)\&.
2663 \fBunsigned long long num()\fR;
2664 \fI$d\fR\fB\->num()\fR
2665 \fId\fR\fB\&.num()\fR
2666 \fId\fR\fB\&.num()\fR
2672 The numeric value that was matched (only valid for numeric types)\&.
2678 \fBunsigned int num2()\fR;
2679 \fI$d\fR\fB\->num2()\fR
2680 \fId\fR\fB\&.num2()\fR
2681 \fId\fR\fB\&.num2()\fR
2687 The secondary numeric value that was matched (only valid for types containing two values)\&.
2693 \fBDatapos pos()\fR;
2694 my \fI$pos\fR \fB=\fR \fI$d\fR\fB\->pos()\fR;
2695 \fIpos\fR \fB=\fR \fId\fR\fB\&.pos()\fR
2696 \fIpos\fR \fB=\fR \fId\fR\fB\&.pos()\fR
2702 The position object of the current match\&. It can be used to do sub\-searches starting at the match (if it is of an array type)\&. See the Datapos class for more information\&.
2708 \fBDatapos parentpos()\fR;
2709 my \fI$pos\fR \fB=\fR \fI$d\fR\fB\->parentpos()\fR;
2710 \fIpos\fR \fB=\fR \fId\fR\fB\&.parentpos()\fR
2711 \fIpos\fR \fB=\fR \fId\fR\fB\&.parentpos()\fR
2717 The position object of the array containing the current match\&. It can be used to do sub\-searches, see the Datapos class for more information\&.
2723 \fB<stringification>\fR
2724 my \fI$str\fR \fB=\fR \fI$d\fR\fB\->str\fR;
2725 \fIstr\fR \fB= str(\fR\fId\fR\fB)\fR
2726 \fIstr\fR \fB=\fR \fId\fR\fB\&.to_s\fR
2732 Return the stringification of the matched value\&. Stringification depends on the search flags, for file list entries it will return just the base name unless SEARCH_FILES is used, for checksums it will return an empty string unless SEARCH_CHECKSUMS is used\&. Numeric values are currently stringified to an empty string\&.
2733 .SH "THE SELECTION CLASS"
2735 Selections are a way to easily deal with sets of packages\&. There are multiple constructors to create them, the most useful is probably the select() method in the Pool class\&.
2738 \fBSELECTION_NAME\fR
2740 Create the selection by matching package names\&.
2743 \fBSELECTION_PROVIDES\fR
2745 Create the selection by matching package provides\&.
2748 \fBSELECTION_FILELIST\fR
2750 Create the selection by matching package files\&.
2753 \fBSELECTION_CANON\fR
2755 Create the selection by matching the canonical representation of the package\&. This is normally a combination of the name, the version, and the architecture of a package\&.
2758 \fBSELECTION_DOTARCH\fR
2760 Allow an \(lq\&.<architecture>\(rq suffix when matching names or provides\&.
2765 Allow the specification of a relation when matching names or provides, e\&.g\&. "name >= 1\&.2"\&.
2768 \fBSELECTION_INSTALLED_ONLY\fR
2770 Limit the package search to installed packages\&.
2773 \fBSELECTION_SOURCE_ONLY\fR
2775 Limit the package search to source packages only\&.
2778 \fBSELECTION_WITH_SOURCE\fR
2780 Extend the package search to also match source packages\&. The default is only to match binary packages\&.
2783 \fBSELECTION_GLOB\fR
2785 Allow glob matching for package names, package provides, and file names\&.
2788 \fBSELECTION_NOCASE\fR
2790 Ignore case when matching package names, package provides, and file names\&.
2793 \fBSELECTION_FLAT\fR
2795 Return only one selection element describing the selected packages\&. The default is to create multiple elements for all globbed packages\&. Multiple elements are useful if you want to turn the selection into an install job, in that case you want an install job for every globbed package\&.
2803 \fBPool *pool;\fR /* read only */
2804 \fI$d\fR\fB\->{pool}\fR
2805 \fId\fR\fB\&.pool\fR
2806 \fId\fR\fB\&.pool\fR
2812 Back pointer to pool\&.
2820 my \fI$flags\fR \fB=\fR \fI$sel\fR\fB\->flags()\fR;
2821 \fIflags\fR \fB=\fR \fIsel\fR\fB\&.flags()\fR
2822 \fIflags\fR \fB=\fR \fIsel\fR\fB\&.flags()\fR
2828 Return the result flags of the selection\&. The flags are a subset of the ones used when creating the selection, they describe which method was used to get the result\&. For example, if you create the selection with \(lqSELECTION_NAME | SELECTION_PROVIDES\(rq, the resulting flags will either be SELECTION_NAME or SELECTION_PROVIDES depending if there was a package that matched the name or not\&. If there was no match at all, the flags will be zero\&.
2834 \fBbool isempty()\fR;
2835 \fI$sel\fR\fB\->isempty()\fR
2836 \fIsel\fR\fB\&.isempty()\fR
2837 \fIsel\fR\fB\&.isempty?\fR
2843 Return true if the selection is empty, i\&.e\&. no package could be matched\&.
2849 \fBvoid filter(Selection *\fR\fIother\fR\fB)\fR
2850 \fI$sel\fR\fB\->filter(\fR\fI$other\fR\fB)\fR;
2851 \fIsel\fR\fB\&.filter(\fR\fIother\fR\fB)\fR
2852 \fIsel\fR\fB\&.filter(\fR\fIother\fR\fB)\fR
2858 Intersect two selections\&. Packages will only stay in the selection if there are also included in the other selecting\&. Does an in\-place modification\&.
2864 \fBvoid add(Selection *\fR\fIother\fR\fB)\fR
2865 \fI$sel\fR\fB\->add(\fR\fI$other\fR\fB)\fR;
2866 \fIsel\fR\fB\&.add(\fR\fIother\fR\fB)\fR
2867 \fIsel\fR\fB\&.add(\fR\fIother\fR\fB)\fR
2873 Build the union of two selections\&. All packages of the other selection will be added to the set of packages of the selection object\&. Does an in\-place modification\&. Note that the selection flags are no longer meaningful after the add operation\&.
2879 \fBvoid add_raw(Id\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR
2880 \fI$sel\fR\fB\->add_raw(\fR\fI$how\fR\fB,\fR \fI$what\fR\fB)\fR;
2881 \fIsel\fR\fB\&.add_raw(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR
2882 \fIsel\fR\fB\&.add_raw(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR
2888 Add a raw element to the selection\&. Check the Job class for information about the how and what parameters\&.
2894 \fBJob *jobs(int\fR \fIaction\fR\fB)\fR
2895 my \fI@jobs\fR \fB=\fR \fI$sel\fR\fB\->jobs(\fR\fI$action\fR\fB)\fR;
2896 \fIjobs\fR \fB=\fR \fIsel\fR\fB\&.jobs(\fR\fIaction\fR\fB)\fR
2897 \fIjobs\fR \fB=\fR \fIsel\fR\fB\&.jobs(\fR\fIaction\fR\fB)\fR
2903 Convert a selection into an array of Job objects\&. The action parameter is or\-ed to the \(lqhow\(rq part of the job, it describes the type of job (e\&.g\&. install, erase)\&. See the Job class for the action and action modifier constants\&.
2909 \fBSolvable *solvables()\fR
2910 my \fI@solvables\fR \fB=\fR \fI$sel\fR\fB\->solvables()\fR;
2911 \fIsolvables\fR \fB=\fR \fIsel\fR\fB\&.solvables()\fR
2912 \fIsolvables\fR \fB=\fR \fIsel\fR\fB\&.solvables()\fR
2918 Convert a selection into an array of Solvable objects\&.
2924 \fB<stringification>\fR
2925 my \fI$str\fR \fB=\fR \fI$sel\fR\fB\->str\fR;
2926 \fIstr\fR \fB= str(\fR\fIsel\fR\fB)\fR
2927 \fIstr\fR \fB=\fR \fIsel\fR\fB\&.to_s\fR
2933 Return a string describing the selection\&.
2936 Jobs are the way to specify to the dependency solver what to do\&. Most of the times jobs will get created by calling the jobs() method on a Selection object, but there is also a Job() constructor in the Pool class\&.
2939 Selection constants:
2941 \fBSOLVER_SOLVABLE\fR
2943 The \(lqwhat\(rq part is the id of a solvable\&.
2946 \fBSOLVER_SOLVABLE_NAME\fR
2948 The \(lqwhat\(rq part is the id of a package name\&.
2951 \fBSOLVER_SOLVABLE_PROVIDES\fR
2953 The \(lqwhat\(rq part is the id of a package provides\&.
2956 \fBSOLVER_SOLVABLE_ONE_OF\fR
2958 The \(lqwhat\(rq part is an offset into the \(lqwhatprovides\(rq data, created by calling the towhatprovides() pool method\&.
2961 \fBSOLVER_SOLVABLE_REPO\fR
2963 The \(lqwhat\(rq part is the id of a repository\&.
2966 \fBSOLVER_SOLVABLE_ALL\fR
2968 The \(lqwhat\(rq part is ignored, all packages are selected\&.
2971 \fBSOLVER_SOLVABLE_SELECTMASK\fR
2973 A mask containing all the above selection bits\&.
2983 \fBSOLVER_INSTALL\fR
2985 Install a package of the specified set of packages\&. It tries to install the best matching package (i\&.e\&. the highest version of the packages from the repositories with the highest priority)\&.
2990 Erase all of the packages from the specified set\&. If a package is not installed, erasing it will keep it from getting installed\&.
2995 Update the matching installed packages to their best version\&. If none of the specified packages are installed, try to update the installed packages to the specified versions\&. See the section about targeted updates about more information\&.
2998 \fBSOLVER_WEAKENDEPS\fR
3000 Allow to break the dependencies of the matching packages\&. Handle with care\&.
3003 \fBSOLVER_MULTIVERSION\fR
3005 Mark the matched packages for multiversion install\&. If they get to be installed because of some other job, the installation will keep the old version of the package installed (for rpm this is done by using \(lq\-i\(rq instead of \(lq\-U\(rq)\&.
3010 Do not change the state of the matched packages, i\&.e\&. when they are installed they stay installed, if not they are not selected for installation\&.
3013 \fBSOLVER_DISTUPGRADE\fR
3015 Update the matching installed packages to the best version included in one of the repositories\&. After this operation, all come from one of the available repositories except orphaned packages\&. Orphaned packages are packages that have no relation to the packages in the repositories, i\&.e\&. no package in the repositories have the same name or obsolete the orphaned package\&. This action brings the installed packages in sync with the ones in the repository\&. It also turns of arch/vendor/version locking for the affected packages to simulate a fresh installation\&. This means that distupgrade can actually downgrade packages if only lower versions of a package are available in the repositories\&.
3018 \fBSOLVER_DROP_ORPHANED\fR
3020 Erase all the matching installed packages if they are orphaned\&. This only makes sense if there is a \(lqdistupgrade all packages\(rq job\&. The default is to erase orphaned packages only if they block the installation of other packages\&.
3025 Fix dependency problems of matching installed packages\&. The default is to ignore dependency problems for installed packages\&.
3028 \fBSOLVER_USERINSTALLED\fR
3030 The matching installed packages are considered to be installed by a user, thus not installed to fulfill some dependency\&. This is needed input for the calculation of unneeded packages for jobs that have the SOLVER_CLEANDEPS flag set\&.
3033 \fBSOLVER_JOBMASK\fR
3035 A mask containing all the above action bits\&.
3038 Action modifier constants:
3042 Makes the job a weak job\&. The solver tries to fulfill weak jobs, but does not report a problem if it is not possible to do so\&.
3045 \fBSOLVER_ESSENTIAL\fR
3047 Makes the job an essential job\&. If there is a problem with the job, the solver will not propose to remove the job as one solution (unless all other solutions are also to remove essential jobs)\&.
3050 \fBSOLVER_CLEANDEPS\fR
3052 The solver will try to also erase all packages dragged in through dependencies when erasing the package\&. This needs SOLVER_USERINSTALLED jobs to maximize user satisfaction\&.
3055 \fBSOLVER_FORCEBEST\fR
3057 Insist on the best package for install, update, and distupgrade jobs\&. If this flag is not used, the solver will use the second\-best package if the best package cannot be installed for some reason\&. When this flag is used, the solver will generate a problem instead\&.
3060 \fBSOLVER_TARGETED\fR
3062 Forces targeted operation update and distupgrade jobs\&. See the section about targeted updates about more information\&.
3069 The job specified the exact epoch and version of the package set\&.
3074 The job specified the exact epoch, version, and release of the package set\&.
3077 \fBSOLVER_SETARCH\fR
3079 The job specified the exact architecture of the packages from the set\&.
3082 \fBSOLVER_SETVENDOR\fR
3084 The job specified the exact vendor of the packages from the set\&.
3087 \fBSOLVER_SETREPO\fR
3089 The job specified the exact repository of the packages from the set\&.
3092 \fBSOLVER_SETNAME\fR
3094 The job specified the exact name of the packages from the set\&.
3097 \fBSOLVER_NOAUTOSET\fR
3099 Turn of automatic set flag generation for SOLVER_SOLVABLE jobs\&.
3102 \fBSOLVER_SETMASK\fR
3104 A mask containing all the above set bits\&.
3107 See the section about set bits for more information\&.
3114 \fBPool *pool;\fR /* read only */
3115 \fI$job\fR\fB\->{pool}\fR
3116 \fId\fR\fB\&.pool\fR
3117 \fId\fR\fB\&.pool\fR
3123 Back pointer to pool\&.
3129 \fBId how;\fR /* read/write */
3130 \fI$job\fR\fB\->{how}\fR
3138 Union of the selection, action, action modifier, and set flags\&. The selection part describes the semantics of the \(lqwhat\(rq Id\&.
3144 \fBId what;\fR /* read/write */
3145 \fI$job\fR\fB\->{what}\fR
3146 \fId\fR\fB\&.what\fR
3147 \fId\fR\fB\&.what\fR
3153 Id describing the set of packages, the meaning depends on the selection part of the \(lqhow\(rq attribute\&.
3160 \fBSolvable *solvables()\fR
3161 my \fI@solvables\fR \fB=\fR \fI$job\fR\fB\->solvables()\fR;
3162 \fIsolvables\fR \fB=\fR \fIjob\fR\fB\&.solvables()\fR
3163 \fIsolvables\fR \fB=\fR \fIjob\fR\fB\&.solvables()\fR
3169 Return the set of solvables of the job as an array of Solvable objects\&.
3175 \fBbool isemptyupdate()\fR;
3176 \fI$job\fR\fB\->isemptyupdate()\fR
3177 \fIjob\fR\fB\&.isemptyupdate()\fR
3178 \fIjob\fR\fB\&.isemptyupdate?\fR
3184 Convenience function to find out if the job describes an update job with no matching packages, i\&.e\&. a job that does nothing\&. Some package managers like \(lqzypper\(rq like to turn those jobs into install jobs, i\&.e\&. an update of a not\-installed package will result into the installation of the package\&.
3190 \fB<stringification>\fR
3191 my \fI$str\fR \fB=\fR \fI$job\fR\fB\->str\fR;
3192 \fIstr\fR \fB= str(\fR\fIjob\fR\fB)\fR
3193 \fIstr\fR \fB=\fR \fIjob\fR\fB\&.to_s\fR
3199 Return a string describing the job\&.
3206 \fBif (\fR\fI$job1\fR \fB==\fR \fI$job2\fR\fB)\fR
3207 \fBif\fR \fIjob1\fR \fB==\fR \fIjob2\fR\fB:\fR
3208 \fBif\fR \fIjob1\fR \fB==\fR \fIjob2\fR
3214 Two jobs are equal if they belong to the same pool and both the \(lqhow\(rq and the \(lqwhat\(rq attributes are the same\&.
3215 .SS "TARGETED UPDATES"
3217 Libsolv has two modes for upgrades and distupgrade: targeted and untargeted\&. Untargeted mode means that the installed packages from the specified set will be updated to the best version\&. Targeted means that packages that can be updated to a package in the specified set will be updated to the best package of the set\&.
3219 Here\(cqs an example to explain the subtle difference\&. Suppose that you have package A installed in version "1\&.1", "A\-1\&.2" is available in one of the repositories and there is also package "B" that obsoletes package A\&.
3221 An untargeted update of "A" will update the installed "A\-1\&.1" to package "B", because that is the newest version (B obsoletes A and is thus newer)\&.
3223 A targeted update of "A" will update "A\-1\&.1" to "A\-1\&.2", as the set of packages contains both "A\-1\&.1" and "A\-1\&.2", and "A\-1\&.2" is the newer one\&.
3225 An untargeted update of "B" will do nothing, as "B" is not installed\&.
3227 An targeted update of "B" will update "A\-1\&.1" to "B"\&.
3229 Note that the default is to do "auto\-targeting", thus if the specified set of packages does not include an installed package, the solver will assume targeted operation even if SOLVER_TARGETED is not used\&.
3231 This mostly matches the intent of the user, with one exception: In the example above, an update of "A\-1\&.2" will update "A\-1\&.1" to "A\-1\&.2" (targeted mode), but a second update of "A\-1\&.2" will suddenly update to "B", as untargeted mode is chosen because "A\-1\&.2" is now installed\&.
3233 If you want to have full control over when targeting mode is chosen, turn off auto\-targeting with the SOLVER_FLAG_NO_AUTOTARGET solver option\&. In that case, all updates are considered to be untargeted unless they include the SOLVER_TARGETED flag\&.
3236 Set bits specify which parts of the specified packages where specified by the user\&. It is used by the solver when checking if an operation is allowed or not\&. For example, the solver will normally not allow the downgrade of an installed package\&. But it will not report a problem if the SOLVER_SETEVR flag is used, as it then assumes that the user specified the exact version and thus knows what he is doing\&.
3238 So if a package "screen\-1\-1" is installed for the x86_64 architecture and version "2\-1" is only available for the i586 architecture, installing package "screen\-2\&.1" will ask the user for confirmation because of the different architecture\&. When using the Selection class to create jobs the set bits are automatically added, e\&.g\&. selecting \(lqscreen\&.i586\(rq will automatically add SOLVER_SETARCH, and thus no problem will be reported\&.
3239 .SH "THE SOLVER CLASS"
3241 Dependency solving is what this library is about\&. A solver object is needed for solving to store the result of the solver run\&. The solver object can be used multiple times for different jobs, reusing it allows the solver to re\-use the dependency rules it already computed\&.
3244 Flags to modify some of the solver\(cqs behavior:
3246 \fBSOLVER_FLAG_ALLOW_DOWNGRADE\fR
3248 Allow the solver to downgrade packages without asking for confirmation (i\&.e\&. reporting a problem)\&.
3251 \fBSOLVER_FLAG_ALLOW_ARCHCHANGE\fR
3253 Allow the solver to change the architecture of an installed package without asking for confirmation\&. Note that changes to/from noarch are always considered to be allowed\&.
3256 \fBSOLVER_FLAG_ALLOW_VENDORCHANGE\fR
3258 Allow the solver to change the vendor of an installed package without asking for confirmation\&. Each vendor is part of one or more vendor equivalence classes, normally installed packages may only change their vendor if the new vendor shares at least one equivalence class\&.
3261 \fBSOLVER_FLAG_ALLOW_NAMECHANGE\fR
3263 Allow the solver to change the name of an installed package, i\&.e\&. install a package with a different name that obsoletes the installed package\&. This option is on by default\&.
3266 \fBSOLVER_FLAG_ALLOW_UNINSTALL\fR
3268 Allow the solver to erase installed packages to fulfill the jobs\&. This flag also includes the above flags\&. You may want to set this flag if you only have SOLVER_ERASE jobs, as in that case it\(cqs better for the user to check the transaction overview instead of approving every single package that needs to be erased\&.
3271 \fBSOLVER_FLAG_NO_UPDATEPROVIDE\fR
3273 If multiple packages obsolete an installed package, the solver checks the provides of every such package and ignores all packages that do not provide the installed package name\&. Thus, you can have an official update candidate that provides the old name, and other packages that also obsolete the package but are not considered for updating\&. If you cannot use this feature, you can turn it off by setting this flag\&.
3276 \fBSOLVER_FLAG_SPLITPROVIDES\fR
3278 Make the solver aware of special provides of the form \(lq<packagename>:<path>\(rq used in SUSE systems to support package splits\&.
3281 \fBSOLVER_FLAG_IGNORE_RECOMMENDED\fR
3283 Do not process optional (aka weak) dependencies\&.
3286 \fBSOLVER_FLAG_ADD_ALREADY_RECOMMENDED\fR
3288 Install recommended or supplemented packages even if they have no connection to the current transaction\&. You can use this feature to implement a simple way for the user to install new recommended packages that were not available in the past\&.
3291 \fBSOLVER_FLAG_NO_INFARCHCHECK\fR
3293 Turn off the inferior architecture checking that is normally done by the solver\&. Normally, the solver allows only the installation of packages from the "best" architecture if a package is available for multiple architectures\&.
3296 \fBSOLVER_FLAG_BEST_OBEY_POLICY\fR
3298 Make the SOLVER_FORCEBEST job option consider only packages that meet the policies for installed packages, i\&.e\&. no downgrades, no architecture change, no vendor change (see the first flags of this section)\&. If the flag is not specified, the solver will enforce the installation of the best package ignoring the installed packages, which may conflict with the set policy\&.
3301 \fBSOLVER_FLAG_NO_AUTOTARGET\fR
3303 Do not enable auto\-targeting up update and distupgrade jobs\&. See the section on targeted updates for more information\&.
3308 \fBSOLVER_RULE_UNKNOWN\fR
3310 A rule of an unknown class\&. You should never encounter those\&.
3313 \fBSOLVER_RULE_RPM\fR
3315 A package dependency rule, called rpm rule for historical reasons\&.
3318 \fBSOLVER_RULE_UPDATE\fR
3320 A rule to implement the update policy of installed packages\&. Every installed package has an update rule that consists of the packages that may replace the installed package\&.
3323 \fBSOLVER_RULE_FEATURE\fR
3325 Feature rules are fallback rules used when a update rule is disabled\&. They include all packages that may replace the installed package ignoring the update policy, i\&.e\&. they contain downgrades, arch changes and so on\&. Without them, the solver would simply erase installed packages if their update rule gets disabled\&.
3328 \fBSOLVER_RULE_JOB\fR
3330 Job rules implement the job given to the solver\&.
3333 \fBSOLVER_RULE_DISTUPGRADE\fR
3335 This are simple negative assertions that make sure that only packages are kept that are also available in one of the repositories\&.
3338 \fBSOLVER_RULE_INFARCH\fR
3340 Infarch rules are also negative assertions, they disallow the installation of packages when there are packages of the same name but with a better architecture\&.
3343 \fBSOLVER_RULE_CHOICE\fR
3345 Choice rules are used to make sure that the solver prefers updating to installing different packages when some dependency is provided by multiple packages with different names\&. The solver may always break choice rules, so you will not see them when a problem is found\&.
3348 \fBSOLVER_RULE_LEARNT\fR
3350 These rules are generated by the solver to keep it from running into the same problem multiple times when it has to backtrack\&. They are the main reason why a sat solver is faster then other dependency solver implementations\&.
3353 Special dependency rule types:
3355 \fBSOLVER_RULE_RPM_NOT_INSTALLABLE\fR
3357 This rule was added to prevent the installation of a package of an architecture that does not work on the system\&.
3360 \fBSOLVER_RULE_RPM_NOTHING_PROVIDES_DEP\fR
3362 The package contains a required dependency which was not provided by any package\&.
3365 \fBSOLVER_RULE_RPM_PACKAGE_REQUIRES\fR
3367 Similar to SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP, but in this case some packages provided the dependency but none of them could be installed due to other dependency issues\&.
3370 \fBSOLVER_RULE_RPM_SELF_CONFLICT\fR
3372 The package conflicts with itself\&. This is not allowed by older rpm versions\&.
3375 \fBSOLVER_RULE_RPM_PACKAGE_CONFLICT\fR
3377 To fulfill the dependencies two packages need to be installed, but one of the packages contains a conflict with the other one\&.
3380 \fBSOLVER_RULE_RPM_SAME_NAME\fR
3382 The dependencies can only be fulfilled by multiple versions of a package, but installing multiple versions of the same package is not allowed\&.
3385 \fBSOLVER_RULE_RPM_PACKAGE_OBSOLETES\fR
3387 To fulfill the dependencies two packages need to be installed, but one of the packages obsoletes the other one\&.
3390 \fBSOLVER_RULE_RPM_IMPLICIT_OBSOLETES\fR
3392 To fulfill the dependencies two packages need to be installed, but one of the packages has provides a dependency that is obsoleted by the other one\&. See the POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES flag\&.
3395 \fBSOLVER_RULE_RPM_INSTALLEDPKG_OBSOLETES\fR
3397 To fulfill the dependencies a package needs to be installed that is obsoleted by an installed package\&. See the POOL_FLAG_NOINSTALLEDOBSOLETES flag\&.
3400 \fBSOLVER_RULE_JOB_NOTHING_PROVIDES_DEP\fR
3402 The user asked for installation of a package providing a specific dependency, but no available package provides it\&.
3405 \fBSOLVER_RULE_JOB_UNKNOWN_PACKAGE\fR
3407 The user asked for installation of a package with a specific name, but no available package has that name\&.
3410 \fBSOLVER_RULE_JOB_PROVIDED_BY_SYSTEM\fR
3412 The user asked for the erasure of a dependency that is provided by the system (i\&.e\&. for special hardware or language dependencies), this cannot be done with a job\&.
3415 \fBSOLVER_RULE_JOB_UNSUPPORTED\fR
3417 The user asked for something that is not yet implemented, e\&.g\&. the installation of all packages at once\&.
3420 Policy error constants
3422 \fBPOLICY_ILLEGAL_DOWNGRADE\fR
3424 The solver ask for permission before downgrading packages\&.
3427 \fBPOLICY_ILLEGAL_ARCHCHANGE\fR
3429 The solver ask for permission before changing the architecture of installed packages\&.
3432 \fBPOLICY_ILLEGAL_VENDORCHANGE\fR
3434 The solver ask for permission before changing the vendor of installed packages\&.
3437 \fBPOLICY_ILLEGAL_NAMECHANGE\fR
3439 The solver ask for permission before replacing an installed packages with a package that has a different name\&.
3442 Solution element type constants
3444 \fBSOLVER_SOLUTION_JOB\fR
3446 The problem can be solved by removing the specified job\&.
3449 \fBSOLVER_SOLUTION_POOLJOB\fR
3451 The problem can be solved by removing the specified job that is defined in the pool\&.
3454 \fBSOLVER_SOLUTION_INFARCH\fR
3456 The problem can be solved by allowing the installation of the specified package with an inferior architecture\&.
3459 \fBSOLVER_SOLUTION_DISTUPGRADE\fR
3461 The problem can be solved by allowing to keep the specified package installed\&.
3464 \fBSOLVER_SOLUTION_BEST\fR
3466 The problem can be solved by allowing to install the specified package that is not the best available package\&.
3469 \fBSOLVER_SOLUTION_ERASE\fR
3471 The problem can be solved by allowing to erase the specified package\&.
3474 \fBSOLVER_SOLUTION_REPLACE\fR
3476 The problem can be solved by allowing to replace the package with some other package\&.
3479 \fBSOLVER_SOLUTION_REPLACE_DOWNGRADE\fR
3481 The problem can be solved by allowing to replace the package with some other package that has a lower version\&.
3484 \fBSOLVER_SOLUTION_REPLACE_ARCHCHANGE\fR
3486 The problem can be solved by allowing to replace the package with some other package that has a different architecture\&.
3489 \fBSOLVER_SOLUTION_REPLACE_VENDORCHANGE\fR
3491 The problem can be solved by allowing to replace the package with some other package that has a different vendor\&.
3494 \fBSOLVER_SOLUTION_REPLACE_NAMECHANGE\fR
3496 The problem can be solved by allowing to replace the package with some other package that has a different name\&.
3504 \fBPool *pool;\fR /* read only */
3505 \fI$job\fR\fB\->{pool}\fR
3506 \fId\fR\fB\&.pool\fR
3507 \fId\fR\fB\&.pool\fR
3513 Back pointer to pool\&.
3520 \fBint set_flag(int\fR \fIflag\fR\fB, int\fR \fIvalue\fR\fB)\fR
3521 my \fI$oldvalue\fR \fB=\fR \fI$pool\fR\fB\->set_flag(\fR\fI$flag\fR\fB,\fR \fI$value\fR\fB)\fR;
3522 \fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR
3523 \fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR
3533 \fBint get_flag(int\fR \fIflag\fR\fB)\fR
3534 my \fI$value\fR \fB=\fR \fI$pool\fR\fB\->get_flag(\fR\fI$flag\fR\fB)\fR;
3535 \fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR
3536 \fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR
3542 Set/get a solver specific flag\&. The flags define the policies the solver has to obey\&. The flags are explained in the CONSTANTS section of this class\&.
3548 \fBProblem *solve(Job *\fR\fIjobs\fR\fB)\fR
3549 my \fI@problems\fR \fB=\fR \fI$solver\fR\fB\->solve(\e\fR\fI@jobs\fR\fB)\fR;
3550 \fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR
3551 \fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR
3557 Solve a problem specified in the job list (plus the jobs defined in the pool)\&. Returns an array of problems that need user interaction, or an empty array if no problems were encountered\&. See the Problem class on how to deal with problems\&.
3563 \fBTransaction transaction()\fR
3564 my \fI$trans\fR \fB=\fR \fI$solver\fR\fB\->transaction()\fR;
3565 \fItrans\fR \fB=\fR \fIsolver\fR\fB\&.transaction()\fR
3566 \fItrans\fR \fB=\fR \fIsolver\fR\fB\&.transaction()\fR
3572 Return the transaction to implement the calculated package changes\&. A transaction is available even if problems were found, this is useful for interactive user interfaces that show both the job result and the problems\&.
3573 .SH "THE PROBLEM CLASS"
3575 Problems are the way of the solver to interact with the user\&. You can simply list all problems and terminate your program, but a better way is to present solutions to the user and let him pick the ones he likes\&.
3582 \fBSolver *solv;\fR /* read only */
3583 \fI$problem\fR\fB\->{solv}\fR
3584 \fIproblem\fR\fB\&.solv\fR
3585 \fIproblem\fR\fB\&.solv\fR
3591 Back pointer to solver object\&.
3597 \fBId id;\fR /* read only */
3598 \fI$problem\fR\fB\->{id}\fR
3599 \fIproblem\fR\fB\&.id\fR
3600 \fIproblem\fR\fB\&.id\fR
3606 Id of the problem\&. The first problem has Id 1, they are numbered consecutively\&.
3613 \fBRule findproblemrule()\fR
3614 my \fI$probrule\fR \fB=\fR \fI$problem\fR\fB\->findproblemrule()\fR;
3615 \fIprobrule\fR \fB=\fR \fIproblem\fR\fB\&.findproblemrule()\fR
3616 \fIprobrule\fR \fB=\fR \fIproblem\fR\fB\&.findproblemrule()\fR
3622 Return the rule that caused the problem\&. Of course in most situations there is no single responsible rule, but many rules that interconnect with each created the problem\&. Nevertheless, the solver uses some heuristic approach to find a rule that somewhat describes the problem best to the user\&.
3628 \fBRule *findallproblemrules(bool\fR \fIunfiltered\fR \fB= 0)\fR
3629 my \fI@probrules\fR \fB=\fR \fI$problem\fR\fB\->findallproblemrules()\fR;
3630 \fIprobrules\fR \fB=\fR \fIproblem\fR\fB\&.findallproblemrule()\fR
3631 \fIprobrules\fR \fB=\fR \fIproblem\fR\fB\&.findallproblemrule()\fR
3637 Return all rules responsible for the problem\&. The returned set of rules contains all the needed information why there was a problem, but it\(cqs hard to present them to the user in a sensible way\&. The default is to filter out all update and job rules (unless the returned rules only consist of those types)\&.
3643 \fBSolution *solutions()\fR
3644 my \fI@solutions\fR \fB=\fR \fI$problem\fR\fB\->solutions()\fR;
3645 \fIsolutions\fR \fB=\fR \fIproblem\fR\fB\&.solutions()\fR
3646 \fIsolutions\fR \fB=\fR \fIproblem\fR\fB\&.solutions()\fR
3652 Return an array containing multiple possible solutions to fix the problem\&. See the solution class for more information\&.
3658 \fBint solution_count()\fR
3659 my \fI$cnt\fR \fB=\fR \fI$problem\fR\fB\->solution_count()\fR;
3660 \fIcnt\fR \fB=\fR \fIproblem\fR\fB\&.solution_count()\fR
3661 \fIcnt\fR \fB=\fR \fIproblem\fR\fB\&.solution_count()\fR
3667 Return the number of solutions without creating solution objects\&.
3673 \fB<stringification>\fR
3674 my \fI$str\fR \fB=\fR \fI$problem\fR\fB\->str\fR;
3675 \fIstr\fR \fB= str(\fR\fIproblem\fR\fB)\fR
3676 \fIstr\fR \fB=\fR \fIproblem\fR\fB\&.to_s\fR
3682 Return a string describing the problem\&. This is a convenience function, it is a shorthand for calling findproblemrule(), then ruleinfo() on the problem rule and problemstr() on the ruleinfo object\&.
3683 .SH "THE RULE CLASS"
3685 Rules are the basic block of sat solving\&. Each package dependency gets translated into one or multiple rules\&.
3692 \fBSolver *solv;\fR /* read only */
3693 \fI$rule\fR\fB\->{solv}\fR
3694 \fIrule\fR\fB\&.solv\fR
3695 \fIrule\fR\fB\&.solv\fR
3701 Back pointer to solver object\&.
3707 \fBId id;\fR /* read only */
3708 \fI$rule\fR\fB\->{id}\fR
3709 \fIrule\fR\fB\&.id\fR
3710 \fIrule\fR\fB\&.id\fR
3716 The id of the rule\&.
3722 \fBint type;\fR /* read only */
3723 \fI$rule\fR\fB\->{type}\fR
3724 \fIrule\fR\fB\&.type\fR
3725 \fIrule\fR\fB\&.type\fR
3731 The basic type of the rule\&. See the constant section of the solver class for the type list\&.
3738 \fBRuleinfo info()\fR
3739 my \fI$ruleinfo\fR \fB=\fR \fI$rule\fR\fB\->info()\fR;
3740 \fIruleinfo\fR \fB=\fR \fIrule\fR\fB\&.info()\fR
3741 \fIruleinfo\fR \fB=\fR \fIrule\fR\fB\&.info()\fR
3747 Return a Ruleinfo object that contains information about why the rule was created\&. But see the allinfos() method below\&.
3753 \fBRuleinfo *allinfos()\fR
3754 my \fI@ruleinfos\fR \fB=\fR \fI$rule\fR\fB\->allinfos()\fR;
3755 \fIruleinfos\fR \fB=\fR \fIrule\fR\fB\&.allinfos()\fR
3756 \fIruleinfos\fR \fB=\fR \fIrule\fR\fB\&.allinfos()\fR
3762 As the same dependency rule can get created because of multiple dependencies, one Ruleinfo is not enough to describe the reason\&. Thus the allinfos() method returns an array of all infos about a rule\&.
3769 \fBif (\fR\fI$rule1\fR \fB==\fR \fI$rule2\fR\fB)\fR
3770 \fBif\fR \fIrule1\fR \fB==\fR \fIrule2\fR\fB:\fR
3771 \fBif\fR \fIrule1\fR \fB==\fR \fIrule2\fR
3777 Two rules are equal if they belong to the same solver and have the same id\&.
3778 .SH "THE RULEINFO CLASS"
3780 A Ruleinfo describes one reason why a rule was created\&.
3787 \fBSolver *solv;\fR /* read only */
3788 \fI$ruleinfo\fR\fB\->{solv}\fR
3789 \fIruleinfo\fR\fB\&.solv\fR
3790 \fIruleinfo\fR\fB\&.solv\fR
3796 Back pointer to solver object\&.
3802 \fBint type;\fR /* read only */
3803 \fI$ruleinfo\fR\fB\->{type}\fR
3804 \fIruleinfo\fR\fB\&.type\fR
3805 \fIruleinfo\fR\fB\&.type\fR
3811 The type of the ruleinfo\&. See the constant section of the solver class for the rule type list and the special type list\&.
3817 \fBDep *dep;\fR /* read only */
3818 \fI$ruleinfo\fR\fB\->{dep}\fR
3819 \fIruleinfo\fR\fB\&.dep\fR
3820 \fIruleinfo\fR\fB\&.dep\fR
3826 The dependency leading to the creation of the rule\&.
3832 \fBDep *dep_id;\fR /* read only */
3833 \fI$ruleinfo\fR\fB\->{\*(Aqdep_id\*(Aq}\fR
3834 \fIruleinfo\fR\fB\&.dep_id\fR
3835 \fIruleinfo\fR\fB\&.dep_id\fR
3841 The Id of the dependency leading to the creation of the rule, or zero\&.
3847 \fBSolvable *solvable;\fR /* read only */
3848 \fI$ruleinfo\fR\fB\->{solvable}\fR
3849 \fIruleinfo\fR\fB\&.solvable\fR
3850 \fIruleinfo\fR\fB\&.solvable\fR
3856 The involved Solvable, e\&.g\&. the one containing the dependency\&.
3862 \fBSolvable *othersolvable;\fR /* read only */
3863 \fI$ruleinfo\fR\fB\->{othersolvable}\fR
3864 \fIruleinfo\fR\fB\&.othersolvable\fR
3865 \fIruleinfo\fR\fB\&.othersolvable\fR
3871 The other involved Solvable (if any), e\&.g\&. the one containing providing the dependency for conflicts\&.
3877 \fBconst char *problemstr()\fR;
3878 my \fI$str\fR \fB=\fR \fI$ruleinfo\fR\fB\->problemstr()\fR;
3879 \fIstr\fR \fB=\fR \fIruleinfo\fR\fB\&.problemstr()\fR
3880 \fIstr\fR \fB=\fR \fIruleinfo\fR\fB\&.problemstr()\fR
3886 A string describing the ruleinfo from a problem perspective\&. This probably only makes sense if the rule is part of a problem\&.
3887 .SH "THE SOLUTION CLASS"
3889 A solution solves one specific problem\&. It consists of multiple solution elements that all need to be executed\&.
3896 \fBSolver *solv;\fR /* read only */
3897 \fI$solution\fR\fB\->{solv}\fR
3898 \fIsolution\fR\fB\&.solv\fR
3899 \fIsolution\fR\fB\&.solv\fR
3905 Back pointer to solver object\&.
3911 \fBId problemid;\fR /* read only */
3912 \fI$solution\fR\fB\->{problemid}\fR
3913 \fIsolution\fR\fB\&.problemid\fR
3914 \fIsolution\fR\fB\&.problemid\fR
3920 Id of the problem the solution solves\&.
3926 \fBId id;\fR /* read only */
3927 \fI$solution\fR\fB\->{id}\fR
3928 \fIsolution\fR\fB\&.id\fR
3929 \fIsolution\fR\fB\&.id\fR
3935 Id of the solution\&. The first solution has Id 1, they are numbered consecutively\&.
3942 \fBSolutionelement *elements(bool\fR \fIexpandreplaces\fR \fB= 0)\fR
3943 my \fI@solutionelements\fR \fB=\fR \fI$solution\fR\fB\->elements()\fR;
3944 \fIsolutionelements\fR \fB=\fR \fIsolution\fR\fB\&.elements()\fR
3945 \fIsolutionelements\fR \fB=\fR \fIsolution\fR\fB\&.elements()\fR
3951 Return an array containing the elements describing what needs to be done to implement the specific solution\&. If expandreplaces is true, elements of type SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace elements describing the policy mismatches\&.
3957 \fBint element_count()\fR
3958 my \fI$cnt\fR \fB=\fR \fI$solution\fR\fB\->solution_count()\fR;
3959 \fIcnt\fR \fB=\fR \fIsolution\fR\fB\&.element_count()\fR
3960 \fIcnt\fR \fB=\fR \fIsolution\fR\fB\&.element_count()\fR
3966 Return the number of solution elements without creating objects\&. Note that the count does not match the number of objects returned by the elements() method of expandreplaces is set to true\&.
3967 .SH "THE SOLUTIONELEMENT CLASS"
3969 A solution element describes a single action of a solution\&. The action is always either to remove one specific job or to add a new job that installs or erases a single specific package\&.
3976 \fBSolver *solv;\fR /* read only */
3977 \fI$solutionelement\fR\fB\->{solv}\fR
3978 \fIsolutionelement\fR\fB\&.solv\fR
3979 \fIsolutionelement\fR\fB\&.solv\fR
3985 Back pointer to solver object\&.
3991 \fBId problemid;\fR /* read only */
3992 \fI$solutionelement\fR\fB\->{problemid}\fR
3993 \fIsolutionelement\fR\fB\&.problemid\fR
3994 \fIsolutionelement\fR\fB\&.problemid\fR
4000 Id of the problem the element (partly) solves\&.
4006 \fBId solutionid;\fR /* read only */
4007 \fI$solutionelement\fR\fB\->{solutionid}\fR
4008 \fIsolutionelement\fR\fB\&.solutionid\fR
4009 \fIsolutionelement\fR\fB\&.solutionid\fR
4015 Id of the solution the element is a part of\&.
4021 \fBId id;\fR /* read only */
4022 \fI$solutionelement\fR\fB\->{id}\fR
4023 \fIsolutionelement\fR\fB\&.id\fR
4024 \fIsolutionelement\fR\fB\&.id\fR
4030 Id of the solution element\&. The first element has Id 1, they are numbered consecutively\&.
4036 \fBId type;\fR /* read only */
4037 \fI$solutionelement\fR\fB\->{type}\fR
4038 \fIsolutionelement\fR\fB\&.type\fR
4039 \fIsolutionelement\fR\fB\&.type\fR
4045 Type of the solution element\&. See the constant section of the solver class for the existing types\&.
4051 \fBSolvable *solvable;\fR /* read only */
4052 \fI$solutionelement\fR\fB\->{solvable}\fR
4053 \fIsolutionelement\fR\fB\&.solvable\fR
4054 \fIsolutionelement\fR\fB\&.solvable\fR
4060 The installed solvable that needs to be replaced for replacement elements\&.
4066 \fBSolvable *replacement;\fR /* read only */
4067 \fI$solutionelement\fR\fB\->{replacement}\fR
4068 \fIsolutionelement\fR\fB\&.replacement\fR
4069 \fIsolutionelement\fR\fB\&.replacement\fR
4075 The solvable that needs to be installed to fix the problem\&.
4081 \fBint jobidx;\fR /* read only */
4082 \fI$solutionelement\fR\fB\->{jobidx}\fR
4083 \fIsolutionelement\fR\fB\&.jobidx\fR
4084 \fIsolutionelement\fR\fB\&.jobidx\fR
4090 The index of the job that needs to be removed to fix the problem, or \-1 if the element is of another type\&. Note that it\(cqs better to change the job to SOLVER_NOOP type so that the numbering of other elements does not get disturbed\&. This method works both for types SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB\&.
4097 \fBSolutionelement *replaceelements()\fR
4098 my \fI@solutionelements\fR \fB=\fR \fI$solutionelement\fR\fB\->replaceelements()\fR;
4099 \fIsolutionelements\fR \fB=\fR \fIsolutionelement\fR\fB\&.replaceelements()\fR
4100 \fIsolutionelements\fR \fB=\fR \fIsolutionelement\fR\fB\&.replaceelements()\fR
4106 If the solution element is of type SOLVER_SOLUTION_REPLACE, return an array of elements describing the policy mismatches, otherwise return a copy of the element\&. See also the \(lqexpandreplaces\(rq option in the solution\(cqs elements() method\&.
4112 \fBint illegalreplace()\fR
4113 my \fI$illegal\fR \fB=\fR \fI$solutionelement\fR\fB\->illegalreplace()\fR;
4114 \fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.illegalreplace()\fR
4115 \fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.illegalreplace()\fR
4121 Return an integer that contains the policy mismatch bits or\-ed together, or zero if there was no policy mismatch\&. See the policy error constants in the solver class\&.
4128 my \fI$job\fR \fB=\fR \fI$solutionelement\fR\fB\->Job()\fR;
4129 \fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.Job()\fR
4130 \fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.Job()\fR
4136 Create a job that implements the solution element\&. Add this job to the array of jobs for all elements of type different to SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB\&. For the later two, a SOLVER_NOOB Job is created, you should replace the old job with the new one\&.
4142 \fBconst char *str()\fR
4143 my \fI$str\fR \fB=\fR \fI$solutionelement\fR\fB\->str()\fR;
4144 \fIstr\fR \fB=\fR \fIsolutionelement\fR\fB\&.str()\fR
4145 \fIstr\fR \fB=\fR \fIsolutionelement\fR\fB\&.str()\fR
4151 A string describing the change the solution element consists of\&.
4152 .SH "THE TRANSACTION CLASS"
4154 Transactions describe the output of a solver run\&. A transaction contains a number of transaction elements, each either the installation of a new package or the removal of an already installed package\&. The Transaction class supports a classify() method that puts the elements into different groups so that a transaction can be presented to the user in a meaningful way\&.
4157 Transaction element types, both active and passive
4159 \fBSOLVER_TRANSACTION_IGNORE\fR
4161 This element does nothing\&. Used to map element types that do not match the view mode\&.
4164 \fBSOLVER_TRANSACTION_INSTALL\fR
4166 This element installs a package\&.
4169 \fBSOLVER_TRANSACTION_ERASE\fR
4171 This element erases a package\&.
4174 \fBSOLVER_TRANSACTION_MULTIINSTALL\fR
4176 This element installs a package with a different version keeping the other versions installed\&.
4179 \fBSOLVER_TRANSACTION_MULTIREINSTALL\fR
4181 This element reinstalls a installed package keeping the other versions installed\&.
4184 Transaction element types, active view
4186 \fBSOLVER_TRANSACTION_REINSTALL\fR
4188 This element re\-installs a package, i\&.e\&. installs the same package again\&.
4191 \fBSOLVER_TRANSACTION_CHANGE\fR
4193 This element installs a package with same name, version, architecture but different content\&.
4196 \fBSOLVER_TRANSACTION_UPGRADE\fR
4198 This element installs a newer version of an installed package\&.
4201 \fBSOLVER_TRANSACTION_DOWNGRADE\fR
4203 This element installs a older version of an installed package\&.
4206 \fBSOLVER_TRANSACTION_OBSOLETES\fR
4208 This element installs a package that obsoletes an installed package\&.
4211 Transaction element types, passive view
4213 \fBSOLVER_TRANSACTION_REINSTALLED\fR
4215 This element re\-installs a package, i\&.e\&. installs the same package again\&.
4218 \fBSOLVER_TRANSACTION_CHANGED\fR
4220 This element replaces an installed package with one of the same name, version, architecture but different content\&.
4223 \fBSOLVER_TRANSACTION_UPGRADED\fR
4225 This element replaces an installed package with a new version\&.
4228 \fBSOLVER_TRANSACTION_DOWNGRADED\fR
4230 This element replaces an installed package with an old version\&.
4233 \fBSOLVER_TRANSACTION_OBSOLETED\fR
4235 This element replaces an installed package with a package that obsoletes it\&.
4238 Pseudo element types for showing extra information used by classify()
4240 \fBSOLVER_TRANSACTION_ARCHCHANGE\fR
4242 This element replaces an installed package with a package of a different architecture\&.
4245 \fBSOLVER_TRANSACTION_VENDORCHANGE\fR
4247 This element replaces an installed package with a package of a different vendor\&.
4250 Transaction mode flags
4252 \fBSOLVER_TRANSACTION_SHOW_ACTIVE\fR
4254 Filter for active view types\&. The default is to return passive view type, i\&.e\&. to show how the installed packages get changed\&.
4257 \fBSOLVER_TRANSACTION_SHOW_OBSOLETES\fR
4259 Do not map the obsolete view type into INSTALL/ERASE elements\&.
4262 \fBSOLVER_TRANSACTION_SHOW_ALL\fR
4264 If multiple packages replace an installed package, only the best of them is kept as OBSOLETE element, the other ones are mapped to INSTALL/ERASE elements\&. This is because most applications want to show just one package replacing the installed one\&. The SOLVER_TRANSACTION_SHOW_ALL makes the library keep all OBSOLETE elements\&.
4267 \fBSOLVER_TRANSACTION_SHOW_MULTIINSTALL\fR
4269 The library maps MULTIINSTALL elements to simple INSTALL elements\&. This flag can be used to disable the mapping\&.
4272 \fBSOLVER_TRANSACTION_CHANGE_IS_REINSTALL\fR
4274 Use this flag if you want to map CHANGE elements to the REINSTALL type\&.
4277 \fBSOLVER_TRANSACTION_OBSOLETE_IS_UPGRADE\fR
4279 Use this flag if you want to map OBSOLETE elements to the UPGRADE type\&.
4282 \fBSOLVER_TRANSACTION_MERGE_ARCHCHANGES\fR
4284 Do not add extra categories for every architecture change, instead cumulate them in one category\&.
4287 \fBSOLVER_TRANSACTION_MERGE_VENDORCHANGES\fR
4289 Do not add extra categories for every vendor change, instead cumulate them in one category\&.
4292 \fBSOLVER_TRANSACTION_RPM_ONLY\fR
4294 Special view mode that just returns IGNORE, ERASE, INSTALL, MULTIINSTALL elements\&. Useful if you want to find out what to feed to the underlying package manager\&.
4297 Transaction order flags
4299 \fBSOLVER_TRANSACTION_KEEP_ORDERDATA\fR
4301 Do not throw away the dependency graph used for ordering the transaction\&. This flag is needed if you want to do manual ordering\&.
4309 \fBPool *pool;\fR /* read only */
4310 \fI$trans\fR\fB\->{pool}\fR
4311 \fItrans\fR\fB\&.pool\fR
4312 \fItrans\fR\fB\&.pool\fR
4318 Back pointer to pool\&.
4325 \fBbool isempty()\fR;
4326 \fI$trans\fR\fB\->isempty()\fR
4327 \fItrans\fR\fB\&.isempty()\fR
4328 \fItrans\fR\fB\&.isempty?\fR
4334 Returns true if the transaction does not do anything, i\&.e\&. has no elements\&.
4340 \fBSolvable *newsolvables()\fR;
4341 my \fI@newsolvables\fR \fB=\fR \fI$trans\fR\fB\->newsolvables()\fR;
4342 \fInewsolvables\fR \fB=\fR \fItrans\fR\fB\&.newsolvables()\fR
4343 \fInewsolvables\fR \fB=\fR \fItrans\fR\fB\&.newsolvables()\fR
4349 Return all packages that are to be installed by the transaction\&. This are the packages that need to be downloaded from the repositories\&.
4355 \fBSolvable *keptsolvables()\fR;
4356 my \fI@keptsolvables\fR \fB=\fR \fI$trans\fR\fB\->keptsolvables()\fR;
4357 \fIkeptsolvables\fR \fB=\fR \fItrans\fR\fB\&.keptsolvables()\fR
4358 \fIkeptsolvables\fR \fB=\fR \fItrans\fR\fB\&.keptsolvables()\fR
4364 Return all installed packages that the transaction will keep installed\&.
4370 \fBSolvable *steps()\fR;
4371 my \fI@steps\fR \fB=\fR \fI$trans\fR\fB\->steps()\fR;
4372 \fIsteps\fR \fB=\fR \fItrans\fR\fB\&.steps()\fR
4373 \fIsteps\fR \fB=\fR \fItrans\fR\fB\&.steps()\fR
4379 Return all solvables that need to be installed (if the returned solvable is not already installed) or erased (if the returned solvable is installed)\&. A step is also called a transaction element\&.
4385 \fBint steptype(Solvable *\fR\fIsolvable\fR\fB, int\fR \fImode\fR\fB)\fR
4386 my \fI$type\fR \fB=\fR \fI$trans\fR\fB\->steptype(\fR\fI$solvable\fR\fB,\fR \fI$mode\fR\fB)\fR;
4387 \fItype\fR \fB=\fR \fItrans\fR\fB\&.steptype(\fR\fIsolvable\fR\fB,\fR \fImode\fR\fB)\fR
4388 \fItype\fR \fB=\fR \fItrans\fR\fB\&.steptype(\fR\fIsolvable\fR\fB,\fR \fImode\fR\fB)\fR
4394 Return the transaction type of the specified solvable\&. See the CONSTANTS sections for the mode argument flags and the list of returned types\&.
4400 \fBTransactionClass *classify(int\fR \fImode\fR \fB= 0)\fR
4401 my \fI@classes\fR \fB=\fR \fI$trans\fR\fB\->classify()\fR;
4402 \fIclasses\fR \fB=\fR \fItrans\fR\fB\&.classify()\fR
4403 \fIclasses\fR \fB=\fR \fItrans\fR\fB\&.classify()\fR
4409 Group the transaction elements into classes so that they can be displayed in a structured way\&. You can use various mapping mode flags to tweak the result to match your preferences, see the mode argument flag in the CONSTANTS section\&. See the TransactionClass class for how to deal with the returned objects\&.
4415 \fBSolvable othersolvable(Solvable *\fR\fIsolvable\fR\fB)\fR;
4416 my \fI$other\fR \fB=\fR \fI$trans\fR\fB\->othersolvable(\fR\fI$solvable\fR\fB)\fR;
4417 \fIother\fR \fB=\fR \fItrans\fR\fB\&.othersolvable(\fR\fIsolvable\fR\fB)\fR
4418 \fIother\fR \fB=\fR \fItrans\fR\fB\&.othersolvable(\fR\fIsolvable\fR\fB)\fR
4424 Return the \(lqother\(rq solvable for a given solvable\&. For installed packages the other solvable is the best package with the same name that replaces the installed package, or the best package of the obsoleting packages if the package does not get replaced by one with the same name\&.
4426 For to be installed packages, the \(lqother\(rq solvable is the best installed package with the same name that will be replaced, or the best packages of all the packages that are obsoleted if the new package does not replace a package with the same name\&.
4428 Thus, the \(lqother\(rq solvable is normally the package that is also shown for a given package\&.
4434 \fBSolvable *allothersolvables(Solvable *\fR\fIsolvable\fR\fB)\fR;
4435 my \fI@others\fR \fB=\fR \fI$trans\fR\fB\->allothersolvables(\fR\fI$solvable\fR\fB)\fR;
4436 \fIothers\fR \fB=\fR \fItrans\fR\fB\&.allothersolvables(\fR\fIsolvable\fR\fB)\fR
4437 \fIothers\fR \fB=\fR \fItrans\fR\fB\&.allothersolvables(\fR\fIsolvable\fR\fB)\fR
4443 For installed packages, returns all of the packages that replace us\&. For to be installed packages, returns all of the packages that the new package replaces\&. The special \(lqother\(rq solvable is always the first entry of the returned array\&.
4449 \fBint calc_installsizechange()\fR;
4450 my \fI$change\fR \fB=\fR \fI$trans\fR\fB\->calc_installsizechange()\fR;
4451 \fIchange\fR \fB=\fR \fItrans\fR\fB\&.calc_installsizechange()\fR
4452 \fIchange\fR \fB=\fR \fItrans\fR\fB\&.calc_installsizechange()\fR
4458 Return the size change of the installed system in kilobytes (kibibytes)\&.
4464 \fBvoid order(int\fR \fIflags\fR \fB= 0)\fR;
4465 \fI$trans\fR\fB\->order()\fR;
4466 \fItrans\fR\fB\&.order()\fR
4467 \fItrans\fR\fB\&.order()\fR
4473 Order the steps in the transactions so that dependant packages are updated before packages that depend on them\&. For rpm, you can also use rpmlib\(cqs ordering functionality, debian\(cqs dpkg does not provide a way to order a transaction\&.
4474 .SS "ACTIVE/PASSIVE VIEW"
4476 Active view list what new packages get installed, while passive view shows what happens to the installed packages\&. Most often there\(cqs not much difference between the two modes, but things get interesting of multiple package get replaced by one new package\&. Say you have installed package A\-1\-1 and B\-1\-1, and now install A\-2\-1 with has a new dependency that obsoletes B\&. The transaction elements will be
4482 updated A\-1\-1 (other: A\-2\-1)
4483 obsoleted B\-1\-1 (other: A\-2\-1)
4489 in passive mode, but
4495 update A\-2\-1 (other: A\-1\-1)
4502 in active mode\&. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the passive mode list will be unchanged but the active mode list will just contain A\-2\-1\&.
4503 .SH "THE TRANSACTIONCLASS CLASS"
4505 Objects of this type are returned by the classify() Transaction method\&.
4512 \fBTransaction *transaction;\fR /* read only */
4513 \fI$class\fR\fB\->{transaction}\fR
4514 \fIclass\fR\fB\&.transaction\fR
4515 \fIclass\fR\fB\&.transaction\fR
4521 Back pointer to transaction object\&.
4527 \fBint type;\fR /* read only */
4528 \fI$class\fR\fB\->{type}\fR
4529 \fIclass\fR\fB\&.type\fR
4530 \fIclass\fR\fB\&.type\fR
4536 The type of the transaction elements in the class\&.
4542 \fBint count;\fR /* read only */
4543 \fI$class\fR\fB\->{count}\fR
4544 \fIclass\fR\fB\&.count\fR
4545 \fIclass\fR\fB\&.count\fR
4551 The number of elements in the class\&.
4557 \fBconst char *\fR\fIfromstr\fR;
4558 \fI$class\fR\fB\->{fromstr}\fR
4559 \fIclass\fR\fB\&.fromstr\fR
4560 \fIclass\fR\fB\&.fromstr\fR
4566 The old vendor or architecture\&.
4572 \fBconst char *\fR\fItostr\fR;
4573 \fI$class\fR\fB\->{tostr}\fR
4574 \fIclass\fR\fB\&.tostr\fR
4575 \fIclass\fR\fB\&.tostr\fR
4581 The new vendor or architecture\&.
4587 \fBId\fR \fIfromid\fR;
4588 \fI$class\fR\fB\->{fromid}\fR
4589 \fIclass\fR\fB\&.fromid\fR
4590 \fIclass\fR\fB\&.fromid\fR
4596 The id of the old vendor or architecture\&.
4602 \fBId\fR \fItoid\fR;
4603 \fI$class\fR\fB\->{toid}\fR
4604 \fIclass\fR\fB\&.toid\fR
4605 \fIclass\fR\fB\&.toid\fR
4611 The id of the new vendor or architecture\&.
4618 \fBvoid solvables()\fR;
4619 my \fI@solvables\fR \fB=\fR \fI$class\fR\fB\->solvables()\fR;
4620 \fIsolvables\fR \fB=\fR \fIclass\fR\fB\&.solvables()\fR
4621 \fIsolvables\fR \fB=\fR \fIclass\fR\fB\&.solvables()\fR
4627 Return the solvables for all transaction elements in the class\&.
4630 Checksums (also called hashes) are used to make sure that downloaded data is not corrupt and also as a fingerprint mechanism to check if data has changed\&.
4637 \fBChksum Chksum(Id\fR \fItype\fR\fB)\fR
4638 my \fI$chksum\fR \fB= solv::Chksum\->new(\fR\fI$type\fR\fB)\fR;
4639 \fIchksum\fR \fB= solv\&.Chksum(\fR\fItype\fR\fB)\fR
4640 \fIchksum\fR \fB= Solv::Chksum\&.new(\fR\fItype\fR\fB)\fR
4646 Create a checksum object\&. Currently the following types are supported:
4652 \fBREPOKEY_TYPE_MD5\fR
4653 \fBREPOKEY_TYPE_SHA1\fR
4654 \fBREPOKEY_TYPE_SHA256\fR
4660 These keys are constants in the \fBsolv\fR class\&.
4666 \fBChksum Chksum(Id\fR \fItype\fR\fB, const char *\fR\fIhex\fR\fB)\fR
4667 my \fI$chksum\fR \fB= solv::Chksum\->new(\fR\fI$type\fR\fB,\fR \fI$hex\fR\fB)\fR;
4668 \fIchksum\fR \fB= solv\&.Chksum(\fR\fItype\fR\fB,\fR \fIhex\fR\fB)\fR
4669 \fIchksum\fR \fB= Solv::Chksum\&.new(\fR\fItype\fR\fB,\fR \fIhex\fR\fB)\fR
4675 Create an already finalized checksum object\&.
4682 \fBId type;\fR /* read only */
4683 \fI$chksum\fR\fB\->{type}\fR
4684 \fIchksum\fR\fB\&.type\fR
4685 \fIchksum\fR\fB\&.type\fR
4691 Return the type of the checksum object\&.
4698 \fBvoid add(const char *\fR\fIstr\fR\fB)\fR
4699 \fI$chksum\fR\fB\->add(\fR\fI$str\fR\fB)\fR;
4700 \fIchksum\fR\fB\&.add(\fR\fIstr\fR\fB)\fR
4701 \fIchksum\fR\fB\&.add(\fR\fIstr\fR\fB)\fR
4707 Add a string to the checksum\&.
4713 \fBvoid add_fp(FILE *\fR\fIfp\fR\fB)\fR
4714 \fI$chksum\fR\fB\->add_fp(\fR\fI$file\fR\fB)\fR;
4715 \fIchksum\fR\fB\&.add_fp(\fR\fIfile\fR\fB)\fR
4716 \fIchksum\fR\fB\&.add_fp(\fR\fIfile\fR\fB)\fR
4722 Add the contents of a file to the checksum\&.
4728 \fBvoid add_stat(const char *\fR\fIfilename\fR\fB)\fR
4729 \fI$chksum\fR\fB\->add_stat(\fR\fI$filename\fR\fB)\fR;
4730 \fIchksum\fR\fB\&.add_stat(\fR\fIfilename\fR\fB)\fR
4731 \fIchksum\fR\fB\&.add_stat(\fR\fIfilename\fR\fB)\fR
4737 Stat the file and add the dev/ino/size/mtime member to the checksum\&. If the stat fails, the members are zeroed\&.
4743 \fBvoid add_fstat(int\fR \fIfd\fR\fB)\fR
4744 \fI$chksum\fR\fB\->add_fstat(\fR\fI$fd\fR\fB)\fR;
4745 \fIchksum\fR\fB\&.add_fstat(\fR\fIfd\fR\fB)\fR
4746 \fIchksum\fR\fB\&.add_fstat(\fR\fIfd\fR\fB)\fR
4752 Same as add_stat, but instead of the filename a file descriptor is used\&.
4758 \fBunsigned char *raw()\fR
4759 my \fI$raw\fR \fB=\fR \fI$chksum\fR\fB\->raw()\fR;
4760 \fIraw\fR \fB=\fR \fIchksum\fR\fB\&.raw()\fR
4761 \fIraw\fR \fB=\fR \fIchksum\fR\fB\&.raw()\fR
4767 Finalize the checksum and return the result as raw bytes\&. This means that the result can contain NUL bytes or unprintable characters\&.
4773 \fBconst char *hex()\fR
4774 my \fI$raw\fR \fB=\fR \fI$chksum\fR\fB\->hex()\fR;
4775 \fIraw\fR \fB=\fR \fIchksum\fR\fB\&.hex()\fR
4776 \fIraw\fR \fB=\fR \fIchksum\fR\fB\&.hex()\fR
4782 Finalize the checksum and return the result as hex string\&.
4789 \fBif (\fR\fI$chksum1\fR \fB==\fR \fI$chksum2\fR\fB)\fR
4790 \fBif\fR \fIchksum1\fR \fB==\fR \fIchksum2\fR\fB:\fR
4791 \fBif\fR \fIchksum1\fR \fB==\fR \fIchksum2\fR
4797 Checksums are equal if they are of the same type and the finalized results are the same\&.
4803 \fB<stringification>\fR
4804 my \fI$str\fR \fB=\fR \fI$chksum\fR\fB\->str\fR;
4805 \fIstr\fR \fB= str(\fR\fIchksum\fR\fB)\fR
4806 \fIstr\fR \fB=\fR \fIchksum\fR\fB\&.to_s\fR
4812 If the checksum is finished, the checksum is returned as "<type>:<hex>" string\&. Otherwise "<type>:unfinished" is returned\&.
4813 .SH "FILE MANAGEMENT"
4815 This functions were added because libsolv uses standard \fBFILE\fR pointers to read/write files, but languages like perl have their own implementation of files\&. The libsolv functions also support decompression and compression, the algorithm is selected by looking at the file name extension\&.
4821 \fBFILE *xfopen(char *\fR\fIfn\fR\fB, char *\fR\fImode\fR \fB= "r")\fR
4822 my \fI$file\fR \fB= solv::xfopen(\fR\fI$path\fR\fB)\fR;
4823 \fIfile\fR \fB= solv\&.xfopen(\fR\fIpath\fR\fB)\fR
4824 \fIfile\fR \fB= Solv::xfopen(\fR\fIpath\fR\fB)\fR
4830 Open a file at the specified path\&. The mode argument is passed on to the stdio library\&.
4836 \fBFILE *xfopen_fd(char *\fR\fIfn\fR\fB, int\fR \fIfileno\fR\fB)\fR
4837 my \fI$file\fR \fB= solv::xfopen_fd(\fR\fI$path\fR\fB,\fR \fI$fileno\fR\fB)\fR;
4838 \fIfile\fR \fB= solv\&.xfopen_fd(\fR\fIpath\fR\fB,\fR \fIfileno\fR\fB)\fR
4839 \fIfile\fR \fB= Solv::xfopen_fd(\fR\fIpath\fR\fB,\fR \fIfileno\fR\fB)\fR
4845 Create a file handle from the specified file descriptor\&. The path argument is only used to select the correct (de\-)compression algorithm, use an empty path if you want to make sure to read/write raw data\&.
4853 my \fI$fileno\fR \fB=\fR \fI$file\fR\fB\->fileno()\fR;
4854 \fIfileno\fR \fB=\fR \fIfile\fR\fB\&.fileno()\fR
4855 \fIfileno\fR \fB=\fR \fIfile\fR\fB\&.fileno()\fR
4861 Return file file descriptor of the file\&. If the file is not open, \-1 is returned\&.
4868 my \fI$fileno\fR \fB=\fR \fI$file\fR\fB\->dup()\fR;
4869 \fIfileno\fR \fB=\fR \fIfile\fR\fB\&.dup()\fR
4870 \fIfileno\fR \fB=\fR \fIfile\fR\fB\&.dup()\fR
4876 Return a copy of the descriptor of the file\&. If the file is not open, \-1 is returned\&.
4883 \fI$file\fR\fB\->flush()\fR;
4884 \fIfile\fR\fB\&.flush()\fR
4885 \fIfile\fR\fB\&.flush()\fR
4891 Flush the file\&. Returns false if there was an error\&. Flushing a closed file always returns true\&.
4898 \fI$file\fR\fB\->close()\fR;
4899 \fIfile\fR\fB\&.close()\fR
4900 \fIfile\fR\fB\&.close()\fR
4906 Close the file\&. This is needed for languages like Ruby, that do not destruct objects right after they are no longer referenced\&. In that case, it is good style to close open files so that the file descriptors are freed right away\&. Returns false if there was an error\&.
4907 .SH "THE REPODATA CLASS"
4909 The Repodata stores attributes for packages and the repository itself, each repository can have multiple repodata areas\&. You normally only need to directly access them if you implement lazy downloading of repository data\&. Repodata areas are created by calling the repository\(cqs add_repodata() method or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING flag\&.
4916 \fBRepo *repo;\fR /* read only */
4917 \fI$data\fR\fB\->{repo}\fR
4918 \fIdata\fR\fB\&.repo\fR
4919 \fIdata\fR\fB\&.repo\fR
4925 Back pointer to repository object\&.
4931 \fBId id;\fR /* read only */
4932 \fI$data\fR\fB\->{id}\fR
4933 \fIdata\fR\fB\&.id\fR
4934 \fIdata\fR\fB\&.id\fR
4940 The id of the repodata area\&. Repodata ids of different repositories overlap\&.
4947 \fBinternalize()\fR;
4948 \fI$data\fR\fB\->internalize()\fR;
4949 \fIdata\fR\fB\&.internalize()\fR
4950 \fIdata\fR\fB\&.internalize()\fR
4956 Internalize newly added data\&. The lookup functions will only see the new data after it has been internalized\&.
4962 \fBbool write(FILE *\fR\fIfp\fR\fB)\fR;
4963 \fI$data\fR\fB\->write(\fR\fI$fp\fR\fB)\fR;
4964 \fIdata\fR\fB\&.write(\fR\fIfp\fR\fB)\fR
4965 \fIdata\fR\fB\&.write(\fR\fIfp\fR\fB)\fR
4971 Write the contents of the repodata area as solv file\&.
4977 \fBbool add_solv(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR;
4978 \fI$data\fR\fB\->add_solv(\fR\fI$fp\fR\fB)\fR;
4979 \fIdata\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR
4980 \fIdata\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR
4986 Replace a stub repodata object with the data from a solv file\&. This method automatically adds the REPO_USE_LOADING flag\&. It should only be used from a load callback\&.
4992 \fBvoid create_stubs()\fR;
4993 \fI$data\fR\fB\->create_stubs()\fR
4994 \fIdata\fR\fB\&.create_stubs()\fR
4995 \fIdata\fR\fB\&.create_stubs()\fR
5001 Create stub repodatas from the information stored in the repodata meta area\&.
5007 \fBvoid extend_to_repo()\fR;
5008 \fI$data\fR\fB\->extend_to_repo()\fR;
5009 \fIdata\fR\fB\&.extend_to_repo()\fR
5010 \fIdata\fR\fB\&.extend_to_repo()\fR
5016 Extend the repodata so that it has the same size as the repo it belongs to\&. This method is only needed when switching to a just written repodata extension to make the repodata match the written extension (which is always of the size of the repo)\&.
5023 \fBif (\fR\fI$data1\fR \fB==\fR \fI$data2\fR\fB)\fR
5024 \fBif\fR \fIdata1\fR \fB==\fR \fIdata2\fR\fB:\fR
5025 \fBif\fR \fIdata1\fR \fB==\fR \fIdata2\fR
5031 Two repodata objects are equal if they belong to the same repository and have the same id\&.
5032 .SS "DATA RETRIEVAL METHODS"
5038 \fBconst char *lookup_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
5039 my \fI$string\fR \fB=\fR \fI$data\fR\fB\->lookup_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
5040 \fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5041 \fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5051 \fBId *lookup_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
5052 my \fI@ids\fR \fB=\fR \fI$data\fR\fB\->lookup_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
5053 \fIids\fR \fB=\fR \fIdata\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5054 \fIids\fR \fB=\fR \fIdata\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5064 \fBChksum lookup_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
5065 my \fI$chksum\fR \fB=\fR \fI$data\fR\fB\->lookup_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR;
5066 \fIchksum\fR \fB=\fR \fIdata\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5067 \fIchksum\fR \fB=\fR \fIdata\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR
5073 Lookup functions\&. Return the data element stored in the specified solvable\&. The methods probably only make sense to retrieve data from the special SOLVID_META solvid that stores repodata meta information\&.
5074 .SS "DATA STORAGE METHODS"
5080 \fBvoid set_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, DepId\fR \fIid\fR\fB)\fR;
5081 \fI$data\fR\fB\->set_id(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$id\fR\fB)\fR;
5082 \fIdata\fR\fB\&.set_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR
5083 \fIdata\fR\fB\&.set_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR
5093 \fBvoid set_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fIstr\fR\fB)\fR;
5094 \fI$data\fR\fB\->set_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$str\fR\fB)\fR;
5095 \fIdata\fR\fB\&.set_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR
5096 \fIdata\fR\fB\&.set_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR
5106 \fBvoid set_poolstr(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fIstr\fR\fB)\fR;
5107 \fI$data\fR\fB\->set_poolstr(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$str\fR\fB)\fR;
5108 \fIdata\fR\fB\&.set_poolstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR
5109 \fIdata\fR\fB\&.set_poolstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR
5119 \fBvoid set_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Chksum *\fR\fIchksum\fR\fB)\fR;
5120 \fI$data\fR\fB\->set_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$chksum\fR\fB)\fR;
5121 \fIdata\fR\fB\&.set_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIchksum\fR\fB)\fR
5122 \fIdata\fR\fB\&.set_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIchksum\fR\fB)\fR
5132 \fBvoid add_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, DepId\fR \fIid\fR\fB)\fR;
5133 \fI$data\fR\fB\->add_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$id\fR\fB)\fR;
5134 \fIdata\fR\fB\&.add_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR
5135 \fIdata\fR\fB\&.add_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR
5145 \fBId new_handle()\fR;
5146 my \fI$handle\fR \fB=\fR \fI$data\fR\fB\->new_handle()\fR;
5147 \fIhandle\fR \fB=\fR \fIdata\fR\fB\&.new_handle()\fR
5148 \fIhandle\fR \fB=\fR \fIdata\fR\fB\&.new_handle()\fR
5158 \fBvoid add_flexarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fIhandle\fR\fB)\fR;
5159 \fI$data\fR\fB\->add_flexarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$handle\fR\fB)\fR;
5160 \fIdata\fR\fB\&.add_flexarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIhandle\fR\fB)\fR
5161 \fIdata\fR\fB\&.add_flexarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIhandle\fR\fB)\fR
5167 Data storage methods\&. Probably only useful to store data in the special SOLVID_META solvid that stores repodata meta information\&. Note that repodata areas can have their own Id pool (see the REPO_LOCALPOOL flag), so be careful if you need to store ids\&. Arrays are created by calling the add function for every element\&. A flexarray is an array of sub\-structures, call new_handle to create a new structure, use the handle as solvid to fill the structure with data and call add_flexarray to put the structure in an array\&.
5168 .SH "THE DATAPOS CLASS"
5170 Datapos objects describe a specific position in the repository data area\&. Thus they are only valid until the repository is modified in some way\&. Datapos objects can be created by the pos() and parentpos() methods of a Datamatch object or by accessing the \(lqmeta\(rq attribute of a repository\&.
5177 \fBRepo *repo;\fR /* read only */
5178 \fI$data\fR\fB\->{repo}\fR
5179 \fIdata\fR\fB\&.repo\fR
5180 \fIdata\fR\fB\&.repo\fR
5186 Back pointer to repository object\&.
5193 \fBDataiterator(Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR
5194 my \fI$di\fR \fB=\fR \fI$datapos\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR;
5195 \fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
5196 \fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR
5202 Create a Dataiterator at the position of the datapos object\&.
5208 \fBconst char *lookup_deltalocation(unsigned int *\fR\fIOUTPUT\fR\fB)\fR;
5209 my \fB(\fR\fI$location\fR\fB,\fR \fI$medianr\fR\fB) =\fR \fI$datapos\fR\fB\->lookup_deltalocation()\fR;
5210 \fIlocation\fR\fB,\fR \fImedianr\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltalocation()\fR
5211 \fIlocation\fR\fB,\fR \fImedianr\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltalocation()\fR
5217 Return a tuple containing the on\-media location and an optional media number for a delta rpm\&. This obviously only works if the data position points to structure describing a delta rpm\&.
5223 \fBconst char *lookup_deltaseq()\fR;
5224 my \fI$seq\fR \fB=\fR \fI$datapos\fR\fB\->lookup_deltaseq()\fR;
5225 \fIseq\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltaseq()\fR;
5226 \fIseq\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltaseq()\fR;
5232 Return the delta rpm sequence from the structure describing a delta rpm\&.
5233 .SS "DATA RETRIEVAL METHODS"
5239 \fBconst char *lookup_str(Id\fR \fIkeyname\fR\fB)\fR
5240 my \fI$string\fR \fB=\fR \fI$datapos\fR\fB\->lookup_str(\fR\fI$keyname\fR\fB)\fR;
5241 \fIstring\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR
5242 \fIstring\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR
5252 \fBId lookup_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR
5253 my \fI$id\fR \fB=\fR \fI$datapos\fR\fB\->lookup_id(\fR\fI$keyname\fR\fB)\fR;
5254 \fIid\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR
5255 \fIid\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR
5265 \fBunsigned long long lookup_num(Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR
5266 my \fI$num\fR \fB=\fR \fI$datapos\fR\fB\->lookup_num(\fR\fI$keyname\fR\fB)\fR;
5267 \fInum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR
5268 \fInum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR
5278 \fBbool lookup_void(Id\fR \fIkeyname\fR\fB)\fR
5279 my \fI$bool\fR \fB=\fR \fI$datapos\fR\fB\->lookup_void(\fR\fI$keyname\fR\fB)\fR;
5280 \fIbool\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR
5281 \fIbool\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR
5291 \fBId *lookup_idarray(Id\fR \fIkeyname\fR\fB)\fR
5292 my \fI@ids\fR \fB=\fR \fI$datapos\fR\fB\->lookup_idarray(\fR\fI$keyname\fR\fB)\fR;
5293 \fIids\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR
5294 \fIids\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR
5304 \fBChksum lookup_checksum(Id\fR \fIkeyname\fR\fB)\fR
5305 my \fI$chksum\fR \fB=\fR \fI$datapos\fR\fB\->lookup_checksum(\fR\fI$keyname\fR\fB)\fR;
5306 \fIchksum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR
5307 \fIchksum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR
5313 Lookup functions\&. Note that the returned Ids are always translated into the Ids of the global pool even if the repodata area contains its own pool\&.
5316 Michael Schroeder <mls@suse\&.de>
projects / platform / upstream / libsolv.git / blob