Changeset 85845 in vbox for trunk/include/VBox

Timestamp:

Aug 20, 2020 2:28:33 PM (5 years ago)

Author:

vboxsync

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

140013

Message:

Shared Clipboard/X11: Fixes for empty strings (was too strict before), don't include the terminating zeros when return string lengths to match IPRT. Also should fix the testcases.

File:

• trunk/include/VBox/GuestHost/clipboard-helper.h (modified) (9 diffs)

trunk/include/VBox/GuestHost/clipboard-helper.h

@@ -54 +54 @@
  * @param   pcwszSrc            UTF-16 string to return size for.
  * @param   cwcSrc              Length of the string in RTUTF16 units.
- * @param   pchLen              Where to return the length (in UTF-8 characters). Includes terminator.
+ * @param   pchLen              Where to return the length (in UTF-8 characters).
+ *                              Does not include terminator.
  */
 int ShClUtf16LFLenUtf8(PCRTUTF16 pcwszSrc, size_t cwcSrc, size_t *pchLen);
@@ -64 +65 @@
  * @param   pcwszSrc            UTF-16 string to return size for.
  * @param   cwcSrc              Length of the source string in RTUTF16 units.
- * @param   pchLen              Where to return the length (in UTF-8 characters). Includes terminator.
+ * @param   pchLen              Where to return the length (in UTF-8 characters).
+ *                              Does not include terminator.
  */
 int ShClUtf16CRLFLenUtf8(PCRTUTF16 pcwszSrc, size_t cwcSrc, size_t *pchLen);
@@ -74 +76 @@
  * @param  pcwszSrc             UTF-16 string to return size for.
  * @param  cwcSrc               Length of the source string in RTUTF16 units.
- * @param  pchLen               Where to return the length (in UTF-8 characters). Includes terminator.
+ * @param  pchLen               Where to return the length (in UTF-8 characters).
+ *                              Does not include terminator.
  */
 int ShClUtf16LenUtf8(PCRTUTF16 pcwszSrc, size_t cwcSrc, size_t *pchLen);
@@ -85 +88 @@
  * @param   cwcSrc              Size of the string int RTUTF16 units.
  * @param   pwszDst             Buffer to store the converted string to.
- * @param   cwcDst              Size of the buffer for the converted string in RTUTF16 units. Includes terminator.
+ * @param   cwcDst              The size of \a pwszDst in RTUTF16 units.
  */
 int ShClConvUtf16LFToCRLF(PCRTUTF16 pcwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
@@ -98 +101 @@
  * @param   cwcSrc              Size of the string int RTUTF16 units.
  * @param   ppwszDst            Where to return the allocated converted string. Must be free'd by the caller.
- * @param   pcwDst              Where to return the size of the converted string in RTUTF16 units. Includes terminator.
+ * @param   pcwDst              Where to return the size of the converted string in RTUTF16 units.
+ *                              Does not include the terminator.
  */
 int ShClConvUtf16LFToCRLFA(PCRTUTF16 pcwszSrc, size_t cwcSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
@@ -109 +113 @@
  * @param   cwcSrc              Size of the string in RTUTF16 units.
  * @param   pwszDst             Where to store the converted string to.
- * @param   cwcDst              The size of \a pwszDst in RTUTF16 chars. Includes terminator.
+ * @param   cwcDst              The size of \a pwszDst in RTUTF16 units.
  */
 int ShClConvUtf16CRLFToLF(PCRTUTF16 pcwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
@@ -121 +125 @@
  * @param  pszBuf               Where to write the converted string.
  * @param  cbBuf                The size of the buffer pointed to by @a pszBuf.
- * @param  pcbLen               Where to store the size (in bytes) of the converted string. Includes terminator.
+ * @param  pcbLen               Where to store the size (in bytes) of the converted string.
+ *                              Does not include terminator.
  */
 int ShClConvUtf16CRLFToUtf8LF(PCRTUTF16 pcwszSrc, size_t cbSrc, char *pszBuf, size_t cbBuf, size_t *pcbLen);
@@ -143 +148 @@
  * @param  cbSrc                Size of UTF-8 string to convert (in bytes), not counting the terminating zero.
  * @param  ppwszDst             Where to return the allocated buffer on success.
- * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success. Includes terminator.
- */
-int ShClConvUtf8LFToUtf16CRLF(const char *pcszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
+ * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success.
+ *                              Does not include terminator.
+ */
+int ShClConvUtf8LFToUtf16CRLF(const char *pcszSrc, size_t cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
 
 /**
@@ -154 +160 @@
  * @param  cbSrc                Size of string (in bytes), not counting the terminating zero.
  * @param  ppwszDst             Where to return the allocated buffer on success.
- * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success. Includes terminator.
- */
-int ShClConvLatin1LFToUtf16CRLF(const char *pcszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
+ * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success.
+ *                              Does not include terminator.
+ */
+int ShClConvLatin1LFToUtf16CRLF(const char *pcszSrc, size_t cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
 
 #pragma pack(1)