如何让 SWIG 自动将模拟的“this”指针包装到 C 结构？

Question

我已经实现了一个简单的 C“类”，在结构中使用函数指针来实现成员函数，并将指向该结构的指针作为第一个参数传递给每个函数，类似于隐含的“this " C++ 中的指针。

%module mytest
%{
typedef struct mytest mytest;

struct mytest {
  int data;
  int (*func1)(mytest *,int);
  void (*func2)(mytest *,int);
};

int f1(mytest *me,int n) { return me->data + n; }
void f2(mytest *me,int n) { me->data += n; }

mytest *mytestNew(int n) {
  mytest *me = (mytest*) malloc(sizeof(mytest));
  me->data = n;
  me->func1 = f1;
  me->func2 = f2;
  return me;
}

%}

typedef struct mytest mytest;

struct mytest {
  int data;
  int func1(mytest *,int);
  void func2(mytest *,int);
};

extern mytest *mytestNew(int n);

现在我的问题是，当为我在前端选择的任何语言创建接口时，我最终不得不将“this”指针显式传递给对象，即使语言本身支持隐藏它。

例如，假设我选择 Python。我必须这样做：

from mytest import *
m = mytestNew(1)
m.func1(m,0)

我真正想要的是这样做：

from mytest import *
m = mytestNew(1)
m.func1(0)

我知道我可以只写一些包装代码，但是对于我的实际项目，我在现有 C 代码的很多对象中都有很多函数，并将其乘以我想要支持的每种语言，这也是很多工作！有没有办法让 SWIG 自动执行此操作？

Answer 1

您可以在 SWIG 中以语言中立的方式执行此操作，只需两个类型映射，前提是您将参数命名为在 SWIG 界面中一致的名称以及允许有选择地应用类型映射的定义。 （当然，除非您希望所有指向 mytest 的指针默认成为“this”指针）

您需要的类型图是：

// Make sure the wraqpped function doesn't expect an input for this:
%typemap(in,numinputs=0) mytest *me "$1=NULL;"
// Slightly abuse check typemap, but it needs to happen after the rest of the arguments have been set:
%typemap(check) mytest *me {
  $1 = arg1;
}

检查类型映射并不是真的打算像这样使用，但它是在从目标语言提取参数之后和进行实际调用之前注入代码的最简单方法。

您还可以借助宏来简化模块，以避免编写函数指针和成员技巧之间的映射并保持同步。我最终得到了test.h：

#ifdef SWIG
#define MEMBER(name, args) name args
#else
#define MEMBER(name, args) (*name) args
#endif

typedef struct mytest mytest;

struct mytest {
  int data;
  int  MEMBER(func1,(mytest *me,int));
  void MEMBER(func2,(mytest *me,int));
};

以及对应的接口文件（test.i）：

%module test

%{
#include "test.h"

static int f1(mytest *me,int n) { return me->data + n; }
static void f2(mytest *me,int n) { me->data += n; }
%}

%extend mytest {
  mytest(int n) {
    $self->data = n;
    $self->func1 = f1;
    $self->func2 = f2;
  }
}

%typemap(in,numinputs=0) mytest *me "$1=NULL;"
%typemap(check) mytest *me {
  $1 = arg1;
}

%include "test.h"

（这个接口文件提供了一个构造函数，它完全按照 Java 程序员的期望“创建”“对象”——你可以调用 new，它会在后台设置函数指针）