8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3c / iswalpha.3c
blobbf50de8402476fab8aa54d1ca4439ecf7c8bef9b
1 '\" te
2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
3 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.  Portions Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
7 .\"  This notice shall appear on any product containing this material.
8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 .TH ISWALPHA 3C "April 9, 2016"
12 .SH NAME
13 iswalpha, isenglish, isideogram, iswideogram, isnumber, iswnumber,
14 isphonogram, iswphonogram, isspecial, iswspecial, iswalnum, iswascii,
15 iswblank, iswcntrl, iswdigit, iswgraph, iswlower, iswprint, iswpunct,
16 iswspace, iswupper, iswxdigit, iswhexnumber, iswalpha_l, iswideogram_l,
17 iswnumber_l, iswphonogram_l, iswspecial_l, iswalnum_l, iswascii_l,
18 iswblank_l, iswcntrl_l, iswdigit_l, iswgraph_l, iswlower_l, iswprint_l,
19 iswpunct_l, iswspace_l, iswupper_l, iswhexnumber_l \- wide-character
20 code classification functions
22 .SH SYNOPSIS
23 .LP
24 .nf
25 #include <wchar.h>
26 #include <wctype.h>
28 \fBint\fR \fBiswalpha\fR(\fBwint_t\fR \fIwc\fR);
29 .fi
30 .LP
31 .nf
32 \fBint\fR \fBisenglish\fR(\fBwint_t\fR \fIwc\fR);
33 .fi
34 .LP
35 .nf
36 \fBint\fR \fBisideogram\fR(\fBwint_t\fR \fIwc\fR);
37 .fi
38 .LP
39 .nf
40 \fBint\fR \fBisnumber\fR(\fBwint_t\fR \fIwc\fR);
41 .fi
42 .LP
43 .nf
44 \fBint\fR \fBisphonogram\fR(\fBwint_t\fR \fIwc\fR);
45 .fi
46 .LP
47 .nf
48 \fBint\fR \fBisspecial\fR(\fBwint_t\fR \fIwc\fR);
49 .fi
50 .LP
51 .nf
52 \fBint\fR \fBiswalnum\fR(\fBwint_t\fR \fIwc\fR);
53 .fi
54 .LP
55 .nf
56 \fBint\fR \fBiswascii\fR(\fBwint_t\fR \fIwc\fR);
57 .fi
58 .LP
59 .nf
60 \fBint\fR \fBiswblank\fR(\fBwint_t\fR \fIwc\fR);
61 .fi
62 .LP
63 .nf
64 \fBint\fR \fBiswcntrl\fR(\fBwint_t\fR \fIwc\fR);
65 .fi
66 .LP
67 .nf
68 \fBint\fR \fBiswdigit\fR(\fBwint_t\fR \fIwc\fR);
69 .fi
70 .LP
71 .nf
72 \fBint\fR \fBiswgraph\fR(\fBwint_t\fR \fIwc\fR);
73 .fi
74 .LP
75 .nf
76 \fBint\fR \fBiswlower\fR(\fBwint_t\fR \fIwc\fR);
77 .fi
78 .LP
79 .nf
80 \fBint\fR \fBiswprint\fR(\fBwint_t\fR \fIwc\fR);
81 .fi
82 .LP
83 .nf
84 \fBint\fR \fBiswpunct\fR(\fBwint_t\fR \fIwc\fR);
85 .fi
86 .LP
87 .nf
88 \fBint\fR \fBiswspace\fR(\fBwint_t\fR \fIwc\fR);
89 .fi
90 .LP
91 .nf
92 \fBint\fR \fBiswupper\fR(\fBwint_t\fR \fIwc\fR);
93 .fi
94 .LP
95 .nf
96 \fBint\fR \fBiswxdigit\fR(\fBwint_t\fR \fIwc\fR);
97 .fi
98 .LP
99 .nf
100 \fBint\fR \fBiswhexnumber\fR(\fBwint_t\fR \fIwc\fR);
104 \fBint\fR \fBiswideogram\fR(\fBwint_t\fR \fIwc\fR);
108 \fBint\fR \fBiswnumber\fR(\fBwint_t\fR \fIwc\fR);
112 \fBint\fR \fBiswphonogram\fR(\fBwint_t\fR \fIwc\fR);
116 \fBint\fR \fBiswspecial\fR(\fBwint_t\fR \fIwc\fR);
120 \fBint\fR \fBiswalpha_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
124 \fBint\fR \fBiswideogram_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
128 \fBint\fR \fBiswnumber_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
132 \fBint\fR \fBiswphonogram_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
136 \fBint\fR \fBiswspecial_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
140 \fBint\fR \fBiswalnum_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
144 \fBint\fR \fBiswascii_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
148 \fBint\fR \fBiswblank_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
152 \fBint\fR \fBiswcntrl_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
156 \fBint\fR \fBiswdigit_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
160 \fBint\fR \fBiswgraph_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
164 \fBint\fR \fBiswlower_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
168 \fBint\fR \fBiswprint_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
172 \fBint\fR \fBiswpunct_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
176 \fBint\fR \fBiswspace_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
180 \fBint\fR \fBiswupper\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
184 \fBint\fR \fBiswxdigit\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
188 #include <xlocale.h>
190 \fBint\fR \fBiswhexnumber\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
193 .SH DESCRIPTION
195 These functions test whether \fIwc\fR is a wide-character code representing a
196 character of a particular class defined in the \fBLC_CTYPE\fR category of the
197 current locale or the locale specified by \fIloc\fR.
199 The functions \fBiswalpha_l()\fR, \fBiswideogram_l()\fR, \fBiswnumber_l()\fR,
200 \fBiswphonogram_l()\fR, \fBiswspecial_l()\fR, \fBiswalnum_l()\fR,
201 \fBiswascii_l()\fR, \fBiswblank_l()\fR, \fBiswcntrl_l()\fR, \fBiswdigit_l()\fR,
202 \fBiswgraph_l()\fR, \fBiswlower_l()\fR, \fBiswprint_l()\fR, \fBiswpunct_l()\fR,
203 \fBiswspace_l()\fR, \fBiswupper_l()\fR, all behave identically to their
204 counterparts without the '\fB_l\fR' suffix, but instead of operating on the
205 current locale, they operate on the locale specified by \fIloc\fR.
207 The functions, \fBiswideogram()\fR, \fBiswnumber()\fR, \fBiswphonogram()\fR,
208 \fBiswspecial()\fR, and \fBiswhexnumber()\fR, are respectively identical to
209 \fBisideogram()\fR, \fBisnumber()\fR, \fBisphonogram()\fR, \fBisspecial()\fR,
210 \fBiswxdigit()\fR respectively.  They are provided for compatibility purposes.
212 In all cases, \fIwc\fR is a \fBwint_t\fR, the value of which must be a
213 wide-character code corresponding to a valid character in the current locale or
214 must equal the value of the macro \fBWEOF\fR. If the argument has any other
215 values, the behavior is undefined.
217 .ne 2
219 \fB\fBiswalpha(\fR\fIwc\fR\fB)\fR\fR
221 .RS 19n
222 Tests whether \fIwc\fR is a wide-character code representing a character of
223 class "alpha" in the program's current locale.
227 .ne 2
229 \fB\fBisenglish(\fR\fIwc\fR\fB)\fR\fR
231 .RS 19n
232 Tests whether \fIwc\fR is a wide-character code representing an English
233 language character, excluding \fBASCII\fR characters.
237 .ne 2
239 \fB\fBisideogram(\fR\fIwc\fR\fB)\fR\fR
241 .RS 19n
242 Tests whether \fIwc\fR is a wide-character code representing an ideographic
243 language character, excluding \fBASCII\fR characters.
247 .ne 2
249 \fB\fBisnumber(\fR\fIwc\fR\fB)\fR\fR
251 .RS 19n
252 Tests whether \fIwc\fR is a wide-character code representing digit [0\(mi9],
253 excluding \fBASCII\fR characters.
257 .ne 2
259 \fB\fBisphonogram(\fR\fIwc\fR\fB)\fR\fR
261 .RS 19n
262 Tests whether \fIwc\fR is a wide-character code representing a phonetic
263 language character, excluding \fBASCII\fR characters.
267 .ne 2
269 \fB\fBisspecial(\fR\fIwc\fR\fB)\fR\fR
271 .RS 19n
272 Tests whether \fIwc\fR is a wide-character code representing a special language
273 character, excluding \fBASCII\fR characters.
277 .ne 2
279 \fB\fBiswalnum(\fR\fIwc\fR\fB)\fR\fR
281 .RS 19n
282 Tests whether \fIwc\fR is a wide-character code representing a character of
283 class "alpha" or "digit" in the program's current locale.
287 .ne 2
289 \fB\fBiswascii(\fR\fIwc\fR\fB)\fR\fR
291 .RS 19n
292 Tests whether \fIwc\fR is a wide-character code representing an \fBASCII\fR
293 character.
297 .ne 2
299 \fB\fBiswblank(\fR\fIwc\fR\fB)\fR\fR
301 .RS 19n
302 Tests whether \fIwc\fR is a wide-character code representing a character of
303 class "blank" in the program's current locale. This function is not available
304 to applications conforming to standards prior to SUSv3. See \fBstandards\fR(5).
308 .ne 2
310 \fB\fBiswlower(\fR\fIwc\fR\fB)\fR\fR
312 .RS 19n
313 Tests whether \fIwc\fR is a wide-character code representing a character of
314 class "lower" in the program's current locale.
318 .ne 2
320 \fB\fBiswcntrl(\fR\fIwc\fR\fB)\fR\fR
322 .RS 19n
323 Tests whether \fIwc\fR is a wide-character code representing a character of
324 class "cntrl" in the program's current locale.
328 .ne 2
330 \fB\fBiswdigit(\fR\fIwc\fR\fB)\fR\fR
332 .RS 19n
333 Tests whether \fIwc\fR is a wide-character code representing a character of
334 class "digit" in the program's current locale.
338 .ne 2
340 \fB\fBiswgraph(\fR\fIwc\fR\fB)\fR\fR
342 .RS 19n
343 Tests whether \fIwc\fR is a wide-character code representing a character of
344 class "graph" in the program's current locale.
348 .ne 2
350 \fB\fBiswprint(\fR\fIwc\fR\fB)\fR\fR
352 .RS 19n
353 Tests whether \fIwc\fR is a wide-character code representing a character of
354 class "print" in the program's current locale.
358 .ne 2
360 \fB\fBiswpunct(\fR\fIwc\fR\fB)\fR\fR
362 .RS 19n
363 Tests whether \fIwc\fR is a wide-character code representing a character of
364 class "punct" in the program's current locale.
368 .ne 2
370 \fB\fBiswspace(\fR\fIwc\fR\fB)\fR\fR
372 .RS 19n
373 Tests whether \fIwc\fR is a wide-character code representing a character of
374 class "space" in the program's current locale.
378 .ne 2
380 \fB\fBiswupper(\fR\fIwc\fR\fB)\fR\fR
382 .RS 19n
383 Tests whether \fIwc\fR is a wide-character code representing a character of
384 class "upper" in the program's current locale.
388 .ne 2
390 \fB\fBiswxdigit(\fR\fIwc\fR\fB)\fR\fR
392 .RS 19n
393 Tests whether \fIwc\fR is a wide-character code representing a character of
394 class "xdigit" in the program's current locale.
397 .SH ATTRIBUTES
399 See \fBattributes\fR(5) for descriptions of the following attributes:
401 box;
402 c | c
403 l | l .
404 ATTRIBUTE TYPE  ATTRIBUTE VALUE
406 CSI     Enabled
408 Interface Stability     See below.
410 MT-Level        MT-Safe
414 The \fBiswalpha()\fR, \fBiswalnum()\fR, \fBiswblank()\fR, \fBiswcntrl()\fR,
415 \fBiswdigit()\fR, \fBiswgraph()\fR, \fBiswlower()\fR, \fBiswprint()\fR,
416 \fBiswpunct()\fR, \fBiswspace()\fR, \fBiswupper()\fR, and \fBiswxdigit()\fR
417 functions are Standard.
419 The \fBiswalpha_l()\fR, \fBiswalnum_l()\fR, \fBiswblank_l()\fR, \fBiswcntrl_l()\fR,
420 \fBiswdigit_l()\fR, \fBiswgraph_l()\fR, \fBiswlower_l()\fR, \fBiswprint_l()\fR,
421 \fBiswpunct_l()\fR, \fBiswspace_l()\fR, and \fBiswupper_l()\fR
422 functions are Standard.
423 .SH SEE ALSO
425 \fBlocaledef\fR(1), \fBnewlocale\fR(3C),
426 \fBsetlocale\fR(3C), \fBstdio\fR(3C), \fBuselocale\fR(3C),
427 \fBascii\fR(5), \fBattributes\fR(5), \fBstandards\fR(5)