Swig - 绑定一个返回对导向器类指针的引用的方法

Posted 2023-02-23

【中文标题】Swig - 绑定一个返回对导向器类指针的引用的方法

【英文标题】：Swig - binding a method returning a reference to a pointer of a director class

【发布时间】：2019-03-13 10:36:40

【问题描述】：

好吧，标题有点长，但我想不出一个更短的：）所以让我解释一下。

我有一个 C++ 代码库，其中有一些容器类。这些类具有通过引用或 const 引用返回项目的访问方法。然后在代码库的另一部分，我分配了object 的堆容器，它们正在使用director 功能。

而且我不知道如何为 object 专门化我们的容器类：对于所有返回对项目的引用的容器方法（在本例中是对 object 的指针的引用），Swig 生成一个包装器由于无效的dy​​namic_cast而无法编译的代码（基本上它试图将object **转换为Swig::Director *）

我设法用下面的代码重现了这个问题。

测试.h

#ifndef TEST_H
#define TEST_H

template< typename T >
class Vector


public:

    inline Vector(void)
        : m_Data(nullptr)
        , m_Size(0)
    
    

    inline ~Vector(void)
    
        delete [] m_Data;
    

    inline void add(const T & item)
    
        T * data = new T [m_Size + 1];
        for (int i = 0; i < m_Size; ++i)
        
            data[i] = std::move(m_Data[i]);
        
        delete [] m_Data;
        m_Data = data;
        m_Data[m_Size++] = item;
    

    inline const T& item(int index) const
    
        return m_Data[index];
    

    inline int count(void) const
    
        return m_Size;
    

private:

    T * m_Data;
    int m_Size;

;

class Foo


public:

    Foo(void) = default;
    virtual ~Foo(void) = default;

    virtual const char * method(void) const
    
        return "Foo::method";
    

;

class Cache


public:

    static void add(Foo * item = nullptr)
    
        m_Cache.add(item == nullptr ? new Foo() : item);
    

    static const Vector< Foo * > & get(void)
    
        return m_Cache;
    

    static Foo * get(int index)
    
        return m_Cache.item(index);
    

private:

    static Vector< Foo * > m_Cache;

;

Vector< Foo * > Cache::m_Cache;

#endif // TEST_H

核心.i

%module(directors="1") core

// we want to be able to inherit Foo in Python
%feature("director") Foo;

// generate wrappers
%include "Test.h"

// specialize Vector for Foo
%template(FooVector) Vector<Foo*>;

// when compiling the wrapper code, include those
%
#include "Test.h"
%

如果您生成 Python 模块 (swig.exe -python -c++ core.i)，它可以正常工作，但生成的 core_wrap.cxx 文件无法构建，因为为 Vector::item 生成的包装代码包含从 Foo ** 到 Swig::Director * 的无效 dynamic_cast

违规行是（其中结果的类型为Foo **）

  director = SWIG_DIRECTOR_CAST(result);

如果我像这样手动修复它：

  director = SWIG_DIRECTOR_CAST(*result);

然后模块编译正确，一切正常。

所以基本上我的问题是：这是 Swig 中的错误吗？我做错了吗？是否有解决方法告诉 Swig 在转换为 Swig::Director * 之前正确取消引用我的 Foo ** 结果？

任何帮助表示赞赏:)

【问题讨论】：

我遇到过一些类似的情况，我有#ifndef SWIG_VERSION跳过某些功能。您是否尝试过仅包装 Vector 或 int 以查看它是否与 directors 或一般演员问题有关。另一件事 - 你为什么使用导演，我没有看到 Python 类实现 Foo。

包装不使用director 功能的类型的Vector 可以正常工作（无效的dynamic_cast 仅在与此功能相关的生成部分中）因此将Vector 专门用于@987654347 @ 工作正常。而且您看不到实现Foo 的Python 类，因为%feature(director) 旨在在Python 中定义实现Foo 的类时使用（好吧，至少在我的情况下，这就是我需要的）而且我没有提供一个使用示例模块的示例 Python 脚本，因为该模块甚至不编译，所以它并不真正相关。

如果您通过添加编译选项 -DSWIG_DIRECTOR_NORTTI 跳过使用本机 RTTI，您的示例将编译..

你是救生员！它编译，我的示例用例按预期工作！没有想过尝试定义这个宏，我觉得有点愚蠢（我记得在生成的包装代码中看到它并想知道它的用途是什么）如果你想添加这个作为正确答案，我可以接受它（也许它会在未来帮助其他人:)

我会这样做的......

【参考方案1】：

我找到了解决您问题的方法。

在某些情况下，使用 director 功能和原生 RTTI 会导致代码无法立即编译，例如在 Python 中使用 distutils 时。

适用于您的示例的解决方案是在编译代码时定义SWIG_DIRECTOR_NORTTI，例如对于 GNU 编译器，将 -DSWIG_DIRECTOR_NORTTI 添加到 CXXFLAGS