summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qeventdispatcher_winrt.cpp
blob: aec09816779a2c2132aa15175d396c7461a854bf (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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** 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.GPL 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qeventdispatcher_winrt_p.h"

#include <QtCore/QCoreApplication>
#include <QtCore/QThread>
#include <QtCore/QHash>
#include <QtCore/qfunctions_winrt.h>
#include <private/qabstracteventdispatcher_p.h>
#include <private/qcoreapplication_p.h>

#include <wrl.h>
#include <windows.foundation.h>
#include <windows.system.threading.h>
#include <windows.ui.core.h>
#include <windows.applicationmodel.core.h>
using namespace Microsoft::WRL;
using namespace Microsoft::WRL::Wrappers;
using namespace ABI::Windows::System::Threading;
using namespace ABI::Windows::Foundation;
using namespace ABI::Windows::UI::Core;
using namespace ABI::Windows::ApplicationModel::Core;

QT_BEGIN_NAMESPACE

class QZeroTimerEvent : public QTimerEvent
{
public:
    explicit inline QZeroTimerEvent(int timerId)
        : QTimerEvent(timerId)
    { t = QEvent::ZeroTimerEvent; }
};

struct WinRTTimerInfo                           // internal timer info
{
    WinRTTimerInfo(int timerId, int timerInterval, Qt::TimerType timerType, QObject *object, QEventDispatcherWinRT *dispatcher)
        : isFinished(false), id(timerId), interval(timerInterval), timerType(timerType), obj(object), inTimerEvent(false), dispatcher(dispatcher)
    {
    }

    void cancel()
    {
        if (isFinished) {
            delete this;
            return;
        }
        isFinished = true;
        if (!timer)
            return;

        HRESULT hr = timer->Cancel();
        RETURN_VOID_IF_FAILED("Failed to cancel timer");
    }

    HRESULT timerExpired(IThreadPoolTimer *)
    {
        if (isFinished)
            return S_OK;
        if (dispatcher)
            QCoreApplication::postEvent(dispatcher, new QTimerEvent(id));
        return S_OK;
    }

    HRESULT timerDestroyed(IThreadPoolTimer *)
    {
        if (isFinished)
            delete this;
        else
            isFinished = true;
        return S_OK;
    }

    bool isFinished;
    int id;
    int interval;
    Qt::TimerType timerType;
    quint64 timeout;                            // - when to actually fire
    QObject *obj;                               // - object to receive events
    bool inTimerEvent;
    ComPtr<IThreadPoolTimer> timer;
    QPointer<QEventDispatcherWinRT> dispatcher;
};

class QEventDispatcherWinRTPrivate : public QAbstractEventDispatcherPrivate
{
    Q_DECLARE_PUBLIC(QEventDispatcherWinRT)

public:
    QEventDispatcherWinRTPrivate();
    ~QEventDispatcherWinRTPrivate();

private:
    QHash<int, WinRTTimerInfo*> timerDict;

    ComPtr<IThreadPoolTimerStatics> timerFactory;
    ComPtr<ICoreDispatcher> coreDispatcher;
    QPointer<QThread> thread;

    bool interrupt;

    void fetchCoreDispatcher()
    {
        ComPtr<ICoreImmersiveApplication> application;
        HRESULT hr = RoGetActivationFactory(HString::MakeReference(RuntimeClass_Windows_ApplicationModel_Core_CoreApplication).Get(),
                                            IID_PPV_ARGS(&application));
        RETURN_VOID_IF_FAILED("Failed to get the application factory");

        ComPtr<ICoreApplicationView> view;
        hr = application->get_MainView(&view);
        RETURN_VOID_IF_FAILED("Failed to get the main view");

        ComPtr<ICoreApplicationView2> view2;
        hr = view.As(&view2);
        RETURN_VOID_IF_FAILED("Failed to cast the main view");

        hr = view2->get_Dispatcher(&coreDispatcher);
        if (hr == HRESULT_FROM_WIN32(ERROR_NOT_FOUND)) // expected in thread pool cases
            return;
        RETURN_VOID_IF_FAILED("Failed to get core dispatcher");

        thread = QThread::currentThread();
    }
};

QEventDispatcherWinRT::QEventDispatcherWinRT(QObject *parent)
    : QAbstractEventDispatcher(*new QEventDispatcherWinRTPrivate, parent)
{
    Q_D(QEventDispatcherWinRT);

    // Special treatment for the WinMain thread, as it is created before the UI
    static bool firstThread = true;
    if (firstThread) {
        firstThread = false;
        return;
    }

    d->fetchCoreDispatcher();
}

QEventDispatcherWinRT::QEventDispatcherWinRT(QEventDispatcherWinRTPrivate &dd, QObject *parent)
    : QAbstractEventDispatcher(dd, parent)
{ }

QEventDispatcherWinRT::~QEventDispatcherWinRT()
{
}

bool QEventDispatcherWinRT::processEvents(QEventLoop::ProcessEventsFlags flags)
{
    Q_D(QEventDispatcherWinRT);

    if (d->thread && d->thread != QThread::currentThread())
        d->fetchCoreDispatcher();

    bool didProcess = false;
    forever {
        // Process native events
        if (d->coreDispatcher) {
            boolean hasThreadAccess;
            HRESULT hr = d->coreDispatcher->get_HasThreadAccess(&hasThreadAccess);
            if (SUCCEEDED(hr) && hasThreadAccess) {
                hr = d->coreDispatcher->ProcessEvents(CoreProcessEventsOption_ProcessAllIfPresent);
                if (FAILED(hr))
                    qErrnoWarning(hr, "Failed to process events");
            }
        }

        // Dispatch accumulated user events
        didProcess = sendPostedEvents(flags);
        if (didProcess)
            break;

        if (d->interrupt)
            break;

        // Short sleep if there is nothing to do
        if (!(flags & QEventLoop::WaitForMoreEvents))
            break;

        emit aboutToBlock();
        WaitForSingleObjectEx(GetCurrentThread(), 1, FALSE);
        emit awake();
    }
    d->interrupt = false;
    return didProcess;
}

bool QEventDispatcherWinRT::sendPostedEvents(QEventLoop::ProcessEventsFlags flags)
{
    Q_UNUSED(flags);
    if (hasPendingEvents()) {
        QCoreApplication::sendPostedEvents();
        return true;
    }
    return false;
}

bool QEventDispatcherWinRT::hasPendingEvents()
{
    return qGlobalPostedEventsCount();
}

void QEventDispatcherWinRT::registerSocketNotifier(QSocketNotifier *notifier)
{
    Q_UNUSED(notifier);
    Q_UNIMPLEMENTED();
}
void QEventDispatcherWinRT::unregisterSocketNotifier(QSocketNotifier *notifier)
{
    Q_UNUSED(notifier);
    Q_UNIMPLEMENTED();
}

void QEventDispatcherWinRT::registerTimer(int timerId, int interval, Qt::TimerType timerType, QObject *object)
{
    Q_UNUSED(timerType);

    if (timerId < 1 || interval < 0 || !object) {
        qWarning("QEventDispatcherWinRT::registerTimer: invalid arguments");
        return;
    } else if (object->thread() != thread() || thread() != QThread::currentThread()) {
        qWarning("QObject::startTimer: timers cannot be started from another thread");
        return;
    }

    Q_D(QEventDispatcherWinRT);

    WinRTTimerInfo *t = new WinRTTimerInfo(timerId, interval, timerType, object, this);
    t->timeout = qt_msectime() + interval;
    d->timerDict.insert(t->id, t);

    // Don't use timer factory for zero-delay timers
    if (interval == 0u) {
        QCoreApplication::postEvent(this, new QZeroTimerEvent(timerId));
        return;
    }

    TimeSpan period;
    period.Duration = interval ? (interval * 10000) : 1; // TimeSpan is based on 100-nanosecond units
    HRESULT hr = d->timerFactory->CreatePeriodicTimerWithCompletion(
                Callback<ITimerElapsedHandler>(t, &WinRTTimerInfo::timerExpired).Get(), period,
                Callback<ITimerDestroyedHandler>(t, &WinRTTimerInfo::timerDestroyed).Get(), &t->timer);
    if (FAILED(hr)) {
        qErrnoWarning(hr, "Failed to create periodic timer");
        delete t;
        d->timerDict.remove(t->id);
        return;
    }
}

bool QEventDispatcherWinRT::unregisterTimer(int timerId)
{
    if (timerId < 1) {
        qWarning("QEventDispatcherWinRT::unregisterTimer: invalid argument");
        return false;
    }
    if (thread() != QThread::currentThread()) {
        qWarning("QObject::killTimer: timers cannot be stopped from another thread");
        return false;
    }

    Q_D(QEventDispatcherWinRT);

    WinRTTimerInfo *t = d->timerDict.take(timerId);
    if (!t)
        return false;

    t->cancel();
    return true;
}

bool QEventDispatcherWinRT::unregisterTimers(QObject *object)
{
    if (!object) {
        qWarning("QEventDispatcherWinRT::unregisterTimers: invalid argument");
        return false;
    }
    QThread *currentThread = QThread::currentThread();
    if (object->thread() != thread() || thread() != currentThread) {
        qWarning("QObject::killTimers: timers cannot be stopped from another thread");
        return false;
    }

    Q_D(QEventDispatcherWinRT);
    for (QHash<int, WinRTTimerInfo *>::iterator it = d->timerDict.begin(); it != d->timerDict.end();) {
        if (it.value()->obj == object) {
            it.value()->cancel();
            it = d->timerDict.erase(it);
            continue;
        }
        ++it;
    }
    return true;
}

QList<QAbstractEventDispatcher::TimerInfo> QEventDispatcherWinRT::registeredTimers(QObject *object) const
{
    if (!object) {
        qWarning("QEventDispatcherWinRT:registeredTimers: invalid argument");
        return QList<TimerInfo>();
    }

    Q_D(const QEventDispatcherWinRT);
    QList<TimerInfo> list;
    foreach (const WinRTTimerInfo *t, d->timerDict) {
        if (t->obj == object)
            list.append(TimerInfo(t->id, t->interval, t->timerType));
    }
    return list;
}

bool QEventDispatcherWinRT::registerEventNotifier(QWinEventNotifier *notifier)
{
    Q_UNUSED(notifier);
    Q_UNIMPLEMENTED();
    return false;
}

void QEventDispatcherWinRT::unregisterEventNotifier(QWinEventNotifier *notifier)
{
    Q_UNUSED(notifier);
    Q_UNIMPLEMENTED();
}

int QEventDispatcherWinRT::remainingTime(int timerId)
{
#ifndef QT_NO_DEBUG
    if (timerId < 1) {
        qWarning("QEventDispatcherWinRT::remainingTime: invalid argument");
        return -1;
    }
#endif

    Q_D(QEventDispatcherWinRT);
    if (WinRTTimerInfo *t = d->timerDict.value(timerId)) {
        const quint64 currentTime = qt_msectime();
        if (currentTime < t->timeout) {
            // time to wait
            return t->timeout - currentTime;
        } else {
            return 0;
        }
    }

#ifndef QT_NO_DEBUG
    qWarning("QEventDispatcherWinRT::remainingTime: timer id %d not found", timerId);
#endif
    return -1;
}

void QEventDispatcherWinRT::wakeUp()
{
}

void QEventDispatcherWinRT::interrupt()
{
    Q_D(QEventDispatcherWinRT);
    d->interrupt = true;
}

void QEventDispatcherWinRT::flush()
{
}

void QEventDispatcherWinRT::startingUp()
{
}

void QEventDispatcherWinRT::closingDown()
{
    Q_D(QEventDispatcherWinRT);
    d->timerDict.clear();
}

bool QEventDispatcherWinRT::event(QEvent *e)
{
    Q_D(QEventDispatcherWinRT);
    bool ret = false;
    switch (e->type()) {
    case QEvent::ZeroTimerEvent:
        ret = true;
        // fall through
    case QEvent::Timer: {
        QTimerEvent *timerEvent = static_cast<QTimerEvent *>(e);
        const int id = timerEvent->timerId();
        if (WinRTTimerInfo *t = d->timerDict.value(id)) {
            if (t->inTimerEvent) // but don't allow event to recurse
                break;
            t->inTimerEvent = true;

            QTimerEvent te(id);
            QCoreApplication::sendEvent(t->obj, &te);

            if (t = d->timerDict.value(id)) {
                if (t->interval == 0 && t->inTimerEvent) {
                    // post the next zero timer event as long as the timer was not restarted
                    QCoreApplication::postEvent(this, new QZeroTimerEvent(id));
                }
                t->inTimerEvent = false;
            }
        }
    }
    default:
        break;
    }
    return ret ? true : QAbstractEventDispatcher::event(e);
}

QEventDispatcherWinRTPrivate::QEventDispatcherWinRTPrivate()
    : interrupt(false)
{
    CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
    HRESULT hr = GetActivationFactory(HString::MakeReference(RuntimeClass_Windows_System_Threading_ThreadPoolTimer).Get(), &timerFactory);
    if (FAILED(hr))
        qWarning("QEventDispatcherWinRTPrivate::QEventDispatcherWinRTPrivate: Could not obtain timer factory: %lx", hr);
}

QEventDispatcherWinRTPrivate::~QEventDispatcherWinRTPrivate()
{
    CoUninitialize();
}

QT_END_NAMESPACE