locale/FreeBSD/localeconv.3

   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.
  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
  33 .\" $FreeBSD: src/lib/libc/locale/localeconv.3,v 1.3 2007/01/09 00:28:00 imp Exp $
  34 .\"
  35 .Dd November 21, 2003
  36 .Dt LOCALECONV 3
  37 .Os
  38 .Sh NAME
  39 .Nm localeconv ,
  40 .Nm localeconv_l
  41 .Nd natural language formatting for C
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In locale.h
  46 .Ft struct lconv *
  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
  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.
 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.
 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 ,
 228 .Xr strfmon 3 ,
 229 .Xr xlocale 3
 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 .