-// ----------------------------------------------------------------------------
-// $Id$
-// ----------------------------------------------------------------------------
-// Public Domain C Library - http://pdclib.sourceforge.net
-// This code is Public Domain. Use, modify, and redistribute at will.
-// ----------------------------------------------------------------------------
-// Provides information on locale specifics as well as a function to change the
-// active locale to something else but the startup default "C".
-// ----------------------------------------------------------------------------
+/* $Id$ */
-#ifndef __LOCALE_H
-#define __LOCALE_H __LOCALE_H
+/* 7.11 Localization <locale.h>
-// ----------------------------------------------------------------------------
-// DEFINES
+ This file is part of the Public Domain C Library (PDCLib).
+ Permission is granted to use, modify, and / or redistribute at will.
+*/
-#define NULL 0
+#ifndef _PDCLIB_LOCALE_H
+#define _PDCLIB_LOCALE_H _PDCLIB_LOCALE_H
-// Locale categories
-#define LC_COLLATE 1 // affects strcoll() and strxfrm()
-#define LC_CTYPE 2 // affects ctype.h
-#define LC_MONETARY 4 // affects monetary aspect of localeconv()
-#define LC_NUMERIC 8 // affects numeric aspect of localeconv()
-#define LC_TIME 16 // affects strftime()
-#define LC_ALL 31 // affects all of the above
+/* The structure returned by localeconv().
-// ----------------------------------------------------------------------------
-// TYPEDEFS
-
-// TODO: Detailed documentation of grouping formats and field values
+ The values for *_sep_by_space:
+ 0 - no space
+ 1 - if symbol and sign are adjacent, a space seperates them from the value;
+ otherwise a space seperates the symbol from the value
+ 2 - if symbol and sign are adjacent, a space seperates them; otherwise a
+ space seperates the sign from the value
+ The values for *_sign_posn:
+ 0 - Parentheses surround value and symbol
+ 1 - sign precedes value and symbol
+ 2 - sign succeeds value and symbol
+ 3 - sign immediately precedes symbol
+ 4 - sign immediately succeeds symbol
+*/
struct lconv
{
- // LC_NUMERIC
- char * decimal_point; // decimal point
- char * grouping; // grouping
- char * thousands_sep; // grouping string
+ char * decimal_point; /* decimal point character */
+ char * thousands_sep; /* character for seperating groups of digits */
+ char * grouping; /* string indicating the size of digit groups */
+ char * mon_decimal_point; /* decimal point for monetary quantities */
+ char * mon_thousands_sep; /* thousands_sep for monetary quantities */
+ char * mon_grouping; /* grouping for monetary quantities */
+ char * positive_sign; /* string indicating nonnegative mty. qty. */
+ char * negative_sign; /* string indicating negative mty. qty. */
+ char * currency_symbol; /* local currency symbol (e.g. '$') */
+ char * int_curr_symbol; /* international currency symbol (e.g. "USD" */
+ char frac_digits; /* fractional digits in local monetary qty. */
+ char p_cs_precedes; /* if currency_symbol precedes positive qty. */
+ char n_cs_precedes; /* if currency_symbol precedes negative qty. */
+ char p_sep_by_space; /* if it is seperated by space from pos. qty. */
+ char n_sep_by_space; /* if it is seperated by space from neg. qty. */
+ char p_sign_posn; /* positioning of positive_sign for mon. qty. */
+ char n_sign_posn; /* positioning of negative_sign for mon. qty. */
+ char int_frac_digits; /* Same as above, for international format */
+ char int_p_cs_precedes; /* Same as above, for international format */
+ char int_n_cs_precedes; /* Same as above, for international format */
+ char int_p_sep_by_space; /* Same as above, for international format */
+ char int_n_sep_by_space; /* Same as above, for international format */
+ char int_p_sign_posn; /* Same as above, for international format */
+ char int_n_sign_posn; /* Same as above, for international format */
+}
+
+#ifndef _PDCLIB_NULL_DEFINED
+#define _PDCLIB_NULL_DEFINED _PDCLIB_NULL_DEFINED
+#define NULL _PDCLIB_NULL
+#endif
- // LC_MONETARY
- char * mon_decimal_point; // decimal point
- char * mon_grouping; // grouping
- char * mon_thousands_sep; // grouping string
- char * negative_sign; // negative sign
- char * positive_sign; // positive sign
- char * currency_symbol; // currency symbol
- char frac_digits; // after-point digits
- // negative values
- char n_cs_precedes; // currency symbol preceding value?
- char n_sep_by_space; // currency symbol seperated by space?
- char n_sign_posn; // sign position
- // positive values
- char p_cs_precedes; // currency symbol preceding value?
- char p_sep_by_space; // currency symbol seperated by space?
- char p_sign_posn; // sign position?
+/* LC_ALL
+ - entire locale
+ LC_COLLATE
+ - strcoll(), strxfrm()
+ LC_CTYPE
+ - <ctype.h>
+ LC_MONETARY
+ - monetary formatting as returned by localeconv
+ LC_NUMERIC
+ - decimal-point character for printf() / scanf() functions, string
+ conversions, and nonmonetary formattign as returned by localeconv
+ LC_TIME
+ - strftime(), wcsftime()
- // for international monetary values
- char * int_curr_symbol; // international currency symbol (ISO 4217)
- char int_frac_digits; // after-point digits
- // negative values
- char int_n_cs_precedes; // currency symbol preceding value?
- char int_n_sep_by_space; // currency symbol seperated by space?
- char int_n_sign_posn; // sign position?
- // positive values
- char int_p_cs_precedes; // currency symbol preceding value?
- char int_p_sep_by_space; // currency symbol seperated by space?
- char int_p_sign_posn; // sign position?
-};
+ First arguments to setlocale().
+*/
-// ----------------------------------------------------------------------------
-// FUNCTIONS
+/* The category parameter can be any of the LC_* macros to specify if the call
+ to setlocale() shall affect the entire locale or only a portion thereof.
+ The category locale specifies which locale should be switched to, with "C"
+ being the minimal default locale, and "" being the locale-specific native
+ environment. A NULL pointer makes setlocale() return the *current* setting.
+ Otherwise, returns a pointer to a string associated with the specified
+ category for the new locale.
+*/
+char * setlocale( int category, const char * locale );
-// Returns a (pointer to a) lconv structure holding the values for the current
-// locale. The structure must not be changed; values might become outdated with
-// later calls to setlocale() changing LC_NUMERIC, LC_MONETARY or LC_ALL.
+/* Returns a struct lconv initialized to the values appropriate for the current
+ locale setting.
+*/
struct lconv * localeconv( void );
-// Categories are selected by OR'ing the LC_* defines from this header. The
-// function sets the current locale to that defined by locale_name, and returns
-// the name of the new locale (if it was set successfully) or a null pointer
-// (if unsuccessful). At startup, the current locale is "C" by default. A null
-// pointer as locale_name leaves the locale unchanged, an empty string sets it
-// to the "native" locale.
-char * setlocale( int categories, const char * locale_name );
+#endif
-#endif // __LOCALE_H