Clementine-audio-player-Mac.../ext/libclementine-common/core/closure.h

236 lines
8.0 KiB
C
Raw Normal View History

2011-10-05 11:36:08 +02:00
/* This file is part of Clementine.
Copyright 2011, David Sansome <me@davidsansome.com>
Clementine is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Clementine is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Clementine. If not, see <http://www.gnu.org/licenses/>.
*/
2011-10-04 18:26:40 +02:00
#ifndef CLOSURE_H
#define CLOSURE_H
2015-07-20 15:35:13 +02:00
#include <chrono>
2013-10-28 17:30:52 +01:00
#include <functional>
#include <memory>
2012-11-26 10:10:20 +01:00
2015-11-26 19:34:41 +01:00
#include <QFuture>
#include <QFutureWatcher>
2011-10-04 18:26:40 +02:00
#include <QMetaMethod>
#include <QObject>
#include <QSharedPointer>
2015-07-20 15:35:13 +02:00
#include <QTimer>
2011-10-04 18:26:40 +02:00
namespace _detail {
2012-11-22 15:15:07 +01:00
class ObjectHelper;
2011-10-04 18:26:40 +02:00
2012-11-22 15:15:07 +01:00
// Interface for ObjectHelper to call on signal emission.
class ClosureBase {
2011-10-04 18:26:40 +02:00
public:
2012-11-22 15:15:07 +01:00
virtual ~ClosureBase();
virtual void Invoke() = 0;
2011-10-04 18:26:40 +02:00
2012-11-22 15:15:07 +01:00
// Tests only.
ObjectHelper* helper() const;
2011-10-04 18:26:40 +02:00
2012-11-22 15:15:07 +01:00
protected:
explicit ClosureBase(ObjectHelper*);
ObjectHelper* helper_;
private:
Q_DISABLE_COPY(ClosureBase)
2011-10-04 18:26:40 +02:00
};
2012-11-22 15:15:07 +01:00
// QObject helper as templated QObjects do not work.
// Connects to the given signal and invokes the closure when called.
// Deletes itself and the Closure after being invoked.
class ObjectHelper : public QObject {
2011-10-04 18:26:40 +02:00
Q_OBJECT
public:
ObjectHelper(QObject* parent, const char* signal, ClosureBase* closure);
public slots:
void TearDown();
2011-10-04 18:26:40 +02:00
private slots:
void Invoked();
private:
QMetaObject::Connection connection_;
std::unique_ptr<ClosureBase> closure_;
Q_DISABLE_COPY(ObjectHelper)
2012-11-22 15:15:07 +01:00
};
2011-10-06 13:19:42 +02:00
// Helpers for unpacking a variadic template list.
// Base case of no arguments.
void Unpack(QList<QGenericArgument>*);
2011-10-04 18:26:40 +02:00
template <typename Arg>
void Unpack(QList<QGenericArgument>* list, const Arg& arg) {
list->append(Q_ARG(Arg, arg));
}
2011-10-04 18:26:40 +02:00
template <typename Head, typename... Tail>
void Unpack(QList<QGenericArgument>* list, const Head& head,
const Tail&... tail) {
Unpack(list, head);
Unpack(list, tail...);
}
2012-11-22 15:15:07 +01:00
template <typename... Args>
class Closure : public ClosureBase {
public:
Closure(QObject* sender, const char* signal, QObject* receiver,
const char* slot, const Args&... args)
: ClosureBase(new ObjectHelper(sender, signal, this)),
// std::bind is the easiest way to store an argument list.
function_(std::bind(&Closure<Args...>::Call, this, args...)),
receiver_(receiver) {
2012-11-22 15:15:07 +01:00
const QMetaObject* meta_receiver = receiver->metaObject();
QByteArray normalised_slot = QMetaObject::normalizedSignature(slot + 1);
const int index = meta_receiver->indexOfSlot(normalised_slot.constData());
Q_ASSERT(index != -1);
slot_ = meta_receiver->method(index);
// Use a direct connection to insure that this is called immediately when
// the sender is destroyed. This will run on the signal thread, so TearDown
// must be thread safe.
QObject::connect(receiver_, SIGNAL(destroyed()), helper_, SLOT(TearDown()),
Qt::DirectConnection);
}
virtual void Invoke() { function_(); }
private:
2012-11-22 15:15:07 +01:00
void Call(const Args&... args) {
QList<QGenericArgument> arg_list;
Unpack(&arg_list, args...);
2012-11-22 15:15:07 +01:00
slot_.invoke(receiver_,
arg_list.size() > 0 ? arg_list[0] : QGenericArgument(),
arg_list.size() > 1 ? arg_list[1] : QGenericArgument(),
arg_list.size() > 2 ? arg_list[2] : QGenericArgument(),
arg_list.size() > 3 ? arg_list[3] : QGenericArgument(),
arg_list.size() > 4 ? arg_list[4] : QGenericArgument(),
arg_list.size() > 5 ? arg_list[5] : QGenericArgument(),
arg_list.size() > 6 ? arg_list[6] : QGenericArgument(),
arg_list.size() > 7 ? arg_list[7] : QGenericArgument(),
arg_list.size() > 8 ? arg_list[8] : QGenericArgument(),
arg_list.size() > 9 ? arg_list[9] : QGenericArgument());
2012-11-22 15:15:07 +01:00
}
std::function<void()> function_;
2012-11-22 15:15:07 +01:00
QObject* receiver_;
QMetaMethod slot_;
};
2012-11-22 15:15:07 +01:00
template <typename T, typename... Args>
class SharedClosure : public Closure<Args...> {
public:
SharedClosure(QSharedPointer<T> sender, const char* signal, QObject* receiver,
const char* slot, const Args&... args)
: Closure<Args...>(sender.data(), signal, receiver, slot, args...),
data_(sender) {}
private:
2012-11-22 15:15:07 +01:00
QSharedPointer<T> data_;
};
class CallbackClosure : public ClosureBase {
public:
CallbackClosure(QObject* sender, const char* signal,
std::function<void()> callback);
virtual void Invoke();
private:
std::function<void()> callback_;
};
} // namespace _detail
2012-11-22 15:15:07 +01:00
template <typename... Args>
_detail::ClosureBase* NewClosure(QObject* sender, const char* signal,
QObject* receiver, const char* slot,
const Args&... args) {
return new _detail::Closure<Args...>(sender, signal, receiver, slot, args...);
2011-10-06 13:11:18 +02:00
}
2012-11-22 15:15:07 +01:00
// QSharedPointer variant
template <typename T, typename... Args>
_detail::ClosureBase* NewClosure(QSharedPointer<T> sender, const char* signal,
QObject* receiver, const char* slot,
const Args&... args) {
return new _detail::SharedClosure<T, Args...>(sender, signal, receiver, slot,
args...);
}
_detail::ClosureBase* NewClosure(QObject* sender, const char* signal,
std::function<void()> callback);
template <typename... Args>
_detail::ClosureBase* NewClosure(QObject* sender, const char* signal,
std::function<void(Args...)> callback,
const Args&... args) {
return NewClosure(sender, signal, std::bind(callback, args...));
}
template <typename... Args>
_detail::ClosureBase* NewClosure(QObject* sender, const char* signal,
void (*callback)(Args...),
const Args&... args) {
return NewClosure(sender, signal, std::bind(callback, args...));
}
template <typename T, typename Unused, typename... Args>
_detail::ClosureBase* NewClosure(QObject* sender, const char* signal,
T* receiver, Unused (T::*callback)(Args...),
const Args&... args) {
return NewClosure(sender, signal, std::bind(callback, receiver, args...));
}
2015-11-26 19:34:41 +01:00
template <typename T, typename... Args>
_detail::ClosureBase* NewClosure(QFuture<T> future, QObject* receiver,
const char* slot, const Args&... args) {
QFutureWatcher<T>* watcher = new QFutureWatcher<T>;
QObject::connect(watcher, SIGNAL(finished()), watcher, SLOT(deleteLater()));
watcher->setFuture(future);
2015-11-26 19:59:44 +01:00
return NewClosure(watcher, SIGNAL(finished()), receiver, slot, args...);
2015-11-26 19:34:41 +01:00
}
2015-11-27 15:22:59 +01:00
template <typename T, typename F, typename... Args>
_detail::ClosureBase* NewClosure(QFuture<T> future, const F& callback,
const Args&... args) {
QFutureWatcher<T>* watcher = new QFutureWatcher<T>;
QObject::connect(watcher, SIGNAL(finished()), watcher, SLOT(deleteLater()));
watcher->setFuture(future);
2015-11-27 15:22:59 +01:00
return NewClosure(watcher, SIGNAL(finished()), callback, args...);
}
void DoAfter(QObject* receiver, const char* slot, int msec);
2015-07-20 15:35:13 +02:00
void DoAfter(std::function<void()> callback, std::chrono::milliseconds msec);
void DoInAMinuteOrSo(QObject* receiver, const char* slot);
2015-07-20 15:35:13 +02:00
template <typename R, typename P>
2015-11-26 19:34:41 +01:00
void DoAfter(std::function<void()> callback,
std::chrono::duration<R, P> duration) {
2015-07-20 15:35:13 +02:00
QTimer* timer = new QTimer;
timer->setSingleShot(true);
NewClosure(timer, SIGNAL(timeout()), callback);
QObject::connect(timer, SIGNAL(timeout()), timer, SLOT(deleteLater()));
std::chrono::milliseconds msec =
std::chrono::duration_cast<std::chrono::milliseconds>(duration);
timer->start(msec.count());
}
2011-10-04 18:26:40 +02:00
#endif // CLOSURE_H