C++で元ライブラリを隠蔽しつつ、自作クラスのメンバ関数をコールバック登録する機能を実現したい

Question

前提・実現したいこと

c++で、イベント発生時にコールバック関数を呼び出すベンダー製ライブラリの機能を顧客に提供したいです。
しかし、すべて開示するのではなく必要な情報のみ開示するために自作ライブラリを作成して隠蔽したいです。
さらに顧客が実装する自作クラスのメンバ関数を、イベント発生時に呼び出すコールバック関数として登録できるようにしたいです。

ヘッダファイルの関係性は下記のイメージで、顧客に提供するのはmy_vendorlib_api.hppのみにしたいです。
(実際にはmy_vendorlib_listener.hppはmy_vendorlib_api.cppにてincludeすることで分離/隠蔽できるのかなと考えました)

vendorlib.hpp(ベンダー製Lib)
--> my_vendorlib_listener.hpp
--> my_vendorlib_api.hpp(顧客にはこのヘッダファイルと動的リンクライブラリのみ渡す想定)
--> sample.hpp(顧客が実装)

発生している問題・エラーメッセージ

しかしながら、自作クラスのメンバ関数をイベント発生時のコールバック関数に登録しようとすると、テンプレート記法を使うことになりヘッダーファイルにコールバック関数登録の実装を書かなければならず、my_vendorlib_listener.hppを隠蔽する方法がわからないということに悩んでいます。
そもそも思想が間違っているなども含めて、アドバイスいただけると幸いです。

my_vendorlib_api.hpp: error: invalid use of imcomplete type 'class MyVendorLibListener'
    this->my_vendorlib_listener->set_callback(boost::bind(fp, obj, boost::placeholders::_1));
                                ^

該当のソースコード

my_vendorlib_listener.hpp

#ifndef MYVENDORLIBLISTENER_H
#define MYVENDORLIBLISTENER_H

#include <functional>
#include "vendorlib.h"

class MyVendorLibListener : public vendorliblistener
{
public:
    //event関数がイベント発生時に呼ばれるので、msgの内容を絞ってcallback関数を呼ぶ実装にする
    void event(VendorCustomMessage msg);
    int set_callback(std::function<void (int)> callback);
private:
    std::function<void (int)> callback;
};

#endif

my_vendorlib_api.hpp

#ifndef MYVENDORLIBAPI_H
#define MYVENDORLIBAPI_H

//my_vendorlib_listener.hppはソースファイル側でincludeすることで隠蔽したい
#include <functional>
#include <boost/bind.hpp>

class MyVendorLibApi
{
private:
    class MyVendorLibListener* my_vendorlib_listener;
public:
    template<class T>
    void set_callback(void(T::*fp)(int a), T *obj)
    {
        //テンプレートを使っているため、このヘッダファイルでmy_vendorlib_listenerを使った実装をせざるを得なくなりエラーとなる
        this->my_vendorlib_listener->set_callback(boost::bind(fp, obj, boost::placeholders::_1));
    }
};

#endif

Comments

[matukeso]

Apiクラス側のset_callbackでもstd::function使えばいいとおもうけど、何か理由があるの？

[zukky619]

ありがとうございます。知識不足につきイメージがついていない部分もあります。
自作関数のメンバを登録する際、sample.cppの自作クラスのインスタンスthisを渡さなければならないという理解で、
template<class T> void set_callback(void(T::*fp)(int a), T *obj)
とするのかなと思ったのですが、std::functionを使うとその点が解消されるのでしょうか。予めbindしたものを受け取るイメージでしょうか？

Answer 1

1.関数ポインタとvoid*ペア。Windows APIとかで頻出のパターン。DLL境界(言語、バージョンの境界)超えてても大丈夫。使う方はサンク関数を渡すパターン。使用例はこんな感じ。

api->set_callback( OnCallbackThunk, this );
…
void OnCallbackThunk( void *data ){
    static_cast<UserClass*>( data )->OnCallback();
}

2.std::funtion。使う方がthisとかをキャプチャしたラムダを渡す。使用例は下記みたいな感じ。ただしライブラリと使用側でコンパイル環境を揃える必要がある。

api->set_callback([this](){ oncallback();});

Answer 2

いったんtemplateの型の解決をMyVendorLibApi内部で行って、MyVendorLibListenerへcallbackを送るのは別関数にすれば隠蔽できるかと思います。

// MyVendorLibApi.hpp
class MyVendorLibApi
{
private:
    class MyVendorLibListener* my_vendorlib_listener;
    std::function<void(int)> callback;

public:
    template<class T>
    void set_callback(void(T::*fp)(int a), T *obj)
    {
       this->callback = boost::bind(fp, obj, boost::placeholders::_1);
　　　　push_callback();
    }
private:
    void push_callback( void );
};

//MyVendorLibApi.cpp
#include "my_vendorlib_listener.hpp"

void MyVendorLibApi::push_callback( void ){

    my_vendorlib_listener->set_callback( this->callback );
}

修正

// MyVendorLibApi.hpp
class MyVendorLibApi
{
private:
    class MyVendorLibListener* my_vendorlib_listener;

public:
    template<class T>
    void set_callback(void(T::*fp)(int a), T *obj)
    {
       set_callback( boost::bind(fp, obj, boost::placeholders::_1) );
    }

    void set_callback( std::function<void(int)> callback );
};

//MyVendorLibApi.cpp
#include "my_vendorlib_listener.hpp"

void MyVendorLibApi::set_callback( std::function<void(int)> callback ){

    my_vendorlib_listener->set_callback( callback );
}

Comments

[Serbonis]

push_callback( std::function<void(int)> callback )にすれば、callbackをメンバ変数で持つ必要もないかも知れないです。

[Serbonis]

private: void push_callback( std::function<void(int)> callback );
↓
public: void set_callback( std::function<void(int)> callback );

set_callbackのオーバーロードにすれば、汎用性が高くなるかと思います。

[zukky619]

ありがとうございます。こちらの方法で解決できました。

Answer 3

話の途中でいきなりテンプレートが登場した意味がわかりません．

自作クラスのメンバ関数をイベント発生時のコールバック関数に登録

することに何らかの工夫を要するのだとしても，その作業を行うべきは，「あなたの自作ライブラリを使う側（自作クラスとかいうのを実装している側）」なのではないでしょうか．

Comments

[fana]

あなたのライブラリはコールバックとして設定できる物の型を，ライブラリを使う側に強制すればいいだけです．それがライブラリの仕様です．
（当然，なるべく使いやすい形にしたほうがよいですが）

で，使う側はそれに合わせて使います．
使うものの仕様に合わせるための作業は使う側が行うことです．

[zukky619]

ありがとうございます。知識不足につきイメージがついていない部分もあります。
テンプレートを用いた理由は、sample.cppの自作クラスのインスタンスthisを渡さなければならないという理解で、
template<class T> void set_callback(void(T::*fp)(int a), T *obj)
とするのかなと思ったからです。

おっしゃるとおり、例えばクラスのメンバ関数ではなく、通常の関数のみ受け付ける仕様にしてしまえば本件で悩まなくて良いなと思うのですが、なるべく使いやすい形にしたく考えておりました。

[dodox86]

DLLにして関数をEXPORTするのであれば、C++であるとメンバー関数の名前のマングリングの問題が出てきますよ。

[fana]

std::function と 自作クラスのメンバ関数 の間を取り持つための template を用いた実装を，
ライブラリ側で提供したいのだとしても，
それを MyVendorLibApi のメソッドとしてしまうと my_vendorlib_listener.hpp を隠蔽できなくなる

であれば

MyVendorLibApi が要求する型は （MyVendorLibListener と同じ）std::function にして，
そこにtemplateで突っ込む作業を行うだけのヘルパを別途提供する形とかでもよいのでは？