1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/******************************************************************************
* Copyright (C) 2019 Kitsune Ral <kitsune-ral@users.sf.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include "util.h"
#include <QtCore/QPointer>
namespace Quotient {
namespace _impl {
template <typename... ArgTs>
using decorated_slot_tt =
std::function<void(QMetaObject::Connection&, const ArgTs&...)>;
template <typename SenderT, typename SignalT, typename ContextT, typename... ArgTs>
inline QMetaObject::Connection
connectDecorated(SenderT* sender, SignalT signal, ContextT* context,
decorated_slot_tt<ArgTs...> decoratedSlot,
Qt::ConnectionType connType)
{
// See https://bugreports.qt.io/browse/QTBUG-60339
#if QT_VERSION < QT_VERSION_CHECK(5, 10, 0)
auto pc = std::make_shared<QMetaObject::Connection>();
#else
auto pc = std::make_unique<QMetaObject::Connection>();
#endif
auto& c = *pc; // Resolve a reference before pc is moved to lambda
// Perfect forwarding doesn't work through signal-slot connections -
// arguments are always copied (at best - COWed) to the context of
// the slot. Therefore the slot decorator receives const ArgTs&...
// rather than ArgTs&&...
// TODO: std::bind_front() instead of lambda.
c = QObject::connect(sender, signal, context,
[pc = std::move(pc),
decoratedSlot = std::move(decoratedSlot)](const ArgTs&... args) {
Q_ASSERT(*pc); // If it's been triggered, it should exist
decoratedSlot(*pc, args...);
},
connType);
return c;
}
template <typename SenderT, typename SignalT, typename ContextT,
typename... ArgTs>
inline QMetaObject::Connection
connectUntil(SenderT* sender, SignalT signal, ContextT* context,
std::function<bool(ArgTs...)> functor,
Qt::ConnectionType connType)
{
return connectDecorated(sender, signal, context,
decorated_slot_tt<ArgTs...>(
[functor = std::move(functor)](QMetaObject::Connection& c,
const ArgTs&... args) {
if (functor(args...))
QObject::disconnect(c);
}),
connType);
}
template <typename SenderT, typename SignalT, typename ContextT,
typename... ArgTs>
inline QMetaObject::Connection
connectSingleShot(SenderT* sender, SignalT signal, ContextT* context,
std::function<void(ArgTs...)> slot,
Qt::ConnectionType connType)
{
return connectDecorated(sender, signal, context,
decorated_slot_tt<ArgTs...>(
[slot = std::move(slot)](QMetaObject::Connection& c,
const ArgTs&... args) {
QObject::disconnect(c);
slot(args...);
}),
connType);
}
} // namespace _impl
/*! \brief Create a connection that self-disconnects when its "slot" returns true
*
* A slot accepted by connectUntil() is different from classic Qt slots
* in that its return value must be bool, not void. The slot's return value
* controls whether the connection should be kept; if the slot returns false,
* the connection remains; upon returning true, the slot is disconnected from
* the signal. Because of a different slot signature connectUntil() doesn't
* accept member functions as QObject::connect or Quotient::connectSingleShot
* do; you should pass a lambda or a pre-bound member function to it.
*/
template <typename SenderT, typename SignalT, typename ContextT, typename FunctorT>
inline auto connectUntil(SenderT* sender, SignalT signal, ContextT* context,
const FunctorT& slot,
Qt::ConnectionType connType = Qt::AutoConnection)
{
return _impl::connectUntil(sender, signal, context, wrap_in_function(slot),
connType);
}
/// Create a connection that self-disconnects after triggering on the signal
template <typename SenderT, typename SignalT, typename ContextT, typename FunctorT>
inline auto connectSingleShot(SenderT* sender, SignalT signal,
ContextT* context, const FunctorT& slot,
Qt::ConnectionType connType = Qt::AutoConnection)
{
return _impl::connectSingleShot(
sender, signal, context, wrap_in_function(slot), connType);
}
// Specialisation for usual Qt slots passed as pointers-to-members.
template <typename SenderT, typename SignalT, typename ReceiverT,
typename SlotObjectT, typename... ArgTs>
inline auto connectSingleShot(SenderT* sender, SignalT signal,
ReceiverT* receiver,
void (SlotObjectT::*slot)(ArgTs...),
Qt::ConnectionType connType = Qt::AutoConnection)
{
// TODO: when switching to C++20, use std::bind_front() instead
return _impl::connectSingleShot(sender, signal, receiver,
wrap_in_function(
[receiver, slot](const ArgTs&... args) {
(receiver->*slot)(args...);
}),
connType);
}
/*! \brief A guard pointer that disconnects an interested object upon destruction
*
* It's almost QPointer<> except that you have to initialise it with one
* more additional parameter - a pointer to a QObject that will be
* disconnected from signals of the underlying pointer upon the guard's
* destruction. Note that destructing the guide doesn't destruct either QObject.
*/
template <typename T>
class ConnectionsGuard : public QPointer<T> {
public:
ConnectionsGuard(T* publisher, QObject* subscriber)
: QPointer<T>(publisher), subscriber(subscriber)
{}
~ConnectionsGuard()
{
if (*this)
(*this)->disconnect(subscriber);
}
ConnectionsGuard(ConnectionsGuard&&) = default;
ConnectionsGuard& operator=(ConnectionsGuard&&) = default;
Q_DISABLE_COPY(ConnectionsGuard)
using QPointer<T>::operator=;
private:
QObject* subscriber;
};
} // namespace Quotient
|
