libstdc++
|
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.
typedef _CharT std::ctype::char_type |
Typedef for the template parameter.
Reimplemented from std::__ctype_abstract_base< _CharT >.
Definition at line 610 of file locale_facets.h.
virtual bool std::__ctype_abstract_base::do_is | ( | mask | __m, |
char_type | __c | ||
) | const [protected, pure virtual, inherited] |
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.
c | The char_type to find the mask of. |
m | The mask to compare against. |
virtual const char_type* std::__ctype_abstract_base::do_is | ( | const char_type * | __lo, |
const char_type * | __hi, | ||
mask * | __vec | ||
) | const [protected, pure virtual, inherited] |
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.
lo | Pointer to start of range. |
hi | Pointer to end of range. |
vec | Pointer to an array of mask storage. |
virtual char std::ctype::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.
c | The char_type to convert. |
dfault | Char to return if conversion fails. |
Implements std::__ctype_abstract_base< _CharT >.
Referenced by std::ctype< char >::narrow().
virtual const char_type* std::ctype::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.
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. |
Implements std::__ctype_abstract_base< _CharT >.
virtual const char_type* std::__ctype_abstract_base::do_scan_is | ( | mask | __m, |
const char_type * | __lo, | ||
const char_type * | __hi | ||
) | const [protected, pure virtual, inherited] |
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.
m | The mask to compare against. |
lo | Pointer to start of range. |
hi | Pointer to end of range. |
virtual const char_type* std::__ctype_abstract_base::do_scan_not | ( | mask | __m, |
const char_type * | __lo, | ||
const char_type * | __hi | ||
) | const [protected, pure virtual, inherited] |
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.
m | The mask to compare against. |
lo | Pointer to start of range. |
hi | Pointer to end of range. |
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.
c | The char_type to convert. |
Implements std::__ctype_abstract_base< _CharT >.
Referenced by std::ctype< char >::tolower().
virtual const char_type* std::ctype::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.
lo | Pointer to start of range. |
hi | Pointer to end of range. |
Implements std::__ctype_abstract_base< _CharT >.
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.
c | The char_type to convert. |
Implements std::__ctype_abstract_base< _CharT >.
Referenced by std::ctype< char >::toupper().
virtual const char_type* std::ctype::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.
lo | Pointer to start of range. |
hi | Pointer to end of range. |
Implements std::__ctype_abstract_base< _CharT >.
virtual char_type std::ctype::do_widen | ( | char | ) | 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.
c | The char to convert. |
Implements std::__ctype_abstract_base< _CharT >.
Referenced by std::ctype< char >::widen().
virtual const char* std::ctype::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.
lo | Pointer to start range. |
hi | Pointer to end of range. |
to | Pointer to the destination array. |
Implements std::__ctype_abstract_base< _CharT >.
bool std::__ctype_abstract_base::is | ( | mask | __m, |
char_type | __c | ||
) | const [inline, inherited] |
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().
c | The char_type to compare the mask of. |
m | The mask to compare against. |
Definition at line 163 of file locale_facets.h.
References std::__ctype_abstract_base::do_is().
const char_type* std::__ctype_abstract_base::is | ( | const char_type * | __lo, |
const char_type * | __hi, | ||
mask * | __vec | ||
) | const [inline, inherited] |
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().
lo | Pointer to start of range. |
hi | Pointer to end of range. |
vec | Pointer to an array of mask storage. |
Definition at line 180 of file locale_facets.h.
References std::__ctype_abstract_base::do_is().
char std::__ctype_abstract_base::narrow | ( | char_type | __c, |
char | __dfault | ||
) | const [inline, inherited] |
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.
c | The char_type to convert. |
dfault | Char to return if conversion fails. |
Definition at line 325 of file locale_facets.h.
References std::__ctype_abstract_base::do_narrow().
const char_type* std::__ctype_abstract_base::narrow | ( | const char_type * | __lo, |
const char_type * | __hi, | ||
char | __dfault, | ||
char * | __to | ||
) | const [inline, inherited] |
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.
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. |
Definition at line 347 of file locale_facets.h.
References std::__ctype_abstract_base::do_narrow().
const char_type* std::__ctype_abstract_base::scan_is | ( | mask | __m, |
const char_type * | __lo, | ||
const char_type * | __hi | ||
) | const [inline, inherited] |
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().
m | The mask to compare against. |
lo | Pointer to start of range. |
hi | Pointer to end of range. |
Definition at line 196 of file locale_facets.h.
References std::__ctype_abstract_base::do_scan_is().
const char_type* std::__ctype_abstract_base::scan_not | ( | mask | __m, |
const char_type * | __lo, | ||
const char_type * | __hi | ||
) | const [inline, inherited] |
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().
m | The mask to compare against. |
lo | Pointer to first char in range. |
hi | Pointer to end of range. |
Definition at line 212 of file locale_facets.h.
References std::__ctype_abstract_base::do_scan_not().
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).
c | The char_type to convert. |
Definition at line 255 of file locale_facets.h.
References std::__ctype_abstract_base::do_tolower().
const char_type* std::__ctype_abstract_base::tolower | ( | char_type * | __lo, |
const char_type * | __hi | ||
) | const [inline, inherited] |
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).
lo | Pointer to start of range. |
hi | Pointer to end of range. |
Definition at line 270 of file locale_facets.h.
References std::__ctype_abstract_base::do_tolower().
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().
c | The char_type to convert. |
Definition at line 226 of file locale_facets.h.
References std::__ctype_abstract_base::do_toupper().
const char_type* std::__ctype_abstract_base::toupper | ( | char_type * | __lo, |
const char_type * | __hi | ||
) | const [inline, inherited] |
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).
lo | Pointer to start of range. |
hi | Pointer to end of range. |
Definition at line 241 of file locale_facets.h.
References std::__ctype_abstract_base::do_toupper().
char_type std::__ctype_abstract_base::widen | ( | char | __c | ) | const [inline, inherited] |
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.
c | The char to convert. |
Definition at line 287 of file locale_facets.h.
References std::__ctype_abstract_base::do_widen().
const char* std::__ctype_abstract_base::widen | ( | const char * | __lo, |
const char * | __hi, | ||
char_type * | __to | ||
) | const [inline, inherited] |
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.
lo | Pointer to start of range. |
hi | Pointer to end of range. |
to | Pointer to the destination array. |
Definition at line 306 of file locale_facets.h.
References std::__ctype_abstract_base::do_widen().
locale::id std::ctype::id [static] |
The facet id for ctype<char_type>
Definition at line 614 of file locale_facets.h.