#include <locale.h>
#include <string>
#include <cosmos/dso_export.h>
#include <cosmos/SysString.hxx>

Enumerations
enum class	cosmos::locale::Category : int { ALL = LC_ALL , COLLATE = LC_COLLATE , CTYPE = LC_CTYPE , MESSAGES = LC_MESSAGES , MONETARY = LC_MONETARY , NUMERIC = LC_NUMERIC , TIME = LC_TIME }
	Different Locale Categories that can be configured. More...

Functions
std::string	cosmos::locale::get (Category category)
	Returns a string describing the currently active locale setting for the given category.

void	cosmos::locale::set (Category category, const SysString val)
	Set the given locale category to the given value.

void	cosmos::locale::set_to_default (Category category)
	Set the given locale category to its default value ("C" or "POSIX").

void	cosmos::locale::set_from_environment (Category category)
	Set the given locale category according to present environment variables.

Detailed Description

This header contains locale specific types and functionality.

Beware that the following functions are not thread-safe (by C-API design)

Setting up the locale should be done in the main thread of a program early on so that this poses no problem.

Definition in file locale.hxx.

Enumeration Type Documentation

◆ Category

enum class cosmos::locale::Category : int

strong

Different Locale Categories that can be configured.

Enumerator
ALL	all aspects of the locale
COLLATE	comparison of strings
CTYPE	character classification (e.g. alphanumeric, numeric, ...)
MESSAGES	natural language messages
MONETARY	formatting of monetary values
NUMERIC	non-monetary numeric values
TIME	formatting of date and time values

Definition at line 27 of file locale.hxx.

                    : int {
        ALL            = LC_ALL,       
        COLLATE        = LC_COLLATE,   
        CTYPE          = LC_CTYPE,     
        MESSAGES       = LC_MESSAGES,  
        MONETARY       = LC_MONETARY,  
        NUMERIC        = LC_NUMERIC,   
        TIME           = LC_TIME       
#ifdef LC_ADDRESS /* the following are GNU extensions */
        ,ADDRESS       = LC_ADDRESS,        
        IDENTIFICATION = LC_IDENTIFICATION, 
        MEASUREMENT    = LC_MEASUREMENT,    
        NAME           = LC_NAME,           
        PAPER          = LC_PAPER,          
        TELEPHONE      = LC_TELEPHONE       
#endif
};

Function Documentation

◆ get()

COSMOS_API std::string cosmos::locale::get ( Category category )

Returns a string describing the currently active locale setting for the given category.

Definition at line 14 of file locale.cxx.

                                 {
        // this string is potentially statically allocated and will be
        // overwritten by future calls to setlocale()
        char *locale = ::setlocale(get_cat(category), nullptr);
        return locale;
}

◆ set()

COSMOS_API void cosmos::locale::set	(	Category	category,
		const SysString	val )

Set the given locale category to the given value.

This may throw an ApiError if the request cannot be honored.

Definition at line 21 of file locale.cxx.

                                                 {
        if (::setlocale(get_cat(category), val.raw()) == nullptr) {
                cosmos_throw (ApiError("setlocale()"));
        }
}

◆ set_from_environment()

COSMOS_API void cosmos::locale::set_from_environment ( Category category )

Set the given locale category according to present environment variables.

This function call will inspect the environment variables and set the given locale category accordingly (setlocale(cat, "").

Definition at line 31 of file locale.cxx.

                                             {
        set(category, "");
}

◆ set_to_default()

COSMOS_API void cosmos::locale::set_to_default ( Category category )

Set the given locale category to its default value ("C" or "POSIX").

Definition at line 27 of file locale.cxx.

                                       {
        set(category, "C");
}

Enumerations

Functions