Scroll to navigation

std::messages< _CharT >(3cxx) std::messages< _CharT >(3cxx)

NAME

std::messages< _CharT > - Primary class template messages.

SYNOPSIS

#include <locale>

Inherits std::locale::facet, and std::messages_base.

Inherited by std::messages_byname< _CharT >.

Public Types


typedef int catalog



typedef _CharT char_type
Public typedefs. typedef basic_string< _CharT > string_type
Public typedefs.

Public Member Functions


messages (__c_locale __cloc, const char *__s, size_t __refs=0)
Internal constructor. Not for general use. messages (size_t __refs=0)
Constructor performs initialization. void close (catalog __c) const
string_type get (catalog __c, int __set, int __msgid, const string_type &__s) const
catalog open (const basic_string< char > &, const locale &, const char *) const
catalog open (const basic_string< char > &__s, const locale &__loc) const

Static Public Attributes


static locale::id id
Numpunct facet id.

Protected Member Functions


virtual ~messages ()
Destructor. string_type _M_convert_from_char (char *) const
char * _M_convert_to_char (const string_type &__msg) const
virtual void do_close (catalog) const
void do_close (catalog) const
void do_close (catalog) const
string do_get (catalog, int, int, const string &) const
Specializations for required instantiations. virtual string_type do_get (catalog, int, int, const string_type &__dfault) const
wstring do_get (catalog, int, int, const wstring &) const
virtual catalog do_open (const basic_string< char > &, const locale &) const
messages< char >::catalog do_open (const basic_string< char > &, const locale &) const
messages< wchar_t >::catalog do_open (const basic_string< char > &, const locale &) const

Static Protected Member Functions


static __c_locale _S_clone_c_locale (__c_locale &__cloc) throw ()
static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
static void _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)

Protected Attributes


__c_locale _M_c_locale_messages
const char * _M_name_messages

Detailed Description

template<typename _CharT>

class std::messages< _CharT >"Primary class template messages.

This facet encapsulates the code to retrieve messages from message catalogs. The only thing defined by the standard for this facet is the interface. All underlying functionality is implementation-defined.

This library currently implements 3 versions of the message facet. The first version (gnu) is a wrapper around gettext, provided by libintl. The second version (ieee) is a wrapper around catgets. The final version (default) does no actual translation. These implementations are only provided for char and wchar_t instantiations.

The messages template uses protected virtual functions to provide the actual results. The public accessors forward the call to the virtual functions. These virtual functions are hooks for developers to implement the behavior they require from the messages facet.

Definition at line 1853 of file locale.

Member Typedef Documentation

typedef int std::messages_base::catalog [inherited]

Definition at line 1826 of file locale.

template<typename _CharT > typedef _CharT std::messages< _CharT >::char_type

Public typedefs.

Definition at line 1859 of file locale.

template<typename _CharT > typedef basic_string<_CharT> std::messages< _CharT >::string_type

Public typedefs.

Definition at line 1860 of file locale.

Constructor & Destructor Documentation

template<typename _CharT > std::messages< _CharT >::messages (size_t __refs = 0) [explicit]

Constructor performs initialization. This is the constructor provided by the standard.

Parameters

__refs Passed to the base facet class.

Definition at line 44 of file messages_members.h.

template<typename _CharT > std::messages< _CharT >::messages (__c_locale __cloc, const char * __s, size_t __refs = 0) [explicit]

Internal constructor. Not for general use. This is a constructor for use by the library itself to set up new locales.

Parameters

__cloc The C locale.
__s The name of a locale.
__refs Refcount to pass to the base class.

Definition at line 50 of file messages_members.h.

template<typename _CharT > std::messages< _CharT >::~messages [protected], [virtual]

Destructor.

Definition at line 79 of file messages_members.h.

Member Function Documentation

template<typename _CharT > string_type std::messages< _CharT >::_M_convert_from_char (char *) const [inline], [protected]

Definition at line 2014 of file locale.

template<typename _CharT > char * std::messages< _CharT >::_M_convert_to_char (const string_type & __msg) const [inline], [protected]

Definition at line 2006 of file locale.

template<typename _CharT > void std::messages< _CharT >::close (catalog __c) const [inline]

Definition at line 1955 of file locale.

template<typename _CharT > void std::messages< _CharT >::do_close (catalog) const [protected], [virtual]

Definition at line 99 of file messages_members.h.

string std::messages< char >::do_get (catalog, int, int, const string &) const [protected]

Specializations for required instantiations.

template<typename _CharT > messages< _CharT >::catalog std::messages< _CharT >::do_open (const basic_string< char > & __s, const locale &) const [protected], [virtual]

Definition at line 88 of file messages_members.h.

template<typename _CharT > string_type std::messages< _CharT >::get (catalog __c, int __set, int __msgid, const string_type & __s) const [inline]

Definition at line 1944 of file locale.

template<typename _CharT > messages< _CharT >::catalog std::messages< _CharT >::open (const basic_string< char > & __s, const locale & __loc, const char * __dir) const

Definition at line 70 of file messages_members.h.

template<typename _CharT > catalog std::messages< _CharT >::open (const basic_string< char > & __s, const locale & __loc) const [inline]

Definition at line 1908 of file locale.

Member Data Documentation

template<typename _CharT > __c_locale std::messages< _CharT >::_M_c_locale_messages [protected]

Definition at line 1866 of file locale.

template<typename _CharT > const char* std::messages< _CharT >::_M_name_messages [protected]

Definition at line 1867 of file locale.

template<typename _CharT > locale::id std::messages< _CharT >::id [static]

Numpunct facet id.

Definition at line 1871 of file locale.

Author

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

Sun Jan 8 2023 libstdc++