如何跨swig类型映射重用代码?

How can I reuse code across swig typemaps?

本文关键字：代码 映射 何跨 swig 类型      更新时间：2023-10-16

我有两个swig typemaps，其中有一堆重复的代码。我想将代码合并如下:

%{
   #include "structure_defs.h"
%}
%ignore Cartesian2PyList(const schrodinger::Cartesian&);
PyObject* Cartesian2PyList(const schrodinger::Cartesian& cartesian)
{
  PyObject *o;
  o = PyList_New(3);
  PyObject* item = PyFloat_FromDouble(cartesian.x);
  PyList_SetItem(o, 0, item);
  item = PyFloat_FromDouble(cartesian.y);
  PyList_SetItem(o, 1, item);
  item = PyFloat_FromDouble(cartesian.z);
  PyList_SetItem(o, 2, item);
  return o; 
}
%typemap(out) schrodinger::Cartesian
{
  $result = Cartesian2PyList($1);
}
%typemap(out) std::vector<schrodinger::Cartesian>
{
  PyObject *o;
  o = PyList_New($1.size());
  for (uint i=0; i<$1.size(); i++) {
    PyObject *elem = Cartesian2PyList($1.at(i));
    PyList_SetItem(o, i, elem);
  }
  $result = o;
}
%include "cartesian.h"

然而，这无法编译，因为在编译时无法找到Cartesian2PyList的定义。在多个类型映射中重用代码的最佳方法是什么?

您可以使用%{ %}直接将代码传递到生成的.c文件。因此，在包装器中重用代码的最简单方法是将其放入其中，可能是作为静态函数，这样它就不会与同一模块中的其他任何内容冲突。在您的示例中，这将起作用:

%{
   #include "structure_defs.h"
%}
%{
static PyObject* Cartesian2PyList(const schrodinger::Cartesian& cartesian)
{
  PyObject *o;
  o = PyList_New(3);
  PyObject* item = PyFloat_FromDouble(cartesian.x);
  PyList_SetItem(o, 0, item);
  item = PyFloat_FromDouble(cartesian.y);
  PyList_SetItem(o, 1, item);
  item = PyFloat_FromDouble(cartesian.z);
  PyList_SetItem(o, 2, item);
  return o; 
}
%}
%typemap(out) schrodinger::Cartesian
{
  $result = Cartesian2PyList($1);
}
%typemap(out) std::vector<schrodinger::Cartesian>
{
  PyObject *o;
  o = PyList_New($1.size());
  for (uint i=0; i<$1.size(); i++) {
    PyObject *elem = Cartesian2PyList($1.at(i));
    PyList_SetItem(o, i, elem);
  }
  $result = o;
}
%include "cartesian.h"

如果你愿意，你可以在这里将两个%{ %}块合并为一个块。

我还删除了%ignore指令，因为%{ %}内部的代码只是输出到生成的模块，而不是包装，所以是多余的。另一方面，如果你真的想在生成的代码中包装和定义它，你可以使用%inline %{ ... %}，例如:

%inline %{
static PyObject* Cartesian2PyList(const schrodinger::Cartesian& cartesian)
{
    //...
}
%}

如果你正在编写更通用的SWIG代码，而不仅仅是一个模块，你可以使用更聪明的东西，参见fragments, %define和$typemap。在简单的情况下，只编写上面所示的模块内部使用的代码就足够了。

相关文章：