c++ - SWIG c++ python 构造函数类型错误(可能是命名空间问题)

Question

我有一个完全在头文件 (HKnotVector.h) 中实现的类。我还有一个 SWIG 接口(interface)文件 (HKnotVector.i)，它定义了一些 std_vector.i 类型映射。 HKnotVector.h 需要来自另一个文件 (common.h) 的定义。如果我将 common.h 的相关部分复制/粘贴到 HKnotVector.i 中，一切都会完美无缺。

当我尝试 #include "common.h" 时问题来了在 HKnotVector.h 中。 SWIG 和 python 能够构建扩展，但我收到以下警告:HKnotVector.h:7: Error: Nothing known about namespace 'util'

这里是 HKnotVector.h 的相关部分:

/* file HKnotVector.h */
#include "common.h"
#include <vector>
#include <iostream>

using namespace std;
using namespace util;

namespace hbs
{
    class HKnotVector
    {
        public:
        HKnotVector( uint degree, const DoubleVec &knots )
            : mDeg( degree ), mKnots( knots )
        {
            getKVecData( mKnots, mGroups, mReverseGroups, mMultipleCount );
        }
        // A lot of missing code
        protected:
        uint mDeg;
        DoubleVec mKnots;
        IntVec mGroups;
        IntVecVec mReverseGroups;
        IntVec mMultipleCount;
        void getKVecData( const DoubleVec &knots, IntVec &knot_groups,
                          IntVecVec &reverse_knot_groups, IntVec &multiple_counts ) const
        {
            // Do cool stuff
        }
    };
}

common.h相关部分:

/* file common.h */
#include <iostream>
#include <vector>

typedef unsigned int uint;

using namespace std;

namespace util
{
    typedef std::vector< double > DoubleVec;
    typedef std::vector< int > IntVec;
    typedef std::vector< IntVec > IntVecVec;
    // A whole bunch of more stuff
}

所有 HKnotVector.i:

/* file HKnotVector.i */
%module hbspy
%{
#include "HKnotvector.h"
%}

%include "std_vector.i"
namespace std {
    %template(IntVec)    vector<int>;
    %template(DoubleVec) vector<double>;
    %template(IntVecVec) vector<vector<int> >;
}

%include "HKnotvector.h"

最后我有了尝试创建 HKnotVector 实例的测试 python 文件:

import hbspy

# Test HKnotVector
py_knots = [0., 0., 0., .25, .5, .75, 1., 1., 1.]
knots = hbspy.DoubleVec(py_knots)
print('knots object: %s\n\n\n' % knots)
kv = hbspy.HKnotVector(2, knots)

当我使用 swig -c++ -python HKnotVector.i 编译时然后构建扩展并运行测试文件这就是我得到的:

knots object: <hbspy.DoubleVec; proxy of <Swig Object of type 'std::vector< double > *' at 0x100499450> >

Traceback (most recent call last):
File "./doit", line 17, in <module>
  execfile('test.py')
File "test.py", line 18, in <module>
  kv = hbspy.HKnotVector(2, knots)
File "/Users/spencerlyon2/Research/HBS/hbs/swig/hbspy.py", line 249, in __init__
  this = _hbspy.new_HKnotVector(*args)
NotImplementedError: Wrong number or type of arguments for overloaded function 'new_HKnotVector'.
Possible C/C++ prototypes are:
  hbs::HKnotVector::HKnotVector()
  hbs::HKnotVector::HKnotVector(uint,DoubleVec const &)
  hbs::HKnotVector::HKnotVector(hbs::HKnotVector const &)

当我打印结时，你可以看到它的类型是 std::vector < double > * ，在 common.h 中是 typdef d为DoubleVec .我不明白为什么我要通过 knots当似乎很清楚应该满足第二个“C/C++ 原型(prototype)”时，构造函数会给出此错误。

我想强调的是，如果我简单地将相关代码从 common.h 复制/粘贴到 HKnotVector.i 中，我不会收到此错误。

我有两个想法可能会让某人走上正确的道路:

1. 当我在 .i 文件上运行 swig 时出现的错误是关于命名空间 util 一无所知，这是DoubleVec是typedef d在common.h
2. 我可能(？)需要 %include common.h某个地方让 swig 知道它的一切。

---

编辑 (5-11-13)

如果我尝试 %include "common.h"在 HKnotVector.i(就在 %include "../include/HKnotVector.h" 行上方)中，扩展构建时没有命名空间错误(HKnotVector.h:7: Error: Nothing known about namespace 'util')，但 python 无法导入它。这是在使用 %include "common.h" 构建后尝试运行 test.py 时发生的情况。 :

Traceback (most recent call last):
  File "test.py", line 10, in <module>
    import hbspy
  File "/Users/spencerlyon2/Research/HBS/hbs/swig/hbspy.py", line 26, in <module>
    _hbspy = swig_import_helper()
  File "/Users/spencerlyon2/Research/HBS/hbs/swig/hbspy.py", line 22, in swig_import_helper
    _mod = imp.load_module('_hbspy', fp, pathname, description)
ImportError: dlopen(/Users/spencerlyon2/Research/HBS/hbs/swig/_hbspy.so, 2): Symbol not found: __ZN4utillsERSoRKNS_4AxisE
  Referenced from: /Users/spencerlyon2/Research/HBS/hbs/swig/_hbspy.so
  Expected in: dynamic lookup

我不知道是什么__ZN4utillsERSoRKNS_4AxisE是，但我假设它是由扩展模块或 SWIG 定义的一些内部符号。

---

编辑 2 (5-11-13)

如果我转到 common.h 并删除指定 util 的行命名空间并注释掉 using namespace util; HKnotVector.h 中的行一切正常。

这对我来说很奇怪，因为 swig docs明确声明“对 C++ 命名空间的支持是全面的……”并且“默认的包装行为是在目标语言中扁平化命名空间。这意味着所有命名空间的内容都合并到生成的脚本语言模块中。”这似乎是我想要的行为，即我想成为 python 以便能够从 util 访问所有内容就好像它在全局命名空间中一样。

在这个小示例中，删除 namespace 规范简单明了。然而，这是一个已经深入使用 namespace 的相当大的项目的一小部分。尽管我编译了这个示例，但删除 namespace 并不是一个可行的长期解决方案。

Answer 1

正如您所发现的，当 SWIG 处理头文件时，默认情况下它不会递归到顶级头文件包含的头文件中，因此您必须专门 %include "common.h"将其定义公开给 SWIG。

正如您还发现的那样，在头文件中使用 using 语句是一种不好的做法，因为它们会将所有内容导入到一个 namespace 中。在这种情况下，它会混淆 SWIG。任何包含带有 using 语句的 header 的 .cpp 文件都会被强制污染其全局命名空间。 header 应尊重命名空间并完整指定它们，并将 using 语句留给 .cpp 文件。

参见 Why is including "using namespace" into a header file a bad idea in C++?