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

std::ctype< _CharT > Class Template Reference

Template ctype facet. More...

#include <locale_facets.h>

Inheritance diagram for std::ctype< _CharT >:

std::__ctype_abstract_base< _CharT > std::locale::facet ctype_base std::ctype_byname< _CharT > List of all members.

Public Types

typedef _CharT char_type
 Typedef for the template parameter.

typedef __ctype_abstract_base<
_CharT >::mask 		mask

Public Member Functions

 ctype (size_t __refs=0)

Static Public Attributes

locale::id id
 The facet id for ctype<char_type>.


Protected Member Functions

virtual ~ctype ()
virtual bool do_is (mask __m, char_type __c) const
 Test char_type classification.

virtual const char_type * do_is (const char_type *__lo, const char_type *__hi, mask *__vec) const
 Return a mask array.

virtual const char_type * do_scan_is (mask __m, const char_type *__lo, const char_type *__hi) const
 Find char_type matching mask.

virtual const char_type * do_scan_not (mask __m, const char_type *__lo, const char_type *__hi) const
 Find char_type not matching mask.

virtual char_type do_toupper (char_type __c) const
 Convert to uppercase.

virtual const char_type * do_toupper (char_type *__lo, const char_type *__hi) const
 Convert array to uppercase.

virtual char_type do_tolower (char_type __c) const
 Convert to lowercase.

virtual const char_type * do_tolower (char_type *__lo, const char_type *__hi) const
 Convert array to lowercase.

virtual char_type do_widen (char __c) const
 Widen char.

virtual const char * do_widen (const char *__lo, const char *__hi, char_type *__dest) const
 Widen char array.

virtual char do_narrow (char_type, char __dfault) const
 Narrow char_type to char.

virtual const char_type * do_narrow (const char_type *__lo, const char_type *__hi, char __dfault, char *__dest) const
 Narrow char_type array to char.

Detailed Description

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

Template ctype facet.

This template class defines classification and conversion functions for character sets. It wraps functionality. Ctype gets used by streams for many I/O operations.

This template provides the protected virtual functions the developer will have to replace in a derived class or specialization to make a working facet. The public functions that access them are defined in __ctype_abstract_base, to allow for implementation flexibility. See ctype<wchar_t> for an example. The functions are documented in __ctype_abstract_base.

Note: implementations are provided for all the protected virtual functions, but will likely not be useful.

Definition at line 606 of file locale_facets.h.

Member Typedef Documentation

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

Typedef for the template parameter.

Reimplemented from std::__ctype_abstract_base< _CharT >.

Reimplemented in std::ctype_byname< _CharT >.

Definition at line 610 of file locale_facets.h.

template<typename _CharT>
typedef __ctype_abstract_base<_CharT>::mask std::ctype< _CharT >::mask
 

Reimplemented from ctype_base.

Definition at line 611 of file locale_facets.h.

Constructor & Destructor Documentation

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

Definition at line 617 of file locale_facets.h.

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

Member Function Documentation

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_is (  const char_type *  __lo,
const char_type *  __hi,
mask *  __vec
)  const [protected, virtual]
 

Return a mask array.

This function finds the mask for each char_type in the range [lo,hi) and successively writes it to vec. vec must have as many elements as the input.

do_is() is a hook for a derived facet to change the behavior of classifying. do_is() must always return the same result for the same input.

Parameters:
lo Pointer to start of range.
hi Pointer to end of range.
vec Pointer to an array of mask storage.
Returns:
hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual bool std::ctype< _CharT >::do_is (  mask  __m,
char_type  __c
)  const [protected, virtual]
 

Test char_type classification.

This function finds a mask M for c and compares it to mask m.

do_is() is a hook for a derived facet to change the behavior of classifying. do_is() must always return the same result for the same input.

Parameters:
c The char_type to find the mask of.
m The mask to compare against.
Returns:
(M & m) != 0.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_narrow (  const char_type *  __lo,
const char_type *  __hi,
char  __dfault,
char *  __dest
)  const [protected, virtual]
 

Narrow char_type array to char.

This virtual function converts each char_type in the range [lo,hi) to char using the simplest reasonable transformation and writes the results to the destination array. For any element in the input that cannot be converted, dfault is used instead.

do_narrow() is a hook for a derived facet to change the behavior of narrowing. do_narrow() must always return the same result for the same input.

Note: this is not what you want for codepage conversions. See codecvt for that.

Parameters:
lo Pointer to start of range.
hi Pointer to end of range.
dfault Char to use if conversion fails.
to Pointer to the destination array.
Returns:
hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char std::ctype< _CharT >::do_narrow (  char_type  ,
char  __dfault
)  const [protected, virtual]
 

Narrow char_type to char.

This virtual function converts the argument to char using the simplest reasonable transformation. If the conversion fails, dfault is returned instead.

