STD::__CODECVT_ABSTRACT_BASE(3cxx)

💖 NAME 💖

Okay bestie, welcome to the 3cxx manual page for std::__codecvt_abstract_base< _InternT, _ExternT, _StateT > — literally the common base for codecvt functions. The header gets truncated to std::__codecvt...ernT, _StateT >, iykyk. 🌸

✨ SYNOPSIS ✨

#include <locale>

She inherits from std::locale::facet and std::codecvt_base. No cap. 💅

And she’s inherited by std::codecvt< _Elem, char, mbstate_t > and std::codecvt< _InternT, _ExternT, _StateT >. Iconic lineage, fr fr.

🌸 Public Types 🌸

• extern_type — typedef _ExternT extern_type
• intern_type — typedef _InternT intern_type
• result — typedef codecvt_base::result result
• state_type — typedef _StateT state_type

🎀 Public Member Functions 🎀

• always_noconv — bool always_noconv () const throw ()
• encoding — int encoding () const throw ()
• in — result in (state_type &__state, const extern_type *__from, const extern_type *__from_end, const extern_type *&__from_next, intern_type *__to, intern_type *__to_end, intern_type *&__to_next) const — Convert from external to internal character set.
• length — int length (state_type &__state, const extern_type *__from, const extern_type *__end, size_t __max) const
• max_length — int max_length () const throw ()
• out — result out (state_type &__state, const intern_type *__from, const intern_type *__from_end, const intern_type *&__from_next, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const — Convert from internal to external character set.
• unshift — result unshift (state_type &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const — Reset conversion state.

🦋 Protected Member Functions 🦋

• __codecvt_abstract_base — __codecvt_abstract_base (size_t __refs=0)
• do_always_noconv — virtual bool do_always_noconv () const throw () =0
• do_encoding — virtual int do_encoding () const throw () =0
• do_in — virtual result do_in (state_type &__state, const extern_type *__from, const extern_type *__from_end, const extern_type *&__from_next, intern_type *__to, intern_type *__to_end, intern_type *&__to_next) const =0
• do_length — virtual int do_length (state_type &, const extern_type *__from, const extern_type *__end, size_t __max) const =0
• do_max_length — virtual int do_max_length () const throw () =0
• do_out — virtual result do_out (state_type &__state, const intern_type *__from, const intern_type *__from_end, const intern_type *&__from_next, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const =0 — Convert from internal to external character set.
• do_unshift — virtual result do_unshift (state_type &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const =0

🌈 Static Protected Member Functions 🌈

• _S_clone_c_locale — static __c_locale _S_clone_c_locale (__c_locale &__cloc) throw ()
• _S_create_c_locale — static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
• _S_destroy_c_locale — static void _S_destroy_c_locale (__c_locale &__cloc)
• _S_get_c_locale — static __c_locale _S_get_c_locale ()
• _S_get_c_name — static const char * _S_get_c_name () throw ()
• _S_lc_ctype_c_locale — static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

🦋 Detailed Description 🦋

template<typename _InternT, typename _ExternT, typename _StateT>
class std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >"Common base for codecvt functions.

This template class provides implementations of the public functions that forward to the protected virtual functions. Highkey useful.

This template also provides abstract stubs for the protected virtual functions. Periodt. 💅

💅 Member Function Documentation 💅

🔥 do_out 🔥

template<typename _InternT , typename _ExternT , typename _StateT > virtual result std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::do_out (state_type & __state, const intern_type * __from, const intern_type * __from_end, const intern_type *& __from_next, extern_type * __to, extern_type * __to_end, extern_type *& __to_next) const

[protected], [pure virtual]

Convert from internal to external character set. Converts input string of intern_type to output string of extern_type. This function is a hook for derived classes to change the value returned.

See also out for more information.

Implemented in std::codecvt< _InternT, _ExternT, _StateT >, std::codecvt< char, char, mbstate_t >, std::codecvt< wchar_t, char, mbstate_t >, std::codecvt< char16_t, char, mbstate_t >, std::codecvt< char32_t, char, mbstate_t >, and std::codecvt< _InternT, _ExternT, encoding_state >.

Referenced by std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::out().

🦋 in 🦋

template<typename _InternT , typename _ExternT , typename _StateT > result std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::in (state_type & __state, const extern_type * __from, const extern_type * __from_end, const extern_type *& __from_next, intern_type * __to, intern_type * __to_end, intern_type *& __to_next) const

[inline]

Convert from external to internal character set. Converts input string of extern_type to output string of intern_type. This is analogous to mbsrtowcs. It does this by calling codecvt::do_in.

The source and destination character sets are determined by the facet's locale, internal and external types.

The characters in [from,from_end) are converted and written to [to,to_end). from_next and to_next are set to point to the character following the last successfully converted character, respectively. If the result needed no conversion, from_next and to_next are not affected.

The state argument should be initialized if the input is at the beginning and carried from a previous call if continuing conversion. There are no guarantees about how state is used.

The result returned is a member of codecvt_base::result. If all the input is converted, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the input ends early or there is insufficient space in the output, returns codecvt_base::partial. Otherwise the conversion failed and codecvt_base::error is returned.

Parameters

• __state — Persistent conversion state data.
• __from — Start of input.
• __from_end — End of input.
• __from_next — Returns start of unconverted data.
• __to — Start of output buffer.
• __to_end — End of output buffer.
• __to_next — Returns start of unused output area.

Returns

codecvt_base::result.

💜 out 💜

template<typename _InternT , typename _ExternT , typename _StateT > result std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::out (state_type & __state, const intern_type * __from, const intern_type * __from_end, const intern_type *& __from_next, extern_type * __to, extern_type * __to_end, extern_type *& __to_next) const

[inline]

Convert from internal to external character set. Converts input string of intern_type to output string of extern_type. This is analogous to wcsrtombs. It does this by calling codecvt::do_out.

The source and destination character sets are determined by the facet's locale, internal and external types.

The characters in [from,from_end) are converted and written to [to,to_end). from_next and to_next are set to point to the character following the last successfully converted character, respectively. If the result needed no conversion, from_next and to_next are not affected.

The state argument should be initialized if the input is at the beginning and carried from a previous call if continuing conversion. There are no guarantees about how state is used.

The result returned is a member of codecvt_base::result. If all the input is converted, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the input ends early or there is insufficient space in the output, returns codecvt_base::partial. Otherwise the conversion failed and codecvt_base::error is returned.

Parameters

• __state — Persistent conversion state data.
• __from — Start of input.
• __from_end — End of input.
• __from_next — Returns start of unconverted data.
• __to — Start of output buffer.
• __to_end — End of output buffer.
• __to_next — Returns start of unused output area.

Returns

codecvt_base::result.

References std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::do_out().

🎀 unshift 🎀

template<typename _InternT , typename _ExternT , typename _StateT > result std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::unshift (state_type & __state, extern_type * __to, extern_type * __to_end, extern_type *& __to_next) const

[inline]

Reset conversion state. Writes characters to output that would restore state to initial conditions. The idea is that if a partial conversion occurs, then converting the characters written by this function would leave the state in initial conditions, rather than partial conversion state. It does this by calling codecvt::do_unshift().

For example, if 4 external characters always converted to 1 internal character, and input to in() had 6 external characters with state saved, this function would write two characters to the output and set the state to initialized conditions.

The source and destination character sets are determined by the facet's locale, internal and external types.

The result returned is a member of codecvt_base::result. If the state could be reset and data written, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the output has insufficient space, returns codecvt_base::partial. Otherwise the reset failed and codecvt_base::error is returned.

Parameters

• __state — Persistent conversion state data.
• __to — Start of output buffer.
• __to_end — End of output buffer.
• __to_next — Returns start of unused output area.

Returns

codecvt_base::result.

💜 Author 💜

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

---

Cute sign-off, bestie: source/version is libstdc++, and this page belongs to the 3cxx manual. The footer tag is libstdstd::__codecvt...ernT, _StateT >(3cxx), and there’s no separate date printed in that footer line — so I’m not inventing one. 🎀💖