Examples: Support manifest-defined category order

Reads a separate sorted list of categories from the manifest files.
The first of these lists that is found in the manifest files is used.
For example the Qt documentation defines the list in the manifest file
for qtdoc.

Change-Id: I57c2779862a5ebfc27707b53d43d4ed9e7e8c5f9
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
Eike Ziller
2023-07-21 09:21:20 +02:00
parent 5af88f5702
commit 08bbe885b4
5 changed files with 92 additions and 29 deletions

View File

@@ -355,13 +355,14 @@ void ExamplesViewController::updateExamples()
&qtVersion);
m_view->clear();
QStringList categoryOrder;
QList<ExampleItem *> items;
for (const QString &exampleSource : sources) {
const auto manifest = FilePath::fromUserInput(exampleSource);
qCDebug(log) << QString::fromLatin1("Reading file \"%1\"...")
.arg(manifest.absoluteFilePath().toUserOutput());
const expected_str<QList<ExampleItem *>> result
const expected_str<ParsedExamples> result
= parseExamples(manifest,
FilePath::fromUserInput(examplesInstallPath),
FilePath::fromUserInput(demosInstallPath),
@@ -371,7 +372,9 @@ void ExamplesViewController::updateExamples()
<< result.error();
continue;
}
items += filtered(*result, isValidExampleOrDemo);
items += filtered(result->items, isValidExampleOrDemo);
if (categoryOrder.isEmpty())
categoryOrder = result->categoryOrder;
}
if (m_isExamples) {
@@ -386,7 +389,8 @@ void ExamplesViewController::updateExamples()
}
const bool sortIntoCategories = !m_isExamples || qtVersion >= *minQtVersionForCategories;
const QStringList order = m_isExamples ? *defaultOrder : QStringList();
const QStringList order = categoryOrder.isEmpty() && m_isExamples ? *defaultOrder
: categoryOrder;
const QList<std::pair<Section, QList<ExampleItem *>>> sections
= getCategories(items, sortIntoCategories, order, m_isExamples);
for (int i = 0; i < sections.size(); ++i) {