From 03e892fcc9d53e37ef52098855fa02b7c689f016 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Gr=C3=A4=C3=9Flin?= Date: Sat, 21 Jan 2012 17:48:07 +0100 Subject: [PATCH] Workspace Wrapper uses Q_PROPERTIES The idea is to extend the wrapper to have it wrapping even more functions provided by Workspace. Of course it would be possible to just add the properties to Workspace itself and export this. But I think complete Workspace is just too powerful to fully expose to scripts. So a small wrapper around the parts which are usefull for scripts might make more sense. This breaks now also the API for Workspace and again it is already more powerful with less code than before. --- scripting/scripting.cpp | 7 +- scripting/workspace.cpp | 159 ++++++++++------------------------------ scripting/workspace.h | 37 +++++----- 3 files changed, 62 insertions(+), 141 deletions(-) diff --git a/scripting/scripting.cpp b/scripting/scripting.cpp index d8ab8e557e..4142f98f58 100644 --- a/scripting/scripting.cpp +++ b/scripting/scripting.cpp @@ -77,7 +77,9 @@ void KWin::Script::run() return; } if (m_scriptFile.open(QIODevice::ReadOnly)) { - m_workspace->attach(m_engine); + QScriptValue workspace = m_engine->newQObject(m_workspace, QScriptEngine::QtOwnership, + QScriptEngine::ExcludeSuperClassContents | QScriptEngine::ExcludeDeleteLater); + m_engine->globalObject().setProperty("workspace", workspace, QScriptValue::Undeletable); m_engine->globalObject().setProperty("QTimer", constructTimerClass(m_engine)); QObject::connect(m_engine, SIGNAL(signalHandlerException(QScriptValue)), this, SLOT(sigException(QScriptValue))); KWin::MetaScripting::registration(m_engine); @@ -158,9 +160,6 @@ void KWin::Scripting::start() loadScript(scriptsDir.filePath(scriptList.at(i))); } - // Initialize singletons. Currently, only KWin::Workspace. - SWrapper::Workspace::initialize(KWin::Workspace::self()); - runScripts(); } diff --git a/scripting/workspace.cpp b/scripting/workspace.cpp index a4576d40c8..0f4bff6667 100644 --- a/scripting/workspace.cpp +++ b/scripting/workspace.cpp @@ -3,7 +3,7 @@ This file is part of the KDE project. Copyright (C) 2010 Rohan Prabhu -Copyright (C) 2011 Martin Gräßlin +Copyright (C) 2011, 2012 Martin Gräßlin This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -20,156 +20,75 @@ along with this program. If not, see . *********************************************************************/ #include "workspace.h" -#include "meta.h" #include "../client.h" -KWin::Workspace* SWrapper::Workspace::centralObject = 0; - -QScriptValue SWrapper::valueForClient(KWin::Client *client, QScriptEngine *engine) { - return engine->newQObject(client, QScriptEngine::QtOwnership, - QScriptEngine::ExcludeChildObjects | QScriptEngine::ExcludeDeleteLater | QScriptEngine::PreferExistingWrapperObject); -} - SWrapper::Workspace::Workspace(QObject* parent) : QObject(parent) { - if (centralObject == 0) { - return; - } else { - - QObject::connect(centralObject, SIGNAL(desktopPresenceChanged(KWin::Client*,int)), - this, SIGNAL(desktopPresenceChanged(KWin::Client*,int)) - ); - - QObject::connect(centralObject, SIGNAL(currentDesktopChanged(int)), - this, SIGNAL(currentDesktopChanged(int)) - ); - - QObject::connect(centralObject, SIGNAL(clientAdded(KWin::Client*)), - this, SIGNAL(clientAdded(KWin::Client*)) - ); - QObject::connect(centralObject, SIGNAL(clientAdded(KWin::Client*)), SLOT(setupClientConnections(KWin::Client*))); - - QObject::connect(centralObject, SIGNAL(clientRemoved(KWin::Client*)), - this, SIGNAL(clientRemoved(KWin::Client*)) - ); - - QObject::connect(centralObject, SIGNAL(clientActivated(KWin::Client*)), - this, SIGNAL(clientActivated(KWin::Client*)) - ); - } - foreach (KWin::Client *client, centralObject->clientList()) { + KWin::Workspace *ws = KWin::Workspace::self(); + connect(ws, SIGNAL(desktopPresenceChanged(KWin::Client*,int)), SIGNAL(desktopPresenceChanged(KWin::Client*,int))); + connect(ws, SIGNAL(currentDesktopChanged(int)), SIGNAL(currentDesktopChanged(int))); + connect(ws, SIGNAL(clientAdded(KWin::Client*)), SIGNAL(clientAdded(KWin::Client*))); + connect(ws, SIGNAL(clientAdded(KWin::Client*)), SLOT(setupClientConnections(KWin::Client*))); + connect(ws, SIGNAL(clientRemoved(KWin::Client*)), SIGNAL(clientRemoved(KWin::Client*))); + connect(ws, SIGNAL(clientActivated(KWin::Client*)), SIGNAL(clientActivated(KWin::Client*))); + foreach (KWin::Client *client, ws->clientList()) { setupClientConnections(client); } } -bool SWrapper::Workspace::initialize(KWin::Workspace* wspace) +QList< KWin::Client* > SWrapper::Workspace::clientList() const { - if (wspace == 0) { - return false; - } else { - SWrapper::Workspace::centralObject = wspace; - return true; - } + return KWin::Workspace::self()->clientList(); } -QScriptValue SWrapper::Workspace::getAllClients(QScriptContext* ctx, QScriptEngine* eng) +KWin::Client* SWrapper::Workspace::activeClient() { - const KWin::ClientList x = centralObject->stackingOrder(); - - if (ctx->argumentCount() == 0) { - QScriptValue array = eng->newArray(x.size()); - for (int i=0; iargument(0)).toNumber(); - if ((desk_no >= 1) && (desk_no > SWrapper::Workspace::centralObject->numberOfDesktops())) { - return QScriptValue(); - } else { - QScriptValue array = eng->newArray(); - for (int i = 0; i < x.size(); i++) { - if (x.at(i)->desktop() == desk_no) { - ret.append(x.at(i)); - } - } - for (int i=0; iactiveClient(); } -QScriptValue SWrapper::Workspace::activeClient(QScriptContext* ctx, QScriptEngine* eng) +void SWrapper::Workspace::setActiveClient(KWin::Client* client) { - Q_UNUSED(ctx); - return valueForClient(centralObject->activeClient(), eng); + KWin::Workspace::self()->activateClient(client); } -QScriptValue SWrapper::Workspace::setCurrentDesktop(QScriptContext* ctx, QScriptEngine* /*eng*/) +void SWrapper::Workspace::setCurrentDesktop(int desktop) { - if (ctx->argumentCount() >= 1) { - int num = ((ctx->argument(0)).isNumber()) ? ((ctx->argument(0)).toNumber()) : (-1); - if (num != -1) { - centralObject->setCurrentDesktop(num); - } - } - - return QScriptValue(); + KWin::Workspace::self()->setCurrentDesktop(desktop); } -QScriptValue SWrapper::Workspace::dimensions(QScriptContext* ctx, QScriptEngine* eng) +int SWrapper::Workspace::workspaceWidth() const { - Q_UNUSED(ctx); - return eng->toScriptValue(QSize(centralObject->workspaceWidth(), centralObject->workspaceHeight())); + return KWin::Workspace::self()->workspaceWidth(); } -QScriptValue SWrapper::Workspace::desktopGridSize(QScriptContext* ctx, QScriptEngine* eng) +int SWrapper::Workspace::workspaceHeight() const { - Q_UNUSED(ctx); - return eng->toScriptValue(centralObject->desktopGridSize()); + return KWin::Workspace::self()->workspaceHeight(); } -QScriptValue SWrapper::Workspace::clientGroups(QScriptContext* ctx, QScriptEngine* eng) +QSize SWrapper::Workspace::workspaceSize() const { - Q_UNUSED(ctx); - return eng->toScriptValue >(centralObject->clientGroups); + return QSize(workspaceWidth(), workspaceHeight()); +} + +QSize SWrapper::Workspace::desktopGridSize() const +{ + return KWin::Workspace::self()->desktopGridSize(); +} + +int SWrapper::Workspace::desktopGridWidth() const +{ + return KWin::Workspace::self()->desktopGridWidth(); +} + +int SWrapper::Workspace::desktopGridHeight() const +{ + return KWin::Workspace::self()->desktopGridHeight(); } int SWrapper::Workspace::currentDesktop() const { - return centralObject->currentDesktop(); -} - -void SWrapper::Workspace::attach(QScriptEngine* engine) -{ - QScriptValue func; - centralEngine = engine; - - QScriptValue self = engine->newQObject( - this, - QScriptEngine::QtOwnership, - QScriptEngine::ExcludeSuperClassContents | QScriptEngine::ExcludeDeleteLater - ); - - func = engine->newFunction(setCurrentDesktop, 1); - self.setProperty("setCurrentDesktop", func, QScriptValue::Undeletable); - - func = engine->newFunction(getAllClients, 0); - self.setProperty("getAllClients", func, QScriptValue::Undeletable); - - func = engine->newFunction(dimensions, 0); - self.setProperty("dimensions", func, QScriptValue::Undeletable); - - func = engine->newFunction(desktopGridSize, 0); - self.setProperty("desktopGridSize", func, QScriptValue::Undeletable); - self.setProperty("activeClient", engine->newFunction(activeClient, 0), QScriptValue::Undeletable); - self.setProperty("clientGroups", engine->newFunction(clientGroups, 0), QScriptValue::Undeletable); - - (engine->globalObject()).setProperty("workspace", self, QScriptValue::Undeletable); + return KWin::Workspace::self()->currentDesktop(); } void SWrapper::Workspace::setupClientConnections(KWin::Client *client) diff --git a/scripting/workspace.h b/scripting/workspace.h index 0c8b636857..d6c2eea64b 100644 --- a/scripting/workspace.h +++ b/scripting/workspace.h @@ -3,6 +3,7 @@ This file is part of the KDE project. Copyright (C) 2010 Rohan Prabhu +Copyright (C) 2012 Martin Gräßlin This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -22,7 +23,6 @@ along with this program. If not, see . #define KWIN_SCRIPTING_WORKSPACE_H #include "../workspace.h" -#include namespace SWrapper { @@ -30,13 +30,17 @@ namespace SWrapper class Workspace : public QObject { Q_OBJECT - //Don't add WRITE for now. Access considerations - Q_PROPERTY(int currentDesktop READ currentDesktop) + Q_PROPERTY(int currentDesktop READ currentDesktop WRITE setCurrentDesktop NOTIFY currentDesktopChanged) + Q_PROPERTY(KWin::Client *activeClient READ activeClient WRITE setActiveClient NOTIFY clientActivated) + // TODO: write and notify? + Q_PROPERTY(QSize desktopGridSize READ desktopGridSize) + Q_PROPERTY(int desktopGridWidth READ desktopGridWidth) + Q_PROPERTY(int desktopGridHeight READ desktopGridHeight) + Q_PROPERTY(int workspaceWidth READ workspaceWidth) + Q_PROPERTY(int workspaceHeight READ workspaceHeight) + Q_PROPERTY(QSize workspaceSize READ workspaceSize) private: - static KWin::Workspace* centralObject; - QScriptEngine* centralEngine; - Q_DISABLE_COPY(Workspace) signals: @@ -57,23 +61,22 @@ signals: public: Workspace(QObject* parent = 0); int currentDesktop() const; - void attach(QScriptEngine*); + void setCurrentDesktop(int desktop); + KWin::Client *activeClient(); + void setActiveClient(KWin::Client *client); + QSize desktopGridSize() const; + int desktopGridWidth() const; + int desktopGridHeight() const; + int workspaceWidth() const; + int workspaceHeight() const; + QSize workspaceSize() const; - static QScriptValue getAllClients(QScriptContext*, QScriptEngine*); - - static bool initialize(KWin::Workspace*); - static QScriptValue setCurrentDesktop(QScriptContext*, QScriptEngine*); - static QScriptValue dimensions(QScriptContext*, QScriptEngine*); - static QScriptValue desktopGridSize(QScriptContext*, QScriptEngine*); - static QScriptValue activeClient(QScriptContext*, QScriptEngine*); - static QScriptValue clientGroups(QScriptContext*, QScriptEngine*); + Q_INVOKABLE QList< KWin::Client* > clientList() const; private Q_SLOTS: void setupClientConnections(KWin::Client* client); }; -QScriptValue valueForClient(KWin::Client *client, QScriptEngine *engine); - } #endif