locales, libconv: Sync with FreeBSD (extensive reach)
[dragonfly.git] / lib / libc / locale / iswalnum_l.3
1 .\" Copyright (c) 2012 Isabell Long <issyl0@FreeBSD.org>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: head/lib/libc/locale/iswalnum_l.3 238808 2012-07-26 14:46:19Z joel $
26 .\"
27 .Dd July 25, 2012
28 .Dt ISWALNUM_L 3
29 .Os
30 .Sh NAME
31 .Nm iswalnum_l ,
32 .Nm iswalpha_l ,
33 .Nm iswcntrl_l ,
34 .Nm iswctype_l ,
35 .Nm iswdigit_l ,
36 .Nm iswgraph_l ,
37 .Nm iswlower_l ,
38 .Nm iswprint_l ,
39 .Nm iswpunct_l ,
40 .Nm iswspace_l ,
41 .Nm iswupper_l ,
42 .Nm iswxdigit_l ,
43 .Nm towlower_l ,
44 .Nm towupper_l ,
45 .Nm wctype_l ,
46 .Nm iswblank_l ,
47 .Nm iswhexnumber_l ,
48 .Nm iswideogram_l ,
49 .Nm iswnumber_l ,
50 .Nm iswphonogram_l ,
51 .Nm iswrune_l ,
52 .Nm iswspecial_l ,
53 .Nm nextwctype_l ,
54 .Nm towctrans_l ,
55 .Nm wctrans_l
56 .Nd wide character classification utilities
57 .Sh LIBRARY
58 .Lb libc
59 .Sh SYNOPSIS
60 .In wctype.h
61 .Ft int
62 .Fn iswalnum_l "wint_t wc" "locale_t loc"
63 .Ft int
64 .Fn iswalpha_l "wint_t wc" "locale_t loc"
65 .Ft int
66 .Fn iswcntrl_l "wint_t wc" "locale_t loc"
67 .Ft int
68 .Fn iswctype_l "wint_t wc" "locale_t loc"
69 .Ft int
70 .Fn iswdigit_l "wint_t wc" "locale_t loc"
71 .Ft int
72 .Fn iswgraph_l "wint_t wc" "locale_t loc"
73 .Ft int
74 .Fn iswlower_l "wint_t wc" "locale_t loc"
75 .Ft int
76 .Fn iswprint_l "wint_t wc" "locale_t loc"
77 .Ft int
78 .Fn iswpunct_l "wint_t wc" "locale_t loc"
79 .Ft int
80 .Fn iswspace_l "wint_t wc" "locale_t loc"
81 .Ft int
82 .Fn iswupper_l "wint_t wc" "locale_t loc"
83 .Ft int
84 .Fn iswxdigit_l "wint_t wc" "locale_t loc"
85 .Ft wint_t
86 .Fn towlower_l "wint_t wc" "locale_t loc"
87 .Ft wint_t
88 .Fn towupper_l "wint_t wc" "locale_t loc"
89 .Ft wctype_t
90 .Fn wctype_l "wint_t wc" "locale_t loc"
91 .Ft int
92 .Fn iswblank_l "wint_t wc" "locale_t loc"
93 .Ft int
94 .Fn iswhexnumber_l "wint_t wc" "locale_t loc"
95 .Ft int
96 .Fn iswideogram_l "wint_t wc" "locale_t loc"
97 .Ft int
98 .Fn iswnumber_l "wint_t wc" "locale_t loc"
99 .Ft int
100 .Fn iswphonogram_l "wint_t wc" "locale_t loc"
101 .Ft int
102 .Fn iswrune_l "wint_t wc" "locale_t loc"
103 .Ft int
104 .Fn iswspecial_l "wint_t wc" "locale_t loc"
105 .Ft wint_t
106 .Fn nextwctype_l "wint_t wc" "locale_t loc"
107 .Ft wint_t
108 .Fn towctrans_l "wint_t wc" "wctrans_t" "locale_t loc"
109 .Ft wctrans_t
110 .Fn wctrans_l "const char *" "locale_t loc"
111 .Sh DESCRIPTION
112 The above functions are character classification utility functions,
113 for use with wide characters
114 .Vt ( wchar_t
115 or
116 .Vt wint_t )
117 in the locale
118 .Fa loc .
119 They behave in the same way as the versions without the _l suffix, but use
120 the specified locale rather than the global or per-thread locale.
121 These functions may be implemented as inline functions in
122 .In wctype.h
123 and as functions in the C library.
124 See the specific manual pages for more information.
125 .Sh RETURN VALUES
126 These functions return the same things as their non-locale versions.
127 If the locale is invalid, their behaviors are undefined.
128 .Sh SEE ALSO
129 .Xr iswalnum 3 ,
130 .Xr iswalpha 3 ,
131 .Xr iswblank 3 ,
132 .Xr iswcntrl 3 ,
133 .Xr iswctype 3 ,
134 .Xr iswdigit 3 ,
135 .Xr iswgraph 3 ,
136 .Xr iswhexnumber 3 ,
137 .Xr iswideogram 3 ,
138 .Xr iswlower 3 ,
139 .Xr iswnumber 3 ,
140 .Xr iswphonogram 3 ,
141 .Xr iswprint 3 ,
142 .Xr iswpunct 3 ,
143 .Xr iswrune 3 ,
144 .Xr iswspace 3 ,
145 .Xr iswspecial 3 ,
146 .Xr iswupper 3 ,
147 .Xr iswxdigit 3 ,
148 .Xr nextwctype 3 ,
149 .Xr towctrans 3 ,
150 .Xr towlower 3 ,
151 .Xr towupper 3 ,
152 .Xr wctrans 3 ,
153 .Xr wctype 3
154 .Sh STANDARDS
155 These functions conform to
156 .St -p1003.1-2008 ,
157 except for
158 .Fn iswascii_l ,
159 .Fn iswhexnumber_l ,
160 .Fn iswideogram_l ,
161 .Fn iswphonogram_l ,
162 .Fn iswrune_l ,
163 .Fn iswspecial_l
164 and
165 .Fn nextwctype_l
166 which are
167 .Fx
168 extensions.