man std::ctype (Fonctions bibliothèques) - Template ctype facet.

NAME

std::ctype - Template ctype facet.

SYNOPSIS



#include <locale>

Inherits std::ctype_abstract_base< CharT >< CharT >.

Inherited by std::ctype_byname< CharT >.

Public Types

typedef CharT char_type

Typedef for the template parameter. typedef ctype_abstract_base< CharT >::mask mask

typedef const int * __to_type

Public Member Functions

ctype (size_t __refs=0)

bool is (mask __m, char_type c) const

Test char_type classification. const char_type * is (const char_type *__lo, const char_type *__hi, mask *__vec) const

Return a mask array. const char_type * scan_is (mask __m, const char_type *__lo, const char_type *__hi) const

Find char_type matching a mask. const char_type * scan_not (mask __m, const char_type *__lo, const char_type *__hi) const

Find char_type not matching a mask. char_type toupper (char_type c) const

Convert to uppercase. const char_type * toupper (char_type *__lo, const char_type *__hi) const

Convert array to uppercase. char_type tolower (char_type c) const

Convert to lowercase. const char_type * tolower (char_type *__lo, const char_type *__hi) const

Convert array to lowercase. char_type widen (char c) const

Widen char to char_type. const char * widen (const char *__lo, const char *__hi, char_type *__to) const

Widen array to char_type. char narrow (char_type c, char __dfault) const

Narrow char_type to char. const char_type * narrow (const char_type *__lo, const char_type *__hi, char __dfault, char *__to) const

Narrow array to char array.

Static Public Attributes

static locale::id id

The facet id for ctype<char_type>. static const mask upper

static const mask lower

static const mask alpha

static const mask digit

static const mask xdigit

static const mask space

static const mask print

static const mask graph

static const mask cntrl

static const mask punct

static const mask alnum

Protected Member Functions

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. virtual bool do_is (mask __m, char_type c) const =0

Test char_type classification. virtual const char_type * do_is (const char_type *__lo, const char_type *__hi, mask *__vec) const =0

Return a mask array. virtual const char_type * do_scan_is (mask __m, const char_type *__lo, const char_type *__hi) const =0

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

Find char_type not matching mask.

Static Protected Member Functions

static c_locale S_get_c_locale ()

static const char * S_get_c_name ()

Friends

class locale::Impl

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 <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 606 of file locale.

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.

Member Function Documentation

template<typename CharT> virtual const char_type* std::ctype_abstract_base< CharT >::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.

Parameters: lo Pointer to start of range.

hi Pointer to end of range.

vec Pointer to an array of mask storage.

Returns: hi.

template<typename CharT> virtual bool std::ctype_abstract_base< CharT >::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.

Parameters: c The char_type to find the mask of.

m The mask to compare against.

Returns: (M & m) != 0.

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_abstract_base< CharT >::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.

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.

template<typename CharT> virtual const char_type* std::ctype_abstract_base< CharT >::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.

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.

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().

template<typename CharT> const char_type* std::ctype_abstract_base< CharT >::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().

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 180 of file locale.

template<typename CharT> bool std::ctype_abstract_base< CharT >::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().

Parameters: c The char_type to compare the mask of.

m The mask to compare against.

Returns: (M & m) != 0.

Definition at line 163 of file locale.

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 [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.

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 347 of file locale.

template<typename CharT> char std::ctype_abstract_base< CharT >::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.

Parameters: c The char_type to convert.

dfault Char to return if conversion fails.

Returns: The converted char.

Definition at line 325 of file locale.

Referenced by std::time_get< CharT, InIter >::do_get_year(), std::time_get< CharT, InIter >::M_extract_num(), and std::time_put< CharT, OutIter >::put().

template<typename CharT> const char_type* std::ctype_abstract_base< CharT >::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().

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 196 of file locale.

template<typename CharT> const char_type* std::ctype_abstract_base< CharT >::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().

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 212 of file locale.

Referenced by std::money_put< CharT, OutIter >::M_insert().

template<typename CharT> const char_type* std::ctype_abstract_base< CharT >::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).

Parameters: lo Pointer to start of range.

hi Pointer to end of range.

Returns: hi.

Definition at line 270 of file locale.

template<typename CharT> char_type std::ctype_abstract_base< CharT >::tolower (char_type c) const [inline, inherited]

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: c The char_type to convert.

Returns: The lowercase char_type if convertible, else c.

Definition at line 255 of file locale.

template<typename CharT> const char_type* std::ctype_abstract_base< CharT >::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).

Parameters: lo Pointer to start of range.

hi Pointer to end of range.

Returns: hi.

Definition at line 241 of file locale.

template<typename CharT> char_type std::ctype_abstract_base< CharT >::toupper (char_type c) const [inline, inherited]

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: c The char_type to convert.

Returns: The uppercase char_type if convertible, else c.

Definition at line 226 of file locale.

Referenced by std::time_get< CharT, InIter >::M_extract_name().

template<typename CharT> const char* std::ctype_abstract_base< CharT >::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.

Parameters: lo Pointer to start of range.

hi Pointer to end of range.

to Pointer to the destination array.

Returns: hi.

Definition at line 306 of file locale.

template<typename CharT> char_type std::ctype_abstract_base< CharT >::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.

Parameters: c The char to convert.

Returns: The converted char_type.

Definition at line 287 of file locale.

Referenced by std::money_get< CharT, InIter >::do_get(), std::time_put< CharT, OutIter >::do_put(), std::money_put< CharT, OutIter >::do_put(), std::__moneypunct_cache< CharT, Intl >::M_cache(), std::numpunct_cache< CharT >::M_cache(), std::num_put< CharT, OutIter >::M_insert_float(), and std::__pad< CharT, Traits >::S_pad().

Member Data Documentation

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

The facet id for ctype<char_type>.

Definition at line 614 of file locale.

Author

Generated automatically by Doxygen for libstdc++-v3 Source from the source code.