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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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.
**
****************************************************************************/
#include "exampleslistmodel.h"
#include <QDebug>
#include <QDir>
#include <QFile>
#include <QUrl>
#include <QXmlStreamReader>
#include <QStandardItemModel>
#include <coreplugin/helpmanager.h>
#include <coreplugin/icore.h>
#include <projectexplorer/kitmanager.h>
#include <qtsupport/qtkitinformation.h>
#include <qtsupport/qtversionmanager.h>
#include <utils/environment.h>
#include <utils/qtcassert.h>
#include <algorithm>
namespace QtSupport {
namespace Internal {
const int allQtVersionsId = -0xff;
static const char currentQtVersionFilterSettingsKeyC[] = "WelcomePageQtVersionFilter";
int uniqueQtVersionIdSetting()
{
QSettings *settings = Core::ICore::settings();
int id = settings->value(QLatin1String(currentQtVersionFilterSettingsKeyC), allQtVersionsId).toInt();
return id;
}
void setUniqueQtVersionIdSetting(int id)
{
QSettings *settings = Core::ICore::settings();
settings->setValue(QLatin1String(currentQtVersionFilterSettingsKeyC), id);
}
class QtVersionsModel : public QStandardItemModel
{
Q_OBJECT
public:
QtVersionsModel(QObject *parent) : QStandardItemModel(parent)
{
QHash<int, QByteArray> roleNames;
roleNames[Qt::UserRole + 1] = "text";
roleNames[Qt::UserRole + 2] = "QtId";
setRoleNames(roleNames);
}
void setupQtVersions()
{
beginResetModel();
clear();
// prioritize default qt version
QtVersionManager *versionManager = QtVersionManager::instance();
QList <BaseQtVersion *> qtVersions = versionManager->validVersions();
ProjectExplorer::Kit *defaultKit = ProjectExplorer::KitManager::instance()->defaultKit();
BaseQtVersion *defaultVersion = QtKitInformation::qtVersion(defaultKit);
if (defaultVersion && qtVersions.contains(defaultVersion))
qtVersions.move(qtVersions.indexOf(defaultVersion), 0);
QStandardItem *newItem = new QStandardItem();
newItem->setData(tr("All Versions"), Qt::UserRole + 1);
newItem->setData(allQtVersionsId, Qt::UserRole + 2);
appendRow(newItem);
int qtVersionSetting = uniqueQtVersionIdSetting();
if (qtVersionSetting != allQtVersionsId) {
//ensure that the unique Qt id is valid
int newQtVersionSetting = allQtVersionsId;
foreach (BaseQtVersion *version, qtVersions) {
if (version->uniqueId() == qtVersionSetting)
newQtVersionSetting = qtVersionSetting;
}
if (newQtVersionSetting != qtVersionSetting) {
setUniqueQtVersionIdSetting(newQtVersionSetting);
}
}
foreach (BaseQtVersion *version, qtVersions) {
QStandardItem *newItem = new QStandardItem();
newItem->setData(QString::fromLatin1("Qt %1 (%2)").arg(version->qtVersionString()).arg(version->platformDisplayName()),
Qt::UserRole + 1);
newItem->setData(version->uniqueId(), Qt::UserRole + 2);
appendRow(newItem);
}
endResetModel();
}
int indexForUniqueId(int uniqueId) {
for (int i=0; i < rowCount(); i++) {
if (uniqueId == getId(i).toInt())
return i;
}
return 0;
}
public slots:
QVariant get(int i)
{
QModelIndex modelIndex = index(i,0);
QVariant variant = data(modelIndex, Qt::UserRole + 1);
return variant;
}
QVariant getId(int i)
{
QModelIndex modelIndex = index(i,0);
QVariant variant = data(modelIndex, Qt::UserRole + 2);
return variant;
}
};
ExamplesListModel::ExamplesListModel(QObject *parent) :
QAbstractListModel(parent),
m_updateOnQtVersionsChanged(false),
m_initialized(false),
m_helpInitialized(false),
m_uniqueQtId(allQtVersionsId)
{
QHash<int, QByteArray> roleNames;
roleNames[Name] = "name";
roleNames[ProjectPath] = "projectPath";
roleNames[ImageUrl] = "imageUrl";
roleNames[Description] = "description";
roleNames[DocUrl] = "docUrl";
roleNames[FilesToOpen] = "filesToOpen";
roleNames[Tags] = "tags";
roleNames[Difficulty] = "difficulty";
roleNames[Type] = "type";
roleNames[HasSourceCode] = "hasSourceCode";
roleNames[Dependencies] = "dependencies";
roleNames[IsVideo] = "isVideo";
roleNames[VideoUrl] = "videoUrl";
roleNames[VideoLength] = "videoLength";
roleNames[Platforms] = "platforms";
roleNames[IsHighlighted] = "isHighlighted";
setRoleNames(roleNames);
connect(Core::HelpManager::instance(), SIGNAL(setupFinished()),
SLOT(helpInitialized()));
connect(QtVersionManager::instance(), SIGNAL(qtVersionsChanged(QList<int>,QList<int>,QList<int>)),
this, SLOT(handleQtVersionsChanged()));
connect(ProjectExplorer::KitManager::instance(), SIGNAL(defaultkitChanged()),
SLOT(handleQtVersionsChanged()));
}
static QString fixStringForTags(const QString &string)
{
QString returnString = string;
returnString.remove(QLatin1String("<i>"));
returnString.remove(QLatin1String("</i>"));
returnString.remove(QLatin1String("<tt>"));
returnString.remove(QLatin1String("</tt>"));
return returnString;
}
static QStringList trimStringList(const QStringList &stringlist)
{
QStringList returnList;
foreach (const QString &string, stringlist)
returnList << string.trimmed();
return returnList;
}
static QString relativeOrInstallPath(const QString &path, const QString &manifestPath,
const QString &installPath)
{
const QChar slash = QLatin1Char('/');
const QString relativeResolvedPath = manifestPath + slash + path;
const QString installResolvedPath = installPath + slash + path;
if (QFile::exists(relativeResolvedPath))
return relativeResolvedPath;
if (QFile::exists(installResolvedPath))
return installResolvedPath;
// doesn't exist, just return relative
return relativeResolvedPath;
}
static bool debugExamples()
{
static bool isDebugging = !qgetenv("QTC_DEBUG_EXAMPLESMODEL").isEmpty();
return isDebugging;
}
static bool isValidExampleOrDemo(ExampleItem &item)
{
static QString invalidPrefix = QLatin1String("qthelp:////"); /* means that the qthelp url
doesn't have any namespace */
QString reason;
bool ok = true;
if (!item.hasSourceCode || !QFileInfo(item.projectPath).exists()) {
ok = false;
reason = QString::fromLatin1("projectPath '%1' empty or does not exist").arg(item.projectPath);
} else if (item.imageUrl.startsWith(invalidPrefix) || !QUrl(item.imageUrl).isValid()) {
ok = false;
reason = QString::fromLatin1("imageUrl '%1' not valid").arg(item.imageUrl);
} else if (!item.docUrl.isEmpty()
&& (item.docUrl.startsWith(invalidPrefix) || !QUrl(item.docUrl).isValid())) {
ok = false;
reason = QString::fromLatin1("docUrl '%1' non-empty but not valid").arg(item.docUrl);
}
if (!ok) {
item.tags.append(QLatin1String("broken"));
if (debugExamples())
qWarning() << QString::fromLatin1("ERROR: Item '%1' broken: %2").arg(item.name, reason);
}
if (debugExamples() && item.description.isEmpty())
qWarning() << QString::fromLatin1("WARNING: Item '%1' has no description").arg(item.name);
return ok || debugExamples();
}
void ExamplesListModel::parseExamples(QXmlStreamReader *reader,
const QString &projectsOffset, const QString &examplesInstallPath)
{
ExampleItem item;
const QChar slash = QLatin1Char('/');
while (!reader->atEnd()) {
switch (reader->readNext()) {
case QXmlStreamReader::StartElement:
if (reader->name() == QLatin1String("example")) {
item = ExampleItem();
item.type = Example;
QXmlStreamAttributes attributes = reader->attributes();
item.name = attributes.value(QLatin1String("name")).toString();
item.projectPath = attributes.value(QLatin1String("projectPath")).toString();
item.hasSourceCode = !item.projectPath.isEmpty();
item.projectPath = relativeOrInstallPath(item.projectPath, projectsOffset, examplesInstallPath);
item.imageUrl = attributes.value(QLatin1String("imageUrl")).toString();
item.docUrl = attributes.value(QLatin1String("docUrl")).toString();
if (attributes.hasAttribute(QLatin1String("isHighlighted")))
item.isHighlighted = attributes.value(QLatin1String("isHighlighted")).toString() == QLatin1String("true");
} else if (reader->name() == QLatin1String("fileToOpen")) {
item.filesToOpen.append(relativeOrInstallPath(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement),
projectsOffset, examplesInstallPath));
} else if (reader->name() == QLatin1String("description")) {
item.description = fixStringForTags(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("dependency")) {
item.dependencies.append(projectsOffset + slash + reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("tags")) {
item.tags = trimStringList(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement).split(QLatin1Char(','), QString::SkipEmptyParts));
m_tags.append(item.tags);
} else if (reader->name() == QLatin1String("platforms")) {
item.platforms = trimStringList(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement).split(QLatin1Char(','), QString::SkipEmptyParts));
}
break;
case QXmlStreamReader::EndElement:
if (reader->name() == QLatin1String("example")) {
if (isValidExampleOrDemo(item))
m_exampleItems.append(item);
} else if (reader->name() == QLatin1String("examples")) {
return;
}
break;
default: // nothing
break;
}
}
}
void ExamplesListModel::parseDemos(QXmlStreamReader *reader,
const QString &projectsOffset, const QString &demosInstallPath)
{
ExampleItem item;
const QChar slash = QLatin1Char('/');
while (!reader->atEnd()) {
switch (reader->readNext()) {
case QXmlStreamReader::StartElement:
if (reader->name() == QLatin1String("demo")) {
item = ExampleItem();
item.type = Demo;
QXmlStreamAttributes attributes = reader->attributes();
item.name = attributes.value(QLatin1String("name")).toString();
item.projectPath = attributes.value(QLatin1String("projectPath")).toString();
item.hasSourceCode = !item.projectPath.isEmpty();
item.projectPath = relativeOrInstallPath(item.projectPath, projectsOffset, demosInstallPath);
item.imageUrl = attributes.value(QLatin1String("imageUrl")).toString();
item.docUrl = attributes.value(QLatin1String("docUrl")).toString();
if (attributes.hasAttribute(QLatin1String("isHighlighted")))
item.isHighlighted = attributes.value(QLatin1String("isHighlighted")).toString() == QLatin1String("true");
} else if (reader->name() == QLatin1String("fileToOpen")) {
item.filesToOpen.append(relativeOrInstallPath(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement),
projectsOffset, demosInstallPath));
} else if (reader->name() == QLatin1String("description")) {
item.description = fixStringForTags(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("dependency")) {
item.dependencies.append(projectsOffset + slash + reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("tags")) {
item.tags = reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement).split(QLatin1Char(','));
}
break;
case QXmlStreamReader::EndElement:
if (reader->name() == QLatin1String("demo")) {
if (isValidExampleOrDemo(item))
m_exampleItems.append(item);
} else if (reader->name() == QLatin1String("demos")) {
return;
}
break;
default: // nothing
break;
}
}
}
void ExamplesListModel::parseTutorials(QXmlStreamReader *reader, const QString &projectsOffset)
{
ExampleItem item;
const QChar slash = QLatin1Char('/');
while (!reader->atEnd()) {
switch (reader->readNext()) {
case QXmlStreamReader::StartElement:
if (reader->name() == QLatin1String("tutorial")) {
item = ExampleItem();
item.type = Tutorial;
QXmlStreamAttributes attributes = reader->attributes();
item.name = attributes.value(QLatin1String("name")).toString();
item.projectPath = attributes.value(QLatin1String("projectPath")).toString();
item.hasSourceCode = !item.projectPath.isEmpty();
item.projectPath.prepend(slash);
item.projectPath.prepend(projectsOffset);
if (attributes.hasAttribute(QLatin1String("imageUrl")))
item.imageUrl = attributes.value(QLatin1String("imageUrl")).toString();
if (attributes.hasAttribute(QLatin1String("docUrl")))
item.docUrl = attributes.value(QLatin1String("docUrl")).toString();
if (attributes.hasAttribute(QLatin1String("isVideo")))
item.isVideo = attributes.value(QLatin1String("isVideo")).toString() == QLatin1String("true");
if (attributes.hasAttribute(QLatin1String("videoUrl")))
item.videoUrl = attributes.value(QLatin1String("videoUrl")).toString();
if (attributes.hasAttribute(QLatin1String("videoLength")))
item.videoLength = attributes.value(QLatin1String("videoLength")).toString();
} else if (reader->name() == QLatin1String("fileToOpen")) {
item.filesToOpen.append(projectsOffset + slash + reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("description")) {
item.description = fixStringForTags(reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("dependency")) {
item.dependencies.append(projectsOffset + slash + reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement));
} else if (reader->name() == QLatin1String("tags")) {
item.tags = reader->readElementText(QXmlStreamReader::ErrorOnUnexpectedElement).split(QLatin1Char(','));
}
break;
case QXmlStreamReader::EndElement:
if (reader->name() == QLatin1String("tutorial"))
m_exampleItems.append(item);
else if (reader->name() == QLatin1String("tutorials"))
return;
break;
default: // nothing
break;
}
}
}
void ExamplesListModel::handleQtVersionsChanged()
{
if (m_updateOnQtVersionsChanged) {
emit qtVersionsChanged();
updateExamples();
}
}
void ExamplesListModel::updateExamples()
{
QString examplesInstallPath;
QString demosInstallPath;
QString examplesFallback;
QString demosFallback;
QString sourceFallback;
QStringList sources = exampleSources(&examplesInstallPath, &demosInstallPath,
&examplesFallback, &demosFallback, &sourceFallback);
beginResetModel();
m_tags.clear();
m_exampleItems.clear();
foreach (const QString &exampleSource, sources) {
QFile exampleFile(exampleSource);
if (!exampleFile.open(QIODevice::ReadOnly)) {
if (debugExamples())
qWarning() << "ERROR: Could not open file" << exampleSource;
continue;
}
QFileInfo fi(exampleSource);
QString offsetPath = fi.path();
QDir examplesDir(offsetPath);
QDir demosDir(offsetPath);
if (!examplesFallback.isEmpty()) {
// Look at Qt source directory at first,
// since examplesPath() / demosPath() points at the build directory
examplesDir = sourceFallback + QLatin1String("/examples");
demosDir = sourceFallback + QLatin1String("/demos");
// if examples or demos don't exist in source, try the directories
// that qmake -query gave (i.e. in the build directory)
if (!examplesDir.exists() || !demosDir.exists()) {
examplesDir = examplesFallback;
demosDir = demosFallback;
}
}
if (debugExamples())
qWarning() << QString::fromLatin1("Reading file '%1'...").arg(fi.absoluteFilePath());
QXmlStreamReader reader(&exampleFile);
while (!reader.atEnd())
switch (reader.readNext()) {
case QXmlStreamReader::StartElement:
if (reader.name() == QLatin1String("examples"))
parseExamples(&reader, examplesDir.path(), examplesInstallPath);
else if (reader.name() == QLatin1String("demos"))
parseDemos(&reader, demosDir.path(), demosInstallPath);
else if (reader.name() == QLatin1String("tutorials"))
parseTutorials(&reader, examplesDir.path());
break;
default: // nothing
break;
}
if (reader.hasError() && debugExamples())
qWarning() << QString::fromLatin1("ERROR: Could not parse file as XML document ('%1')").arg(exampleSource);
}
endResetModel();
m_tags.sort();
m_tags.erase(std::unique(m_tags.begin(), m_tags.end()), m_tags.end());
emit tagsUpdated();
}
QStringList ExamplesListModel::exampleSources(QString *examplesInstallPath, QString *demosInstallPath,
QString *examplesFallback, QString *demosFallback,
QString *sourceFallback)
{
QTC_CHECK(examplesFallback);
QTC_CHECK(demosFallback);
QTC_CHECK(sourceFallback);
QStringList sources;
QString resourceDir = Core::ICore::resourcePath() + QLatin1String("/welcomescreen/");
// overriding examples with a custom XML file
QString exampleFileEnvKey = QLatin1String("QTC_EXAMPLE_FILE");
if (Utils::Environment::systemEnvironment().hasKey(exampleFileEnvKey)) {
QString filePath = Utils::Environment::systemEnvironment().value(exampleFileEnvKey);
if (filePath.endsWith(QLatin1String(".xml")) && QFileInfo(filePath).exists()) {
sources.append(filePath);
return sources;
}
}
// Qt Creator shipped tutorials
sources << (resourceDir + QLatin1String("/qtcreator_tutorials.xml"));
// Read keys from SDK installer
QSettings *settings = Core::ICore::settings(QSettings::SystemScope);
int size = settings->beginReadArray(QLatin1String("ExampleManifests"));
for (int i = 0; i < size; ++i) {
settings->setArrayIndex(i);
sources.append(settings->value(QLatin1String("Location")).toString());
}
settings->endArray();
// if the installer set something, that's enough for us
if (size > 0)
return sources;
// try to find a suitable Qt version
m_updateOnQtVersionsChanged = true; // this must be updated when the Qt versions change
// fallbacks are passed back if no example manifest is found
// and we fallback to Qt Creator's shipped manifest (e.g. only old Qt Versions found)
QString potentialExamplesFallback;
QString potentialDemosFallback;
QString potentialSourceFallback;
const QStringList pattern(QLatin1String("*.xml"));
// prioritize default qt version
QtVersionManager *versionManager = QtVersionManager::instance();
QList <BaseQtVersion *> qtVersions = versionManager->validVersions();
ProjectExplorer::Kit *defaultKit = ProjectExplorer::KitManager::instance()->defaultKit();
BaseQtVersion *defaultVersion = QtKitInformation::qtVersion(defaultKit);
if (defaultVersion && qtVersions.contains(defaultVersion))
qtVersions.move(qtVersions.indexOf(defaultVersion), 0);
foreach (BaseQtVersion *version, qtVersions) {
//filter for qt versions
if (version->uniqueId() != m_uniqueQtId && m_uniqueQtId != allQtVersionsId)
continue;
// qt5 with examples OR demos manifest
if (version->qtVersion().majorVersion == 5 && (version->hasExamples() || version->hasDemos())) {
// examples directory in Qt5 is under the qtbase submodule,
// search other submodule directories for further manifest files
QDir qt5docPath = QDir(version->documentationPath());
const QStringList examplesPattern(QLatin1String("examples-manifest.xml"));
const QStringList demosPattern(QLatin1String("demos-manifest.xml"));
QFileInfoList fis;
foreach (QFileInfo subDir, qt5docPath.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot)) {
if (version->hasExamples())
fis << QDir(subDir.absoluteFilePath()).entryInfoList(examplesPattern);
if (version->hasDemos())
fis << QDir(subDir.absoluteFilePath()).entryInfoList(demosPattern);
}
if (!fis.isEmpty()) {
foreach (const QFileInfo &fi, fis)
sources.append(fi.filePath());
if (examplesInstallPath)
*examplesInstallPath = version->examplesPath();
if (demosInstallPath)
*demosInstallPath = version->demosPath();
return sources;
}
}
QFileInfoList fis;
if (version->hasExamples())
fis << QDir(version->examplesPath()).entryInfoList(pattern);
if (version->hasDemos())
fis << QDir(version->demosPath()).entryInfoList(pattern);
if (!fis.isEmpty()) {
foreach (const QFileInfo &fi, fis)
sources.append(fi.filePath());
return sources;
}
// check if this Qt version would be the preferred fallback, Qt 4 only
if (version->qtVersion().majorVersion == 4 && version->hasExamples() && version->hasDemos()) { // cached, so no performance hit
if (potentialExamplesFallback.isEmpty()) {
potentialExamplesFallback = version->examplesPath();
potentialDemosFallback = version->demosPath();
potentialSourceFallback = version->sourcePath().toString();
}
}
}
if (!potentialExamplesFallback.isEmpty()) {
// We didn't find a manifest, use Creator-provided XML file with fall back Qt version
// qDebug() << Q_FUNC_INFO << "falling through to Creator-provided XML file";
sources << QString(resourceDir + QLatin1String("/examples_fallback.xml"));
if (examplesFallback)
*examplesFallback = potentialExamplesFallback;
if (demosFallback)
*demosFallback = potentialDemosFallback;
if (sourceFallback)
*sourceFallback = potentialSourceFallback;
}
return sources;
}
int ExamplesListModel::rowCount(const QModelIndex &) const
{
ensureInitialized();
return m_exampleItems.size();
}
QString prefixForItem(const ExampleItem &item)
{
if (item.isHighlighted)
return QLatin1String("0000 ");
return QString();
}
QVariant ExamplesListModel::data(const QModelIndex &index, int role) const
{
ensureInitialized();
if (!index.isValid() || index.row()+1 > m_exampleItems.count()) {
qDebug() << Q_FUNC_INFO << "invalid index requested";
return QVariant();
}
ExampleItem item = m_exampleItems.at(index.row());
switch (role)
{
case Qt::DisplayRole: // for search only
return QString(prefixForItem(item) + item.name + QLatin1Char(' ') + item.tags.join(QLatin1String(" ")));
case Name:
return item.name;
case ProjectPath:
return item.projectPath;
case Description:
return item.description;
case ImageUrl:
return item.imageUrl;
case DocUrl:
return item.docUrl;
case FilesToOpen:
return item.filesToOpen;
case Tags:
return item.tags;
case Difficulty:
return item.difficulty;
case Dependencies:
return item.dependencies;
case HasSourceCode:
return item.hasSourceCode;
case Type:
return item.type;
case IsVideo:
return item.isVideo;
case VideoUrl:
return item.videoUrl;
case VideoLength:
return item.videoLength;
case Platforms:
return item.platforms;
case IsHighlighted:
return item.isHighlighted;
default:
qDebug() << Q_FUNC_INFO << "role type not supported";
return QVariant();
}
}
QStringList ExamplesListModel::tags() const
{
ensureInitialized();
return m_tags;
}
void ExamplesListModel::helpInitialized()
{
m_helpInitialized = true;
if (m_initialized) // if we are already initialized we need to update nevertheless
updateExamples();
}
void ExamplesListModel::ensureInitialized() const
{
if (m_initialized || !m_helpInitialized)
return;
ExamplesListModel *that = const_cast<ExamplesListModel *>(this);
that->m_initialized = true;
that->updateExamples();
emit that->qtVersionsChanged();
}
void ExamplesListModel::filterForQtById(int id)
{
m_uniqueQtId = id;
setUniqueQtVersionIdSetting(id);
updateExamples();
}
ExamplesListModelFilter::ExamplesListModelFilter(ExamplesListModel *sourceModel, QObject *parent) :
QSortFilterProxyModel(parent),
m_showTutorialsOnly(true),
m_sourceModel(sourceModel),
m_timerId(0),
m_qtVersionModel(new QtVersionsModel(this)),
m_blockIndexUpdate(false)
{
connect(this, SIGNAL(showTutorialsOnlyChanged()), SLOT(updateFilter()));
connect(sourceModel, SIGNAL(qtVersionsChanged()), SLOT(handleQtVersionsChanged()));
setSourceModel(m_sourceModel);
}
void ExamplesListModelFilter::updateFilter()
{
ExamplesListModel *exampleListModel = qobject_cast<ExamplesListModel*>(sourceModel());
if (exampleListModel) {
exampleListModel->beginReset();
invalidateFilter();
exampleListModel->endReset();
}
}
bool containsSubString(const QStringList &list, const QString &substr, Qt::CaseSensitivity cs)
{
foreach (const QString &elem, list)
if (elem.contains(substr, cs))
return true;
return false;
}
bool ExamplesListModelFilter::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
{
if (m_showTutorialsOnly) {
int type = sourceModel()->index(sourceRow, 0, sourceParent).data(Type).toInt();
if (type != Tutorial)
return false;
}
if (!m_showTutorialsOnly) {
int type = sourceModel()->index(sourceRow, 0, sourceParent).data(Type).toInt();
if (type != Example)
return false;
}
const QStringList tags = sourceModel()->index(sourceRow, 0, sourceParent).data(Tags).toStringList();
if (!m_filterTags.isEmpty()) {
foreach (const QString &tag, m_filterTags)
if (!tags.contains(tag, Qt::CaseInsensitive))
return false;
return true;
}
if (!m_searchString.isEmpty()) {
const QString description = sourceModel()->index(sourceRow, 0, sourceParent).data(Description).toString();
const QString name = sourceModel()->index(sourceRow, 0, sourceParent).data(Name).toString();
foreach (const QString &subString, m_searchString) {
bool wordMatch = false;
wordMatch |= (bool)name.contains(subString, Qt::CaseInsensitive);
if (wordMatch)
continue;
wordMatch |= containsSubString(tags, subString, Qt::CaseInsensitive);
if (wordMatch)
continue;
wordMatch |= (bool)description.contains(subString, Qt::CaseInsensitive);
if (!wordMatch)
return false;
}
}
return QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
}
int ExamplesListModelFilter::rowCount(const QModelIndex &parent) const
{
m_sourceModel->ensureInitialized();
return QSortFilterProxyModel::rowCount(parent);
}
QVariant ExamplesListModelFilter::data(const QModelIndex &index, int role) const
{
m_sourceModel->ensureInitialized();
return QSortFilterProxyModel::data(index, role);
}
QAbstractItemModel* ExamplesListModelFilter::qtVersionModel()
{
return m_qtVersionModel;
}
void ExamplesListModelFilter::setShowTutorialsOnly(bool showTutorialsOnly)
{
m_showTutorialsOnly = showTutorialsOnly;
emit showTutorialsOnlyChanged();
}
void ExamplesListModelFilter::handleQtVersionsChanged()
{
m_blockIndexUpdate = true;
m_qtVersionModel->setupQtVersions();
emit qtVersionIndexChanged();
m_blockIndexUpdate = false;
}
void ExamplesListModelFilter::delayedUpdateFilter()
{
if (m_timerId != 0)
killTimer(m_timerId);
m_timerId = startTimer(320);
}
int ExamplesListModelFilter::qtVersionIndex() const
{
int id = uniqueQtVersionIdSetting();
int index = m_qtVersionModel->indexForUniqueId(id);
return index;
}
void ExamplesListModelFilter::timerEvent(QTimerEvent *timerEvent)
{
if (m_timerId == timerEvent->timerId()) {
updateFilter();
killTimer(m_timerId);
m_timerId = 0;
}
}
struct SearchStringLexer
{
QString code;
const QChar *codePtr;
QChar yychar;
QString yytext;
enum TokenKind {
END_OF_STRING = 0,
TAG,
STRING_LITERAL,
UNKNOWN
};
inline void yyinp() { yychar = *codePtr++; }
SearchStringLexer(const QString &code)
: code(code)
, codePtr(code.unicode())
, yychar(QLatin1Char(' ')) { }
int operator()() { return yylex(); }
int yylex() {
while (yychar.isSpace())
yyinp(); // skip all the spaces
yytext.clear();
if (yychar.isNull())
return END_OF_STRING;
QChar ch = yychar;
yyinp();
switch (ch.unicode()) {
case '"':
case '\'':
{
const QChar quote = ch;
yytext.clear();
while (!yychar.isNull()) {
if (yychar == quote) {
yyinp();
break;
} if (yychar == QLatin1Char('\\')) {
yyinp();
switch (yychar.unicode()) {
case '"': yytext += QLatin1Char('"'); yyinp(); break;
case '\'': yytext += QLatin1Char('\''); yyinp(); break;
case '\\': yytext += QLatin1Char('\\'); yyinp(); break;
}
} else {
yytext += yychar;
yyinp();
}
}
return STRING_LITERAL;
}
default:
if (ch.isLetterOrNumber() || ch == QLatin1Char('_')) {
yytext.clear();
yytext += ch;
while (yychar.isLetterOrNumber() || yychar == QLatin1Char('_')) {
yytext += yychar;
yyinp();
}
if (yychar == QLatin1Char(':') && yytext == QLatin1String("tag")) {
yyinp();
return TAG;
}
return STRING_LITERAL;
}
}
yytext += ch;
return UNKNOWN;
}
};
void ExamplesListModelFilter::parseSearchString(const QString &arg)
{
QStringList tags;
QStringList searchTerms;
SearchStringLexer lex(arg);
bool isTag = false;
while (int tk = lex()) {
if (tk == SearchStringLexer::TAG) {
isTag = true;
searchTerms.append(lex.yytext);
}
if (tk == SearchStringLexer::STRING_LITERAL) {
if (isTag) {
searchTerms.pop_back();
tags.append(lex.yytext);
isTag = false;
} else {
searchTerms.append(lex.yytext);
}
}
}
setSearchStrings(searchTerms);
setFilterTags(tags);
delayedUpdateFilter();
}
} // namespace Internal
} // namespace QtSupport
#include "exampleslistmodel.moc"
|