Changeset 84286 in vbox for trunk/include/iprt

Timestamp:

May 13, 2020 1:58:21 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

137923

Message:

IPRT/base64: Added UTF-16 versions of the encoding functions. bugref:9224

Location:

trunk/include/iprt

Files:

• base64.h (modified) (4 diffs)
• mangling.h (modified) (1 diff)

trunk/include/iprt/base64.h ¶

@@ -143 +143 @@
  * data produced by RTBase64Encode().
  *
- * @returns The Base64 string length.
+ * @returns The Base64 string length, excluding the terminator.
  * @param   cbData      The number of bytes to encode.
  */
 RTDECL(size_t) RTBase64EncodedLength(size_t cbData);
+
+/**
+ * Calculates the UTF-16 length of the Base64 encoding of a given number of
+ * bytes of data produced by RTBase64EncodeUtf16().
+ *
+ * @returns The Base64 UTF-16 string length (in RTUTF16 units), excluding the
+ *          terminator.
+ * @param   cbData      The number of bytes to encode.
+ */
+RTDECL(size_t) RTBase64EncodedUtf16Length(size_t cbData);
 
 /**
@@ -152 +162 @@
  * data produced by RTBase64EncodeEx() with the same @a fFlags.
  *
- * @returns The Base64 string length.
+ * @returns The Base64 string length, excluding the terminator.
  * @param   cbData      The number of bytes to encode.
  * @param   fFlags      Flags, any combination of the RTBASE64_FLAGS \#defines.
  */
 RTDECL(size_t) RTBase64EncodedLengthEx(size_t cbData, uint32_t fFlags);
+
+/**
+ * Calculates the UTF-16 length of the Base64 encoding of a given number of
+ * bytes of data produced by RTBase64EncodeUtf16Ex() with the same @a fFlags.
+ *
+ * @returns The Base64 UTF-16 string length (in RTUTF16 units), excluding the
+ *          terminator.
+ * @param   cbData      The number of bytes to encode.
+ * @param   fFlags      Flags, any combination of the RTBASE64_FLAGS \#defines.
+ */
+RTDECL(size_t) RTBase64EncodedUtf16LengthEx(size_t cbData, uint32_t fFlags);
 
 /**
@@ -177 +198 @@
 
 /**
+ * Encodes the specifed data into a Base64 UTF-16 string, the caller supplies
+ * the output buffer.
+ *
+ * This is equivalent to calling RTBase64EncodeUtf16Ex() with no flags.
+ *
+ * @returns IRPT status code.
+ * @retval  VERR_BUFFER_OVERFLOW if the output buffer is too small. The buffer
+ *          may contain an invalid Base64 string.
+ *
+ * @param   pvData      The data to encode.
+ * @param   cbData      The number of bytes to encode.
+ * @param   pwszBuf     Where to put the Base64 UTF-16 string.
+ * @param   cwcBuf      The size of the output buffer in RTUTF16 units,
+ *                      including the terminator.
+ * @param   pcwcActual  The actual number of characters returned (excluding the
+ *                      terminator).  Optional.
+ */
+RTDECL(int) RTBase64EncodeUtf16(const void *pvData, size_t cbData, PRTUTF16 pwszBuf, size_t cwcBuf, size_t *pcwcActual);
+
+/**
  * Encodes the specifed data into a Base64 string, the caller supplies the
  * output buffer.
@@ -189 +230 @@
  * @param   pszBuf      Where to put the Base64 string.
  * @param   cbBuf       The size of the output buffer, including the terminator.
- * @param   pcchActual  The actual number of characters returned.
+ * @param   pcchActual  The actual number of characters returned (excluding the
+ *                      terminator).  Optional.
  */
 RTDECL(int) RTBase64EncodeEx(const void *pvData, size_t cbData, uint32_t fFlags,
                              char *pszBuf, size_t cbBuf, size_t *pcchActual);
 
+/**
+ * Encodes the specifed data into a Base64 UTF-16 string, the caller supplies
+ * the output buffer.
+ *
+ * @returns IRPT status code.
+ * @retval  VERR_BUFFER_OVERFLOW if the output buffer is too small. The buffer
+ *          may contain an invalid Base64 string.
+ *
+ * @param   pvData      The data to encode.
+ * @param   cbData      The number of bytes to encode.
+ * @param   fFlags      Flags, any combination of the RTBASE64_FLAGS \#defines.
+ * @param   pwszBuf     Where to put the Base64 UTF-16 string.
+ * @param   cwcBuf      The size of the output buffer in RTUTF16 units,
+ *                      including the terminator.
+ * @param   pcwcActual  The actual number of characters returned (excluding the
+ *                      terminator).  Optional.
+ */
+RTDECL(int) RTBase64EncodeUtf16Ex(const void *pvData, size_t cbData, uint32_t fFlags,
+                                  PRTUTF16 pwszBuf, size_t cwcBuf, size_t *pcwcActual);
+
+
 /** @}  */
 

trunk/include/iprt/mangling.h ¶

@@ -581 +581 @@
 # define RTBase64EncodedLength                          RT_MANGLER(RTBase64EncodedLength)
 # define RTBase64EncodedLengthEx                        RT_MANGLER(RTBase64EncodedLengthEx)
+# define RTBase64EncodeUtf16                            RT_MANGLER(RTBase64EncodeUtf16)
+# define RTBase64EncodeUtf16Ex                          RT_MANGLER(RTBase64EncodeUtf16Ex)
+# define RTBase64EncodedUtf16Length                     RT_MANGLER(RTBase64EncodedUtf16Length)
+# define RTBase64EncodedUtf16LengthEx                   RT_MANGLER(RTBase64EncodedUtf16LengthEx)
 # define RTBldCfgCompiler                               RT_MANGLER(RTBldCfgCompiler)
 # define RTBldCfgRevision                               RT_MANGLER(RTBldCfgRevision)