collate Class Template Reference

#include <locale_facets.h>

Inheritance diagram for collate:

Inheritance graph
Collaboration diagram for collate:

Collaboration graph
List of all members.

Detailed Description

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes


Member Typedef Documentation

typedef CharT char_type
 

Public typedefs.

Definition at line 2475 of file locale_facets.h.

typedef basic_string<CharT> string_type
 

Public typedefs.

Definition at line 2476 of file locale_facets.h.

Referenced by collate::do_compare(), and collate::do_transform().


Constructor & Destructor Documentation

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

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

virtual ~collate  )  [inline, protected, virtual]
 

Destructor.

Definition at line 2573 of file locale_facets.h.


Member Function Documentation

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

int 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 2298 of file locale_facets.tcc.

References collate::string_type.

long 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 2381 of file locale_facets.tcc.

collate< CharT >::string_type 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 2337 of file locale_facets.tcc.

References basic_string::append(), basic_string::c_str(), basic_string::data(), basic_string::length(), basic_string::push_back(), and collate::string_type.

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

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


Member Data Documentation

locale::id id [static]
 

Numpunct facet id.

Definition at line 2622 of file locale_facets.h.


The documentation for this class was generated from the following files:
Generated on Sun Sep 12 15:50:12 2004 for libstdc++ source by doxygen 1.3.8