/usr/include/x86_64-linux-gnu/zypp/PoolQuery.h is in libzypp-dev 15.3.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 | /*---------------------------------------------------------------------\
| ____ _ __ __ ___ |
| |__ / \ / / . \ . \ |
| / / \ V /| _/ _/ |
| / /__ | | | | | | |
| /_____||_| |_| |_| |
| |
\---------------------------------------------------------------------*/
/** \file zypp/PoolQuery.h
*
*/
#ifndef ZYPP_POOLQUERY_H
#define ZYPP_POOLQUERY_H
#include <iosfwd>
#include <set>
#include <map>
#include "zypp/base/Regex.h"
#include "zypp/base/PtrTypes.h"
#include "zypp/base/Function.h"
#include "zypp/sat/SolvIterMixin.h"
#include "zypp/sat/LookupAttr.h"
#include "zypp/base/StrMatcher.h"
#include "zypp/sat/Pool.h"
///////////////////////////////////////////////////////////////////
namespace zypp
{ /////////////////////////////////////////////////////////////////
namespace detail
{
class PoolQueryIterator;
}
///////////////////////////////////////////////////////////////////
//
// CLASS NAME : PoolQuery
//
/**
* Meta-data query API. Returns solvables of specified kinds from specified
* repositories with attributes matching the specified search strings.
*
* The search strings can be specified via \ref addString() and
* \ref addAttribute() methods. String matching type can be set using the
* setMatch*() methods. Multiple search strings for a particular attribute
* will be combined into a regex (see \ref addString() and
* \ref addAttribute() for more details).
*
* The begin() and end() methods return a PoolQueryIterator returning
* \ref sat::Solvable objects which can easily be turned into \ref Resolvable
* objects. Additionally, thanx to the \ref sat::SolvIterMixin, a Selectable
* and PoolItem iterators are automatically available.
*
* \note You will sometimes face the problem, that when using the \ref PoolItem
* iterator you hit multiple version of the same package, while when using the
* \ref ui::Selectable iterator the information which of the available candidates
* actually matched got lost. In this case class \ref PoolItemBest may help you.
* Use it to pick the best version only.
*
* <code>
* PoolQuery q;
* q.addAttribute(sat::SolvAttr::name, "zypp*");
* q.addKind(ResKind::package);
* q.setMatchGlob();
*
* for (PoolQuery::Selectable_iterator it = q.selectableBegin();
* it != q.selectableEnd(); ++it)
* {
* ui::Selectable::constPtr s = *it;
* // ...
* }
* </code>
*
* Performance considerations
*
* Results of simple queries like those using one string and/or one attribute
* and/or one repository are filtered by sat-solver's Dataiterator directly,
* and thus it is fast.
*
* Queries with multiple strings are implemented using regexes. Queries based
* on kinds, multiple repos, and multiple attributes are filtered inside
* the PoolQuery, so these tend to be slower.
*
* \see detail::PoolQueryIterator on how to inspect matches in detail.
* \see tests/zypp/PoolQuery_test.cc for more examples
* \see sat::SolvIterMixin
*/
class PoolQuery : public sat::SolvIterMixin<PoolQuery, detail::PoolQueryIterator>
{
public:
typedef std::set<ResKind> Kinds;
typedef std::set<std::string> StrContainer;
typedef std::map<sat::SolvAttr, StrContainer> AttrRawStrMap;
typedef detail::PoolQueryIterator const_iterator;
typedef unsigned int size_type;
public:
typedef function<bool( const sat::Solvable & )> ProcessResolvable;
PoolQuery();
~PoolQuery();
/** Query result accessers. */
//@{
/**
* Compile the query and return an iterator to the result.
*
* \return An iterator (\ref detail::PoolQueryIterator) returning
* sat::Solvable objects pointing at the beginning of the query result.
* \throws sat::MatchInvalidRegexException if the query was about to use a regex which
* failed to compile.
*
* \note Note that PoolQuery is derived from \ref sat::SolvIterMixin which
* makes PoolItem and Selectable iterators automatically available.
* \see \ref sat::SolvIterMixin
*/
const_iterator begin() const;
/** An iterator pointing to the end of the query result. */
const_iterator end() const;
/** Whether the result is empty. */
bool empty() const;
/** Number of solvables in the query result. */
size_type size() const;
//@}
/**
* Executes the query with the current settings.
* Results are yielded via the \a fnc callback.
*/
void execute(ProcessResolvable fnc);
/**
* Filter by selectable kind.
*
* By default, all kinds will be returned. If addKind() is used,
* only the specified kinds will be returned (multiple kinds will be ORed).
*
* Pass ResKind constants to this method, (e.g. ResKind::package).
*/
void addKind(const ResKind & kind);
/**
* Filter by repo.
*
* By default, all repos will be returned. If addRepo() is used,
* only the specified repo will be returned (multiple repos will be ORed).
*/
void addRepo(const std::string &repoalias);
/** Installed status filter setters. */
//@{
/**
* Filter by status (installed uninstalled)
*/
enum StatusFilter {
ALL = 0, // both install filter and uninstall filter bits are 0
INSTALLED_ONLY = 1,
UNINSTALLED_ONLY = 2
};
/** Return only @System repo packages */
void setInstalledOnly();
/** Return only packages from repos other than @System. */
void setUninstalledOnly();
/** Set status filter directly \see StatusFilter */
void setStatusFilterFlags( StatusFilter flags );
//@}
/**
* Add a global query string. The string added via this method is applied
* to all query attributes as if addAttribute(..., \value) was called
* for all of them.
*
* This method can be used multiple times in which case the query strings
* will be combined (together with strings added via addAttribute()) into
* a regex. Searched attribute value will match this regex if <b>any</b>
* of these strings will match the value. This can be changed by
* (not yet implemented) \ref setRequireAll() method.
*/
void addString(const std::string & value);
/**
* Filter by the \a value of the specified \a attr attribute. This can
* be any of the available solvable attributes.
*
* This method can be used multiple times with the same \a attr in which
* case the query strings will be combined (together with strings added
* via addString()) into a regex. Searched attribute value will match
* this regex if <b>any</b> of these strings will match the value.
* This can be changed by (not yet implemented) \ref setRequireAll()
* method.
*
* \note Though it is possible to use dependency attributes like
* \ref Solv::Attr::provides here, note that the query string is
* matched against a dependencies \c "name" part only. Any
* <tt>"op edition"</tt> part of a \ref Capability is \b not
* considered at all. \see \ref addDependency on how to query for
* capabilities including edition ranges.
*
* \note Solvables of a kind not supporting the specified attribute will
* <b>not</b> be returned.
* \todo check the above
*
* \param attr Attribute identfier. Use sat::Solvattr::* constants
* \param value What to search for.
*
* \see sat::SolvAttr
*/
void addAttribute( const sat::SolvAttr & attr, const std::string & value = "" );
/** \name Filter by dependencies matching a broken down capability <tt>name [op edition]</tt> and/or architecture.
*
* The capabilities \c name part may be defined as query string
* like with \ref addAttribute. Globing and regex are supported.
* Global query strings defined by \ref addString are considered.
*
* So without any <tt>op edition arch</tt> addDependency behaves the
* same as \ref addAttribute. If an edition range is given, matches
* are restricted accordingly. There are various overloads, so pick
* the one you like best.
*
* An optional \c arch argument will additionally require the matching
* solvable to be of this arch.
*
* \code
* {
* setMatchGlob();
* setCaseSensitive( false );
* addDependency( sat::SolvAttr::provides, "kde*", Rel::EQ, Edition("2.0") );
* addDependency( sat::SolvAttr::provides, "kde*", Edition("2.0") ); // same as above
* }
* {
* setMatchGlob();
* setCaseSensitive( false );
* addString( "kde*" );
* addDependency( sat::SolvAttr::provides, Rel::EQ, Edition("2.0") );// same as above
* addDependency( sat::SolvAttr::provides, Edition("2.0") ); // same as above
* }
* \endcode
*
* \note Thre's also a version of \ref addDependency provided, that takes a
* complete \ref Capability as argument. This always requires an exact match
* of the name part (as the resolver would do it).
*
* This is the list of valid dependency attributes:
* \code
* SolvAttr::provides
* SolvAttr::obsoletes
* SolvAttr::conflicts
* SolvAttr::requires
* SolvAttr::recommends
* SolvAttr::suggests
* SolvAttr::supplements
* SolvAttr::enhances
* \endcode
*
* \note <b>What happens if a non dependency attribute is passed?<\b>
* If an edition range is given, it is matched against the matching
* solvables edition instead. Without edition range it behaves the
* same as \ref addAttribute.
*
* \code
* // Find all packages providing "kernel > 2.0"
* addDependency( sat::SolvAttr::provides, "kernel", Rel::GT, Edition("2.0") );
*
* // // Find all packages named "kernel" and with edition "> 2.0"
* addDependency( sat::SolvAttr::name, "kernel", Rel::GT, Edition("2.0") );
* \endcode
*/
//@{
/** Query <tt>"name|global op edition"</tt>. */
void addDependency( const sat::SolvAttr & attr, const std::string & name, const Rel & op, const Edition & edition );
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const std::string & name, const Rel & op, const Edition & edition, const Arch & arch );
/** \overload Query <tt>"name|global == edition"</tt>. */
void addDependency( const sat::SolvAttr & attr, const std::string & name, const Edition & edition )
{ addDependency( attr, name, Rel::EQ, edition ); }
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const std::string & name, const Edition & edition, const Arch & arch )
{ addDependency( attr, name, Rel::EQ, edition, arch ); }
/** \overload Query <tt>"name|global"</tt>. */
void addDependency( const sat::SolvAttr & attr, const std::string & name )
{ addDependency( attr, name, Rel::ANY, Edition() ); }
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const std::string & name, const Arch & arch )
{ addDependency( attr, name, Rel::ANY, Edition(), arch ); }
/** \overload Query <tt>"global op edition"</tt>.*/
void addDependency( const sat::SolvAttr & attr, const Rel & op, const Edition & edition )
{ addDependency( attr, std::string(), op, edition ); }
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const Rel & op, const Edition & edition, const Arch & arch )
{ addDependency( attr, std::string(), op, edition, arch ); }
/** \overload Query <tt>"global == edition"</tt>. */
void addDependency( const sat::SolvAttr & attr, const Edition & edition )
{ addDependency( attr, std::string(), Rel::EQ, edition ); }
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const Edition & edition, const Arch & arch )
{ addDependency( attr, std::string(), Rel::EQ, edition, arch ); }
/** \overload Query <tt>"global"</tt>. */
void addDependency( const sat::SolvAttr & attr )
{ addDependency( attr, std::string(), Rel::ANY, Edition() ); }
/** \overload also restricting architecture */
void addDependency( const sat::SolvAttr & attr, const Arch & arch )
{ addDependency( attr, std::string(), Rel::ANY, Edition(), arch ); }
/** \overload Query taking a \ref Capability (always exact name match).
* \note If a non dependency attribute is passed, the \ref Capability
* will always be matched against the Solvables \c name and \c edition.
*/
void addDependency( const sat::SolvAttr & attr, Capability cap_r );
//@}
/**
* Set version condition. This will filter out solvables not matching
* <tt>solvableEdition \a op \a edition</tt>.
*
* \param edition Edition to look for.
* \param op Found-wanted relation operator.
*/
void setEdition(const Edition & edition, const Rel & op = Rel::EQ);
/** \name Text Matching Options
* \note The implementation treats an empty search string as
* <it>"match always"</it>. So if you want to actually match
* an empty value, try <tt>( "^$", setMatchRegex )</tt>.
*/
//@{
/**
* Turn case sentitivity on or off (unsets or sets \ref SEARCH_NOCASE flag).
* PoolQuery defaults to case insensitive search unless this method
* is used.
*
* \param value Whether to turn the case sensitivity on (default) or off.
*/
void setCaseSensitive( bool value = true );
/**
* If set (default), look at the full path when searching in filelists.
* Otherwise just match the the basenames.
* \see \ref Match::FILES
*/
void setFilesMatchFullPath( bool value = true );
/** \overload */
void setFilesMatchBasename( bool value = true )
{ setFilesMatchFullPath( !value ); }
/** Set to match exact string instead of substring.*/
void setMatchExact();
/** Set to substring (the default). */
void setMatchSubstring();
/** Set to match globs. */
void setMatchGlob();
/** Set to use the query strings as regexes */
void setMatchRegex();
/** Set to match words (uses regex) */
void setMatchWord();
//void setLocale(const Locale & locale);
//@}
/**
* Require that all of the values set by addString or addAttribute
* match the values of respective attributes.
*
* \todo doesn't work yet, don't use this function
*/
void setRequireAll( bool require_all = true );
/** \name getters */
//@{
/** Search strings added via addString() */
const StrContainer & strings() const;
/**
* Map (map<SolvAttr, StrContainer>) of attribute values added via
* addAttribute(), addDep in string form */
const AttrRawStrMap & attributes() const;
const StrContainer & attribute(const sat::SolvAttr & attr) const;
const Kinds & kinds() const;
const StrContainer & repos() const;
const Edition edition() const;
const Rel editionRel() const;
/**
* returns true if search is case sensitive
*/
bool caseSensitive() const;
/** Whether searching in filelists looks at the full path or just at the basenames. */
bool filesMatchFullPath() const;
/** \overload */
bool filesMatchBasename() const
{ return !filesMatchFullPath(); }
bool matchExact() const;
bool matchSubstring() const;
bool matchGlob() const;
bool matchRegex() const;
bool matchWord() const;
/** Returns string matching mode as enum.
* \see \ref Match::Mode
*/
Match::Mode matchMode() const
{ return flags().mode(); }
/**
* Whether all values added via addString() or addAttribute() are required
* to match the values of the respective attributes.
*/
bool requireAll() const;
StatusFilter statusFilterFlags() const;
//@}
/**
* Reads from stream query. Attributes is sepated by delim. Query is
* separated by two delim.
*
* \param str input stream which contains query
* \param delim delimeter for attributes
* \return true if non-empty query is recovered
*
* \see readPoolQueriesFromFile
*/
bool recover( std::istream &str, char delim = '\n' );
/**
* Writes a machine-readable string representation of the query to stream.
* Use \a delim as attribute delimiter.
*
* \param str output stream to write to
* \param delim delimiter for attributes
*
* \see writePoolQueriesToFile
*/
void serialize( std::ostream &str, char delim = '\n' ) const;
/** Return a human-readable description of the query */
std::string asString() const;
bool operator==(const PoolQuery& b) const;
bool operator!=(const PoolQuery& b) const { return !(*this == b ); }
// low level API
/**
* Free function to get libsolv repo search
* flags.
*
* \see \ref Match
*/
Match flags() const;
/**
* Free function to set libsolv repo search
* flags.
*
* \see \ref Match
*/
void setFlags( const Match & flags );
public:
class Impl;
private:
/** Pointer to implementation */
RW_pointer<Impl> _pimpl;
};
///////////////////////////////////////////////////////////////////
/** \relates PoolQuery Stream output. */
std::ostream & operator<<( std::ostream & str, const PoolQuery & obj );
/** \relates PoolQuery Detailed stream output. */
std::ostream & dumpOn( std::ostream & str, const PoolQuery & obj );
///////////////////////////////////////////////////////////////////
namespace detail
{ /////////////////////////////////////////////////////////////////
class PoolQueryMatcher;
///////////////////////////////////////////////////////////////////
//
// CLASS NAME : PoolQuery::PoolQueryIterator
//
/** \ref PoolQuery iterator as returned by \ref PoolQuery::begin.
*
* The \ref PoolQueryIterator visits sat::Solavables that do contain matches.
*
* But it also provides an iterator by itself, to allow a detailed inspection of
* the individual attribute matches within the current Solvable.
*/
class PoolQueryIterator : public boost::iterator_adaptor<
PoolQueryIterator // Derived
, sat::LookupAttr::iterator // Base
, const sat::Solvable // Value
, boost::forward_traversal_tag // CategoryOrTraversal
, const sat::Solvable // Reference
>
{
typedef std::vector<sat::LookupAttr::iterator> Matches;
public:
typedef Matches::size_type size_type;
typedef Matches::const_iterator matches_iterator;
public:
/** Default ctor is also \c end.*/
PoolQueryIterator()
{}
/** \Ref PoolQuery ctor. */
PoolQueryIterator( const shared_ptr<PoolQueryMatcher> & matcher_r )
: _matcher( matcher_r )
{ increment(); }
/** \name Detailed inspection of attribute matches within the current Solvable.
*
* The \ref matches_iterator visits all attribute matches within the current Solvable,
* providing a \ref sat::LookupAttr::iterator pointing to attribute. While a
* \ref matches_iterator itself becomes invalid if the PoolQueryIterator is advanced,
* the \ref sat::LookupAttr::iterator it pointed to stays valid, even after the query
* ended.
*
* \code
* // Setup query for "libzypp" in name or requires:
* PoolQuery q;
* q.addString( "libzypp" );
* q.setMatchSubstring();
* q.setCaseSensitive( false );
* q.addAttribute( sat::SolvAttr::name );
* q.addDependency( sat::SolvAttr::requires );
*
* // Iterate the result:
* for_( solvIter, q.begin(), q.end() )
* {
* sat::Solvable solvable( *solvIter );
* cout << "Found matches in " << solvable << endl;
* if ( verbose )
* for_( attrIter, solvIter.matchesBegin(), solvIter.matchesEnd() )
* {
* sat::LookupAttr::iterator attr( *attrIter );
* cout << " " << attr.inSolvAttr() << "\t\"" << attr.asString() << "\"" << endl;
* }
* }
*
*
* Found matches in PackageKit-0.3.11-1.12.i586(@System)
* solvable:requires "libzypp.so.523"
* Found matches in libqdialogsolver1-1.2.6-1.1.2.i586(@System)
* solvable:requires "libzypp.so.523"
* solvable:requires "libzypp >= 5.25.3-0.1.2"
* Found matches in libzypp-5.30.3-0.1.1.i586(@System)
* solvable:name "libzypp"
* Found matches in libzypp-testsuite-tools-4.2.6-8.1.i586(@System)
* solvable:name "libzypp-testsuite-tools"
* solvable:requires "libzypp.so.523"
* ...
* \endcode
*/
//@{
/** \c False unless this is the \c end iterator. */
bool matchesEmpty() const { return ! _matcher; }
/** Number of attribute matches. */
size_type matchesSize() const { return matches().size(); }
/** Begin of matches. */
matches_iterator matchesBegin() const { return matches().begin(); }
/** End of matches. */
matches_iterator matchesEnd() const { return matches().end(); }
//@}
private:
friend class boost::iterator_core_access;
sat::Solvable dereference() const
{ return base_reference().inSolvable(); }
void increment();
private:
const Matches & matches() const;
private:
shared_ptr<PoolQueryMatcher> _matcher;
mutable shared_ptr<Matches> _matches;
};
///////////////////////////////////////////////////////////////////
/** \relates PoolQueryIterator Stream output. */
inline std::ostream & operator<<( std::ostream & str, const PoolQueryIterator & obj )
{ return str << obj.base(); }
/** \relates PoolQueryIterator Detailed stream output. */
std::ostream & dumpOn( std::ostream & str, const PoolQueryIterator & obj );
///////////////////////////////////////////////////////////////////
} //namespace detail
///////////////////////////////////////////////////////////////////
inline detail::PoolQueryIterator PoolQuery::end() const
{ return detail::PoolQueryIterator(); }
/////////////////////////////////////////////////////////////////
} // namespace zypp
///////////////////////////////////////////////////////////////////
#endif // ZYPP_POOLQUERY_H
|