plugins/execute/executeplugin.cpp

   1 /*
   2   * This file is part of KDevelop
   3  *
   4  * Copyright 2007 Hamish Rodda <rodda@kde.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU Library General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 #include "executeplugin.h"
  23
  24 #include <QApplication>
  25
  26 #include <klocale.h>
  27 #include <kpluginfactory.h>
  28 #include <kpluginloader.h>
  29 #include <kdebug.h>
  30 #include <kjob.h>
  31 #include <kmessagebox.h>
  32 #include <kaboutdata.h>
  33
  34 #include <util/environmentgrouplist.h>
  35
  36 using namespace KDevelop;
  37
  38 K_PLUGIN_FACTORY(KDevExecuteFactory, registerPlugin<ExecutePlugin>(); )
  39 K_EXPORT_PLUGIN(KDevExecuteFactory(KAboutData("kdevexecute", "kdevexecute", ki18n("Execute support"), "0.1", ki18n("Allows running of native apps"), KAboutData::License_GPL)))
  40
  41 ExecutePlugin::ExecutePlugin(QObject *parent, const QVariantList&)
  42     : KDevelop::IPlugin(KDevExecuteFactory::componentData(), parent)
  43 {
  44   KDEV_USE_EXTENSION_INTERFACE( KDevelop::IRunProvider )
  45 }
  46
  47 ExecutePlugin::~ExecutePlugin()
  48 {
  49 }
  50
  51 void ExecutePlugin::unload()
  52 {
  53 }
  54
  55 QStringList ExecutePlugin::instrumentorsProvided() const
  56 {
  57     return QStringList() << "default";
  58 }
  59
  60 QString ExecutePlugin::translatedInstrumentor(const QString&) const
  61 {
  62     return i18n("Run");
  63 }
  64
  65 bool ExecutePlugin::execute(const IRun & run, KJob* job)
  66 {
  67     Q_ASSERT(instrumentorsProvided().contains(run.instrumentor()));
  68
  69     QProcess* process = new QProcess(this);
  70     connect(process, SIGNAL(readyReadStandardOutput()), SLOT(readyReadStandardOutput()));
  71     connect(process, SIGNAL(readyReadStandardError()), SLOT(readyReadStandardError()));
  72     connect(process, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
  73     connect(process, SIGNAL(error(QProcess::ProcessError)), SLOT(error(QProcess::ProcessError)));
  74
  75     m_runners.insert(job, process);
  76
  77     KDevelop::EnvironmentGroupList l(KGlobal::config());
  78     process->setProperty("job", QVariant::fromValue(static_cast<void*>(job)));
  79     process->setEnvironment(l.createEnvironment(run.environmentKey(), process->systemEnvironment()));
  80     process->setWorkingDirectory(run.workingDirectory().path());
  81
  82     process->setProperty("executable", run.executable().path());
  83     process->start(run.executable().path(), run.arguments());
  84
  85     kDebug() << "Started process" << run.executable().path() << "with arguments" << run.arguments();
  86
  87     return true;
  88 }
  89
  90 void ExecutePlugin::abort(KJob* job)
  91 {
  92     if (m_runners.contains(job)) {
  93         QProcess* process = m_runners.take(job);
  94         process->close();
  95         delete process;
  96     }
  97 }
  98
  99 void ExecutePlugin::readyReadStandardError()
 100 {
 101     QProcess* process = qobject_cast<QProcess*>(sender());
 102     if (!process)
 103         return;
 104
 105     readFrom(process, QProcess::StandardError);
 106 }
 107
 108 void ExecutePlugin::readyReadStandardOutput()
 109 {
 110     QProcess* process = qobject_cast<QProcess*>(sender());
 111     if (!process)
 112         return;
 113
 114     readFrom(process, QProcess::StandardOutput);
 115 }
 116
 117 void ExecutePlugin::readFrom(QProcess * process, QProcess::ProcessChannel channel)
 118 {
 119     process->setReadChannel(channel);
 120     KJob* job = static_cast<KJob*>(qvariant_cast<void*>(process->property("job")));
 121
 122     while (process->canReadLine()) {
 123         QByteArray line = process->readLine() + '\n';
 124         QString string = QString::fromLocal8Bit(line, line.length() - 2);
 125         emit output(job, string, channel == QProcess::StandardOutput ? IRunProvider::StandardOutput : IRunProvider::StandardError);
 126     }
 127 }
 128
 129 void ExecutePlugin::processFinished(int exitCode, QProcess::ExitStatus exitStatus)
 130 {
 131     QProcess* process = qobject_cast<QProcess*>(sender());
 132     if (!process)
 133         return;
 134
 135     KJob* job = static_cast<KJob*>(qvariant_cast<void*>(process->property("job")));
 136
 137     if (exitCode == 0 && exitStatus == QProcess::NormalExit)
 138         emit output(job, i18n("*** Exited normally ***"), IRunProvider::RunProvider);
 139     else
 140         if (exitStatus == QProcess::NormalExit)
 141             emit output(job, i18n("*** Exited with return code: %1 ***", QString::number(exitCode)), IRunProvider::RunProvider);
 142         else
 143             if (job->error() == KJob::KilledJobError)
 144                 emit output(job, i18n("*** Process aborted ***"), IRunProvider::RunProvider);
 145             else
 146                 emit output(job, i18n("*** Crashed with return code: %1 ***", QString::number(exitCode)), IRunProvider::RunProvider);
 147
 148     emit finished(job);
 149 }
 150
 151 void ExecutePlugin::error(QProcess::ProcessError error)
 152 {
 153     const QProcess* process = qobject_cast<const QProcess*>(sender());
 154     Q_ASSERT(process);
 155
 156     if( error == QProcess::FailedToStart )
 157     {
 158         KMessageBox::information(
 159             qApp->activeWindow(),
 160             i18n("<b>Could not start program.</b>"
 161                  "<p>Could not run '%1'. "
 162                  "Make sure that the path name is specified correctly.",
 163                  process->property("executable").toString()),
 164             i18n("Could not start program"));
 165     }
 166
 167     KJob* job = static_cast<KJob*>(qvariant_cast<void*>(process->property("job")));
 168     Q_ASSERT(job);
 169
 170     emit finished(job);
 171 }
 172
 173 #include "executeplugin.moc"
 174
 175 // kate: space-indent on; indent-width 4; tab-width 4; replace-tabs on; auto-insert-doxygen on