Update.
[platform/upstream/glibc.git] / locale / langinfo.h
1 /* Access to locale-dependent parameters.
2    Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef _LANGINFO_H
21 #define _LANGINFO_H 1
22
23 #include <locale.h>             /* Define the LC_* category names.  */
24
25 /* Get the type definition.  */
26 #include <nl_types.h>
27
28
29 __BEGIN_DECLS
30
31 /* Construct an `nl_item' value for `nl_langinfo' from a locale category
32    (LC_*) and an item index within the category.  Some code may depend on
33    the item values within a category increasing monotonically with the
34    indices.  */
35 #define _NL_ITEM(category, index)       (((category) << 16) | (index))
36
37 /* Extract the category and item index from a constructed `nl_item' value.  */
38 #define _NL_ITEM_CATEGORY(item)         ((int) (item) >> 16)
39 #define _NL_ITEM_INDEX(item)            ((int) (item) & 0xffff)
40
41
42 /* Enumeration of locale items that can be queried with `nl_langinfo'.  */
43 enum
44 {
45   /* LC_TIME category: date and time formatting.  */
46
47   /* Abbreviated days of the week. */
48   ABDAY_1 = _NL_ITEM (LC_TIME, 0), /* Sun */
49 #define ABDAY_1                 ABDAY_1
50   ABDAY_2,
51 #define ABDAY_2                 ABDAY_2
52   ABDAY_3,
53 #define ABDAY_3                 ABDAY_3
54   ABDAY_4,
55 #define ABDAY_4                 ABDAY_4
56   ABDAY_5,
57 #define ABDAY_5                 ABDAY_5
58   ABDAY_6,
59 #define ABDAY_6                 ABDAY_6
60   ABDAY_7,
61 #define ABDAY_7                 ABDAY_7
62
63   /* Long-named days of the week. */
64   DAY_1,                        /* Sunday */
65 #define DAY_1                   DAY_1
66   DAY_2,                        /* Monday */
67 #define DAY_2                   DAY_2
68   DAY_3,                        /* Tuesday */
69 #define DAY_3                   DAY_3
70   DAY_4,                        /* Wednesday */
71 #define DAY_4                   DAY_4
72   DAY_5,                        /* Thursday */
73 #define DAY_5                   DAY_5
74   DAY_6,                        /* Friday */
75 #define DAY_6                   DAY_6
76   DAY_7,                        /* Saturday */
77 #define DAY_7                   DAY_7
78
79   /* Abbreviated month names.  */
80   ABMON_1,                      /* Jan */
81 #define ABMON_1                 ABMON_1
82   ABMON_2,
83 #define ABMON_2                 ABMON_2
84   ABMON_3,
85 #define ABMON_3                 ABMON_3
86   ABMON_4,
87 #define ABMON_4                 ABMON_4
88   ABMON_5,
89 #define ABMON_5                 ABMON_5
90   ABMON_6,
91 #define ABMON_6                 ABMON_6
92   ABMON_7,
93 #define ABMON_7                 ABMON_7
94   ABMON_8,
95 #define ABMON_8                 ABMON_8
96   ABMON_9,
97 #define ABMON_9                 ABMON_9
98   ABMON_10,
99 #define ABMON_10                ABMON_10
100   ABMON_11,
101 #define ABMON_11                ABMON_11
102   ABMON_12,
103 #define ABMON_12                ABMON_12
104
105   /* Long month names.  */
106   MON_1,                        /* January */
107 #define MON_1                   MON_1
108   MON_2,
109 #define MON_2                   MON_2
110   MON_3,
111 #define MON_3                   MON_3
112   MON_4,
113 #define MON_4                   MON_4
114   MON_5,
115 #define MON_5                   MON_5
116   MON_6,
117 #define MON_6                   MON_6
118   MON_7,
119 #define MON_7                   MON_7
120   MON_8,
121 #define MON_8                   MON_8
122   MON_9,
123 #define MON_9                   MON_9
124   MON_10,
125 #define MON_10                  MON_10
126   MON_11,
127 #define MON_11                  MON_11
128   MON_12,
129 #define MON_12                  MON_12
130
131   AM_STR,                       /* Ante meridian string.  */
132 #define AM_STR                  AM_STR
133   PM_STR,                       /* Post meridian string.  */
134 #define PM_STR                  PM_STR
135
136   D_T_FMT,                      /* Date and time format for strftime.  */
137 #define D_T_FMT                 D_T_FMT
138   D_FMT,                        /* Date format for strftime.  */
139 #define D_FMT                   D_FMT
140   T_FMT,                        /* Time format for strftime.  */
141 #define T_FMT                   T_FMT
142   T_FMT_AMPM,                   /* 12-hour time format for strftime.  */
143 #define T_FMT_AMPM              T_FMT_AMPM
144
145   ERA,                          /* Alternate era.  */
146 #define ERA                     ERA
147   ERA_YEAR,                     /* Year in alternate era format.  */
148 #define ERA_YEAR                ERA_YEAR
149   ERA_D_FMT,                    /* Date in alternate era format.  */
150 #define ERA_D_FMT               ERA_D_FMT
151   ALT_DIGITS,                   /* Alternate symbols for digits.  */
152 #define ALT_DIGITS              ALT_DIGITS
153   ERA_D_T_FMT,                  /* Date and time in alternate era format.  */
154 #define ERA_D_T_FMT             ERA_D_T_FMT
155   ERA_T_FMT,                    /* Time in alternate era format.  */
156 #define ERA_T_FMT               ERA_T_FMT
157
158   _NL_TIME_ERA_NUM_ENTRIES,     /* Number entries in the era arrays.  */
159   _NL_TIME_ERA_ENTRIES,         /* Structure with era entries in usable form.*/
160
161   _NL_WABDAY_1,         /* Sun */
162   _NL_WABDAY_2,
163   _NL_WABDAY_3,
164   _NL_WABDAY_4,
165   _NL_WABDAY_5,
166   _NL_WABDAY_6,
167   _NL_WABDAY_7,
168
169   /* Long-named days of the week. */
170   _NL_WDAY_1,           /* Sunday */
171   _NL_WDAY_2,           /* Monday */
172   _NL_WDAY_3,           /* Tuesday */
173   _NL_WDAY_4,           /* Wednesday */
174   _NL_WDAY_5,           /* Thursday */
175   _NL_WDAY_6,           /* Friday */
176   _NL_WDAY_7,           /* Saturday */
177
178   /* Abbreviated month names.  */
179   _NL_WABMON_1,         /* Jan */
180   _NL_WABMON_2,
181   _NL_WABMON_3,
182   _NL_WABMON_4,
183   _NL_WABMON_5,
184   _NL_WABMON_6,
185   _NL_WABMON_7,
186   _NL_WABMON_8,
187   _NL_WABMON_9,
188   _NL_WABMON_10,
189   _NL_WABMON_11,
190   _NL_WABMON_12,
191
192   /* Long month names.  */
193   _NL_WMON_1,           /* January */
194   _NL_WMON_2,
195   _NL_WMON_3,
196   _NL_WMON_4,
197   _NL_WMON_5,
198   _NL_WMON_6,
199   _NL_WMON_7,
200   _NL_WMON_8,
201   _NL_WMON_9,
202   _NL_WMON_10,
203   _NL_WMON_11,
204   _NL_WMON_12,
205
206   _NL_WAM_STR,          /* Ante meridian string.  */
207   _NL_WPM_STR,          /* Post meridian string.  */
208
209   _NL_WD_T_FMT,         /* Date and time format for strftime.  */
210   _NL_WD_FMT,           /* Date format for strftime.  */
211   _NL_WT_FMT,           /* Time format for strftime.  */
212   _NL_WT_FMT_AMPM,      /* 12-hour time format for strftime.  */
213
214   _NL_WERA_YEAR,        /* Year in alternate era format.  */
215   _NL_WERA_D_FMT,       /* Date in alternate era format.  */
216   _NL_WALT_DIGITS,      /* Alternate symbols for digits.  */
217   _NL_WERA_D_T_FMT,     /* Date and time in alternate era format.  */
218   _NL_WERA_T_FMT,       /* Time in alternate era format.  */
219
220   _NL_TIME_WEEK_NDAYS,
221   _NL_TIME_WEEK_1STDAY,
222   _NL_TIME_WEEK_1STWEEK,
223   _NL_TIME_FIRST_WEEKDAY,
224   _NL_TIME_FIRST_WORKDAY,
225   _NL_TIME_CAL_DIRECTION,
226   _NL_TIME_TIMEZONE,
227
228   _NL_NUM_LC_TIME,              /* Number of indices in LC_TIME category.  */
229
230   /* LC_COLLATE category: text sorting.
231      This information is accessed by the strcoll and strxfrm functions.
232      These `nl_langinfo' names are used only internally.  */
233   _NL_COLLATE_NRULES = _NL_ITEM (LC_COLLATE, 0),
234   _NL_COLLATE_RULES,
235   _NL_COLLATE_HASH_SIZE,
236   _NL_COLLATE_HASH_LAYERS,
237   _NL_COLLATE_TABLEMB,
238   _NL_COLLATE_TABLEWC,
239   _NL_COLLATE_UNDEFINED_MB,
240   _NL_COLLATE_UNDEFINED_WC,
241   _NL_COLLATE_EXTRAMB,
242   _NL_COLLATE_EXTRAWC,
243   _NL_COLLATE_ELEM_HASH_SIZE,
244   _NL_COLLATE_ELEM_HASH,
245   _NL_COLLATE_ELEM_STR_POOL,
246   _NL_COLLATE_ELEM_VAL,
247   _NL_COLLATE_ELEM_VALMB,
248   _NL_COLLATE_ELEM_VALWC,
249   _NL_COLLATE_SYMB_HASH_SIZE,
250   _NL_COLLATE_SYMB_HASH,
251   _NL_COLLATE_SYMB_STR_POOL,
252   _NL_COLLATE_SYMB_CLASSMB,
253   _NL_COLLATE_SYMB_CLASSWC,
254   _NL_NUM_LC_COLLATE,
255
256   /* LC_CTYPE category: character classification.
257      This information is accessed by the functions in <ctype.h>.
258      These `nl_langinfo' names are used only internally.  */
259   _NL_CTYPE_CLASS = _NL_ITEM (LC_CTYPE, 0),
260   _NL_CTYPE_TOUPPER,
261   _NL_CTYPE_TOLOWER,
262   _NL_CTYPE_CLASS32,
263   _NL_CTYPE_NAMES,
264   _NL_CTYPE_HASH_SIZE,
265   _NL_CTYPE_HASH_LAYERS,
266   _NL_CTYPE_CLASS_NAMES,
267   _NL_CTYPE_MAP_NAMES,
268   _NL_CTYPE_WIDTH,
269   _NL_CTYPE_MB_CUR_MAX,
270   _NL_CTYPE_CODESET_NAME,
271 #ifdef __USE_XOPEN
272   CODESET = _NL_CTYPE_CODESET_NAME,
273 #endif
274   _NL_CTYPE_INDIGITS_MB_LEN,
275   _NL_CTYPE_INDIGITS0_MB,
276   _NL_CTYPE_INDIGITS1_MB,
277   _NL_CTYPE_INDIGITS2_MB,
278   _NL_CTYPE_INDIGITS3_MB,
279   _NL_CTYPE_INDIGITS4_MB,
280   _NL_CTYPE_INDIGITS5_MB,
281   _NL_CTYPE_INDIGITS6_MB,
282   _NL_CTYPE_INDIGITS7_MB,
283   _NL_CTYPE_INDIGITS8_MB,
284   _NL_CTYPE_INDIGITS9_MB,
285   _NL_CTYPE_INDIGITS_WC_LEN,
286   _NL_CTYPE_INDIGITS0_WC,
287   _NL_CTYPE_INDIGITS1_WC,
288   _NL_CTYPE_INDIGITS2_WC,
289   _NL_CTYPE_INDIGITS3_WC,
290   _NL_CTYPE_INDIGITS4_WC,
291   _NL_CTYPE_INDIGITS5_WC,
292   _NL_CTYPE_INDIGITS6_WC,
293   _NL_CTYPE_INDIGITS7_WC,
294   _NL_CTYPE_INDIGITS8_WC,
295   _NL_CTYPE_INDIGITS9_WC,
296   _NL_CTYPE_OUTDIGIT0_MB,
297   _NL_CTYPE_OUTDIGIT1_MB,
298   _NL_CTYPE_OUTDIGIT2_MB,
299   _NL_CTYPE_OUTDIGIT3_MB,
300   _NL_CTYPE_OUTDIGIT4_MB,
301   _NL_CTYPE_OUTDIGIT5_MB,
302   _NL_CTYPE_OUTDIGIT6_MB,
303   _NL_CTYPE_OUTDIGIT7_MB,
304   _NL_CTYPE_OUTDIGIT8_MB,
305   _NL_CTYPE_OUTDIGIT9_MB,
306   _NL_CTYPE_OUTDIGIT0_WC,
307   _NL_CTYPE_OUTDIGIT1_WC,
308   _NL_CTYPE_OUTDIGIT2_WC,
309   _NL_CTYPE_OUTDIGIT3_WC,
310   _NL_CTYPE_OUTDIGIT4_WC,
311   _NL_CTYPE_OUTDIGIT5_WC,
312   _NL_CTYPE_OUTDIGIT6_WC,
313   _NL_CTYPE_OUTDIGIT7_WC,
314   _NL_CTYPE_OUTDIGIT8_WC,
315   _NL_CTYPE_OUTDIGIT9_WC,
316   _NL_CTYPE_TRANSLIT_HASH_SIZE,
317   _NL_CTYPE_TRANSLIT_HASH_LAYERS,
318   _NL_CTYPE_TRANSLIT_FROM_IDX,
319   _NL_CTYPE_TRANSLIT_FROM_TBL,
320   _NL_CTYPE_TRANSLIT_TO_IDX,
321   _NL_CTYPE_TRANSLIT_TO_TBL,
322   _NL_NUM_LC_CTYPE,
323
324   /* LC_MONETARY category: formatting of monetary quantities.
325      These items each correspond to a member of `struct lconv',
326      defined in <locale.h>.  */
327   INT_CURR_SYMBOL = _NL_ITEM (LC_MONETARY, 0),
328 #define INT_CURR_SYMBOL         INT_CURR_SYMBOL
329   CURRENCY_SYMBOL,
330 #define CURRENCY_SYMBOL         CURRENCY_SYMBOL
331 #ifdef __USE_XOPEN
332   CRNCYSTR = CURRENCY_SYMBOL,
333 # define CRNCYSTR               CRNCYSTR
334 #endif
335   MON_DECIMAL_POINT,
336 #define MON_DECIMAL_POINT       MON_DECIMAL_POINT
337   MON_THOUSANDS_SEP,
338 #define MON_THOUSANDS_SEP       MON_THOUSANDS_SEP
339   MON_GROUPING,
340 #define MON_GROUPING            MON_GROUPING
341   POSITIVE_SIGN,
342 #define POSITIVE_SIGN           POSITIVE_SIGN
343   NEGATIVE_SIGN,
344 #define NEGATIVE_SIGN           NEGATIVE_SIGN
345   INT_FRAC_DIGITS,
346 #define INT_FRAC_DIGITS         INT_FRAC_DIGITS
347   FRAC_DIGITS,
348 #define FRAC_DIGITS             FRAC_DIGITS
349   P_CS_PRECEDES,
350 #define P_CS_PRECEDES           P_CS_PRECEDES
351   P_SEP_BY_SPACE,
352 #define P_SEP_BY_SPACE          P_SEP_BY_SPACE
353   N_CS_PRECEDES,
354 #define N_CS_PRECEDES           N_CS_PRECEDES
355   N_SEP_BY_SPACE,
356 #define N_SEP_BY_SPACE          N_SEP_BY_SPACE
357   P_SIGN_POSN,
358 #define P_SIGN_POSN             P_SIGN_POSN
359   N_SIGN_POSN,
360 #define N_SIGN_POSN             N_SIGN_POSN
361   _NL_MONETARY_INT_P_CS_PRECEDES,
362   _NL_MONETARY_INT_P_SEP_BY_SPACE,
363   _NL_MONETARY_INT_N_CS_PRECEDES,
364   _NL_MONETARY_INT_N_SEP_BY_SPACE,
365   _NL_MONETARY_INT_P_SIGN_POSN,
366   _NL_MONETARY_INT_N_SIGN_POSN,
367   _NL_MONETARY_DUO_INT_CURR_SYMBOL,
368   _NL_MONETARY_DUO_CURRENCY_SYMBOL,
369   _NL_MONETARY_DUO_INT_FRAC_DIGITS,
370   _NL_MONETARY_DUO_FRAC_DIGITS,
371   _NL_MONETARY_DUO_P_CS_PRECEDES,
372   _NL_MONETARY_DUO_P_SEP_BY_SPACE,
373   _NL_MONETARY_DUO_N_CS_PRECEDES,
374   _NL_MONETARY_DUO_N_SEP_BY_SPACE,
375   _NL_MONETARY_DUO_INT_P_CS_PRECEDES,
376   _NL_MONETARY_DUO_INT_P_SEP_BY_SPACE,
377   _NL_MONETARY_DUO_INT_N_CS_PRECEDES,
378   _NL_MONETARY_DUO_INT_N_SEP_BY_SPACE,
379   _NL_MONETARY_DUO_P_SIGN_POSN,
380   _NL_MONETARY_DUO_N_SIGN_POSN,
381   _NL_MONETARY_DUO_INT_P_SIGN_POSN,
382   _NL_MONETARY_DUO_INT_N_SIGN_POSN,
383   _NL_MONETARY_UNO_VALID_FROM,
384   _NL_MONETARY_UNO_VALID_TO,
385   _NL_MONETARY_DUO_VALID_FROM,
386   _NL_MONETARY_DUO_VALID_TO,
387   _NL_MONETARY_CONVERSION_RATE,
388   _NL_NUM_LC_MONETARY,
389
390   /* LC_NUMERIC category: formatting of numbers.
391      These also correspond to members of `struct lconv'; see <locale.h>.  */
392   DECIMAL_POINT = _NL_ITEM (LC_NUMERIC, 0),
393 #define DECIMAL_POINT           DECIMAL_POINT
394 #ifdef __USE_XOPEN
395   RADIXCHAR = DECIMAL_POINT,
396 # define RADIXCHAR              RADIXCHAR
397 #endif
398   THOUSANDS_SEP,
399 #define THOUSANDS_SEP           THOUSANDS_SEP
400 #ifdef __USE_XOPEN
401   THOUSEP = THOUSANDS_SEP,
402 # define THOUSANDS_SEP          THOUSANDS_SEP
403 #endif
404   GROUPING,
405 #define GROUPING                GROUPING
406   _NL_NUM_LC_NUMERIC,
407
408   YESEXPR = _NL_ITEM (LC_MESSAGES, 0), /* Regex matching ``yes'' input.  */
409 #define YESEXPR                 YESEXPR
410   NOEXPR,                       /* Regex matching ``no'' input.  */
411 #define NOEXPR                  NOEXPR
412   YESSTR,                       /* Output string for ``yes''.  */
413 #define YESSTR                  YESSTR
414   NOSTR,                        /* Output string for ``no''.  */
415 #define NOSTR                   NOSTR
416   _NL_NUM_LC_MESSAGES,
417
418   _NL_PAPER_HEIGHT = _NL_ITEM (LC_PAPER, 0),
419   _NL_PAPER_WIDTH,
420   _NL_NUM_LC_PAPER,
421
422   _NL_NAME_NAME_FMT = _NL_ITEM (LC_NAME, 0),
423   _NL_NAME_NAME_GEN,
424   _NL_NAME_NAME_MR,
425   _NL_NAME_NAME_MRS,
426   _NL_NAME_NAME_MISS,
427   _NL_NAME_NAME_MS,
428   _NL_NUM_LC_NAME,
429
430   _NL_ADDRESS_POSTAL_FMT = _NL_ITEM (LC_ADDRESS, 0),
431   _NL_ADDRESS_COUNTRY_NAME,
432   _NL_ADDRESS_COUNTRY_POST,
433   _NL_ADDRESS_COUNTRY_AB2,
434   _NL_ADDRESS_COUNTRY_AB3,
435   _NL_ADDRESS_COUNTRY_CAR,
436   _NL_ADDRESS_COUNTRY_NUM,
437   _NL_ADDRESS_COUNTRY_ISBN,
438   _NL_ADDRESS_LANG_NAME,
439   _NL_ADDRESS_LANG_AB,
440   _NL_ADDRESS_LANG_TERM,
441   _NL_ADDRESS_LANG_LIB,
442   _NL_NUM_LC_ADDRESS,
443
444   _NL_TELEPHONE_TEL_INT_FMT = _NL_ITEM (LC_TELEPHONE, 0),
445   _NL_TELEPHONE_TEL_DOM_FMT,
446   _NL_TELEPHONE_INT_SELECT,
447   _NL_TELEPHONE_INT_PREFIX,
448   _NL_NUM_LC_TELEPHONE,
449
450   _NL_MEASUREMENT_MEASUREMENT = _NL_ITEM (LC_MEASUREMENT, 0),
451   _NL_NUM_LC_MEASUREMENT,
452
453   _NL_IDENTIFICATION_TITLE = _NL_ITEM (LC_IDENTIFICATION, 0),
454   _NL_IDENTIFICATION_SOURCE,
455   _NL_IDENTIFICATION_ADDRESS,
456   _NL_IDENTIFICATION_CONTACT,
457   _NL_IDENTIFICATION_EMAIL,
458   _NL_IDENTIFICATION_TEL,
459   _NL_IDENTIFICATION_FAX,
460   _NL_IDENTIFICATION_LANGUAGE,
461   _NL_IDENTIFICATION_TERRITORY,
462   _NL_IDENTIFICATION_AUDIENCE,
463   _NL_IDENTIFICATION_APPLICATION,
464   _NL_IDENTIFICATION_ABBREVIATION,
465   _NL_IDENTIFICATION_REVISION,
466   _NL_IDENTIFICATION_DATE,
467   _NL_IDENTIFICATION_CATEGORY,
468   _NL_NUM_LC_IDENTIFICATION,
469
470   /* This marks the highest value used.  */
471   _NL_NUM
472 };
473
474
475 /* Return the current locale's value for ITEM.
476    If ITEM is invalid, an empty string is returned.
477
478    The string returned will not change until `setlocale' is called;
479    it is usually in read-only memory and cannot be modified.  */
480
481 extern char *nl_langinfo __P ((nl_item __item));
482
483
484 __END_DECLS
485
486 #endif  /* langinfo.h */