Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

std::collate< _CharT > Class Template Reference

Facet for localized string comparison. More...

#include <locale_facets.h>

Inheritance diagram for std::collate< _CharT >:

std::locale::facet std::collate_byname< _CharT > List of all members.

Public Types

typedef _CharT char_type
 Public typedefs.

typedef basic_string< _CharT > string_type

Public Member Functions

 collate (size_t __refs=0)
 Constructor performs initialization.

 collate (__c_locale __cloc, size_t __refs=0)
 Internal constructor. Not for general use.

int compare (const _CharT *__lo1, const _CharT *__hi1, const _CharT *__lo2, const _CharT *__hi2) const
 Compare two strings.

string_type transform (const _CharT *__lo, const _CharT *__hi) const
 Transform string to comparable form.

long hash (const _CharT *__lo, const _CharT *__hi) const
 Return hash of a string.

int _M_compare (const _CharT *, const _CharT *) const
size_t _M_transform (_CharT *, const _CharT *, size_t) const

Static Public Attributes

locale::id id
 Numpunct facet id.


Protected Member Functions

virtual ~collate ()
 Destructor.

virtual int do_compare (const _CharT *__lo1, const _CharT *__hi1, const _CharT *__lo2, const _CharT *__hi2) const
 Compare two strings.

virtual string_type do_transform (const _CharT *__lo, const _CharT *__hi) const
 Transform string to comparable form.

virtual long do_hash (const _CharT *__lo, const _CharT *__hi) const
 Return hash of a string.


Protected Attributes

__c_locale _M_c_locale_collate

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 2942 of file locale_facets.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 2948 of file locale_facets.h.

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

Reimplemented in std::collate_byname< _CharT >.

Definition at line 2949 of file locale_facets.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 2969 of file locale_facets.h.

Referenced by std::num_get< _CharT, _InIter >::get().

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 2983 of file locale_facets.h.

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

Destructor.

Definition at line 3046 of file locale_facets.h.

Member Function Documentation

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

Definition at line 2273 of file locale_facets.tcc.

Referenced by std::collate< _CharT >::do_compare().

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

Definition at line 2279 of file locale_facets.tcc.

Referenced by std::collate< _CharT >::do_transform().

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 3000 of file locale_facets.h.

template<typename _CharT>
int std::collate< _CharT >::do_compare (  const _CharT *  __lo1,
const _CharT *  __hi1,
const _CharT *  __lo2,
const _CharT *  __hi2
)  const [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 2285 of file locale_facets.tcc.

References std::collate< _CharT >::_M_compare().

template<typename _CharT>
long std::collate< _CharT >::do_hash (  const _CharT *  __lo,
const _CharT *  __hi
)  const [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 2368 of file locale_facets.tcc.

Referenced by std::num_get< _CharT, _InIter >::get().

template<typename _CharT>
collate< _CharT >::string_type std::collate< _CharT >::do_transform (  const _CharT *  __lo,
const _CharT *  __hi
)  const [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 2324 of file locale_facets.tcc.

References std::collate< _CharT >::_M_transform().

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 3033 of file locale_facets.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 3019 of file locale_facets.h.

References std::time_get< _CharT, _InIter >::do_get_time(), and std::ios_base::iostate.

Member Data Documentation

template<typename _CharT>
__c_locale std::collate< _CharT >::_M_c_locale_collate [protected]
 

Definition at line 2955 of file locale_facets.h.

Referenced by std::num_get< _CharT, _InIter >::get().

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

Numpunct facet id.

Definition at line 3095 of file locale_facets.h.

The documentation for this class was generated from the following files:
Generated on Tue Jan 30 17:32:14 2007 for GNU C++ STL by doxygen 1.3.6