[apple/libc.git] / locale / FreeBSD / localeconv.3

.\" Copyright (c) 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Donn Seeley at BSDI.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" From @(#)setlocale.3	8.1 (Berkeley) 6/9/93
.\" From FreeBSD: src/lib/libc/locale/setlocale.3,v 1.28 2003/11/15 02:26:04 tjr Exp
.\" $FreeBSD: src/lib/libc/locale/localeconv.3,v 1.3 2007/01/09 00:28:00 imp Exp $
.\"
.Dd November 21, 2003
.Dt LOCALECONV 3
.Os
.Sh NAME
.Nm localeconv ,
.Nm localeconv_l
.Nd natural language formatting for C
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In locale.h
.Ft struct lconv *
.Fo localeconv
.Fa "void"
.Fc
.In xlocale.h
.Ft struct lconv *
.Fo localeconv_l
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn localeconv
function returns a pointer to a structure
which provides parameters for formatting numbers,
especially currency values:
.Bd -literal -offset indent
struct lconv {
	char	*decimal_point;
	char	*thousands_sep;
	char	*grouping;
	char	*int_curr_symbol;
	char	*currency_symbol;
	char	*mon_decimal_point;
	char	*mon_thousands_sep;
	char	*mon_grouping;
	char	*positive_sign;
	char	*negative_sign;
	char	int_frac_digits;
	char	frac_digits;
	char	p_cs_precedes;
	char	p_sep_by_space;
	char	n_cs_precedes;
	char	n_sep_by_space;
	char	p_sign_posn;
	char	n_sign_posn;
	char	int_p_cs_precedes;
	char	int_n_cs_precedes;
	char	int_p_sep_by_space;
	char	int_n_sep_by_space;
	char	int_p_sign_posn;
	char	int_n_sign_posn;
};
.Ed
.Pp
The individual fields have the following meanings:
.Pp
.Bl -tag -width mon_decimal_point
.It Va decimal_point
The decimal point character, except for currency values,
cannot be an empty string.
.It Va thousands_sep
The separator between groups of digits
before the decimal point, except for currency values.
.It Va grouping
The sizes of the groups of digits, except for currency values.
This is a pointer to a vector of integers, each of size
.Vt char ,
representing group size from low order digit groups
to high order (right to left).
The list may be terminated with 0 or
.Dv CHAR_MAX .
If the list is terminated with 0,
the last group size before the 0 is repeated to account for all the digits.
If the list is terminated with
.Dv CHAR_MAX ,
no more grouping is performed.
.It Va int_curr_symbol
The standardized international currency symbol.
.It Va currency_symbol
The local currency symbol.
.It Va mon_decimal_point
The decimal point character for currency values.
.It Va mon_thousands_sep
The separator for digit groups in currency values.
.It Va mon_grouping
Like
.Va grouping
but for currency values.
.It Va positive_sign
The character used to denote nonnegative currency values,
usually the empty string.
.It Va negative_sign
The character used to denote negative currency values,
usually a minus sign.
.It Va int_frac_digits
The number of digits after the decimal point
in an international-style currency value.
.It Va frac_digits
The number of digits after the decimal point
in the local style for currency values.
.It Va p_cs_precedes
1 if the currency symbol precedes the currency value
for nonnegative values, 0 if it follows.
.It Va p_sep_by_space
1 if a space is inserted between the currency symbol
and the currency value for nonnegative values, 0 otherwise.
.It Va n_cs_precedes
Like
.Va p_cs_precedes
but for negative values.
.It Va n_sep_by_space
Like
.Va p_sep_by_space
but for negative values.
.It Va p_sign_posn
The location of the
.Va positive_sign
with respect to a nonnegative quantity and the
.Va currency_symbol ,
coded as follows:
.Pp
.Bl -tag -width 3n -compact
.It Li 0
Parentheses around the entire string.
.It Li 1
Before the string.
.It Li 2
After the string.
.It Li 3
Just before
.Va currency_symbol .
.It Li 4
Just after
.Va currency_symbol .
.El
.It Va n_sign_posn
Like
.Va p_sign_posn
but for negative currency values.
.It Va int_p_cs_precedes
Same as
.Va p_cs_precedes ,
but for internationally formatted monetary quantities.
.It Va int_n_cs_precedes
Same as
.Va n_cs_precedes ,
but for internationally formatted monetary quantities.
.It Va int_p_sep_by_space
Same as
.Va p_sep_by_space ,
but for internationally formatted monetary quantities.
.It Va int_n_sep_by_space
Same as
.Va n_sep_by_space ,
but for internationally formatted monetary quantities.
.It Va int_p_sign_posn
Same as
.Va p_sign_posn ,
but for internationally formatted monetary quantities.
.It Va int_n_sign_posn
Same as
.Va n_sign_posn ,
but for internationally formatted monetary quantities.
.El
.Pp
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
.Dv CHAR_MAX
result similarly denotes an unavailable value.
.Pp
While the
.Fn localeconv
function uses the current locale, the
.Fn localeconv_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.Sh RETURN VALUES
The
.Fn localeconv
function returns a pointer to a static object
which may be altered by later calls to
.Xr setlocale 3
or
.Fn localeconv .
.Sh ERRORS
No errors are defined.
.Sh SEE ALSO
.Xr setlocale 3 ,
.Xr strfmon 3 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn localeconv
function conforms to
.St -isoC-99 .
.Sh HISTORY
The
.Fn localeconv
function first appeared in
.Bx 4.4 .
Commit	Line	Data
3d9156a7 A	1	.\" Copyright (c) 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Donn Seeley at BSDI.
	6	.\"
	7	.\" Redistribution and use in source and binary forms, with or without
	8	.\" modification, are permitted provided that the following conditions
	9	.\" are met:
	10	.\" 1. Redistributions of source code must retain the above copyright
	11	.\" notice, this list of conditions and the following disclaimer.
	12	.\" 2. Redistributions in binary form must reproduce the above copyright
	13	.\" notice, this list of conditions and the following disclaimer in the
	14	.\" documentation and/or other materials provided with the distribution.
3d9156a7 A	15	.\" 4. Neither the name of the University nor the names of its contributors
	16	.\" may be used to endorse or promote products derived from this software
	17	.\" without specific prior written permission.
	18	.\"
	19	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	20	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	21	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	22	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	23	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	24	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	25	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	26	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	27	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	28	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	29	.\" SUCH DAMAGE.
	30	.\"
	31	.\" From @(#)setlocale.3 8.1 (Berkeley) 6/9/93
	32	.\" From FreeBSD: src/lib/libc/locale/setlocale.3,v 1.28 2003/11/15 02:26:04 tjr Exp
1f2f436a	33	.\" $FreeBSD: src/lib/libc/locale/localeconv.3,v 1.3 2007/01/09 00:28:00 imp Exp $
3d9156a7 A	34	.\"
	35	.Dd November 21, 2003
	36	.Dt LOCALECONV 3
	37	.Os
	38	.Sh NAME
ad3c9f2a A	39	.Nm localeconv ,
ad3c9f2a A	40	.Nm localeconv_l
3d9156a7 A	41	.Nd natural language formatting for C
	42	.Sh LIBRARY
	43	.Lb libc
	44	.Sh SYNOPSIS
	45	.In locale.h
	46	.Ft struct lconv *
ad3c9f2a A	47	.Fo localeconv
	48	.Fa "void"
	49	.Fc
	50	.In xlocale.h
	51	.Ft struct lconv *
	52	.Fo localeconv_l
	53	.Fa "locale_t loc"
	54	.Fc
3d9156a7 A	55	.Sh DESCRIPTION
	56	The
	57	.Fn localeconv
	58	function returns a pointer to a structure
	59	which provides parameters for formatting numbers,
	60	especially currency values:
	61	.Bd -literal -offset indent
	62	struct lconv {
	63	char *decimal_point;
	64	char *thousands_sep;
	65	char *grouping;
	66	char *int_curr_symbol;
	67	char *currency_symbol;
	68	char *mon_decimal_point;
	69	char *mon_thousands_sep;
	70	char *mon_grouping;
	71	char *positive_sign;
	72	char *negative_sign;
	73	char int_frac_digits;
	74	char frac_digits;
	75	char p_cs_precedes;
	76	char p_sep_by_space;
	77	char n_cs_precedes;
	78	char n_sep_by_space;
	79	char p_sign_posn;
	80	char n_sign_posn;
	81	char int_p_cs_precedes;
	82	char int_n_cs_precedes;
	83	char int_p_sep_by_space;
	84	char int_n_sep_by_space;
	85	char int_p_sign_posn;
	86	char int_n_sign_posn;
	87	};
	88	.Ed
	89	.Pp
	90	The individual fields have the following meanings:
	91	.Pp
	92	.Bl -tag -width mon_decimal_point
	93	.It Va decimal_point
	94	The decimal point character, except for currency values,
	95	cannot be an empty string.
	96	.It Va thousands_sep
	97	The separator between groups of digits
	98	before the decimal point, except for currency values.
	99	.It Va grouping
	100	The sizes of the groups of digits, except for currency values.
	101	This is a pointer to a vector of integers, each of size
	102	.Vt char ,
	103	representing group size from low order digit groups
	104	to high order (right to left).
	105	The list may be terminated with 0 or
	106	.Dv CHAR_MAX .
	107	If the list is terminated with 0,
	108	the last group size before the 0 is repeated to account for all the digits.
	109	If the list is terminated with
	110	.Dv CHAR_MAX ,
	111	no more grouping is performed.
	112	.It Va int_curr_symbol
	113	The standardized international currency symbol.
	114	.It Va currency_symbol
	115	The local currency symbol.
	116	.It Va mon_decimal_point
	117	The decimal point character for currency values.
	118	.It Va mon_thousands_sep
119	The separator for digit groups in currency values.
120	.It Va mon_grouping
121	Like
122	.Va grouping
123	but for currency values.
124	.It Va positive_sign
125	The character used to denote nonnegative currency values,
126	usually the empty string.
127	.It Va negative_sign
128	The character used to denote negative currency values,
129	usually a minus sign.
130	.It Va int_frac_digits
131	The number of digits after the decimal point
132	in an international-style currency value.
133	.It Va frac_digits
134	The number of digits after the decimal point
135	in the local style for currency values.
136	.It Va p_cs_precedes
137	1 if the currency symbol precedes the currency value
138	for nonnegative values, 0 if it follows.
139	.It Va p_sep_by_space
140	1 if a space is inserted between the currency symbol
141	and the currency value for nonnegative values, 0 otherwise.
142	.It Va n_cs_precedes
143	Like
144	.Va p_cs_precedes
145	but for negative values.
146	.It Va n_sep_by_space
147	Like
148	.Va p_sep_by_space
149	but for negative values.
150	.It Va p_sign_posn
151	The location of the
152	.Va positive_sign
153	with respect to a nonnegative quantity and the
154	.Va currency_symbol ,
155	coded as follows:
156	.Pp
157	.Bl -tag -width 3n -compact
158	.It Li 0
159	Parentheses around the entire string.
160	.It Li 1
161	Before the string.
162	.It Li 2
163	After the string.
164	.It Li 3
165	Just before
166	.Va currency_symbol .
167	.It Li 4
168	Just after
169	.Va currency_symbol .
170	.El
171	.It Va n_sign_posn
172	Like
173	.Va p_sign_posn
174	but for negative currency values.
175	.It Va int_p_cs_precedes
176	Same as
177	.Va p_cs_precedes ,
178	but for internationally formatted monetary quantities.
179	.It Va int_n_cs_precedes
180	Same as
181	.Va n_cs_precedes ,
182	but for internationally formatted monetary quantities.
183	.It Va int_p_sep_by_space
184	Same as
185	.Va p_sep_by_space ,
186	but for internationally formatted monetary quantities.
187	.It Va int_n_sep_by_space
188	Same as
189	.Va n_sep_by_space ,
190	but for internationally formatted monetary quantities.
191	.It Va int_p_sign_posn
192	Same as
193	.Va p_sign_posn ,
194	but for internationally formatted monetary quantities.
195	.It Va int_n_sign_posn
196	Same as
197	.Va n_sign_posn ,
198	but for internationally formatted monetary quantities.
199	.El
200	.Pp
201	Unless mentioned above,
202	an empty string as a value for a field
203	indicates a zero length result or
204	a value that is not in the current locale.
205	A
206	.Dv CHAR_MAX
207	result similarly denotes an unavailable value.
ad3c9f2a A	208	.Pp
	209	While the
	210	.Fn localeconv
	211	function uses the current locale, the
	212	.Fn localeconv_l
	213	function may be passed a locale directly. See
	214	.Xr xlocale 3
	215	for more information.
3d9156a7 A	216	.Sh RETURN VALUES
	217	The
	218	.Fn localeconv
	219	function returns a pointer to a static object
	220	which may be altered by later calls to
	221	.Xr setlocale 3
	222	or
	223	.Fn localeconv .
	224	.Sh ERRORS
	225	No errors are defined.
	226	.Sh SEE ALSO
	227	.Xr setlocale 3 ,
ad3c9f2a A	228	.Xr strfmon 3 ,
ad3c9f2a A	229	.Xr xlocale 3
3d9156a7 A	230	.Sh STANDARDS
	231	The
	232	.Fn localeconv
	233	function conforms to
	234	.St -isoC-99 .
	235	.Sh HISTORY
	236	The
	237	.Fn localeconv
	238	function first appeared in
	239	.Bx 4.4 .