[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
.Nd natural language formatting for C
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In locale.h
.Ft struct lconv *
.Fn localeconv "void"
.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.
.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
.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
	39	.Nm localeconv
	40	.Nd natural language formatting for C
	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
	44	.In locale.h
	45	.Ft struct lconv *
	46	.Fn localeconv "void"
	47	.Sh DESCRIPTION
	48	The
	49	.Fn localeconv
	50	function returns a pointer to a structure
	51	which provides parameters for formatting numbers,
	52	especially currency values:
	53	.Bd -literal -offset indent
	54	struct lconv {
	55	char *decimal_point;
	56	char *thousands_sep;
	57	char *grouping;
	58	char *int_curr_symbol;
	59	char *currency_symbol;
	60	char *mon_decimal_point;
	61	char *mon_thousands_sep;
	62	char *mon_grouping;
	63	char *positive_sign;
	64	char *negative_sign;
	65	char int_frac_digits;
	66	char frac_digits;
	67	char p_cs_precedes;
	68	char p_sep_by_space;
	69	char n_cs_precedes;
	70	char n_sep_by_space;
	71	char p_sign_posn;
	72	char n_sign_posn;
	73	char int_p_cs_precedes;
	74	char int_n_cs_precedes;
	75	char int_p_sep_by_space;
	76	char int_n_sep_by_space;
	77	char int_p_sign_posn;
	78	char int_n_sign_posn;
	79	};
	80	.Ed
	81	.Pp
	82	The individual fields have the following meanings:
	83	.Pp
	84	.Bl -tag -width mon_decimal_point
	85	.It Va decimal_point
	86	The decimal point character, except for currency values,
	87	cannot be an empty string.
	88	.It Va thousands_sep
	89	The separator between groups of digits
	90	before the decimal point, except for currency values.
	91	.It Va grouping
	92	The sizes of the groups of digits, except for currency values.
	93	This is a pointer to a vector of integers, each of size
	94	.Vt char ,
	95	representing group size from low order digit groups
	96	to high order (right to left).
	97	The list may be terminated with 0 or
98	.Dv CHAR_MAX .
99	If the list is terminated with 0,
100	the last group size before the 0 is repeated to account for all the digits.
101	If the list is terminated with
102	.Dv CHAR_MAX ,
103	no more grouping is performed.
104	.It Va int_curr_symbol
105	The standardized international currency symbol.
106	.It Va currency_symbol
107	The local currency symbol.
108	.It Va mon_decimal_point
109	The decimal point character for currency values.
110	.It Va mon_thousands_sep
111	The separator for digit groups in currency values.
112	.It Va mon_grouping
113	Like
114	.Va grouping
115	but for currency values.
116	.It Va positive_sign
117	The character used to denote nonnegative currency values,
118	usually the empty string.
119	.It Va negative_sign
120	The character used to denote negative currency values,
121	usually a minus sign.
122	.It Va int_frac_digits
123	The number of digits after the decimal point
124	in an international-style currency value.
125	.It Va frac_digits
126	The number of digits after the decimal point
127	in the local style for currency values.
128	.It Va p_cs_precedes
129	1 if the currency symbol precedes the currency value
130	for nonnegative values, 0 if it follows.
131	.It Va p_sep_by_space
132	1 if a space is inserted between the currency symbol
133	and the currency value for nonnegative values, 0 otherwise.
134	.It Va n_cs_precedes
135	Like
136	.Va p_cs_precedes
137	but for negative values.
138	.It Va n_sep_by_space
139	Like
140	.Va p_sep_by_space
141	but for negative values.
142	.It Va p_sign_posn
143	The location of the
144	.Va positive_sign
145	with respect to a nonnegative quantity and the
146	.Va currency_symbol ,
147	coded as follows:
148	.Pp
149	.Bl -tag -width 3n -compact
150	.It Li 0
151	Parentheses around the entire string.
152	.It Li 1
153	Before the string.
154	.It Li 2
155	After the string.
156	.It Li 3
157	Just before
158	.Va currency_symbol .
159	.It Li 4
160	Just after
161	.Va currency_symbol .
162	.El
163	.It Va n_sign_posn
164	Like
165	.Va p_sign_posn
166	but for negative currency values.
167	.It Va int_p_cs_precedes
168	Same as
169	.Va p_cs_precedes ,
170	but for internationally formatted monetary quantities.
171	.It Va int_n_cs_precedes
172	Same as
173	.Va n_cs_precedes ,
174	but for internationally formatted monetary quantities.
175	.It Va int_p_sep_by_space
176	Same as
177	.Va p_sep_by_space ,
178	but for internationally formatted monetary quantities.
179	.It Va int_n_sep_by_space
180	Same as
181	.Va n_sep_by_space ,
182	but for internationally formatted monetary quantities.
183	.It Va int_p_sign_posn
184	Same as
185	.Va p_sign_posn ,
186	but for internationally formatted monetary quantities.
187	.It Va int_n_sign_posn
188	Same as
189	.Va n_sign_posn ,
190	but for internationally formatted monetary quantities.
191	.El
192	.Pp
193	Unless mentioned above,
194	an empty string as a value for a field
195	indicates a zero length result or
196	a value that is not in the current locale.
197	A
198	.Dv CHAR_MAX
199	result similarly denotes an unavailable value.
200	.Sh RETURN VALUES
201	The
202	.Fn localeconv
203	function returns a pointer to a static object
204	which may be altered by later calls to
205	.Xr setlocale 3
206	or
207	.Fn localeconv .
208	.Sh ERRORS
209	No errors are defined.
210	.Sh SEE ALSO
211	.Xr setlocale 3 ,
212	.Xr strfmon 3
213	.Sh STANDARDS
214	The
215	.Fn localeconv
216	function conforms to
217	.St -isoC-99 .
218	.Sh HISTORY
219	The
220	.Fn localeconv
221	function first appeared in
222	.Bx 4.4 .