workspace/plasma/scriptengines/javascript/javascriptrunner.cpp

   1 /*
   2  *   Copyright 2008 Richard J. Moore <rich@kde.org>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library General Public License version 2 as
   6  *   published by the Free Software Foundation
   7  *
   8  *   This program is distributed in the hope that it will be useful,
   9  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  *   GNU General Public License for more details
  12  *
  13  *   You should have received a copy of the GNU Library General Public
  14  *   License along with this program; if not, write to the
  15  *   Free Software Foundation, Inc.,
  16  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 #include "javascriptrunner.h"
  20
  21 #include <QScriptEngine>
  22 #include <QFile>
  23
  24 #include <Plasma/AbstractRunner>
  25 #include <Plasma/QueryMatch>
  26
  27
  28 typedef const Plasma::RunnerContext* ConstRunnerContextStar;
  29 typedef const Plasma::QueryMatch* ConstSearchMatchStar;
  30
  31 Q_DECLARE_METATYPE(Plasma::QueryMatch*)
  32 Q_DECLARE_METATYPE(Plasma::RunnerContext*)
  33 Q_DECLARE_METATYPE(ConstRunnerContextStar)
  34 Q_DECLARE_METATYPE(ConstSearchMatchStar)
  35
  36 JavaScriptRunner::JavaScriptRunner(QObject *parent, const QVariantList &args)
  37     : RunnerScript(parent)
  38 {
  39     m_engine = new QScriptEngine( this );
  40     importExtensions();
  41 }
  42
  43 JavaScriptRunner::~JavaScriptRunner()
  44 {
  45 }
  46
  47 Plasma::AbstractRunner* JavaScriptRunner::runner() const
  48 {
  49     return RunnerScript::runner();
  50 }
  51
  52 bool JavaScriptRunner::init()
  53 {
  54     setupObjects();
  55
  56     QFile file(mainScript());
  57     if ( !file.open(QIODevice::ReadOnly | QIODevice::Text) ) {
  58         kWarning() << "Unable to load script file";
  59         return false;
  60     }
  61
  62     QString script = file.readAll();
  63     kDebug() << "Script says" << script;
  64
  65     m_engine->evaluate( script );
  66     if ( m_engine->hasUncaughtException() ) {
  67         reportError();
  68         return false;
  69     }
  70
  71     return true;
  72 }
  73
  74 void JavaScriptRunner::match(Plasma::RunnerContext *search)
  75 {
  76     QScriptValue fun = m_self.property( "match" );
  77     if ( !fun.isFunction() ) {
  78         kDebug() << "Script: match is not a function, " << fun.toString();
  79         return;
  80     }
  81
  82     QScriptValueList args;
  83     args << m_engine->toScriptValue(search);
  84
  85     QScriptContext *ctx = m_engine->pushContext();
  86     ctx->setActivationObject( m_self );
  87     fun.call( m_self, args );
  88     m_engine->popContext();
  89
  90     if ( m_engine->hasUncaughtException() ) {
  91         reportError();
  92     }
  93 }
  94
  95 void JavaScriptRunner::exec(const Plasma::RunnerContext *search, const Plasma::QueryMatch *action)
  96 {
  97     QScriptValue fun = m_self.property( "exec" );
  98     if ( !fun.isFunction() ) {
  99         kDebug() << "Script: exec is not a function, " << fun.toString();
 100         return;
 101     }
 102
 103     QScriptValueList args;
 104     args << m_engine->toScriptValue(search);
 105     args << m_engine->toScriptValue(action);
 106
 107     QScriptContext *ctx = m_engine->pushContext();
 108     ctx->setActivationObject( m_self );
 109     fun.call( m_self, args );
 110     m_engine->popContext();
 111
 112     if ( m_engine->hasUncaughtException() ) {
 113         reportError();
 114     }
 115 }
 116
 117 void JavaScriptRunner::setupObjects()
 118 {
 119     QScriptValue global = m_engine->globalObject();
 120
 121     // Expose an applet
 122     m_self = m_engine->newQObject( this );
 123     m_self.setScope( global );
 124
 125     global.setProperty("runner", m_self);
 126 }
 127
 128 void JavaScriptRunner::importExtensions()
 129 {
 130     QStringList extensions;
 131     //extensions << "qt.core" << "qt.gui" << "qt.svg" << "qt.xml" << "org.kde.plasma";
 132     extensions << "qt.core" << "qt.gui" << "qt.xml";
 133     foreach (const QString &ext, extensions) {
 134         kDebug() << "importing " << ext << "...";
 135         QScriptValue ret = m_engine->importExtension(ext);
 136         if (ret.isError())
 137             kDebug() << "failed to import extension" << ext << ":" << ret.toString();
 138     }
 139     kDebug() << "done importing extensions.";
 140 }
 141
 142 void JavaScriptRunner::reportError()
 143 {
 144     kDebug() << "Error: " << m_engine->uncaughtException().toString()
 145              << " at line " << m_engine->uncaughtExceptionLineNumber() << endl;
 146     kDebug() << m_engine->uncaughtExceptionBacktrace();
 147 }
 148
 149 #include "javascriptrunner.moc"