man3/mbstowcs.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\" and Copyright 2014 Michael Kerrisk <mtk.manpages@gmail.com>
   4 .\"
   5 .\" SPDX-License-Identifier: GPL-2.0-or-later
   6 .\"
   7 .\" References consulted:
   8 .\"   GNU glibc-2 source code and manual
   9 .\"   Dinkumware C library reference http://www.dinkumware.com/
  10 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  11 .\"   ISO/IEC 9899:1999
  12 .\"
  13 .TH mbstowcs 3 (date) "Linux man-pages (unreleased)"
  14 .SH NAME
  15 mbstowcs \- convert a multibyte string to a wide-character string
  16 .SH LIBRARY
  17 Standard C library
  18 .RI ( libc ", " \-lc )
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <stdlib.h>
  22 .P
  23 .BI "size_t mbstowcs(wchar_t " dest "[restrict ." n "], \
  24 const char *restrict " src ,
  25 .BI "                size_t " n );
  26 .fi
  27 .SH DESCRIPTION
  28 If
  29 .I dest
  30 is not NULL,
  31 the
  32 .BR mbstowcs ()
  33 function converts the
  34 multibyte string
  35 .I src
  36 to a wide-character string starting at
  37 .IR dest .
  38 At most
  39 .I n
  40 wide characters are written to
  41 .IR dest .
  42 The sequence of characters in the string
  43 .I src
  44 shall begin in the initial shift state.
  45 The conversion can stop for three reasons:
  46 .IP \[bu] 3
  47 An invalid multibyte sequence has been encountered.
  48 In this case,
  49 .I (size_t)\ \-1
  50 is returned.
  51 .IP \[bu]
  52 .I n
  53 non-L\[aq]\e0\[aq] wide characters have been stored at
  54 .IR dest .
  55 In this case, the number of wide characters written to
  56 .I dest
  57 is returned, but the
  58 shift state at this point is lost.
  59 .IP \[bu]
  60 The multibyte string has been completely converted, including the
  61 terminating null character (\[aq]\e0\[aq]).
  62 In this case, the number of wide characters written to
  63 .IR dest ,
  64 excluding the terminating null wide character, is returned.
  65 .P
  66 The programmer must ensure that there is room for at least
  67 .I n
  68 wide
  69 characters at
  70 .IR dest .
  71 .P
  72 If
  73 .I dest
  74 is NULL,
  75 .I n
  76 is ignored, and the conversion proceeds as
  77 above, except that the converted wide characters are not written out to memory,
  78 and that no length limit exists.
  79 .P
  80 In order to avoid the case 2 above, the programmer should make sure
  81 .I n
  82 is
  83 greater than or equal to
  84 .IR "mbstowcs(NULL,src,0)+1" .
  85 .SH RETURN VALUE
  86 The
  87 .BR mbstowcs ()
  88 function returns the number of wide characters that make
  89 up the converted part of the wide-character string, not including the
  90 terminating null wide character.
  91 If an invalid multibyte sequence was
  92 encountered,
  93 .I (size_t)\ \-1
  94 is returned.
  95 .SH ATTRIBUTES
  96 For an explanation of the terms used in this section, see
  97 .BR attributes (7).
  98 .TS
  99 allbox;
 100 lbx lb lb
 101 l l l.
 102 Interface       Attribute       Value
 103 T{
 104 .na
 105 .nh
 106 .BR mbstowcs ()
 107 T}      Thread safety   MT-Safe
 108 .TE
 109 .SH VERSIONS
 110 The function
 111 .BR mbsrtowcs (3)
 112 provides a better interface to the same
 113 functionality.
 114 .SH STANDARDS
 115 C11, POSIX.1-2008.
 116 .SH HISTORY
 117 POSIX.1-2001, C99.
 118 .SH NOTES
 119 The behavior of
 120 .BR mbstowcs ()
 121 depends on the
 122 .B LC_CTYPE
 123 category of the
 124 current locale.
 125 .SH EXAMPLES
 126 The program below illustrates the use of
 127 .BR mbstowcs (),
 128 as well as some of the wide character classification functions.
 129 An example run is the following:
 130 .P
 131 .in +4n
 132 .EX
 133 $ ./t_mbstowcs de_DE.UTF\-8 Grüße!
 134 Length of source string (excluding terminator):
 135     8 bytes
 136     6 multibyte characters
 137 \&
 138 Wide character string is: Grüße! (6 characters)
 139     G alpha upper
 140     r alpha lower
 141     ü alpha lower
 142     ß alpha lower
 143     e alpha lower
 144     ! !alpha
 145 .EE
 146 .in
 147 .SS Program source
 148 \&
 149 .\" SRC BEGIN (mbstowcs.c)
 150 .EX
 151 #include <locale.h>
 152 #include <stdio.h>
 153 #include <stdlib.h>
 154 #include <string.h>
 155 #include <wchar.h>
 156 #include <wctype.h>
 157 \&
 158 int
 159 main(int argc, char *argv[])
 160 {
 161     size_t mbslen;      /* Number of multibyte characters in source */
 162     wchar_t *wcs;       /* Pointer to converted wide character string */
 163 \&
 164     if (argc < 3) {
 165         fprintf(stderr, "Usage: %s <locale> <string>\en", argv[0]);
 166         exit(EXIT_FAILURE);
 167     }
 168 \&
 169     /* Apply the specified locale. */
 170 \&
 171     if (setlocale(LC_ALL, argv[1]) == NULL) {
 172         perror("setlocale");
 173         exit(EXIT_FAILURE);
 174     }
 175 \&
 176     /* Calculate the length required to hold argv[2] converted to
 177        a wide character string. */
 178 \&
 179     mbslen = mbstowcs(NULL, argv[2], 0);
 180     if (mbslen == (size_t) \-1) {
 181         perror("mbstowcs");
 182         exit(EXIT_FAILURE);
 183     }
 184 \&
 185     /* Describe the source string to the user. */
 186 \&
 187     printf("Length of source string (excluding terminator):\en");
 188     printf("    %zu bytes\en", strlen(argv[2]));
 189     printf("    %zu multibyte characters\en\en", mbslen);
 190 \&
 191     /* Allocate wide character string of the desired size.  Add 1
 192        to allow for terminating null wide character (L\[aq]\e0\[aq]). */
 193 \&
 194     wcs = calloc(mbslen + 1, sizeof(*wcs));
 195     if (wcs == NULL) {
 196         perror("calloc");
 197         exit(EXIT_FAILURE);
 198     }
 199 \&
 200     /* Convert the multibyte character string in argv[2] to a
 201        wide character string. */
 202 \&
 203     if (mbstowcs(wcs, argv[2], mbslen + 1) == (size_t) \-1) {
 204         perror("mbstowcs");
 205         exit(EXIT_FAILURE);
 206     }
 207 \&
 208     printf("Wide character string is: %ls (%zu characters)\en",
 209            wcs, mbslen);
 210 \&
 211     /* Now do some inspection of the classes of the characters in
 212        the wide character string. */
 213 \&
 214     for (wchar_t *wp = wcs; *wp != 0; wp++) {
 215         printf("    %lc ", (wint_t) *wp);
 216 \&
 217         if (!iswalpha(*wp))
 218             printf("!");
 219         printf("alpha ");
 220 \&
 221         if (iswalpha(*wp)) {
 222             if (iswupper(*wp))
 223                 printf("upper ");
 224 \&
 225             if (iswlower(*wp))
 226                 printf("lower ");
 227         }
 228 \&
 229         putchar(\[aq]\en\[aq]);
 230     }
 231 \&
 232     exit(EXIT_SUCCESS);
 233 }
 234 .EE
 235 .\" SRC END
 236 .SH SEE ALSO
 237 .BR mblen (3),
 238 .BR mbsrtowcs (3),
 239 .BR mbtowc (3),
 240 .BR wcstombs (3),
 241 .BR wctomb (3)