(_ISCTYPE): New macro.
[kopensolaris-gnu/glibc.git] / locale / localeinfo.h
1 /* Declarations for internal libc locale interfaces
2    Copyright (C) 1995, 96, 97, 98, 99, 2000 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 _LOCALEINFO_H
21 #define _LOCALEINFO_H 1
22
23 #include <stddef.h>
24 #include <langinfo.h>
25 #include <limits.h>
26 #include <time.h>
27 #include <stdint.h>
28 #include <sys/types.h>
29
30 /* This has to be changed whenever a new locale is defined.  */
31 #define __LC_LAST       13
32
33 #include <intl/loadinfo.h>      /* For loaded_l10nfile definition.  */
34
35 /* Magic number at the beginning of a locale data file for CATEGORY.  */
36 #define LIMAGIC(category)       (0x20000616 ^ (category))
37
38 /* Two special weight constants for the collation data.  */
39 #define IGNORE_CHAR     2
40
41 /* We use a special value for the usage counter in `locale_data' to
42    signal that this data must never be removed anymore.  */
43 #define MAX_USAGE_COUNT (UINT_MAX - 1)
44 #define UNDELETABLE     UINT_MAX
45
46 /* Structure describing locale data in core for a category.  */
47 struct locale_data
48 {
49   const char *name;
50   const char *filedata;         /* Region mapping the file data.  */
51   off_t filesize;               /* Size of the file (and the region).  */
52   int mmaped;                   /* If nonzero the data is mmaped.  */
53
54   unsigned int usage_count;     /* Counter for users.  */
55
56   int use_translit;             /* Nonzero if the mb*towv*() and wc*tomb()
57                                    functions should use transliteration.  */
58   const char *options;          /* Extra options from the locale name,
59                                    not used in the path to the locale data.  */
60
61   unsigned int nstrings;        /* Number of strings below.  */
62   union locale_data_value
63   {
64     const uint32_t *wstr;
65     const char *string;
66     unsigned int word;
67   }
68   values[0];    /* Items, usually pointers into `filedata'.  */
69 };
70
71 /* We know three kinds of collation sorting rules.  */
72 enum coll_sort_rule
73 {
74   illegal_0__,
75   sort_forward,
76   sort_backward,
77   illegal_3__,
78   sort_position,
79   sort_forward_position,
80   sort_backward_position,
81   sort_mask
82 };
83
84 /* We can map the types of the entries into a few categories.  */
85 enum value_type
86 {
87   none,
88   string,
89   stringarray,
90   byte,
91   bytearray,
92   word,
93   stringlist,
94   wordarray
95 };
96
97
98 /* Definitions for `era' information from LC_TIME.  */
99 #define ERA_NAME_FORMAT_MEMBERS 4
100 #define ERA_M_NAME   0
101 #define ERA_M_FORMAT 1
102 #define ERA_W_NAME   2
103 #define ERA_W_FORMAT 3
104
105
106 /* Structure to access `era' information from LC_TIME.  */
107 struct era_entry
108 {
109   uint32_t direction;           /* Contains '+' or '-'.  */
110   int32_t offset;
111   int32_t start_date[3];
112   int32_t stop_date[3];
113   const char *era_name;
114   const char *era_format;
115   const wchar_t *era_wname;
116   const wchar_t *era_wformat;
117   int absolute_direction;
118   /* absolute direction:
119      +1 indicates that year number is higher in the future. (like A.D.)
120      -1 indicates that year number is higher in the past. (like B.C.)  */
121 };
122
123
124 /* LC_CTYPE specific:
125    Hardwired indices for standard wide character translation mappings.  */
126 enum
127 {
128   __TOW_toupper = 0,
129   __TOW_tolower = 1
130 };
131
132
133 /* LC_CTYPE specific:
134    Access a wide character class with a single character index.
135    _ISCTYPE (c, desc) = iswctype (btowc (c), desc).
136    c must be an `unsigned char'.  desc must be a nonzero wctype_t.  */
137 #define _ISCTYPE(c, desc) \
138   (((((const uint32_t *) (desc)) - 8)[(c) >> 5] >> ((c) & 0x1f)) & 1)
139
140
141 /* For each category declare the variable for the current locale data.  */
142 #define DEFINE_CATEGORY(category, category_name, items, a) \
143 extern struct locale_data *_nl_current_##category;
144 #include "categories.def"
145 #undef  DEFINE_CATEGORY
146
147 extern const char *const _nl_category_names[__LC_LAST];
148 extern const size_t _nl_category_name_sizes[__LC_LAST];
149 extern struct locale_data * *const _nl_current[__LC_LAST];
150
151 /* Name of the standard locales.  */
152 extern const char _nl_C_name[];
153 extern const char _nl_POSIX_name[];
154
155 /* Extract the current CATEGORY locale's string for ITEM.  */
156 #define _NL_CURRENT(category, item) \
157   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].string)
158
159 /* Extract the current CATEGORY locale's string for ITEM.  */
160 #define _NL_CURRENT_WSTR(category, item) \
161   ((wchar_t *) (_nl_current_##category->values[_NL_ITEM_INDEX (item)].wstr))
162
163 /* Extract the current CATEGORY locale's word for ITEM.  */
164 #define _NL_CURRENT_WORD(category, item) \
165   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].word)
166
167 /* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY.  */
168 #define _NL_CURRENT_DEFINE(category) \
169   extern struct locale_data _nl_C_##category; \
170   struct locale_data *_nl_current_##category = &_nl_C_##category
171
172 /* Load the locale data for CATEGORY from the file specified by *NAME.
173    If *NAME is "", use environment variables as specified by POSIX,
174    and fill in *NAME with the actual name used.  The directories
175    listed in LOCALE_PATH are searched for the locale files.  */
176 extern struct locale_data *_nl_find_locale (const char *locale_path,
177                                             size_t locale_path_len,
178                                             int category, const char **name);
179
180 /* Try to load the file described by FILE.  */
181 extern void _nl_load_locale (struct loaded_l10nfile *file, int category);
182
183 /* Free all resource.  */
184 extern void _nl_unload_locale (struct locale_data *locale);
185
186 /* Free the locale and give back all memory if the usage count is one.  */
187 extern void _nl_remove_locale (int locale, struct locale_data *data);
188
189
190 /* Return `era' entry which corresponds to TP.  Used in strftime.  */
191 extern struct era_entry *_nl_get_era_entry (const struct tm *tp);
192
193 /* Return `era' cnt'th entry .  Used in strptime.  */
194 extern struct era_entry *_nl_select_era_entry (int cnt);
195
196 /* Return `alt_digit' which corresponds to NUMBER.  Used in strftime.  */
197 extern const char *_nl_get_alt_digit (unsigned int number);
198
199 /* Similar, but now for wide characters.  */
200 extern const wchar_t *_nl_get_walt_digit (unsigned int number);
201
202 #endif  /* localeinfo.h */