File size: 7,185 Bytes
985c397 | 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 | /***************************************************************************
* Copyright (c) 2008 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#include <QCoreApplication>
#include <QDir>
#include <QFileInfo>
#include <QLibraryInfo>
#include <QMessageBox>
#include <QProcess>
#include <QTextStream>
#include <App/Application.h>
#include <Base/Console.h>
#include "Assistant.h"
using namespace Gui;
/* TRANSLATOR Gui::Assistant */
Assistant::Assistant()
: proc(nullptr)
{}
Assistant::~Assistant()
{
if (proc && proc->state() == QProcess::Running) {
proc->terminate();
proc->waitForFinished(3000);
}
}
void Assistant::showDocumentation(const QString& page)
{
if (!startAssistant()) {
return;
}
if (!page.isEmpty()) {
QTextStream str(proc);
str << QLatin1String("setSource qthelp://org.freecad.usermanual/doc/") << page
<< QLatin1String("\n\n");
}
}
bool Assistant::startAssistant()
{
if (!proc) {
proc = new QProcess();
connect(proc, &QProcess::readyReadStandardOutput, this, &Assistant::readyReadStandardOutput);
connect(proc, &QProcess::readyReadStandardError, this, &Assistant::readyReadStandardError);
}
if (proc->state() != QProcess::Running) {
#ifdef Q_OS_WIN
QString app;
app = QDir::toNativeSeparators(
QString::fromStdString(App::Application::getHomePath()) + QLatin1String("bin/")
);
#elif defined(Q_OS_MACOS)
QString app = QCoreApplication::applicationDirPath() + QDir::separator();
#else
# if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
QString app = QLibraryInfo::location(QLibraryInfo::BinariesPath) + QDir::separator();
# else
QString app = QLibraryInfo::path(QLibraryInfo::BinariesPath) + QDir::separator();
# endif
#endif
app += QLatin1String("assistant");
// get the name of the executable and the doc path
QString exe = QString::fromStdString(App::Application::getExecutableName());
QString doc = QString::fromStdString(App::Application::getHelpDir());
QString qhc = doc + exe.toLower() + QLatin1String(".qhc");
QFileInfo fi(qhc);
if (!fi.isReadable()) {
QMessageBox::critical(
nullptr,
tr("%1 Help").arg(exe),
tr("%1 help files not found (%2). You might need to install the %1 documentation "
"package.")
.arg(exe, qhc)
);
return false;
}
static bool first = true;
if (first) {
Base::Console().log("Help file at %s\n", (const char*)qhc.toUtf8());
first = false;
}
// AppImage start
// AppImage mount location changes on each start. Assistant caches freecad.qhc
// file and sets an absolute path. As a result embedded documentation only works
// on the first AppImage (help) run. Register the .gch file, to overcome the issue.
static bool start = true;
if (start) {
char* appimage = getenv("APPIMAGE");
if (appimage) {
QString qch = doc + exe.toLower() + QLatin1String(".qch");
QFileInfo fi(qch);
if (fi.isReadable()) {
// Assume documentation is embedded
// Unregister qch file (path) from previous AppImage run
QStringList args;
args << QLatin1String("-collectionFile") << qhc << QLatin1String("-unregister")
<< qch;
proc->start(app, args);
if (!proc->waitForFinished(50000)) {
QMessageBox::critical(
nullptr,
tr("%1 Help").arg(exe),
tr("Unable to launch Qt Assistant (%1)").arg(app)
);
return false;
}
// Register qch file (path) for current AppImage run
args.clear();
args << QLatin1String("-collectionFile") << qhc << QLatin1String("-register")
<< qch;
proc->start(app, args);
if (!proc->waitForFinished(50000)) {
QMessageBox::critical(
nullptr,
tr("%1 Help").arg(exe),
tr("Unable to launch Qt Assistant (%1)").arg(app)
);
return false;
}
}
}
start = false;
}
// AppImage end
QStringList args;
args << QLatin1String("-collectionFile") << qhc << QLatin1String("-enableRemoteControl");
proc->start(app, args);
if (!proc->waitForStarted()) {
QMessageBox::critical(
nullptr,
tr("%1 Help").arg(exe),
tr("Unable to launch Qt Assistant (%1)").arg(app)
);
return false;
}
}
return true;
}
void Assistant::readyReadStandardOutput()
{
QByteArray data = proc->readAllStandardOutput();
Base::Console().log("Help view: %s\n", data.constData());
}
void Assistant::readyReadStandardError()
{
QByteArray data = proc->readAllStandardError();
Base::Console().log("Help view: %s\n", data.constData());
}
#include "moc_Assistant.cpp"
|