doc/libsolv-bindings.txt

   1 Libsolv-Bindings(3)
   2 ===================
   3 :man manual: LIBSOLV
   4 :man source: libsolv
   5
   6
   7 Name
   8 ----
   9 libsolv-bindings - access libsolv from perl/python/ruby
  10
  11
  12 Description
  13 -----------
  14 Libsolv's language bindings offer an abstract, object orientated interface
  15 to the library. The supported languages are currently perl, python, and ruby.
  16 All example code (except in the specifics sections, of course) lists first
  17 the ``C-ish'' interface, then the syntax for perl, python, and ruby (in that
  18 order).
  19
  20
  21 Perl Specifics
  22 --------------
  23 Libsolv's perl bindings can be loaded with the following statement:
  24
  25         use solv;
  26
  27 Objects are either created by calling the new() method on a class or they
  28 are returned by calling methods on other objects.
  29
  30         my $pool = solv::Pool->new();
  31         my $repo = $pool->add_repo("my_first_repo");
  32
  33 Swig encapsulates all objects as tied hashes, thus the attributes can be
  34 accessed by treating the object as standard hash reference:
  35
  36         $pool->{appdata} = 42;
  37         printf "appdata is %d\n", $pool->{appdata};
  38
  39 A special exception to this are iterator objects, they are encapsulated as
  40 tied arrays so that it is possible to iterate with a for() statement:
  41
  42         my $iter = $pool->solvables_iter();
  43         for my $solvable (@$iter) { ... };
  44
  45 As a downside of this approach, iterator objects cannot have attributes.
  46
  47 If an array needs to be passed to a method it is usually done by reference,
  48 if a method returns an array it returns it on the stack:
  49
  50         my @problems = $solver->solve(\@jobs);
  51
  52 Due to a bug in swig, stringification does not work for libsolv's objects.
  53 Instead, you have to call the object's str() method.
  54
  55         print $dep->str() . "\n";
  56
  57 Swig implements all constants as numeric variables (instead of the more
  58 natural constant subs), so don't forget the leading ``$'' when accessing a
  59 constant. Also do not forget to prepend the namespace of the constant:
  60
  61         $pool->set_flag($solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1);
  62
  63
  64 Python Specifics
  65 ----------------
  66 The python bindings can be loaded with:
  67
  68         import solv
  69
  70 Objects are either created by calling the constructor method for a class or they
  71 are returned by calling methods on other objects.
  72
  73         pool = solv.Pool()
  74         repo = pool.add_repo("my_first_repo")
  75
  76 Attributes can be accessed as usual:
  77
  78         pool.appdata = 42
  79         print "appdata is %d" % (pool.appdata)
  80
  81 Iterators also work as expected:
  82
  83         for solvable in pool.solvables_iter():
  84
  85 Arrays are passed and returned as list objects:
  86
  87         jobs = []
  88         problems = solver.solve(jobs)
  89
  90 The bindings define stringification for many classes, some also have a
  91 __repr__ method to ease debugging.
  92
  93         print dep
  94         print repr(repo)
  95
  96 Constants are attributes of the classes:
  97
  98         pool.set_flag(solv.Pool.POOL_FLAG_OBSOLETEUSESCOLORS, 1);
  99
 100
 101 Ruby Specifics
 102 --------------
 103 The ruby bindings can be loaded with:
 104
 105         require 'solv'
 106
 107 Objects are either created by calling the new method on a class or they
 108 are returned by calling methods on other objects. Note that all classes start
 109 with an uppercase letter in ruby, so the class is called ``Solv''.
 110
 111         pool = Solv::Pool.new
 112         repo = pool.add_repo("my_first_repo")
 113
 114 Attributes can be accessed as usual:
 115
 116         pool.appdata = 42
 117         puts "appdata is #{pool.appdata}"
 118
 119 Iterators also work as expected:
 120
 121         for solvable in pool.solvables_iter() do ...
 122
 123 Arrays are passed and returned as array objects:
 124
 125         jobs = []
 126         problems = solver.solve(jobs)
 127
 128 Most classes define a to_s method, so objects can be easily stringified.
 129 Many also define an inspect() method.
 130
 131         puts dep
 132         puts repo.inspect
 133
 134 Constants live in the namespace of the class they belong to:
 135
 136         pool.set_flag(Solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1);
 137
 138 Note that boolean methods have an added trailing ``?'', to be consistent with
 139 other ruby modules:
 140
 141         puts "empty repo" if repo.isempty?
 142
 143
 144 The Solv Class
 145 --------------
 146 This is the main namespace of the library, you cannot create objects of this
 147 type but it contains some useful constants.
 148
 149 === CONSTANTS ===
 150
 151 Relational flag constants, the first three can be or-ed together
 152
 153 *REL_LT*::
 154 the ``less than'' bit
 155
 156 *REL_EQ*::
 157 the ``equals to'' bit
 158
 159 *REL_GT*::
 160 the ``greater then'' bit
 161
 162 *REL_ARCH*::
 163 used for relations that describe an extra architecture filter, the
 164 version part of the relation is interpreted as architecture.
 165
 166 Special Solvable Ids
 167
 168 *SOLVID_META*::
 169 Access the meta section of a repository or repodata area. This is
 170 like an extra Solvable that has the Id SOLVID_META.
 171
 172 *SOLVID_POS*::
 173 Use the data position stored inside of the pool instead of accessing
 174 some solvable by Id. The bindings have the Datapos objects as an
 175 abstraction mechanism, so you do not need this constant.
 176
 177 Constant string Ids
 178
 179 *ID_NULL*::
 180 Always zero
 181
 182 *ID_EMPTY*::
 183 Always one, describes the empty string
 184
 185 *SOLVABLE_NAME*::
 186 The keyname Id of the name of the solvable.
 187
 188 *...*::
 189 see the libsolv-constantids manpage for a list of fixed Ids.
 190
 191
 192 The Pool Class
 193 --------------
 194 The pool is libsolv's central resource manager. A pool consists of Solvables,
 195 Repositories, Dependencies, each indexed by Ids.
 196
 197 === CLASS METHODS ===
 198
 199         Pool *Pool()
 200         my $pool = solv::Pool->new();
 201         pool = solv.Pool()
 202         pool = Solv::Pool.new()
 203
 204 Create a new pool instance. In most cases you just need
 205 one pool.
 206
 207 === ATTRIBUTES ===
 208
 209         void *appdata;                  /* read/write */
 210         $pool->{appdata}
 211         pool.appdata
 212         pool.appdata
 213
 214 Application specific data that may be used in any way by the code using the
 215 pool.
 216
 217         Solvable solvables[];           /* read only */
 218         my $solvable = $pool->{solvables}->[$solvid];
 219         solvable = pool.solvables[solvid]
 220         solvable = pool.solvables[solvid]
 221
 222 Look up a Solvable by its id.
 223
 224         Repo repos[];                   /* read only */
 225         my $repo = $pool->{repos}->[$repoid];
 226         repo = pool.repos[repoid]
 227         repo = pool.repos[repoid]
 228
 229 Look up a Repository by its id.
 230
 231         Repo *installed;                /* read/write */
 232         $pool->{installed} = $repo;
 233         pool.installed = repo
 234         pool.installed = repo
 235
 236 Define which repository contains all the installed packages.
 237
 238         const char *errstr;             /* read only */
 239         my $err = $pool->{errstr};
 240         err = pool.errstr
 241         err = pool.errstr
 242
 243 Return the last error string that was stored in the pool.
 244
 245 === CONSTANTS ===
 246
 247 *POOL_FLAG_PROMOTEEPOCH*::
 248 Promote the epoch of the providing dependency to the requesting
 249 dependency if it does not contain an epoch. Used at some time
 250 in old rpm versions, modern systems should never need this.
 251
 252 *POOL_FLAG_FORBIDSELFCONFLICTS*::
 253 Disallow the installation of packages that conflict with themselves.
 254 Debian always allows self-conflicting packages, rpm used to forbid
 255 them but switched to also allowing them recently.
 256
 257 *POOL_FLAG_OBSOLETEUSESPROVIDES*::
 258 Make obsolete type dependency match against provides instead of
 259 just the name and version of packages. Very old versions of rpm
 260 used the name/version, then it got switched to provides and later
 261 switched back again to just name/version.
 262
 263 *POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES*::
 264 An implicit obsoletes is the internal mechanism to remove the
 265 old package on an update. The default is to remove all packages
 266 with the same name, rpm-5 switched to also removing packages
 267 providing the same name.
 268
 269 *POOL_FLAG_OBSOLETEUSESCOLORS*::
 270 Rpm's multilib implementation (used in RedHat and Fedora)
 271 distinguishes between 32bit and 64bit packages (the terminology
 272 is that they have a different color). If obsoleteusescolors is
 273 set, packages with different colors will not obsolete each other.
 274
 275 *POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS*::
 276 Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if
 277 packages of the same name can be installed in parallel. For
 278 current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be
 279 false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true
 280 (this is the default if FEDORA is defined when libsolv is compiled).
 281
 282 *POOL_FLAG_NOINSTALLEDOBSOLETES*::
 283 New versions of rpm consider the obsoletes of installed packages
 284 when checking for dependency, thus you may not install a package
 285 that is obsoleted by some other installed package, unless you
 286 also erase the other package.
 287
 288 *POOL_FLAG_HAVEDISTEPOCH*::
 289 Mandriva added a new field called distepoch that gets checked in
 290 version comparison if the epoch/version/release of two packages
 291 are the same.
 292
 293 *POOL_FLAG_NOOBSOLETESMULTIVERSION*::
 294 If a package is installed in multiversionmode, rpm used to ignore
 295 both the implicit obsoletes and the obsolete dependency of a
 296 package. This was changed to ignoring just the implicit obsoletes,
 297 thus you may install multiple versions of the same name, but
 298 obsoleted packages still get removed.
 299
 300 *POOL_FLAG_ADDFILEPROVIDESFILTERED*::
 301 Make the addfileprovides method only add files from the standard
 302 locations (i.e. the ``bin'' and ``etc'' directories). This is
 303 useful if you have only few packages that use non-standard file
 304 dependencies, but you still wand the fast speed that addfileprovides()
 305 generates.
 306
 307 === METHODS ===
 308
 309         void free()
 310         $pool->free();
 311         pool.free()
 312         pool.free()
 313
 314 Free a pool. This is currently done with a method instead of relying on
 315 reference counting or garbage collection because it's hard to track every
 316 reference to a pool.
 317
 318         void setdebuglevel(int level)
 319         $pool->setdebuglevel($level);
 320         pool.setdebuglevel(level)
 321         pool.setdebuglevel(level)
 322
 323 Set the debug level. A value of zero means no debug output, the higher the
 324 value, the more output is generated.
 325
 326         int set_flag(int flag, int value)
 327         my $oldvalue = $pool->set_flag($flag, $value);
 328         oldvalue = pool.set_flag(flag, value)
 329         oldvalue = pool.set_flag(flag, value)
 330
 331         int get_flag(int flag)
 332         my $value = $pool->get_flag($flag);
 333         value = pool.get_flag(flag)
 334         value = pool.get_flag(flag)
 335
 336 Set/get a pool specific flag. The flags define how the system works, e.g. how
 337 the package manager treats obsoletes. The default flags should be sane for most
 338 applications, but in some cases you may want to tweak a flag, for example if
 339 you want to solv package dependencies for some other system than yours.
 340
 341         void set_rootdir(const char *rootdir)
 342         $pool->set_rootdir(rootdir);
 343         pool.set_rootdir(rootdir)
 344         pool.set_rootdir(rootdir)
 345
 346         const char *get_rootdir()
 347         my $rootdir = $pool->get_rootdir();
 348         rootdir = pool.get_rootdir()
 349         rootdir = pool.get_rootdir()
 350
 351 Set/get the rootdir to use. This is useful if you want package management
 352 to work only in some directory, for example if you want to setup a chroot
 353 jail. Note that the rootdir will only be prepended to file paths if the
 354 *REPO_USE_ROOTDIR* flag is used.
 355
 356         void setarch(const char *arch = 0)
 357         $pool->setarch();
 358         pool.setarch()
 359         pool.setarch()
 360
 361 Set the architecture for your system. The architecture is used to determine
 362 which packages are installable. It defaults to the result of ``uname -m''.
 363
 364         Repo add_repo(const char *name)
 365         $repo = $pool->add_repo($name);
 366         repo = pool.add_repo(name)
 367         repo = pool.add_repo(name)
 368
 369 Add a Repository with the specified name to the pool. The repository is empty
 370 on creation, use the repository methods to populate it with packages.
 371
 372         Repoiterator repos_iter()
 373         for my $repo (@{$pool->repos_iter()})
 374         for repo in pool.repos_iter():
 375         for repo in pool.repos_iter()
 376
 377 Iterate over the existing repositories.
 378
 379         Solvableiterator solvables_iter()
 380         for my $solvable (@{$pool->solvables_iter()})
 381         for solvable in pool.solvables_iter():
 382         for solvable in pool.solvables_iter()
 383
 384 Iterate over the existing solvables.
 385
 386         Dep Dep(const char *str, bool create = 1)
 387         my $dep = $pool->Dep($string);
 388         dep = pool.Dep(string)
 389         dep = pool.Dep(string)
 390
 391 Create an object describing a string or dependency. If the string is currently
 392 not in the pool and _create_ is false, *undef*/*None*/*nil* is returned.
 393
 394         void addfileprovides()
 395         $pool->addfileprovides();
 396         pool.addfileprovides()
 397         pool.addfileprovides()
 398
 399         Id *addfileprovides_queue()
 400         my @ids = $pool->addfileprovides_queue();
 401         ids = pool.addfileprovides_queue()
 402         ids = pool.addfileprovides_queue()
 403
 404 Some package managers like rpm allow dependencies on files contained in other
 405 packages. To allow libsolv to deal with those dependencies in an efficient way,
 406 you need to call the addfileprovides method after creating and reading all
 407 repositories. This method will scan all dependency for file names and than scan
 408 all packages for matching files. If a filename has been matched, it will be
 409 added to the provides list of the corresponding package. The
 410 addfileprovides_queue variant works the same way but returns an array
 411 containing all file dependencies. This information can be stored in the
 412 meta section of the repositories to speed up the next time the
 413 repository is loaded and addfileprovides is called.
 414
 415         void createwhatprovides()
 416         $pool->createwhatprovides();
 417         pool.createwhatprovides()
 418         pool.createwhatprovides()
 419
 420 Create the internal ``whatprovides'' hash over all of the provides of all
 421 packages. This method must be called before doing any lookups on provides.
 422 It's encouraged to do it right after all repos are set up, usually right after
 423 the call to addfileprovides().
 424
 425         Solvable *whatprovides(DepId dep)
 426         my @solvables = $pool->whatprovides($dep);
 427         solvables = pool.whatprovides(dep)
 428         solvables = pool.whatprovides(dep)
 429
 430 Return all solvables that provide the specified dependency. You can use either
 431 a Dep object or an simple Id as argument.
 432
 433         Id *matchprovidingids(const char *match, int flags)
 434         my @ids = $pool->matchprovidingids($match, $flags);
 435         ids = pool.matchprovidingids(match, flags)
 436         ids = pool.matchprovidingids(match, flags)
 437
 438 Search the names of all provides and return the ones matching the specified
 439 string. See the Dataiterator class for the allowed flags.
 440
 441         Id towhatprovides(Id *ids)
 442         my $offset = $pool->towhatprovides(\@ids);
 443         offset = pool.towhatprovides(ids)
 444         offset = pool.towhatprovides(ids)
 445
 446 ``Internalize'' an array containing Ids. The returned value can be used to
 447 create solver jobs working on a specific set of packages. See the Solver class
 448 for more information.
 449
 450         bool isknownarch(DepId id)
 451         my $bool = $pool->isknownarch($id);
 452         bool = pool.isknownarch(id)
 453         bool = pool.isknownarch?(id)
 454
 455 Return true if the specified Id describes a known architecture.
 456
 457         Solver Solver()
 458         my $solver = $pool->Solver();
 459         solver = pool.Solver()
 460         solver = pool.Solver()
 461
 462 Create a new solver object.
 463
 464         Job Job(int how, Id what)
 465         my $job = $pool->Job($how, $what);
 466         job = pool.Job(how, what)
 467         job = pool.Job(how, what)
 468
 469 Create a new Job object. Kind of low level, in most cases you would use a
 470 Selection or Dep job constructor instead.
 471
 472         Selection Selection()
 473         my $sel = $pool->Selection();
 474         sel = pool.Selection()
 475         sel = pool.Selection()
 476
 477 Create an empty selection. Useful as a starting point for merging other
 478 selections.
 479
 480         Selection Selection_all()
 481         my $sel = $pool->Selection_all();
 482         sel = pool.Selection_all()
 483         sel = pool.Selection_all()
 484
 485 Create a selection containing all packages. Useful as starting point for
 486 intersecting other selections or for update/distupgrade jobs.
 487
 488         Selection select(const char *name, int flags)
 489         my $sel = $pool->select($name, $flags);
 490         sel = pool.select(name, flags)
 491         sel = pool.select(name, flags)
 492
 493 Create a selection by matching packages against the specified string. See the
 494 Selection class for a list of flags and how to create solver jobs from a
 495 selection.
 496
 497         void setpooljobs(Jobs *jobs)
 498         $pool->setpooljobs(\@jobs);
 499         pool.setpooljobs(jobs)
 500         pool.setpooljobs(jobs)
 501
 502         Job *getpooljobs()
 503         @jobs = $pool->getpooljobs();
 504         jobs = pool.getpooljobs()
 505         jobs = pool.getpooljobs()
 506
 507 Get/Set fixed jobs stored in the pool. Those jobs are automatically appended to
 508 all solver jobs, they are meant for fixed configurations like which packages
 509 can be multiversion installed, which packages were userinstalled or must not be
 510 erased.
 511
 512         void set_loadcallback(Callable *callback)
 513         $pool->setloadcallback(\&callbackfunction);
 514         pool.setloadcallback(callbackfunction)
 515         pool.setloadcallback { |repodata| ... }
 516
 517 Set the callback function called when repository metadata needs to be loaded on
 518 demand. To make use of this feature, you need to create repodata stubs that
 519 tell the library which data is available but not loaded. If later on the data
 520 needs to be accessed, the callback function is called with a repodata argument.
 521 You can then load the data (maybe fetching it first from an remote server).
 522 The callback should return true if the data has been made available.
 523
 524 === DATA RETRIEVAL METHODS ===
 525
 526 In the following functions, the _keyname_ argument describes what to retrieve.
 527 For the standard cases you can use the available Id constants. For example,
 528
 529         $solv::SOLVABLE_SUMMARY
 530         solv.SOLVABLE_SUMMARY
 531         Solv::SOLVABLE_SUMMARY
 532
 533 selects the ``Summary'' entry of a solvable. The _solvid_ argument selects the
 534 desired solvable by Id.
 535
 536         const char *lookup_str(Id solvid, Id keyname)
 537         my $string = $pool->lookup_str($solvid, $keyname);
 538         string = pool.lookup_str(solvid, keyname)
 539         string = pool.lookup_str(solvid, keyname)
 540
 541         Id lookup_id(Id solvid, Id keyname)
 542         my $id = $pool->lookup_id($solvid, $keyname);
 543         id = pool.lookup_id(solvid, keyname)
 544         id = pool.lookup_id(solvid, keyname)
 545
 546         unsigned long long lookup_num(Id solvid, Id keyname, unsigned long long notfound = 0)
 547         my $num = $pool->lookup_num($solvid, $keyname);
 548         num = pool.lookup_num(solvid, keyname)
 549         num = pool.lookup_num(solvid, keyname)
 550
 551         bool lookup_void(Id solvid, Id keyname)
 552         my $bool = $pool->lookup_void($solvid, $keyname);
 553         bool = pool.lookup_void(solvid, keyname)
 554         bool = pool.lookup_void(solvid, keyname)
 555
 556         Id *lookup_idarray(Id solvid, Id keyname)
 557         my @ids = $pool->lookup_idarray($solvid, $keyname);
 558         ids = pool.lookup_idarray(solvid, keyname)
 559         ids = pool.lookup_idarray(solvid, keyname)
 560
 561         Chksum lookup_checksum(Id solvid, Id keyname)
 562         my $chksum = $pool->lookup_checksum($solvid, $keyname);
 563         chksum = pool.lookup_checksum(solvid, keyname)
 564         chksum = pool.lookup_checksum(solvid, keyname)
 565
 566 Lookup functions. Return the data element stored in the specified solvable.
 567 You should probably use the methods of the Solvable class instead.
 568
 569         Dataiterator Dataiterator(Id solvid, Id keyname, const char *match = 0, int flags = 0)
 570         my $di = $pool->Dataiterator($solvid, $keyname, $match, $flags);
 571         di = pool.Dataiterator(solvid, keyname, match, flags)
 572         di = pool.Dataiterator(solvid, keyname, match, flags)
 573
 574         for my $d (@$di)
 575         for d in di:
 576         for d in di
 577
 578 Iterate over the matching data elements. See the Dataiterator class for more
 579 information.
 580
 581 === ID METHODS ===
 582
 583 The following methods deal with Ids, i.e. integers representing objects in the
 584 pool. They are considered ``low level'', in most cases you would not use them
 585 but instead the object orientated methods.
 586
 587         Repo id2repo(Id id)
 588         $repo = $pool->id2repo($id);
 589         repo = pool.id2repo(id)
 590         repo = pool.id2repo(id)
 591
 592 Lookup an existing Repository by id. You can also do this by using the *repos*
 593 attribute.
 594
 595         Solvable id2solvable(Id id)
 596         $solvable = $pool->id2solvable($id);
 597         solvable = pool.id2solvable(id)
 598         solvable = pool.id2solvable(id)
 599
 600 Lookup an existing Repository by id. You can also do this by using the
 601 *solvables* attribute.
 602
 603         const char *solvid2str(Id id)
 604         my $str = $pool->solvid2str($id);
 605         str = pool.solvid2str(id)
 606         str = pool.solvid2str(id)
 607
 608 Return a string describing the Solvable with the specified id. The string
 609 consists of the name, version, and architecture of the Solvable.
 610
 611         Id str2id(const char *str, bool create = 1)
 612         my $id = pool->str2id($string);
 613         id = pool.str2id(string)
 614         id = pool.str2id(string)
 615
 616         const char *id2str(Id id)
 617         $string = pool->id2str($id);
 618         string = pool.id2str(id)
 619         string = pool.id2str(id)
 620
 621 Convert a string into an Id and back. If the string is currently not in the
 622 pool and _create_ is false, zero is returned.
 623
 624         Id rel2id(Id name, Id evr, int flags, bool create = 1)
 625         my $id = pool->rel2id($nameid, $evrid, $flags);
 626         id = pool.rel2id(nameid, evrid, flags)
 627         id = pool.rel2id(nameid, evrid, flags)
 628
 629 Create a ``relational'' dependency. Such dependencies consist of a name part,
 630 the _flags_ describing the relation, and a version part. The flags are:
 631
 632         $solv::REL_EQ | $solv::REL_GT | $solv::REL_LT
 633         solv.REL_EQ | solv.REL_GT | solv.REL_LT
 634         Solv::REL_EQ | Solv::REL_GT | Solv::REL_LT
 635
 636 Thus, if you want a ``\<='' relation, you would use *REL_LT | REL_EQ*.
 637
 638         Id id2langid(Id id, const char *lang, bool create = 1)
 639         my $id = $pool->id2langid($id, $language);
 640         id = pool.id2langid(id, language)
 641         id = pool.id2langid(id, language)
 642
 643 Create a language specific Id from some other id. This function simply converts
 644 the id into a string, appends a dot and the specified language to the string
 645 and converts the result back into an Id.
 646
 647         const char *dep2str(Id id)
 648         $string = pool->dep2str($id);
 649         string = pool.dep2str(id)
 650         string = pool.dep2str(id)
 651
 652 Convert a dependency id into a string. If the id is just a string, this
 653 function has the same effect as id2str(). For relational dependencies, the
 654 result is the correct ``name relation evr'' string.
 655
 656
 657 The Dependency Class
 658 --------------------
 659 The dependency class is an object orientated way to work with strings and
 660 dependencies. Internally, dependencies are represented as Ids, i.e. simple
 661 numbers. Dependency objects can be constructed by using the Pool's Dep()
 662 method.
 663
 664 === ATTRIBUTES ===
 665
 666         Pool *pool;             /* read only */
 667         $dep->{pool}
 668         dep.pool
 669         dep.pool
 670
 671 Back reference to the pool this dependency belongs to.
 672
 673         Id id;          /* read only */
 674         $dep->{id}
 675         dep.id
 676         dep.id
 677
 678 The id of this dependency.
 679
 680 == Methods ==
 681
 682         Dep Rel(int flags, DepId evrid, bool create = 1)
 683         my $reldep = $dep->Rel($flags, $evrdep);
 684         reldep = dep.Rel(flags, evrdep)
 685         reldep = dep.Rel(flags, evrdep)
 686
 687 Create a relational dependency from to string dependencies and a flags
 688 argument. See the pool's rel2id method for a description of the flags.
 689
 690         Selection Selection_name(int setflags = 0)
 691         my $sel = $dep->Selection_name();
 692         sel = dep.Selection_name()
 693         sel = dep.Selection_name()
 694
 695 Create a Selection from a dependency. The selection consists of all packages
 696 that have a name equal to the dependency. If the dependency is of a relational
 697 type, the packages version must also fulfill the dependency.
 698
 699         Selection Selection_provides(int setflags = 0)
 700         my $sel = $dep->Selection_provides();
 701         sel = dep.Selection_provides()
 702         sel = dep.Selection_provides()
 703
 704 Create a Selection from a dependency. The selection consists of all packages
 705 that have at least one provides matching the dependency.
 706
 707         const char *str()
 708         my $str = $dep->str();
 709         str = $dep.str()
 710         str = $dep.str()
 711
 712 Return a string describing the dependency.
 713
 714         <stringification>
 715         my $str = $dep->str;
 716         str = str(dep)
 717         str = dep.to_s
 718
 719 Same as calling the str() method.
 720
 721         <equality>
 722         if ($dep1 == $dep2)
 723         if dep1 == dep2:
 724         if dep1 == dep2
 725
 726 The dependencies are equal if they are part of the same pool and have the same
 727 ids.
 728
 729
 730 The Repository Class
 731 --------------------
 732 A Repository describes a group of packages, normally coming from the same
 733 source. Repositories are created by the Pool's add_repo() method.
 734
 735 === ATTRIBUTES ===
 736
 737         Pool *pool;                     /* read only */
 738         $repo->{pool}
 739         repo.pool
 740         repo.pool
 741
 742 Back reference to the pool this dependency belongs to.
 743
 744         Id id;                          /* read only */
 745         $repo->{id}
 746         repo.id
 747         repo.id
 748
 749 The id of the repository.
 750
 751         const char *name;               /* read/write */
 752         $repo->{name}
 753         repo.name
 754         repo.name
 755
 756 The repositories name. To libsolv, the name is just a string with no specific
 757 meaning.
 758
 759         int priority;                   /* read/write */
 760         $repo->{priority}
 761         repo.priority
 762         repo.priority
 763
 764 The priority of the repository. A higher number means that packages of this
 765 repository will be chosen over other repositories, even if they have a greater
 766 package version.
 767
 768         int subpriority;                /* read/write */
 769         $repo->{subpriority}
 770         repo.subpriority
 771         repo.subpriority
 772
 773 The sub-priority of the repository. This value is compared when the priorities
 774 of two repositories are the same. It is useful to make the library prefer
 775 on-disk repositories to remote ones.
 776
 777         int nsolvables;                 /* read only */
 778         $repo->{nsolvables}
 779         repo.nsolvables
 780         repo.nsolvables
 781
 782 The number of solvables in this repository.
 783
 784         void *appdata;                  /* read/write */
 785         $repo->{appdata}
 786         repo.appdata
 787         repo.appdata
 788
 789 Application specific data that may be used in any way by the code using the
 790 repository.
 791
 792         Datapos *meta;                  /* read only */
 793         $repo->{meta}
 794         repo.meta
 795         repo.meta
 796
 797 Return a Datapos object of the repodata's metadata. You can use the lookup
 798 methods of the Datapos class to lookup metadata attributes, like the repository
 799 timestamp.
 800
 801 === CONSTANTS ===
 802
 803 *REPO_REUSE_REPODATA*::
 804 Reuse the last repository data area (``repodata'') instead of creating a
 805 new one.
 806
 807 *REPO_NO_INTERNALIZE*::
 808 Do not internalize the added repository data. This is useful if
 809 you plan to add more data because internalization is a costly
 810 operation.
 811
 812 *REPO_LOCALPOOL*::
 813 Use the repodata's pool for Id storage instead of the global pool. Useful
 814 if you don't want to pollute the global pool with many unneeded ids, like
 815 when storing the filelist.
 816
 817 *REPO_USE_LOADING*::
 818 Use the repodata that is currently being loaded instead of creating a new
 819 one. This only makes sense if used in a load callback.
 820
 821 *REPO_EXTEND_SOLVABLES*::
 822 Do not create new solvables for the new data, but match existing solvables
 823 and add the data to them. Repository metadata is often split into multiple
 824 parts, with one primary file describing all packages and other parts
 825 holding information that is normally not needed, like the changelog.
 826
 827 *REPO_USE_ROOTDIR*::
 828 Prepend the pool's rootdir to the path when doing file operations.
 829
 830 *REPO_NO_LOCATION*::
 831 Do not add a location element to the solvables. Useful if the solvables
 832 are not in the final position, so you can add the correct location later
 833 in your code.
 834
 835 *SOLV_ADD_NO_STUBS*::
 836 Do not create stubs for repository parts that can be downloaded on demand.
 837
 838 *SUSETAGS_RECORD_SHARES*::
 839 This is specific to the add_susetags() method. Susetags allows to refer to
 840 already read packages to save disk space. If this data sharing needs to
 841 work over multiple calls to add_susetags, you need to specify this flag so
 842 that the share information is made available to subsequent calls.
 843
 844 === METHODS ===
 845
 846         void free(bool reuseids = 0)
 847         $repo->free();
 848         repo.free()
 849         repo.free()
 850
 851 Free the repository and all solvables it contains. If _reuseids_ is set to
 852 true, the solvable ids and the repository id may be reused by the library when
 853 added new solvables. Thus you should leave it false if you are not sure that
 854 somebody holds a reference.
 855
 856         void empty(bool reuseids = 0)
 857         $repo->empty();
 858         repo.empty()
 859         repo.empty()
 860
 861 Free all the solvables in a repository. The repository will be empty after this
 862 call. See the free() method for the meaning of _reuseids_.
 863
 864         bool isempty()
 865         $repo->isempty()
 866         repo.empty()
 867         repo.empty?
 868
 869 Return true if there are no solvables in this repository.
 870
 871         void internalize()
 872         $repo->internalize();
 873         repo.internalize()
 874         repo.internalize()
 875
 876 Internalize added data. Data must be internalized before it is available to the
 877 lookup and data iterator functions.
 878
 879         bool write(FILE *fp)
 880         $repo->write($fp)
 881         repo.write(fp)
 882         repo.write(fp)
 883
 884 Write a repo as a ``solv'' file. These files can be read very fast and thus are
 885 a good way to cache repository data. Returns false if there was some error
 886 writing the file.
 887
 888         Solvableiterator solvables_iter()
 889         for my $solvable (@{$repo->solvables_iter()})
 890         for solvable in repo.solvables_iter():
 891         for solvable in repo.solvables_iter()
 892
 893 Iterate over all solvables in a repository.
 894
 895         Repodata add_repodata(int flags = 0)
 896         my $repodata = $repo->add_repodata();
 897         repodata = repo.add_repodata()
 898         repodata = repo.add_repodata()
 899
 900 Add a new repodata area to the repository. This is normally automatically
 901 done by the repo_add methods, so you need this method only in very
 902 rare circumstances.
 903
 904         void create_stubs()
 905         $repo->create_stubs();
 906         repo.create_stubs()
 907         repo.create_stubs()
 908
 909 Calls the create_stubs() repodata method for the last repodata of the
 910 repository.
 911
 912         bool iscontiguous()
 913         $repo->iscontiguous()
 914         repo.iscontiguous()
 915         repo.iscontiguous?
 916
 917 Return true if the solvables of this repository are all in a single block with
 918 no holes, i.e. they have consecutive ids.
 919
 920         Repodata first_repodata()
 921         my $repodata = $repo->first_repodata();
 922         repodata = repo.first_repodata()
 923         repodata = repo.first_repodata()
 924
 925 Checks if all repodatas but the first repodata are extensions, and return the
 926 first repodata if this is the case. Useful if you want to do a store/retrieve
 927 sequence on the repository to reduce the memory using and enable paging, as
 928 this does not work if the repository contains multiple non-extension repodata
 929 areas.
 930
 931         Selection Selection(int setflags = 0)
 932         my $sel = $repo->Selection();
 933         sel = repo.Selection()
 934         sel = repo.Selection()
 935
 936 Create a Selection consisting of all packages in the repository.
 937
 938         Dataiterator Dataiterator(Id p, Id key, const char *match = 0, int flags = 0)
 939         my $di = $repo->Dataiterator($solvid, $keyname, $match, $flags);
 940         di = repo.Dataiterator(solvid, keyname, match, flags)
 941         di = repo.Dataiterator(solvid, keyname, match, flags)
 942
 943         for my $d (@$di)
 944         for d in di:
 945         for d in di
 946
 947 Iterate over the matching data elements in this repository. See the
 948 Dataiterator class for more information.
 949
 950         <stringification>
 951         my $str = $repo->str;
 952         str = str(repo)
 953         str = repo.to_s
 954
 955 Return the name of the repository, or "Repo#<id>" if no name is set.
 956
 957         <equality>
 958         if ($repo1 == $repo2)
 959         if repo1 == repo2:
 960         if repo1 == repo2
 961
 962 Two repositories are equal if they belong to the same pool and have the same id.
 963
 964 === DATA ADD METHODS ===
 965
 966         Solvable add_solvable()
 967         $repo->add_solvable();
 968         repo.add_solvable()
 969         repo.add_solvable()
 970
 971 Add a single empty solvable to the repository. Returns a Solvable object, see
 972 the Solvable class for more information.
 973
 974         bool add_solv(const char *name, int flags = 0)
 975         $repo->add_solv($name);
 976         repo.add_solv(name)
 977         repo.add_solv(name)
 978
 979         bool add_solv(FILE *fp, int flags = 0)
 980         $repo->add_solv($fp);
 981         repo.add_solv(fp)
 982         repo.add_solv(fp)
 983
 984 Read a ``solv'' file and add its contents to the repository. These files can be
 985 written with the write() method and are normally used as fast cache for
 986 repository metadata.
 987
 988         bool add_rpmdb(int flags = 0)
 989         $repo->add_rpmdb();
 990         repo.add_rpmdb()
 991         repo.add_rpmdb()
 992
 993         bool add_rpmdb_reffp(FILE *reffp, int flags = 0)
 994         $repo->add_rpmdb_reffp($reffp);
 995         repo.add_rpmdb_reffp(reffp)
 996         repo.add_rpmdb_reffp(reffp)
 997
 998 Add the contents of the rpm database to the repository. If a solv file
 999 containing an old version of the database is available, it can be passed as
