logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

wchar.h.0p (12630B)

    

  1. '\" et
  2. .TH wchar.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. wchar.h
  12. \(em wide-character handling
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wchar.h>
  17. .fi
  18. .SH DESCRIPTION
  19. Some of the functionality described on this reference page extends the
  20. ISO\ C standard. Applications shall define the appropriate feature test macro
  21. (see the System Interfaces volume of POSIX.1\(hy2017,
  22. .IR "Section 2.2" ", " "The Compilation Environment")
  23. to enable the visibility of these symbols in this header.
  24. .P
  25. The
  26. .IR <wchar.h> 
  27. header shall define the following types:
  28. .IP "\fBFILE\fP" 12
  29. As described in
  30. .IR <stdio.h> .
  31. .IP "\fBlocale_t\fP" 12
  32. As described in
  33. .IR <locale.h> .
  34. .IP "\fBmbstate_t\fP" 12
  35. An object type other than an array type that can hold the conversion
  36. state information necessary to convert between sequences of (possibly
  37. multi-byte) characters and wide characters.
  38. If a codeset is being used such that an
  39. .BR mbstate_t
  40. needs to preserve more than two levels of reserved state, the
  41. results are unspecified.
  42. .IP "\fBsize_t\fP" 12
  43. As described in
  44. .IR <stddef.h> .
  45. .IP "\fBva_list\fP" 12
  46. As described in
  47. .IR <stdarg.h> .
  48. .IP "\fBwchar_t\fP" 12
  49. As described in
  50. .IR <stddef.h> .
  51. .IP "\fBwctype_t\fP" 12
  52. A scalar type of a data object that can hold values which represent
  53. locale-specific character classification.
  54. .IP "\fBwint_t\fP" 12
  55. An integer type capable of storing any valid value of
  56. .BR wchar_t
  57. or WEOF.
  58. .P
  59. The tag
  60. .BR tm
  61. shall be declared as naming an incomplete structure type, the contents
  62. of which are described in the
  63. .IR <time.h> 
  64. header.
  65. .P
  66. The implementation shall support one or more programming environments
  67. in which the width of
  68. .BR wint_t
  69. is no greater than the width of type
  70. .BR long .
  71. The names of these programming environments can be obtained using the
  72. \fIconfstr\fR()
  73. function or the
  74. .IR getconf
  75. utility.
  76. .P
  77. The
  78. .IR <wchar.h> 
  79. header shall define the following macros:
  80. .IP WCHAR_MAX 12
  81. As described in
  82. .IR <stdint.h> .
  83. .IP WCHAR_MIN 12
  84. As described in
  85. .IR <stdint.h> .
  86. .IP WEOF 12
  87. Constant expression of type
  88. .BR wint_t
  89. that is returned by several WP functions to indicate end-of-file.
  90. .IP NULL 12
  91. As described in
  92. .IR <stddef.h> .
  93. .P
  94. Inclusion of the
  95. .IR <wchar.h> 
  96. header may make visible all symbols from the headers
  97. .IR <ctype.h> ,
  98. .IR <string.h> ,
  99. .IR <stdarg.h> ,
  100. .IR <stddef.h> ,
  101. .IR <stdio.h> ,
  102. .IR <stdlib.h> ,
  103. and
  104. .IR <time.h> .
  105. .P
  106. The following shall be declared as functions and may also be defined
  107. as macros. Function prototypes shall be provided for use with ISO\ C standard
  108. compilers. Arguments to functions in this list can point to arrays
  109. containing
  110. .BR wchar_t
  111. values that do not correspond to members of the character set of the
  112. current locale. Such values shall be processed according to the
  113. specified semantics, unless otherwise stated.
  114. .sp
  115. .RS 4
  116. .nf
  118. wint_t        btowc(int);
  119. wint_t        fgetwc(FILE *);
  120. wchar_t      *fgetws(wchar_t *restrict, int, FILE *restrict);
  121. wint_t        fputwc(wchar_t, FILE *);
  122. int           fputws(const wchar_t *restrict, FILE *restrict);
  123. int           fwide(FILE *, int);
  124. int           fwprintf(FILE *restrict, const wchar_t *restrict, ...);
  125. int           fwscanf(FILE *restrict, const wchar_t *restrict, ...);
  126. wint_t        getwc(FILE *);
  127. wint_t        getwchar(void);
  128. int           iswalnum(wint_t);
  129. int           iswalpha(wint_t);
  130. int           iswcntrl(wint_t);
  131. int           iswctype(wint_t, wctype_t);
  132. int           iswdigit(wint_t);
  133. int           iswgraph(wint_t);
  134. int           iswlower(wint_t);
  135. int           iswprint(wint_t);
  136. int           iswpunct(wint_t);
  137. int           iswspace(wint_t);
  138. int           iswupper(wint_t);
  139. int           iswxdigit(wint_t);
  140. size_t        mbrlen(const char *restrict, size_t, mbstate_t *restrict);
  141. size_t        mbrtowc(wchar_t *restrict, const char *restrict, size_t,
  142.                   mbstate_t *restrict);
  143. int           mbsinit(const mbstate_t *);
  144. size_t        mbsnrtowcs(wchar_t *restrict, const char **restrict,
  145.                   size_t, size_t, mbstate_t *restrict);
  146. size_t        mbsrtowcs(wchar_t *restrict, const char **restrict, size_t,
  147.                   mbstate_t *restrict);
  148. FILE         *open_wmemstream(wchar_t **, size_t *);
  149. wint_t        putwc(wchar_t, FILE *);
  150. wint_t        putwchar(wchar_t);
  151. int           swprintf(wchar_t *restrict, size_t,
  152.                   const wchar_t *restrict, ...);
  153. int           swscanf(const wchar_t *restrict,
  154.                   const wchar_t *restrict, ...);
  155. wint_t        towlower(wint_t);
  156. wint_t        towupper(wint_t);
  157. wint_t        ungetwc(wint_t, FILE *);
  158. int           vfwprintf(FILE *restrict, const wchar_t *restrict, va_list);
  159. int           vfwscanf(FILE *restrict, const wchar_t *restrict, va_list);
  160. int           vswprintf(wchar_t *restrict, size_t,
  161.                   const wchar_t *restrict, va_list);
  162. int           vswscanf(const wchar_t *restrict, const wchar_t *restrict,
  163.                   va_list);
  164. int           vwprintf(const wchar_t *restrict, va_list);
  165. int           vwscanf(const wchar_t *restrict, va_list);
  166. wchar_t      *wcpcpy(wchar_t *restrict, const wchar_t *restrict);
  167. wchar_t      *wcpncpy(wchar_t *restrict, const wchar_t *restrict, size_t);
  168. size_t        wcrtomb(char *restrict, wchar_t, mbstate_t *restrict);
  169. int           wcscasecmp(const wchar_t *, const wchar_t *);
  170. int           wcscasecmp_l(const wchar_t *, const wchar_t *, locale_t);
  171. wchar_t      *wcscat(wchar_t *restrict, const wchar_t *restrict);
  172. wchar_t      *wcschr(const wchar_t *, wchar_t);
  173. int           wcscmp(const wchar_t *, const wchar_t *);
  174. int           wcscoll(const wchar_t *, const wchar_t *);
  175. int           wcscoll_l(const wchar_t *, const wchar_t *, locale_t);
  176. wchar_t      *wcscpy(wchar_t *restrict, const wchar_t *restrict);
  177. size_t        wcscspn(const wchar_t *, const wchar_t *);
  178. wchar_t      *wcsdup(const wchar_t *);
  179. size_t        wcsftime(wchar_t *restrict, size_t,
  180.                   const wchar_t *restrict, const struct tm *restrict);
  181. size_t        wcslen(const wchar_t *);
  182. int           wcsncasecmp(const wchar_t *, const wchar_t *, size_t);
  183. int           wcsncasecmp_l(const wchar_t *, const wchar_t *, size_t,
  184.                   locale_t);
  185. wchar_t      *wcsncat(wchar_t *restrict, const wchar_t *restrict, size_t);
  186. int           wcsncmp(const wchar_t *, const wchar_t *, size_t);
  187. wchar_t      *wcsncpy(wchar_t *restrict, const wchar_t *restrict, size_t);
  188. size_t        wcsnlen(const wchar_t *, size_t);
  189. size_t        wcsnrtombs(char *restrict, const wchar_t **restrict, size_t,
  190.                   size_t, mbstate_t *restrict);
  191. wchar_t      *wcspbrk(const wchar_t *, const wchar_t *);
  192. wchar_t      *wcsrchr(const wchar_t *, wchar_t);
  193. size_t        wcsrtombs(char *restrict, const wchar_t **restrict,
  194.                   size_t, mbstate_t *restrict);
  195. size_t        wcsspn(const wchar_t *, const wchar_t *);
  196. wchar_t      *wcsstr(const wchar_t *restrict, const wchar_t *restrict);
  197. double        wcstod(const wchar_t *restrict, wchar_t **restrict);
  198. float         wcstof(const wchar_t *restrict, wchar_t **restrict);
  199. wchar_t      *wcstok(wchar_t *restrict, const wchar_t *restrict,
  200.                   wchar_t **restrict);
  201. long          wcstol(const wchar_t *restrict, wchar_t **restrict, int);
  202. long double   wcstold(const wchar_t *restrict, wchar_t **restrict);
  203. long long     wcstoll(const wchar_t *restrict, wchar_t **restrict, int);
  204. unsigned long wcstoul(const wchar_t *restrict, wchar_t **restrict, int);
  205. unsigned long long
  206.               wcstoull(const wchar_t *restrict, wchar_t **restrict, int);
  207. int           wcswidth(const wchar_t *, size_t);
  208. size_t        wcsxfrm(wchar_t *restrict, const wchar_t *restrict, size_t);
  209. size_t        wcsxfrm_l(wchar_t *restrict, const wchar_t *restrict,
  210.                   size_t, locale_t);
  211. int           wctob(wint_t);
  212. wctype_t      wctype(const char *);
  213. int           wcwidth(wchar_t);
  214. wchar_t      *wmemchr(const wchar_t *, wchar_t, size_t);
  215. int           wmemcmp(const wchar_t *, const wchar_t *, size_t);
  216. wchar_t      *wmemcpy(wchar_t *restrict, const wchar_t *restrict, size_t);
  217. wchar_t      *wmemmove(wchar_t *, const wchar_t *, size_t);
  218. wchar_t      *wmemset(wchar_t *, wchar_t, size_t);
  219. int           wprintf(const wchar_t *restrict, ...);
  220. int           wscanf(const wchar_t *restrict, ...);
  221. .fi
  222. .P
  223. .RE
  224. .LP
  225. .IR "The following sections are informative."
  226. .SH "APPLICATION USAGE"
  227. The
  228. \fIiswblank\fR()
  229. function was a late addition to the ISO\ C standard and was introduced at the same
  230. time as the ISO\ C standard introduced
  231. .IR <wctype.h> ,
  232. which contains all of the
  233. .IR isw* (\|)
  234. functions. The Open Group Base Specifications had previously aligned
  235. with the MSE working draft and had introduced the rest of the
  236. .IR isw* (\|)
  237. functions into
  238. .IR <wchar.h> .
  239. For backwards-compatibility, the original set of
  240. .IR isw* (\|)
  241. functions, without
  242. \fIiswblank\fR(),
  243. are permitted (as part of the XSI option) in
  244. .IR <wchar.h> .
  245. For maximum portability, applications should include
  246. .IR <wctype.h> 
  247. in order to obtain declarations for the
  248. .IR isw* (\|)
  249. functions. This compatibility has been made obsolescent.
  250. .SH RATIONALE
  251. In the ISO\ C standard, the symbols referenced as XSI extensions are in
  252. .IR <wctype.h> .
  253. Their presence here is thus an extension.
  254. .SH "FUTURE DIRECTIONS"
  255. None.
  256. .SH "SEE ALSO"
  257. .IR "\fB<ctype.h>\fP",
  258. .IR "\fB<locale.h>\fP",
  259. .IR "\fB<stdarg.h>\fP",
  260. .IR "\fB<stddef.h>\fP",
  261. .IR "\fB<stdint.h>\fP",
  262. .IR "\fB<stdio.h>\fP",
  263. .IR "\fB<stdlib.h>\fP",
  264. .IR "\fB<string.h>\fP",
  265. .IR "\fB<time.h>\fP",
  266. .IR "\fB<wctype.h>\fP"
  267. .P
  268. .ad l
  269. The System Interfaces volume of POSIX.1\(hy2017,
  270. .IR "Section 2.2" ", " "The Compilation Environment",
  271. .IR "\fIbtowc\fR\^(\|)",
  272. .IR "\fIconfstr\fR\^(\|)",
  273. .IR "\fIfgetwc\fR\^(\|)",
  274. .IR "\fIfgetws\fR\^(\|)",
  275. .IR "\fIfputwc\fR\^(\|)",
  276. .IR "\fIfputws\fR\^(\|)",
  277. .IR "\fIfwide\fR\^(\|)",
  278. .IR "\fIfwprintf\fR\^(\|)",
  279. .IR "\fIfwscanf\fR\^(\|)",
  280. .IR "\fIgetwc\fR\^(\|)",
  281. .IR "\fIgetwchar\fR\^(\|)",
  282. .IR "\fIiswalnum\fR\^(\|)",
  283. .IR "\fIiswalpha\fR\^(\|)",
  284. .IR "\fIiswcntrl\fR\^(\|)",
  285. .IR "\fIiswctype\fR\^(\|)",
  286. .IR "\fIiswdigit\fR\^(\|)",
  287. .IR "\fIiswgraph\fR\^(\|)",
  288. .IR "\fIiswlower\fR\^(\|)",
  289. .IR "\fIiswprint\fR\^(\|)",
  290. .IR "\fIiswpunct\fR\^(\|)",
  291. .IR "\fIiswspace\fR\^(\|)",
  292. .IR "\fIiswupper\fR\^(\|)",
  293. .IR "\fIiswxdigit\fR\^(\|)",
  294. .IR "\fImbrlen\fR\^(\|)",
  295. .IR "\fImbrtowc\fR\^(\|)",
  296. .IR "\fImbsinit\fR\^(\|)",
  297. .IR "\fImbsrtowcs\fR\^(\|)",
  298. .IR "\fIopen_memstream\fR\^(\|)",
  299. .IR "\fIputwc\fR\^(\|)",
  300. .IR "\fIputwchar\fR\^(\|)",
  301. .IR "\fItowlower\fR\^(\|)",
  302. .IR "\fItowupper\fR\^(\|)",
  303. .IR "\fIungetwc\fR\^(\|)",
  304. .IR "\fIvfwprintf\fR\^(\|)",
  305. .IR "\fIvfwscanf\fR\^(\|)",
  306. .IR "\fIwcrtomb\fR\^(\|)",
  307. .IR "\fIwcscasecmp\fR\^(\|)",
  308. .IR "\fIwcscat\fR\^(\|)",
  309. .IR "\fIwcschr\fR\^(\|)",
  310. .IR "\fIwcscmp\fR\^(\|)",
  311. .IR "\fIwcscoll\fR\^(\|)",
  312. .IR "\fIwcscpy\fR\^(\|)",
  313. .IR "\fIwcscspn\fR\^(\|)",
  314. .IR "\fIwcsdup\fR\^(\|)",
  315. .IR "\fIwcsftime\fR\^(\|)",
  316. .IR "\fIwcslen\fR\^(\|)",
  317. .IR "\fIwcsncat\fR\^(\|)",
  318. .IR "\fIwcsncmp\fR\^(\|)",
  319. .IR "\fIwcsncpy\fR\^(\|)",
  320. .IR "\fIwcspbrk\fR\^(\|)",
  321. .IR "\fIwcsrchr\fR\^(\|)",
  322. .IR "\fIwcsrtombs\fR\^(\|)",
  323. .IR "\fIwcsspn\fR\^(\|)",
  324. .IR "\fIwcsstr\fR\^(\|)",
  325. .IR "\fIwcstod\fR\^(\|)",
  326. .IR "\fIwcstok\fR\^(\|)",
  327. .IR "\fIwcstol\fR\^(\|)",
  328. .IR "\fIwcstoul\fR\^(\|)",
  329. .IR "\fIwcswidth\fR\^(\|)",
  330. .IR "\fIwcsxfrm\fR\^(\|)",
  331. .IR "\fIwctob\fR\^(\|)",
  332. .IR "\fIwctype\fR\^(\|)",
  333. .IR "\fIwcwidth\fR\^(\|)",
  334. .IR "\fIwmemchr\fR\^(\|)",
  335. .IR "\fIwmemcmp\fR\^(\|)",
  336. .IR "\fIwmemcpy\fR\^(\|)",
  337. .IR "\fIwmemmove\fR\^(\|)",
  338. .IR "\fIwmemset\fR\^(\|)"
  339. .ad b
  340. .P
  341. The Shell and Utilities volume of POSIX.1\(hy2017,
  342. .IR "\fIgetconf\fR\^"
  343. .\"
  344. .SH COPYRIGHT
  345. Portions of this text are reprinted and reproduced in electronic form
  346. from IEEE Std 1003.1-2017, Standard for Information Technology
  347. -- Portable Operating System Interface (POSIX), The Open Group Base
  348. Specifications Issue 7, 2018 Edition,
  349. Copyright (C) 2018 by the Institute of
  350. Electrical and Electronics Engineers, Inc and The Open Group.
  351. In the event of any discrepancy between this version and the original IEEE and
  352. The Open Group Standard, the original IEEE and The Open Group Standard
  353. is the referee document. The original Standard can be obtained online at
  354. http://www.opengroup.org/unix/online.html .
  355. .PP
  356. Any typographical or formatting errors that appear
  357. in this page are most likely
  358. to have been introduced during the conversion of the source files to
  359. man page format. To report such errors, see
  360. https://www.kernel.org/doc/man-pages/reporting_bugs.html .