yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Configuration support for KWin scripts

Browse source 
New global method readConfig is exported to QtScript and declarative scripts.
Config is read from a config group stored in kwinrc called "Script-<pluginname>".
For this the ctors of the AbstractScript and derived classes are changed to also
take the pluginname.
This commit is contained in:
Martin Gräßlin 2012-02-25 11:30:45 +01:00
parent 6c225755fc
commit 87fede97a1
2 changed files with 65 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
scripting/scripting.cpp
View file

@ -57,26 +57,62 @@ QScriptValue kwinScriptPrint(QScriptContext *context, QScriptEngine *engine)
return engine->undefinedValue();
}
KWin::AbstractScript::AbstractScript (int id, QString scriptName, QObject *parent)
QScriptValue kwinScriptReadConfig(QScriptContext *context, QScriptEngine *engine)
{
KWin::AbstractScript *script = qobject_cast<KWin::AbstractScript*>(context->callee().data().toQObject());
if (context->argumentCount() < 1 || context->argumentCount() > 2) {
kDebug(1212) << "Incorrect number of arguments";
return engine->undefinedValue();
}
const QString key = context->argument(0).toString();
QVariant defaultValue;
if (context->argumentCount() == 2) {
defaultValue = context->argument(1).toVariant();
}
return engine->newVariant(script->config().readEntry(key, defaultValue));
}
KWin::AbstractScript::AbstractScript(int id, QString scriptName, QString pluginName, QObject *parent)
: QObject(parent)
, m_scriptId(id)
, m_pluginName(pluginName)
, m_running(false)
, m_workspace(new WorkspaceWrapper(this))
{
m_scriptFile.setFileName(scriptName);
if (m_pluginName.isNull()) {
m_pluginName = scriptName;
}
}
KWin::AbstractScript::~AbstractScript()
{
}
KConfigGroup KWin::AbstractScript::config() const
{
return KGlobal::config()->group("Script-" + m_pluginName);
}
void KWin::AbstractScript::stop()
{
deleteLater();
}
KWin::Script::Script(int id, QString scriptName, QObject *parent)
: AbstractScript(id, scriptName, parent)
void KWin::AbstractScript::installScriptFunctions(QScriptEngine* engine)
{
// add our print
QScriptValue printFunc = engine->newFunction(kwinScriptPrint);
printFunc.setData(engine->newQObject(this));
engine->globalObject().setProperty("print", printFunc);
// add read config
QScriptValue configFunc = engine->newFunction(kwinScriptReadConfig);
configFunc.setData(engine->newQObject(this));
engine->globalObject().setProperty("readConfig", configFunc);
}
KWin::Script::Script(int id, QString scriptName, QString pluginName, QObject* parent)
: AbstractScript(id, scriptName, pluginName, parent)
, m_engine(new QScriptEngine(this))
{
QDBusConnection::sessionBus().registerObject('/' + QString::number(scriptId()), this, QDBusConnection::ExportScriptableContents | QDBusConnection::ExportScriptableInvokables);
@ -110,10 +146,7 @@ void KWin::Script::run()
QObject::connect(m_engine, SIGNAL(signalHandlerException(QScriptValue)), this, SLOT(sigException(QScriptValue)));
KWin::MetaScripting::registration(m_engine);
KWin::MetaScripting::supplyConfig(m_engine);
// add our print
QScriptValue printFunc = m_engine->newFunction(kwinScriptPrint);
printFunc.setData(m_engine->newQObject(this));
m_engine->globalObject().setProperty("print", printFunc);
installScriptFunctions(m_engine);
QScriptValue ret = m_engine->evaluate(scriptFile().readAll());
@ -142,8 +175,8 @@ void KWin::Script::sigException(const QScriptValue& exception)
emit printError(exception.toString());
}
KWin::DeclarativeScript::DeclarativeScript(int id, QString scriptName, QObject *parent)
: AbstractScript(id, scriptName, parent)
KWin::DeclarativeScript::DeclarativeScript(int id, QString scriptName, QString pluginName, QObject* parent)
: AbstractScript(id, scriptName, pluginName, parent)
, m_view(new QDeclarativeView())
{
}
@ -168,10 +201,13 @@ void KWin::DeclarativeScript::run()
foreach (const QString &importPath, KGlobal::dirs()->findDirs("module", "imports")) {
m_view->engine()->addImportPath(importPath);
}
// add read config
KDeclarative kdeclarative;
kdeclarative.setDeclarativeEngine(m_view->engine());
kdeclarative.initialize();
kdeclarative.setupBindings();
installScriptFunctions(kdeclarative.scriptEngine());
qmlRegisterType<ThumbnailItem>("org.kde.kwin", 0, 1, "ThumbnailItem");
qmlRegisterType<WorkspaceWrapper>("org.kde.kwin", 0, 1, "KWin");
@ -216,9 +252,9 @@ void KWin::Scripting::start()
continue;
}
if (javaScript) {
loadScript(file);
loadScript(file, pluginName);
} else if (declarativeScript) {
loadDeclarativeScript(file);
loadDeclarativeScript(file, pluginName);
}
}
@ -237,19 +273,19 @@ void KWin::Scripting::scriptDestroyed(QObject *object)
scripts.removeAll(static_cast<KWin::Script*>(object));
}
int KWin::Scripting::loadScript(const QString &filePath)
int KWin::Scripting::loadScript(const QString &filePath, const QString& pluginName)
{
const int id = scripts.size();
KWin::Script *script = new KWin::Script(id, filePath, this);
KWin::Script *script = new KWin::Script(id, filePath, pluginName, this);
connect(script, SIGNAL(destroyed(QObject*)), SLOT(scriptDestroyed(QObject*)));
scripts.append(script);
return id;
}
int KWin::Scripting::loadDeclarativeScript(const QString &filePath)
int KWin::Scripting::loadDeclarativeScript(const QString& filePath, const QString& pluginName)
{
const int id = scripts.size();
KWin::DeclarativeScript *script = new KWin::DeclarativeScript(id, filePath, this);
KWin::DeclarativeScript *script = new KWin::DeclarativeScript(id, filePath, pluginName, this);
connect(script, SIGNAL(destroyed(QObject*)), SLOT(scriptDestroyed(QObject*)));
scripts.append(script);
return id;

19
scripting/scripting.h
View file

@ -28,6 +28,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
class QDeclarativeView;
class QScriptEngine;
class QScriptValue;
class KConfigGroup;
namespace KWin
{
@ -37,12 +38,14 @@ class AbstractScript : public QObject
{
Q_OBJECT
public:
AbstractScript(int id, QString scriptName, QObject *parent = NULL);
AbstractScript(int id, QString scriptName, QString pluginName, QObject *parent = NULL);
~AbstractScript();
QString fileName() const {
return m_scriptFile.fileName();
}
KConfigGroup config() const;
public Q_SLOTS:
Q_SCRIPTABLE void stop();
Q_SCRIPTABLE virtual void run() = 0;
@ -51,6 +54,9 @@ protected:
QFile &scriptFile() {
return m_scriptFile;
}
const QString &pluginName() {
return m_pluginName;
}
bool running() const {
return m_running;
}
@ -65,9 +71,12 @@ protected:
return m_workspace;
}
void installScriptFunctions(QScriptEngine *engine);
private:
int m_scriptId;
QFile m_scriptFile;
QString m_pluginName;
bool m_running;
WorkspaceWrapper *m_workspace;
};
@ -78,7 +87,7 @@ class Script : public AbstractScript
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.Scripting")
public:
Script(int id, QString scriptName, QObject *parent = NULL);
Script(int id, QString scriptName, QString pluginName, QObject *parent = NULL);
virtual ~Script();
void printMessage(const QString &message);
@ -106,7 +115,7 @@ class DeclarativeScript : public AbstractScript
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.Scripting")
public:
explicit DeclarativeScript(int id, QString scriptName, QObject *parent = 0);
explicit DeclarativeScript(int id, QString scriptName, QString pluginName, QObject *parent = 0);
virtual ~DeclarativeScript();
public Q_SLOTS:
@ -138,8 +147,8 @@ public:
*/
void start();
~Scripting();
Q_SCRIPTABLE Q_INVOKABLE int loadScript(const QString &filePath);
Q_SCRIPTABLE Q_INVOKABLE int loadDeclarativeScript(const QString &filePath);
Q_SCRIPTABLE Q_INVOKABLE int loadScript(const QString &filePath, const QString &pluginName = QString());
Q_SCRIPTABLE Q_INVOKABLE int loadDeclarativeScript(const QString &filePath, const QString &pluginName = QString());
public Q_SLOTS:
void scriptDestroyed(QObject *object);