Revision control
++ // Copyright (C) 2017 The Qt Company Ltd.
++ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
++
++ #include "assistant.h"
++
++ #include <QApplication>
++ #include <QByteArray>
++ #include <QDir>
++ #include <QLibraryInfo>
++ #include <QMessageBox>
++ #include <QStandardPaths>
++
++ using namespace Qt::StringLiterals;
++
++ //! [0]
++ Assistant::~Assistant()
++ {
++ if (m_process && m_process->state() == QProcess::Running) {
++ QObject::disconnect(m_process.get(), &QProcess::finished, nullptr, nullptr);
++ m_process->terminate();
++ m_process->waitForFinished(3000);
++ }
++ }
++ //! [0]
++
++ //! [1]
++ void Assistant::showDocumentation(const QString &page)
++ {
++ if (!startAssistant())
++ return;
++
++ QByteArray ba("SetSource ");
++ ba.append("qthelp://org.qt-project.examples.simpletextviewer/doc/");
++
++ m_process->write(ba + page.toLocal8Bit() + '\n');
++ }
++ //! [1]
++
++ static QString documentationDirectory()
++ {
++ QStringList paths;
++ #ifdef SRCDIR
++ paths.append(QLatin1StringView(SRCDIR));
++ #endif
++ paths.append(QLibraryInfo::path(QLibraryInfo::ExamplesPath));
++ paths.append(QCoreApplication::applicationDirPath());
++ paths.append(QStandardPaths::standardLocations(QStandardPaths::AppDataLocation));
++ for (const auto &dir : std::as_const(paths)) {
++ const QString path = dir + "/documentation"_L1;
++ if (QFileInfo::exists(path))
++ return path;
++ }
++ return {};
++ }
++
++ //! [2]
++ bool Assistant::startAssistant()
++ {
++ if (!m_process) {
++ m_process = std::make_unique<QProcess>();
++ QObject::connect(m_process.get(), &QProcess::finished,
++ m_process.get(), [this](int exitCode, QProcess::ExitStatus status) {
++ finished(exitCode, status);
++ });
++ }
++
++ if (m_process->state() != QProcess::Running) {
++ QString app = QLibraryInfo::path(QLibraryInfo::BinariesPath);
++ #ifndef Q_OS_DARWIN
++ app += "/assistant"_L1;
++ #else
++ app += "/Assistant.app/Contents/MacOS/Assistant"_L1;
++ #endif
++
++ const QString collectionDirectory = documentationDirectory();
++ if (collectionDirectory.isEmpty()) {
++ showError(tr("The documentation directory cannot be found"));
++ return false;
++ }
++
++ const QStringList args{"-collectionFile"_L1,
++ collectionDirectory + "/simpletextviewer.qhc"_L1,
++ "-enableRemoteControl"_L1};
++
++ m_process->start(app, args);
++
++ if (!m_process->waitForStarted(3000)) {
++ showError(tr("Unable to launch Qt Assistant (%1): %2")
++ .arg(QDir::toNativeSeparators(app), m_process->errorString()));
++ return false;
++ }
++ }
++ return true;
++ }
++ //! [2]
++
++ void Assistant::showError(const QString &message)
++ {
++ QMessageBox::critical(QApplication::activeWindow(), tr("Simple Text Viewer"), message);
++ }
++
++ void Assistant::finished(int exitCode, QProcess::ExitStatus status)
++ {
++ const QString stdErr = QString::fromLocal8Bit(m_process->readAllStandardError());
++ if (status != QProcess::NormalExit)
++ showError(tr("Assistant crashed: %1").arg(stdErr));
++ else if (exitCode != 0)
++ showError(tr("Assistant exited with %1: %2").arg(exitCode).arg(stdErr));
++ }