summaryrefslogtreecommitdiff
path: root/src/intent-server-lib/intentmodel.cpp
blob: f4b1a76a4e0f6616dc0c442ff50abb84c4bb495c (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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#include <QQmlContext>
#include <QQmlEngine>
#include <QQmlInfo>
#include <QJSEngine>
#include <QJSValueList>

#include "global.h"
#include "logging.h"
#include "intentserver.h"
#include "intentmodel.h"
#include "intent.h"


/*!
    \qmltype IntentModel
    \inherits QSortFilterProxyModel
    \ingroup system-ui-instantiable
    \inqmlmodule QtApplicationManager.SystemUI
    \brief A proxy model for the IntentServer singleton.

    The IntentModel type provides a customizable model that can be used to tailor the
    IntentServer model to your needs. The IntentServer singleton is a model itself,
    that includes all available intents. In contrast, the IntentModel supports filtering
    and sorting.

    Since the IntentModel is based on the IntentServer model, the latter is referred
    to as the \e source model. The IntentModel includes the same \l {IntentServer Roles}
    {roles} as the IntentServer model.

    \note If you require a model with all intents, with no filtering whatsoever, you should
    use the IntentServer directly, as it has better performance.

    The following code snippet displays the icons of all the intents belonging to the \c
    com.pelagicore.test package:

    \qml
    import QtQuick 2.6
    import QtApplicationManager.SystemUI 2.0

    ListView {
        model: IntentModel {
            filterFunction: function(intent) {
                return intent.packageId == 'com.pelagicore.test'
            }
        }

        delegate: Image {
            source: icon
        }
    }
    \endqml
*/

/*!
    \qmlproperty int IntentModel::count
    \readonly

    Holds the number of intents included in this model.
*/

/*!
    \qmlproperty var IntentModel::filterFunction

    A JavaScript function callback that is invoked for each intent in the IntentServer
    source model. This function gets one IntentObject parameter and must return a Boolean.
    If the intent passed should be included in this model, then the function must return
    \c true; \c false otherwise.

    If you need no filtering at all, you should set this property to an undefined (the default) or
    null value.

    \note Whenever this function is changed, the filter is reevaluated. Changes in the source model
    are reflected. Since the type is derived from QSortFilterProxyModel, the
    \l {QSortFilterProxyModel::invalidate()}{invalidate()} slot can be used to force a reevaluation.
*/

/*!
    \qmlproperty var IntentModel::sortFunction

    A JavaScript function callback that is invoked to sort the intents in this model. This function
    gets two IntentObject parameters and must return a Boolean. If the first intent should have a
    smaller index in this model than the second, the function must return \c true; \c false
    otherwise.

    If you need no sorting at all, you should set this property to an undefined (the default) or
    null value.

    \note Whenever this function is changed, the model is sorted. Changes in the source model are
    reflected. Since the type is derived from QSortFilterProxyModel, the
    \l {QSortFilterProxyModel::invalidate()}{invalidate()} slot can be used to force a sort.
*/


QT_BEGIN_NAMESPACE_AM


class IntentModelPrivate
{
public:
    QJSEngine *m_engine = nullptr;
    QJSValue m_filterFunction;
    QJSValue m_sortFunction;
};


IntentModel::IntentModel(QObject *parent)
    : QSortFilterProxyModel(parent)
    , d(new IntentModelPrivate())
{
    setSourceModel(IntentServer::instance());

    connect(this, &QAbstractItemModel::rowsInserted, this, &IntentModel::countChanged);
    connect(this, &QAbstractItemModel::rowsRemoved, this, &IntentModel::countChanged);
    connect(this, &QAbstractItemModel::layoutChanged, this, &IntentModel::countChanged);
    connect(this, &QAbstractItemModel::modelReset, this, &IntentModel::countChanged);
}

int IntentModel::count() const
{
    return rowCount();
}

bool IntentModel::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const
{
    Q_UNUSED(source_parent)

    if (!d->m_engine)
        d->m_engine = getJSEngine();
    if (!d->m_engine)
        qCWarning(LogSystem) << "IntentModel can't filter without a JavaScript engine";

    if (d->m_engine && d->m_filterFunction.isCallable()) {
        const QObject *intent = IntentServer::instance()->intent(source_row);
        QJSValueList args = { d->m_engine->newQObject(const_cast<QObject*>(intent)) };
        return d->m_filterFunction.call(args).toBool();
    }

    return true;
}

bool IntentModel::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const
{
    if (!d->m_engine)
        d->m_engine = getJSEngine();
    if (!d->m_engine)
        qCWarning(LogSystem) << "IntentModel can't sort without a JavaScript engine";

    if (d->m_engine && d->m_sortFunction.isCallable()) {
        const QObject *intent1 = IntentServer::instance()->intent(source_left.row());
        const QObject *intent2 = IntentServer::instance()->intent(source_right.row());
        QJSValueList args = { d->m_engine->newQObject(const_cast<QObject*>(intent1)),
                              d->m_engine->newQObject(const_cast<QObject*>(intent2)) };
        return d->m_sortFunction.call(args).toBool();
    }

    return QSortFilterProxyModel::lessThan(source_left, source_right);
}

QJSValue IntentModel::filterFunction() const
{
    return d->m_filterFunction;
}

void IntentModel::setFilterFunction(const QJSValue &callback)
{
    if (!callback.equals(d->m_filterFunction)) {
        d->m_filterFunction = callback;
        emit filterFunctionChanged();
        invalidateFilter();
    }
}

QJSValue IntentModel::sortFunction() const
{
    return d->m_sortFunction;
}

void IntentModel::setSortFunction(const QJSValue &callback)
{
    if (!callback.equals(d->m_sortFunction)) {
        d->m_sortFunction = callback;
        emit sortFunctionChanged();
        invalidate();
        sort(0);
    }
}

/*!
    \qmlmethod int IntentModel::indexOfIntent(string intentId, string applicationId, var parameters)

    Maps the intent corresponding to the given \a intentId, \a applicationId and \a parameters to
    its position within this model. Returns \c -1 if the specified intent is invalid, or not part of
    this model.
*/
int IntentModel::indexOfIntent(const QString &intentId, const QString &applicationId,
                               const QVariantMap &parameters) const
{
    int idx = IntentServer::instance()->indexOfIntent(intentId, applicationId, parameters);
    return idx != -1 ? mapFromSource(idx) : idx;
}

/*!
    \qmlmethod int IntentModel::indexOfIntent(IntentObject intent)

    Maps the \a intent to its position within this model. Returns \c -1 if the specified intent is
    invalid, or not part of this model.
*/
int IntentModel::indexOfIntent(Intent *intent)
{
    int idx = IntentServer::instance()->indexOfIntent(intent);
    return idx != -1 ? mapFromSource(idx) : idx;

}

/*!
    \qmlmethod int IntentModel::mapToSource(int index)

    Maps an intent's \a index in this model to the corresponding index in the
    IntentServer model. Returns \c -1 if the specified \a index is invalid.
*/
int IntentModel::mapToSource(int ourIndex) const
{
    return QSortFilterProxyModel::mapToSource(index(ourIndex, 0)).row();
}

/*!
    \qmlmethod int IntentModel::mapFromSource(int index)

    Maps an intenet's \a index from the IntentServer model to the corresponding index in
    this model. Returns \c -1 if the specified \a index is invalid.
*/
int IntentModel::mapFromSource(int sourceIndex) const
{
    return QSortFilterProxyModel::mapFromSource(sourceModel()->index(sourceIndex, 0)).row();
}

QJSEngine *IntentModel::getJSEngine() const
{
    QQmlContext *context = QQmlEngine::contextForObject(this);
    return context ? reinterpret_cast<QJSEngine*>(context->engine()) : nullptr;
}

QT_END_NAMESPACE_AM