[MWF] Fix unicode string handling from clipboard paste in X11

In the TextBoxTest.PasteTest () test case we copy the string "ABCD" to the clipboard.
We then try to paste it again and see if it's the same.

Internally in WinForms, the clipboard data is retrieved via an X11 API that returns
a pointer to the string. In this case, we have a unicode/utf16 string that usually
looks as follows in memory (2 byte per character):

65  'A'
0
-
66  'B'
0
-
67  'C'
0
-
68  'D'
0
-
0   '\0' end of string
0   potential garbage from here on
-
0
0
...

The bug is that we use Marshal.PtrToStringUni (), which reads until the
first null *char* not the first null *byte*.

Imagine if we get the following (happens sometimes):

65  'A'
0
-
66  'B'
0
-
67  'C'
0
-
68  'D'
0
-
0   '\0' end of string
230 <--- garbage, but considered part of a char by PtrToStringUni ()
-
47
56
-
74
43
...

This produces garbage like "ABCD㠯⭊" since PtrToStringUni () reads beyond the original string.

The fix is to use the nitems variable that is returned by the X11 API (it contains the
actual number of bytes in the string) and copy the bytes manually. We already do
the same for the UTF8 case above.

This fixes the TextBoxTest.PasteTest () that intermittently fails on Jenkins.

1 files changed, 4 insertions, 1 deletions

diff --git a/mcs/class/Managed.Windows.Forms/System.Windows.Forms/XplatUIX11.cs b/mcs/class/Managed.Windows.Forms/System.Windows.Forms/XplatUIX11.cs
index 657a42457c9..b0777b56026 100644
--- a/mcs/class/Managed.Windows.Forms/System.Windows.Forms/XplatUIX11.cs
+++ b/mcs/class/Managed.Windows.Forms/System.Windows.Forms/XplatUIX11.cs
@@ -1296,7 +1296,10 @@ namespace System.Windows.Forms {
 						buffer [i] = Marshal.ReadByte (prop, i);
 					Clipboard.Item = Encoding.UTF8.GetString (buffer);
 				} else if (property == UTF16_STRING) {
-					Clipboard.Item = Marshal.PtrToStringUni (prop);
+					byte [] buffer = new byte [(int)nitems];
+					for (int i = 0; i < (int)nitems; i++)
+						buffer [i] = Marshal.ReadByte (prop, i);
+					Clipboard.Item = Encoding.Unicode.GetString (buffer);
 				} else if (property == RICHTEXTFORMAT)
 					Clipboard.Item = Marshal.PtrToStringAnsi(prop);
 				else if (DataFormats.ContainsFormat (property.ToInt32 ())) {