使用 SWIG，如何将 C++ void func(Class& out) 包装为 C# Class func()？

（不幸的是，SWIG 的文档非常难以解析，而且在线示例似乎很少。所以我来到这里。）

假设 C++ 函数对类类型使用以下典型返回样式：

void func(Class& out);

使用 SWIG，这个函数应该像这样用 C# 包装：

Class func();

根据我的发现，我可以使用类型映射来完成此任务。

假装那样Class实际上是int，我根据我发现的示例尝试了以下操作：

%include <typemaps.i>

%{
void func(int& pOut);
%}

%apply int &OUTPUT { int &pOut }
void func(int& pOut);

许多示例（不过倾向于 Python）表明这应该创建一个不带参数的函数，该函数输出int.

但是，我使用了以下命令行：

swig.exe -namespace Test -o .\Test.cxx -c++ -module Test -csharp -outdir . test.i

这输出以下 Test.cs：

namespace Test {

using System;
using System.Runtime.InteropServices;

public class Test {
  public static void func(out int pOut) {
    TestPINVOKE.func(out pOut);
  }

}

}

如何实现我想要的函数签名，以及如何将其转换为对象类型？

看来我找到了一种方法来做到这一点具体来说在 C# 中，尽管它应该可以扩展到其他语言。

考虑这个 SWIG 界面，我在其中添加了额外的参数以获得戏剧性的效果：

%include <typemaps.i>

%{
class MyClass{};
void func(MyClass& pOut, int x);
MyClass* func2(int x);
%}

%typemap(ctype, out="void *") void func ""
%typemap(imtype, out="global::System.IntPtr") void func ""
%typemap(cstype, out="MyClass") void func ""
%typemap(in, numinputs=0, noblock=1) MyClass &pOut
{
    $1 = new MyClass();
}
%typemap(argout, noblock=1) MyClass &pOut
{
    $result = $1;
}
%typemap(csout, excode=SWIGEXCODE) void func
{
    IntPtr cPtr = $imcall;$excode
    MyClass ret = (cPtr != IntPtr.Zero) ? null : new MyClass(cPtr, $owner);
    return ret;
}

class MyClass{};
void func(MyClass& pOut, int x);
MyClass* func2(int x);

我已经包括了func2也有正确的签名。

前 3 个%typemap分别更改 C++ 包装函数、C# 互操作方法和 C# 包装方法的返回类型。

The %typemap(in)删除无关的输出参数并添加代码以在其位置使用新对象。这也奇迹般地让其他论点完好无损。

The %typemap(argout)使用输出参数值作为新创建的返回值。

The %typemap(csout)重写 C# 包装器方法代码以利用互操作方法的返回值，就像正常情况一样。

以下是证明它具有魅力的输出示例：

Test.cxx

SWIGEXPORT void * SWIGSTDCALL CSharp_func(int jarg2) {
  void * jresult ;
  MyClass *arg1 = 0 ;
  int arg2 ;

  arg1 = new MyClass();
  arg2 = (int)jarg2; 
  func(*arg1,arg2);
  jresult = arg1;
  return jresult;
}


SWIGEXPORT void * SWIGSTDCALL CSharp_func2(int jarg1) {
  void * jresult ;
  int arg1 ;
  MyClass *result = 0 ;

  arg1 = (int)jarg1; 
  result = (MyClass *)func2(arg1);
  jresult = (void *)result; 
  return jresult;
}

测试PINVOKE.cs

[DllImport("Test", EntryPoint="CSharp_func")]
public static extern global::System.IntPtr func(int jarg2);

[DllImport("Test", EntryPoint="CSharp_func2")]
public static extern IntPtr func2(int jarg1);

Test.cs

public class Test {
  public static MyClass func(int x) {
    IntPtr cPtr = TestPINVOKE.func(x);
    MyClass ret = (cPtr != IntPtr.Zero) ? null : new MyClass(cPtr, false);
    return ret;
}

  public static MyClass func2(int x) {
    IntPtr cPtr = TestPINVOKE.func2(x);
    MyClass ret = (cPtr == IntPtr.Zero) ? null : new MyClass(cPtr, false);
    return ret;
  }

}

C# 特定的%typemap需要用其他特定语言的替换来与其他语言一起使用，但可惜我没有找到与语言无关的方法来做到这一点。

为了使此操作能够轻松地使用多种类型和函数，可以定义一个宏。