summaryrefslogtreecommitdiffstats
path: root/async/src/future.h
blob: cadd96d766d9ba0341a4a43e9f0c6f08f3ba8b70 (plain)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/*
 * Copyright 2014  Daniel Vrátil <dvratil@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef FUTURE_H
#define FUTURE_H

class QEventLoop;

#include <type_traits>

#include <QSharedDataPointer>
#include <QPointer>
#include <QVector>
#include <QEventLoop>

namespace Async {

namespace Private {
class Execution;
class ExecutorBase;

typedef QSharedPointer<Execution> ExecutionPtr;

}

class FutureBase
{
    friend class Async::Private::Execution;

public:
    virtual ~FutureBase();

    virtual void setFinished() = 0;
    virtual bool isFinished() const = 0;
    virtual void setError(int code = 1, const QString &message = QString()) = 0;

protected:
    virtual void releaseExecution() = 0;

    class PrivateBase : public QSharedData
    {
    public:
        PrivateBase(const Async::Private::ExecutionPtr &execution);
        virtual ~PrivateBase();

        void releaseExecution();

    private:
        QWeakPointer<Async::Private::Execution> mExecution;
    };

    FutureBase();
    FutureBase(const FutureBase &other);
};

template<typename T>
class FutureWatcher;

template<typename T>
class Future;

template<typename T>
class FutureGeneric : public FutureBase
{
    friend class FutureWatcher<T>;

public:
    void setFinished()
    {
        if (d->finished) {
            return;
        }
        d->finished = true;
        for (auto watcher : d->watchers) {
            if (watcher) {
                watcher->futureReadyCallback();
            }
        }
    }

    bool isFinished() const
    {
        return d->finished;
    }

    void setError(int errorCode, const QString &message)
    {
        d->errorCode = errorCode;
        d->errorMessage = message;
        setFinished();
    }

    int errorCode() const
    {
        return d->errorCode;
    }

    QString errorMessage() const
    {
        return d->errorMessage;
    }

    void waitForFinished()
    {
        if (isFinished()) {
            return;
        }
        FutureWatcher<T> watcher;
        QEventLoop eventLoop;
        QObject::connect(&watcher, &Async::FutureWatcher<T>::futureReady,
                         &eventLoop, &QEventLoop::quit);
        watcher.setFuture(*static_cast<Async::Future<T>*>(this));
        eventLoop.exec();
    }

protected:
    FutureGeneric(const Async::Private::ExecutionPtr &execution)
        : FutureBase()
        , d(new Private(execution))
    {}

    FutureGeneric(const FutureGeneric<T> &other)
        : FutureBase(other)
        , d(other.d)
    {}

    class Private : public FutureBase::PrivateBase
    {
    public:
        Private(const Async::Private::ExecutionPtr &execution)
            : FutureBase::PrivateBase(execution)
            , finished(false)
            , errorCode(0)
        {}

        typename std::conditional<std::is_void<T>::value, int /* dummy */, T>::type
        value;

        QVector<QPointer<FutureWatcher<T>>> watchers;
        bool finished;
        int errorCode;
        QString errorMessage;
    };

    QExplicitlySharedDataPointer<Private> d;

    void releaseExecution()
    {
        d->releaseExecution();
    }

    void addWatcher(FutureWatcher<T> *watcher)
    {
        d->watchers.append(QPointer<FutureWatcher<T>>(watcher));
    }
};

template<typename T>
class Future : public FutureGeneric<T>
{
    friend class Async::Private::ExecutorBase;

    template<typename T_>
    friend class Async::FutureWatcher;

public:
    Future()
        : FutureGeneric<T>(Async::Private::ExecutionPtr())
    {}

    Future(const Future<T> &other)
        : FutureGeneric<T>(other)
    {}

    void setValue(const T &value)
    {
        this->d->value = value;
    }

    T value() const
    {
        return this->d->value;
    }

protected:
    Future(const Async::Private::ExecutionPtr &execution)
        : FutureGeneric<T>(execution)
    {}

};

template<>
class Future<void> : public FutureGeneric<void>
{
    friend class Async::Private::ExecutorBase;

    template<typename T_>
    friend class Async::FutureWatcher;

public:
    Future()
        : FutureGeneric<void>(Async::Private::ExecutionPtr())
    {}

    Future(const Future<void> &other)
        : FutureGeneric<void>(other)
    {}

protected:
    Future(const Async::Private::ExecutionPtr &execution)
        : FutureGeneric<void>(execution)
    {}
};


class FutureWatcherBase : public QObject
{
    Q_OBJECT

protected:
    FutureWatcherBase(QObject *parent = nullptr);
    virtual ~FutureWatcherBase();

Q_SIGNALS:
    void futureReady();
};

template<typename T>
class FutureWatcher : public FutureWatcherBase
{
    friend class Async::FutureGeneric<T>;

public:
    FutureWatcher(QObject *parent = nullptr)
        : FutureWatcherBase(parent)
    {}

    ~FutureWatcher()
    {}

    void setFuture(const Async::Future<T> &future)
    {
        mFuture = future;
        mFuture.addWatcher(this);
        if (future.isFinished()) {
            futureReadyCallback();
        }
    }

    Async::Future<T> future() const
    {
        return mFuture;
    }

private:
    void futureReadyCallback()
    {
        Q_EMIT futureReady();
    }

    Async::Future<T> mFuture;
};

} // namespace Async

#endif // FUTURE_H