如何在 C# 中使用 Swig 包装 UTF-8 编码的 C++ std::strings？

我的问题几乎相同这个问题 https://stackoverflow.com/questions/16749871/how-to-make-swig-deal-with-utf8-strings-in-c，除了链接的问题处理 char* ，而我在代码中使用 std::string 。就像链接的问题一样，我也使用 C# 作为我的目标语言。

我有一个用 C++ 编写的类：

class MyClass
{
public:
    const std::string get_value() const; // returns utf8-string
    void set_value(const std::string &value); // sets utf8-string
private:
    // ...
};

这个 get 由 SWIG 用 C# 封装，如下所示：

public class MyClass
{
    public string get_value();
    public void set_value(string value);
}

SWIG 为我做了所有事情，除了它在调用 MyClass 期间不会进行 utf8 到 utf16 字符串转换。如果我的字符串可以用 ASCII 表示，那么它们就可以很好地处理，但是如果我尝试通过“set_value”和“get_value”来回传递带有非 ASCII 字符的字符串，最终会得到难以理解的字符。

如何使 SWIG 在 C# 中包装 UTF-8 编码的 C++ 字符串？注：我使用的是 std::string，而不是 std::wstring，也不是 char*。

有一个部分解决方案SWIG sourceforge 网站 http://sourceforge.net/p/swig/patches/249/，但它处理 char* 而不是 std::string，并且它使用（可配置的）固定长度缓冲区。

在（阅读：天才！）的帮助下大卫·杰斯克 http://www.codeproject.com/Articles/138614/Advanced-Topics-in-PInvoke-String-Marshaling在链接的代码项目文章中，我终于能够回答这个问题了。

您的 C# 库中需要此类（来自 David Jeske 的代码）。

public class UTF8Marshaler : ICustomMarshaler {
    static UTF8Marshaler static_instance;

    public IntPtr MarshalManagedToNative(object managedObj) {
        if (managedObj == null)
            return IntPtr.Zero;
        if (!(managedObj is string))
            throw new MarshalDirectiveException(
                   "UTF8Marshaler must be used on a string.");

        // not null terminated
        byte[] strbuf = Encoding.UTF8.GetBytes((string)managedObj); 
        IntPtr buffer = Marshal.AllocHGlobal(strbuf.Length + 1);
        Marshal.Copy(strbuf, 0, buffer, strbuf.Length);

        // write the terminating null
        Marshal.WriteByte(buffer + strbuf.Length, 0); 
        return buffer;
    }

    public unsafe object MarshalNativeToManaged(IntPtr pNativeData) {
        byte* walk = (byte*)pNativeData;

        // find the end of the string
        while (*walk != 0) {
            walk++;
        }
        int length = (int)(walk - (byte*)pNativeData);

        // should not be null terminated
        byte[] strbuf = new byte[length];  
        // skip the trailing null
        Marshal.Copy((IntPtr)pNativeData, strbuf, 0, length); 
        string data = Encoding.UTF8.GetString(strbuf);
        return data;
    }

    public void CleanUpNativeData(IntPtr pNativeData) {
        Marshal.FreeHGlobal(pNativeData);            
    }

    public void CleanUpManagedData(object managedObj) {
    }

    public int GetNativeDataSize() {
        return -1;
    }

    public static ICustomMarshaler GetInstance(string cookie) {
        if (static_instance == null) {
            return static_instance = new UTF8Marshaler();
        }
        return static_instance;
    }
}

然后，在 Swig 的“std_string.i”中，第 24 行替换这一行：

%typemap(imtype) string "string"

用这一行：

%typemap(imtype, inattributes="[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(UTF8Marshaler))]", outattributes="[return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(UTF8Marshaler))]") string "string"

在第 61 行，替换这一行：

%typemap(imtype) const string & "string"

用这一行：

%typemap(imtype, inattributes="[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(UTF8Marshaler))]", outattributes="[return: MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(UTF8Marshaler))]") string & "string"

你瞧，一切正常。阅读链接的文章以更好地了解其工作原理。