From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f52.google.com (mail-wr1-f52.google.com [209.85.221.52]) by mx.groups.io with SMTP id smtpd.web08.10135.1607361643244987982 for ; Mon, 07 Dec 2020 09:20:43 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@nuviainc-com.20150623.gappssmtp.com header.s=20150623 header.b=TMPbe5oK; spf=pass (domain: nuviainc.com, ip: 209.85.221.52, mailfrom: leif@nuviainc.com) Received: by mail-wr1-f52.google.com with SMTP id a12so6730718wrv.8 for ; Mon, 07 Dec 2020 09:20:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nuviainc-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=PbSduc0A7VJBn0c+DWTQA7xWHCazV1VLfCI7wFipMi4=; b=TMPbe5oKeIA6xSiUPeKKiMePgAFj3KUWbCFn3//UwxKqLDzohBG55/a6qooJK7/5Bg NLbISvVlD0fA1cZpqCMUPcmUWhOz69ZbmjEELE/gr6GGvSf/cGOCuCkPxabOxpxNn7ak P4v5ZeqRS5Bb7z0wdHgVDyYlFnN1rhnCzEIkAPu1P1X3P4BDmGPeYMdBTAAg1NwyDlva hgCMSwM1mk7rY0arGlg7QVX37pslQC0eyrUVuoikfOWXuLOEZJJYoVmi8pMKtyA48eVO J1GRWTEwfrVBY0tqPcXi2GiLxRxZfcU5BFCD7atB798mrbHPqVBdguslF87YdhNViENx m06g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=PbSduc0A7VJBn0c+DWTQA7xWHCazV1VLfCI7wFipMi4=; b=ed+GHsCMCVBqJPT4m15InN1dvM1+PCjgQWGSDKywHv4PGburblSwXFQ6bT4D7QB1X3 4ZLIehp+5frV//KuM2+0XR1+fePGSeott19ilyk6TUMA9OFTBmc7MAdDU7ny15VOV28/ NhKOSwWeXcJXluw6V9208Wm+7SxovdjiTbRUhN0YNyIXzHJAen5+AFaXtyZJLVyqEuBg 3XtkRo+osFZmuiCgohtjrpWeEJwcQ8jnGXpycKuBL6Jq79IfvSBkda2knr3zx8U48d3u oK+w/Rkg338u1VVK9FG151uMzFUQsqm4+2PDol3HcfEr8pxz1lDFgCQAK3Y0A8c3jf3T 0TBQ== X-Gm-Message-State: AOAM530ot54K+2d54kv7yUXuHh8yTcy2ROG5s7bYkrOzbu4gZ2JNTD5D 0EG+gqvHnoYIIEL8Vsr33COfpA== X-Google-Smtp-Source: ABdhPJy6CesoUGe/vLHagTI1+U02eA22EbQ+bBWyFLXwqLqK9qLtaTHdJVUhlPJRpR3BRBJPjhUmwA== X-Received: by 2002:adf:e2ca:: with SMTP id d10mr17983271wrj.65.1607361641731; Mon, 07 Dec 2020 09:20:41 -0800 (PST) Return-Path: Received: from vanye (cpc1-cmbg19-2-0-cust915.5-4.cable.virginm.net. [82.27.183.148]) by smtp.gmail.com with ESMTPSA id h5sm5790726wrp.56.2020.12.07.09.20.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 07 Dec 2020 09:20:40 -0800 (PST) Date: Mon, 7 Dec 2020 17:20:39 +0000 From: "Leif Lindholm" To: "Wu, Hao A" Cc: "Chang, Abner (HPS SW/FW Technologist)" , "devel@edk2.groups.io" , Liming Gao , "Wang, Jian J" , "Wang, Nickle (HPS SW)" , "O'Hanley, Peter (EXL)" Subject: Re: [edk2-devel] [PATCH v4 1/6] MdeModulePkg/Ucs2Utf8lib: UCS2 to UFT8 manipulation library Message-ID: <20201207172039.GF1664@vanye> References: <20201207053655.29101-1-abner.chang@hpe.com> <20201207053655.29101-2-abner.chang@hpe.com> MIME-Version: 1.0 In-Reply-To: User-Agent: Mutt/1.10.1 (2018-07-13) Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Hi Hao Wu, On Mon, Dec 07, 2020 at 07:34:21 +0000, Wu, Hao A wrote: > > > For me, the Ucs2Utf8lib case is kind of similar with the jansson > > > library case for the Redfish feature. > > > If the current consumer is only the jansson library under the > > > RedfishPkg, I would suggest to put the Ucs2Utf8lib under RedfishPkg first. > > > We can move this library to a more generic place if there are more > > > consumers. > > > > > > Best Regards, > > > Hao Wu > > > > Hi Hao, I have no problem with this. Will send patches again. > > Thanks > > > Thanks Abner. > Leif and Liming, do you have comments on this? Thanks. I was the one who suggested Abner try to add it to MdeModulePkg, since it sounded to me like a generically useful thing to have. But I understand the argument that it should not live there until it is known to have multiple users, and I am OK with that. Best Regards, Leif > Best Regards, > Hao Wu > > > > > > > > > > > > > > > > > > Signed-off-by: Abner Chang > > > > > > > > Cc: Jian J Wang > > > > Cc: Hao A Wu > > > > Cc: Liming Gao > > > > Cc: Leif Lindholm > > > > Cc: Nickle Wang > > > > Cc: Peter O'Hanley > > > > --- > > > > .../Include/Library/BaseUcs2Utf8Lib.h | 69 +++ > > > > .../Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c | 417 > > > ++++++++++++++++++ > > > > .../BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf | 30 ++ > > > > MdeModulePkg/MdeModulePkg.dec | 5 + > > > > MdeModulePkg/MdeModulePkg.dsc | 2 + > > > > 5 files changed, 523 insertions(+) > > > > create mode 100644 MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > > > > create mode 100644 > > > > MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > > > > create mode 100644 > > > > MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > > > > > diff --git a/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > > > > b/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > > > > new file mode 100644 > > > > index 0000000000..51ae924929 > > > > --- /dev/null > > > > +++ b/MdeModulePkg/Include/Library/BaseUcs2Utf8Lib.h > > > > @@ -0,0 +1,69 @@ > > > > +/** @file > > > > + UCS2 to UTF8 manipulation library header file. > > > > + > > > > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> > > > + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
> > > > + > > > > + SPDX-License-Identifier: BSD-2-Clause-Patent > > > > + > > > > +**/ > > > > + > > > > +#ifndef BASE_UCS2UTF8_LIB_H_ > > > > +#define BASE_UCS2UTF8_LIB_H_ > > > > + > > > > +#include > > > > +#include > > > > +#include > > > > +#include > > > > +#include > > > > +#include > > > > +#include > > > > + > > > > +/// > > > > +/// L"\u0000" > > > > +/// > > > > +#define UNICODE_FORMAT_LEN 6 > > > > +#define UNICODE_FORMAT_CHAR_LEN 2 > > > > +#define UNICODE_FORMAT_CHAR_SIZE 3 > > > > + > > > > +#define UTF8_BUFFER_FOR_UCS2_MAX_SIZE 3 > > > > + > > > > +/** > > > > + Convert a UCS2 string to a UTF8 encoded string. > > > > + > > > > + @param[in] Ucs2Str The provided UCS2 string. > > > > + @param[out] Utf8StrAddr The converted UTF8 string address. > > > Caller > > > > + is responsible for Free this string. > > > > + > > > > + @retval EFI_INVALID_PARAMETER One or more parameters are > > > invalid. > > > > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > > > > + @retval EFI_SUCCESS The UTF8 encoded string has been > > > > converted. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +UCS2StrToUTF8 ( > > > > + IN CHAR16 *Ucs2Str, > > > > + OUT CHAR8 **Utf8StrAddr > > > > + ); > > > > + > > > > +/** > > > > + Convert a UTF8 encoded string to a UCS2 string. > > > > + > > > > + @param[in] Utf8Str The provided UTF8 encoded string. > > > > + @param[out] Ucs2StrAddr The converted UCS2 string address. > > > > Caller > > > > + is responsible for Free this string. > > > > + > > > > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not > > > valid > > > > to > > > > + convert to UCS2 string. > > > > + One or more parameters are invalid. > > > > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > > > > + @retval EFI_SUCCESS The UCS2 string has been converted. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +UTF8StrToUCS2 ( > > > > + IN CHAR8 *Utf8Str, > > > > + OUT CHAR16 **Ucs2StrAddr > > > > + ); > > > > + > > > > +#endif > > > > diff --git a/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > > > > b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > > > > new file mode 100644 > > > > index 0000000000..6cff109a5c > > > > --- /dev/null > > > > +++ b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c > > > > @@ -0,0 +1,417 @@ > > > > +/** @file > > > > + UCS2 to UTF8 manipulation library. > > > > + > > > > + Copyright (c) 2018 - 2019, Intel Corporation. All rights > > > > + reserved.
> > > > + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
> > > > + > > > > + SPDX-License-Identifier: BSD-2-Clause-Patent > > > > + > > > > +**/ > > > > + > > > > +#include > > > > + > > > > +/** > > > > + Since each UCS2 character can be represented by 1-3 UTF8 encoded > > > > +characters, > > > > + this function is used to retrieve the UTF8 encoding size for a > > > > +UCS2 > > > > character. > > > > + > > > > + @param[in] Utf8Buffer The buffer for UTF8 encoded data. > > > > + > > > > + @retval Return the size of UTF8 encoding string or 0 if it is not for > > > > + UCS2 format. > > > > + > > > > +**/ > > > > +UINT8 > > > > +GetUTF8SizeForUCS2 ( > > > > + IN CHAR8 *Utf8Buffer > > > > + ) > > > > +{ > > > > + CHAR8 TempChar; > > > > + UINT8 Utf8Size; > > > > + > > > > + ASSERT (Utf8Buffer != NULL); > > > > + > > > > + TempChar = *Utf8Buffer; > > > > + if ((TempChar & 0xF0) == 0xF0) { > > > > + > > > > + // > > > > + // This format is not for UCS2. > > > > + // > > > > + return 0; > > > > + } > > > > + > > > > + Utf8Size = 1; > > > > + if ((TempChar & 0x80) == 0x80) { > > > > + if ((TempChar & 0xC0) == 0xC0) { > > > > + > > > > + Utf8Size ++; > > > > + if ((TempChar & 0xE0) == 0xE0) { > > > > + > > > > + Utf8Size ++; > > > > + } > > > > + } > > > > + } > > > > + > > > > + return Utf8Size; > > > > +} > > > > + > > > > +/** > > > > + Since each UCS2 character can be represented by the format: > > > > +\uXXXX, this function > > > > + is used to retrieve the UCS2 character from a Unicode format. > > > > + Call MUST make sure there are at least 6 Bytes in the input UTF8 buffer. > > > > + > > > > + @param[in] Utf8Buffer The buffer for UTF8 encoded data. > > > > + @param[out] Ucs2Char The converted UCS2 character. > > > > + > > > > + @retval EFI_INVALID_PARAMETER Non-Ascii characters found in the > > > > hexadecimal > > > > + digits string, and can't be converted to a UCS2 > > > > + character. > > > > + @retval EFI_SUCCESS The UCS2 character has been retrieved. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +GetUCS2CharByFormat ( > > > > + IN CHAR8 *Utf8Buffer, > > > > + OUT CHAR16 *Ucs2Char > > > > + ) > > > > +{ > > > > + UINT8 Num1; > > > > + UINT8 Num2; > > > > + UINT8 Index; > > > > + CHAR8 Ucs2CharFormat[UNICODE_FORMAT_CHAR_SIZE]; /// two > > > > Hexadecimal digits Ascii string, like "3F" > > > > + > > > > + for (Index = 0; Index < 4; Index ++) { > > > > + if ((*(Utf8Buffer + 2 + Index) & 0x80) != 0x00) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + } > > > > + > > > > + ZeroMem (Ucs2CharFormat, UNICODE_FORMAT_CHAR_SIZE); > > > > + > > > > + // > > > > + // Get the First Number, Offset is 2 // CopyMem > > > > + (Ucs2CharFormat, Utf8Buffer + 2, > > > > UNICODE_FORMAT_CHAR_LEN); > > > > + Num1 = (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); > > > > + > > > > + // > > > > + // Get the Second Number, Offset is 4 // CopyMem > > > > + (Ucs2CharFormat, Utf8Buffer + 4, UNICODE_FORMAT_CHAR_LEN); > > > > + Num2 = (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); > > > > + > > > > + // > > > > + // Ucs2Char is Little-Endian > > > > + // > > > > + *((CHAR8 *) Ucs2Char) = Num2; > > > > + *(((CHAR8 *) Ucs2Char) + 1) = Num1; > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +/** > > > > + Convert a UCS2 character to UTF8 encoding string. > > > > + > > > > + @param[in] Ucs2Char The provided UCS2 character. > > > > + @param[out] Utf8Buffer The converted UTF8 encoded data. > > > > + > > > > + @retval Return the size of UTF8 encoding data for this UCS2 character. > > > > + > > > > +**/ > > > > +UINT8 > > > > +UCS2CharToUTF8 ( > > > > + IN CHAR16 Ucs2Char, > > > > + OUT CHAR8 *Utf8Buffer > > > > + ) > > > > +{ > > > > + UINT16 Ucs2Number; > > > > + > > > > + ASSERT (Utf8Buffer != NULL); > > > > + > > > > + Ucs2Number = (UINT16) Ucs2Char; > > > > + if (Ucs2Number <= 0x007F) { > > > > + > > > > + // > > > > + // UTF8 format: 0xxxxxxx > > > > + // > > > > + *Utf8Buffer = Ucs2Char & 0x7F; > > > > + return 1; > > > > + > > > > + } else if (Ucs2Number >= 0x0080 && Ucs2Number <= 0x07FF) { > > > > + > > > > + // > > > > + // UTF8 format: 110xxxxx 10xxxxxx > > > > + // > > > > + *(Utf8Buffer + 1) = (Ucs2Char & 0x3F) | 0x80; > > > > + *Utf8Buffer = ((Ucs2Char >> 6) & 0x1F) | 0xC0; > > > > + return 2; > > > > + > > > > + } else { /// Ucs2Number >= 0x0800 && Ucs2Number <= 0xFFFF > > > > + > > > > + // > > > > + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx > > > > + // > > > > + *(Utf8Buffer + 2) = (Ucs2Char & 0x3F) | 0x80; > > > > + *(Utf8Buffer + 1) = ((Ucs2Char >> 6) & 0x3F) | 0x80; > > > > + *Utf8Buffer = ((Ucs2Char >> 12) & 0x0F) | 0xE0; > > > > + return 3; > > > > + } > > > > +} > > > > + > > > > +/** > > > > + Convert a UTF8 encoded data to a UCS2 character. > > > > + > > > > + @param[in] Utf8Buffer The provided UTF8 encoded data. > > > > + @param[out] Ucs2Char The converted UCS2 character. > > > > + > > > > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not > > > valid > > > > or > > > > + not for UCS2 character. > > > > + @retval EFI_SUCCESS The converted UCS2 character. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +UTF8ToUCS2Char ( > > > > + IN CHAR8 *Utf8Buffer, > > > > + OUT CHAR16 *Ucs2Char > > > > + ) > > > > +{ > > > > + UINT8 Utf8Size; > > > > + CHAR8 *Ucs2Buffer; > > > > + CHAR8 TempChar1; > > > > + CHAR8 TempChar2; > > > > + CHAR8 TempChar3; > > > > + > > > > + ASSERT (Utf8Buffer != NULL && Ucs2Char != NULL); ZeroMem > > > > + (Ucs2Char, sizeof (CHAR16)); Ucs2Buffer = (CHAR8 *) Ucs2Char; > > > > + > > > > + Utf8Size = GetUTF8SizeForUCS2 (Utf8Buffer); switch (Utf8Size) { > > > > + > > > > + case 1: > > > > + > > > > + // > > > > + // UTF8 format: 0xxxxxxx > > > > + // > > > > + TempChar1 = *Utf8Buffer; > > > > + if ((TempChar1 & 0x80) != 0x00) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + *Ucs2Buffer = TempChar1; > > > > + *(Ucs2Buffer + 1) = 0; > > > > + break; > > > > + > > > > + case 2: > > > > + > > > > + // > > > > + // UTF8 format: 110xxxxx 10xxxxxx > > > > + // > > > > + TempChar1 = *Utf8Buffer; > > > > + if ((TempChar1 & 0xE0) != 0xC0) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + TempChar2 = *(Utf8Buffer + 1); > > > > + if ((TempChar2 & 0xC0) != 0x80) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + *Ucs2Buffer = (TempChar1 << 6) + (TempChar2 & 0x3F); > > > > + *(Ucs2Buffer + 1) = (TempChar1 >> 2) & 0x07; > > > > + break; > > > > + > > > > + case 3: > > > > + > > > > + // > > > > + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx > > > > + // > > > > + TempChar1 = *Utf8Buffer; > > > > + if ((TempChar1 & 0xF0) != 0xE0) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + TempChar2 = *(Utf8Buffer + 1); > > > > + if ((TempChar2 & 0xC0) != 0x80) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + TempChar3 = *(Utf8Buffer + 2); > > > > + if ((TempChar3 & 0xC0) != 0x80) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + *Ucs2Buffer = (TempChar2 << 6) + (TempChar3 & 0x3F); > > > > + *(Ucs2Buffer + 1) = (TempChar1 << 4) + ((TempChar2 >> 2) & > > > > + 0x0F); > > > > + > > > > + break; > > > > + > > > > + default: > > > > + > > > > + return EFI_INVALID_PARAMETER; } > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +/** > > > > + Convert a UCS2 string to a UTF8 encoded string. > > > > + > > > > + @param[in] Ucs2Str The provided UCS2 string. > > > > + @param[out] Utf8StrAddr The converted UTF8 string address. > > > Caller > > > > + is responsible for Free this string. > > > > + > > > > + @retval EFI_INVALID_PARAMETER One or more parameters are > > > invalid. > > > > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > > > > + @retval EFI_SUCCESS The UTF8 encoded string has been > > > > converted. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +UCS2StrToUTF8 ( > > > > + IN CHAR16 *Ucs2Str, > > > > + OUT CHAR8 **Utf8StrAddr > > > > + ) > > > > +{ > > > > + UINTN Ucs2StrIndex; > > > > + UINTN Ucs2StrLength; > > > > + CHAR8 *Utf8Str; > > > > + UINTN Utf8StrLength; > > > > + UINTN Utf8StrIndex; > > > > + CHAR8 Utf8Buffer[UTF8_BUFFER_FOR_UCS2_MAX_SIZE]; > > > > + UINT8 Utf8BufferSize; > > > > + > > > > + if (Ucs2Str == NULL || Utf8StrAddr == NULL) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + Ucs2StrLength = StrLen (Ucs2Str); Utf8StrLength = 0; > > > > + > > > > + for (Ucs2StrIndex = 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex > > > > + ++) { > > > > + > > > > + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); > > > > + Utf8BufferSize = UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], Utf8Buffer); > > > > + Utf8StrLength += Utf8BufferSize; } > > > > + > > > > + Utf8Str = AllocateZeroPool (Utf8StrLength + 1); if (Utf8Str == > > > > + NULL) { > > > > + return EFI_OUT_OF_RESOURCES; > > > > + } > > > > + > > > > + Utf8StrIndex = 0; > > > > + for (Ucs2StrIndex = 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex > > > > + ++) { > > > > + > > > > + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); > > > > + Utf8BufferSize = UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], > > > > + Utf8Buffer); > > > > + > > > > + CopyMem (Utf8Str + Utf8StrIndex, Utf8Buffer, Utf8BufferSize); > > > > + Utf8StrIndex += Utf8BufferSize; } > > > > + > > > > + Utf8Str[Utf8StrIndex] = '\0'; > > > > + *Utf8StrAddr = Utf8Str; > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > +/** > > > > + Convert a UTF8 encoded string to a UCS2 string. > > > > + > > > > + @param[in] Utf8Str The provided UTF8 encoded string. > > > > + @param[out] Ucs2StrAddr The converted UCS2 string address. > > > > Caller > > > > + is responsible for Free this string. > > > > + > > > > + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not > > > valid > > > > to > > > > + convert to UCS2 string. > > > > + One or more parameters are invalid. > > > > + @retval EFI_OUT_OF_RESOURCES System runs out of resources. > > > > + @retval EFI_SUCCESS The UCS2 string has been converted. > > > > + > > > > +**/ > > > > +EFI_STATUS > > > > +UTF8StrToUCS2 ( > > > > + IN CHAR8 *Utf8Str, > > > > + OUT CHAR16 **Ucs2StrAddr > > > > + ) > > > > +{ > > > > + EFI_STATUS Status; > > > > + UINTN Utf8StrIndex; > > > > + UINTN Utf8StrLength; > > > > + UINTN Ucs2StrIndex; > > > > + UINT8 Utf8BufferSize; > > > > + CHAR16 *Ucs2StrTemp; > > > > + > > > > + if (Utf8Str == NULL || Ucs2StrAddr == NULL) { > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + // > > > > + // It is not an Ascii string, calculate string length. > > > > + // > > > > + Utf8StrLength = 0; > > > > + while (*(Utf8Str + Utf8StrLength) != '\0') { > > > > + Utf8StrLength ++; > > > > + } > > > > + > > > > + // > > > > + // UCS2 string shall not be longer than the UTF8 string. > > > > + // > > > > + Ucs2StrTemp = AllocateZeroPool ((Utf8StrLength + 1) * sizeof > > > > + (CHAR16)); if (Ucs2StrTemp == NULL) { > > > > + return EFI_OUT_OF_RESOURCES; > > > > + } > > > > + > > > > + Utf8StrIndex = 0; > > > > + Ucs2StrIndex = 0; > > > > + while (Utf8Str[Utf8StrIndex] != '\0') { > > > > + > > > > + if (CompareMem (Utf8Str + Utf8StrIndex, "\\u", 2) == 0 && > > > > + Utf8StrLength - Utf8StrIndex >= UNICODE_FORMAT_LEN) { > > > > + > > > > + Status = GetUCS2CharByFormat (Utf8Str + Utf8StrIndex, > > > > + Ucs2StrTemp + > > > > Ucs2StrIndex); > > > > + if (!EFI_ERROR (Status)) { > > > > + > > > > + Utf8StrIndex += UNICODE_FORMAT_LEN; > > > > + Ucs2StrIndex ++; > > > > + } else { > > > > + > > > > + StrCpyS (Ucs2StrTemp + Ucs2StrIndex, 3, L"\\u"); > > > > + > > > > + Ucs2StrIndex += 2; > > > > + Utf8StrIndex += 2; > > > > + } > > > > + } else { > > > > + > > > > + Utf8BufferSize = GetUTF8SizeForUCS2 (Utf8Str + Utf8StrIndex); > > > > + if (Utf8BufferSize == 0 || Utf8StrLength - Utf8StrIndex < > > > > + Utf8BufferSize) { > > > > + > > > > + FreePool (Ucs2StrTemp); > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + Status = UTF8ToUCS2Char (Utf8Str + Utf8StrIndex, Ucs2StrTemp > > > > + + > > > > Ucs2StrIndex); > > > > + if (EFI_ERROR (Status)) { > > > > + > > > > + FreePool (Ucs2StrTemp); > > > > + return EFI_INVALID_PARAMETER; > > > > + } > > > > + > > > > + Ucs2StrIndex ++; > > > > + Utf8StrIndex += Utf8BufferSize; > > > > + } > > > > + } > > > > + > > > > + *Ucs2StrAddr = AllocateZeroPool ((Ucs2StrIndex + 1) * sizeof > > > > + (CHAR16)); if (*Ucs2StrAddr == NULL) { > > > > + > > > > + FreePool (Ucs2StrTemp); > > > > + return EFI_OUT_OF_RESOURCES; > > > > + } > > > > + > > > > + StrCpyS (*Ucs2StrAddr, Ucs2StrIndex + 1, Ucs2StrTemp); > > > > + *(*Ucs2StrAddr + Ucs2StrIndex) = L'\0'; FreePool (Ucs2StrTemp); > > > > + > > > > + return EFI_SUCCESS; > > > > +} > > > > + > > > > diff --git > > > > a/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > new file mode 100644 > > > > index 0000000000..93efb1fb88 > > > > --- /dev/null > > > > +++ b/MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > @@ -0,0 +1,30 @@ > > > > +## @file > > > > +# UCS2 to UTF8 manipulation library. > > > > +# > > > > +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# > > > > +(C) Copyright 2020 Hewlett Packard Enterprise Development LP
# > > > > +# SPDX-License-Identifier: BSD-2-Clause-Patent > > > > +# > > > > +## > > > > + > > > > +[Defines] > > > > + INF_VERSION = 0x0001001b > > > > + BASE_NAME = BaseUcs2Utf8Lib > > > > + FILE_GUID = 536646C3-46D0-4B12-ABC4-CDE1A33B5256 > > > > + MODULE_TYPE = BASE > > > > + VERSION_STRING = 1.0 > > > > + LIBRARY_CLASS = Ucs2Utf8Lib > > > > + > > > > +# > > > > +# VALID_ARCHITECTURES = IA32 X64 ARM AARCH64 RISCV64 > > > > +# > > > > + > > > > +[Sources.common] > > > > + BaseUcs2Utf8Lib.c > > > > + > > > > +[Packages] > > > > + MdePkg/MdePkg.dec > > > > + MdeModulePkg/MdeModulePkg.dec > > > > + > > > > + > > > > diff --git a/MdeModulePkg/MdeModulePkg.dec > > > > b/MdeModulePkg/MdeModulePkg.dec index 9b52b34494..1cd8c6392d > > > > 100644 > > > > --- a/MdeModulePkg/MdeModulePkg.dec > > > > +++ b/MdeModulePkg/MdeModulePkg.dec > > > > @@ -154,6 +154,11 @@ > > > > # > > > > VariablePolicyHelperLib|Include/Library/VariablePolicyHelperLib.h > > > > > > > > + ## @libraryclass This library provides UCS2 to UTF8 manipulation > > > > + # functions. > > > > + # > > > > + Ucs2Utf8Lib|Include/Library/BaseUcs2Utf8Lib.h > > > > + > > > > [Guids] > > > > ## MdeModule package token space guid > > > > # Include/Guid/MdeModulePkgTokenSpace.h > > > > diff --git a/MdeModulePkg/MdeModulePkg.dsc > > > > b/MdeModulePkg/MdeModulePkg.dsc index 90165ca443..85e2daeeea > > > > 100644 > > > > --- a/MdeModulePkg/MdeModulePkg.dsc > > > > +++ b/MdeModulePkg/MdeModulePkg.dsc > > > > @@ -43,6 +43,7 @@ > > > > PeCoffLib|MdePkg/Library/BasePeCoffLib/BasePeCoffLib.inf > > > > > > > > > > > PeCoffGetEntryPointLib|MdePkg/Library/BasePeCoffGetEntryPointLib/Base > > > > PeCoffGetEntryPointLib.inf > > > > SortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf > > > > + > > > > > > > Ucs2Utf8Lib|MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > # > > > > # UEFI & PI > > > > # > > > > @@ -212,6 +213,7 @@ > > > > MdeModulePkg/Application/MemoryProfileInfo/MemoryProfileInfo.inf > > > > > > > > MdeModulePkg/Library/UefiSortLib/UefiSortLib.inf > > > > + MdeModulePkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf > > > > MdeModulePkg/Logo/Logo.inf > > > > MdeModulePkg/Logo/LogoDxe.inf > > > > MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf > > > > -- > > > > 2.17.1 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >