libzypp  17.7.0
PoolQuery.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_POOLQUERY_H
13 #define ZYPP_POOLQUERY_H
14 
15 #include <iosfwd>
16 #include <set>
17 #include <map>
18 
19 #include "zypp/base/Regex.h"
20 #include "zypp/base/PtrTypes.h"
21 #include "zypp/base/Function.h"
22 
23 #include "zypp/sat/SolvIterMixin.h"
24 #include "zypp/sat/LookupAttr.h"
25 #include "zypp/base/StrMatcher.h"
26 #include "zypp/sat/Pool.h"
27 
29 namespace zypp
30 {
31 
32  namespace detail
33  {
34  class PoolQueryIterator;
35  }
36 
38  //
39  // CLASS NAME : PoolQuery
40  //
90  class PoolQuery : public sat::SolvIterMixin<PoolQuery, detail::PoolQueryIterator>
91  {
92  public:
93  typedef std::set<ResKind> Kinds;
94  typedef std::set<std::string> StrContainer;
95  typedef std::map<sat::SolvAttr, StrContainer> AttrRawStrMap;
96 
98  typedef unsigned int size_type;
99 
100  public:
101  typedef function<bool( const sat::Solvable & )> ProcessResolvable;
102 
103  PoolQuery();
104  ~PoolQuery();
105 
120  const_iterator begin() const;
121 
123  const_iterator end() const;
124 
126  bool empty() const;
127 
129  size_type size() const;
131 
136  void execute(ProcessResolvable fnc);
137 
153  void addKind(const ResKind & kind);
154 
161  void addRepo(const std::string &repoalias);
162 
165 
170  ALL = 0, // both install filter and uninstall filter bits are 0
173  };
174 
176  void setInstalledOnly();
178  void setUninstalledOnly();
181 
183 
195  void addString(const std::string & value);
196 
224  void addAttribute( const sat::SolvAttr & attr, const std::string & value = "" );
225 
287  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Rel & op, const Edition & edition );
289  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Rel & op, const Edition & edition, const Arch & arch );
291  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Rel & op, const Edition & edition, const Arch & arch, Match::Mode mode );
292 
294  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Edition & edition )
295  { addDependency( attr, name, Rel::EQ, edition ); }
297  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Edition & edition, const Arch & arch )
298  { addDependency( attr, name, Rel::EQ, edition, arch ); }
299 
301  void addDependency( const sat::SolvAttr & attr, const std::string & name )
302  { addDependency( attr, name, Rel::ANY, Edition() ); }
304  void addDependency( const sat::SolvAttr & attr, const std::string & name, const Arch & arch )
305  { addDependency( attr, name, Rel::ANY, Edition(), arch ); }
306 
308  void addDependency( const sat::SolvAttr & attr, const Rel & op, const Edition & edition )
309  { addDependency( attr, std::string(), op, edition ); }
311  void addDependency( const sat::SolvAttr & attr, const Rel & op, const Edition & edition, const Arch & arch )
312  { addDependency( attr, std::string(), op, edition, arch ); }
313 
315  void addDependency( const sat::SolvAttr & attr, const Edition & edition )
316  { addDependency( attr, std::string(), Rel::EQ, edition ); }
318  void addDependency( const sat::SolvAttr & attr, const Edition & edition, const Arch & arch )
319  { addDependency( attr, std::string(), Rel::EQ, edition, arch ); }
320 
323  { addDependency( attr, std::string(), Rel::ANY, Edition() ); }
325  void addDependency( const sat::SolvAttr & attr, const Arch & arch )
326  { addDependency( attr, std::string(), Rel::ANY, Edition(), arch ); }
327 
332  void addDependency( const sat::SolvAttr & attr, Capability cap_r );
334 
342  void setEdition(const Edition & edition, const Rel & op = Rel::EQ);
343 
357  void setCaseSensitive( bool value = true );
358 
364  void setFilesMatchFullPath( bool value = true );
366  void setFilesMatchBasename( bool value = true )
367  { setFilesMatchFullPath( !value ); }
368 
370  void setMatchExact();
372  void setMatchSubstring();
374  void setMatchGlob();
376  void setMatchRegex();
378  void setMatchWord();
379  //void setLocale(const Locale & locale);
381 
388  void setRequireAll( bool require_all = true );
389 
390 
393 
395  const StrContainer & strings() const;
399  const AttrRawStrMap & attributes() const;
400 
401  const StrContainer & attribute(const sat::SolvAttr & attr) const;
402 
403  const Kinds & kinds() const;
404 
405  const StrContainer & repos() const;
406 
407  const Edition edition() const;
408  const Rel editionRel() const;
409 
413  bool caseSensitive() const;
414 
416  bool filesMatchFullPath() const;
418  bool filesMatchBasename() const
419  { return !filesMatchFullPath(); }
420 
421  bool matchExact() const;
422  bool matchSubstring() const;
423  bool matchGlob() const;
424  bool matchRegex() const;
425  bool matchWord() const;
426 
431  { return flags().mode(); }
432 
437  bool requireAll() const;
438 
441 
452  bool recover( std::istream &str, char delim = '\n' );
453 
463  void serialize( std::ostream &str, char delim = '\n' ) const;
464 
466  std::string asString() const;
467 
468  bool operator<(const PoolQuery& b) const;
469  bool operator==(const PoolQuery& b) const;
470  bool operator!=(const PoolQuery& b) const { return !(*this == b ); }
471 
472  // low level API
473 
480  Match flags() const;
481 
488  void setFlags( const Match & flags );
489 
490  public:
491  class Impl;
492  private:
495  };
497 
499  std::ostream & operator<<( std::ostream & str, const PoolQuery & obj );
500 
502  std::ostream & dumpOn( std::ostream & str, const PoolQuery & obj );
503 
505  namespace detail
506  {
507 
508  class PoolQueryMatcher;
509 
511  //
512  // CLASS NAME : PoolQuery::PoolQueryIterator
513  //
521  class PoolQueryIterator : public boost::iterator_adaptor<
522  PoolQueryIterator // Derived
523  , sat::LookupAttr::iterator // Base
524  , const sat::Solvable // Value
525  , boost::forward_traversal_tag // CategoryOrTraversal
526  , const sat::Solvable // Reference
527  >
528  {
529  typedef std::vector<sat::LookupAttr::iterator> Matches;
530  public:
532  typedef Matches::const_iterator matches_iterator;
533  public:
536  {}
537 
539  PoolQueryIterator( const shared_ptr<PoolQueryMatcher> & matcher_r )
540  : _matcher( matcher_r )
541  { increment(); }
542 
589  bool matchesEmpty() const { return ! _matcher; }
591  size_type matchesSize() const { return matches().size(); }
593  matches_iterator matchesBegin() const { return matches().begin(); }
595  matches_iterator matchesEnd() const { return matches().end(); }
597 
598  private:
600 
602  { return base_reference().inSolvable(); }
603 
604  void increment();
605 
606  private:
607  const Matches & matches() const;
608 
609  private:
610  shared_ptr<PoolQueryMatcher> _matcher;
611  mutable shared_ptr<Matches> _matches;
612  };
614 
616  inline std::ostream & operator<<( std::ostream & str, const PoolQueryIterator & obj )
617  { return str << obj.base(); }
618 
620  std::ostream & dumpOn( std::ostream & str, const PoolQueryIterator & obj );
621 
623  } //namespace detail
625 
627  { return detail::PoolQueryIterator(); }
628 
630 } // namespace zypp
632 
633 #endif // ZYPP_POOLQUERY_H
PoolQueryIterator(const shared_ptr< PoolQueryMatcher > &matcher_r)
PoolQuery ctor.
Definition: PoolQuery.h:539
bool matchExact() const
Definition: PoolQuery.cc:1081
A Solvable object within the sat Pool.
Definition: Solvable.h:53
std::ostream & operator<<(std::ostream &str, const PoolQueryIterator &obj)
Definition: PoolQuery.h:616
void setUninstalledOnly()
Return only packages from repos other than .
Definition: PoolQuery.cc:1030
StatusFilter
Installed status filter setters.
Definition: PoolQuery.h:169
const AttrRawStrMap & attributes() const
Map (map<SolvAttr, StrContainer>) of attribute values added via addAttribute(), addDep in string form...
Definition: PoolQuery.cc:1045
void addAttribute(const sat::SolvAttr &attr, const std::string &value="")
Filter by the value of the specified attr attribute.
Definition: PoolQuery.cc:934
void addDependency(const sat::SolvAttr &attr, const Rel &op, const Edition &edition, const Arch &arch)
Definition: PoolQuery.h:311
std::set< ResKind > Kinds
Definition: PoolQuery.h:93
String matching option flags as used e.g.
Definition: StrMatcher.h:32
void addDependency(const sat::SolvAttr &attr, const std::string &name)
Definition: PoolQuery.h:301
std::ostream & dumpOn(std::ostream &str, const PoolQueryIterator &obj)
Definition: PoolQuery.cc:1839
void addDependency(const sat::SolvAttr &attr, const std::string &name, const Arch &arch)
Definition: PoolQuery.h:304
Architecture.
Definition: Arch.h:36
PoolQuery iterator as returned by PoolQuery::begin.
Definition: PoolQuery.h:521
void setFlags(const Match &flags)
Free function to set libsolv repo search flags.
Definition: PoolQuery.cc:1024
Relational operators.
Definition: Rel.h:43
void execute(ProcessResolvable fnc)
Executes the query with the current settings.
Definition: PoolQuery.cc:1115
void addString(const std::string &value)
Add a global query string.
Definition: PoolQuery.cc:931
void setFilesMatchBasename(bool value=true)
Definition: PoolQuery.h:366
static const Rel EQ
Definition: Rel.h:50
const StrContainer & strings() const
Search strings added via addString()
Definition: PoolQuery.cc:1041
sat::SolvAttr attr
Definition: PoolQuery.cc:311
Match::Mode matchMode() const
Returns string matching mode as enum.
Definition: PoolQuery.h:430
const Matches & matches() const
Definition: PoolQuery.cc:1822
void setMatchGlob()
Set to match globs.
Definition: PoolQuery.cc:1015
void setMatchRegex()
Set to use the query strings as regexes.
Definition: PoolQuery.cc:1014
String related utilities and Regular expression matching.
detail::PoolQueryIterator const_iterator
Definition: PoolQuery.h:97
bool operator<(const PoolQuery &b) const
Definition: PoolQuery.cc:1510
bool matchesEmpty() const
False unless this is the end iterator.
Definition: PoolQuery.h:589
void addDependency(const sat::SolvAttr &attr, const std::string &name, const Rel &op, const Edition &edition)
Query "name|global op edition".
Definition: PoolQuery.cc:937
void setCaseSensitive(bool value=true)
Turn case sentitivity on or off (unsets or sets SEARCH_NOCASE flag).
Definition: PoolQuery.cc:1073
void addDependency(const sat::SolvAttr &attr, const std::string &name, const Edition &edition)
Definition: PoolQuery.h:294
void addKind(const ResKind &kind)
Filter by selectable kind.
Definition: PoolQuery.cc:928
Edition represents [epoch:]version[-release]
Definition: Edition.h:60
static const Rel ANY
Definition: Rel.h:56
Mode mode() const
Return the mode part.
Definition: StrMatcher.cc:52
bool operator!=(const PoolQuery &b) const
Definition: PoolQuery.h:470
const Kinds & kinds() const
Definition: PoolQuery.cc:1063
void addDependency(const sat::SolvAttr &attr)
Definition: PoolQuery.h:322
Matches::size_type size_type
Definition: PoolQuery.h:531
size_type size() const
Number of solvables in the query result.
Definition: PoolQuery.cc:1102
bool operator==(const PoolQuery &b) const
Definition: PoolQuery.cc:1507
void serialize(std::ostream &str, char delim='\n') const
Writes a machine-readable string representation of the query to stream.
Definition: PoolQuery.cc:1389
const StrContainer & attribute(const sat::SolvAttr &attr) const
Definition: PoolQuery.cc:1049
std::vector< sat::LookupAttr::iterator > Matches
Definition: PoolQuery.h:529
Base class providing common iterator types based on a Solvable iterator.
bool caseSensitive() const
returns true if search is case sensitive
Definition: PoolQuery.cc:1071
unsigned int size_type
Definition: PoolQuery.h:98
Solvable attribute keys.
Definition: SolvAttr.h:40
bool filesMatchFullPath() const
Whether searching in filelists looks at the full path or just at the basenames.
Definition: PoolQuery.cc:1076
std::set< std::string > StrContainer
Definition: PoolQuery.h:94
void setStatusFilterFlags(StatusFilter flags)
Set status filter directly.
Definition: PoolQuery.cc:1032
std::ostream & operator<<(std::ostream &str, const Exception &obj)
Definition: Exception.cc:147
const StrContainer & repos() const
Definition: PoolQuery.cc:1067
void addRepo(const std::string &repoalias)
Filter by repo.
Definition: PoolQuery.cc:918
void setMatchWord()
Set to match words (uses regex)
Definition: PoolQuery.cc:1016
const_iterator begin() const
Query result accessers.
Definition: PoolQuery.cc:1856
matches_iterator matchesEnd() const
End of matches.
Definition: PoolQuery.h:595
friend class boost::iterator_core_access
Definition: PoolQuery.h:599
const Rel editionRel() const
Definition: PoolQuery.cc:1058
std::ostream & dumpOn(std::ostream &str, const Capability &obj)
Definition: Capability.cc:444
void setInstalledOnly()
Return only repo packages.
Definition: PoolQuery.cc:1028
bool recover(std::istream &str, char delim='\n')
Reads from stream query.
Definition: PoolQuery.cc:1206
Mode
Mode flags (mutual exclusive).
Definition: StrMatcher.h:40
void addDependency(const sat::SolvAttr &attr, const std::string &name, const Edition &edition, const Arch &arch)
Definition: PoolQuery.h:297
const_iterator end() const
An iterator pointing to the end of the query result.
Definition: PoolQuery.h:626
SolvableIdType size_type
Definition: PoolMember.h:126
const Edition edition() const
Definition: PoolQuery.cc:1056
Matches::const_iterator matches_iterator
Definition: PoolQuery.h:532
void setMatchSubstring()
Set to substring (the default).
Definition: PoolQuery.cc:1012
std::map< sat::SolvAttr, StrContainer > AttrRawStrMap
Definition: PoolQuery.h:95
Meta-data query API.
Definition: PoolQuery.h:90
bool matchWord() const
Definition: PoolQuery.cc:1086
void setEdition(const Edition &edition, const Rel &op=Rel::EQ)
Set version condition.
Definition: PoolQuery.cc:1006
void setMatchExact()
Set to match exact string instead of substring.
Definition: PoolQuery.cc:1013
A sat capability.
Definition: Capability.h:59
shared_ptr< PoolQueryMatcher > _matcher
Definition: PoolQuery.h:610
StatusFilter statusFilterFlags() const
Definition: PoolQuery.cc:1092
bool matchSubstring() const
Definition: PoolQuery.cc:1082
matches_iterator matchesBegin() const
Begin of matches.
Definition: PoolQuery.h:593
bool empty() const
Whether the result is empty.
Definition: PoolQuery.cc:1095
shared_ptr< Matches > _matches
Definition: PoolQuery.h:611
void addDependency(const sat::SolvAttr &attr, const Edition &edition, const Arch &arch)
Definition: PoolQuery.h:318
sat::Solvable dereference() const
Definition: PoolQuery.h:601
Match flags() const
Free function to get libsolv repo search flags.
Definition: PoolQuery.cc:1022
void setFilesMatchFullPath(bool value=true)
If set (default), look at the full path when searching in filelists.
Definition: PoolQuery.cc:1078
RW_pointer< Impl > _pimpl
Pointer to implementation.
Definition: PoolQuery.h:491
void addDependency(const sat::SolvAttr &attr, const Arch &arch)
Definition: PoolQuery.h:325
std::string asString() const
Return a human-readable description of the query.
Definition: PoolQuery.cc:1498
Resolvable kinds.
Definition: ResKind.h:32
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
size_type matchesSize() const
Number of attribute matches.
Definition: PoolQuery.h:591
function< bool(const sat::Solvable &)> ProcessResolvable
Definition: PoolQuery.h:101
bool matchGlob() const
Definition: PoolQuery.cc:1083
bool requireAll() const
Whether all values added via addString() or addAttribute() are required to match the values of the re...
Definition: PoolQuery.cc:1089
void addDependency(const sat::SolvAttr &attr, const Rel &op, const Edition &edition)
Definition: PoolQuery.h:308
PoolQueryIterator()
Default ctor is also end.
Definition: PoolQuery.h:535
bool matchRegex() const
Definition: PoolQuery.cc:1084
bool filesMatchBasename() const
Definition: PoolQuery.h:418
void addDependency(const sat::SolvAttr &attr, const Edition &edition)
Definition: PoolQuery.h:315
void setRequireAll(bool require_all=true)
Require that all of the values set by addString or addAttribute match the values of respective attrib...
Definition: PoolQuery.cc:1036