boost/python/return_opaque_pointer.hpp

クラス

return_opaque_pointer クラス

struct return_opaque_pointer

return_opaque_pointer は、新しい Python オブジェクトに戻り値がコピーされる未定義型へのポインタを返す C++ 関数をラップするのに使用する ResultConverterGenerator のモデルである。

戻り値のポインタ先の型について type_id 関数の特殊化を定義するには、return_opaque_pointer ポリシーを指定することに加え、BOOST_PYTHON_OPAQUE_SPECIALIZED_TYPE_ID マクロを使用しなければならない。

return_opaque_pointer クラスの概要

namespace boost { namespace python
{
    struct return_opaque_pointer
    {
        template <class R> struct apply;
    };
}}

return_opaque_pointer クラスのメタ関数

template<class T>
struct apply

typedef detail::opaque_conversion_holder<R> type

例

C++ のモジュール定義

# include <boost/python/return_opaque_pointer.hpp>
# include <boost/python/def.hpp>
# include <boost/python/module.hpp>
# include <boost/python/return_value_policy.hpp>

typedef struct opaque_ *opaque;

opaque the_op   = ((opaque) 0x47110815);

opaque get () { return the_op; }
void use (opaque op) {
    if (op != the_op)
        throw std::runtime_error (std::string ("failed"));
}

void failuse (opaque op) {
    if (op == the_op)
        throw std::runtime_error (std::string ("success"));
}

BOOST_PYTHON_OPAQUE_SPECIALIZED_TYPE_ID(opaque_)

namespace bpl = boost::python;

BOOST_PYTHON_MODULE(opaque_ext)
{
    bpl::def (
        "get", &::get, bpl::return_value_policy<bpl::return_opaque_pointer>());
    bpl::def ("use", &::use);
    bpl::def ("failuse", &::failuse);
}

Python のコード

"""
>>> from opaque_ext import *
>>> #
>>> # 正しい変換のチェック
>>> use(get())
>>> failuse(get())
Traceback (most recent call last):
        ...
RuntimeError: success
>>> #
>>> # 整数から不透明なオブジェクトへの変換が存在しないことのチェック
>>> use(0)
Traceback (most recent call last):
        ...
TypeError: bad argument type for built-in operation
>>> #
>>> # 文字列から不透明なオブジェクトへの変換が存在しないことのチェック
>>> use("")
Traceback (most recent call last):
        ...
TypeError: bad argument type for built-in operation
"""
def run(args = None):
    import sys
    import doctest

    if args is not None:
        sys.argv = args
    return doctest.testmod(sys.modules.get(__name__))

if __name__ == '__main__':
    print "実行中..."
    import sys
    sys.exit(run()[0])

参考

opaque