feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

HelpManager: Hide registerDocumentationNow() in cpp

Browse Source 
This avoid calling collectionFilePath() concurrently,
which might be potentially problematic.

Change-Id: Ic873b6429b933f2f3359623b1e9cb14409ef3c4b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Jarek Kobus
2023-10-06 10:25:31 +02:00
parent 5a715330fc
commit ab13b7b155
2 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
src/plugins/help/helpmanager.cpp
View File

@@ -94,6 +94,39 @@ QString HelpManager::collectionFilePath()
return ICore::userResourcePath("helpcollection.qhc").toString();
}
static void registerDocumentationNow(QPromise<bool> &promise, const QString &collectionFilePath,
const QStringList &files)
{
QMutexLocker locker(&d->m_helpengineMutex);
promise.setProgressRange(0, files.count());
promise.setProgressValue(0);
QHelpEngineCore helpEngine(collectionFilePath);
helpEngine.setReadOnly(false);
helpEngine.setupData();
bool docsChanged = false;
QStringList nameSpaces = helpEngine.registeredDocumentations();
for (const QString &file : files) {
if (promise.isCanceled())
break;
promise.setProgressValue(promise.future().progressValue() + 1);
const QString &nameSpace = QHelpEngineCore::namespaceName(file);
if (nameSpace.isEmpty())
continue;
if (!nameSpaces.contains(nameSpace)) {
if (helpEngine.registerDocumentation(file)) {
nameSpaces.append(nameSpace);
docsChanged = true;
} else {
qWarning() << "Error registering namespace '" << nameSpace
<< "' from file '" << file << "':" << helpEngine.error();
}
}
}
promise.addResult(docsChanged);
}
void HelpManager::registerDocumentation(const QStringList &files)
{
if (d->m_needsSetup) {
@@ -102,7 +135,7 @@ void HelpManager::registerDocumentation(const QStringList &files)
return;
}
QFuture<bool> future = Utils::asyncRun(&HelpManager::registerDocumentationNow, files);
QFuture<bool> future = Utils::asyncRun(registerDocumentationNow, collectionFilePath(), files);
Utils::onResultReady(future, this, [](bool docsChanged){
if (docsChanged) {
d->m_helpEngine->setupData();
@@ -125,38 +158,6 @@ void HelpManager::unregisterDocumentation(const QStringList &fileNames)
unregisterNamespaces(getNamespaces(fileNames));
}
void HelpManager::registerDocumentationNow(QPromise<bool> &promise, const QStringList &files)
{
QMutexLocker locker(&d->m_helpengineMutex);
promise.setProgressRange(0, files.count());
promise.setProgressValue(0);
QHelpEngineCore helpEngine(collectionFilePath());
helpEngine.setReadOnly(false);
helpEngine.setupData();
bool docsChanged = false;
QStringList nameSpaces = helpEngine.registeredDocumentations();
for (const QString &file : files) {
if (promise.isCanceled())
break;
promise.setProgressValue(promise.future().progressValue() + 1);
const QString &nameSpace = QHelpEngineCore::namespaceName(file);
if (nameSpace.isEmpty())
continue;
if (!nameSpaces.contains(nameSpace)) {
if (helpEngine.registerDocumentation(file)) {
nameSpaces.append(nameSpace);
docsChanged = true;
} else {
qWarning() << "Error registering namespace '" << nameSpace
<< "' from file '" << file << "':" << helpEngine.error();
}
}
}
promise.addResult(docsChanged);
}
void HelpManager::unregisterNamespaces(const QStringList &nameSpaces)
{
if (d->m_needsSetup) {

1
src/plugins/help/helpmanager.h
View File

@@ -59,7 +59,6 @@ public:
Core::HelpManager::HelpViewerLocation location = Core::HelpManager::HelpModeAlways) override;
static void setupHelpManager();
static void registerDocumentationNow(QPromise<bool> &promise, const QStringList &fileNames);
signals:
void collectionFileChanged();