libzypp  17.5.0
zypp::Capability Class Reference

A sat capability. More...

#include <Capability.h>

Inheritance diagram for zypp::Capability:

Classes

struct  Matches
 matches functor. More...
 

Public Types

enum  CtorFlag { PARSED, UNPARSED }
 

Public Member Functions

 Capability ()
 Default ctor, Empty capability. More...
 
 Capability (sat::detail::IdType id_r)
 Ctor from id. More...
 
 operator bool () const
 Evaluate in a boolean context ( ! empty() ). More...
 
bool empty () const
 Whether the Capability is empty. More...
 
const char * c_str () const
 Conversion to const char * More...
 
std::string asString () const
 
CapDetail detail () const
 Helper providing more detailed information about a Capability. More...
 
sat::detail::IdType id () const
 Expert backdoor. More...
 
Ctors parsing a Capability: <tt>"name[.arch] [op edition]"</tt> or <tt>( arch, "name [op edition]")</tt>
 Capability (const char *str_r, const ResKind &prefix_r=ResKind(), CtorFlag flag_r=UNPARSED)
 Ctor from string. More...
 
 Capability (const std::string &str_r, const ResKind &prefix_r=ResKind(), CtorFlag flag_r=UNPARSED)
 
 Capability (const Arch &arch_r, const char *str_r, const ResKind &prefix_r=ResKind(), CtorFlag flag_r=UNPARSED)
 
 Capability (const Arch &arch_r, const std::string &str_r, const ResKind &prefix_r=ResKind(), CtorFlag flag_r=UNPARSED)
 
 Capability (const char *str_r, CtorFlag flag_r, const ResKind &prefix_r=ResKind())
 
 Capability (const std::string &str_r, CtorFlag flag_r, const ResKind &prefix_r=ResKind())
 
 Capability (const Arch &arch_r, const char *str_r, CtorFlag flag_r, const ResKind &prefix_r=ResKind())
 
 Capability (const Arch &arch_r, const std::string &str_r, CtorFlag flag_r, const ResKind &prefix_r=ResKind())
 
