libzypp  17.3.1
zypp::Locale Class Reference

'Language[_Country]' codes. More...

#include <Locale.h>

Inheritance diagram for zypp::Locale:

Public Member Functions

 Locale ()
 Default Ctor: noCode. More...
 
 Locale (IdString str_r)
 Ctor from string. More...
 
 Locale (const std::string &str_r)
 Ctor from string. More...
 
 Locale (const char *str_r)
 Ctor from string. More...
 
 Locale (LanguageCode language_r, CountryCode country_r=CountryCode())
 Ctor taking LanguageCode and optional CountryCode. More...
 
 ~Locale ()
 Dtor. More...
 
LanguageCode language () const
 The language part. More...
 
CountryCode country () const
 The county part. More...
 
std::string code () const
 Return the locale code asString. More...
 
std::string name () const
 Return the translated locale name. More...
 
Locale fallback () const
 Return the fallback locale for this locale, if no fallback exists the empty Locale::noCode. More...
 
- Public Member Functions inherited from zypp::IdStringType< Locale >
IdString idStr () const
 
bool empty () const
 
unsigned size () const
 
const char * c_str () const
 
std::string asString () const
 
IdType id () const
 
 operator bool () const
 Evaluate in a boolean context ( ! empty() ). More...
 
 operator IdString () const
 Explicit conversion to IdString. More...
 
 operator std::string () const
 Explicit conversion to std::string. More...
 
int compare (const Locale &rhs) const
 
int compare (const IdStringType &rhs) const
 
int compare (const IdString &rhs) const
 
int compare (const std::string &rhs) const
 
int compare (const char *rhs) const
 

Static Public Member Functions

static Locale bestMatch (const LocaleSet &avLocales_r, Locale requested_r=Locale())
 Return the best match for Locale requested_r within the available avLocales_r. More...
 
- Static Public Member Functions inherited from zypp::IdStringType< Locale >
static int compare (const Locale &lhs, const Locale &rhs)
 
static int compare (const Locale &lhs, const IdString &rhs)
 
static int compare (const Locale &lhs, const std::string &rhs)
 
static int compare (const Locale &lhs, const char *rhs)
 
static int compare (const IdString &lhs, const Locale &rhs)
 
static int compare (const IdString &lhs, const IdString &rhs)
 
static int compare (const IdString &lhs, const std::string &rhs)
 
static int compare (const IdString &lhs, const char *rhs)
 
static int compare (const std::string &lhs, const Locale &rhs)
 
static int compare (const std::string &lhs, const IdString &rhs)
 
static int compare (const std::string &lhs, const std::string &rhs)
 
static int compare (const std::string &lhs, const char *rhs)
 
static int compare (const char *lhs, const Locale &rhs)
 
static int compare (const char *lhs, const IdString &rhs)
 
static int compare (const char *lhs, const std::string &rhs)
 
static int compare (const char *lhs, const char *rhs)
 

Static Public Attributes

Locale constants.
static const Locale noCode
 Empty code. More...
 
static const Locale enCode
 Last resort "en". More...
 

Private Attributes

IdString _str
 

Friends

class IdStringType< Locale >
 

Additional Inherited Members

- Public Types inherited from zypp::IdStringType< Locale >
typedef IdString::IdType IdType
 
- Protected Member Functions inherited from zypp::IdStringType< Locale >
 IdStringType ()
 
 IdStringType (const IdStringType &)
 
void operator= (const IdStringType &)
 
 ~IdStringType ()
 
- Static Protected Member Functions inherited from zypp::sat::detail::PoolMember
static PoolImplmyPool ()
 

Detailed Description

'Language[_Country]' codes.

In fact the class will not prevent to use a non iso code. Just a warning will appear in the log. Construction from string consider everything up to the first '.' or '@'.

Locale l( "de_DE.UTF-8" );
l.code() == "de_DE";
l.language() == "de";
l.country() == "DE";
l.fallback() == "de";
l.fallback().fallback() == Locale::enCode == "en";

Definition at line 49 of file Locale.h.

Constructor & Destructor Documentation

◆ Locale() [1/5]

zypp::Locale::Locale ( )

Default Ctor: noCode.

Definition at line 177 of file Locale.cc.

◆ Locale() [2/5]

zypp::Locale::Locale ( IdString  str_r)
explicit

Ctor from string.

Definition at line 180 of file Locale.cc.

◆ Locale() [3/5]

zypp::Locale::Locale ( const std::string &  str_r)
explicit

Ctor from string.

Definition at line 184 of file Locale.cc.

◆ Locale() [4/5]

zypp::Locale::Locale ( const char *  str_r)
explicit

Ctor from string.

Definition at line 188 of file Locale.cc.

◆ Locale() [5/5]

zypp::Locale::Locale ( LanguageCode  language_r,
CountryCode  country_r = CountryCode() 
)

Ctor taking LanguageCode and optional CountryCode.

Definition at line 192 of file Locale.cc.

◆ ~Locale()

zypp::Locale::~Locale ( )

Dtor.

Definition at line 196 of file Locale.cc.

Member Function Documentation

◆ language()

LanguageCode zypp::Locale::language ( ) const

The language part.

Definition at line 199 of file Locale.cc.

◆ country()

CountryCode zypp::Locale::country ( ) const

The county part.

Definition at line 202 of file Locale.cc.

◆ code()

std::string zypp::Locale::code ( ) const
inline

Return the locale code asString.

Definition at line 88 of file Locale.h.

◆ name()

std::string zypp::Locale::name ( ) const

Return the translated locale name.

Definition at line 205 of file Locale.cc.

◆ fallback()

Locale zypp::Locale::fallback ( ) const

Return the fallback locale for this locale, if no fallback exists the empty Locale::noCode.

The usual fallback sequence is "language_COUNTRY" -> "language" -> Locale::enCode ("en") ->Locale::noCode (""). Some exceptions like "pt_BR"->"en"->"" do exist.

Definition at line 208 of file Locale.cc.

◆ bestMatch()

Locale zypp::Locale::bestMatch ( const LocaleSet avLocales_r,
Locale  requested_r = Locale() 
)
static

Return the best match for Locale requested_r within the available avLocales_r.

If requested_r is not specified ZConfig::textLocale is assumed.

If neither requested_r nor any of it's fallback locales are available in avLocales_r, Locale::noCode is returned.

Definition at line 213 of file Locale.cc.

Friends And Related Function Documentation

◆ IdStringType< Locale >

friend class IdStringType< Locale >
friend

Definition at line 111 of file Locale.h.

Member Data Documentation

◆ noCode

const Locale zypp::Locale::noCode
static

Empty code.

Definition at line 74 of file Locale.h.

◆ enCode

const Locale zypp::Locale::enCode
static

Last resort "en".

Definition at line 77 of file Locale.h.

◆ _str

IdString zypp::Locale::_str
private

Definition at line 112 of file Locale.h.


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