libstdc++: std::collate< _CharT > Class Template Reference (original) (raw)

#include <[locale_classes.h](a00587%5Fsource.html)>

Public Types
typedef _CharT	char_type

typedef basic_string< _CharT >	string_type

Public Member Functions
	collate (__c_locale __cloc, size_t __refs=0)

	collate (size_t __refs=0)

int	_M_compare (const _CharT , const _CharT ) const throw ()

int	_M_compare (const char , const char ) const throw()

int	_M_compare (const wchar_t , const wchar_t ) const throw()

size_t	_M_transform (_CharT , const _CharT , size_t) const throw ()

size_t	_M_transform (char , const char , size_t) const throw()

size_t	_M_transform (wchar_t , const wchar_t , size_t) const throw()

int	compare (const _CharT __lo1, const _CharT __hi1, const _CharT __lo2, const _CharT __hi2) const

long	hash (const _CharT __lo, const _CharT __hi) const

string_type	transform (const _CharT __lo, const _CharT __hi) const

Protected Member Functions
virtual	~collate ()

virtual int	do_compare (const _CharT __lo1, const _CharT __hi1, const _CharT __lo2, const _CharT __hi2) const

virtual long	do_hash (const _CharT __lo, const _CharT __hi) const

virtual string_type	do_transform (const _CharT __lo, const _CharT __hi) const

Static Protected Member Functions
static __c_locale	_S_clone_c_locale (__c_locale &__cloc) throw ()

static void	_S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)

static void	_S_destroy_c_locale (__c_locale &__cloc)

static __c_locale	_S_get_c_locale ()

static const char *	_S_get_c_name () throw ()

static __c_locale	_S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

template<typename _CharT>
class std::collate< _CharT >

Facet for localized string comparison.

This facet encapsulates the code to compare strings in a localized manner.

The collate template uses protected virtual functions to provide the actual results. The public accessors forward the call to the virtual functions. These virtual functions are hooks for developers to implement the behavior they require from the collate facet.

Definition at line 679 of file locale_classes.h.

◆ char_type

template<typename _CharT >

◆ string_type

template<typename _CharT >

◆ collate() [1/2]

template<typename _CharT >

std::collate< _CharT >::collate ( size_t __refs = 0)	inlineexplicit

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters

__refs	Passed to the base facet class.

Definition at line 706 of file locale_classes.h.

◆ collate() [2/2]

template<typename _CharT >

std::collate< _CharT >::collate ( __c_locale __cloc, size_t __refs = 0 )	inlineexplicit

Internal constructor. Not for general use.

This is a constructor for use by the library itself to set up new locales.

Parameters

__cloc	The C locale.
__refs	Passed to the base facet class.

Definition at line 720 of file locale_classes.h.

template<typename _CharT >

◆ _M_compare()

template<typename _CharT >

int std::collate< _CharT >::_M_compare	(	const _CharT *	,
const _CharT *
)	const
throw	(
)

◆ _M_transform()

template<typename _CharT >

size_t std::collate< _CharT >::_M_transform	(	_CharT *	,
const _CharT *	,
size_t
)	const
throw	(
)

◆ compare()

template<typename _CharT >

int std::collate< _CharT >::compare ( const _CharT * __lo1, const _CharT * __hi1, const _CharT * __lo2, const _CharT * __hi2 ) const	inline

Compare two strings.

This function compares two strings and returns the result by calling collate::do_compare().

Parameters

__lo1	Start of string 1.
__hi1	End of string 1.
__lo2	Start of string 2.
__hi2	End of string 2.

Returns

1 if string1 > string2, -1 if string1 < string2, else 0.

Definition at line 737 of file locale_classes.h.

◆ do_compare()

template<typename _CharT >

int std::collate< _CharT >::do_compare ( const _CharT * __lo1, const _CharT * __hi1, const _CharT * __lo2, const _CharT * __hi2 ) const	protectedvirtual

Compare two strings.

This function is a hook for derived classes to change the value returned.

◆ do_hash()

template<typename _CharT >

long std::collate< _CharT >::do_hash ( const _CharT * __lo, const _CharT * __hi ) const	protectedvirtual

Return hash of a string.

This function computes and returns a hash on the input string. This function is a hook for derived classes to change the value returned.

Parameters

__lo	Start of string.
__hi	End of string.

Returns

Hash value.

Definition at line 332 of file locale_classes.tcc.

◆ do_transform()

template<typename _CharT >

Transform string to comparable form.

This function is a hook for derived classes to change the value returned.

Parameters

Returns

transformed string.

Definition at line 276 of file locale_classes.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::append(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), std::basic_string< _CharT, _Traits, _Alloc >::data(), std::basic_string< _CharT, _Traits, _Alloc >::length(), and std::basic_string< _CharT, _Traits, _Alloc >::push_back().

◆ hash()

template<typename _CharT >

long std::collate< _CharT >::hash ( const _CharT * __lo, const _CharT * __hi ) const	inline

Return hash of a string.

This function computes and returns a hash on the input string. It does so by returning collate::do_hash().

Parameters

__lo	Start of string.
__hi	End of string.

Returns

Hash value.

Definition at line 770 of file locale_classes.h.

◆ transform()

template<typename _CharT >

Transform string to comparable form.

This function is a wrapper for strxfrm functionality. It takes the input string and returns a modified string that can be directly compared to other transformed strings. In the C locale, this function just returns a copy of the input string. In some other locales, it may replace two chars with one, change a char for another, etc. It does so by returning collate::do_transform().

Parameters

__lo	Start of string.
__hi	End of string.

Returns

Transformed string_type.

Definition at line 756 of file locale_classes.h.

◆ _M_c_locale_collate

template<typename _CharT >

◆ id

template<typename _CharT >

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