diff options
| author | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2012-06-15 19:58:39 +0000 |
|---|---|---|
| committer | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2012-06-15 19:58:39 +0000 |
| commit | a7a8363d86ec8ad445fb73619b1ca5cac4e56a86 (patch) | |
| tree | 2f395fe3d054f5036014cd7eb1f892d7d7333bb0 /StdLib/LibC/Locale/multibyte_Utf8.c | |
| parent | c7907ba2fa68a7515747385bf63b47f5e281c904 (diff) | |
StdLib: Add multi-byte character support. The normal "narrow" character set is now UTF-8 instead of ASCII.
Add library classes which are required by StdLib, but not commonly defined in Platform DSC files, to StdLib.inc.
Modify MB_LEN_MAX to be 4, the maximum length of UTF-8 characters.
Adjust size of internal buffers to be multiples of MB_LEN_MAX instead of assuming 1-byte characters.
Make the XYoffset object public and move its declaration into EfiSysCall.h.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: daryl.mcdaniel@intel.com
Reviewed-by: erik.c.bjorge@intel.com
Reviewed-by: lee.g.rosenbaum@intel.com
Reviewed-by: leroy.p.leahy@intel.com
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13457 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'StdLib/LibC/Locale/multibyte_Utf8.c')
| -rw-r--r-- | StdLib/LibC/Locale/multibyte_Utf8.c | 829 |
1 files changed, 829 insertions, 0 deletions
diff --git a/StdLib/LibC/Locale/multibyte_Utf8.c b/StdLib/LibC/Locale/multibyte_Utf8.c new file mode 100644 index 000000000..3f29f2942 --- /dev/null +++ b/StdLib/LibC/Locale/multibyte_Utf8.c @@ -0,0 +1,829 @@ +/** @file
+ Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+**/
+#include <assert.h>
+#include <string.h>
+#include <errno.h>
+#include <stdlib.h>
+#include <wchar.h>
+#include <sys/types.h>
+
+typedef int ch_UCS4;
+
+static mbstate_t LocalConvState = {0};
+
+/** Map a UTF-8 encoded prefix byte to a sequence length.
+ Zero means illegal prefix, but valid surrogate if < 0xC0.
+ One indicates an ASCII-7 equivalent character.
+ Two, three, and four are the first byte for 2, 3, and 4 byte sequences, respectively.
+ See RFC 3629 for details.
+
+ TABLE ENCODING:
+ Low Nibble decodes the first byte into the number of bytes in the sequence.
+ A value of zero indicates an invalid byte.
+ The High Nibble encodes a bit mask to be used to match against the high nibble of the second byte.
+
+ example:
+ SequenceLength = code[c0] & 0x0F;
+ Mask = 0x80 | code[c0];
+
+ Surrogate bytes are valid if: code[cX] & Mask > 0x80;
+
+*/
+static
+UINT8 utf8_code_length[256] = {
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, /* 00-0F */
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+ 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, /* 70-7F */
+ 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90, /* 80-8F */
+ 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, /* 90-9F */
+ 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, /* A0-AF */
+ 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, 0xC0, /* B0-BF */
+ 0x00, 0x00, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, /* C0-C1 + C2-CF */
+ 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, /* D0-DF */
+ 0x43, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x73, 0x33, 0x73, 0x73, /* E0-EF */
+ 0x64, 0x74, 0x74, 0x74, 0x14, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 /* F0-F4 + F5-FF */
+};
+
+/** Process one byte of a multibyte character.
+
+ @param ch
+ @param ps
+
+ @retval -2
+ @retval -1
+ @retval 1:4
+**/
+static
+int
+ProcessOneByte(unsigned char ch, mbstate_t *ps)
+{
+ UINT32 Mask;
+ UINT32 Length;
+ int RetVal = 0;
+
+ if(ps->A > 3) {
+ // We are in an invalid state
+ ps->A = 0; // Initial State
+ }
+ ps->C[ps->A] = ch; // Save the current character
+ Mask = utf8_code_length[ch];
+
+ if(ps->A == 0) { // Initial State. First byte of sequence.
+ ps->E = Mask | 0x80;
+ Length = Mask & 0xF;
+ switch(Length) {
+ case 0: // State 0, Code 0
+ errno = EILSEQ;
+ RetVal = -1;
+ ps->E = 1; // Consume this character
+ break;
+ case 1: // State 0, Code 1
+ // ASCII-7 Character
+ ps->B = ps->D[0] = ch;
+ RetVal = 1;
+ break;
+ default: // State 0, Code 2, 3, 4
+ ps->A = 1; // Next state is State-1
+ RetVal = -2; // Incomplete but potentially valid character
+ break;
+ }
+ }
+ else {
+ // We are in state 1, 2, or 3 and processing a surrogate byte
+ Length = ps->E & 0xF;
+ if((Mask & ps->E) > 0x80) {
+ // This byte is valid
+ switch(ps->A) { // Process based upon our current state
+ case 1: // Second byte of the sequence.
+ if(Length == 2) { // State 1, Code 2
+ Length = ((ps->C[0] & 0x1f) << 6) + (ps->C[1] & 0x3f);
+ assert ((Length > 0x007F) && (Length <= 0x07FF));
+ ps->B = ps->D[0] = (UINT16)Length;
+ ps->A = 0; // Next state is State-0
+ RetVal = 2;
+ }
+ else { // This isn't the last character, get more. State 1, Code 3 or 4
+ ps->A = 2;
+ RetVal = -2;
+ }
+ break;
+ case 2: // Third byte of the sequence
+ if(Length == 3) {
+ Length = ((ps->C[0] & 0x0f) << 12) + ((ps->C[1] & 0x3f) << 6) + (ps->C[2] & 0x3f);
+ assert ((Length > 0x07FF) && (Length <= 0xFFFF));
+ ps->B = ps->D[0] = (UINT16)Length;
+ ps->A = 0; // Next state is State-0
+ RetVal = 3;
+ }
+ else {
+ ps->A = 3;
+ RetVal = -2;
+ }
+ break;
+ case 3: // Fourth byte of the sequence
+ if(Length == 4) {
+ Length = ((ps->C[0] & 0x7) << 18) + ((ps->C[1] & 0x3f) << 12) +
+ ((ps->C[2] & 0x3f) << 6) + (ps->C[3] & 0x3f);
+ ps->B = Length;
+ assert ((Length > 0xFFFF) && (Length <= 0x10ffff));
+
+ /* compute and append the two surrogates: */
+
+ /* translate from 10000..10FFFF to 0..FFFF */
+ Length -= 0x10000;
+
+ /* high surrogate = top 10 bits added to D800 */
+ ps->D[0] = (UINT16)(0xD800 + (Length >> 10));
+
+ /* low surrogate = bottom 10 bits added to DC00 */
+ ps->D[1] = (UINT16)(0xDC00 + (Length & 0x03FF));
+ ps->A = 0; // Next state is State-0
+ RetVal = 4;
+ }
+ else {
+ errno = EILSEQ;
+ ps->A = 0;
+ RetVal = -1;
+ ps->E = 4; // Can't happen, but consume this character anyway
+ }
+ break;
+ }
+ }
+ else { // Invalid surrogate character
+ errno = EILSEQ;
+ ps->A = 0; // Next is State-0
+ RetVal = -1;
+ ps->E = 0; // Don't Consume, it may be an initial byte
+ }
+ }
+ return RetVal;
+}
+
+/** Convert one Multibyte sequence.
+
+ @param Dest
+ @param Src
+ @param Len
+ @param pS
+
+ @retval -2 Bytes processed comprise an incomplete, but potentially valid, character.
+ @retval -1 An encoding error was encountered. ps->E indicates the number of bytes consumed.
+ @retval 0 Either Src is NULL or it points to a NUL character.
+ @retval 1:N N bytes were consumed producing a valid wide character.
+**/
+int
+DecodeOneStateful(
+ wchar_t *Dest, // Pointer to output location, or NULL
+ const char *Src, // Multibyte Source (UTF8)
+ ssize_t Len, // Max Number of bytes to convert
+ mbstate_t *pS // Pointer to State struct., or NULL
+ )
+{
+ const char *SrcEnd;
+ int NumConv;
+ unsigned char ch;
+
+ if((Src == NULL) || (*Src == '\0')) {
+ return 0;
+ }
+ if(pS == NULL) {
+ pS = &LocalConvState;
+ }
+ SrcEnd = Src + Len;
+ NumConv = 0;
+ while(Src < SrcEnd) {
+ ch = (unsigned char)*Src++;
+ NumConv = ProcessOneByte(ch, pS);
+ if(NumConv != -2)
+ break;
+ }
+ if((NumConv > 0) && (Dest != NULL)) {
+ Dest[0] = pS->D[0];
+ if(NumConv == 4) {
+ Dest[1] = pS->D[1];
+ }
+ }
+ return NumConv;
+}
+
+/** Convert wide characters (UTF16) into multibyte characters (UTF8)
+
+ @param s Pointer to the wide-character string to convert
+ @param size Number of wide characters in s. size <= wcslen(s);
+
+ @return A newly allocated buffer containing the converted string is returned,
+ or NULL if an error occurred. Global variable errno contains more
+ information if NULL is returned.
+**/
+ssize_t
+EncodeUtf8(char *Dest, wchar_t *s, ssize_t size)
+{
+ char *p; /* next free byte in build buffer */
+ char *v; /* next free byte in destination */
+ ssize_t nneeded; /* number of result bytes needed */
+ int i; /* index into s of next input byte */
+ int NumInBuff; // number of bytes in Buff
+ char Buff[4]; // Buffer into which each character is built
+
+ assert(s != NULL);
+ assert(size >= 0);
+
+ v = Dest;
+ nneeded = 0;
+ if((size * MB_LEN_MAX) / MB_LEN_MAX != size) {
+ // size is too large and resulted in overflow when multiplied by MB_LEN_MAX
+ errno = EINVAL;
+ return (ssize_t)-1;
+ }
+
+ for (i = 0; i < size;) {
+ ch_UCS4 ch = s[i++];
+ p = Buff;
+
+ if (ch < 0x80) {
+ /* Encode ASCII -- One Byte */
+ *p++ = (char) ch;
+ }
+ else if (ch < 0x0800) {
+ /* Encode Latin-1 -- Two Byte */
+ *p++ = (char)(0xc0 | (ch >> 6));
+ *p++ = (char)(0x80 | (ch & 0x3f));
+ }
+ else {
+ /* Encode UCS2 Unicode ordinals -- Three Byte */
+ /* Special case: check for high surrogate -- Shouldn't happen in UEFI */
+ if (0xD800 <= ch && ch <= 0xDBFF && i < size) {
+ ch_UCS4 ch2 = s[i];
+ /* Check for low surrogate and combine the two to
+ form a UCS4 value */
+ if (0xDC00 <= ch2 && ch2 <= 0xDFFF) {
+ ch = ((ch - 0xD800) << 10 | (ch2 - 0xDC00)) + 0x10000;
+ i++;
+ /* Encode UCS4 Unicode ordinals -- Four Byte */
+ *p++ = (char)(0xf0 | (ch >> 18));
+ *p++ = (char)(0x80 | ((ch >> 12) & 0x3f));
+ *p++ = (char)(0x80 | ((ch >> 6) & 0x3f));
+ *p++ = (char)(0x80 | (ch & 0x3f));
+ continue;
+ }
+ /* Fall through: handles isolated high surrogates */
+ }
+ *p++ = (char)(0xe0 | (ch >> 12));
+ *p++ = (char)(0x80 | ((ch >> 6) & 0x3f));
+ *p++ = (char)(0x80 | (ch & 0x3f));
+ }
+ /* At this point, Buff holds the converted character which is NumInBuff bytes long.
+ NumInBuff is the value 1, 2, 3, or 4
+ */
+ NumInBuff = (int)(p - Buff); // Number of bytes in Buff
+ if(Dest != NULL) { // Save character if Dest is not NULL
+ memcpy(v, Buff, NumInBuff);
+ v += NumInBuff;
+ }
+ nneeded += NumInBuff; // Keep track of the number of bytes put into Dest
+ }
+ if(Dest != NULL) {
+ // Terminate the destination string.
+ *v = '\0';
+ }
+ return nneeded; // Tell the caller
+}
+
+// ######################## Narrow to Wide Conversions #######################
+
+/** If ps is not a null pointer, the mbsinit function determines whether the
+ pointed-to mbstate_t object describes an initial conversion state.
+
+ @return The mbsinit function returns nonzero if ps is a null pointer
+ or if the pointed-to object describes an initial conversion
+ state; otherwise, it returns zero.
+
+ Declared in: wchar.h
+**/
+int
+mbsinit(const mbstate_t *ps)
+{
+ if((ps == NULL) || (ps->A == 0)) {
+ return 1;
+ }
+ return 0;
+}
+
+/** The mbrlen function is equivalent to the call:<BR>
+@verbatim
+ mbrtowc(NULL, s, n, ps != NULL ? ps : &internal)
+@endverbatim
+ where internal is the mbstate_t object for the mbrlen function, except that
+ the expression designated by ps is evaluated only once.
+
+ @return The mbrlen function returns a value between zero and n,
+ inclusive, (size_t)(-2), or (size_t)(-1).
+
+ Declared in: wchar.h
+**/
+size_t
+mbrlen(
+ const char *s,
+ size_t n,
+ mbstate_t *ps
+ )
+{
+ return mbrtowc(NULL, s, n, ps);
+}
+
+/** Determine the number of bytes comprising a multibyte character.
+
+ If S is not a null pointer, the mblen function determines the number of bytes
+ contained in the multibyte character pointed to by S. Except that the
+ conversion state of the mbtowc function is not affected, it is equivalent to
+ mbtowc((wchar_t *)0, S, N);
+
+ @param[in] S NULL to query whether multibyte characters have
+ state-dependent encodings. Otherwise, points to a
+ multibyte character.
+ @param[in] N The maximum number of bytes in a multibyte character.
+
+ @return If S is a null pointer, the mblen function returns a nonzero or
+ zero value, if multibyte character encodings, respectively, do
+ or do not have state-dependent encodings. If S is not a null
+ pointer, the mblen function either returns 0 (if S points to the
+ null character), or returns the number of bytes that are contained
+ in the multibyte character (if the next N or fewer bytes form a
+ valid multibyte character), or returns -1 (if they do not form a
+ valid multibyte character).
+
+ Declared in: stdlib.h
+**/
+int
+mblen(
+ const char *s,
+ size_t n
+ )
+{
+ return (int)mbrlen(s, n, NULL);
+}
+
+/**
+If S is a null pointer, the mbrtowc function is equivalent to the call:<BR>
+@verbatim
+ mbrtowc(NULL, "", 1, ps)
+@endverbatim
+
+In this case, the values of the parameters pwc and n are ignored.
+
+If S is not a null pointer, the mbrtowc function inspects at most n bytes beginning with
+the byte pointed to by S to determine the number of bytes needed to complete the next
+multibyte character (including any shift sequences). If the function determines that the
+next multibyte character is complete and valid, it determines the value of the
+corresponding wide character and then, if pwc is not a null pointer, stores that value in
+the object pointed to by pwc. If the corresponding wide character is the null wide
+character, the resulting state described is the initial conversion state.
+
+ @retval 0 if the next n or fewer bytes complete the multibyte
+ character that corresponds to the null wide
+ character (which is the value stored).
+ @retval between_1_and_n_inclusive if the next n or fewer bytes complete
+ a valid multibyte character (which is the value
+ stored); the value returned is the number of bytes
+ that complete the multibyte character.
+ @retval (size_t)(-2) if the next n bytes contribute to an incomplete
+ (but potentially valid) multibyte character, and
+ all n bytes have been processed (no value is stored).
+ @retval (size_t)(-1) if an encoding error occurs, in which case the next
+ n or fewer bytes do not contribute to a complete and
+ valid multibyte character (no value is stored); the
+ value of the macro EILSEQ is stored in errno, and
+ the conversion state is unspecified.
+
+ Declared in: wchar.h
+**/
+size_t
+mbrtowc(
+ wchar_t *pwc,
+ const char *s,
+ size_t n,
+ mbstate_t *ps
+ )
+{
+ int RetVal;
+
+ RetVal = DecodeOneStateful(pwc, s, (ssize_t)n, ps);
+ return (size_t)RetVal;
+}
+
+/** Convert a multibyte character into a wide character.
+
+ If S is not a null pointer, the mbtowc function inspects at most N bytes
+ beginning with the byte pointed to by S to determine the number of bytes
+ needed to complete the next multibyte character (including any shift
+ sequences). If the function determines that the next multibyte character
+ is complete and valid, it determines the value of the corresponding wide
+ character and then, if Pwc is not a null pointer, stores that value in
+ the object pointed to by Pwc. If the corresponding wide character is the
+ null wide character, the function is left in the initial conversion state.
+
+ @param[out] Pwc Pointer to a wide-character object to receive the converted character.
+ @param[in] S Pointer to a multibyte character to convert.
+ @param[in] N Maximum number of bytes in a multibyte character.
+
+ @return If S is a null pointer, the mbtowc function returns a nonzero or
+ zero value, if multibyte character encodings, respectively, do
+ or do not have state-dependent encodings. If S is not a null
+ pointer, the mbtowc function either returns 0 (if S points to
+ the null character), or returns the number of bytes that are
+ contained in the converted multibyte character (if the next N or
+ fewer bytes form a valid multibyte character), or returns -1
+ (if they do not form a valid multibyte character).
+
+ In no case will the value returned be greater than N or the value
+ of the MB_CUR_MAX macro.
+
+ Declared in: stdlib.h
+**/
+int
+mbtowc(
+ wchar_t *pwc,
+ const char *s,
+ size_t n
+ )
+{
+ return (int)mbrtowc(pwc, s, n, NULL);
+}
+
+/**
+The mbsrtowcs function converts a sequence of multibyte characters that begins in the
+conversion state described by the object pointed to by ps, from the array indirectly
+pointed to by src into a sequence of corresponding wide characters. If dst is not a null
+pointer, the converted characters are stored into the array pointed to by dst. Conversion
+continues up to and including a terminating null character, which is also stored.
+Conversion stops earlier in two cases: when a sequence of bytes is encountered that does
+not form a valid multibyte character, or (if dst is not a null pointer) when len wide
+characters have been stored into the array pointed to by dst. Each conversion takes
+place as if by a call to the mbrtowc function.
+
+If dst is not a null pointer, the pointer object pointed to by src is assigned either a null
+pointer (if conversion stopped due to reaching a terminating null character) or the address
+just past the last multibyte character converted (if any). If conversion stopped due to
+reaching a terminating null character and if dst is not a null pointer, the resulting state
+described is the initial conversion state.
+
+ @return If the input conversion encounters a sequence of bytes that do
+ not form a valid multibyte character, an encoding error occurs:
+ the mbsrtowcs function stores the value of the macro EILSEQ in
+ errno and returns (size_t)(-1); the conversion state is
+ unspecified. Otherwise, it returns the number of multibyte
+ characters successfully converted, not including the terminating
+ null character (if any).
+
+ Declared in: wchar.h
+**/
+size_t
+mbsrtowcs(
+ wchar_t *dst,
+ const char **src,
+ size_t len,
+ mbstate_t *ps
+ )
+{
+ int x;
+ size_t RetVal = 0;
+ const char *MySrc;
+
+ if((src == NULL) || (*src == NULL) || (**src == '\0')) {
+ return 0;
+ }
+
+ MySrc = *src;
+ for(x = 1 ; (len != 0) && (x > 0); --len) {
+ x = DecodeOneStateful(dst, MySrc, MB_LEN_MAX, ps);
+ switch(x) {
+ case -2: // Incomplete character
+ case -1: // Encoding error
+ RetVal = (size_t)x;
+ break;
+ case 0: // Encountered NUL character: done.
+ if(dst != NULL) {
+ *dst = 0;
+ *src = NULL;
+ }
+ break;
+ default: // Successfully decoded a character, continue with next
+ MySrc += x;
+ if(dst != NULL) {
+ ++dst;
+ if(x == 4) {
+ ++dst;
+ }
+ *src = MySrc;
+ }
+ ++RetVal;
+ break;
+ }
+ }
+ return RetVal;
+}
+
+/** Convert a multibyte character string into a wide-character string.
+
+ The mbstowcs function converts a sequence of multibyte characters that
+ begins in the initial shift state from the array pointed to by Src into
+ a sequence of corresponding wide characters and stores not more than limit
+ wide characters into the array pointed to by Dest. No multibyte
+ characters that follow a null character (which is converted into a null
+ wide character) will be examined or converted. Each multibyte character
+ is converted as if by a call to the mbtowc function, except that the
+ conversion state of the mbtowc function is not affected.
+
+ No more than Limit elements will be modified in the array pointed to by Dest.
+ If copying takes place between objects that overlap,
+ the behavior is undefined.
+
+ @param[out] Dest Pointer to the array to receive the converted string.
+ @param[in] Src Pointer to the string to be converted.
+ @param[in] Limit Maximum number of elements to be written to Dest.
+
+ @return If an invalid multibyte character is encountered, the mbstowcs
+ function returns (size_t)(-1). Otherwise, the mbstowcs function
+ returns the number of array elements modified, not including a
+ terminating null wide character, if any.
+
+ Declared in: stdlib.h
+**/
+size_t
+mbstowcs(
+ wchar_t *pwcs,
+ const char *s,
+ size_t n
+ )
+{
+
+ /* pwcs may be NULL */
+ /* s may be NULL */
+
+ return mbsrtowcs(pwcs, &s, n, NULL);
+}
+
+/** The btowc function determines whether C constitutes a valid single-byte
+ character in the initial shift state.
+
+ @return The btowc function returns WEOF if c has the value EOF or if
+ (unsigned char)C does not constitute a valid single-byte
+ character in the initial shift state. Otherwise, it returns the
+ wide character representation of that character.
+
+ Declared in: wchar.h
+**/
+wint_t
+btowc(int c)
+{
+ int x;
+ wchar_t Dest;
+ wint_t RetVal = WEOF;
+
+ if (c == EOF)
+ return WEOF;
+ x = DecodeOneStateful(&Dest, (const char *)&c, 1, NULL);
+ if(x == 0) {
+ RetVal = 0;
+ }
+ else if(x == 1) {
+ RetVal = (wint_t)Dest;
+ }
+ return RetVal;
+}
+
+// ######################## Wide to Narrow Conversions #######################
+
+/**
+If S is a null pointer, the wcrtomb function is equivalent to the call:<BR>
+@verbatim
+ wcrtomb(buf, L'\0', ps)
+@endverbatim
+where buf is an internal buffer.
+
+If S is not a null pointer, the wcrtomb function determines the number of bytes needed
+to represent the multibyte character that corresponds to the wide character given by wc
+(including any shift sequences), and stores the multibyte character representation in the
+array whose first element is pointed to by S. At most MB_CUR_MAX bytes are stored. If
+wc is a null wide character, a null byte is stored, preceded by any shift sequence needed
+to restore the initial shift state; the resulting state described is the initial conversion state.
+
+ @return The wcrtomb function returns the number of bytes stored in the
+ array object (including any shift sequences). When wc is not a
+ valid wide character, an encoding error occurs: the function
+ stores the value of the macro EILSEQ in errno and
+ returns (size_t)(-1); the conversion state is unspecified.
+
+ Declared in: wchar.h
+**/
+size_t
+wcrtomb(
+ char *s,
+ wchar_t wchar,
+ mbstate_t *ps
+ )
+{
+ size_t RetVal;
+
+ /* s may be NULL */
+ if (s == NULL) {
+ RetVal = 1;
+ }
+ else {
+ if (wchar == L'\0') {
+ *s = '\0';
+ RetVal = 1;
+ }
+ else {
+ RetVal = EncodeUtf8(s, &wchar, 1);
+ }
+ }
+ return RetVal;
+}
+
+/** Convert a wide character into a multibyte character.
+
+ The wctomb function determines the number of bytes needed to represent the
+ multibyte character corresponding to the wide character given by WC
+ (including any shift sequences), and stores the multibyte character
+ representation in the array whose first element is pointed to by S (if S is
+ not a null pointer). At most MB_CUR_MAX characters are stored. If WC is a
+ null wide character, a null byte is stored, preceded by any shift sequence
+ needed to restore the initial shift state, and the function is left in the
+ initial conversion state.
+
+ @param[out] S Pointer to the object to receive the converted multibyte character.
+ @param[in] WC Wide character to be converted.
+
+ @return If S is a null pointer, the wctomb function returns a nonzero or
+ zero value, if multibyte character encodings, respectively, do or
+ do not have state-dependent encodings. If S is not a null pointer,
+ the wctomb function returns -1 if the value of WC does not
+ correspond to a valid multibyte character, or returns the number
+ of bytes that are contained in the multibyte character
+ corresponding to the value of WC.
+
+ In no case will the value returned be greater than the value of
+ the MB_CUR_MAX macro.
+
+ Declared in: stdlib.h
+**/
+int
+wctomb(
+ char *s,
+ wchar_t wchar
+ )
+{
+ /*
+ If s is NULL just return whether MB Characters have state
+ dependent encodings -- they don't.
+ */
+ if (s == NULL)
+ return 0;
+
+ return (int)wcrtomb(s, wchar, NULL);
+}
+
+/** The wcsrtombs function converts a sequence of wide characters from the array
+ indirectly pointed to by S into a sequence of corresponding multibyte
+ characters that begins in the conversion state described by the object
+ pointed to by ps.
+
+ If S is not a null pointer, the converted characters
+ are then stored into the array pointed to by S. Conversion continues
+ up to and including a terminating null wide character, which is also
+ stored. Conversion stops earlier in two cases: when a wide character is
+ reached that does not correspond to a valid multibyte character, or
+ (if S is not a null pointer) when the next multibyte character would
+ exceed the limit of N total bytes to be stored into the array pointed
+ to by S. Each conversion takes place as if by a call to the wcrtomb
+ function.)
+
+ If S is not a null pointer, the pointer object pointed to by pwcs is
+ assigned either a null pointer (if conversion stopped due to reaching
+ a terminating null wide character) or the address just past the last wide
+ character converted (if any). If conversion stopped due to reaching a
+ terminating null wide character, the resulting state described is the
+ initial conversion state.
+
+ @return If conversion stops because a wide character is reached that
+ does not correspond to a valid multibyte character, an
+ encoding error occurs: the wcsrtombs function stores the
+ value of the macro EILSEQ in errno and returns (size_t)(-1);
+ the conversion state is unspecified. Otherwise, it returns
+ the number of bytes in the resulting multibyte character
+ sequence, not including the terminating null character (if any).
+
+ Declared in: wchar.h
+**/
+size_t
+wcsrtombs(
+ char *s,
+ const wchar_t **pwcs,
+ size_t n,
+ mbstate_t *ps
+)
+{
+ int count = 0;
+
+ /* s may be NULL */
+ /* pwcs may be NULL */
+ /* ps appears to be unused */
+
+ if (pwcs == NULL || *pwcs == NULL)
+ return (0);
+
+ if (s == NULL) {
+ while (*(*pwcs)++ != 0)
+ count++;
+ return(count);
+ }
+
+ if (n != 0) {
+ do {
+ if ((*s++ = (char) *(*pwcs)++) == 0) {
+ *pwcs = NULL;
+ break;
+ }
+ count++;
+ } while (--n != 0);
+ }
+
+ return count;
+}
+
+/** Convert a wide-character string into a multibyte character string.
+
+ The wcstombs function converts a sequence of wide characters from the
+ array pointed to by Src into a sequence of corresponding multibyte
+ characters that begins in the initial shift state, and stores these
+ multibyte characters into the array pointed to by Dest, stopping if a
+ multibyte character would exceed the limit of Limit total bytes or if a
+ null character is stored. Each wide character is converted as if by
+ a call to the wctomb function, except that the conversion state of
+ the wctomb function is not affected.
+
+ No more than Limit bytes will be modified in the array pointed to by Dest.
+ If copying takes place between objects that overlap,
+ the behavior is undefined.
+
+ @param[out] Dest Pointer to the array to receive the converted string.
+ @param[in] Src Pointer to the string to be converted.
+ @param[in] Limit Maximum number of elements to be written to Dest.
+
+ @return If a wide character is encountered that does not correspond to a
+ valid multibyte character, the wcstombs function returns
+ (size_t)(-1). Otherwise, the wcstombs function returns the number
+ of bytes modified, not including a terminating null character,
+ if any.
+
+ Declared in: stdlib.h
+**/
+size_t
+wcstombs(
+ char *s,
+ const wchar_t *pwcs,
+ size_t n
+)
+{
+ /* s may be NULL */
+ return wcsrtombs(s, &pwcs, n, NULL);
+}
+
+/** The wctob function determines whether C corresponds to a member of the extended
+ character set whose multibyte character representation is a single byte when in the initial
+ shift state.
+
+ @return The wctob function returns EOF if C does not correspond to a multibyte
+ character with length one in the initial shift state. Otherwise, it
+ returns the single-byte representation of that character as an
+ unsigned char converted to an int.
+
+ Declared in: wchar.h
+**/
+int
+wctob(wint_t c)
+{
+ /* wctob needs to be consistent with wcrtomb.
+ if wcrtomb says that a character is representable in 1 byte,
+ which this implementation always says, then wctob needs to
+ also represent the character as 1 byte.
+ */
+ if (c == WEOF) {
+ return EOF;
+ }
+ return (int)(c & 0xFF);
+}
|