libstdc++: std::ctype< _CharT > Class Template Reference (original) (raw)
#include <[locale_facets.h](a00596%5Fsource.html)>
| 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) | |
| const char_type * | is (const char_type *__lo, const char_type *__hi, mask *__vec) const |
| bool | is (mask __m, char_type __c) 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 |
| const char_type * | tolower (char_type *__lo, const char_type *__hi) const |
| char_type | tolower (char_type __c) const |
| const char_type * | toupper (char_type *__lo, const char_type *__hi) const |
| char_type | toupper (char_type __c) 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 | |
| static const mask | punct |
| static const mask | space |
| static const mask | upper |
| static const mask | xdigit |
| Protected Member Functions | |
|---|---|
| virtual const char_type * | do_is (const char_type *__lo, const char_type *__hi, mask *__vec) const |
| virtual bool | do_is (mask __m, char_type __c) 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 const char_type * | do_tolower (char_type *__lo, const char_type *__hi) const |
| virtual char_type | do_tolower (char_type __c) const |
| virtual const char_type * | do_toupper (char_type *__lo, const char_type *__hi) const |
| virtual char_type | do_toupper (char_type __c) 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) |
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 615 of file locale_facets.h.
◆ __to_type
| typedef const int* std::ctype_base::__to_type | inherited |
|---|
◆ char_type
template<typename _CharT >
◆ mask
template<typename _CharT >
template<typename _CharT >
| std::ctype< _CharT >::ctype ( size_t __refs = 0) | inlineexplicit |
|---|
◆ do_is() [1/2]
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
| __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 >.
◆ do_is() [2/2]
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
| __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 >.
◆ do_narrow() [1/2]
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
| __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 >::narrow(), and std::ctype< char >::narrow().
◆ do_narrow() [2/2]
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
| __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 >.
◆ do_scan_is()
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
| __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 >.
◆ do_scan_not()
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
| __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 >.
◆ do_tolower() [1/2]
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
Returns
__hi.
Implements std::__ctype_abstract_base< _CharT >.
◆ do_tolower() [2/2]
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
| __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(), and std::ctype< char >::tolower().
◆ do_toupper() [1/2]
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
Returns
__hi.
Implements std::__ctype_abstract_base< _CharT >.
◆ do_toupper() [2/2]
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
| __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(), and std::ctype< char >::toupper().
◆ do_widen() [1/2]
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
Returns
The converted char_type
Implements std::__ctype_abstract_base< _CharT >.
Referenced by std::ctype< char >::widen(), and std::ctype< char >::widen().
◆ do_widen() [2/2]
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
| __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 >.
◆ is() [1/2]
template<typename _CharT >
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
| __vec | Pointer to an array of mask storage. |
Returns
__hi.
Definition at line 189 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_is().
◆ is() [2/2]
template<typename _CharT >
◆ narrow() [1/2]
template<typename _CharT >
◆ narrow() [2/2]
template<typename _CharT >
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
| __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.
Definition at line 356 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_narrow().
◆ scan_is()
template<typename _CharT >
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
| __m | The mask to compare against. |
|---|---|
| __lo | Pointer to start of range. |
| __hi | Pointer to end of range. |
Returns
Pointer to matching char_type if found, else __hi.
Definition at line 205 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_scan_is().
◆ scan_not()
template<typename _CharT >
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
| __m | The mask to compare against. |
|---|---|
| __lo | Pointer to first char in range. |
| __hi | Pointer to end of range. |
Returns
Pointer to non-matching char if found, else __hi.
Definition at line 221 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_scan_not().
◆ tolower() [1/2]
template<typename _CharT >
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
Returns
__hi.
Definition at line 279 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_tolower().
◆ tolower() [2/2]
template<typename _CharT >
◆ toupper() [1/2]
template<typename _CharT >
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
Returns
__hi.
Definition at line 250 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_toupper().
◆ toupper() [2/2]
template<typename _CharT >
◆ widen() [1/2]
template<typename _CharT >
◆ widen() [2/2]
template<typename _CharT >
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
| __lo | Pointer to start of range. |
|---|---|
| __hi | Pointer to end of range. |
| __to | Pointer to the destination array. |
Returns
__hi.
Definition at line 315 of file locale_facets.h.
References std::__ctype_abstract_base< _CharT >::do_widen().
◆ alnum
| const mask std::ctype_base::alnum | staticinherited |
|---|
◆ alpha
| const mask std::ctype_base::alpha | staticinherited |
|---|
◆ blank
| const mask std::ctype_base::blank | staticinherited |
|---|
◆ cntrl
| const mask std::ctype_base::cntrl | staticinherited |
|---|
◆ digit
| const mask std::ctype_base::digit | staticinherited |
|---|
◆ graph
| const mask std::ctype_base::graph | staticinherited |
|---|
◆ id
template<typename _CharT >
◆ lower
| const mask std::ctype_base::lower | staticinherited |
|---|
| const mask std::ctype_base::print | staticinherited |
|---|
◆ punct
| const mask std::ctype_base::punct | staticinherited |
|---|
◆ space
| const mask std::ctype_base::space | staticinherited |
|---|
◆ upper
| const mask std::ctype_base::upper | staticinherited |
|---|
◆ xdigit
| const mask std::ctype_base::xdigit | staticinherited |
|---|
The documentation for this class was generated from the following file: