Print this page
2964 need POSIX 2008 locale object support
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Gordon Ross <gordon.ross@nexenta.com>
Approved by: TBD

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3c/mbsrtowcs.3c
          +++ new/usr/src/man/man3c/mbsrtowcs.3c
   1    1  '\" te
        2 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   2    3  .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.  Portions Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
   3    4  .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4    5  .\" http://www.opengroup.org/bookstore/.
   5    6  .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6    7  .\"  This notice shall appear on any product containing this material.
   7    8  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8    9  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9   10  .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10      -.TH MBSRTOWCS 3C "Nov 1, 2003"
       11 +.TH MBSRTOWCS 3C "Jun 28, 2014"
  11   12  .SH NAME
  12      -mbsrtowcs \- convert a character string to a wide-character string
  13      -(restartable)
       13 +mbsnrtwocs, mbsnrtowcs_l, mbsrtowcs, mbsrtowcs_l \- convert a character string
       14 +to a wide-character string (restartable)
  14   15  .SH SYNOPSIS
  15   16  .LP
  16   17  .nf
  17   18  #include <wchar.h>
  18   19  
       20 +\fBsize_t\fR \fBmbsnrtowcs\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
       21 +     \fBsize_t\fR \fInms\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
       22 +.fi
       23 +.LP
       24 +.nf
  19   25  \fBsize_t\fR \fBmbsrtowcs\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
  20   26       \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
  21   27  .fi
       28 +.LP
       29 +.nf
       30 +#include <wchar.h>
       31 +#include <xlocale.h>
  22   32  
       33 +\fBsize_t\fR \fBmbsnrtowcs_l\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
       34 +     \fBsize_t\fR \fInms\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
       35 +.fi
       36 +.LP
       37 +.nf
       38 +\fBsize_t\fR \fBmbsrtowcs_l\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
       39 +     \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
       40 +.fi
  23   41  .SH DESCRIPTION
  24      -.sp
  25   42  .LP
  26      -The \fBmbsrtowcs()\fR function converts a sequence of characters, beginning in
       43 +These function converts a sequence of characters, beginning in
  27   44  the conversion state described by the object pointed to by \fIps\fR, from the
  28   45  array indirectly pointed to by \fIsrc\fR into a sequence of corresponding
  29   46  wide-characters. If \fIdst\fR is not a null pointer, the converted characters
  30      -are stored into the array pointed to by  \fIdst\fR. Conversion continues up to
       47 +are stored into the array pointed to by \fIdst\fR. Conversion continues up to
  31   48  and including a terminating null character, which is also stored.  Conversion
  32   49  stops early in either of the following cases:
  33   50  .RS +4
  34   51  .TP
  35   52  .ie t \(bu
  36   53  .el o
  37   54  When a sequence of bytes is encountered that does not form a valid character.
  38   55  .RE
  39   56  .RS +4
  40   57  .TP
  41   58  .ie t \(bu
  42   59  .el o
  43   60  When \fIlen\fR codes have been stored into the array pointed to by \fIdst\fR
  44   61  (and  \fIdst\fR is not a null pointer).
  45   62  .RE
  46      -.sp
  47   63  .LP
  48   64  Each conversion takes place as if by a call to the \fBmbrtowc()\fR function.
  49      -.sp
  50   65  .LP
  51   66  If \fIdst\fR is not a null pointer, the pointer object pointed to by \fIsrc\fR
  52   67  is assigned either a null pointer (if conversion stopped due to reaching a
  53   68  terminating null character) or the address just past the last character
  54   69  converted (if any).  If conversion stopped due to reaching a terminating null
  55   70  character, and if \fIdst\fR is not a null pointer, the resulting state
  56   71  described is the initial conversion state.
  57      -.sp
  58   72  .LP
  59      -If \fIps\fR is a null pointer, the \fBmbsrtowcs()\fR function uses its own
       73 +If \fIps\fR is a null pointer, these functions uses their own
  60   74  internal \fBmbstate_t\fR object, which is initialized at program startup to the
  61      -initial conversion state.  Otherwise, the  \fBmbstate_t\fR object pointed to by
       75 +initial conversion state.  Otherwise, the \fBmbstate_t\fR object pointed to by
  62   76  \fIps\fR is used to completely describe the current conversion state of the
  63      -associated character sequence. Solaris will behave as if no function defined in
  64      -the Solaris Reference Manual calls \fBmbsrtowcs()\fR.
  65      -.sp
       77 +associated character sequence. The system will behave as if no function defined
       78 +in the Reference Manual calls any of these functions.
  66   79  .LP
  67      -The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  68      -current locale.  See \fBenviron\fR(5).
       80 +The function \fBmbsnrtowcs()\fR behaves identically to \fBmbsrtowcs()\fR,
       81 +except the conversion stops after reading \fInms\fR bytes from the
       82 +buffer pointed to by \fIsrc\fR.
       83 +.LP
       84 +The behavior of \fBmbnrtowcs()\fR and \fBmbsrtowcs()\fR functions are
       85 +affected by the \fBLC_CTYPE\fR category of the
       86 +current locale.  See \fBenviron\fR(5). The functions \fBmbsrtowcs_l()\fR and
       87 +\fBmbsnrtowcs_l()\fR behave identically to \fBmbsrtowcs()\fR and
       88 +\fBmbsnrtowcs()\fR, except that instead of using the current locale, they use
       89 +the locale specified by \fIloc\fR.
  69   90  .SH RETURN VALUES
  70      -.sp
  71   91  .LP
  72   92  If the input conversion encounters a sequence of bytes that do not form a valid
  73      -character, an encoding error occurs.  In this case, the \fBmbsrtowcs()\fR
  74      -function stores the value of the macro \fBEILSEQ\fR in \fBerrno\fR and returns
  75      -\fB(size_t)\(mi1\fR; the conversion state is undefined.  Otherwise, it returns
       93 +character, an encoding error occurs.  In this case, these
       94 +functions store the value of the macro \fBEILSEQ\fR in \fBerrno\fR and return
       95 +\fB(size_t)\(mi1\fR; the conversion state is undefined.  Otherwise, they return
  76   96  the number of characters successfully converted, not including the terminating
  77   97  null (if any).
  78   98  .SH ERRORS
  79      -.sp
  80   99  .LP
  81      -The \fBmbsrtowcs()\fR function may fail if:
      100 +Theses functions may fail if:
  82  101  .sp
  83  102  .ne 2
  84  103  .na
  85  104  \fB\fBEINVAL\fR\fR
  86  105  .ad
  87  106  .RS 10n
  88  107  The \fIps\fR argument points to an object that contains an invalid conversion
  89  108  state.
  90  109  .RE
  91  110  
  92  111  .sp
  93  112  .ne 2
  94  113  .na
  95  114  \fB\fBEILSEQ\fR\fR
  96  115  .ad
  97  116  .RS 10n
  98  117  Invalid character sequence is detected.
  99  118  .RE
 100      -
 101  119  .SH ATTRIBUTES
 102      -.sp
 103  120  .LP
 104  121  See \fBattributes\fR(5) for descriptions of the following attributes:
 105      -.sp
 106      -
 107      -.sp
 108  122  .TS
 109  123  box;
 110  124  c | c
 111  125  l | l .
 112  126  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113  127  _
 114      -Interface Stability     Standard
      128 +Interface Stability     See below.
 115  129  _
 116      -MT-Level        See NOTES below
      130 +MT-Level        See below.
 117  131  .TE
 118  132  
 119      -.SH SEE ALSO
 120      -.sp
 121  133  .LP
 122      -\fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5),
 123      -\fBenviron\fR(5), \fBstandards\fR(5)
 124      -.SH NOTES
 125      -.sp
      134 +The
      135 +.B mbsnrtowcs()
      136 +and
      137 +.B mbsrtowcs()
      138 +functions are Standard.  The 
      139 +.B mbsnrtowcs_l()
      140 +and
      141 +.B mbsrtowcs_l()
      142 +functions are Uncommitted.
 126  143  .LP
 127      -If \fIps\fR is not a null pointer, \fBmbsrtowcs()\fR uses the \fBmbstate_t\fR
 128      -object pointed to by \fIps\fR and the function can be used safely in
 129      -multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called
 130      -to change the locale. If \fIps\fR is a null pointer, \fBmbsrtowcs()\fR uses its
 131      -internal \fBmbstate_t\fR object and the function is Unsafe in multithreaded
      144 +If \fIps\fR is not a null pointer, these functions use the \fBmbstate_t\fR
      145 +object pointed to by \fIps\fR and can be used safely in
      146 +multithreaded applications, otherwise they use an
      147 +internal \fBmbstate_t\fR object and are Unsafe in multithreaded
 132  148  applications.
      149 +.SH SEE ALSO
      150 +.LP
      151 +\fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBnewlocale\fR(3C),
      152 +\fBsetlocale\fR(3C), \fBuselocale()\fR, \fBattributes\fR(5),
      153 +\fBenviron\fR(5), \fBstandards\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX