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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "private/qdeclarativexmllistmodel_p.h"
#include <qdeclarativecontext.h>
#include <qdeclarativeengine_p.h>
#include <QDebug>
#include <QStringList>
#include <QQueue>
#include <QApplication>
#include <QThread>
#include <QMutex>
#include <QWaitCondition>
#include <QXmlQuery>
#include <QXmlResultItems>
#include <QXmlNodeModelIndex>
#include <QBuffer>
#include <QNetworkRequest>
#include <QNetworkReply>
#include <QTimer>
#include <private/qobject_p.h>
Q_DECLARE_METATYPE(QDeclarativeXmlQueryResult)
QT_BEGIN_NAMESPACE
typedef QPair<int, int> QDeclarativeXmlListRange;
#define XMLLISTMODEL_CLEAR_ID 0
/*!
\qmlclass XmlRole QDeclarativeXmlListModelRole
\ingroup qml-working-with-data
\since 4.7
\brief The XmlRole element allows you to specify a role for an XmlListModel.
\sa {QtDeclarative}
*/
/*!
\qmlproperty string XmlRole::name
The name for the role. This name is used to access the model data for this role.
For example, the following model has a role named "title", which can be accessed
from the view's delegate:
\qml
XmlListModel {
id: xmlModel
...
XmlRole { name: "title"; query: "title/string()" }
}
ListView {
model: xmlModel
delegate: Text { text: title }
}
\endqml
*/
/*!
\qmlproperty string XmlRole::query
The relative XPath expression query for this role. The query must be relative; it cannot start
with a '/'.
For example, if there is an XML document like this:
\quotefile doc/src/snippets/declarative/xmlrole.xml
Here are some valid XPath expressions for XmlRole queries on this document:
\snippet doc/src/snippets/declarative/xmlrole.qml 0
\dots 4
\snippet doc/src/snippets/declarative/xmlrole.qml 1
See the \l{http://www.w3.org/TR/xpath20/}{W3C XPath 2.0 specification} for more information.
*/
/*!
\qmlproperty bool XmlRole::isKey
Defines whether this is a key role.
Key roles are used to to determine whether a set of values should
be updated or added to the XML list model when XmlListModel::reload()
is called.
\sa XmlListModel
*/
struct XmlQueryJob
{
int queryId;
QByteArray data;
QString query;
QString namespaces;
QStringList roleQueries;
QList<void*> roleQueryErrorId; // the ptr to send back if there is an error
QStringList keyRoleQueries;
QStringList keyRoleResultsCache;
};
class QDeclarativeXmlQuery : public QThread
{
Q_OBJECT
public:
QDeclarativeXmlQuery(QObject *parent=0)
: QThread(parent), m_quit(false), m_abortQueryId(-1), m_queryIds(XMLLISTMODEL_CLEAR_ID + 1) {
qRegisterMetaType<QDeclarativeXmlQueryResult>("QDeclarativeXmlQueryResult");
m_currentJob.queryId = -1;
}
~QDeclarativeXmlQuery() {
m_mutex.lock();
m_quit = true;
m_condition.wakeOne();
m_mutex.unlock();
wait();
}
void abort(int id) {
QMutexLocker locker(&m_mutex);
QQueue<XmlQueryJob>::iterator it;
for (it = m_jobs.begin(); it != m_jobs.end(); ++it) {
if ((*it).queryId == id) {
m_jobs.erase(it);
return;
}
}
m_abortQueryId = id;
}
int doQuery(QString query, QString namespaces, QByteArray data, QList<QDeclarativeXmlListModelRole *> *roleObjects, QStringList keyRoleResultsCache) {
QMutexLocker locker(&m_mutex);
XmlQueryJob job;
job.queryId = m_queryIds;
job.data = data;
job.query = QLatin1String("doc($src)") + query;
job.namespaces = namespaces;
job.keyRoleResultsCache = keyRoleResultsCache;
for (int i=0; i<roleObjects->count(); i++) {
if (!roleObjects->at(i)->isValid()) {
job.roleQueries << QString();
continue;
}
job.roleQueries << roleObjects->at(i)->query();
job.roleQueryErrorId << static_cast<void*>(roleObjects->at(i));
if (roleObjects->at(i)->isKey())
job.keyRoleQueries << job.roleQueries.last();
}
m_jobs.enqueue(job);
m_queryIds++;
if (!isRunning())
start(QThread::IdlePriority);
else
m_condition.wakeOne();
return job.queryId;
}
Q_SIGNALS:
void queryCompleted(const QDeclarativeXmlQueryResult &);
void error(void*, const QString&);
protected:
void run() {
while (!m_quit) {
m_mutex.lock();
if (!m_jobs.isEmpty())
m_currentJob = m_jobs.dequeue();
m_mutex.unlock();
QDeclarativeXmlQueryResult r;
if (m_currentJob.queryId != -1) {
doQueryJob();
doSubQueryJob();
r.queryId = m_currentJob.queryId;
r.size = m_size;
r.data = m_modelData;
r.inserted = m_insertedItemRanges;
r.removed = m_removedItemRanges;
r.keyRoleResultsCache = m_currentJob.keyRoleResultsCache;
}
m_mutex.lock();
if (m_currentJob.queryId != -1 && m_abortQueryId != m_currentJob.queryId)
emit queryCompleted(r);
if (m_jobs.isEmpty())
m_condition.wait(&m_mutex);
m_currentJob.queryId = -1;
m_abortQueryId = -1;
m_mutex.unlock();
}
}
private:
void doQueryJob();
void doSubQueryJob();
void getValuesOfKeyRoles(QStringList *values, QXmlQuery *query) const;
void addIndexToRangeList(QList<QDeclarativeXmlListRange> *ranges, int index) const;
private:
QMutex m_mutex;
QWaitCondition m_condition;
QQueue<XmlQueryJob> m_jobs;
XmlQueryJob m_currentJob;
bool m_quit;
int m_abortQueryId;
QString m_prefix;
int m_size;
int m_queryIds;
QList<QList<QVariant> > m_modelData;
QList<QDeclarativeXmlListRange> m_insertedItemRanges;
QList<QDeclarativeXmlListRange> m_removedItemRanges;
};
Q_GLOBAL_STATIC(QDeclarativeXmlQuery, globalXmlQuery)
void QDeclarativeXmlQuery::doQueryJob()
{
Q_ASSERT(m_currentJob.queryId != -1);
QString r;
QXmlQuery query;
QBuffer buffer(&m_currentJob.data);
buffer.open(QIODevice::ReadOnly);
query.bindVariable(QLatin1String("src"), &buffer);
query.setQuery(m_currentJob.namespaces + m_currentJob.query);
query.evaluateTo(&r);
//always need a single root element
QByteArray xml = "<dummy:items xmlns:dummy=\"http://qtsotware.com/dummy\">\n" + r.toUtf8() + "</dummy:items>";
QBuffer b(&xml);
b.open(QIODevice::ReadOnly);
QString namespaces = QLatin1String("declare namespace dummy=\"http://qtsotware.com/dummy\";\n") + m_currentJob.namespaces;
QString prefix = QLatin1String("doc($inputDocument)/dummy:items") +
m_currentJob.query.mid(m_currentJob.query.lastIndexOf(QLatin1Char('/')));
//figure out how many items we are dealing with
int count = -1;
{
QXmlResultItems result;
QXmlQuery countquery;
countquery.bindVariable(QLatin1String("inputDocument"), &b);
countquery.setQuery(namespaces + QLatin1String("count(") + prefix + QLatin1Char(')'));
countquery.evaluateTo(&result);
QXmlItem item(result.next());
if (item.isAtomicValue())
count = item.toAtomicValue().toInt();
}
m_currentJob.data = xml;
m_prefix = namespaces + prefix + QLatin1Char('/');
m_size = 0;
if (count > 0)
m_size = count;
}
void QDeclarativeXmlQuery::getValuesOfKeyRoles(QStringList *values, QXmlQuery *query) const
{
Q_ASSERT(m_currentJob.queryId != -1);
const QStringList &keysQueries = m_currentJob.keyRoleQueries;
QString keysQuery;
if (keysQueries.count() == 1)
keysQuery = m_prefix + keysQueries[0];
else if (keysQueries.count() > 1)
keysQuery = m_prefix + QLatin1String("concat(") + keysQueries.join(QLatin1String(",")) + QLatin1String(")");
if (!keysQuery.isEmpty()) {
query->setQuery(keysQuery);
QXmlResultItems resultItems;
query->evaluateTo(&resultItems);
QXmlItem item(resultItems.next());
while (!item.isNull()) {
values->append(item.toAtomicValue().toString());
item = resultItems.next();
}
}
}
void QDeclarativeXmlQuery::addIndexToRangeList(QList<QDeclarativeXmlListRange> *ranges, int index) const {
if (ranges->isEmpty())
ranges->append(qMakePair(index, 1));
else if (ranges->last().first + ranges->last().second == index)
ranges->last().second += 1;
else
ranges->append(qMakePair(index, 1));
}
void QDeclarativeXmlQuery::doSubQueryJob()
{
Q_ASSERT(m_currentJob.queryId != -1);
m_modelData.clear();
QBuffer b(&m_currentJob.data);
b.open(QIODevice::ReadOnly);
QXmlQuery subquery;
subquery.bindVariable(QLatin1String("inputDocument"), &b);
QStringList keyRoleResults;
getValuesOfKeyRoles(&keyRoleResults, &subquery);
// See if any values of key roles have been inserted or removed.
m_insertedItemRanges.clear();
m_removedItemRanges.clear();
if (m_currentJob.keyRoleResultsCache.isEmpty()) {
m_insertedItemRanges << qMakePair(0, m_size);
} else {
if (keyRoleResults != m_currentJob.keyRoleResultsCache) {
QStringList temp;
for (int i=0; i<m_currentJob.keyRoleResultsCache.count(); i++) {
if (!keyRoleResults.contains(m_currentJob.keyRoleResultsCache[i]))
addIndexToRangeList(&m_removedItemRanges, i);
else
temp << m_currentJob.keyRoleResultsCache[i];
}
for (int i=0; i<keyRoleResults.count(); i++) {
if (temp.count() == i || keyRoleResults[i] != temp[i]) {
temp.insert(i, keyRoleResults[i]);
addIndexToRangeList(&m_insertedItemRanges, i);
}
}
}
}
m_currentJob.keyRoleResultsCache = keyRoleResults;
// Get the new values for each role.
//### we might be able to condense even further (query for everything in one go)
const QStringList &queries = m_currentJob.roleQueries;
for (int i = 0; i < queries.size(); ++i) {
QList<QVariant> resultList;
if (!queries[i].isEmpty()) {
subquery.setQuery(m_prefix + QLatin1String("(let $v := ") + queries[i] + QLatin1String(" return if ($v) then ") + queries[i] + QLatin1String(" else \"\")"));
if (subquery.isValid()) {
QXmlResultItems resultItems;
subquery.evaluateTo(&resultItems);
QXmlItem item(resultItems.next());
while (!item.isNull()) {
resultList << item.toAtomicValue(); //### we used to trim strings
item = resultItems.next();
}
} else {
emit error(m_currentJob.roleQueryErrorId.at(i), queries[i]);
}
}
//### should warn here if things have gone wrong.
while (resultList.count() < m_size)
resultList << QVariant();
m_modelData << resultList;
b.seek(0);
}
//this method is much slower, but works better for incremental loading
/*for (int j = 0; j < m_size; ++j) {
QList<QVariant> resultList;
for (int i = 0; i < m_roleObjects->size(); ++i) {
QDeclarativeXmlListModelRole *role = m_roleObjects->at(i);
subquery.setQuery(m_prefix.arg(j+1) + role->query());
if (role->isStringList()) {
QStringList data;
subquery.evaluateTo(&data);
resultList << QVariant(data);
//qDebug() << data;
} else {
QString s;
subquery.evaluateTo(&s);
if (role->isCData()) {
//un-escape
s.replace(QLatin1String("<"), QLatin1String("<"));
s.replace(QLatin1String(">"), QLatin1String(">"));
s.replace(QLatin1String("&"), QLatin1String("&"));
}
resultList << s.trimmed();
//qDebug() << s;
}
b.seek(0);
}
m_modelData << resultList;
}*/
}
class QDeclarativeXmlListModelPrivate : public QObjectPrivate
{
Q_DECLARE_PUBLIC(QDeclarativeXmlListModel)
public:
QDeclarativeXmlListModelPrivate()
: isComponentComplete(true), size(-1), highestRole(Qt::UserRole)
, reply(0), status(QDeclarativeXmlListModel::Null), progress(0.0)
, queryId(-1), roleObjects(), redirectCount(0) {}
void notifyQueryStarted(bool remoteSource) {
Q_Q(QDeclarativeXmlListModel);
progress = remoteSource ? 0.0 : 1.0;
status = QDeclarativeXmlListModel::Loading;
errorString.clear();
emit q->progressChanged(progress);
emit q->statusChanged(status);
}
bool isComponentComplete;
QUrl src;
QString xml;
QString query;
QString namespaces;
int size;
QList<int> roles;
QStringList roleNames;
int highestRole;
QNetworkReply *reply;
QDeclarativeXmlListModel::Status status;
QString errorString;
qreal progress;
int queryId;
QStringList keyRoleResultsCache;
QList<QDeclarativeXmlListModelRole *> roleObjects;
static void append_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list, QDeclarativeXmlListModelRole *role);
static void clear_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list);
static void removeAt_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list, int i);
static void insert_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list, int i, QDeclarativeXmlListModelRole *role);
QList<QList<QVariant> > data;
int redirectCount;
};
void QDeclarativeXmlListModelPrivate::append_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list, QDeclarativeXmlListModelRole *role)
{
QDeclarativeXmlListModel *_this = qobject_cast<QDeclarativeXmlListModel *>(list->object);
if (_this) {
int i = _this->d_func()->roleObjects.count();
_this->d_func()->roleObjects.append(role);
if (_this->d_func()->roleNames.contains(role->name())) {
qmlInfo(role) << QObject::tr("\"%1\" duplicates a previous role name and will be disabled.").arg(role->name());
return;
}
_this->d_func()->roles.insert(i, _this->d_func()->highestRole);
_this->d_func()->roleNames.insert(i, role->name());
++_this->d_func()->highestRole;
}
}
//### clear needs to invalidate any cached data (in data table) as well
// (and the model should emit the appropriate signals)
void QDeclarativeXmlListModelPrivate::clear_role(QDeclarativeListProperty<QDeclarativeXmlListModelRole> *list)
{
QDeclarativeXmlListModel *_this = static_cast<QDeclarativeXmlListModel *>(list->object);
_this->d_func()->roles.clear();
_this->d_func()->roleNames.clear();
_this->d_func()->roleObjects.clear();
}
/*!
\class QDeclarativeXmlListModel
\internal
*/
/*!
\qmlclass XmlListModel QDeclarativeXmlListModel
\ingroup qml-working-with-data
\since 4.7
\brief The XmlListModel element is used to specify a model using XPath expressions.
XmlListModel is used to create a model from XML data. It can be used as a data source
for view elements (such as ListView, PathView, GridView) and other elements that interact with model
data (such as \l Repeater).
For example, if there is a XML document at http://www.mysite.com/feed.xml like this:
\code
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
...
<channel>
<item>
<title>A blog post</title>
<pubDate>Sat, 07 Sep 2010 10:00:01 GMT</pubDate>
</item>
<item>
<title>Another blog post</title>
<pubDate>Sat, 07 Sep 2010 15:35:01 GMT</pubDate>
</item>
</channel>
</rss>
\endcode
A XmlListModel could create a model from this data, like this:
\qml
import Qt 4.7
XmlListModel {
id: xmlModel
source: "http://www.mysite.com/feed.xml"
query: "/rss/channel/item"
XmlRole { name: "title"; query: "title/string()" }
XmlRole { name: "pubDate"; query: "pubDate/string()" }
}
\endqml
The \l {XmlListModel::query}{query} value of "/rss/channel/item" specifies that the XmlListModel should generate
a model item for each \c <item> in the XML document.
The XmlRole objects define the
model item attributes. Here, each model item will have \c title and \c pubDate
attributes that match the \c title and \c pubDate values of its corresponding \c <item>.
(See \l XmlRole::query for more examples of valid XPath expressions for XmlRole.)
The model could be used in a ListView, like this:
\qml
ListView {
width: 180; height: 300
model: xmlModel
delegate: Text { text: title + ": " + pubDate }
}
\endqml
\image qml-xmllistmodel-example.png
The XmlListModel data is loaded asynchronously, and \l status
is set to \c XmlListModel.Ready when loading is complete.
Note this means when XmlListModel is used for a view, the view is not
populated until the model is loaded.
\section2 Using key XML roles
You can define certain roles as "keys" so that when reload() is called,
the model will only add and refresh data that contains new values for
these keys.
For example, if above role for "pubDate" was defined like this instead:
\qml
XmlRole { name: "pubDate"; query: "pubDate/string()"; isKey: true }
\endqml
Then when reload() is called, the model will only add and reload
items with a "pubDate" value that is not already
present in the model.
This is useful when displaying the contents of XML documents that
are incrementally updated (such as RSS feeds) to avoid repainting the
entire contents of a model in a view.
If multiple key roles are specified, the model only adds and reload items
with a combined value of all key roles that is not already present in
the model.
\sa {RSS News}
*/
QDeclarativeXmlListModel::QDeclarativeXmlListModel(QObject *parent)
: QListModelInterface(*(new QDeclarativeXmlListModelPrivate), parent)
{
connect(globalXmlQuery(), SIGNAL(queryCompleted(QDeclarativeXmlQueryResult)),
this, SLOT(queryCompleted(QDeclarativeXmlQueryResult)));
connect(globalXmlQuery(), SIGNAL(error(void*,QString)),
this, SLOT(queryError(void*,QString)));
}
QDeclarativeXmlListModel::~QDeclarativeXmlListModel()
{
}
/*!
\qmlproperty list<XmlRole> XmlListModel::roles
The roles to make available for this model.
*/
QDeclarativeListProperty<QDeclarativeXmlListModelRole> QDeclarativeXmlListModel::roleObjects()
{
Q_D(QDeclarativeXmlListModel);
QDeclarativeListProperty<QDeclarativeXmlListModelRole> list(this, d->roleObjects);
list.append = &QDeclarativeXmlListModelPrivate::append_role;
list.clear = &QDeclarativeXmlListModelPrivate::clear_role;
return list;
}
QHash<int,QVariant> QDeclarativeXmlListModel::data(int index, const QList<int> &roles) const
{
Q_D(const QDeclarativeXmlListModel);
QHash<int, QVariant> rv;
for (int i = 0; i < roles.size(); ++i) {
int role = roles.at(i);
int roleIndex = d->roles.indexOf(role);
rv.insert(role, roleIndex == -1 ? QVariant() : d->data.value(roleIndex).value(index));
}
return rv;
}
QVariant QDeclarativeXmlListModel::data(int index, int role) const
{
Q_D(const QDeclarativeXmlListModel);
int roleIndex = d->roles.indexOf(role);
return (roleIndex == -1) ? QVariant() : d->data.value(roleIndex).value(index);
}
/*!
\qmlproperty int XmlListModel::count
The number of data entries in the model.
*/
int QDeclarativeXmlListModel::count() const
{
Q_D(const QDeclarativeXmlListModel);
return d->size;
}
QList<int> QDeclarativeXmlListModel::roles() const
{
Q_D(const QDeclarativeXmlListModel);
return d->roles;
}
QString QDeclarativeXmlListModel::toString(int role) const
{
Q_D(const QDeclarativeXmlListModel);
int index = d->roles.indexOf(role);
if (index == -1)
return QString();
return d->roleNames.at(index);
}
/*!
\qmlproperty url XmlListModel::source
The location of the XML data source.
If both \c source and \l xml are set, \l xml is used.
*/
QUrl QDeclarativeXmlListModel::source() const
{
Q_D(const QDeclarativeXmlListModel);
return d->src;
}
void QDeclarativeXmlListModel::setSource(const QUrl &src)
{
Q_D(QDeclarativeXmlListModel);
if (d->src != src) {
d->src = src;
if (d->xml.isEmpty()) // src is only used if d->xml is not set
reload();
emit sourceChanged();
}
}
/*!
\qmlproperty string XmlListModel::xml
This property holds the XML data for this model, if set.
The text is assumed to be UTF-8 encoded.
If both \l source and \c xml are set, \c xml is used.
*/
QString QDeclarativeXmlListModel::xml() const
{
Q_D(const QDeclarativeXmlListModel);
return d->xml;
}
void QDeclarativeXmlListModel::setXml(const QString &xml)
{
Q_D(QDeclarativeXmlListModel);
if (d->xml != xml) {
d->xml = xml;
reload();
emit xmlChanged();
}
}
/*!
\qmlproperty string XmlListModel::query
An absolute XPath query representing the base query for creating model items
from this model's XmlRole objects. The query should start with '/' or '//'.
*/
QString QDeclarativeXmlListModel::query() const
{
Q_D(const QDeclarativeXmlListModel);
return d->query;
}
void QDeclarativeXmlListModel::setQuery(const QString &query)
{
Q_D(QDeclarativeXmlListModel);
if (!query.startsWith(QLatin1Char('/'))) {
qmlInfo(this) << QCoreApplication::translate("QDeclarativeXmlRoleList", "An XmlListModel query must start with '/' or \"//\"");
return;
}
if (d->query != query) {
d->query = query;
reload();
emit queryChanged();
}
}
/*!
\qmlproperty string XmlListModel::namespaceDeclarations
The namespace declarations to be used in the XPath queries.
The namespaces should be declared as in XQuery. For example, if a requested document
at http://mysite.com/feed.xml uses the namespace "http://www.w3.org/2005/Atom",
this can be declared as the default namespace:
\qml
XmlListModel {
source: "http://mysite.com/feed.xml"
query: "/feed/entry"
namespaceDeclarations: "declare default element namespace 'http://www.w3.org/2005/Atom';"
XmlRole { name: "title"; query: "title/string()" }
}
\endqml
*/
QString QDeclarativeXmlListModel::namespaceDeclarations() const
{
Q_D(const QDeclarativeXmlListModel);
return d->namespaces;
}
void QDeclarativeXmlListModel::setNamespaceDeclarations(const QString &declarations)
{
Q_D(QDeclarativeXmlListModel);
if (d->namespaces != declarations) {
d->namespaces = declarations;
reload();
emit namespaceDeclarationsChanged();
}
}
/*!
\qmlmethod object XmlListModel::get(int index)
Returns the item at \a index in the model.
For example, for a model like this:
\qml
XmlListModel {
id: model
source: "http://mysite.com/feed.xml"
query: "/feed/entry"
XmlRole { name: "title"; query: "title/string()" }
}
\endqml
This will access the \c title value for the first item in the model:
\qml
var title = model.get(0).title;
\endqml
*/
QScriptValue QDeclarativeXmlListModel::get(int index) const
{
Q_D(const QDeclarativeXmlListModel);
QScriptEngine *sengine = QDeclarativeEnginePrivate::getScriptEngine(qmlContext(this)->engine());
if (index < 0 || index >= count())
return sengine->undefinedValue();
QScriptValue sv = sengine->newObject();
for (int i=0; i<d->roleObjects.count(); i++)
sv.setProperty(d->roleObjects[i]->name(), sengine->toScriptValue(d->data.value(i).value(index)));
return sv;
}
/*!
\qmlproperty enumeration XmlListModel::status
Specifies the model loading status, which can be one of the following:
\list
\o XmlListModel.Null - No XML data has been set for this model.
\o XmlListModel.Ready - The XML data has been loaded into the model.
\o XmlListModel.Loading - The model is in the process of reading and loading XML data.
\o XmlListModel.Error - An error occurred while the model was loading. See errorString() for details
about the error.
\endlist
\sa progress
*/
QDeclarativeXmlListModel::Status QDeclarativeXmlListModel::status() const
{
Q_D(const QDeclarativeXmlListModel);
return d->status;
}
/*!
\qmlproperty real XmlListModel::progress
This indicates the current progress of the downloading of the XML data
source. This value ranges from 0.0 (no data downloaded) to
1.0 (all data downloaded). If the XML data is not from a remote source,
the progress becomes 1.0 as soon as the data is read.
Note that when the progress is 1.0, the XML data has been downloaded, but
it is yet to be loaded into the model at this point. Use the status
property to find out when the XML data has been read and loaded into
the model.
\sa status, source
*/
qreal QDeclarativeXmlListModel::progress() const
{
Q_D(const QDeclarativeXmlListModel);
return d->progress;
}
/*!
\qmlmethod void XmlListModel::errorString()
Returns a string description of the last error that occurred
if \l status is XmlListModel::Error.
*/
QString QDeclarativeXmlListModel::errorString() const
{
Q_D(const QDeclarativeXmlListModel);
return d->errorString;
}
void QDeclarativeXmlListModel::classBegin()
{
Q_D(QDeclarativeXmlListModel);
d->isComponentComplete = false;
}
void QDeclarativeXmlListModel::componentComplete()
{
Q_D(QDeclarativeXmlListModel);
d->isComponentComplete = true;
reload();
}
/*!
\qmlmethod XmlListModel::reload()
Reloads the model.
If no key roles have been specified, all existing model
data is removed, and the model is rebuilt from scratch.
Otherwise, items are only added if the model does not already
contain items with matching key role values.
\sa {Using key XML roles}, XmlRole::isKey
*/
void QDeclarativeXmlListModel::reload()
{
Q_D(QDeclarativeXmlListModel);
if (!d->isComponentComplete)
return;
globalXmlQuery()->abort(d->queryId);
d->queryId = -1;
if (d->size < 0)
d->size = 0;
if (d->reply) {
d->reply->abort();
if (d->reply) {
// abort will generally have already done this (and more)
d->reply->deleteLater();
d->reply = 0;
}
}
if (!d->xml.isEmpty()) {
d->queryId = globalXmlQuery()->doQuery(d->query, d->namespaces, d->xml.toUtf8(), &d->roleObjects, d->keyRoleResultsCache);
d->notifyQueryStarted(false);
} else if (d->src.isEmpty()) {
d->queryId = XMLLISTMODEL_CLEAR_ID;
d->notifyQueryStarted(false);
QTimer::singleShot(0, this, SLOT(dataCleared()));
} else {
d->notifyQueryStarted(true);
QNetworkRequest req(d->src);
d->reply = qmlContext(this)->engine()->networkAccessManager()->get(req);
QObject::connect(d->reply, SIGNAL(finished()), this, SLOT(requestFinished()));
QObject::connect(d->reply, SIGNAL(downloadProgress(qint64,qint64)),
this, SLOT(requestProgress(qint64,qint64)));
}
}
#define XMLLISTMODEL_MAX_REDIRECT 16
void QDeclarativeXmlListModel::requestFinished()
{
Q_D(QDeclarativeXmlListModel);
d->redirectCount++;
if (d->redirectCount < XMLLISTMODEL_MAX_REDIRECT) {
QVariant redirect = d->reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
if (redirect.isValid()) {
QUrl url = d->reply->url().resolved(redirect.toUrl());
d->reply->deleteLater();
d->reply = 0;
setSource(url);
return;
}
}
d->redirectCount = 0;
if (d->reply->error() != QNetworkReply::NoError) {
d->errorString = d->reply->errorString();
disconnect(d->reply, 0, this, 0);
d->reply->deleteLater();
d->reply = 0;
int count = this->count();
d->data.clear();
d->size = 0;
if (count > 0) {
emit itemsRemoved(0, count);
emit countChanged();
}
d->status = Error;
d->queryId = -1;
emit statusChanged(d->status);
} else {
QByteArray data = d->reply->readAll();
if (data.isEmpty()) {
d->queryId = XMLLISTMODEL_CLEAR_ID;
QTimer::singleShot(0, this, SLOT(dataCleared()));
} else {
d->queryId = globalXmlQuery()->doQuery(d->query, d->namespaces, data, &d->roleObjects, d->keyRoleResultsCache);
}
disconnect(d->reply, 0, this, 0);
d->reply->deleteLater();
d->reply = 0;
d->progress = 1.0;
emit progressChanged(d->progress);
}
}
void QDeclarativeXmlListModel::requestProgress(qint64 received, qint64 total)
{
Q_D(QDeclarativeXmlListModel);
if (d->status == Loading && total > 0) {
d->progress = qreal(received)/total;
emit progressChanged(d->progress);
}
}
void QDeclarativeXmlListModel::dataCleared()
{
Q_D(QDeclarativeXmlListModel);
QDeclarativeXmlQueryResult r;
r.queryId = XMLLISTMODEL_CLEAR_ID;
r.size = 0;
r.removed << qMakePair(0, count());
r.keyRoleResultsCache = d->keyRoleResultsCache;
queryCompleted(r);
}
void QDeclarativeXmlListModel::queryError(void* object, const QString& error)
{
// Be extra careful, object may no longer exist, it's just an ID.
Q_D(QDeclarativeXmlListModel);
for (int i=0; i<d->roleObjects.count(); i++) {
if (d->roleObjects.at(i) == static_cast<QDeclarativeXmlListModelRole*>(object)) {
qmlInfo(d->roleObjects.at(i)) << QObject::tr("invalid query: \"%1\"").arg(error);
return;
}
}
qmlInfo(this) << QObject::tr("invalid query: \"%1\"").arg(error);
}
void QDeclarativeXmlListModel::queryCompleted(const QDeclarativeXmlQueryResult &result)
{
Q_D(QDeclarativeXmlListModel);
if (result.queryId != d->queryId)
return;
int origCount = d->size;
bool sizeChanged = result.size != d->size;
d->size = result.size;
d->data = result.data;
d->keyRoleResultsCache = result.keyRoleResultsCache;
d->status = Ready;
d->errorString.clear();
d->queryId = -1;
bool hasKeys = false;
for (int i=0; i<d->roleObjects.count(); i++) {
if (d->roleObjects[i]->isKey()) {
hasKeys = true;
break;
}
}
if (!hasKeys) {
if (!(origCount == 0 && d->size == 0)) {
emit itemsRemoved(0, origCount);
emit itemsInserted(0, d->size);
emit countChanged();
}
} else {
for (int i=0; i<result.removed.count(); i++)
emit itemsRemoved(result.removed[i].first, result.removed[i].second);
for (int i=0; i<result.inserted.count(); i++)
emit itemsInserted(result.inserted[i].first, result.inserted[i].second);
if (sizeChanged)
emit countChanged();
}
emit statusChanged(d->status);
}
QT_END_NAMESPACE
#include <qdeclarativexmllistmodel.moc>
|