SWIG：以面向对象的方式包装C-API

Question

我有一个C（而不是C）库，它一致地使用函数的第一个参数作为上下文对象（让我们调用类型t_context），我想使用SWIG生成C#wrappers来保持这种调用风格（也就是说，不要把函数或多或少地孤立起来，而是把它们包装成某个类中的方法，并通过方法中的this对象的引用访问t_上下文）。

示例（C签名）：

void my_lib_function(t_context *ctx, int some_param);

所需的C#API：

class Context
{
    // SWIG generated struct reference
    private SWIG_t_context_ptr ctx;

    public void my_lib_function(int some_param)
    {
        // call SWIG generated my_lib_function with ctx
    }
}

如果有人向我指出一个使用这种API风格的现有C（再次：不是C）库的SWIG生成的包装器，我也会很高兴；我什么也找不到。

或者，除了SWIG之外，是否还有用于C到C#用例的包装器生成器提供对API的更多控制（可能是通过公开用于代码生成的模板）？

Answer 1

为了解决这个问题，我创建了以下迷你头文件来演示我们（可能）真正关心的所有部分。我这样做的目标是：

1. C#用户甚至不应该意识到这里发生了任何非OO的事情

首先，我编写了以下头文件test。h:

#ifndef TEST_H
#define TEST_H

struct context;
typedef struct context context_t;

void init_context(context_t **new);

void fini_context(context_t *new);

void context_func1(context_t *ctx, int arg1);

void context_func2(context_t *ctx, const char *arg1, double arg2);

#endif

以及相应的测试。c和一些存根实现：

#include <stdlib.h>
#include "test.h"

struct context {};
typedef struct context context_t;

void init_context(context_t **new) {
  *new = malloc(sizeof **new);
}

void fini_context(context_t *new) {
  free(new);
}

void context_func1(context_t *ctx, int arg1) {
  (void)ctx;
  (void)arg1;
}

void context_func2(context_t *ctx, const char *arg1, double arg2) {
  (void)ctx;
  (void)arg1;
  (void)arg2;
}

我们需要解决几个不同的问题，才能使其成为一个整洁、可用的OO C#接口。我会一次解决一个问题，最后给出我的首选解决方案。（对于Python，这个问题可以用一种更简单的方法来解决，但这里的解决方案将适用于Python、Java、C#以及其他可能的语言）

通常在OO风格的C API中，您会编写某种构造函数和析构函数来封装您的任何设置（可能是不透明的）。为了以明智的方式将它们呈现给目标语言，我们可以使用%扩展来编写看起来很像C构造函数/析构函数的东西，但在SWIG处理后仍然作为C出现。

%module test

%{
#include "test.h"
%}
    
%rename(Context) context; // Make it more C# like
%nodefaultctor context; // Suppress behaviour that doesn't work for opaque types
%nodefaultdtor context;
struct context {}; // context is opaque, so we need to add this to make SWIG play

%extend context {
  context() {
    context_t *tmp;
    init_context(&tmp);
    // we return context_t * from our "constructor", which becomes $self
    return tmp;
  }

  ~context() {
    // $self is the current object
    fini_context($self);
  }
}

我的设置方式允许我们使用一个可爱的把戏。当我们说：

%extend context {
  void func();
}

然后，SWIG生成一个存根，如下所示：

SWIGEXPORT void SWIGSTDCALL CSharp_Context_func(void * jarg1) {
  struct context *arg1 = (struct context *) 0 ;

  arg1 = (struct context *)jarg1; 
  context_func(arg1);
}

需要从中吸取的两件事是：

1. 实现扩展的context:：func调用的函数称为context\u func

上面的内容与我们从C端开始的内容非常吻合。因此，我们可以简单地完成以下工作：

%module test

%{
#include "test.h"
%}
    
%rename(Context) context;
%nodefaultctor context;
%nodefaultdtor context;
struct context {}; 

%extend context {
  context() {
    context_t *tmp;
    init_context(&tmp);
    return tmp;
  }

  ~context() {
    fini_context($self);
  }

  void func1(int arg1);

  void func2(const char *arg1, double arg2);
}

这并不完全符合我的目标第2点，正如我所希望的那样，您必须手动编写函数声明（除非您使用%include的技巧，并将它们保存在单个头文件中）。有了Python，您可以在导入时将所有的部分放在一起，并使其简单得多，但我看不到一种简洁的方法来枚举所有与模式匹配的函数，并将其放在SWIG生成模式的正确位置。cs文件。

这足以让我使用以下代码进行测试（使用Mono）：

using System;
 
public class Run
{
    static public void Main()
    {
        Context ctx = new Context();
        ctx.func2("", 0.0);
    }
}

还有其他一些C OO风格的设计变体，使用可以解决的函数指针，还有一个类似的问题，我在过去讨论过Java。