1000 reffp to speed up reading.
1001
1002         Solvable add_rpm(const char *filename, int flags = 0)
1003         my $solvable = $repo->add_rpm($filename);
1004         solvable = repo.add_rpm(filename)
1005         solvable = repo.add_rpm(filename)
1006
1007 Add the metadata of a single rpm package to the repository.
1008
1009         bool add_rpmdb_pubkeys(int flags = 0)
1010         $repo->add_rpmdb_pubkeys();
1011         repo.add_rpmdb_pubkeys()
1012         repo.add_rpmdb_pubkeys()
1013
1014 Add all pubkeys contained in the rpm database to the repository. Note that
1015 newer rpm versions also allow to store the pubkeys in some directory instead
1016 of the rpm database.
1017
1018         Solvable add_pubkey(const char *keyfile, int flags = 0)
1019         my $solvable = $repo->add_pubkey($keyfile);
1020         solvable = repo.add_pubkey(keyfile)
1021         solvable = repo.add_pubkey(keyfile)
1022
1023 Add a pubkey from a file to the repository.
1024
1025         bool add_rpmmd(FILE *fp, const char *language, int flags = 0)
1026         $repo->add_rpmmd($fp, undef);
1027         repo.add_rpmmd(fp, None)
1028         repo.add_rpmmd(fp, nil)
1029
1030 Add metadata stored in the "rpm-md" format (i.e. from files in the ``repodata''
1031 directory) to a repository. Supported files are "primary", "filelists",
1032 "other", "suseinfo". Do not forget to specify the *REPO_EXTEND_SOLVABLES* for
1033 extension files like "filelists" and "other". Use the _language_ parameter if
1034 you have language extension files, otherwise simply use a *undef*/*None*/*nil*
1035 parameter.
1036
1037         bool add_repomdxml(FILE *fp, int flags = 0)
1038         $repo->add_repomdxml($fp);
1039         repo.add_repomdxml(fp)
1040         repo.add_repomdxml(fp)
1041
1042 Add the repomd.xml meta description from the "rpm-md" format to the repository.
1043 This file contains information about the repository like keywords, and also a
1044 list of all database files with checksums. The data is added the the "meta"
1045 section of the repository, i.e. no package gets created.
1046
1047         bool add_updateinfoxml(FILE *fp, int flags = 0)
1048         $repo->add_updateinfoxml($fp);
1049         repo.add_updateinfoxml(fp)
1050         repo.add_updateinfoxml(fp)
1051
1052 Add the updateinfo.xml file containing available maintenance updates to the
1053 repository. All updates are created as special packages that have a "patch:"
1054 prefix in their name.
1055
1056         bool add_deltainfoxml(FILE *fp, int flags = 0)
1057         $repo->add_deltainfoxml($fp);
1058         repo.add_deltainfoxml(fp)
1059         repo.add_deltainfoxml(fp)
1060
1061 Add the deltainfo.xml file (also called prestodelta.xml) containing available
1062 delta-rpms to the repository. The data is added to the "meta" section, i.e. no
1063 package gets created.
1064
1065         bool add_debdb(int flags = 0)
1066         $repo->add_debdb();
1067         repo.add_debdb()
1068         repo.add_debdb()
1069
1070 Add the contents of the debian installed package database to the repository.
1071
1072         bool add_debpackages(FILE *fp, int flags = 0)
1073         $repo->add_debpackages($fp);
1074         repo.add_debpackages($fp)
1075         repo.add_debpackages($fp)
1076
1077 Add the contents of the debian repository metadata (the "packages" file)
1078 to the repository.
1079
1080         Solvable add_deb(const char *filename, int flags = 0)
1081         my $solvable = $repo->add_deb($filename);
1082         solvable = repo.add_deb(filename)
1083         solvable = repo.add_deb(filename)
1084
1085 Add the metadata of a single deb package to the repository.
1086
1087         bool add_mdk(FILE *fp, int flags = 0)
1088         $repo->add_mdk($fp);
1089         repo.add_mdk(fp)
1090         repo.add_mdk(fp)
1091
1092 Add the contents of the mageia/mandriva repository metadata (the
1093 "synthesis.hdlist" file) to the repository.
1094
1095         bool add_mdk_info(FILE *fp, int flags = 0)
1096         $repo->add_mdk($fp);
1097         repo.add_mdk(fp)
1098         repo.add_mdk(fp)
1099
1100 Extend the packages from the synthesis file with the info.xml and files.xml
1101 data. Do not forget to specify *REPO_EXTEND_SOLVABLES*.
1102
1103         bool add_arch_repo(FILE *fp, int flags = 0)
1104         $repo->add_arch_repo($fp);
1105         repo.add_arch_repo(fp)
1106         repo.add_arch_repo(fp)
1107
1108 Add the contents of the archlinux repository metadata (the ".db.tar" file) to
1109 the repository.
1110
1111         bool add_arch_local(const char *dir, int flags = 0)
1112         $repo->add_arch_local($dir);
1113         repo.add_arch_local(dir)
1114         repo.add_arch_local(dir)
1115
1116 Add the contents of the archlinux installed package database to the repository.
1117 The _dir_ parameter is usually set to "/var/lib/pacman/local".
1118
1119         bool add_content(FILE *fp, int flags = 0)
1120         $repo->add_content($fp);
1121         repo.add_content(fp)
1122         repo.add_content(fp)
1123
1124 Add the ``content'' meta description from the susetags format to the repository.
1125 This file contains information about the repository like keywords, and also
1126 a list of all database files with checksums. The data is added the the "meta"
1127 section of the repository, i.e. no package gets created.
1128
1129         bool add_susetags(FILE *fp, Id defvendor, const char *language, int flags = 0)
1130         $repo->add_susetags($fp, $defvendor, $language);
1131         repo.add_susetags(fp, defvendor, language)
1132         repo.add_susetags(fp, defvendor, language)
1133
1134 Add repository metadata in the susetags format to the repository. Like with
1135 add_rpmmd, you can specify a language if you have language extension files. The
1136 _defvendor_ parameter provides a default vendor for packages with missing
1137 vendors, it is usually provided in the content file.
1138
1139         bool add_products(const char *dir, int flags = 0)
1140         $repo->add_products($dir);
1141         repo.add_products(dir)
1142         repo.add_products(dir)
1143
1144 Add the installed SUSE products database to the repository. The _dir_ parameter
1145 is usually "/etc/products.d".
1146
1147
1148 The Solvable Class
1149 ------------------
1150 A solvable describes all the information of one package. Each solvable
1151 belongs to one repository, it can be added and filled manually but in
1152 most cases solvables will get created by the repo_add methods.
1153
1154 === ATTRIBUTES ===
1155
1156         Repo *repo;                     /* read only */
1157         $solvable->{repo}
1158         solvable.repo
1159         solvable.repo
1160
1161 The repository this solvable belongs to.
1162
1163         Pool *pool;                     /* read only */
1164         $solvable->{pool}
1165         solvable.pool
1166         solvable.pool
1167
1168 The pool this solvable belongs to, same as the pool of the repo.
1169
1170         Id id;                          /* read only */
1171         $solvable->{id}
1172         solvable.id
1173         solvable.id
1174
1175 The specific id of the solvable.
1176
1177         char *name;                     /* read/write */
1178         $solvable->{name}
1179         solvable.name
1180         solvable.name
1181
1182         char *evr;                      /* read/write */
1183         $solvable->{evr}
1184         solvable.evr
1185         solvable.evr
1186
1187         char *arch;                     /* read/write */
1188         $solvable->{arch}
1189         solvable.arch
1190         solvable.arch
1191
1192         char *vendor;                   /* read/write */
1193         $solvable->{vendor}
1194         solvable.vendor
1195         solvable.vendor
1196
1197 Easy access to often used attributes of solvables. They are
1198 internally stored as Ids.
1199
1200         Id nameid;                      /* read/write */
1201         $solvable->{nameid}
1202         solvable.nameid
1203         solvable.nameid
1204
1205         Id evrid;                       /* read/write */
1206         $solvable->{evrid}
1207         solvable.evrid
1208         solvable.evrid
1209
1210         Id archid;                      /* read/write */
1211         $solvable->{archid}
1212         solvable.archid
1213         solvable.archid
1214
1215         Id vendorid;                    /* read/write */
1216         $solvable->{vendorid}
1217         solvable.vendorid
1218         solvable.vendorid
1219
1220 Raw interface to the ids. Useful if you want to search for
1221 a specific id and want to avoid the string compare overhead.
1222
1223 === METHODS ===
1224
1225         const char *lookup_str(Id keyname)
1226         my $string = $solvable->lookup_str($keyname);
1227         string = solvable.lookup_str(keyname)
1228         string = solvable.lookup_str(keyname)
1229
1230         Id lookup_id(Id keyname)
1231         my $id = $solvable->lookup_id($keyname);
1232         id = solvable.lookup_id(solvid)
1233         id = solvable.lookup_id(solvid)
1234
1235         unsigned long long lookup_num(Id solvid, Id keyname, unsigned long long notfound = 0)
1236         my $num = $solvable->lookup_num($keyname);
1237         num = solvable.lookup_num(keyname)
1238         num = solvable.lookup_num(keyname)
1239
1240         bool lookup_void(Id keyname)
1241         my $bool = $solvable->lookup_void($keyname);
1242         bool = solvable.lookup_void(keyname)
1243         bool = solvable.lookup_void(keyname)
1244
1245         Chksum lookup_checksum(Id keyname)
1246         my $chksum = $solvable->lookup_checksum($keyname);
1247         chksum = solvable.lookup_checksum(keyname)
1248         chksum = solvable.lookup_checksum(keyname)
1249
1250         Id *lookup_idarray(Id keyname, Id marker = -1)
1251         my @ids = $solvable->lookup_idarray($keyname);
1252         ids = solvable.lookup_idarray(keyname)
1253         ids = solvable.lookup_idarray(keyname)
1254
1255         Dep *lookup_deparray(Id keyname, Id marker = -1)
1256         my @deps = $solvable->lookup_deparray($keyname);
1257         deps = solvable.lookup_deparray(keyname)
1258         deps = solvable.lookup_deparray(keyname)
1259
1260 Generic lookup methods. Retrieve data stored for the specific keyname.
1261 The lookup_idarray() method will return an array of Ids, use
1262 lookup_deparray if you want an array of Dependency objects instead.
1263 Some Id arrays contain two parts of data divided by a specific marker,
1264 for example the provides array uses the SOLVABLE_FILEMARKER id to
1265 store both the ids provided by the package and the ids added by
1266 the addfileprovides method. The default, -1, translates to the
1267 correct marker for the keyname and returns the first part of the
1268 array, use 1 to select the second part or 0 to retrieve all ids
1269 including the marker.
1270
1271         const char *lookup_location(unsigned int *OUTPUT);
1272         my ($location, $medianr) = $solvable->lookup_location();
1273         location, medianr = solvable.lookup_location()
1274         location, medianr = solvable.lookup_location()
1275
1276 Return a tuple containing the on-media location and an optional
1277 media number for multi-part repositories (e.g. repositories
1278 spawning multiple DVDs).
1279
1280         Dataiterator Dataiterator(Id keyname, const char *match = 0, int flags = 0)
1281         my $di = $solvable->Dataiterator($keyname, $match, $flags);
1282         di = solvable.Dataiterator(keyname, match, flags)
1283         di = solvable.Dataiterator(keyname, match, flags)
1284
1285         for my $d (@$di)
1286         for d in di:
1287         for d in di
1288
1289 Iterate over the matching data elements. See the Dataiterator class for more
1290 information.
1291
1292         void add_deparray(Id keyname, DepId dep, Id marker = -1);
1293         $solvable->add_deparray($keyname, $dep);
1294         solvable.add_deparray(keyname, dep)
1295         solvable.add_deparray(keyname, dep)
1296
1297 Add a new dependency to the attributes stored in keyname.
1298
1299         void unset(Id keyname);
1300         $solvable->unset($keyname);
1301         solvable.unset(keyname)
1302         solvable.unset(keyname)
1303
1304 Delete data stored for the specific keyname.
1305
1306         bool installable();
1307         $solvable->installable()
1308         solvable.installable()
1309         solvable.installable?
1310
1311 Return true if the solvable is installable on the system. Solvables
1312 are not installable if the system does not support their architecture.
1313
1314         bool isinstalled();
1315         $solvable->isinstalled()
1316         solvable.isinstalled()
1317         solvable.isinstalled?
1318
1319 Return true if the solvable is installed on the system.
1320
1321         bool identical(Solvable *other)
1322         $solvable->identical($other)
1323         $solvable.identical(other)
1324         $solvable.identical?(other)
1325
1326 Return true if the two solvables are identical.
1327
1328         int evrcmp(Solvable *other)
1329         $solvable->evrcmp(other)
1330         $solvable.evrcmp(other)
1331         $solvable.evrcmp(other)
1332
1333 Returns -1 if the epoch/version/release of the solvable is less then the
1334 one from the other solvable, 1 if it is greater, and 0 if they are equal.
1335 Note that "equal" does not mean that the evr is identical.
1336
1337         Selection Selection(int setflags = 0)
1338         my $sel = $solvable->Selection();
1339         sel = solvable.Selection()
1340         sel = solvable.Selection()
1341
1342 Create a Selection containing just the single solvable.
1343
1344         const char *str()
1345         my $str = $solvable->str();
1346         str = $solvable.str()
1347         str = $solvable.str()
1348
1349 Return a string describing the solvable. The string consists of the name,
1350 version, and architecture of the Solvable.
1351
1352         <stringification>
1353         my $str = $solvable->str;
1354         str = str(solvable)
1355         str = solvable.to_s
1356
1357 Same as calling the str() method.
1358
1359         <equality>
1360         if ($solvable1 == $solvable2)
1361         if solvable1 == solvable2:
1362         if solvable1 == solvable2
1363
1364 Two solvables are equal if they are part of the same pool and have the same
1365 ids.
1366
1367
1368 The Dataiterator Class
1369 ----------------------
1370 Dataiterators can be used to do complex string searches or
1371 to iterate over arrays. They can be created via the
1372 constructors in the Pool, Repo, and Solvable classes. The
1373 Repo and Solvable constructors will limit the search to
1374 the repository or the specific package.
1375
1376 === CONSTANTS ===
1377
1378 *SEARCH_STRING*::
1379 Return a match if the search string matches the value.
1380
1381 *SEARCH_STRINGSTART*::
1382 Return a match if the value starts with the search string.
1383
1384 *SEARCH_STRINGEND*::
1385 Return a match if the value ends with the search string.
1386
1387 *SEARCH_SUBSTRING*::
1388 Return a match if the search string can be matched somewhere in the value.
1389
1390 *SEARCH_GLOB*::
1391 Do a glob match of the search string against the value.
1392
1393 *SEARCH_REGEX*::
1394 Do a regular expression match of the search string against the value.
1395
1396 *SEARCH_NOCASE*::
1397 Ignore case when matching strings. Works for all the above match types.
1398
1399 *SEARCH_FILES*::
1400 Match the complete filenames of the file list, not just the base name.
1401
1402 *SEARCH_COMPLETE_FILELIST*::
1403 When matching the file list, check every file of the package not just the
1404 subset from the primary metadata.
1405
1406 *SEARCH_CHECKSUMS*::
1407 Allow the matching of checksum entries.
1408
1409 === METHODS ===
1410
1411         void prepend_keyname(Id keyname);
1412         $di->prepend_keyname($keyname);
1413         di.prepend_keyname(keyname)
1414         di.prepend_keyname(keyname)
1415
1416 Do a sub-search in the array stored in keyname.
1417
1418         void skip_solvable();
1419         $di->kip_solvable();
1420         di.skip_solvable()
1421         di.skip_solvable()
1422
1423 Stop matching the current solvable and advance to the next
1424 one.
1425
1426         <iteration>
1427         for my $d (@$di)
1428         for d in di:
1429         for d in di
1430
1431 Iterate through the matches. If there is a match, the object
1432 in d will be of type Datamatch.
1433
1434 The Datamatch Class
1435 -------------------
1436 Objects of this type will be created for every value matched
1437 by a dataiterator.
1438
1439 === ATTRIBUTES ===
1440
1441         Pool *pool;                             /* read only */
1442         $d->{pool}
1443         d.pool
1444         d.pool
1445
1446 Back pointer to pool.
1447
1448         Repo *repo;                             /* read only */
1449         $d->{repo}
1450         d.repo
1451         d.repo
1452
1453 The repository containing the matched object.
1454
1455         Solvable *solvable;                     /* read only */
1456         $d->{solvable}
1457         d.solvable
1458         d.solvable
1459
1460 The solvable containing the value that was matched.
1461
1462         Id solvid;                              /* read only */
1463         $d->{solvid}
1464         d.solvid
1465         d.solvid
1466
1467 The id of the solvable that matched.
1468
1469 === METHODS ===
1470
1471         Id key_id();
1472         $d->key_id()
1473         d.key_id()
1474         d.key_id()
1475
1476         const char *key_idstr();
1477         $d->key_idstr()
1478         d.key_idstr()
1479         d.key_idstr()
1480
1481 The keyname that matched, either as id or string.
1482
1483         Id type_id();
1484         $d->type_id()
1485         d.type_id()
1486         d.type_id()
1487
1488         const char *type_idstr();
1489         $d->type_idstr();
1490         d.type_idstr()
1491         d.type_idstr()
1492
1493 The key type of the value that was matched, either as id or string.
1494
1495         Id id();
1496         $d->id()
1497         d.id()
1498         d.id()
1499
1500         Id idstr();
1501         $d->idstr()
1502         d.idstr()
1503         d.idstr()
1504
1505 The Id of the value that was matched (only valid for id types),
1506 either as id or string.
1507
1508         const char *str();
1509         $d->str()
1510         d.str()
1511         d.str()
1512
1513 The string value that was matched (only valid for string types).
1514
1515         unsigned long long num();
1516         $d->num()
1517         d.num()
1518         d.num()
1519
1520 The numeric value that was matched (only valid for numeric types).
1521
1522         unsigned int num2();
1523         $d->num2()
1524         d.num2()
1525         d.num2()
1526
1527 The secondary numeric value that was matched (only valid for types
1528 containing two values).
1529
1530         Datapos pos();
1531         my $pos = $d->pos();
1532         pos = d.pos()
1533         pos = d.pos()
1534
1535 The position object of the current match. It can be used to do
1536 sub-searches starting at the match (if it is of an array type).
1537 See the Datapos class for more information.
1538
1539         Datapos parentpos();
1540         my $pos = $d->parentpos();
1541         pos = d.parentpos()
1542         pos = d.parentpos()
1543
1544 The position object of the array containing the current match.
1545 It can be used to do sub-searches, see the Datapos class for more
1546 information.
1547
1548         <stringification>
1549         my $str = $d->str;
1550         str = str(d)
1551         str = d.to_s
1552
1553 Return the stringification of the matched value. Stringification
1554 depends on the search flags, for file list entries it will return
1555 just the base name unless SEARCH_FILES is used, for checksums
1556 it will return an empty string unless SEARCH_CHECKSUMS is used.
1557 Numeric values are currently stringified to an empty string.
1558
1559
1560 The Selection Class
1561 -------------------
1562 Selections are a way to easily deal with sets of packages.
1563 There are multiple constructors to create them, the most useful
1564 is probably the select() method in the Pool class.
1565
1566 === CONSTANTS ===
1567
1568 *SELECTION_NAME*::
1569 Create the selection by matching package names.
1570
1571 *SELECTION_PROVIDES*::
1572 Create the selection by matching package provides.
1573
1574 *SELECTION_FILELIST*::
1575 Create the selection by matching package files.
1576
1577 *SELECTION_CANON*::
1578 Create the selection by matching the canonical representation
1579 of the package. This is normally a combination of the name,
1580 the version, and the architecture of a package.
1581
1582 *SELECTION_DOTARCH*::
1583 Allow an ``.<architecture>'' suffix when matching names or
1584 provides.
1585
1586 *SELECTION_REL*::
1587 Allow the specification of a relation when matching names
1588 or provides, e.g. "name >= 1.2".
1589
1590 *SELECTION_INSTALLED_ONLY*::
1591 Limit the package search to installed packages.
1592
1593 *SELECTION_SOURCE_ONLY*::
1594 Limit the package search to source packages only.
1595
1596 *SELECTION_WITH_SOURCE*::
1597 Extend the package search to also match source packages. The default is
1598 only to match binary packages.
1599
1600 *SELECTION_GLOB*::
1601 Allow glob matching for package names, package provides, and file names.
1602
1603 *SELECTION_NOCASE*::
1604 Ignore case when matching package names, package provides, and file names.
1605
1606 *SELECTION_FLAT*::
1607 Return only one selection element describing the selected packages.
1608 The default is to create multiple elements for all globbed packages.
1609 Multiple elements are useful if you want to turn the selection into
1610 an install job, in that case you want an install job for every
1611 globbed package.
1612
1613 === ATTRIBUTES ===
1614
1615         Pool *pool;                             /* read only */
1616         $d->{pool}
1617         d.pool
1618         d.pool
1619
1620 Back pointer to pool.
1621
1622 === METHODS ===
1623
1624         int flags();
1625         my $flags = $sel->flags();
1626         flags = sel.flags()
1627         flags = sel.flags()
1628
1629 Return the result flags of the selection. The flags are a subset
1630 of the ones used when creating the selection, they describe which
1631 method was used to get the result. For example, if you create the
1632 selection with ``SELECTION_NAME | SELECTION_PROVIDES'', the resulting
1633 flags will either be SELECTION_NAME or SELECTION_PROVIDES depending
1634 if there was a package that matched the name or not. If there was
1635 no match at all, the flags will be zero.
1636
1637         bool isempty();
1638         $sel->isempty()
1639         sel.isempty()
1640         sel.isempty?
1641
1642 Return true if the selection is empty, i.e. no package could be matched.
1643
1644         void filter(Selection *other)
1645         $sel->filter($other);
1646         sel.filter(other)
1647         sel.filter(other)
1648
1649 Intersect two selections. Packages will only stay in the selection if there
1650 are also included in the other selecting. Does an in-place modification.
1651
1652         void add(Selection *other)
1653         $sel->add($other);
1654         sel.add(other)
1655         sel.add(other)
1656
1657 Build the union of two selections. All packages of the other selection will
1658 be added to the set of packages of the selection object. Does an in-place
1659 modification. Note that the selection flags are no longer meaningful after the
1660 add operation.
1661
1662         void add_raw(Id how, Id what)
1663         $sel->add_raw($how, $what);
1664         sel.add_raw(how, what)
1665         sel.add_raw(how, what)
1666
1667 Add a raw element to the selection. Check the Job class for information about
1668 the how and what parameters.
1669
1670         Job *jobs(int action)
1671         my @jobs = $sel->jobs($action);
1672         jobs = sel.jobs(action)
1673         jobs = sel.jobs(action)
1674
1675 Convert a selection into an array of Job objects. The action parameter is or-ed
1676 to the ``how'' part of the job, it describes the type of job (e.g. install,
1677 erase). See the Job class for the action and action modifier constants.
1678
1679         Solvable *solvables()
1680         my @solvables = $sel->solvables();
1681         solvables = sel.solvables()
1682         solvables = sel.solvables()
1683
1684 Convert a selection into an array of Solvable objects.
1685
1686         <stringification>
1687         my $str = $sel->str;
1688         str = str(sel)
1689         str = sel.to_s
1690
1691 Return a string describing the selection.
1692
1693 The Job Class
1694 -------------
1695 Jobs are the way to specify to the dependency solver what to do.
1696 Most of the times jobs will get created by calling the jobs() method
1697 on a Selection object, but there is also a Job() constructor in the
1698 Pool class.
1699
1700 === CONSTANTS ===
1701
1702 Selection constants:
1703
1704 *SOLVER_SOLVABLE*::
1705 The ``what'' part is the id of a solvable.
1706
1707 *SOLVER_SOLVABLE_NAME*::
1708 The ``what'' part is the id of a package name.
1709
1710 *SOLVER_SOLVABLE_PROVIDES*::
1711 The ``what'' part is the id of a package provides.
1712
1713 *SOLVER_SOLVABLE_ONE_OF*::
1714 The ``what'' part is an offset into the ``whatprovides'' data, created
1715 by calling the towhatprovides() pool method.
1716
1717 *SOLVER_SOLVABLE_REPO*::
1718 The ``what'' part is the id of a repository.
1719
1720 *SOLVER_SOLVABLE_ALL*::
1721 The ``what'' part is ignored, all packages are selected.
1722
1723 *SOLVER_SOLVABLE_SELECTMASK*::
1724 A mask containing all the above selection bits.
1725
1726 Action constants:
1727
1728 *SOLVER_NOOP*::
1729 Do nothing.
1730
1731 *SOLVER_INSTALL*::
1732 Install a package of the specified set of packages. It tries to install
1733 the best matching package (i.e. the highest version of the packages from
1734 the repositories with the highest priority).
1735
1736 *SOLVER_ERASE*::
1737 Erase all of the packages from the specified set. If a package is not
1738 installed, erasing it will keep it from getting installed.
1739
1740 *SOLVER_UPDATE*::
1741 Update the matching installed packages to their best version. If none
1742 of the specified packages are installed, try to update the installed
1743 packages to the specified versions. See the section about targeted
1744 updates about more information.
1745
1746 *SOLVER_WEAKENDEPS*::
1747 Allow to break the dependencies of the matching packages. Handle with care.
1748
1749 *SOLVER_MULTIVERSION*::
1750 Mark the matched packages for multiversion install. If they get to be
1751 installed because of some other job, the installation will keep the old
1752 version of the package installed (for rpm this is done by using ``-i''
1753 instead of ``-U'').
1754
1755 *SOLVER_LOCK*::
1756 Do not change the state of the matched packages, i.e. when they are
1757 installed they stay installed, if not they are not selected for
1758 installation.
1759
1760 *SOLVER_DISTUPGRADE*::
1761 Update the matching installed packages to the best version included in one
1762 of the repositories. After this operation, all come from one of the available
1763 repositories except orphaned packages. Orphaned packages are packages that
1764 have no relation to the packages in the repositories, i.e. no package in the
1765 repositories have the same name or obsolete the orphaned package.
1766 This action brings the installed packages in sync with the ones in the
1767 repository. It also turns of arch/vendor/version locking for the affected
1768 packages to simulate a fresh installation. This means that distupgrade can
1769 actually downgrade packages if only lower versions of a package are available
1770 in the repositories.
1771
1772 *SOLVER_DROP_ORPHANED*::
1773 Erase all the matching installed packages if they are orphaned. This only makes
1774 sense if there is a ``distupgrade all packages'' job. The default is to erase
1775 orphaned packages only if they block the installation of other packages.
1776
1777 *SOLVER_VERIFY*::
1778 Fix dependency problems of matching installed packages. The default is to ignore
1779 dependency problems for installed packages.
1780
1781 *SOLVER_USERINSTALLED*::
1782 The matching installed packages are considered to be installed by a user,
1783 thus not installed to fulfill some dependency. This is needed input for
1784 the calculation of unneeded packages for jobs that have the
1785 SOLVER_CLEANDEPS flag set.
1786
1787 *SOLVER_JOBMASK*::
1788 A mask containing all the above action bits.
1789
1790 Action modifier constants:
1791
1792 *SOLVER_WEAK*::
1793 Makes the job a weak job. The solver tries to fulfill weak jobs, but does
1794 not report a problem if it is not possible to do so.
1795
1796 *SOLVER_ESSENTIAL*::
1797 Makes the job an essential job. If there is a problem with the job, the
1798 solver will not propose to remove the job as one solution (unless all
1799 other solutions are also to remove essential jobs).
1800
1801 *SOLVER_CLEANDEPS*::
1802 The solver will try to also erase all packages dragged in through
1803 dependencies when erasing the package. This needs SOLVER_USERINSTALLED
1804 jobs to maximize user satisfaction.
1805
1806 *SOLVER_FORCEBEST*::
1807 Insist on the best package for install, update, and distupgrade jobs. If
1808 this flag is not used, the solver will use the second-best package if the
1809 best package cannot be installed for some reason. When this flag is used,
1810 the solver will generate a problem instead.
1811
1812 *SOLVER_TARGETED*::
1813 Forces targeted operation update and distupgrade jobs. See the section
1814 about targeted updates about more information.
1815
1816 Set constants.
1817
1818 *SOLVER_SETEV*::
1819 The job specified the exact epoch and version of the package set.
1820
1821 *SOLVER_SETEVR*::
1822 The job specified the exact epoch, version, and release of the package set.
1823
1824 *SOLVER_SETARCH*::
1825 The job specified the exact architecture of the packages from the set.
1826
1827 *SOLVER_SETVENDOR*::
1828 The job specified the exact vendor of the packages from the set.
1829
1830 *SOLVER_SETREPO*::
1831 The job specified the exact repository of the packages from the set.
1832
1833 *SOLVER_SETNAME*::
1834 The job specified the exact name of the packages from the set.
1835
1836 *SOLVER_NOAUTOSET*::
1837 Turn of automatic set flag generation for SOLVER_SOLVABLE jobs.
1838
1839 *SOLVER_SETMASK*::
1840 A mask containing all the above set bits.
1841
1842 See the section about set bits for more information.
1843
1844 === ATTRIBUTES ===
1845
1846         Pool *pool;                             /* read only */
1847         $job->{pool}
1848         d.pool
1849         d.pool
1850
1851 Back pointer to pool.
1852
1853         Id how;                                 /* read/write */
1854         $job->{how}
1855         d.how
1856         d.how
1857
1858 Union of the selection, action, action modifier, and set flags.
1859 The selection part describes the semantics of the ``what'' Id.
1860
1861         Id what;                                /* read/write */
1862         $job->{what}
1863         d.what
1864         d.what
1865
1866 Id describing the set of packages, the meaning depends on the
1867 selection part of the ``how'' attribute.
1868
1869 === METHODS ===
1870
1871         Solvable *solvables()
1872         my @solvables = $job->solvables();
1873         solvables = job.solvables()
1874         solvables = job.solvables()
1875
1876 Return the set of solvables of the job as an array of Solvable
1877 objects.
1878
1879         bool isemptyupdate();
1880         $job->isemptyupdate()
1881         job.isemptyupdate()
1882         job.isemptyupdate?
1883
1884 Convenience function to find out if the job describes an update
1885 job with no matching packages, i.e. a job that does nothing.
1886 Some package managers like ``zypper'' like to turn those jobs
1887 into install jobs, i.e. an update of a not-installed package
1888 will result into the installation of the package.
1889
1890         <stringification>
1891         my $str = $job->str;
1892         str = str(job)
1893         str = job.to_s
1894
1895 Return a string describing the job.
1896
1897         <equality>
1898         if ($job1 == $job2)
1899         if job1 == job2:
1900         if job1 == job2
1901
1902 Two jobs are equal if they belong to the same pool and both the
1903 ``how'' and the ``what'' attributes are the same.
1904
1905 === TARGETED UPDATES ===
1906 Libsolv has two modes for upgrades and distupgrade: targeted and
1907 untargeted. Untargeted mode means that the installed packages from
1908 the specified set will be updated to the best version. Targeted means
1909 that packages that can be updated to a package in the specified set
1910 will be updated to the best package of the set.
1911
1912 Here's an example to explain the subtle difference. Suppose that
1913 you have package A installed in version "1.1", "A-1.2" is available
1914 in one of the repositories and there is also package "B" that
1915 obsoletes package A.
1916
1917 An untargeted update of "A" will update the installed "A-1.1" to
1918 package "B", because that is the newest version (B obsoletes A and
1919 is thus newer).
1920
1921 A targeted update of "A" will update "A-1.1" to "A-1.2", as the
1922 set of packages contains both "A-1.1" and "A-1.2", and "A-1.2" is
1923 the newer one.
1924
1925 An untargeted update of "B" will do nothing, as "B" is not installed.
1926
1927 An targeted update of "B" will update "A-1.1" to "B".
1928
1929 Note that the default is to do "auto-targeting", thus if the specified
1930 set of packages does not include an installed package, the solver
1931 will assume targeted operation even if SOLVER_TARGETED is not used.
1932
1933 This mostly matches the intent of the user, with one exception: In
1934 the example above, an update of "A-1.2" will update "A-1.1" to
1935 "A-1.2" (targeted mode), but a second update of "A-1.2" will suddenly
1936 update to "B", as untargeted mode is chosen because "A-1.2" is now
1937 installed.
1938
1939 If you want to have full control over when targeting mode is chosen,
1940 turn off auto-targeting with the SOLVER_FLAG_NO_AUTOTARGET solver option.
1941 In that case, all updates are considered to be untargeted unless they
1942 include the SOLVER_TARGETED flag.
1943
1944 === SET BITS ===
1945 Set bits specify which parts of the specified packages where specified
1946 by the user. It is used by the solver when checking if an operation is
1947 allowed or not. For example, the solver will normally not allow the
1948 downgrade of an installed package. But it will not report a problem if
1949 the SOLVER_SETEVR flag is used, as it then assumes that the user specified
1950 the exact version and thus knows what he is doing.
1951
1952 So if a package "screen-1-1" is installed for the x86_64 architecture and
1953 version "2-1" is only available for the i586 architecture, installing
1954 package "screen-2.1" will ask the user for confirmation because of the
1955 different architecture. When using the Selection class to create jobs
1956 the set bits are automatically added, e.g. selecting ``screen.i586'' will
1957 automatically add SOLVER_SETARCH, and thus no problem will be reported.
1958
1959 The Solver Class
1960 ----------------
1961 Dependency solving is what this library is about. A solver object is needed
1962 for solving to store the result of the solver run. The solver object can be
1963 used multiple times for different jobs, reusing it allows the solver to
1964 re-use the dependency rules it already computed.
1965
1966 === CONSTANTS ===
1967
1968 Flags to modify some of the solver's behavior:
1969
1970 *SOLVER_FLAG_ALLOW_DOWNGRADE*::
1971 Allow the solver to downgrade packages without asking for confirmation
1972 (i.e. reporting a problem).
1973
1974 *SOLVER_FLAG_ALLOW_ARCHCHANGE*::
1975 Allow the solver to change the architecture of an installed package
1976 without asking for confirmation. Note that changes to/from noarch
1977 are always considered to be allowed.
1978
1979 *SOLVER_FLAG_ALLOW_VENDORCHANGE*::
1980 Allow the solver to change the vendor of an installed package
1981 without asking for confirmation. Each vendor is part of one or more
1982 vendor equivalence classes, normally installed packages may only
1983 change their vendor if the new vendor shares at least one equivalence
1984 class.
1985
1986 *SOLVER_FLAG_ALLOW_NAMECHANGE*::
1987 Allow the solver to change the name of an installed package, i.e.
1988 install a package with a different name that obsoletes the installed
1989 package. This option is on by default.
1990
1991 *SOLVER_FLAG_ALLOW_UNINSTALL*::
1992 Allow the solver to erase installed packages to fulfill the jobs.
1993 This flag also includes the above flags. You may want to set this
1994 flag if you only have SOLVER_ERASE jobs, as in that case it's
1995 better for the user to check the transaction overview instead of
1996 approving every single package that needs to be erased.
1997
1998 *SOLVER_FLAG_NO_UPDATEPROVIDE*::
1999 If multiple packages obsolete an installed package, the solver checks
2000 the provides of every such package and ignores all packages that
2001 do not provide the installed package name. Thus, you can have an
2002 official update candidate that provides the old name, and other
2003 packages that also obsolete the package but are not considered for
2004 updating. If you cannot use this feature, you can turn it off
2005 by setting this flag.
2006
2007 *SOLVER_FLAG_SPLITPROVIDES*::
2008 Make the solver aware of special provides of the form
2009 ``<packagename>:<path>'' used in SUSE systems to support package
2010 splits.
2011
2012 *SOLVER_FLAG_IGNORE_RECOMMENDED*::
2013 Do not process optional (aka weak) dependencies.
2014
2015 *SOLVER_FLAG_ADD_ALREADY_RECOMMENDED*::
2016 Install recommended or supplemented packages even if they have no
2017 connection to the current transaction. You can use this feature
2018 to implement a simple way for the user to install new recommended
2019 packages that were not available in the past.
2020
2021 *SOLVER_FLAG_NO_INFARCHCHECK*::
2022 Turn off the inferior architecture checking that is normally done
2023 by the solver. Normally, the solver allows only the installation
2024 of packages from the "best" architecture if a package is available
2025 for multiple architectures.
2026
2027 *SOLVER_FLAG_BEST_OBEY_POLICY*::
2028 Make the SOLVER_FORCEBEST job option consider only packages that
2029 meet the policies for installed packages, i.e. no downgrades,
2030 no architecture change, no vendor change (see the first flags
2031 of this section). If the flag is not specified, the solver will
2032 enforce the installation of the best package ignoring the
2033 installed packages, which may conflict with the set policy.
2034
2035 *SOLVER_FLAG_NO_AUTOTARGET*::
2036 Do not enable auto-targeting up update and distupgrade jobs. See
2037 the section on targeted updates for more information.
2038
2039 Basic rule types:
2040
2041 *SOLVER_RULE_UNKNOWN*::
2042 A rule of an unknown class. You should never encounter those.
2043
2044 *SOLVER_RULE_RPM*::
2045 A package dependency rule, called rpm rule for historical reasons.
2046
2047 *SOLVER_RULE_UPDATE*::
2048 A rule to implement the update policy of installed packages. Every
2049 installed package has an update rule that consists of the packages
2050 that may replace the installed package.
2051
2052 *SOLVER_RULE_FEATURE*::
2053 Feature rules are fallback rules used when a update rule is disabled. They
2054 include all packages that may replace the installed package ignoring the
2055 update policy, i.e. they contain downgrades, arch changes and so on.
2056 Without them, the solver would simply erase installed packages if their
2057 update rule gets disabled.
2058
2059 *SOLVER_RULE_JOB*::
2060 Job rules implement the job given to the solver.
2061
2062 *SOLVER_RULE_DISTUPGRADE*::
2063 This are simple negative assertions that make sure that only packages
2064 are kept that are also available in one of the repositories.
2065
2066 *SOLVER_RULE_INFARCH*::
2067 Infarch rules are also negative assertions, they disallow the installation
2068 of packages when there are packages of the same name but with a better
2069 architecture.
2070
2071 *SOLVER_RULE_CHOICE*::
2072 Choice rules are used to make sure that the solver prefers updating to
2073 installing different packages when some dependency is provided by
2074 multiple packages with different names. The solver may always break
2075 choice rules, so you will not see them when a problem is found.
2076
2077 *SOLVER_RULE_LEARNT*::
2078 These rules are generated by the solver to keep it from running into
2079 the same problem multiple times when it has to backtrack. They are
2080 the main reason why a sat solver is faster then other dependency solver
2081 implementations.
2082
2083 Special dependency rule types:
2084
2085 *SOLVER_RULE_RPM_NOT_INSTALLABLE*::
2086 This rule was added to prevent the installation of a package of an
2087 architecture that does not work on the system.
2088
2089 *SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP*::
2090 The package contains a required dependency which was not provided by
2091 any package.
2092
2093 *SOLVER_RULE_RPM_PACKAGE_REQUIRES*::
2094 Similar to SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP, but in this case
2095 some packages provided the dependency but none of them could be
2096 installed due to other dependency issues.
2097
2098 *SOLVER_RULE_RPM_SELF_CONFLICT*::
2099 The package conflicts with itself. This is not allowed by older rpm
2100 versions.
2101
2102 *SOLVER_RULE_RPM_PACKAGE_CONFLICT*::
2103 To fulfill the dependencies two packages need to be installed, but
2104 one of the packages contains a conflict with the other one.
2105
2106 *SOLVER_RULE_RPM_SAME_NAME*::
2107 The dependencies can only be fulfilled by multiple versions of
2108 a package, but installing multiple versions of the same package
2109 is not allowed.
2110
2111 *SOLVER_RULE_RPM_PACKAGE_OBSOLETES*::
2112 To fulfill the dependencies two packages need to be installed, but
2113 one of the packages obsoletes the other one.
2114
2115 *SOLVER_RULE_RPM_IMPLICIT_OBSOLETES*::
2116 To fulfill the dependencies two packages need to be installed, but
2117 one of the packages has provides a dependency that is obsoleted
2118 by the other one. See the POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES
2119 flag.
2120
2121 *SOLVER_RULE_RPM_INSTALLEDPKG_OBSOLETES*::
2122 To fulfill the dependencies a package needs to be installed that is
2123 obsoleted by an installed package. See the POOL_FLAG_NOINSTALLEDOBSOLETES
2124 flag.
2125
2126 *SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP*::
2127 The user asked for installation of a package providing a specific
2128 dependency, but no available package provides it.
2129
2130 *SOLVER_RULE_JOB_UNKNOWN_PACKAGE*::
2131 The user asked for installation of a package with a specific name,
2132 but no available package has that name.
2133
2134 *SOLVER_RULE_JOB_PROVIDED_BY_SYSTEM*::
2135 The user asked for the erasure of a dependency that is provided by the
2136 system (i.e. for special hardware or language dependencies), this
2137 cannot be done with a job.
2138
2139 *SOLVER_RULE_JOB_UNSUPPORTED*::
2140 The user asked for something that is not yet implemented, e.g. the
2141 installation of all packages at once.
2142
2143 Policy error constants
2144
2145 *POLICY_ILLEGAL_DOWNGRADE*::
2146 The solver ask for permission before downgrading packages.
2147
2148 *POLICY_ILLEGAL_ARCHCHANGE*::
2149 The solver ask for permission before changing the architecture of installed
2150 packages.
2151
2152 *POLICY_ILLEGAL_VENDORCHANGE*::
2153 The solver ask for permission before changing the vendor of installed
2154 packages.
2155
2156 *POLICY_ILLEGAL_NAMECHANGE*::
2157 The solver ask for permission before replacing an installed packages with
2158 a package that has a different name.
2159
2160 Solution element type constants
2161
2162 *SOLVER_SOLUTION_JOB*::
2163 The problem can be solved by removing the specified job.
2164
2165 *SOLVER_SOLUTION_POOLJOB*::
2166 The problem can be solved by removing the specified job that is defined
2167 in the pool.
2168
2169 *SOLVER_SOLUTION_INFARCH*::
2170 The problem can be solved by allowing the installation of the specified
2171 package with an inferior architecture.
2172
2173 *SOLVER_SOLUTION_DISTUPGRADE*::
2174 The problem can be solved by allowing to keep the specified package
2175 installed.
2176
2177 *SOLVER_SOLUTION_BEST*::
2178 The problem can be solved by allowing to install the specified package
2179 that is not the best available package.
2180
2181 *SOLVER_SOLUTION_ERASE*::
2182 The problem can be solved by allowing to erase the specified package.
2183
2184 *SOLVER_SOLUTION_REPLACE*::
2185 The problem can be solved by allowing to replace the package with some
2186 other package.
2187
2188 *SOLVER_SOLUTION_REPLACE_DOWNGRADE*::
2189 The problem can be solved by allowing to replace the package with some
2190 other package that has a lower version.
2191
2192 *SOLVER_SOLUTION_REPLACE_ARCHCHANGE*::
2193 The problem can be solved by allowing to replace the package with some
2194 other package that has a different architecture.
2195
2196 *SOLVER_SOLUTION_REPLACE_VENDORCHANGE*::
2197 The problem can be solved by allowing to replace the package with some
2198 other package that has a different vendor.
2199
2200 *SOLVER_SOLUTION_REPLACE_NAMECHANGE*::
2201 The problem can be solved by allowing to replace the package with some
2202 other package that has a different name.
2203
2204
2205 Reason constants
2206
2207 *SOLVER_REASON_UNRELATED*::
2208 The package status did not change as it was not related to any job.
2209
2210 *SOLVER_REASON_UNIT_RULE*::
2211 The package was installed/erased/kept because of a unit rule, i.e. a rule
2212 where all literals but one were false.
2213
2214 *SOLVER_REASON_KEEP_INSTALLED*::
2215 The package was chosen when trying to keep as many packages installed as
2216 possible.
2217
2218 *SOLVER_REASON_RESOLVE_JOB*::
2219 The decision happened to fulfill a job rule.
2220
2221 *SOLVER_REASON_UPDATE_INSTALLED*::
2222 The decision happened to fulfill a package update request.
2223
2224 *SOLVER_REASON_CLEANDEPS_ERASE*::
2225 The package was erased when cleaning up dependencies from other erased
2226 packages.
2227
2228 *SOLVER_REASON_RESOLVE*::
2229 The package was installed to fulfill package dependencies.
2230
2231 *SOLVER_REASON_WEAKDEP*::
2232 The package was installed because of a weak dependency (Recommends or
2233 Supplements).
2234
2235 *SOLVER_REASON_RESOLVE_ORPHAN*::
2236 The decision about the package was made when deciding the fate of orphaned
2237 packages.
2238
2239 *SOLVER_REASON_RECOMMENDED*::
2240 This is a special case of SOLVER_REASON_WEAKDEP.
2241
2242 *SOLVER_REASON_SUPPLEMENTED*::
2243 This is a special case of SOLVER_REASON_WEAKDEP.
2244
2245
2246 === ATTRIBUTES ===
2247
2248         Pool *pool;                             /* read only */
2249         $job->{pool}
2250         d.pool
2251         d.pool
2252
2253 Back pointer to pool.
2254
2255 === METHODS ===
2256
2257         int set_flag(int flag, int value)
2258         my $oldvalue = $solver->set_flag($flag, $value);
2259         oldvalue = solver.set_flag(flag, value)
2260         oldvalue = solver.set_flag(flag, value)
2261
2262         int get_flag(int flag)
2263         my $value = $solver->get_flag($flag);
2264         value = solver.get_flag(flag)
2265         value = solver.get_flag(flag)
2266
2267 Set/get a solver specific flag. The flags define the policies the solver has
2268 to obey. The flags are explained in the CONSTANTS section of this class.
2269
2270         Problem *solve(Job *jobs)
2271         my @problems = $solver->solve(\@jobs);
2272         problems = solver.solve(jobs)
2273         problems = solver.solve(jobs)
2274
2275 Solve a problem specified in the job list (plus the jobs defined in the pool).
2276 Returns an array of problems that need user interaction, or an empty array
2277 if no problems were encountered. See the Problem class on how to deal with
2278 problems.
2279
2280         Transaction transaction()
2281         my $trans = $solver->transaction();
2282         trans = solver.transaction()
2283         trans = solver.transaction()
2284
2285 Return the transaction to implement the calculated package changes. A transaction
2286 is available even if problems were found, this is useful for interactive user
2287 interfaces that show both the job result and the problems.
2288
2289         int reason = describe_decision(Solvable *s, Rule *OUTPUT)
2290         my ($reason, $rule) = $solver->describe_decision($solvable);
2291         (reason, rule) = solver.describe_decision(solvable)
2292         (reason, rule) = solver.describe_decision(solvable)
2293
2294 Return the reason why a specific solvable was installed or erased. For most of
2295 the reasons the rule that triggered the decision is also returned.
2296
2297 The Problem Class
2298 -----------------
2299 Problems are the way of the solver to interact with the user. You can simply list
2300 all problems and terminate your program, but a better way is to present solutions to
2301 the user and let him pick the ones he likes.
2302
2303 === ATTRIBUTES ===
2304
2305         Solver *solv;                           /* read only */
2306         $problem->{solv}
2307         problem.solv
2308         problem.solv
2309
2310 Back pointer to solver object.
2311
2312         Id id;                                  /* read only */
2313         $problem->{id}
2314         problem.id
2315         problem.id
2316
2317 Id of the problem. The first problem has Id 1, they are numbered consecutively.
2318
2319 === METHODS ===
2320
2321         Rule findproblemrule()
2322         my $probrule = $problem->findproblemrule();
2323         probrule = problem.findproblemrule()
2324         probrule = problem.findproblemrule()
2325
2326 Return the rule that caused the problem. Of course in most situations there is no
2327 single responsible rule, but many rules that interconnect with each created the
2328 problem. Nevertheless, the solver uses some heuristic approach to find a rule
2329 that somewhat describes the problem best to the user.
2330
2331         Rule *findallproblemrules(bool unfiltered = 0)
2332         my @probrules = $problem->findallproblemrules();
2333         probrules = problem.findallproblemrule()
2334         probrules = problem.findallproblemrule()
2335
2336 Return all rules responsible for the problem. The returned set of rules contains
2337 all the needed information why there was a problem, but it's hard to present
2338 them to the user in a sensible way. The default is to filter out all update and
2339 job rules (unless the returned rules only consist of those types).
2340
2341         Solution *solutions()
2342         my @solutions = $problem->solutions();
2343         solutions = problem.solutions()
2344         solutions = problem.solutions()
2345
2346 Return an array containing multiple possible solutions to fix the problem. See
2347 the solution class for more information.
2348
2349         int solution_count()
2350         my $cnt = $problem->solution_count();
2351         cnt = problem.solution_count()
2352         cnt = problem.solution_count()
2353
2354 Return the number of solutions without creating solution objects.
2355
2356         <stringification>
2357         my $str = $problem->str;
2358         str = str(problem)
2359         str = problem.to_s
2360
2361 Return a string describing the problem. This is a convenience function, it is
2362 a shorthand for calling findproblemrule(), then ruleinfo() on the problem
2363 rule and problemstr() on the ruleinfo object.
2364
2365 The Rule Class
2366 --------------
2367 Rules are the basic block of sat solving. Each package dependency gets translated
2368 into one or multiple rules.
2369
2370 === ATTRIBUTES ===
2371
2372         Solver *solv;                           /* read only */
2373         $rule->{solv}
2374         rule.solv
2375         rule.solv
2376
2377 Back pointer to solver object.
2378
2379         Id id;                                  /* read only */
2380         $rule->{id}
2381         rule.id
2382         rule.id
2383
2384 The id of the rule.
2385
2386         int type;                               /* read only */
2387         $rule->{type}
2388         rule.type
2389         rule.type
2390
2391 The basic type of the rule. See the constant section of the solver class for the type list.
2392
2393 === METHODS ===
2394
2395         Ruleinfo info()
2396         my $ruleinfo = $rule->info();
2397         ruleinfo = rule.info()
2398         ruleinfo = rule.info()
2399
2400 Return a Ruleinfo object that contains information about why the rule was created. But
2401 see the allinfos() method below.
2402
2403         Ruleinfo *allinfos()
2404         my @ruleinfos = $rule->allinfos();
2405         ruleinfos = rule.allinfos()
2406         ruleinfos = rule.allinfos()
2407
2408 As the same dependency rule can get created because of multiple dependencies, one
2409 Ruleinfo is not enough to describe the reason. Thus the allinfos() method returns
2410 an array of all infos about a rule.
2411
2412         <equality>
2413         if ($rule1 == $rule2)
2414         if rule1 == rule2:
2415         if rule1 == rule2
2416
2417 Two rules are equal if they belong to the same solver and have the same id.
2418
2419 The Ruleinfo Class
2420 ------------------
2421 A Ruleinfo describes one reason why a rule was created.
2422
2423 === ATTRIBUTES ===
2424
2425         Solver *solv;                           /* read only */
2426         $ruleinfo->{solv}
2427         ruleinfo.solv
2428         ruleinfo.solv
2429
2430 Back pointer to solver object.
2431
2432         int type;                               /* read only */
2433         $ruleinfo->{type}
2434         ruleinfo.type
2435         ruleinfo.type
2436
2437 The type of the ruleinfo. See the constant section of the solver class for the
2438 rule type list and the special type list.
2439
2440         Dep *dep;                               /* read only */
2441         $ruleinfo->{dep}
2442         ruleinfo.dep
2443         ruleinfo.dep
2444
2445 The dependency leading to the creation of the rule.
2446
2447         Dep *dep_id;                            /* read only */
2448         $ruleinfo->{'dep_id'}
2449         ruleinfo.dep_id
2450         ruleinfo.dep_id
2451
2452 The Id of the dependency leading to the creation of the rule, or zero.
2453
2454         Solvable *solvable;                     /* read only */
2455         $ruleinfo->{solvable}
2456         ruleinfo.solvable
2457         ruleinfo.solvable
2458
2459 The involved Solvable, e.g. the one containing the dependency.
2460
2461         Solvable *othersolvable;                /* read only */
2462         $ruleinfo->{othersolvable}
2463         ruleinfo.othersolvable
2464         ruleinfo.othersolvable
2465
2466 The other involved Solvable (if any), e.g. the one containing providing
2467 the dependency for conflicts.
2468
2469         const char *problemstr();
2470         my $str = $ruleinfo->problemstr();
2471         str = ruleinfo.problemstr()
2472         str = ruleinfo.problemstr()
2473
2474 A string describing the ruleinfo from a problem perspective. This probably
2475 only makes sense if the rule is part of a problem.
2476
2477 The Solution Class
2478 ------------------
2479 A solution solves one specific problem. It consists of multiple solution elements
2480 that all need to be executed.
2481
2482 === ATTRIBUTES ===
2483
2484         Solver *solv;                           /* read only */
2485         $solution->{solv}
2486         solution.solv
2487         solution.solv
2488
2489 Back pointer to solver object.
2490
2491         Id problemid;                           /* read only */
2492         $solution->{problemid}
2493         solution.problemid
2494         solution.problemid
2495
2496 Id of the problem the solution solves.
2497
2498         Id id;                                  /* read only */
2499         $solution->{id}
2500         solution.id
2501         solution.id
2502
2503 Id of the solution. The first solution has Id 1, they are numbered consecutively.
2504
2505 === METHODS ===
2506
2507         Solutionelement *elements(bool expandreplaces = 0)
2508         my @solutionelements = $solution->elements();
2509         solutionelements = solution.elements()
2510         solutionelements = solution.elements()
2511
2512 Return an array containing the elements describing what needs to be done to
2513 implement the specific solution. If expandreplaces is true, elements of type
2514 SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace
2515 elements describing the policy mismatches.
2516
2517         int element_count()
2518         my $cnt = $solution->solution_count();
2519         cnt = solution.element_count()
2520         cnt = solution.element_count()
2521
2522 Return the number of solution elements without creating objects. Note that the
2523 count does not match the number of objects returned by the elements() method
2524 of expandreplaces is set to true.
2525
2526
2527 The Solutionelement Class
2528 -------------------------
2529 A solution element describes a single action of a solution. The action is always
2530 either to remove one specific job or to add a new job that installs or erases
2531 a single specific package.
2532
2533 === ATTRIBUTES ===
2534
2535         Solver *solv;                           /* read only */
2536         $solutionelement->{solv}
2537         solutionelement.solv
2538         solutionelement.solv
2539
2540 Back pointer to solver object.
2541
2542         Id problemid;                           /* read only */
2543         $solutionelement->{problemid}
2544         solutionelement.problemid
2545         solutionelement.problemid
2546
2547 Id of the problem the element (partly) solves.
2548
2549         Id solutionid;                          /* read only */
2550         $solutionelement->{solutionid}
2551         solutionelement.solutionid
2552         solutionelement.solutionid
2553
2554 Id of the solution the element is a part of.
2555
2556         Id id;                                  /* read only */
2557         $solutionelement->{id}
2558         solutionelement.id
2559         solutionelement.id
2560
2561 Id of the solution element. The first element has Id 1, they are numbered consecutively.
2562
2563         Id type;                                /* read only */
2564         $solutionelement->{type}
2565         solutionelement.type
2566         solutionelement.type
2567
2568 Type of the solution element. See the constant section of the solver class for the
2569 existing types.
2570
2571         Solvable *solvable;                     /* read only */
2572         $solutionelement->{solvable}
2573         solutionelement.solvable
2574         solutionelement.solvable
2575
2576 The installed solvable that needs to be replaced for replacement elements.
2577
2578         Solvable *replacement;                  /* read only */
2579         $solutionelement->{replacement}
2580         solutionelement.replacement
2581         solutionelement.replacement
2582
2583 The solvable that needs to be installed to fix the problem.
2584
2585         int jobidx;                             /* read only */
2586         $solutionelement->{jobidx}
2587         solutionelement.jobidx
2588         solutionelement.jobidx
2589
2590 The index of the job that needs to be removed to fix the problem, or -1 if the
2591 element is of another type. Note that it's better to change the job to SOLVER_NOOP
2592 type so that the numbering of other elements does not get disturbed. This
2593 method works both for types SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB.
2594
2595 === METHODS ===
2596
2597         Solutionelement *replaceelements()
2598         my @solutionelements = $solutionelement->replaceelements();
2599         solutionelements = solutionelement.replaceelements()
2600         solutionelements = solutionelement.replaceelements()
2601
2602 If the solution element is of type SOLVER_SOLUTION_REPLACE, return an array of
2603 elements describing the policy mismatches, otherwise return a copy of the
2604 element. See also the ``expandreplaces'' option in the solution's elements()
2605 method.
2606
2607         int illegalreplace()
2608         my $illegal = $solutionelement->illegalreplace();
2609         illegal = solutionelement.illegalreplace()
2610         illegal = solutionelement.illegalreplace()
2611
2612 Return an integer that contains the policy mismatch bits or-ed together, or
2613 zero if there was no policy mismatch. See the policy error constants in
2614 the solver class.
2615
2616         Job Job()
2617         my $job = $solutionelement->Job();
2618         illegal = solutionelement.Job()
2619         illegal = solutionelement.Job()
2620
2621 Create a job that implements the solution element. Add this job to the array
2622 of jobs for all elements of type different to SOLVER_SOLUTION_JOB and
2623 SOLVER_SOLUTION_POOLJOB. For the later two, a SOLVER_NOOB Job is created,
2624 you should replace the old job with the new one.
2625
2626         const char *str()
2627         my $str = $solutionelement->str();
2628         str = solutionelement.str()
2629         str = solutionelement.str()
2630
2631 A string describing the change the solution element consists of.
2632
2633 The Transaction Class
2634 ---------------------
2635 Transactions describe the output of a solver run. A transaction contains
2636 a number of transaction elements, each either the installation of a new
2637 package or the removal of an already installed package. The Transaction
2638 class supports a classify() method that puts the elements into different
2639 groups so that a transaction can be presented to the user in a meaningful
2640 way.
2641
2642 === CONSTANTS ===
2643
2644 Transaction element types, both active and passive
2645
2646 *SOLVER_TRANSACTION_IGNORE*::
2647 This element does nothing. Used to map element types that do not match
2648 the view mode.
2649
2650 *SOLVER_TRANSACTION_INSTALL*::
2651 This element installs a package.
2652
2653 *SOLVER_TRANSACTION_ERASE*::
2654 This element erases a package.
2655
2656 *SOLVER_TRANSACTION_MULTIINSTALL*::
2657 This element installs a package with a different version keeping the other
2658 versions installed.
2659
2660 *SOLVER_TRANSACTION_MULTIREINSTALL*::
2661 This element reinstalls a installed package keeping the other versions
2662 installed.
2663
2664 Transaction element types, active view
2665
2666 *SOLVER_TRANSACTION_REINSTALL*::
2667 This element re-installs a package, i.e. installs the same package again.
2668
2669 *SOLVER_TRANSACTION_CHANGE*::
2670 This element installs a package with same name, version, architecture but
2671 different content.
2672
2673 *SOLVER_TRANSACTION_UPGRADE*::
2674 This element installs a newer version of an installed package.
2675
2676 *SOLVER_TRANSACTION_DOWNGRADE*::
2677 This element installs a older version of an installed package.
2678
2679 *SOLVER_TRANSACTION_OBSOLETES*::
2680 This element installs a package that obsoletes an installed package.
2681
2682 Transaction element types, passive view
2683
2684 *SOLVER_TRANSACTION_REINSTALLED*::
2685 This element re-installs a package, i.e. installs the same package again.
2686
2687 *SOLVER_TRANSACTION_CHANGED*::
2688 This element replaces an installed package with one of the same name,
2689 version, architecture but different content.
2690
2691 *SOLVER_TRANSACTION_UPGRADED*::
2692 This element replaces an installed package with a new version.
2693
2694 *SOLVER_TRANSACTION_DOWNGRADED*::
2695 This element replaces an installed package with an old version.
2696
2697 *SOLVER_TRANSACTION_OBSOLETED*::
2698 This element replaces an installed package with a package that obsoletes
2699 it.
2700
2701 Pseudo element types for showing extra information used by classify()
2702
2703 *SOLVER_TRANSACTION_ARCHCHANGE*::
2704 This element replaces an installed package with a package of a different
2705 architecture.
2706
2707 *SOLVER_TRANSACTION_VENDORCHANGE*::
2708 This element replaces an installed package with a package of a different
2709 vendor.
2710
2711 Transaction mode flags
2712
2713 *SOLVER_TRANSACTION_SHOW_ACTIVE*::
2714 Filter for active view types. The default is to return passive view type,
2715 i.e. to show how the installed packages get changed.
2716
2717 *SOLVER_TRANSACTION_SHOW_OBSOLETES*::
2718 Do not map the obsolete view type into INSTALL/ERASE elements.
2719
2720 *SOLVER_TRANSACTION_SHOW_ALL*::
2721 If multiple packages replace an installed package, only the best of them
2722 is kept as OBSOLETE element, the other ones are mapped to INSTALL/ERASE
2723 elements. This is because most applications want to show just one package
2724 replacing the installed one. The SOLVER_TRANSACTION_SHOW_ALL makes the
2725 library keep all OBSOLETE elements.
2726
2727 *SOLVER_TRANSACTION_SHOW_MULTIINSTALL*::
2728 The library maps MULTIINSTALL elements to simple INSTALL elements. This
2729 flag can be used to disable the mapping.
2730
2731 *SOLVER_TRANSACTION_CHANGE_IS_REINSTALL*::
2732 Use this flag if you want to map CHANGE elements to the REINSTALL type.
2733
2734 *SOLVER_TRANSACTION_OBSOLETE_IS_UPGRADE*::
2735 Use this flag if you want to map OBSOLETE elements to the UPGRADE type.
2736
2737 *SOLVER_TRANSACTION_MERGE_ARCHCHANGES*::
2738 Do not add extra categories for every architecture change, instead cumulate
2739 them in one category.
2740
2741 *SOLVER_TRANSACTION_MERGE_VENDORCHANGES*::
2742 Do not add extra categories for every vendor change, instead cumulate
2743 them in one category.
2744
2745 *SOLVER_TRANSACTION_RPM_ONLY*::
2746 Special view mode that just returns IGNORE, ERASE, INSTALL, MULTIINSTALL
2747 elements. Useful if you want to find out what to feed to the underlying
2748 package manager.
2749
2750 Transaction order flags
2751
2752 *SOLVER_TRANSACTION_KEEP_ORDERDATA*::
2753 Do not throw away the dependency graph used for ordering the transaction.
2754 This flag is needed if you want to do manual ordering.
2755
2756 === ATTRIBUTES ===
2757
2758         Pool *pool;                             /* read only */
2759         $trans->{pool}
2760         trans.pool
2761         trans.pool
2762
2763 Back pointer to pool.
2764
2765 === METHODS ===
2766
2767         bool isempty();
2768         $trans->isempty()
2769         trans.isempty()
2770         trans.isempty?
2771
2772 Returns true if the transaction does not do anything, i.e. has no elements.
2773
2774         Solvable *newsolvables();
2775         my @newsolvables = $trans->newsolvables();
2776         newsolvables = trans.newsolvables()
2777         newsolvables = trans.newsolvables()
2778
2779 Return all packages that are to be installed by the transaction. This are
2780 the packages that need to be downloaded from the repositories.
2781
2782         Solvable *keptsolvables();
2783         my @keptsolvables = $trans->keptsolvables();
2784         keptsolvables = trans.keptsolvables()
2785         keptsolvables = trans.keptsolvables()
2786
2787 Return all installed packages that the transaction will keep installed.
2788
2789         Solvable *steps();
2790         my @steps = $trans->steps();
2791         steps = trans.steps()
2792         steps = trans.steps()
2793
2794 Return all solvables that need to be installed (if the returned solvable
2795 is not already installed) or erased (if the returned solvable is installed).
2796 A step is also called a transaction element.
2797
2798         int steptype(Solvable *solvable, int mode)
2799         my $type = $trans->steptype($solvable, $mode);
2800         type = trans.steptype(solvable, mode)
2801         type = trans.steptype(solvable, mode)
2802
2803 Return the transaction type of the specified solvable. See the CONSTANTS
2804 sections for the mode argument flags and the list of returned types.
2805
2806         TransactionClass *classify(int mode = 0)
2807         my @classes = $trans->classify();
2808         classes = trans.classify()
2809         classes = trans.classify()
2810
2811 Group the transaction elements into classes so that they can be displayed
2812 in a structured way. You can use various mapping mode flags to tweak
2813 the result to match your preferences, see the mode argument flag in
2814 the CONSTANTS section. See the TransactionClass class for how to deal
2815 with the returned objects.
2816
2817         Solvable othersolvable(Solvable *solvable);
2818         my $other = $trans->othersolvable($solvable);
2819         other = trans.othersolvable(solvable)
2820         other = trans.othersolvable(solvable)
2821
2822 Return the ``other'' solvable for a given solvable. For installed packages
2823 the other solvable is the best package with the same name that replaces
2824 the installed package, or the best package of the obsoleting packages if
2825 the package does not get replaced by one with the same name.
2826
2827 For to be installed packages, the ``other'' solvable is the best installed
2828 package with the same name that will be replaced, or the best packages
2829 of all the packages that are obsoleted if the new package does not replace
2830 a package with the same name.
2831
2832 Thus, the ``other'' solvable is normally the package that is also shown
2833 for a given package.
2834
2835         Solvable *allothersolvables(Solvable *solvable);
2836         my @others = $trans->allothersolvables($solvable);
2837         others = trans.allothersolvables(solvable)
2838         others = trans.allothersolvables(solvable)
2839
2840 For installed packages, returns all of the packages that replace us. For to
2841 be installed packages, returns all of the packages that the new package
2842 replaces. The special ``other'' solvable is always the first entry of the
2843 returned array.
2844
2845         int calc_installsizechange();
2846         my $change = $trans->calc_installsizechange();
2847         change = trans.calc_installsizechange()
2848         change = trans.calc_installsizechange()
2849
2850 Return the size change of the installed system in kilobytes (kibibytes).
2851
2852         void order(int flags = 0);
2853         $trans->order();
2854         trans.order()
2855         trans.order()
2856
2857 Order the steps in the transactions so that dependant packages are updated
2858 before packages that depend on them. For rpm, you can also use rpmlib's
2859 ordering functionality, debian's dpkg does not provide a way to order a
2860 transaction.
2861
2862 === ACTIVE/PASSIVE VIEW ===
2863
2864 Active view list what new packages get installed, while passive view shows
2865 what happens to the installed packages. Most often there's not much
2866 difference between the two modes, but things get interesting of multiple
2867 package get replaced by one new package. Say you have installed package
2868 A-1-1 and B-1-1, and now install A-2-1 with has a new dependency that
2869 obsoletes B. The transaction elements will be
2870
2871   updated   A-1-1 (other: A-2-1)
2872   obsoleted B-1-1 (other: A-2-1)
2873
2874 in passive mode, but
2875
2876   update A-2-1 (other: A-1-1)
2877   erase  B
2878
2879 in active mode. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the
2880 passive mode list will be unchanged but the active mode list will just
2881 contain A-2-1.
2882
2883 The Transactionclass Class
2884 --------------------------
2885 Objects of this type are returned by the classify() Transaction method.
2886
2887 === ATTRIBUTES ===
2888
2889         Transaction *transaction;               /* read only */
2890         $class->{transaction}
2891         class.transaction
2892         class.transaction
2893
2894 Back pointer to transaction object.
2895
2896         int type;                               /* read only */
2897         $class->{type}
2898         class.type
2899         class.type
2900
2901 The type of the transaction elements in the class.
2902
2903         int count;                              /* read only */
2904         $class->{count}
2905         class.count
2906         class.count
2907
2908 The number of elements in the class.
2909
2910         const char *fromstr;
2911         $class->{fromstr}
2912         class.fromstr
2913         class.fromstr
2914
2915 The old vendor or architecture.
2916
2917         const char *tostr;
2918         $class->{tostr}
2919         class.tostr
2920         class.tostr
2921
2922 The new vendor or architecture.
2923
2924         Id fromid;
2925         $class->{fromid}
2926         class.fromid
2927         class.fromid
2928
2929 The id of the old vendor or architecture.
2930
2931         Id toid;
2932         $class->{toid}
2933         class.toid
2934         class.toid
2935
2936 The id of the new vendor or architecture.
2937
2938 === METHODS ===
2939
2940         void solvables();
2941         my @solvables = $class->solvables();
2942         solvables = class.solvables()
2943         solvables = class.solvables()
2944
2945 Return the solvables for all transaction elements in the class.
2946
2947 Checksums
2948 ---------
2949 Checksums (also called hashes) are used to make sure that downloaded data is
2950 not corrupt and also as a fingerprint mechanism to check if data has changed.
2951
2952 === CLASS METHODS ===
2953
2954         Chksum Chksum(Id type)
2955         my $chksum = solv::Chksum->new($type);
2956         chksum = solv.Chksum(type)
2957         chksum = Solv::Chksum.new(type)
2958
2959 Create a checksum object. Currently the following types are supported:
2960
2961         REPOKEY_TYPE_MD5
2962         REPOKEY_TYPE_SHA1
2963         REPOKEY_TYPE_SHA256
2964
2965 These keys are constants in the *solv* class.
2966
2967         Chksum Chksum(Id type, const char *hex)
2968         my $chksum = solv::Chksum->new($type, $hex);
2969         chksum = solv.Chksum(type, hex)
2970         chksum = Solv::Chksum.new(type, hex)
2971
2972 Create an already finalized checksum object.
2973
2974 === ATTRIBUTES ===
2975
2976         Id type;                        /* read only */
2977         $chksum->{type}
2978         chksum.type
2979         chksum.type
2980
2981 Return the type of the checksum object.
2982
2983 === METHODS ===
2984
2985         void add(const char *str)
2986         $chksum->add($str);
2987         chksum.add(str)
2988         chksum.add(str)
2989
2990 Add a string to the checksum.
2991
2992         void add_fp(FILE *fp)
2993         $chksum->add_fp($file);
2994         chksum.add_fp(file)
2995         chksum.add_fp(file)
2996
2997 Add the contents of a file to the checksum.
2998
2999         void add_stat(const char *filename)
3000         $chksum->add_stat($filename);
3001         chksum.add_stat(filename)
3002         chksum.add_stat(filename)
3003
3004 Stat the file and add the dev/ino/size/mtime member to the checksum. If the
3005 stat fails, the members are zeroed.
3006
3007         void add_fstat(int fd)
3008         $chksum->add_fstat($fd);
3009         chksum.add_fstat(fd)
3010         chksum.add_fstat(fd)
3011
3012 Same as add_stat, but instead of the filename a file descriptor is used.
3013
3014         unsigned char *raw()
3015         my $raw = $chksum->raw();
3016         raw = chksum.raw()
3017         raw = chksum.raw()
3018
3019 Finalize the checksum and return the result as raw bytes. This means that the
3020 result can contain NUL bytes or unprintable characters.
3021
3022         const char *hex()
3023         my $raw = $chksum->hex();
3024         raw = chksum.hex()
3025         raw = chksum.hex()
3026
3027 Finalize the checksum and return the result as hex string.
3028
3029         <equality>
3030         if ($chksum1 == $chksum2)
3031         if chksum1 == chksum2:
3032         if chksum1 == chksum2
3033
3034 Checksums are equal if they are of the same type and the finalized results are
3035 the same.
3036
3037         <stringification>
3038         my $str = $chksum->str;
3039         str = str(chksum)
3040         str = chksum.to_s
3041
3042 If the checksum is finished, the checksum is returned as "<type>:<hex>" string.
3043 Otherwise "<type>:unfinished" is returned.
3044
3045
3046 File Management
3047 ---------------
3048 This functions were added because libsolv uses standard *FILE* pointers to
3049 read/write files, but languages like perl have their own implementation of
3050 files. The libsolv functions also support decompression and compression, the
3051 algorithm is selected by looking at the file name extension.
3052
3053         FILE *xfopen(char *fn, char *mode = "r")
3054         my $file = solv::xfopen($path);
3055         file = solv.xfopen(path)
3056         file = Solv::xfopen(path)
3057
3058 Open a file at the specified path. The `mode` argument is passed on to the
3059 stdio library.
3060
3061         FILE *xfopen_fd(char *fn, int fileno)
3062         my $file = solv::xfopen_fd($path, $fileno);
3063         file = solv.xfopen_fd(path, fileno)
3064         file = Solv::xfopen_fd(path, fileno)
3065
3066 Create a file handle from the specified file descriptor. The path argument is
3067 only used to select the correct (de-)compression algorithm, use an empty path
3068 if you want to make sure to read/write raw data.
3069
3070 === METHODS ===
3071
3072         int fileno()
3073         my $fileno = $file->fileno();
3074         fileno = file.fileno()
3075         fileno = file.fileno()
3076
3077 Return file file descriptor of the file. If the file is not open, `-1` is
3078 returned.
3079
3080         int dup()
3081         my $fileno = $file->dup();
3082         fileno = file.dup()
3083         fileno = file.dup()
3084
3085 Return a copy of the descriptor of the file. If the file is not open, `-1` is
3086 returned.
3087
3088         bool flush()
3089         $file->flush();
3090         file.flush()
3091         file.flush()
3092
3093 Flush the file. Returns false if there was an error. Flushing a closed file
3094 always returns true.
3095
3096         bool close()
3097         $file->close();
3098         file.close()
3099         file.close()
3100
3101 Close the file. This is needed for languages like Ruby, that do not destruct
3102 objects right after they are no longer referenced. In that case, it is good
3103 style to close open files so that the file descriptors are freed right away.
3104 Returns false if there was an error.
3105
3106
3107 The Repodata Class
3108 ------------------
3109 The Repodata stores attributes for packages and the repository itself, each
3110 repository can have multiple repodata areas. You normally only need to
3111 directly access them if you implement lazy downloading of repository data.
3112 Repodata areas are created by calling the repository's add_repodata() method
3113 or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING
3114 flag.
3115
3116 === ATTRIBUTES ===
3117
3118         Repo *repo;                     /* read only */
3119         $data->{repo}
3120         data.repo
3121         data.repo
3122
3123 Back pointer to repository object.
3124
3125         Id id;                                  /* read only */
3126         $data->{id}
3127         data.id
3128         data.id
3129
3130 The id of the repodata area. Repodata ids of different repositories overlap.
3131
3132 === METHODS ===
3133
3134         internalize();
3135         $data->internalize();
3136         data.internalize()
3137         data.internalize()
3138
3139 Internalize newly added data. The lookup functions will only see the new data
3140 after it has been internalized.
3141
3142         bool write(FILE *fp);
3143         $data->write($fp);
3144         data.write(fp)
3145         data.write(fp)
3146
3147 Write the contents of the repodata area as solv file.
3148
3149         bool add_solv(FILE *fp, int flags = 0);
3150         $data->add_solv($fp);
3151         data.add_solv(fp)
3152         data.add_solv(fp)
3153
3154 Replace a stub repodata object with the data from a solv file. This method
3155 automatically adds the REPO_USE_LOADING flag. It should only be used from
3156 a load callback.
3157
3158         void create_stubs();
3159         $data->create_stubs()
3160         data.create_stubs()
3161         data.create_stubs()
3162
3163 Create stub repodatas from the information stored in the repodata meta
3164 area.
3165
3166         void extend_to_repo();
3167         $data->extend_to_repo();
3168         data.extend_to_repo()
3169         data.extend_to_repo()
3170
3171 Extend the repodata so that it has the same size as the repo it belongs to.
3172 This method is only needed when switching to a just written repodata extension
3173 to make the repodata match the written extension (which is always of the
3174 size of the repo).
3175
3176         <equality>
3177         if ($data1 == $data2)
3178         if data1 == data2:
3179         if data1 == data2
3180
3181 Two repodata objects are equal if they belong to the same repository and have
3182 the same id.
3183
3184 === DATA RETRIEVAL METHODS ===
3185
3186         const char *lookup_str(Id solvid, Id keyname)
3187         my $string = $data->lookup_str($solvid, $keyname);
3188         string = data.lookup_str(solvid, keyname)
3189         string = data.lookup_str(solvid, keyname)
3190
3191         Id *lookup_idarray(Id solvid, Id keyname)
3192         my @ids = $data->lookup_idarray($solvid, $keyname);
3193         ids = data.lookup_idarray(solvid, keyname)
3194         ids = data.lookup_idarray(solvid, keyname)
3195
3196         Chksum lookup_checksum(Id solvid, Id keyname)
3197         my $chksum = $data->lookup_checksum($solvid, $keyname);
3198         chksum = data.lookup_checksum(solvid, keyname)
3199         chksum = data.lookup_checksum(solvid, keyname)
3200
3201 Lookup functions. Return the data element stored in the specified solvable.
3202 The methods probably only make sense to retrieve data from the special
3203 SOLVID_META solvid that stores repodata meta information.
3204
3205 === DATA STORAGE METHODS ===
3206
3207         void set_id(Id solvid, Id keyname, DepId id);
3208         $data->set_id($solvid, $keyname, $id);
3209         data.set_id(solvid, keyname, id)
3210         data.set_id(solvid, keyname, id)
3211
3212         void set_str(Id solvid, Id keyname, const char *str);
3213         $data->set_str($solvid, $keyname, $str);
3214         data.set_str(solvid, keyname, str)
3215         data.set_str(solvid, keyname, str)
3216
3217         void set_poolstr(Id solvid, Id keyname, const char *str);
3218         $data->set_poolstr($solvid, $keyname, $str);
3219         data.set_poolstr(solvid, keyname, str)
3220         data.set_poolstr(solvid, keyname, str)
3221
3222         void set_checksum(Id solvid, Id keyname, Chksum *chksum);
3223         $data->set_checksum($solvid, $keyname, $chksum);
3224         data.set_checksum(solvid, keyname, chksum)
3225         data.set_checksum(solvid, keyname, chksum)
3226
3227         void add_idarray(Id solvid, Id keyname, DepId id);
3228         $data->add_idarray($solvid, $keyname, $id);
3229         data.add_idarray(solvid, keyname, id)
3230         data.add_idarray(solvid, keyname, id)
3231
3232         Id new_handle();
3233         my $handle = $data->new_handle();
3234         handle = data.new_handle()
3235         handle = data.new_handle()
3236
3237         void add_flexarray(Id solvid, Id keyname, Id handle);
3238         $data->add_flexarray($solvid, $keyname, $handle);
3239         data.add_flexarray(solvid, keyname, handle)
3240         data.add_flexarray(solvid, keyname, handle)
3241
3242 Data storage methods. Probably only useful to store data in the special
3243 SOLVID_META solvid that stores repodata meta information. Note that
3244 repodata areas can have their own Id pool (see the REPO_LOCALPOOL flag),
3245 so be careful if you need to store ids. Arrays are created by calling
3246 the add function for every element. A flexarray is an array of
3247 sub-structures, call new_handle to create a new structure, use the
3248 handle as solvid to fill the structure with data and call add_flexarray
3249 to put the structure in an array.
3250
3251
3252 The Datapos Class
3253 -----------------
3254 Datapos objects describe a specific position in the repository data area.
3255 Thus they are only valid until the repository is modified in some way.
3256 Datapos objects can be created by the pos() and parentpos() methods of
3257 a Datamatch object or by accessing the ``meta'' attribute of a repository.
3258
3259 === ATTRIBUTES ===
3260
3261         Repo *repo;                     /* read only */
3262         $data->{repo}
3263         data.repo
3264         data.repo
3265
3266 Back pointer to repository object.
3267
3268 === METHODS ===
3269
3270         Dataiterator(Id keyname, const char *match, int flags)
3271         my $di = $datapos->Dataiterator($keyname, $match, $flags);
3272         di = datapos.Dataiterator(keyname, match, flags)
3273         di = datapos.Dataiterator(keyname, match, flags)
3274
3275 Create a Dataiterator at the position of the datapos object.
3276
3277         const char *lookup_deltalocation(unsigned int *OUTPUT);
3278         my ($location, $medianr) = $datapos->lookup_deltalocation();
3279         location, medianr = datapos.lookup_deltalocation()
3280         location, medianr = datapos.lookup_deltalocation()
3281
3282 Return a tuple containing the on-media location and an optional media number
3283 for a delta rpm. This obviously only works if the data position points to
3284 structure describing a delta rpm.
3285
3286         const char *lookup_deltaseq();
3287         my $seq = $datapos->lookup_deltaseq();
3288         seq = datapos.lookup_deltaseq();
3289         seq = datapos.lookup_deltaseq();
3290
3291 Return the delta rpm sequence from the structure describing a delta rpm.
3292
3293 === DATA RETRIEVAL METHODS ===
3294
3295         const char *lookup_str(Id keyname)
3296         my $string = $datapos->lookup_str($keyname);
3297         string = datapos.lookup_str(keyname)
3298         string = datapos.lookup_str(keyname)
3299
3300         Id lookup_id(Id solvid, Id keyname)
3301         my $id = $datapos->lookup_id($keyname);
3302         id = datapos.lookup_id(keyname)
3303         id = datapos.lookup_id(keyname)
3304
3305         unsigned long long lookup_num(Id keyname, unsigned long long notfound = 0)
3306         my $num = $datapos->lookup_num($keyname);
3307         num = datapos.lookup_num(keyname)
3308         num = datapos.lookup_num(keyname)
3309
3310         bool lookup_void(Id keyname)
3311         my $bool = $datapos->lookup_void($keyname);
3312         bool = datapos.lookup_void(keyname)
3313         bool = datapos.lookup_void(keyname)
3314
3315         Id *lookup_idarray(Id keyname)
3316         my @ids = $datapos->lookup_idarray($keyname);
3317         ids = datapos.lookup_idarray(keyname)
3318         ids = datapos.lookup_idarray(keyname)
3319
3320         Chksum lookup_checksum(Id keyname)
3321         my $chksum = $datapos->lookup_checksum($keyname);
3322         chksum = datapos.lookup_checksum(keyname)
3323         chksum = datapos.lookup_checksum(keyname)
3324
3325 Lookup functions. Note that the returned Ids are always translated into
3326 the Ids of the global pool even if the repodata area contains its own pool.
3327
3328         Dataiterator Dataiterator(Id keyname, const char *match = 0, int flags = 0)
3329         my $di = $datapos->Dataiterator($keyname, $match, $flags);
3330         di = datapos.Dataiterator(keyname, match, flags)
3331         di = datapos.Dataiterator(keyname, match, flags)
3332
3333         for my $d (@$di)
3334         for d in di:
3335         for d in di
3336
3337 Iterate over the matching data elements. See the Dataiterator class for more
3338 information.
3339
3340 Author
3341 ------
3342 Michael Schroeder <mls@suse.de>
3343