python - Swig 和指针问题(python)

Question

我正在使用 Swig 为 DLL 文件生成 python 包装器。我所做的是:

1. 使用 swig -c++ -python 生成包装器和加载器文件
我的文件.i
2. 创建一个新的 DLL 文件，包括 myfile_wrapper.cxx 和编译为 _myfile.pyd。
3. 在Idle中加载Swig创建的模块myfile.py并尝试使用。

接口(interface)文件如下所示:

%module myfile 
/* Make a test with cpointer - needed?? */
%include cpointer.i 
%pointer_functions(MyHandle, my_handle_p);
%pointer_class(int, intp);
%{
#define SWIG_FILE_WITH_INIT
#include "MyFile.h"
}%
%include "MyFile.h"

函数看起来像

 typedef struct tagMyHandle
   {
      void* reserved;
   } *MyHandle;

int OpenFile(const char *szPath, MyHandle* pFile); // pFile is an out parameter
int GetNumberOfItems(MyHandle hFile, int *pnNrOfItems); // pnNrOfItems is an out parameter

如果我尝试从 Python 中使用它，我必须这样做:

import myfile
handle_p = myfile.new_my_handle_p()
myfile.OpenFile("Path", handle_p)
handle = myfile.my_file_p_value(handle_p)
num_items_p = myfile.new_intp()
myfile.GetNumberOfItems(handle, num_items_p)
num_items = num_items_p.value()

我是否错误地使用了 Swig？感觉用Python来调用本该被包装的函数是一种非常繁琐的方式。

我想做这样的事情:

result, handle = OpenFile("path")
result, items = GetNumberIfItems(handle)

我无法更改 myfile.h 的源代码。

我在看input/output parameters ，但我是否必须为每种输出类型定义它们？ MyFile.h 有数百个具有不同输出类型的函数。而且它只支持原始数据类型，但MyFile.h中的大多数类型都不是原始类型，而是像struct MyHandle。

我看过SWIG function with pointer struct和 http://www.swig.org/Doc3.0/Python.html#Python_nn18也是，但没有什么好的解决办法。

更新 1经过大量帮助，我已经解决了大部分问题，但还有一些我不明白。

问题一:

// For the out parameter, shouldn't be needed?
%typemap(in,numinputs=0) MyHandle* pOutParam (MyHandle h) %{
    $1 = &h;
%}

// For all others
%typemap(in,numinputs=0) MyHandle* (MyHandle h) %{
    $1 = &h;
%}

// For the return type
%typemap(argout) MyHandle* pOutParam (PyObject* o) %{
    o = PyLong_FromVoidPtr(*$1);
    $result = SWIG_Python_AppendOutput($result,o);
%}

%typemap(in) MyHandle %{
    $1 = reinterpret_cast<MyHandle>(PyLong_AsVoidPtr($input));
%}

代码

int OpenFile(const char *szPath, MyHandle* pOutParam);
int DoSomething(MyHandle* pInParam);

OpenFile 像魅力一样工作，但 DoSomething 仍然尝试返回 MyHandle 而不是将其作为 in 参数，我不这样做明白为什么。 %typemap(argout) MyHandle* 仅为 pOutParam 定义。

问题 2:我不明白如何为类似的东西制作类型映射

int GetFileName(char *szPathBuffer, int iLength);

如何创建一个字符缓冲区并将其发送，就像我 C:

char szBuffer[MAX_PATH]; GetFileName(szBuffer, MAX_PATH);

也许与 cstring_bounded_output 一起使用，或者我应该做类似的事情

%typemap(in) (char*, int) { 
    $2 = PyString_Size($input); 
    $1 = (char*) malloc($2 * sizeof(char*)); 
} 

但是它在哪里释放？

问题 3:枚举值的正确映射是什么。如果我有

typedef enum tagMyEnum {
MyTrue = 1,
MyFalse = 0 } MyEnum;

和函数

int IsCorrect(MyEnum* pOutValue);

@马克·托洛宁:感谢所有帮助!对此，我真的非常感激!我学到了很多关于 Swig 的新知识!

Answer 1

这是一个示例，其接口(interface)类似于您要使用类型映射重新定义接口(interface)来说明的内容:

myfile.h

typedef struct tagMyHandle
{
    void* reserved;
} *MyHandle;

int OpenFile(const char *szPath, MyHandle* pFile);
int GetNumberOfItems(MyHandle hFile, int *pnNrOfItems);
// Added this to free the allocated handle.
void CloseFile(MyHandle hFile);

我的文件.cpp

header 的黑客实现...

#include "myfile.h"

int OpenFile(const char *szPath, MyHandle* pFile)
{
    *pFile = new tagMyHandle;
    (*pFile)->reserved = new int(7);
    return 1;
}

int GetNumberOfItems(MyHandle hFile, int *pnNrOfItems)
{
    *pnNrOfItems = *reinterpret_cast<int*>(hFile->reserved) + 5;
    return 1;
}

// mirrors OpenFile to free the allocated handle.
void CloseFile(MyHandle hFile)
{
    delete reinterpret_cast<int*>(hFile->reserved);
    delete hFile;
}

我的文件.i

%module myfile 

%{
#include "MyFile.h"
%}

// An input typemap for the an output parameter, called before the C++ function is called.
// It suppresses requiring the parameter from Python, and uses a temporary
// variable to hold the output value.
%typemap(in,numinputs=0) MyHandle* (MyHandle h) %{
    $1 = &h;
%}

// An output argument typemap, called after the C++ function is called.
// It retrieves the output value and converts it to a Python int,
// then appends it to the existing return value.  Python will get a tuple of
// (return_value,handle).
%typemap(argout) MyHandle* (PyObject* o) %{
    o = PyLong_FromVoidPtr(*$1);
    $result = SWIG_Python_AppendOutput($result,o);
%}

// An input typemap that converts a Python int to a MyHandle*.
%typemap(in) MyHandle %{
    $1 = reinterpret_cast<MyHandle>(PyLong_AsVoidPtr($input));
%}

// This applies a pre-defined int* output typemap to all int* parameters.
%apply int *OUTPUT {int *};

%include "MyFile.h"

输出

>>> import myfile
>>> s,h = myfile.OpenFile('path')
>>> s,h
(1, 7706832)
>>> s,v = myfile.GetNumberOfItems(h)
>>> s,v
(1, 12)
>>> myfile.CloseFile(h)