|
|
@ -0,0 +1,60 @@ |
|
|
|
.\" $OpenBSD: wcswidth.3,v 1.1 2011/04/04 18:16:24 stsp Exp $ |
|
|
|
.\" Copyright (c) 2002 Tim J. Robbins |
|
|
|
.\" All rights reserved. |
|
|
|
.\" |
|
|
|
.\" 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. |
|
|
|
.\" |
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. |
|
|
|
.\" |
|
|
|
.\" |
|
|
|
.Dd $Mdocdate: April 4 2011 $ |
|
|
|
.Dt WCSWIDTH 3 |
|
|
|
.Os |
|
|
|
.Sh NAME |
|
|
|
.Nm wcswidth |
|
|
|
.Nd number of column positions in wide-character string |
|
|
|
.Sh SYNOPSIS |
|
|
|
.In wchar.h |
|
|
|
.Ft int |
|
|
|
.Fn wcswidth "const wchar_t *pwcs" "size_t n" |
|
|
|
.Sh DESCRIPTION |
|
|
|
The |
|
|
|
.Fn wcswidth |
|
|
|
function determines the number of column positions required for the first |
|
|
|
.Fa n |
|
|
|
characters of |
|
|
|
.Fa pwcs , |
|
|
|
or until a null wide character (L'\e0') is encountered. |
|
|
|
.Sh RETURN VALUES |
|
|
|
The |
|
|
|
.Fn wcswidth |
|
|
|
function returns 0 if |
|
|
|
.Fa pwcs |
|
|
|
is an empty string (L""), |
|
|
|
\-1 if a non-printing wide character is encountered, |
|
|
|
otherwise it returns the number of column positions occupied. |
|
|
|
.Sh SEE ALSO |
|
|
|
.Xr iswprint 3 , |
|
|
|
.Xr wcwidth 3 |
|
|
|
.Sh STANDARDS |
|
|
|
The |
|
|
|
.Fn wcswidth |
|
|
|
function conforms to |
|
|
|
.St -p1003.1-2001 . |