libzypp
15.28.6
|
Meta-data query API. More...
#include <PoolQuery.h>
Classes | |
class | Impl |
Public Types | |
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 |
typedef function< bool(const sat::Solvable &)> | ProcessResolvable |
Public Types inherited from zypp::sat::SolvIterMixin< PoolQuery, detail::PoolQueryIterator > | |
typedef size_t | size_type |
typedef detail::PoolQueryIterator | Solvable_iterator |
typedef transform_iterator < asPoolItem, Solvable_iterator > | PoolItem_iterator |
typedef transform_iterator < ui::asSelectable, UnifiedSolvable_iterator > | Selectable_iterator |
Public Member Functions | |
PoolQuery () | |
~PoolQuery () | |
void | execute (ProcessResolvable fnc) |
Executes the query with the current settings. More... | |
void | addKind (const ResKind &kind) |
Filter by selectable kind. More... | |
void | addRepo (const std::string &repoalias) |
Filter by repo. More... | |
void | addString (const std::string &value) |
Add a global query string. More... | |
void | addAttribute (const sat::SolvAttr &attr, const std::string &value="") |
Filter by the value of the specified attr attribute. More... | |
void | setEdition (const Edition &edition, const Rel &op=Rel::EQ) |
Set version condition. More... | |
bool | recover (std::istream &str, char delim= '\n') |
Reads from stream query. More... | |
void | serialize (std::ostream &str, char delim= '\n') const |
Writes a machine-readable string representation of the query to stream. More... | |
std::string | asString () const |
Return a human-readable description of the query. More... | |
bool | operator< (const PoolQuery &b) const |
bool | operator== (const PoolQuery &b) const |
bool | operator!= (const PoolQuery &b) const |
Match | flags () const |
Free function to get libsolv repo search flags. More... | |
void | setFlags (const Match &flags) |
Free function to set libsolv repo search flags. More... | |
void | setRequireAll (bool require_all=true) ZYPP_DEPRECATED |
bool | requireAll () const ZYPP_DEPRECATED |
const_iterator | begin () const |
Query result accessers. More... | |
const_iterator | end () const |
An iterator pointing to the end of the query result. More... | |
bool | empty () const |
Whether the result is empty. More... | |
size_type | size () const |
Number of solvables in the query result. More... | |
Filter by dependencies matching a broken down capability <tt>name [op edition]</tt> and/or architecture. | |
The capabilities Globing and regex are supported. Global query strings defined by addString are considered. So without any An optional {
setMatchGlob();
setCaseSensitive( false );
}
{
setMatchGlob();
setCaseSensitive( false );
addString( "kde*" );
}
This is the list of valid dependency attributes: SolvAttr::provides
SolvAttr::obsoletes
SolvAttr::conflicts
SolvAttr::requires
SolvAttr::recommends
SolvAttr::suggests
SolvAttr::supplements
SolvAttr::enhances
// Find all packages providing "kernel > 2.0"
// // Find all packages named "kernel" and with edition "> 2.0"
| |
void | addDependency (const sat::SolvAttr &attr, const std::string &name, const Rel &op, const Edition &edition) |
Query "name|global op edition" . More... | |
void | addDependency (const sat::SolvAttr &attr, const std::string &name, const Rel &op, const Edition &edition, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr, const std::string &name, const Edition &edition) |
void | addDependency (const sat::SolvAttr &attr, const std::string &name, const Edition &edition, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr, const std::string &name) |
void | addDependency (const sat::SolvAttr &attr, const std::string &name, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr, const Rel &op, const Edition &edition) |
void | addDependency (const sat::SolvAttr &attr, const Rel &op, const Edition &edition, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr, const Edition &edition) |
void | addDependency (const sat::SolvAttr &attr, const Edition &edition, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr) |
void | addDependency (const sat::SolvAttr &attr, const Arch &arch) |
void | addDependency (const sat::SolvAttr &attr, Capability cap_r) |
Text Matching Options | |
| |
void | setCaseSensitive (bool value=true) |
Turn case sentitivity on or off (unsets or sets SEARCH_NOCASE flag). More... | |
void | setFilesMatchFullPath (bool value=true) |
If set (default), look at the full path when searching in filelists. More... | |
void | setFilesMatchBasename (bool value=true) |
void | setMatchExact () |
Set to match exact string instead of substring. More... | |
void | setMatchSubstring () |
Set to substring (the default). More... | |
void | setMatchGlob () |
Set to match globs. More... | |
void | setMatchRegex () |
Set to use the query strings as regexes. More... | |
void | setMatchWord () |
Set substring to match words. More... | |
getters | |
const StrContainer & | strings () const |
Search strings added via addString() More... | |
const AttrRawStrMap & | attributes () const |
Map (map<SolvAttr, StrContainer>) of attribute values added via addAttribute(), addDep in string form. More... | |
const StrContainer & | attribute (const sat::SolvAttr &attr) const |
const Kinds & | kinds () const |
const StrContainer & | repos () const |
const Edition | edition () const |
const Rel | editionRel () const |
bool | caseSensitive () const |
returns true if search is case sensitive More... | |
bool | filesMatchFullPath () const |
Whether searching in filelists looks at the full path or just at the basenames. More... | |
bool | filesMatchBasename () const |
bool | matchExact () const |
bool | matchSubstring () const |
bool | matchGlob () const |
bool | matchRegex () const |
bool | matchWord () const |
Match::Mode | matchMode () const |
Returns string matching mode as enum. More... | |
StatusFilter | statusFilterFlags () const |
Public Member Functions inherited from zypp::sat::SolvIterMixin< PoolQuery, detail::PoolQueryIterator > | |
bool | empty () const |
Whether the collection is epmty. More... | |
size_type | size () const |
Size of the collection. More... | |
bool | contains (const TSolv &solv_r) const |
Whether collection contains a specific Solvable. More... | |
Solvable_iterator | solvableBegin () const |
Solvable_iterator | solvableEnd () const |
Iterable< Solvable_iterator > | solvable () const |
PoolItem_iterator | poolItemBegin () const |
PoolItem_iterator | poolItemEnd () const |
Iterable< PoolItem_iterator > | poolItem () const |
Selectable_iterator | selectableBegin () const |
Selectable_iterator | selectableEnd () const |
Iterable< Selectable_iterator > | selectable () const |
Private Attributes | |
RW_pointer< Impl > | _pimpl |
Pointer to implementation. More... | |
Related Functions | |
(Note that these are not member functions.) | |
std::ostream & | operator<< (std::ostream &str, const PoolQuery &obj) |
std::ostream & | dumpOn (std::ostream &str, const PoolQuery &obj) |
enum | StatusFilter { ALL = 0, INSTALLED_ONLY = 1, UNINSTALLED_ONLY = 2 } |
Installed status filter setters. More... | |
void | setInstalledOnly () |
Return only repo packages. More... | |
void | setUninstalledOnly () |
Return only packages from repos other than . More... | |
void | setStatusFilterFlags (StatusFilter flags) |
Set status filter directly. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from zypp::sat::SolvIterMixin< PoolQuery, detail::PoolQueryIterator > | |
SolvIterMixin () | |
SolvIterMixin (const SolvIterMixin &) | |
~SolvIterMixin () | |
void | operator= (const SolvIterMixin &) |
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 addString() and 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 addString() and addAttribute() for more details).
The begin() and end() methods return a PoolQueryIterator returning sat::Solvable objects which can easily be turned into Resolvable objects. Additionally, thanx to the sat::SolvIterMixin, a Selectable and PoolItem iterators are automatically available.
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; // ... }
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.
Definition at line 90 of file PoolQuery.h.
typedef std::set<ResKind> zypp::PoolQuery::Kinds |
Definition at line 93 of file PoolQuery.h.
typedef std::set<std::string> zypp::PoolQuery::StrContainer |
Definition at line 94 of file PoolQuery.h.
typedef std::map<sat::SolvAttr, StrContainer> zypp::PoolQuery::AttrRawStrMap |
Definition at line 95 of file PoolQuery.h.
Definition at line 97 of file PoolQuery.h.
typedef unsigned int zypp::PoolQuery::size_type |
Definition at line 98 of file PoolQuery.h.
typedef function<bool( const sat::Solvable & )> zypp::PoolQuery::ProcessResolvable |
Definition at line 101 of file PoolQuery.h.
Installed status filter setters.
Filter by status (installed uninstalled)
Enumerator | |
---|---|
ALL | |
INSTALLED_ONLY | |
UNINSTALLED_ONLY |
Definition at line 162 of file PoolQuery.h.
zypp::PoolQuery::PoolQuery | ( | ) |
Definition at line 803 of file PoolQuery.cc.
zypp::PoolQuery::~PoolQuery | ( | ) |
Definition at line 807 of file PoolQuery.cc.
detail::PoolQueryIterator zypp::PoolQuery::begin | ( | ) | const |
Query result accessers.
Compile the query and return an iterator to the result.
sat::MatchInvalidRegexException | if the query was about to use a regex which failed to compile. |
Definition at line 1773 of file PoolQuery.cc.
|
inline |
An iterator pointing to the end of the query result.
Definition at line 605 of file PoolQuery.h.
bool zypp::PoolQuery::empty | ( | ) | const |
Whether the result is empty.
Definition at line 968 of file PoolQuery.cc.
PoolQuery::size_type zypp::PoolQuery::size | ( | ) | const |
Number of solvables in the query result.
Definition at line 975 of file PoolQuery.cc.
void zypp::PoolQuery::execute | ( | ProcessResolvable | fnc | ) |
Executes the query with the current settings.
Results are yielded via the fnc callback.
Definition at line 988 of file PoolQuery.cc.
void zypp::PoolQuery::addKind | ( | const ResKind & | kind | ) |
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).
Definition at line 820 of file PoolQuery.cc.
void zypp::PoolQuery::addRepo | ( | const std::string & | repoalias | ) |
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).
Definition at line 810 of file PoolQuery.cc.
void zypp::PoolQuery::setInstalledOnly | ( | ) |
Return only repo packages.
Definition at line 910 of file PoolQuery.cc.
void zypp::PoolQuery::setUninstalledOnly | ( | ) |
Return only packages from repos other than .
Definition at line 912 of file PoolQuery.cc.
void zypp::PoolQuery::setStatusFilterFlags | ( | PoolQuery::StatusFilter | flags | ) |
void zypp::PoolQuery::addString | ( | const std::string & | value | ) |
Add a global query string.
The string added via this method is applied to all query attributes as if addAttribute(..., ) 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 any of these strings will match the value.
Definition at line 823 of file PoolQuery.cc.
void zypp::PoolQuery::addAttribute | ( | const sat::SolvAttr & | attr, |
const std::string & | value = "" |
||
) |
Filter by the value of the specified attr attribute.
This can be any of the available solvable attributes.
This method can be used multiple times with the same 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 any of these strings will match the value.
"name"
part only. Any "op edition"
part of a Capability is not considered at all. attr | Attribute identfier. Use sat::Solvattr::* constants |
value | What to search for. |
Definition at line 826 of file PoolQuery.cc.
void zypp::PoolQuery::addDependency | ( | const sat::SolvAttr & | attr, |
const std::string & | name, | ||
const Rel & | op, | ||
const Edition & | edition | ||
) |
Query "name|global op edition"
.
Definition at line 829 of file PoolQuery.cc.
void zypp::PoolQuery::addDependency | ( | const sat::SolvAttr & | attr, |
const std::string & | name, | ||
const Rel & | op, | ||
const Edition & | edition, | ||
const Arch & | arch | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 832 of file PoolQuery.cc.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 282 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 285 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 289 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 292 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 296 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 299 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 303 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 306 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 310 of file PoolQuery.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 313 of file PoolQuery.h.
void zypp::PoolQuery::addDependency | ( | const sat::SolvAttr & | attr, |
Capability | cap_r | ||
) |
Definition at line 875 of file PoolQuery.cc.
Set version condition.
This will filter out solvables not matching solvableEdition op edition
.
edition | Edition to look for. |
op | Found-wanted relation operator. |
Definition at line 892 of file PoolQuery.cc.
void zypp::PoolQuery::setCaseSensitive | ( | bool | value = true | ) |
Turn case sentitivity on or off (unsets or sets SEARCH_NOCASE flag).
PoolQuery defaults to case insensitive search unless this method is used.
value | Whether to turn the case sensitivity on (default) or off. |
Definition at line 951 of file PoolQuery.cc.
void zypp::PoolQuery::setFilesMatchFullPath | ( | bool | value = true | ) |
If set (default), look at the full path when searching in filelists.
Otherwise just match the the basenames.
Definition at line 956 of file PoolQuery.cc.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 354 of file PoolQuery.h.
void zypp::PoolQuery::setMatchExact | ( | ) |
Set to match exact string instead of substring.
Definition at line 899 of file PoolQuery.cc.
void zypp::PoolQuery::setMatchSubstring | ( | ) |
Set to substring (the default).
Definition at line 898 of file PoolQuery.cc.
void zypp::PoolQuery::setMatchGlob | ( | ) |
Set to match globs.
Definition at line 901 of file PoolQuery.cc.
void zypp::PoolQuery::setMatchRegex | ( | ) |
Set to use the query strings as regexes.
Definition at line 900 of file PoolQuery.cc.
void zypp::PoolQuery::setMatchWord | ( | ) |
Set substring to match words.
Definition at line 902 of file PoolQuery.cc.
const PoolQuery::StrContainer & zypp::PoolQuery::strings | ( | ) | const |
Search strings added via addString()
Definition at line 919 of file PoolQuery.cc.
const PoolQuery::AttrRawStrMap & zypp::PoolQuery::attributes | ( | ) | const |
Map (map<SolvAttr, StrContainer>) of attribute values added via addAttribute(), addDep in string form.
Definition at line 923 of file PoolQuery.cc.
const PoolQuery::StrContainer & zypp::PoolQuery::attribute | ( | const sat::SolvAttr & | attr | ) | const |
Definition at line 927 of file PoolQuery.cc.
const PoolQuery::Kinds & zypp::PoolQuery::kinds | ( | ) | const |
Definition at line 941 of file PoolQuery.cc.
const PoolQuery::StrContainer & zypp::PoolQuery::repos | ( | ) | const |
Definition at line 945 of file PoolQuery.cc.
const Edition zypp::PoolQuery::edition | ( | ) | const |
Definition at line 934 of file PoolQuery.cc.
const Rel zypp::PoolQuery::editionRel | ( | ) | const |
Definition at line 936 of file PoolQuery.cc.
bool zypp::PoolQuery::caseSensitive | ( | ) | const |
returns true if search is case sensitive
Definition at line 949 of file PoolQuery.cc.
bool zypp::PoolQuery::filesMatchFullPath | ( | ) | const |
Whether searching in filelists looks at the full path or just at the basenames.
Definition at line 954 of file PoolQuery.cc.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 397 of file PoolQuery.h.
bool zypp::PoolQuery::matchExact | ( | ) | const |
Definition at line 959 of file PoolQuery.cc.
bool zypp::PoolQuery::matchSubstring | ( | ) | const |
Definition at line 960 of file PoolQuery.cc.
bool zypp::PoolQuery::matchGlob | ( | ) | const |
Definition at line 961 of file PoolQuery.cc.
bool zypp::PoolQuery::matchRegex | ( | ) | const |
Definition at line 962 of file PoolQuery.cc.
bool zypp::PoolQuery::matchWord | ( | ) | const |
Definition at line 963 of file PoolQuery.cc.
|
inline |
Returns string matching mode as enum.
Definition at line 409 of file PoolQuery.h.
PoolQuery::StatusFilter zypp::PoolQuery::statusFilterFlags | ( | ) | const |
Definition at line 965 of file PoolQuery.cc.
bool zypp::PoolQuery::recover | ( | std::istream & | str, |
char | delim = '\n' |
||
) |
Reads from stream query.
Attributes is sepated by delim. Query is separated by two delim.
str | input stream which contains query |
delim | delimeter for attributes |
Definition at line 1082 of file PoolQuery.cc.
void zypp::PoolQuery::serialize | ( | std::ostream & | str, |
char | delim = '\n' |
||
) | const |
Writes a machine-readable string representation of the query to stream.
Use delim as attribute delimiter.
str | output stream to write to |
delim | delimiter for attributes |
Definition at line 1319 of file PoolQuery.cc.
string zypp::PoolQuery::asString | ( | ) | const |
Return a human-readable description of the query.
Definition at line 1415 of file PoolQuery.cc.
Definition at line 1427 of file PoolQuery.cc.
Definition at line 1424 of file PoolQuery.cc.
Definition at line 443 of file PoolQuery.h.
Match zypp::PoolQuery::flags | ( | ) | const |
Free function to get libsolv repo search flags.
Definition at line 904 of file PoolQuery.cc.
void zypp::PoolQuery::setFlags | ( | const Match & | flags | ) |
Free function to set libsolv repo search flags.
Definition at line 906 of file PoolQuery.cc.
void zypp::PoolQuery::setRequireAll | ( | bool | require_all = true | ) |
Definition at line 992 of file PoolQuery.cc.
bool zypp::PoolQuery::requireAll | ( | ) | const |
Definition at line 993 of file PoolQuery.cc.
|
related |
Stream output.
|
related |
Detailed stream output.
Definition at line 1421 of file PoolQuery.cc.
|
private |
Pointer to implementation.
Definition at line 470 of file PoolQuery.h.