|
1 /** @file ../include/locale.h |
|
2 @internalComponent |
|
3 */ |
|
4 |
|
5 /** @fn localeconv(void) |
|
6 |
|
7 @return The localeconv function returns a pointer to a static object |
|
8 which may be altered by later calls to setlocale or localeconv. |
|
9 |
|
10 The localeconv function returns a pointer to a structure which provides parameters for formatting numbers, especially currency values: |
|
11 @code |
|
12 struct lconv { |
|
13 char *decimal_point; |
|
14 char *thousands_sep; |
|
15 char *grouping; |
|
16 char *int_curr_symbol; |
|
17 char *currency_symbol; |
|
18 char *mon_decimal_point; |
|
19 char *mon_thousands_sep; |
|
20 char *mon_grouping; |
|
21 char *positive_sign; |
|
22 char *negative_sign; |
|
23 char int_frac_digits; |
|
24 char frac_digits; |
|
25 char p_cs_precedes; |
|
26 char p_sep_by_space; |
|
27 char n_cs_precedes; |
|
28 char n_sep_by_space; |
|
29 char p_sign_posn; |
|
30 char n_sign_posn; |
|
31 char int_p_cs_precedes; |
|
32 char int_n_cs_precedes; |
|
33 char int_p_sep_by_space; |
|
34 char int_n_sep_by_space; |
|
35 char int_p_sign_posn; |
|
36 char int_n_sign_posn; |
|
37 }; |
|
38 |
|
39 @endcode |
|
40 |
|
41 |
|
42 The individual fields have the following meanings: |
|
43 @code |
|
44 decimal_point The decimal point character, except for currency values, cannot be an empty string. |
|
45 thousands_sep The separator between groups of digits before the decimal point, except for currency values. |
|
46 grouping The sizes of the groups of digits, except for currency values. |
|
47 int_curr_symbol The standardized international currency symbol. |
|
48 currency_symbol The local currency symbol. |
|
49 mon_decimal_point The decimal point character for currency values. |
|
50 mon_thousands_sep The separator for digit groups in currency values. |
|
51 mon_grouping Like grouping but for currency values. |
|
52 positive_sign The character used to denote nonnegative currency values, usually the empty string. |
|
53 negative_sign The character used to denote negative currency values, usually a minus sign. |
|
54 int_frac_digits The number of digits after the decimal point in an international-style currency value. |
|
55 frac_digits The number of digits after the decimal point in the local style for currency values. |
|
56 p_cs_precedes 1 if the currency symbol precedes the currency value for nonnegative values, 0 if it follows. |
|
57 p_sep_by_space 1 if a space is inserted between the currency symbol and the currency value for nonnegative values, 0 otherwise. |
|
58 n_cs_precedes Like p_cs_precedes but for negative values. |
|
59 n_sep_by_space Like p_sep_by_space but for negative values. |
|
60 p_sign_posn The location of the positive_sign with respect to a nonnegative quantity and the currency_symbol, coded as follows: |
|
61 @endcode |
|
62 |
|
63 @code |
|
64 0 Parentheses around the entire string. |
|
65 1 Before the string. |
|
66 2 After the string. |
|
67 3 Just before currency_symbol. |
|
68 4 Just after currency_symbol. |
|
69 @endcode |
|
70 |
|
71 @code |
|
72 n_sign_posn |
|
73 Like p_sign_posn but for negative currency values. |
|
74 int_p_cs_precedes |
|
75 Same as p_cs_precedes, but for internationally formatted monetary quantities. |
|
76 int_n_cs_precedes |
|
77 Same as n_cs_precedes, but for internationally formatted monetary quantities. |
|
78 int_p_sep_by_space |
|
79 Same as p_sep_by_space, but for internationally formatted monetary quantities. |
|
80 int_n_sep_by_space |
|
81 Same as n_sep_by_space, but for internationally formatted monetary quantities. |
|
82 int_p_sign_posn |
|
83 Same as p_sign_posn, but for internationally formatted monetary quantities. |
|
84 int_n_sign_posn |
|
85 Same as n_sign_posn, but for internationally formatted monetary quantities. |
|
86 @endcode |
|
87 |
|
88 |
|
89 Unless mentioned above, an empty string as a value for a field indicates a zero length result or a value that is not in the current locale. A CHAR_MAX result similarly denotes an unavailable value. |
|
90 |
|
91 Note: By default smartphone's monetary settings will be returned from the localeconv instead of "C" structure |
|
92 |
|
93 Examples: |
|
94 @code |
|
95 #include<stdio.h> |
|
96 #include<locale.h> |
|
97 int main() |
|
98 { |
|
99 //Set the locale to German |
|
100 char* locale = setlocale(LC_ALL,"de_DE.ISO-8859-1"); |
|
101 struct lconv* str = NULL; |
|
102 //Check whether locale setting is succesful or not |
|
103 if(NULL != locale) |
|
104 { |
|
105 printf("Locale setting is successful |
|
106 "); |
|
107 printf("Locale is set to %s |
|
108 ", locale); |
|
109 //Get numeric formatting information |
|
110 str = localeconv(); |
|
111 printf("Decimal separator is %s |
|
112 ", str->mon_decimal_point); |
|
113 printf("Thousand separator is %s |
|
114 ", str->mon_thousands_sep); |
|
115 } |
|
116 else |
|
117 { |
|
118 printf("Locale setting failed |
|
119 "); |
|
120 } |
|
121 return 0; |
|
122 } |
|
123 |
|
124 @endcode |
|
125 Output |
|
126 @code |
|
127 Locale setting is successful |
|
128 Locale is set to de_DE.ISO-8859-1 |
|
129 Decimal separator is, |
|
130 Thousand separator is. |
|
131 |
|
132 @endcode |
|
133 @see setlocale() |
|
134 @see strfmon() |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 @publishedAll |
|
141 @externallyDefinedApi |
|
142 */ |
|
143 |
|
144 /** @fn setlocale(int category, const char *locale) |
|
145 @param category |
|
146 @param locale |
|
147 @return Upon successful completion, setlocale returns the string associated with the specified category for the requested locale. The setlocale function returns NULL and fails to change the locale |
|
148 if the given combination of category and locale makes no sense. |
|
149 |
|
150 The setlocale function sets the C library’s notion of natural language formatting style for particular sets of routines. Each such style is called a 'locale' and is invoked using an appropriate name passed as a C string. |
|
151 The setlocale function recognizes several categories of routines. These are the categories and the sets of routines they select: |
|
152 |
|
153 @code |
|
154 LC_ALL Set the entire locale generically. |
|
155 LC_COLLATE Set a locale for string collation routines. Currently locale setting does not have effect on this category. |
|
156 LC_CTYPE This controls recognition of upper and lower case, alphabetic or non-alphabetic characters, and so on. Currently locale setting does not have effect on this category. |
|
157 LC_MESSAGES |
|
158 Set a locale for message catalogs. Currently this category is not supported. |
|
159 LC_MONETARY |
|
160 Set a locale for formatting monetary values; this affects the localeconv function. |
|
161 LC_NUMERIC Set a locale for formatting numbers. This controls the formatting of decimal points in input and output of floating point numbers in functions such as printf and scanf, as well as values returned by localeconv. |
|
162 LC_TIME Set a locale for formatting dates and times using the strftime function. |
|
163 @endcode |
|
164 |
|
165 |
|
166 Only three locales are defined by default, the empty string which denotes the native environment, and the C and POSIX locales, which denote the C language environment. A locale argument of NULL causes setlocale to return the current locale. By default, C programs start in the C locale. The only function in the library that sets the locale is setlocale; the locale is never changed as a side effect of some other routine. |
|
167 |
|
168 |
|
169 Examples: |
|
170 @code |
|
171 #include<stdio.h> |
|
172 #include<locale.h> |
|
173 int main() |
|
174 { |
|
175 //Set the locale to UK English |
|
176 char* locale = setlocale(LC_ALL,"en_GB.ISO-8859-1"); |
|
177 //Check whether locale setting is succesful or not |
|
178 if(NULL != locale) |
|
179 { |
|
180 printf("Locale setting is successful |
|
181 "); |
|
182 printf("Locale is set to %s |
|
183 ", locale); |
|
184 } |
|
185 else |
|
186 { |
|
187 printf("Locale setting failed |
|
188 "); |
|
189 } |
|
190 return 0; |
|
191 } |
|
192 |
|
193 @endcode |
|
194 Output |
|
195 @code |
|
196 Locale setting is successful |
|
197 Locale is set to en_GB.ISO-8859-1 |
|
198 |
|
199 @endcode |
|
200 @see localeconv() |
|
201 @see nl_langinfo() |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 @publishedAll |
|
207 @externallyDefinedApi |
|
208 */ |
|
209 |
|
210 |
|
211 /** @struct lconv |
|
212 |
|
213 Includes the following members, |
|
214 |
|
215 @publishedAll |
|
216 @externallyDefinedApi |
|
217 */ |
|
218 |
|
219 /** @var lconv::decimal_point |
|
220 |
|
221 The operand is a string containing the symbol that shall be used as the decimal delimiter (radix character) in numeric, non-monetary formatted quantities. This keyword cannot be omitted and cannot be set to the empty string. In contexts where standards limit the decimal_point to a single byte, the result of specifying a multi-byte operand shall be unspecified. |
|
222 |
|
223 */ |
|
224 |
|
225 /** @var lconv::thousands_sep |
|
226 |
|
227 The operand is a string containing the symbol that shall be used as a separator for groups of digits to the left of the decimal delimiter in numeric, non-monetary formatted monetary quantities. In contexts where standards limit the thousands_sep to a single byte, the result of specifying a multi-byte operand shall be unspecified. |
|
228 |
|
229 */ |
|
230 |
|
231 /** @var lconv::grouping |
|
232 |
|
233 Define the size of each group of digits in formatted non-monetary quantities. The operand is a sequence of integers separated by semicolons. Each integer specifies the number of digits in each group, with the initial integer defining the size of the group immediately preceding the decimal delimiter, and the following integers defining the preceding groups. If the last integer is not -1, then the size of the previous group (if any) shall be repeatedly used for the remainder of the digits. If the last integer is -1, then no further grouping shall be performed. |
|
234 |
|
235 */ |
|
236 |
|
237 /** @var lconv::int_curr_symbol |
|
238 |
|
239 The international currency symbol. The operand shall be a four-character string, with the first three characters containing the alphabetic international currency symbol. The international currency symbol should be chosen in accordance with those specified in the ISO 4217 standard. The fourth character shall be the character used to separate the international currency symbol from the monetary quantity. |
|
240 |
|
241 */ |
|
242 |
|
243 /** @var lconv::currency_symbol |
|
244 |
|
245 The string that shall be used as the local currency symbol. |
|
246 |
|
247 */ |
|
248 |
|
249 /** @var lconv::mon_decimal_point |
|
250 |
|
251 The operand is a string containing the symbol that shall be used as the decimal delimiter (radix character) in monetary formatted quantities. |
|
252 |
|
253 */ |
|
254 |
|
255 /** @var lconv::mon_thousands_sep |
|
256 |
|
257 The operand is a string containing the symbol that shall be used as a separator for groups of digits to the left of the decimal delimiter in formatted monetary quantities. |
|
258 |
|
259 */ |
|
260 |
|
261 /** @var lconv::mon_grouping |
|
262 |
|
263 Define the size of each group of digits in formatted monetary quantities. The operand is a sequence of integers separated by semicolons. Each integer specifies the number of digits in each group, with the initial integer defining the size of the group immediately preceding the decimal delimiter, and the following integers defining the preceding groups. If the last integer is not -1, then the size of the previous group (if any) shall be repeatedly used for the remainder of the digits. If the last integer is -1, then no further grouping shall be performed. |
|
264 |
|
265 */ |
|
266 |
|
267 /** @var lconv::positive_sign |
|
268 |
|
269 A string that shall be used to indicate a non-negative-valued formatted monetary quantity. |
|
270 |
|
271 */ |
|
272 |
|
273 /** @var lconv::negative_sign |
|
274 |
|
275 A string that shall be used to indicate a negative-valued formatted monetary quantity. |
|
276 |
|
277 */ |
|
278 |
|
279 /** @var lconv::int_frac_digits |
|
280 |
|
281 An integer representing the number of fractional digits (those to the right of the decimal delimiter) to be written in a formatted monetary quantity using int_curr_symbol. |
|
282 |
|
283 */ |
|
284 |
|
285 /** @var lconv::frac_digits |
|
286 |
|
287 An integer representing the number of fractional digits (those to the right of the decimal delimiter) to be written in a formatted monetary quantity using currency_symbol. |
|
288 |
|
289 */ |
|
290 |
|
291 /** @var lconv::p_cs_precedes |
|
292 |
|
293 An integer set to 1 if the currency_symbol precedes the value for a monetary quantity with a non-negative value, and set to 0 if the symbol succeeds the value. |
|
294 |
|
295 */ |
|
296 |
|
297 /** @var lconv::p_sep_by_space |
|
298 |
|
299 Set to a value indicating the separation of the currency_symbol, the sign string, and the value for a non-negative formatted monetary quantity. |
|
300 |
|
301 */ |
|
302 |
|
303 /** @var lconv::n_cs_precedes |
|
304 |
|
305 An integer set to 1 if the currency_symbol precedes the value for a monetary quantity with a negative value, and set to 0 if the symbol succeeds the value. |
|
306 |
|
307 */ |
|
308 |
|
309 /** @var lconv::n_sep_by_space |
|
310 |
|
311 Set to a value indicating the separation of the currency_symbol, the sign string, and the value for a negative formatted monetary quantity. |
|
312 |
|
313 */ |
|
314 |
|
315 /** @var lconv::p_sign_posn |
|
316 |
|
317 An integer set to a value indicating the positioning of the positive_sign for a monetary quantity with a non-negative value. |
|
318 |
|
319 */ |
|
320 |
|
321 /** @var lconv::n_sign_posn |
|
322 |
|
323 An integer set to a value indicating the positioning of the negative_sign for a negative formatted monetary quantity. |
|
324 |
|
325 */ |
|
326 |
|
327 /** @var lconv::int_p_cs_precedes |
|
328 |
|
329 An integer set to 1 if the int_curr_symbol precedes the value for a monetary quantity with a non-negative value, and set to 0 if the symbol succeeds the value. |
|
330 |
|
331 */ |
|
332 |
|
333 /** @var lconv::int_n_cs_precedes |
|
334 |
|
335 An integer set to 1 if the int_curr_symbol precedes the value for a monetary quantity with a negative value, and set to 0 if the symbol succeeds the value. |
|
336 |
|
337 */ |
|
338 |
|
339 /** @var lconv::int_p_sep_by_space |
|
340 |
|
341 Set to a value indicating the separation of the int_curr_symbol, the sign string, and the value for a non-negative internationally formatted monetary quantity. |
|
342 |
|
343 */ |
|
344 |
|
345 /** @var lconv::int_n_sep_by_space |
|
346 |
|
347 Set to a value indicating the separation of the int_curr_symbol, the sign string, and the value for a negative internationally formatted monetary quantity. |
|
348 |
|
349 */ |
|
350 |
|
351 /** @var lconv::int_p_sign_posn |
|
352 |
|
353 An integer set to a value indicating the positioning of the positive_sign for a positive monetary quantity formatted with the international format. |
|
354 |
|
355 */ |
|
356 |
|
357 /** @var lconv::int_n_sign_posn |
|
358 |
|
359 An integer set to a value indicating the positioning of the negative_sign for a negative monetary quantity formatted with the international format. |
|
360 |
|
361 */ |
|
362 |
|
363 /** @def LC_ALL |
|
364 |
|
365 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
366 |
|
367 @publishedAll |
|
368 @externallyDefinedApi |
|
369 */ |
|
370 |
|
371 /** @def LC_COLLATE |
|
372 |
|
373 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
374 |
|
375 @publishedAll |
|
376 @externallyDefinedApi |
|
377 */ |
|
378 |
|
379 /** @def LC_CTYPE |
|
380 |
|
381 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
382 |
|
383 @publishedAll |
|
384 @externallyDefinedApi |
|
385 */ |
|
386 |
|
387 /** @def LC_MONETARY |
|
388 |
|
389 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
390 |
|
391 @publishedAll |
|
392 @externallyDefinedApi |
|
393 */ |
|
394 |
|
395 /** @def LC_NUMERIC |
|
396 |
|
397 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
398 |
|
399 @publishedAll |
|
400 @externallyDefinedApi |
|
401 */ |
|
402 |
|
403 /** @def LC_TIME |
|
404 |
|
405 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
406 |
|
407 @publishedAll |
|
408 @externallyDefinedApi |
|
409 */ |
|
410 |
|
411 /** @def LC_MESSAGES |
|
412 |
|
413 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
414 |
|
415 @publishedAll |
|
416 @externallyDefinedApi |
|
417 */ |
|
418 |
|
419 /** @def _LC_LAST |
|
420 |
|
421 It shall expand to distinct integer constant expressions, for use as the first argument to the setlocale() function. |
|
422 |
|
423 @publishedAll |
|
424 @released |
|
425 */ |