NAME
wchar.h —
wide-character handling
SYNOPSIS
#include
<wchar.h>
DESCRIPTION
[CX] Some of the functionality described on this reference page extends the ISO C standard. Applications shall define the appropriate feature test macro (see the System Interfaces volume of IEEE Std 1003.1-2001 (“POSIX.1”), xsh_chap02_02(3)) to enable the visibility of these symbols in this header.
The <wchar.h> header shall define the following types:
- wchar_t
- As described in <stddef.h> .
- wint_t
- An integer type capable of storing any valid value of wchar_t or WEOF.
- wctype_t
- [XSI] A scalar type of a data object that can hold values which represent locale-specific character classification.
- mbstate_t
- An object type other than an array type that can hold the conversion state information necessary to convert between sequences of (possibly multi-byte) characters and wide characters. [XSI] If a codeset is being used such that an mbstate_t needs to preserve more than 2 levels of reserved state, the results are unspecified.
- FILE
- [XSI] As described in <stdio.h> .
- size_t
- As described in <stddef.h> .
- va_list
- [XSI] As described in <stdarg.h> .
The implementation shall support one or more programming environments in which the width of wint_t is no greater than the width of type long. The names of these programming environments can be obtained using the confstr(3) function or the getconf(1) utility.
The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.
wint_t btowc(int);
wint_t fgetwc(FILE *);
wchar_t *fgetws(wchar_t *restrict, int, FILE *restrict);
wint_t fputwc(wchar_t, FILE *);
int fputws(const wchar_t *restrict, FILE *restrict);
int fwide(FILE *, int);
int fwprintf(FILE *restrict, const wchar_t *restrict, ...);
int fwscanf(FILE *restrict, const wchar_t *restrict, ...);
wint_t getwc(FILE *);
wint_t getwchar(void);
[XSI]
int iswalnum(wint_t);
int iswalpha(wint_t);
int iswcntrl(wint_t);
int iswctype(wint_t, wctype_t);
int iswdigit(wint_t);
int iswgraph(wint_t);
int iswlower(wint_t);
int iswprint(wint_t);
int iswpunct(wint_t);
int iswspace(wint_t);
int iswupper(wint_t);
int iswxdigit(wint_t);
size_t mbrlen(const char *restrict, size_t, mbstate_t *restrict);
size_t mbrtowc(wchar_t *restrict, const char *restrict, size_t,
mbstate_t *restrict);
int mbsinit(const mbstate_t *);
size_t mbsrtowcs(wchar_t *restrict, const char **restrict, size_t,
mbstate_t *restrict);
wint_t putwc(wchar_t, FILE *);
wint_t putwchar(wchar_t);
int swprintf(wchar_t *restrict, size_t,
const wchar_t *restrict, ...);
int swscanf(const wchar_t *restrict,
const wchar_t *restrict, ...);
[XSI]
wint_t towlower(wint_t);
wint_t towupper(wint_t);
wint_t ungetwc(wint_t, FILE *);
int vfwprintf(FILE *restrict, const wchar_t *restrict, va_list);
int vfwscanf(FILE *restrict, const wchar_t *restrict, va_list);
int vwprintf(const wchar_t *restrict, va_list);
int vswprintf(wchar_t *restrict, size_t,
const wchar_t *restrict, va_list);
int vswscanf(const wchar_t *restrict, const wchar_t *restrict,
va_list);
int vwscanf(const wchar_t *restrict, va_list);
size_t wcrtomb(char *restrict, wchar_t, mbstate_t *restrict);
wchar_t *wcscat(wchar_t *restrict, const wchar_t *restrict);
wchar_t *wcschr(const wchar_t *, wchar_t);
int wcscmp(const wchar_t *, const wchar_t *);
int wcscoll(const wchar_t *, const wchar_t *);
wchar_t *wcscpy(wchar_t *restrict, const wchar_t *restrict);
size_t wcscspn(const wchar_t *, const wchar_t *);
size_t wcsftime(wchar_t *restrict, size_t,
const wchar_t *restrict, const struct tm *restrict);
size_t wcslen(const wchar_t *);
wchar_t *wcsncat(wchar_t *restrict, const wchar_t *restrict, size_t);
int wcsncmp(const wchar_t *, const wchar_t *, size_t);
wchar_t *wcsncpy(wchar_t *restrict, const wchar_t *restrict, size_t);
wchar_t *wcspbrk(const wchar_t *, const wchar_t *);
wchar_t *wcsrchr(const wchar_t *, wchar_t);
size_t wcsrtombs(char *restrict, const wchar_t **restrict,
size_t, mbstate_t *restrict);
size_t wcsspn(const wchar_t *, const wchar_t *);
wchar_t *wcsstr(const wchar_t *restrict, const wchar_t *restrict);
double wcstod(const wchar_t *restrict, wchar_t **restrict);
float wcstof(const wchar_t *restrict, wchar_t **restrict);
wchar_t *wcstok(wchar_t *restrict, const wchar_t *restrict,
wchar_t **restrict);
long wcstol(const wchar_t *restrict, wchar_t **restrict, int);
long double wcstold(const wchar_t *restrict, wchar_t **restrict);
long long wcstoll(const wchar_t *restrict, wchar_t **restrict, int);
unsigned long wcstoul(const wchar_t *restrict, wchar_t **restrict, int);
unsigned long long
wcstoull(const wchar_t *restrict, wchar_t **restrict, int);
[XSI]
wchar_t *wcswcs(const wchar_t *, const wchar_t *);
int wcswidth(const wchar_t *, size_t);
size_t wcsxfrm(wchar_t *restrict, const wchar_t *restrict, size_t);
int wctob(wint_t);
[XSI]
wctype_t wctype(const char *);
int wcwidth(wchar_t);
wchar_t *wmemchr(const wchar_t *, wchar_t, size_t);
int wmemcmp(const wchar_t *, const wchar_t *, size_t);
wchar_t *wmemcpy(wchar_t *restrict, const wchar_t *restrict, size_t);
wchar_t *wmemmove(wchar_t *, const wchar_t *, size_t);
wchar_t *wmemset(wchar_t *, wchar_t, size_t);
int wprintf(const wchar_t *restrict, ...);
int wscanf(const wchar_t *restrict, ...);
The <wchar.h> header shall define the following macros:
- WCHAR_MAX
- The maximum value representable by an object of type wchar_t .
- WCHAR_MIN
- The minimum value representable by an object of type wchar_t .
- WEOF
- Constant expression of type wint_t that is returned by several WP functions to indicate end-of-file.
- NULL
- As described in <stddef.h> .
The tag tm shall be declared as naming an incomplete structure type, the contents of which are described in the header <time.h> .
[CX] Inclusion of the <wchar.h> header may make visible all symbols from the headers <ctype.h>, <string.h>, <stdarg.h>, <stddef.h>, <stdio.h>, <stdlib.h>, and <time.h>.
APPLICATION USAGE
None.
RATIONALE
In the ISO C standard, the symbols referenced as XSI extensions are in <wctype.h>. Their presence here is thus an extension.
FUTURE DIRECTIONS
None.
SEE ALSO
<ctype.h> , <stdarg.h> , <stddef.h> , <stdio.h> , <stdlib.h> , <string.h> , <time.h> , <wctype.h> , the System Interfaces volume of IEEE Std 1003.1-2001 (“POSIX.1”), btowc(3), confstr(3), fgetwc(3), fgetws(3), fputwc(3), fputws(3), fwide(3), fwprintf(3), fwscanf(3), getwc(3), getwchar(3), iswalnum(3), iswalpha(3), iswcntrl(3), iswctype(3), iswdigit(3), iswgraph(3), iswlower(3), iswprint(3), iswpunct(3), iswspace(3), iswupper(3), iswxdigit(3), iswctype(3), mbsinit(3), mbrlen(3), mbrtowc(3), mbsrtowcs(3), putwc(3), putwchar(3), swprintf(3), swscanf(3), towlower(3), towupper(3), ungetwc(3), vfwprintf(3), vfwscanf(3), vswprintf(3), vswscanf(3), vwscanf(3), wcrtomb(3), wcsrtombs(3), wcscat(3), wcschr(3), wcscmp(3), wcscoll(3), wcscpy(3), wcscspn(3), wcsftime(3), wcslen(3), wcsncat(3), wcsncmp(3), wcsncpy(3), wcspbrk(3), wcsrchr(3), wcsspn(3), wcsstr(3), wcstod(3), wcstof(3), wcstok(3), wcstol(3), wcstold(3), wcstoll(3), wcstoul(3), wcstoull(3), wcswcs(3), wcswidth(3), wcsxfrm(3), wctob(3), wctype(3), wcwidth(3), wmemchr(3), wmemcmp(3), wmemcpy(3), wmemmove(3), wmemset(3), wprintf(3), wscanf(3), the Shell and Utilities volume of IEEE Std 1003.1-2001 (“POSIX.1”), getconf(1)
CHANGE HISTORY
First released in Issue 4.
Issue 5
Aligned with the ISO/IEC 9899/AMD1:1995 (“ISO C90, Amendment 1”) (E).
Issue 6
The Open Group Corrigendum U021/10 is applied. The prototypes for wcswidth(3) and wcwidth(3) are marked as extensions.
The Open Group Corrigendum U028/5 is applied, correcting the prototype for the mbsinit(3) function.
The following changes are made for alignment with the ISO/IEC 9899:1999 (“ISO C99”) standard:
- Various function prototypes are updated to add the restrict keyword.
- The functions vfwscanf(3), vswscanf(3), wcstof(3), wcstold(3), wcstoll(3), and wcstoull(3) are added.
The type wctype_t, the isw* (), to* (), and wctype(3) functions are marked as XSI extensions.
End of informative text. footer end