std::ctype< char > Class Template Reference

The ctype<char> specialization. More...

Inheritance diagram for std::ctype< char >:

Inheritance graph

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends


Detailed Description

template<>
class std::ctype< char >

The ctype<char> specialization.

This class defines classification and conversion functions for the char type. It gets used by char streams for many I/O operations. The char specialization provides a number of optimizations as well.

Definition at line 674 of file locale_facets.h.


Member Typedef Documentation

typedef char std::ctype< char >::char_type

Typedef for the template parameter char.

Definition at line 679 of file locale_facets.h.


Constructor & Destructor Documentation

std::ctype< char >::ctype ( const mask *  __table = 0,
bool  __del = false,
size_t  __refs = 0 
) [explicit]

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters:
table If non-zero, table is used as the per-char mask. Else classic_table() is used.
del If true, passes ownership of table to this facet.
refs Passed to the base facet class.

std::ctype< char >::ctype ( __c_locale  __cloc,
const mask *  __table = 0,
bool  __del = false,
size_t  __refs = 0 
) [explicit]

Constructor performs static initialization.

This constructor is used to construct the initial C locale facet.

Parameters:
cloc Handle to C locale data.
table If non-zero, table is used as the per-char mask.
del If true, passes ownership of table to this facet.
refs Passed to the base facet class.

virtual std::ctype< char >::~ctype (  )  [protected, virtual]

Destructor.

This function deletes table() if del was true in the constructor.


Member Function Documentation

static const mask* std::ctype< char >::classic_table (  )  throw () [static]

Returns a pointer to the C locale mask table.

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

Narrow char array to char array.

This virtual function converts each char in the range [lo,hi) to char using the simplest reasonable transformation and writes the results to the destination array. For any char in the input that cannot be converted, dfault is used instead. For an underived ctype<char> facet, the argument will be copied unchanged.

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.

Definition at line 1150 of file locale_facets.h.

virtual char std::ctype< char >::do_narrow ( char_type  __c,
char   
) const [inline, protected, virtual]

Narrow char.

This virtual function converts the char to char using the simplest reasonable transformation. If the conversion fails, dfault is returned instead. For an underived ctype<char> facet, c will be returned unchanged.

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 to convert.
dfault Char to return if conversion fails.
Returns:
The converted char.

Definition at line 1124 of file locale_facets.h.

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

Convert array to lowercase.

This virtual function converts each char in the range [lo,hi) to lowercase if possible. Other chars 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 first char in range.
hi Pointer to end of range.
Returns:
hi.

virtual char_type std::ctype< char >::do_tolower ( char_type   )  const [protected, virtual]

Convert to lowercase.

This virtual function converts the char 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 to convert.
Returns:
The lowercase char if convertible, else c.

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

Convert array to uppercase.

This virtual function converts each char in the range [lo,hi) to uppercase if possible. Other chars 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.

virtual char_type std::ctype< char >::do_toupper ( char_type   )  const [protected, virtual]

Convert to uppercase.

This virtual function converts the char 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 to convert.
Returns:
The uppercase char if convertible, else c.

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

Widen char array.

This function converts each char in the range [lo,hi) to char using the simplest reasonable transformation. For an underived ctype<char> facet, the argument will be copied unchanged.

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 of range.
hi Pointer to end of range.
to Pointer to the destination array.
Returns:
hi.

Definition at line 1098 of file locale_facets.h.

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

Widen char.

This virtual function converts the char to char using the simplest reasonable transformation. For an underived ctype<char> facet, the argument will be returned unchanged.

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

Definition at line 1075 of file locale_facets.h.

const char * std::ctype< char >::is ( const char *  __lo,
const char *  __hi,
mask *  __vec 
) const [inline]

Return a mask array.

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

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 46 of file ctype_inline.h.

bool std::ctype< char >::is ( mask  __m,
char  __c 
) const [inline]

Test char classification.

This function compares the mask table[c] to m.

Parameters:
c The char to compare the mask of.
m The mask to compare against.
Returns:
True if m & table[c] is true, false otherwise.

Definition at line 41 of file ctype_inline.h.

const char_type* std::ctype< char >::narrow ( const char_type __lo,
const char_type __hi,
char  __dfault,
char *  __to 
) const [inline]

Narrow char array.

This function converts each char in the input to char using the simplest reasonable transformation and writes the results to the destination array. For any char in the input that cannot be converted, dfault is used instead. For an underived ctype<char> facet, the argument will be copied unchanged.

This function works as if it returns ctype<char>::do_narrow(lo, hi, dfault, to). 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.

Definition at line 956 of file locale_facets.h.

char std::ctype< char >::narrow ( char_type  __c,
char  __dfault 
) const [inline]

Narrow char.

This function converts the char to char using the simplest reasonable transformation. If the conversion fails, dfault is returned instead. For an underived ctype<char> facet, c will be returned unchanged.

This function works as if it returns ctype<char>::do_narrow(c). 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 to convert.
dfault Char to return if conversion fails.
Returns:
The converted character.

Definition at line 923 of file locale_facets.h.

const char * std::ctype< char >::scan_is ( mask  __m,
const char *  __lo,
const char *  __hi 
) const [inline]

Find char matching a mask.

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

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 if found, else hi.

Definition at line 55 of file ctype_inline.h.

const char * std::ctype< char >::scan_not ( mask  __m,
const char *  __lo,
const char *  __hi 
) const [inline]

Find char not matching a mask.

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

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 if found, else hi.

Definition at line 65 of file ctype_inline.h.

const mask* std::ctype< char >::table (  )  const throw () [inline]

Returns a pointer to the mask table provided to the constructor, or the default from classic_table() if none was provided.

Definition at line 974 of file locale_facets.h.

const char_type* std::ctype< char >::tolower ( char_type __lo,
const char_type __hi 
) const [inline]

Convert array to lowercase.

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

tolower() acts as if it returns ctype<char>:: do_tolower(lo, hi). do_tolower() must always return the same result for the same input.

Parameters:
lo Pointer to first char in range.
hi Pointer to end of range.
Returns:
hi.

Definition at line 845 of file locale_facets.h.

char_type std::ctype< char >::tolower ( char_type  __c  )  const [inline]

Convert to lowercase.

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

tolower() acts as if it returns ctype<char>::do_tolower(c). do_tolower() must always return the same result for the same input.

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

Definition at line 828 of file locale_facets.h.

const char_type* std::ctype< char >::toupper ( char_type __lo,
const char_type __hi 
) const [inline]

Convert array to uppercase.

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

toupper() acts as if it returns ctype<char>:: do_toupper(lo, hi). do_toupper() must always return the same result for the same input.

Parameters:
lo Pointer to first char in range.
hi Pointer to end of range.
Returns:
hi.

Definition at line 812 of file locale_facets.h.

char_type std::ctype< char >::toupper ( char_type  __c  )  const [inline]

Convert to uppercase.

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

toupper() acts as if it returns ctype<char>::do_toupper(c). do_toupper() must always return the same result for the same input.

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

Definition at line 795 of file locale_facets.h.

const char* std::ctype< char >::widen ( const char *  __lo,
const char *  __hi,
char_type __to 
) const [inline]

Widen char array.

This function converts each char in the input to char using the simplest reasonable transformation. For an underived ctype<char> facet, the argument will be copied unchanged.

This function works as if it returns ctype<char>::do_widen(c). 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 first char in range.
hi Pointer to end of range.
to Pointer to the destination array.
Returns:
hi.

Definition at line 892 of file locale_facets.h.

char_type std::ctype< char >::widen ( char  __c  )  const [inline]

Widen char.

This function converts the char to char_type using the simplest reasonable transformation. For an underived ctype<char> facet, the argument will be returned unchanged.

This function works as if it returns ctype<char>::do_widen(c). 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 character.

Definition at line 865 of file locale_facets.h.


Member Data Documentation

locale::id std::ctype< char >::id [static]

The facet id for ctype<char>.

Definition at line 696 of file locale_facets.h.

const size_t std::ctype< char >::table_size [static]

The size of the mask table. It is SCHAR_MAX + 1.

Definition at line 698 of file locale_facets.h.


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

Generated on Thu Jul 23 21:17:48 2009 for libstdc++ by  doxygen 1.5.8