summaryrefslogtreecommitdiffstats
path: root/tests/auto/shared/model_utilities.h
blob: 207d601718170a8d264ce238fde1bb73642f4348 (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
/****************************************************************************
**
** Copyright (C) 2017 Ford Motor Company
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtRemoteObjects module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <QtTest/QtTest>
#include <QModelIndex>

// Helper class which can be used by tests for starting a task and
// waiting for its completion. It takes care of running an event
// loop while waiting, until finished() method is called (or the
// timeout is reached).
class WaitHelper : public QObject
{
    Q_OBJECT

public:
    WaitHelper() { m_promise.reportStarted(); }

    ~WaitHelper()
    {
        if (m_promise.future().isRunning())
            m_promise.reportFinished();
    }

    /*
        Starts an event loop and waits until finish() method is called
        or the timeout is reached.
    */
    bool wait(int timeout = 30000)
    {
        if (m_promise.future().isFinished())
            return true;

        QFutureWatcher<void> watcher;
        QSignalSpy watcherSpy(&watcher, &QFutureWatcher<void>::finished);
        watcher.setFuture(m_promise.future());
        return watcherSpy.wait(timeout);
    }

protected:
    /*
        The derived classes need to call this method to stop waiting.
    */
    void finish() { m_promise.reportFinished(); }

private:
    QFutureInterface<void> m_promise;
};

namespace {

inline bool compareIndices(const QModelIndex &lhs, const QModelIndex &rhs)
{
    QModelIndex left = lhs;
    QModelIndex right = rhs;
    while (left.row() == right.row() && left.column() == right.column() && left.isValid() && right.isValid()) {
        left = left.parent();
        right = right.parent();
    }
    if (left.isValid() || right.isValid())
        return false;
    return true;
}

struct WaitForDataChanged : public WaitHelper
{
    WaitForDataChanged(const QAbstractItemModel *model, const QVector<QModelIndex> &pending)
        : WaitHelper(), m_model(model), m_pending(pending)
    {
        connect(m_model, &QAbstractItemModel::dataChanged, this,
                [this](const QModelIndex &topLeft, const QModelIndex &bottomRight,
                       const QVector<int> &roles) {
                    Q_UNUSED(roles)

                    checkAndRemoveRange(topLeft, bottomRight);
                    if (m_pending.isEmpty())
                        finish();
                });
    }

    void checkAndRemoveRange(const QModelIndex &topLeft, const QModelIndex &bottomRight)
    {
        QVERIFY(topLeft.parent() == bottomRight.parent());
        const auto isInRange = [topLeft, bottomRight] (const QModelIndex &pending) noexcept -> bool {
            if (pending.isValid()  && compareIndices(pending.parent(), topLeft.parent())) {
                const bool fitLeft = topLeft.column() <= pending.column();
                const bool fitRight = bottomRight.column() >= pending.column();
                const bool fitTop = topLeft.row() <= pending.row();
                const bool fitBottom = bottomRight.row() >= pending.row();
                if (fitLeft && fitRight && fitTop && fitBottom)
                    return true;
            }
            return false;
        };
        m_pending.erase(std::remove_if(m_pending.begin(), m_pending.end(), isInRange),
                        m_pending.end());
    }

private:
    const QAbstractItemModel *m_model = nullptr;
    QVector<QModelIndex> m_pending;
};

} // namespace