]> pd.if.org Git - pdclib.old/blob - includes/locale.h
PDCLIB-2 PDCLIB-9 mbrtowc
[pdclib.old] / includes / locale.h
1 /* $Id$ */
2
3 /* 7.11 Localization <locale.h>
4
5    This file is part of the Public Domain C Library (PDCLib).
6    Permission is granted to use, modify, and / or redistribute at will.
7 */
8
9 #ifndef _PDCLIB_LOCALE_H
10 #define _PDCLIB_LOCALE_H _PDCLIB_LOCALE_H
11 #include <_PDCLIB_int.h>
12 _PDCLIB_BEGIN_EXTERN_C
13
14 #ifndef _PDCLIB_NULL_DEFINED
15 #define _PDCLIB_NULL_DEFINED _PDCLIB_NULL_DEFINED
16 #define NULL _PDCLIB_NULL
17 #endif
18
19 /* The structure returned by localeconv().
20
21    The values for *_sep_by_space:
22    0 - no space
23    1 - if symbol and sign are adjacent, a space seperates them from the value;
24        otherwise a space seperates the symbol from the value
25    2 - if symbol and sign are adjacent, a space seperates them; otherwise a
26        space seperates the sign from the value
27
28    The values for *_sign_posn:
29    0 - Parentheses surround value and symbol
30    1 - sign precedes value and symbol
31    2 - sign succeeds value and symbol
32    3 - sign immediately precedes symbol
33    4 - sign immediately succeeds symbol
34 */
35 struct lconv
36 {
37     char * decimal_point;      /* decimal point character                     */
38     char * thousands_sep;      /* character for seperating groups of digits   */
39     char * grouping;           /* string indicating the size of digit groups  */
40     char * mon_decimal_point;  /* decimal point for monetary quantities       */
41     char * mon_thousands_sep;  /* thousands_sep for monetary quantities       */
42     char * mon_grouping;       /* grouping for monetary quantities            */
43     char * positive_sign;      /* string indicating nonnegative mty. qty.     */
44     char * negative_sign;      /* string indicating negative mty. qty.        */
45     char * currency_symbol;    /* local currency symbol (e.g. '$')            */
46     char * int_curr_symbol;    /* international currency symbol (e.g. "USD"   */
47     char frac_digits;          /* fractional digits in local monetary qty.    */
48     char p_cs_precedes;        /* if currency_symbol precedes positive qty.   */
49     char n_cs_precedes;        /* if currency_symbol precedes negative qty.   */
50     char p_sep_by_space;       /* if it is seperated by space from pos. qty.  */
51     char n_sep_by_space;       /* if it is seperated by space from neg. qty.  */
52     char p_sign_posn;          /* positioning of positive_sign for mon. qty.  */
53     char n_sign_posn;          /* positioning of negative_sign for mon. qty.  */
54     char int_frac_digits;      /* Same as above, for international format     */
55     char int_p_cs_precedes;    /* Same as above, for international format     */
56     char int_n_cs_precedes;    /* Same as above, for international format     */
57     char int_p_sep_by_space;   /* Same as above, for international format     */
58     char int_n_sep_by_space;   /* Same as above, for international format     */
59     char int_p_sign_posn;      /* Same as above, for international format     */
60     char int_n_sign_posn;      /* Same as above, for international format     */
61 };
62
63 /* First arguments to setlocale().
64    TODO: Beware, values might change before v0.6 is released.
65 */
66 /* Entire locale */
67 #define LC_ALL      0
68 /* Collation (strcoll(), strxfrm()) */
69 #define LC_COLLATE  1
70 /* Character types (<ctype.h>) */
71 #define LC_CTYPE    2
72 /* Monetary formatting (as returned by localeconv) */
73 #define LC_MONETARY 3
74 /* Decimal-point character (for printf() / scanf() functions), string
75    conversions, nonmonetary formatting as returned by localeconv              */
76 #define LC_NUMERIC  4
77 /* Time formats (strftime(), wcsftime()) */
78 #define LC_TIME     5
79
80 /* The category parameter can be any of the LC_* macros to specify if the call
81    to setlocale() shall affect the entire locale or only a portion thereof.
82    The category locale specifies which locale should be switched to, with "C"
83    being the minimal default locale, and "" being the locale-specific native
84    environment. A NULL pointer makes setlocale() return the *current* setting.
85    Otherwise, returns a pointer to a string associated with the specified
86    category for the new locale.
87 */
88 char * setlocale( int category, const char * locale ) _PDCLIB_nothrow;
89
90 /* Returns a struct lconv initialized to the values appropriate for the current
91    locale setting.
92 */
93 struct lconv * localeconv( void ) _PDCLIB_nothrow;
94
95 #if _PDCLIB_POSIX_MIN(2008)
96
97 /* POSIX locale type */
98 typedef _PDCLIB_locale_t locale_t;
99
100 /* Global locale */
101 extern struct _PDCLIB_locale _PDCLIB_global_locale;
102 #define LC_GLOBAL_LOCALE (&_PDCLIB_global_locale)
103
104 /* Set the thread locale to newlocale
105  *
106  * If newlocale is (locale_t)0, then doesn't change the locale and just returns
107  * the existing locale.
108  *
109  * If newlocale is LC_GLOBAL_LOCALE, resets the thread's locale to use the 
110  * global locale.
111  *
112  * Returns the previous thread locale. If the thread had no previous locale, 
113  * returns the global locale.
114  */
115 locale_t uselocale(locale_t newlocale);
116
117 /* Returns a copy of loc */
118 locale_t duplocale(locale_t loc);
119
120 /* Frees the passed locale object */
121 void freelocale(locale_t loc);
122
123 #endif
124
125 _PDCLIB_END_EXTERN_C
126 #endif
127