logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::ctype_byname< _CharT > - class ctype_byname [22.2.1.2].

Author

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

                                                    libstdc++                  std::ctype_byname<_CharT>(3cxx)

Detailed Description

template<typename_CharT>
       class std::ctype_byname< _CharT >"class ctype_byname [22.2.1.2].

Member Data Documentation

template<typename_CharT>locale::idstd::ctype<_CharT>::id[static],[inherited]
       The facet id for ctype<char_type>

Member Function Documentation

template<typename_CharT>virtualconstchar_type*std::ctype<_CharT>::do_is(constchar_type*__lo,constchar_type*__hi,mask*__vec)const[protected],[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.

       Implements std::__ctype_abstract_base<_CharT>.

   template<typename_CharT>virtualboolstd::ctype<_CharT>::do_is(mask__m,char_type__c)const[protected],[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.

       Implements std::__ctype_abstract_base<_CharT>.

   template<typename_CharT>virtualcharstd::ctype<_CharT>::do_narrow(char_type__c,char__dfault)const[protected],[virtual],[inherited]
       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().

   template<typename_CharT>virtualconstchar_type*std::ctype<_CharT>::do_narrow(constchar_type*__lo,constchar_type*__hi,char__dfault,char*__to)const[protected],[virtual],[inherited]
       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>virtualconstchar_type*std::ctype<_CharT>::do_scan_is(mask__m,constchar_type*__lo,constchar_type*__hi)const[protected],[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.

       Implements std::__ctype_abstract_base<_CharT>.

   template<typename_CharT>virtualconstchar_type*std::ctype<_CharT>::do_scan_not(mask__m,constchar_type*__lo,constchar_type*__hi)const[protected],[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.

       Implements std::__ctype_abstract_base<_CharT>.

   template<typename_CharT>virtualconstchar_type*std::ctype<_CharT>::do_tolower(char_type*__lo,constchar_type*__hi)const[protected],[virtual],[inherited]
       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>virtualchar_typestd::ctype<_CharT>::do_tolower(char_type__c)const[protected],[virtual],[inherited]
       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().

   template<typename_CharT>virtualconstchar_type*std::ctype<_CharT>::do_toupper(char_type*__lo,constchar_type*__hi)const[protected],[virtual],[inherited]
       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>virtualchar_typestd::ctype<_CharT>::do_toupper(char_type__c)const[protected],[virtual],[inherited]
       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().

   template<typename_CharT>virtualchar_typestd::ctype<_CharT>::do_widen(char__c)const[protected],[virtual],[inherited]
       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>::widen(), and std::ctype<char>::widen().

   template<typename_CharT>virtualconstchar*std::ctype<_CharT>::do_widen(constchar*__lo,constchar*__hi,char_type*__to)const[protected],[virtual],[inherited]
       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>constchar_type*std::__ctype_abstract_base<_CharT>::is(constchar_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_is().

   template<typename_CharT>boolstd::__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.

       References std::__ctype_abstract_base<_CharT>::do_is().

   template<typename_CharT>charstd::__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.

       References std::__ctype_abstract_base<_CharT>::do_narrow().

   template<typename_CharT>constchar_type*std::__ctype_abstract_base<_CharT>::narrow(constchar_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_narrow().

   template<typename_CharT>constchar_type*std::__ctype_abstract_base<_CharT>::scan_is(mask__m,constchar_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_scan_is().

   template<typename_CharT>constchar_type*std::__ctype_abstract_base<_CharT>::scan_not(mask__m,constchar_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_scan_not().

   template<typename_CharT>constchar_type*std::__ctype_abstract_base<_CharT>::tolower(char_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_tolower().

   template<typename_CharT>char_typestd::__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.

       References std::__ctype_abstract_base<_CharT>::do_tolower().

   template<typename_CharT>constchar_type*std::__ctype_abstract_base<_CharT>::toupper(char_type*__lo,constchar_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.

       References std::__ctype_abstract_base<_CharT>::do_toupper().

   template<typename_CharT>char_typestd::__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.

       References std::__ctype_abstract_base<_CharT>::do_toupper().

   template<typename_CharT>char_typestd::__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.

       References std::__ctype_abstract_base<_CharT>::do_widen().

   template<typename_CharT>constchar*std::__ctype_abstract_base<_CharT>::widen(constchar*__lo,constchar*__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.

       References std::__ctype_abstract_base<_CharT>::do_widen().

Name

       std::ctype_byname< _CharT > - class ctype_byname [22.2.1.2].

Synopsis

       #include <locale>

       Inherits std::ctype<_CharT>.

   PublicTypestypedef const int * __to_typetypedef _CharT char_typetypedefctype< _CharT >::mask maskPublicMemberFunctionsctype_byname (const char *__s, size_t __refs=0)
       ctype_byname (const string &__s, size_t __refs=0)
       const char_type * is (const char_type *__lo, const char_type *__hi, mask *__vec) const
           Return a mask array.
       bool is (mask __m, char_type __c) const
           Test char_type classification.
       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.
       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.
       const char_type * tolower (char_type *__lo, const char_type *__hi) const
           Convert array to lowercase.
       char_type tolower (char_type __c) const
           Convert to lowercase.
       const char_type * toupper (char_type *__lo, const char_type *__hi) const
           Convert array to uppercase.
       char_type toupper (char_type __c) const
           Convert to uppercase.
       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.

   StaticPublicAttributesstatic const mask alnumstatic const mask alphastatic const mask blankstatic const mask cntrlstatic const mask digitstatic const mask graphstaticlocale::idid
           The facet id for ctype<char_type>
       static const mask lowerstatic const mask printstatic const mask punctstatic const mask spacestatic const mask upperstatic const mask xdigitProtectedMemberFunctionsvirtual const char_type * do_is (const char_type *__lo, const char_type *__hi, mask *__vec) const
           Return a mask array.
       virtual bool do_is (mask __m, char_type __c) const
           Test char_type classification.
       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
           *__to) const
           Narrow char_type array to char.
       virtual const char_type * do_scan_is (mask __m, const char_type *__lo, const char_type *__hi) const
           Find char_type matching mask.
       virtual const char_type * do_scan_not (mask __m, const char_type *__lo, const char_type *__hi) const
           Find char_type not matching mask.
       virtual const char_type * do_tolower (char_type *__lo, const char_type *__hi) const
           Convert array to lowercase.
       virtual char_type do_tolower (char_type __c) const
           Convert to lowercase.
       virtual const char_type * do_toupper (char_type *__lo, const char_type *__hi) const
           Convert array to uppercase.
       virtual char_type do_toupper (char_type __c) const
           Convert to uppercase.
       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.

   StaticProtectedMemberFunctionsstatic __c_locale _S_clone_c_locale (__c_locale &__cloc)  throw ()
       staticvoid_S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
       staticvoid_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)

See Also