SWIG：返回原始指针与共享 ptrs 的向量

Posted 2023-02-16

【中文标题】SWIG：返回原始指针与共享 ptrs 的向量

【英文标题】：SWIG: Returning a vector of raw pointers vs. shared ptrs

【发布时间】：2017-11-09 16:40:47

【问题描述】：

我正在尝试为我拥有的 C++ 类构建一个 python 接口，不幸的是它包含原始和共享指针对象/返回方法的混合。本质上，使用此接口，由于设计约束（即数据结构定义了一个降序层次结构，即 A -> B -> C，共享指针向下移动，并且原始指向上的指针，以打破循环所有权。）

然而，我观察到的问题是，当我引入共享 ptr 模板时，即：

%shared_ptr(fooType)

然后 SWIG 知道为 fooType 包装/创建代理类，但不知道为 fooType* 包装/创建代理类。 （相反，如果我不包含 %shared_ptr 宏，SWIG 会为原始指针创建代理类。）

我的问题如下所述 - 我需要返回一个原始指针对象的向量。例如，这是我的 MWE：

fooType.h

#include <iostream>
#include <vector>

class fooType
  public:
  fooType()  ;
  ~fooType()  ;
  void printFoo()  std::cerr << "FOO!" << std::endl; 
  static std::shared_ptr<fooType> make_shared()  
      return std::shared_ptr<fooType>(new fooType()); 
  
  static fooType* newPtr()  return new fooType(); 
  static std::vector<fooType*> newVecPtr() 
      std::vector<fooType*> retVec;
      for( size_t i = 0; i < 3; ++i)  retVec.push_back(new fooType()); 
     return retVec;
  
;

fooType.i

%module fooType

%include <std_map.i>
%include <std_shared_ptr.i>
%include <std_vector.i>

%
#include "fooType.h"
%

%shared_ptr(fooType);
%include "fooType.h"

%template(fooVec) std::vector<fooType>;
%template(fooPtrVec) std::vector<fooType*>;

testFooType.py

import fooType as fooMod

ft = fooMod.fooType.make_shared()
ftPtr = fooMod.fooType.newPtr()
fooVec = fooMod.fooType.newVecPtr()

print(ftPtr)
print(ft)
print(fooVec)

for foo in fooVec:
   print(foo)
   foo.printFoo()

这给了我：

<fooType.fooType; proxy of <Swig Object of type 'std::shared_ptr< fooType > *' at 0x7fd83ccfeb10> >
<fooType.fooType; proxy of <Swig Object of type 'std::shared_ptr< fooType > *' at 0x7fd83ccfec30> >
<fooType.fooPtrVec; proxy of <Swig Object of type 'std::vector< fooType * > *' at 0x7fd83ccfeba0> >
<Swig Object of type 'fooType *' at 0x7fd834c1dba0>
Traceback (most recent call last):
  File "testFooType.py", line 13, in <module>
    foo.printFoo()
AttributeError: 'SwigPyObject' object has no attribute 'printFoo'

如果我注释掉 %shared_ptr(fooType) 宏，我会得到：

<fooType.fooType; proxy of <Swig Object of type 'std::vector< fooType * >::value_type' at 0x7feab54b42a0> >
<fooType.fooTypePtr; proxy of <Swig Object of type 'std::shared_ptr< fooType > *' at 0x7feab54b4240> >
<fooType.fooPtrVec; proxy of <Swig Object of type 'std::vector< fooType * > *' at 0x7feab54b4210> >
<fooType.fooType; proxy of <Swig Object of type 'std::vector< fooType * >::value_type' at 0x7feab54b4780> >
FOO!
<fooType.fooType; proxy of <Swig Object of type 'std::vector< fooType * >::value_type' at 0x7feab54b4c90> >
FOO!
<fooType.fooType; proxy of <Swig Object of type 'std::vector< fooType * >::value_type' at 0x7feab54b4780> >
FOO!

那么，我在这里做错了什么？换句话说，我怎样才能让 SWIG 为我的原始指针和我的共享指针同时生成一个代理类，特别是当我将它们包装成向量时？

请注意，我不一定能找到使用 std::enabled_shared_from_this as illustrated here 之类的方法，即因为我坚持使用 C++ 端的接口（即，我无法将类修改为添加来自enable_shared_from_this 的继承）。

大多数情况下，我想知道为什么当我启用共享指针时代理类生成会被破坏，以及如何解决这个问题。 （我尝试开发自己的类型映射来解析指针并将它们放回列表中，但这似乎没有帮助；我最终还是得到了 SWIG 对象，我无法接受。）

【参考方案1】：

最后，当共享指针被包装时，我无法确定让 SWIG 为原始指针创建代理类型的合适方法（即，我启用了 %shared_pointer(fooType) 宏）。

我最终提出的解决方法是通过 SWIG 中的包装器方法将原始指针克隆到新的共享指针对象中（从 this answer here 获得一些灵感）。换句话说，使用隐式复制构造函数 (fooType::fooType(fooType&)) 和 std::make_shared 创建一个新的 shared_ptr<fooType> 对象，该对象不会尝试声明原始原始指针的所有权（它无法控制；因此避免了当共享指针被删除并试图释放它的指针时，双重删除。）

如果有人对如何为原始指针开发适当的类型映射有任何建议，例如让 SWIG 为两者创建代理类（即，允许我取消引用/调用原始指针对象上的方法以及共享指针），我当然很感兴趣；但与此同时，似乎创建并行共享指针是唯一可行的解​​决方法。