do_narrow() is a hook for a derived facet to change the behavior of narrowing. do_narrow() must always return the same result for the same input.

Note: this is not what you want for codepage conversions. See codecvt for that.

Parameters:
c The char_type to convert.
dfault Char to return if conversion fails.
Returns:
The converted char.

Implements std::__ctype_abstract_base< _CharT >.

Referenced by std::ctype< char >::_M_narrow_init(), and std::ctype< char >::narrow().

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_scan_is (  mask  __m,
const char_type *  __lo,
const char_type *  __hi
)  const [protected, virtual]
 

Find char_type matching mask.

This function searches for and returns the first char_type c in [lo,hi) for which is(m,c) is true.

do_scan_is() is a hook for a derived facet to change the behavior of match searching. do_is() must always return the same result for the same input.

Parameters:
m The mask to compare against.
lo Pointer to start of range.
hi Pointer to end of range.
Returns:
Pointer to a matching char_type if found, else hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_scan_not (  mask  __m,
const char_type *  __lo,
const char_type *  __hi
)  const [protected, virtual]
 

Find char_type not matching mask.

This function searches for and returns a pointer to the first char_type c of [lo,hi) for which is(m,c) is false.

do_scan_is() is a hook for a derived facet to change the behavior of match searching. do_is() must always return the same result for the same input.

Parameters:
m The mask to compare against.
lo Pointer to start of range.
hi Pointer to end of range.
Returns:
Pointer to a non-matching char_type if found, else hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_tolower (  char_type *  __lo,
const char_type *  __hi
)  const [protected, virtual]
 

Convert array to lowercase.

This virtual function converts each char_type in the range [lo,hi) to lowercase if possible. Other elements remain untouched.

do_tolower() is a hook for a derived facet to change the behavior of lowercasing. do_tolower() must always return the same result for the same input.

Parameters:
lo Pointer to start of range.
hi Pointer to end of range.
Returns:
hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char_type std::ctype< _CharT >::do_tolower (  char_type  __c  )  const [protected, virtual]
 

Convert to lowercase.

This virtual function converts the argument to lowercase if possible. If not possible (for example, '2'), returns the argument.

do_tolower() is a hook for a derived facet to change the behavior of lowercasing. do_tolower() must always return the same result for the same input.

Parameters:
c The char_type to convert.
Returns:
The lowercase char_type if convertible, else c.

Implements std::__ctype_abstract_base< _CharT >.

Referenced by std::ctype< char >::tolower().

template<typename _CharT>
virtual const char_type* std::ctype< _CharT >::do_toupper (  char_type *  __lo,
const char_type *  __hi
)  const [protected, virtual]
 

Convert array to uppercase.

This virtual function converts each char_type in the range [lo,hi) to uppercase if possible. Other elements remain untouched.

do_toupper() is a hook for a derived facet to change the behavior of uppercasing. do_toupper() must always return the same result for the same input.

Parameters:
lo Pointer to start of range.
hi Pointer to end of range.
Returns:
hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char_type std::ctype< _CharT >::do_toupper (  char_type  __c  )  const [protected, virtual]
 

Convert to uppercase.

This virtual function converts the char_type argument to uppercase if possible. If not possible (for example, '2'), returns the argument.

do_toupper() is a hook for a derived facet to change the behavior of uppercasing. do_toupper() must always return the same result for the same input.

Parameters:
c The char_type to convert.
Returns:
The uppercase char_type if convertible, else c.

Implements std::__ctype_abstract_base< _CharT >.

Referenced by std::ctype< char >::toupper().

template<typename _CharT>
virtual const char* std::ctype< _CharT >::do_widen (  const char *  __lo,
const char *  __hi,
char_type *  __dest
)  const [protected, virtual]
 

Widen char array.

This function converts each char in the input to char_type using the simplest reasonable transformation.

do_widen() is a hook for a derived facet to change the behavior of widening. do_widen() must always return the same result for the same input.

Note: this is not what you want for codepage conversions. See codecvt for that.

Parameters:
lo Pointer to start range.
hi Pointer to end of range.
to Pointer to the destination array.
Returns:
hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char_type std::ctype< _CharT >::do_widen (  char  __c  )  const [protected, virtual]
 

Widen char.

This virtual function converts the char to char_type using the simplest reasonable transformation.

do_widen() is a hook for a derived facet to change the behavior of widening. do_widen() must always return the same result for the same input.

Note: this is not what you want for codepage conversions. See codecvt for that.

Parameters:
c The char to convert.
Returns:
The converted char_type

Implements std::__ctype_abstract_base< _CharT >.

Referenced by std::ctype< char >::_M_widen_init(), and std::ctype< char >::widen().

Member Data Documentation

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

The facet id for ctype<char_type>.

Definition at line 663 of file locale_facets.h.

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