Ctors parsing a broken down Capability: <tt>( "name[.arch]", op, edition )</tt>
 Capability (const std::string &name_r, const std::string &op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 Ctor from name[.arch] op edition. More...
 
 Capability (const std::string &name_r, Rel op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 
 Capability (const std::string &name_r, Rel op_r, const Edition &ed_r, const ResKind &prefix_r=ResKind())
 
Ctors taking a broken down Capability: <tt>( arch, name, op, edition )</tt>
 Capability (const std::string &arch_r, const std::string &name_r, const std::string &op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 Ctor from arch name op edition. More...
 
 Capability (const std::string &arch_r, const std::string &name_r, Rel op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 
 Capability (const std::string &arch_r, const std::string &name_r, Rel op_r, const Edition &ed_r, const ResKind &prefix_r=ResKind())
 
 Capability (const Arch &arch_r, const std::string &name_r, const std::string &op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 
 Capability (const Arch &arch_r, const std::string &name_r, Rel op_r, const std::string &ed_r, const ResKind &prefix_r=ResKind())
 
 Capability (const Arch &arch_r, const std::string &name_r, Rel op_r, const Edition &ed_r, const ResKind &prefix_r=ResKind())
 
Ctor creating a namespace: capability.

An empty value_r (std::string or IdString) will also be mapped to IdString::Null, creating a namespace: capability which in most contexts matches all members of this namespace.

 Capability (ResolverNamespace namespace_r, IdString value_r=IdString::Null)
 
 Capability (ResolverNamespace namespace_r, const char *value_r)
 
 Capability (ResolverNamespace namespace_r, const std::string &value_r)
 

Static Public Member Functions

static bool isInterestingFileSpec (const IdString &name_r)
 Test for a filename that is likely being REQUIRED. More...
 
static bool isInterestingFileSpec (const std::string &name_r)
 
static bool isInterestingFileSpec (const char *name_r)
 
static Capability guessPackageSpec (const std::string &str_r)
 Capability parser also guessing "libzypp-1.2.3-4.5.x86_64" formats. More...
 
static Capability guessPackageSpec (const std::string &str_r, bool &rewrote_r)
 

Static Public Attributes

static const Capability Null
 No or Null Capability ( Id 0 ). More...
 
static const Capability Empty
 Empty Capability. More...
 

Static Private Member Functions

static CapMatch _doMatch (sat::detail::IdType lhs, sat::detail::IdType rhs)
 Match two Capabilities. More...
 

Private Attributes

sat::detail::IdType _id
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &str, const Capability &obj)
 
std::ostream & dumpOn (std::ostream &str, const Capability &obj)
 
bool operator== (const Capability &lhs, const Capability &rhs)
 
bool operator!= (const Capability &lhs, const Capability &rhs)
 
bool operator< (const Capability &lhs, const Capability &rhs)
 

Match two simple capabilities.

Two simple capabilities match if they have the same name and their edition ranges overlap.

Where no edition matches ANY edition.

See also
Edition::match.

If a capability expression is involved, matches returns CapMatch::irrelevant.

CapMatch matches (const Capability &rhs) const
 
CapMatch matches (const IdString &rhs) const
 
CapMatch matches (const std::string &rhs) const
 
CapMatch matches (const char *rhs) const
 
static CapMatch matches (const Capability &lhs, const Capability &rhs)
 
static CapMatch matches (const Capability &lhs, const IdString &rhs)
 
static CapMatch matches (const Capability &lhs, const std::string &rhs)
 
static CapMatch matches (const Capability &lhs, const char *rhs)
 
static CapMatch matches (const IdString &lhs, const Capability &rhs)
 
static CapMatch matches (const IdString &lhs, const IdString &rhs)
 
static CapMatch matches (const IdString &lhs, const std::string &rhs)
 
static CapMatch matches (const IdString &lhs, const char *rhs)
 
static CapMatch matches (const std::string &lhs, const Capability &rhs)
 
static CapMatch matches (const std::string &lhs, const IdString &rhs)
 
static CapMatch matches (const std::string &lhs, const std::string &rhs)
 
static CapMatch matches (const std::string &lhs, const char *rhs)
 
static CapMatch matches (const char *lhs, const Capability &rhs)
 
static CapMatch matches (const char *lhs, const IdString &rhs)
 
static CapMatch matches (const char *lhs, const std::string &rhs)
 
static CapMatch matches (const char *lhs, const char *rhs)
 

Additional Inherited Members

- Static Protected Member Functions inherited from zypp::sat::detail::PoolMember
static PoolImplmyPool ()
 

Detailed Description

A sat capability.

A Capability: "name[.arch] [op edition]"

If a certain ResKind is specified upon construction, the capabilities name part is prefixed, unless it already conatins a well known kind spec. If no ResKind is specified, it's assumed you refer to a package or the name is already prefixed:

Capability( "foo" ) ==> 'foo'
Capability( "foo", ResKind::package ) ==> 'foo'
Capability( "foo", ResKind::pattern ) ==> 'pattern:foo'
Capability( "pattern:foo" ) ==> 'pattern:foo'
// in doubt an explicit name prefix wins:
Capability( "pattern:foo", ResKind::package ) ==> 'pattern:foo'
Capability( "package:foo", ResKind::pattern ) ==> 'foo'

Definition at line 59 of file Capability.h.

Member Enumeration Documentation

◆ CtorFlag

Enumerator
PARSED 
UNPARSED 

Definition at line 62 of file Capability.h.

Constructor & Destructor Documentation

◆ Capability() [1/22]

zypp::Capability::Capability ( )
inline

Default ctor, Empty capability.

Definition at line 66 of file Capability.h.

◆ Capability() [2/22]

zypp::Capability::Capability ( sat::detail::IdType  id_r)
inlineexplicit

Ctor from id.

Definition at line 69 of file Capability.h.

◆ Capability() [3/22]

zypp::Capability::Capability ( const char *  str_r,
const ResKind prefix_r = ResKind(),
CtorFlag  flag_r = UNPARSED 
)
explicit

Ctor from string.

str_r is parsed to check whether it contains an [op edition] part, unless the PARSED flag is passed to the ctor. In that case "name[.arch]" is assumed.

Definition at line 233 of file Capability.cc.

◆ Capability() [4/22]

zypp::Capability::Capability ( const std::string &  str_r,
const ResKind prefix_r = ResKind(),
CtorFlag  flag_r = UNPARSED 
)
explicit

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 237 of file Capability.cc.

◆ Capability() [5/22]

zypp::Capability::Capability ( const Arch arch_r,
const char *  str_r,
const ResKind prefix_r = ResKind(),
CtorFlag  flag_r = UNPARSED 
)

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 241 of file Capability.cc.

◆ Capability() [6/22]

zypp::Capability::Capability ( const Arch arch_r,
const std::string &  str_r,
const ResKind prefix_r = ResKind(),
CtorFlag  flag_r = UNPARSED 
)

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 245 of file Capability.cc.

◆ Capability() [7/22]

zypp::Capability::Capability ( const char *  str_r,
CtorFlag  flag_r,
const ResKind prefix_r = ResKind() 
)

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 249 of file Capability.cc.

◆ Capability() [8/22]

zypp::Capability::Capability ( const std::string &  str_r,
CtorFlag  flag_r,
const ResKind prefix_r = ResKind() 
)

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 253 of file Capability.cc.

◆ Capability() [9/22]

zypp::Capability::Capability ( const Arch arch_r,
const char *  str_r,
CtorFlag  flag_r,
const ResKind prefix_r = ResKind() 
)

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 257 of file Capability.cc.

◆ Capability() [10/22]

zypp::Capability::Capability ( const Arch arch_r,
const std::string &  str_r,
CtorFlag  flag_r,
const ResKind prefix_r = ResKind() 
)

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 261 of file Capability.cc.

◆ Capability() [11/22]

zypp::Capability::Capability ( const std::string &  name_r,
const std::string &  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

Ctor from name[.arch] op edition.

Definition at line 269 of file Capability.cc.

◆ Capability() [12/22]

zypp::Capability::Capability ( const std::string &  name_r,
Rel  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

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 272 of file Capability.cc.

◆ Capability() [13/22]

zypp::Capability::Capability ( const std::string &  name_r,
Rel  op_r,
const Edition ed_r,
const ResKind prefix_r = ResKind() 
)

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 275 of file Capability.cc.

◆ Capability() [14/22]

zypp::Capability::Capability ( const std::string &  arch_r,
const std::string &  name_r,
const std::string &  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

Ctor from arch name op edition.

Definition at line 283 of file Capability.cc.

◆ Capability() [15/22]

zypp::Capability::Capability ( const std::string &  arch_r,
const std::string &  name_r,
Rel  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

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 286 of file Capability.cc.

◆ Capability() [16/22]

zypp::Capability::Capability ( const std::string &  arch_r,
const std::string &  name_r,
Rel  op_r,
const Edition ed_r,
const ResKind prefix_r = ResKind() 
)

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 Capability.cc.

◆ Capability() [17/22]

zypp::Capability::Capability ( const Arch arch_r,
const std::string &  name_r,
const std::string &  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

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 Capability.cc.

◆ Capability() [18/22]

zypp::Capability::Capability ( const Arch arch_r,
const std::string &  name_r,
Rel  op_r,
const std::string &  ed_r,
const ResKind prefix_r = ResKind() 
)

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 295 of file Capability.cc.

◆ Capability() [19/22]

zypp::Capability::Capability ( const Arch arch_r,
const std::string &  name_r,
Rel  op_r,
const Edition ed_r,
const ResKind prefix_r = ResKind() 
)

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 298 of file Capability.cc.

◆ Capability() [20/22]

zypp::Capability::Capability ( ResolverNamespace  namespace_r,
IdString  value_r = IdString::Null 
)

Definition at line 306 of file Capability.cc.

◆ Capability() [21/22]

zypp::Capability::Capability ( ResolverNamespace  namespace_r,
const char *  value_r 
)
inline

Definition at line 132 of file Capability.h.

◆ Capability() [22/22]

zypp::Capability::Capability ( ResolverNamespace  namespace_r,
const std::string &  value_r 
)
inline

Definition at line 133 of file Capability.h.

Member Function Documentation

◆ operator bool()

zypp::Capability::operator bool ( ) const
inlineexplicit

Evaluate in a boolean context ( ! empty() ).

Definition at line 144 of file Capability.h.

◆ empty()

bool zypp::Capability::empty ( ) const
inline

Whether the Capability is empty.

This is true for Null and Empty.

Definition at line 150 of file Capability.h.

◆ c_str()

const char * zypp::Capability::c_str ( ) const

Conversion to const char *

Definition at line 311 of file Capability.cc.

◆ asString()

std::string zypp::Capability::asString ( ) const
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 158 of file Capability.h.

◆ detail()

CapDetail zypp::Capability::detail ( ) const
inline

Helper providing more detailed information about a Capability.

Definition at line 379 of file Capability.h.

◆ matches() [1/20]

static CapMatch zypp::Capability::matches ( const Capability lhs,
const Capability rhs 
)
inlinestatic

Definition at line 176 of file Capability.h.

◆ matches() [2/20]

static CapMatch zypp::Capability::matches ( const Capability lhs,
const IdString rhs 
)
inlinestatic

Definition at line 177 of file Capability.h.

◆ matches() [3/20]

static CapMatch zypp::Capability::matches ( const Capability lhs,
const std::string &  rhs 
)
inlinestatic

Definition at line 178 of file Capability.h.

◆ matches() [4/20]

static CapMatch zypp::Capability::matches ( const Capability lhs,
const char *  rhs 
)
inlinestatic

Definition at line 179 of file Capability.h.

◆ matches() [5/20]

static CapMatch zypp::Capability::matches ( const IdString lhs,
const Capability rhs 
)
inlinestatic

Definition at line 181 of file Capability.h.

◆ matches() [6/20]

static CapMatch zypp::Capability::matches ( const IdString lhs,
const IdString rhs 
)
inlinestatic

Definition at line 182 of file Capability.h.

◆ matches() [7/20]

static CapMatch zypp::Capability::matches ( const IdString lhs,
const std::string &  rhs 
)
inlinestatic

Definition at line 183 of file Capability.h.

◆ matches() [8/20]

static CapMatch zypp::Capability::matches ( const IdString lhs,
const char *  rhs 
)
inlinestatic

Definition at line 184 of file Capability.h.

◆ matches() [9/20]

static CapMatch zypp::Capability::matches ( const std::string &  lhs,
const Capability rhs 
)
inlinestatic

Definition at line 186 of file Capability.h.

◆ matches() [10/20]

static CapMatch zypp::Capability::matches ( const std::string &  lhs,
const IdString rhs 
)
inlinestatic

Definition at line 187 of file Capability.h.

◆ matches() [11/20]

static CapMatch zypp::Capability::matches ( const std::string &  lhs,
const std::string &  rhs 
)
inlinestatic

Definition at line 188 of file Capability.h.

◆ matches() [12/20]

static CapMatch zypp::Capability::matches ( const std::string &  lhs,
const char *  rhs 
)
inlinestatic

Definition at line 189 of file Capability.h.

◆ matches() [13/20]

static CapMatch zypp::Capability::matches ( const char *  lhs,
const Capability rhs 
)
inlinestatic

Definition at line 191 of file Capability.h.

◆ matches() [14/20]

static CapMatch zypp::Capability::matches ( const char *  lhs,
const IdString rhs 
)
inlinestatic

Definition at line 192 of file Capability.h.

◆ matches() [15/20]

static CapMatch zypp::Capability::matches ( const char *  lhs,
const std::string &  rhs 
)
inlinestatic

Definition at line 193 of file Capability.h.

◆ matches() [16/20]

static CapMatch zypp::Capability::matches ( const char *  lhs,
const char *  rhs 
)
inlinestatic

Definition at line 194 of file Capability.h.

◆ matches() [17/20]

CapMatch zypp::Capability::matches ( const Capability rhs) const
inline

Definition at line 196 of file Capability.h.

◆ matches() [18/20]

CapMatch zypp::Capability::matches ( const IdString rhs) const
inline

Definition at line 197 of file Capability.h.

◆ matches() [19/20]

CapMatch zypp::Capability::matches ( const std::string &  rhs) const
inline

Definition at line 198 of file Capability.h.

◆ matches() [20/20]

CapMatch zypp::Capability::matches ( const char *  rhs) const
inline

Definition at line 199 of file Capability.h.

◆ isInterestingFileSpec() [1/3]

static bool zypp::Capability::isInterestingFileSpec ( const IdString name_r)
inlinestatic

Test for a filename that is likely being REQUIRED.

Files below /bin , /sbin , /lib etc. Scanning a packages filelist, an interesting filename might be worth being remembered in PROVIDES.

Definition at line 216 of file Capability.h.

◆ isInterestingFileSpec() [2/3]

static bool zypp::Capability::isInterestingFileSpec ( const std::string &  name_r)
inlinestatic

Definition at line 217 of file Capability.h.

◆ isInterestingFileSpec() [3/3]

bool zypp::Capability::isInterestingFileSpec ( const char *  name_r)
static

Definition at line 365 of file Capability.cc.

◆ guessPackageSpec() [1/2]

Capability zypp::Capability::guessPackageSpec ( const std::string &  str_r)
static

Capability parser also guessing "libzypp-1.2.3-4.5.x86_64" formats.

The argument might be in the form "libzypp-devel-1.2.3.x86_64". Passed to the Capability ctor, this would correctly be parsed as name capability, because actually the edition part had to be separated by a '=', and the architecture had to be appended to the name. So this is how it actually had to look like: "libzypp-devel.x86_64=1.2.3"

Obviously we have to guess if, and where to split name and edition. In fact "devel" could also be the version and "1.2.3" would be the release then.

Assuming this Capability should be provided by some package in the ResPool, we check this. If unprovided, we substitute the last, (or one but last) '-' by a '='. If the name part (without version) of the resulting Capability matches a package name (not provides!) in the ResPool, this Capability is returned.

Otherwise we return the Capability originally created from str_r.

Note
: As this method will access the global pool, the returned result depends on the pools content.

Definition at line 428 of file Capability.cc.

◆ guessPackageSpec() [2/2]

Capability zypp::Capability::guessPackageSpec ( const std::string &  str_r,
bool rewrote_r 
)
static

Definition at line 375 of file Capability.cc.

◆ id()

sat::detail::IdType zypp::Capability::id ( ) const
inline

Expert backdoor.

Definition at line 253 of file Capability.h.

◆ _doMatch()

CapMatch zypp::Capability::_doMatch ( sat::detail::IdType  lhs,
sat::detail::IdType  rhs 
)
staticprivate

Match two Capabilities.

Definition at line 314 of file Capability.cc.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  str,
const Capability obj 
)
related

Stream output

Definition at line 439 of file Capability.cc.

◆ dumpOn()

std::ostream & dumpOn ( std::ostream &  str,
const Capability obj 
)
related

Detailed stream output

Definition at line 444 of file Capability.cc.

◆ operator==()

bool operator== ( const Capability lhs,
const Capability rhs 
)
related

Definition at line 270 of file Capability.h.

◆ operator!=()

bool operator!= ( const Capability lhs,
const Capability rhs 
)
related

Definition at line 274 of file Capability.h.

◆ operator<()

bool operator< ( const Capability lhs,
const Capability rhs 
)
related

Arbitrary order.

Definition at line 278 of file Capability.h.

Member Data Documentation

◆ Null

const Capability zypp::Capability::Null
static

No or Null Capability ( Id 0 ).

Definition at line 137 of file Capability.h.

◆ Empty

const Capability zypp::Capability::Empty
static

Empty Capability.

Definition at line 140 of file Capability.h.

◆ _id

sat::detail::IdType zypp::Capability::_id
private

Definition at line 259 of file Capability.h.


The documentation for this class was generated from the following files: