SignalBinder.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_SIGNALBINDER_H_
#define _MIRA_SIGNALBINDER_H_

#ifndef Q_MOC_RUN
#include <boost/function.hpp>
#endif

#include <QObject>

#include <utils/Bind.h>

namespace mira {


class SignalBinder : public QObject
{
    Q_OBJECT
public:
    SignalBinder(QObject* parent) :
        QObject(parent) {}

public:

    void bind(boost::function<void()> f)    { mVoid = f; }

    void bindInt(boost::function<void(int)> f) { mInt = f; }

    void bindQString(boost::function<void(const QString&)> f) { mQString = f; }

public slots:

    void slot()                   { if(mVoid) mVoid(); }
    void slot(int val)            { if(mInt)  mInt(val); }
    void slot(const QString& val) { if(mQString) mQString(val); }

public:


    static SignalBinder* connect(QObject* sender, const char* signal,
                                 boost::function<void()> function)
    {
        SignalBinder* binder = new SignalBinder(sender);
        binder->bind(function);
        binder->QObject::connect(sender,signal, binder, SLOT(slot()));
        return binder;
    }

    template<typename Class>
    static SignalBinder* connect(QObject* sender, const char* signal,
                 void (Class::*method)(), Class* instance) {
        return connect(sender,signal,(boost::function<void()>)boost::bind(method, instance));
    }

    static SignalBinder* connect(QObject* sender, const char* signal,
                                 boost::function<void(int)> function)
    {
        SignalBinder* binder = new SignalBinder(sender);
        binder->bindInt(function);
        binder->QObject::connect(sender,signal, binder, SLOT(slot(int)));
        return binder;
    }

    template<typename Class>
    static SignalBinder* connect(QObject* sender, const char* signal,
                 void (Class::*method)(int), Class* instance) {
        return connect(sender,signal,(boost::function<void(int)>)boost::bind(method, instance, _1));
    }

    static SignalBinder* connect(QObject* sender, const char* signal,
                                 boost::function<void(const QString&)> function)
    {
        SignalBinder* binder = new SignalBinder(sender);
        binder->bindQString(function);
        binder->QObject::connect(sender,signal, binder, SLOT(slot(const QString&)));
        return binder;
    }

    template<typename Class>
    static SignalBinder* connect(QObject* sender, const char* signal,
                 void (Class::*method)(const QString&), Class* instance) {
        return connect(sender,signal,(boost::function<void(const QString&)>)boost::bind(method, instance, _1));
    }

private:

    boost::function<void()> mVoid;
    boost::function<void(int)> mInt;
    boost::function<void(const QString&)> mQString;
};


}

#endif