collate Class Template Reference

Inheritance diagram for collate:

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends


Member Typedef Documentation

typedef _CharT char_type
 

Public typedefs.

Reimplemented in collate_byname.

Definition at line 2472 of file locale_facets.h.


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

virtual ~collate  )  [inline, protected, virtual]
 

Destructor.

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

References collate::do_compare().

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

References basic_string::c_str(), basic_string::data(), and basic_string::length().

Referenced by collate::compare().

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

Referenced by collate::hash().

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

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

Referenced by collate::transform().

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

References collate::do_hash().

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

References collate::do_transform().


Member Data Documentation

locale::id id [static]
 

Numpunct facet id.

Definition at line 2619 of file locale_facets.h.


The documentation for this class was generated from the following files:
Generated on Wed Apr 27 18:35:46 2005 for libstdc++ source by  doxygen 1.4.2