std::collate< _CharT > Class Template Reference

Facet for localized string comparison. More...

Inheritance diagram for std::collate< _CharT >:

Inheritance graph

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends


Detailed Description

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 604 of file locale_classes.h.


Member Typedef Documentation

template<typename _CharT>
typedef _CharT std::collate< _CharT >::char_type

Public typedefs.

Reimplemented in std::collate_byname< _CharT >.

Definition at line 610 of file locale_classes.h.

template<typename _CharT>
typedef basic_string<_CharT> std::collate< _CharT >::string_type

Public typedefs.

Reimplemented in std::collate_byname< _CharT >.

Definition at line 611 of file locale_classes.h.


Constructor & Destructor Documentation

template<typename _CharT>
std::collate< _CharT >::collate ( size_t  __refs = 0  )  [inline, explicit]

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters:
refs Passed to the base facet class.

Definition at line 631 of file locale_classes.h.

template<typename _CharT>
std::collate< _CharT >::collate ( __c_locale  __cloc,
size_t  __refs = 0 
) [inline, explicit]

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 645 of file locale_classes.h.

template<typename _CharT>
virtual std::collate< _CharT >::~collate (  )  [inline, protected, virtual]

Destructor.

Definition at line 708 of file locale_classes.h.


Member Function Documentation

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 662 of file locale_classes.h.

template<typename _CharT>
int std::collate< _CharT >::do_compare ( const _CharT *  __lo1,
const _CharT *  __hi1,
const _CharT *  __lo2,
const _CharT *  __hi2 
) const [inline, protected, virtual]

Compare two strings.

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

See also:
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 134 of file locale_classes.tcc.

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

template<typename _CharT>
long std::collate< _CharT >::do_hash ( const _CharT *  __lo,
const _CharT *  __hi 
) const [inline, protected, virtual]

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 229 of file locale_classes.tcc.

template<typename _CharT>
collate< _CharT >::string_type std::collate< _CharT >::do_transform ( const _CharT *  __lo,
const _CharT *  __hi 
) const [inline, protected, virtual]

Transform string to comparable form.

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

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 173 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().

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 695 of file locale_classes.h.

template<typename _CharT>
string_type std::collate< _CharT >::transform ( const _CharT *  __lo,
const _CharT *  __hi 
) const [inline]

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 681 of file locale_classes.h.

Referenced by std::regex_traits< _Ch_type >::transform().


Member Data Documentation

template<typename _CharT>
locale::id std::collate< _CharT >::id [inline, static]

Numpunct facet id.

Definition at line 621 of file locale_classes.h.


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

Generated on Thu Jul 23 21:17:47 2009 for libstdc++ by  doxygen 1.5.8