wcwidth(3)

wcwidth3

Number of column positions of a wide-character code

Usage

#include <wchar.h>

int

wcwidth(wchar_t wc);

#include <wchar.h>

#include <xlocale.h>

int

wcwidth_l(wchar_t wc, locale_t loc);

Library

Standard C Library (libc, -lc)

Overview

The wcwidth() function determines the number of column positions required to display the wide character wc.

Although the wcwidth() function uses the current locale, the wcwidth_l() function may be passed a locale directly. See xlocale(3) for more information.

Return values

The wcwidth() function returns 0 if the wc argument is a null wide character (L'\0'), -1 if wc is not printable; otherwise, it returns the number of column positions the character occupies.

Examples

This code fragment reads text from standard input and breaks lines that are more than 20 column positions wide, similar to the fold(1) utility:

wint_t ch;
int column, w;
column = 0;
while ((ch = getwchar()) != WEOF) {
	w = wcwidth(ch);
	if (w > 0 && column + w >= 20) {
		putwchar(L'\n');
		column = 0;
	}
	putwchar(ch);
	if (ch == L'\n')
		column = 0;
	else if (w > 0)
		column += w;
}

Releases

145 releases since Mac OS X 10.3; the text changed 2 times.

  1. 10.3–10.3.9
  2. 10.4–10.4.11
  3. 10.5–26.5

Standards

The wcwidth() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.