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/mbrlen.3c
          +++ new/usr/src/man/man3c/mbrlen.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 MBRLEN 3C "Nov 1, 2003"
       11 +.TH MBRLEN 3C "Jun 21, 2014"
  11   12  .SH NAME
  12      -mbrlen \- get number of bytes in a character (restartable)
       13 +mbrlen, mbrlen_l \- get number of bytes in a character (restartable)
  13   14  .SH SYNOPSIS
  14   15  .LP
  15   16  .nf
  16   17  #include <wchar.h>
  17   18  
  18   19  \fBsize_t\fR \fBmbrlen\fR(\fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR, \fBmbstate_t *restrict\fR \fIps\fR);
  19   20  .fi
       21 +.LP
       22 +.nf
       23 +#include <wchar.h>
       24 +#include <xlocale.h>
  20   25  
       26 +\fBsize_t\fR \fBmbrlen_l\fR(\fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR, \fBmbstate_t *restrict\fR \fIps\fR,
       27 +    \fBlocale_t\fR \fIloc\fR);
       28 +.fi
  21   29  .SH DESCRIPTION
  22      -.sp
  23   30  .LP
  24      -If \fIs\fR is not a null pointer,  \fBmbrlen()\fR determines the number of
  25      -bytes constituting the character pointed to by  \fIs\fR. It is equivalent to:
  26      -.sp
  27      -.in +2
       31 +If \fIs\fR is not a null pointer,  \fBmbrlen()\fR and \fBmbrlen_l()\fR determine
       32 +the number of bytes constituting the character pointed to by \fIs\fR.
       33 +The call
  28   34  .nf
       35 +.IP
       36 +\fBmbrlen\fR(\fIs\fR, \fIn\fR, \fIps\fR);
       37 +.fi
       38 +.LP
       39 +is equivalent to:
       40 +.nf
       41 +.IP
  29   42  mbstate_t internal;
  30      -mbrtowc(NULL, s, n, ps != NULL ? ps : &internal);
       43 +\fBmbrtowc\fR(NULL, \fIs\fR, \fIn\fR, \fIps\fR != NULL ? \fIps\fR : &internal);
  31   44  .fi
  32      -.in -2
  33      -
  34      -.sp
  35   45  .LP
  36      -If \fIps\fR is a null pointer, the \fBmbrlen()\fR function uses its own
       46 +If \fIps\fR is a null pointer, the \fBmbrlen()\fR and \fBmbrlen_l()\fR
       47 +functions use their own
  37   48  internal \fBmbstate_t\fR object, which is initialized at program startup to the
  38   49  initial conversion state.   Otherwise, the  \fBmbstate_t\fR object pointed to
  39   50  by \fIps\fR is used to completely describe the current conversion state of the
  40      -associated character sequence. Solaris will behave as if no function defined in
  41      -the Solaris Reference Manual calls \fBmbrlen()\fR.
  42      -.sp
       51 +associated character sequence. The implemenation will behave as if no function
       52 +defined in the Reference Manual calls \fBmbrlen()\fR.
  43   53  .LP
  44      -The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  45      -current locale.  See \fBenviron\fR(5).
       54 +The behavior of \fBmbrlen()\fR is affected by the \fBLC_CTYPE\fR category of the
       55 +current locale.  See \fBenviron\fR(5). The behavior of \fBmbrlen_l()\fR does not
       56 +use the current enivronment and instead uses the locale specified by \fBloc\fR.
  46   57  .SH RETURN VALUES
  47      -.sp
  48   58  .LP
  49      -The \fBmbrlen()\fR function returns the first of the following that applies:
       59 +The \fBmbrlen()\fR and \fBmbrlen_l()\fR functions return the first of the
       60 +following that applies:
  50   61  .sp
  51   62  .ne 2
  52   63  .na
  53   64  \fB\fB0\fR\fR
  54   65  .ad
  55   66  .RS 17n
  56   67  If the next \fIn\fR or fewer bytes complete the character that corresponds to
  57   68  the null wide-character.
  58   69  .RE
  59   70
↓ open down ↓ 25 lines elided ↑ open up ↑ 
  85   96  .na
  86   97  \fB\fB(size_t)\(mi1\fR\fR
  87   98  .ad
  88   99  .RS 17n
  89  100  If an encoding error occurs, in which case the next \fIn\fR or fewer bytes do
  90  101  not contribute to a complete and valid  character.  In this case, \fBEILSEQ\fR
  91  102  is stored in \fBerrno\fR and the conversion state is undefined.
  92  103  .RE
  93  104  
  94  105  .SH ERRORS
  95      -.sp
  96  106  .LP
  97      -The \fBmbrlen()\fR function may fail if:
      107 +The \fBmbrlen()\fR and \fBmbrlen_l()\fR functions may fail if:
  98  108  .sp
  99  109  .ne 2
 100  110  .na
 101  111  \fB\fBEINVAL\fR\fR
 102  112  .ad
 103  113  .RS 10n
 104  114  The \fIps\fR argument points to an object that contains an invalid conversion
 105  115  state.
 106  116  .RE
 107  117  
 108  118  .sp
 109  119  .ne 2
 110  120  .na
 111  121  \fB\fBEILSEQ\fR\fR
 112  122  .ad
 113  123  .RS 10n
 114  124  Invalid character sequence is detected.
 115  125  .RE
 116  126  
 117  127  .SH ATTRIBUTES
 118      -.sp
 119  128  .LP
 120  129  See \fBattributes\fR(5) for descriptions of the following attributes:
 121      -.sp
 122      -
 123      -.sp
 124  130  .TS
 125  131  box;
 126  132  c | c
 127  133  l | l .
 128  134  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129  135  _
 130      -Interface Stability     Standard
      136 +Interface Stability     See below.
 131  137  _
 132      -MT-Level        See NOTES below
      138 +MT-Level        MT-Safe
 133  139  .TE
 134  140  
      141 +.LP
      142 +The
      143 +.B mbrlen()
      144 +function is Standard.  The
      145 +.B mbrlen_l()
      146 +function is Uncommitted.
 135  147  .SH SEE ALSO
 136      -.sp
 137  148  .LP
 138      -\fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5),
      149 +\fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBnewlocale\fR(3C),
      150 +\fBsetlocale\fR(3C), \fBattributes\fR(5),
 139  151  \fBenviron\fR(5), \fBstandards\fR(5)
 140  152  .SH NOTES
 141  153  .sp
 142  154  .LP
 143  155  If \fIps\fR is not a null pointer, \fBmbrlen()\fR uses the \fBmbstate_t\fR
 144  156  object pointed to by \fIps\fR and the function can be used safely in
 145  157  multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called
 146      -to change the locale. If \fIps\fR is a null pointer, \fBmbrlen()\fR uses its
 147      -internal \fBmbstate_t\fR object and the function is Unsafe in multithreaded
 148      -applications.
      158 +to change the locale or a per-thread locale has been installed on the calling
      159 +thread with \fBuselocale\fR(3C). If \fIps\fR is a null pointer, \fBmbrlen()\fR
      160 +uses its internal \fBmbstate_t\fR object and the function is Unsafe in
      161 +multithreaded applications.
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX