libstdc++
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
std::ctype< _CharT > Class Template Reference
Locales
Inheritance diagram for std::ctype< _CharT >:
[legend]

Public Types

typedef const int * __to_type
 
typedef _CharT char_type
 
typedef __ctype_abstract_base< _CharT >::mask mask
 

Public Member Functions

 ctype (size_t __refs=0)
 
bool is (mask __m, char_type __c) const
 
const char_type * is (const char_type *__lo, const char_type *__hi, mask *__vec) const
 
char narrow (char_type __c, char __dfault) const
 
const char_type * narrow (const char_type *__lo, const char_type *__hi, char __dfault, char *__to) const
 
const char_type * scan_is (mask __m, const char_type *__lo, const char_type *__hi) const
 
const char_type * scan_not (mask __m, const char_type *__lo, const char_type *__hi) const
 
char_type tolower (char_type __c) const
 
const char_type * tolower (char_type *__lo, const char_type *__hi) const
 
char_type toupper (char_type __c) const
 
const char_type * toupper (char_type *__lo, const char_type *__hi) const
 
char_type widen (char __c) const
 
const char * widen (const char *__lo, const char *__hi, char_type *__to) const
 

Static Public Attributes

static const mask alnum
 
static const mask alpha
 
static const mask blank
 
static const mask cntrl
 
static const mask digit
 
static const mask graph
 
static locale::id id
 
static const mask lower
 
static const mask print
 
static const mask punct
 
static const mask space
 
static const mask upper
 
static const mask xdigit
 

Protected Member Functions

virtual bool do_is (mask __m, char_type __c) const
 
virtual const char_type * do_is (const char_type *__lo, const char_type *__hi, mask *__vec) const
 
virtual char do_narrow (char_type, char __dfault) const
 
virtual const char_type * do_narrow (const char_type *__lo, const char_type *__hi, char __dfault, char *__to) const
 
virtual const char_type * do_scan_is (mask __m, const char_type *__lo, const char_type *__hi) const
 
virtual const char_type * do_scan_not (mask __m, const char_type *__lo, const char_type *__hi) const
 
virtual char_type do_tolower (char_type __c) const
 
virtual const char_type * do_tolower (char_type *__lo, const char_type *__hi) const
 
virtual char_type do_toupper (char_type __c) const
 
virtual const char_type * do_toupper (char_type *__lo, const char_type *__hi) const
 
virtual char_type do_widen (char __c) const
 
virtual const char * do_widen (const char *__lo, const char *__hi, char_type *__dest) const
 

Static Protected Member Functions

static __c_locale _S_clone_c_locale (__c_locale &__cloc) throw ()
 
static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
 
static void _S_destroy_c_locale (__c_locale &__cloc)
 
static __c_locale _S_get_c_locale ()
 
static const char * _S_get_c_name () throw ()
 
static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)
 

Detailed Description

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

Primary class template ctype facet.

This template class defines classification and conversion functions for character sets. It wraps cctype 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 612 of file locale_facets.h.

Member Function Documentation

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

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
__cThe char_type to find the mask of.
__mThe 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_is ( const char_type *  __lo,
const char_type *  __hi,
mask *  __vec 
) const
protectedvirtual

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
__loPointer to start of range.
__hiPointer to end of range.
__vecPointer to an array of mask storage.
Returns
__hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char std::ctype< _CharT >::do_narrow ( char_type  __c,
char  __dfault 
) const
protectedvirtual

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
__cThe char_type to convert.
__dfaultChar to return if conversion fails.
Returns
The converted char.

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 *  __to 
) const
protectedvirtual

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
__loPointer to start of range.
__hiPointer to end of range.
__dfaultChar to use if conversion fails.
__toPointer to the destination array.
Returns
__hi.

Implements std::__ctype_abstract_base< _CharT >.

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

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
__mThe mask to compare against.
__loPointer to start of range.
__hiPointer 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
protectedvirtual

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
__mThe mask to compare against.
__loPointer to start of range.
__hiPointer 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 char_type std::ctype< _CharT >::do_tolower ( char_type  __c) const
protectedvirtual

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
__cThe char_type to convert.
Returns
The lowercase char_type if convertible, else __c.

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
protectedvirtual

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
__loPointer to start of range.
__hiPointer 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
protectedvirtual

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
__cThe char_type to convert.
Returns
The uppercase char_type if convertible, else __c.

Implements std::__ctype_abstract_base< _CharT >.

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

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
__loPointer to start of range.
__hiPointer to end of range.
Returns
__hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual char_type std::ctype< _CharT >::do_widen ( char  __c) const
protectedvirtual

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
__cThe char to convert.
Returns
The converted char_type

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
virtual const char* std::ctype< _CharT >::do_widen ( const char *  __lo,
const char *  __hi,
char_type *  __to 
) const
protectedvirtual

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
__loPointer to start range.
__hiPointer to end of range.
__toPointer to the destination array.
Returns
__hi.

Implements std::__ctype_abstract_base< _CharT >.

template<typename _CharT>
bool std::__ctype_abstract_base< _CharT >::is ( mask  __m,
char_type  __c 
) const
inlineinherited

Test char_type classification.

This function finds a mask M for __c and compares it to mask __m. It does so by returning the value of ctype<char_type>::do_is().

Parameters
__cThe char_type to compare the mask of.
__mThe mask to compare against.
Returns
(M & __m) != 0.

Definition at line 169 of file locale_facets.h.

Referenced by std::time_get< _CharT, _InIter >::get(), std::ctype< char >::is(), std::isalnum(), std::isalpha(), std::isblank(), std::iscntrl(), std::isdigit(), std::isgraph(), std::islower(), std::isprint(), std::ispunct(), std::isspace(), std::isupper(), std::isxdigit(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::is ( const char_type *  __lo,
const char_type *  __hi,
mask *  __vec 
) const
inlineinherited

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 char array. It does so by returning the value of ctype<char_type>::do_is().

Parameters
__loPointer to start of range.
__hiPointer to end of range.
__vecPointer to an array of mask storage.
Returns
__hi.

Definition at line 186 of file locale_facets.h.

template<typename _CharT>
char std::__ctype_abstract_base< _CharT >::narrow ( char_type  __c,
char  __dfault 
) const
inlineinherited

Narrow char_type to char.

This function converts the char_type to char using the simplest reasonable transformation. If the conversion fails, dfault is returned instead. It does so by returning ctype<char_type>::do_narrow(__c).

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

Parameters
__cThe char_type to convert.
__dfaultChar to return if conversion fails.
Returns
The converted char.

Definition at line 331 of file locale_facets.h.

Referenced by std::time_get< _CharT, _InIter >::do_date_order(), std::time_get< _CharT, _InIter >::get(), and std::time_put< _CharT, _OutIter >::put().

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::narrow ( const char_type *  __lo,
const char_type *  __hi,
char  __dfault,
char *  __to 
) const
inlineinherited

Narrow array to char array.

This function converts each char_type in the input to char using the simplest reasonable transformation and writes the results to the destination array. For any char_type in the input that cannot be converted, dfault is used instead. It does so by returning ctype<char_type>::do_narrow(__lo, __hi, __dfault, __to).

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

Parameters
__loPointer to start of range.
__hiPointer to end of range.
__dfaultChar to use if conversion fails.
__toPointer to the destination array.
Returns
__hi.

Definition at line 353 of file locale_facets.h.

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::scan_is ( mask  __m,
const char_type *  __lo,
const char_type *  __hi 
) const
inlineinherited

Find char_type matching a mask.

This function searches for and returns the first char_type c in [lo,hi) for which is(m,c) is true. It does so by returning ctype<char_type>::do_scan_is().

Parameters
__mThe mask to compare against.
__loPointer to start of range.
__hiPointer to end of range.
Returns
Pointer to matching char_type if found, else __hi.

Definition at line 202 of file locale_facets.h.

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

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::scan_not ( mask  __m,
const char_type *  __lo,
const char_type *  __hi 
) const
inlineinherited

Find char_type not matching a mask.

This function searches for and returns the first char_type c in [lo,hi) for which is(m,c) is false. It does so by returning ctype<char_type>::do_scan_not().

Parameters
__mThe mask to compare against.
__loPointer to first char in range.
__hiPointer to end of range.
Returns
Pointer to non-matching char if found, else __hi.

Definition at line 218 of file locale_facets.h.

Referenced by std::money_get< _CharT, _InIter >::do_get(), and std::ctype< char >::scan_is().

template<typename _CharT>
char_type std::__ctype_abstract_base< _CharT >::tolower ( char_type  __c) const
inlineinherited

Convert to lowercase.

This function converts the argument to lowercase if possible. If not possible (for example, '2'), returns the argument. It does so by returning ctype<char_type>::do_tolower(c).

Parameters
__cThe char_type to convert.
Returns
The lowercase char_type if convertible, else __c.

Definition at line 261 of file locale_facets.h.

Referenced by std::time_get< _CharT, _InIter >::get(), and std::tolower().

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::tolower ( char_type *  __lo,
const char_type *  __hi 
) const
inlineinherited

Convert array to lowercase.

This function converts each char_type in the range [__lo,__hi) to lowercase if possible. Other elements remain untouched. It does so by returning ctype<char_type>:: do_tolower(__lo, __hi).

Parameters
__loPointer to start of range.
__hiPointer to end of range.
Returns
__hi.

Definition at line 276 of file locale_facets.h.

template<typename _CharT>
char_type std::__ctype_abstract_base< _CharT >::toupper ( char_type  __c) const
inlineinherited

Convert to uppercase.

This function converts the argument to uppercase if possible. If not possible (for example, '2'), returns the argument. It does so by returning ctype<char_type>::do_toupper().

Parameters
__cThe char_type to convert.
Returns
The uppercase char_type if convertible, else __c.

Definition at line 232 of file locale_facets.h.

Referenced by std::time_get< _CharT, _InIter >::do_date_order(), std::time_get< _CharT, _InIter >::get(), and std::toupper().

template<typename _CharT>
const char_type* std::__ctype_abstract_base< _CharT >::toupper ( char_type *  __lo,
const char_type *  __hi 
) const
inlineinherited

Convert array to uppercase.

This function converts each char_type in the range [lo,hi) to uppercase if possible. Other elements remain untouched. It does so by returning ctype<char_type>:: do_toupper(lo, hi).

Parameters
__loPointer to start of range.
__hiPointer to end of range.
Returns
__hi.

Definition at line 247 of file locale_facets.h.

template<typename _CharT>
char_type std::__ctype_abstract_base< _CharT >::widen ( char  __c) const
inlineinherited

Widen char to char_type.

This function converts the char argument to char_type using the simplest reasonable transformation. It does so by returning ctype<char_type>::do_widen(c).

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

Parameters
__cThe char to convert.
Returns
The converted char_type.

Definition at line 293 of file locale_facets.h.

Referenced by std::time_get< _CharT, _InIter >::do_get(), std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::time_put< _CharT, _OutIter >::do_put(), std::money_put< _CharT, _OutIter >::do_put(), and std::num_put< _CharT, _OutIter >::do_put().

template<typename _CharT>
const char* std::__ctype_abstract_base< _CharT >::widen ( const char *  __lo,
const char *  __hi,
char_type *  __to 
) const
inlineinherited

Widen array to char_type.

This function converts each char in the input to char_type using the simplest reasonable transformation. It does so by returning ctype<char_type>::do_widen(c).

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

Parameters
__loPointer to start of range.
__hiPointer to end of range.
__toPointer to the destination array.
Returns
__hi.

Definition at line 312 of file locale_facets.h.

Member Data Documentation

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

The facet id for ctype<char_type>

Definition at line 620 of file locale_facets.h.

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