2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
|
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
|
|
|
.\"
|
|
|
|
|
.TH WCWIDTH 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
wcwidth \- determine columns needed for a wide character
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
2006-10-13 11:21:08 +00:00
|
|
|
.B #define _XOPEN_SOURCE
|
2004-11-03 13:51:07 +00:00
|
|
|
.B #include <wchar.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "int wcwidth(wchar_t " c );
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcwidth ()
|
|
|
|
|
function returns the number of columns
|
2007-04-24 16:44:51 +00:00
|
|
|
needed to represent the wide character \fIc\fP.
|
|
|
|
|
If \fIc\fP is a printable wide character, the value
|
|
|
|
|
is at least 0.
|
2007-06-08 03:17:37 +00:00
|
|
|
If \fIc\fP is L'\\0', the value is 0.
|
|
|
|
|
Otherwise \-1 is returned.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcwidth ()
|
|
|
|
|
function returns the number of
|
2007-04-24 16:44:51 +00:00
|
|
|
column positions for \fIc\fP.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2006-10-13 11:21:08 +00:00
|
|
|
POSIX.1-2001.
|
2006-08-03 13:57:30 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
Note that glibc before 2.2.5 used the prototype
|
|
|
|
|
.br
|
|
|
|
|
.nf
|
|
|
|
|
.BI "int wcwidth(wint_t " c );
|
|
|
|
|
.fi
|
|
|
|
|
.SH NOTES
|
2007-06-08 09:56:56 +00:00
|
|
|
The behavior of
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR wcwidth ()
|
2007-06-22 18:25:23 +00:00
|
|
|
depends on the
|
|
|
|
|
.B LC_CTYPE
|
|
|
|
|
category of the
|
2004-11-03 13:51:07 +00:00
|
|
|
current locale.
|
2007-01-28 20:00:24 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR iswprint (3),
|
|
|
|
|
.BR wcswidth (3),
|
|
|
|
|
.BR feature_test_macros (7)
|
