112 lines
4.2 KiB
C++
112 lines
4.2 KiB
C++
/*
|
|
* Copyright 2007-2008 Richard J. Moore <rich@kde.org>
|
|
* Copyright 2009 Aaron J. Seigo <aseigo@kde.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU Library General Public License version 2 as
|
|
* published by the Free Software Foundation
|
|
*
|
|
* This program 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 General Public License for more details
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this program; if not, write to the
|
|
* Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef SCRIPTENV_H
|
|
#define SCRIPTENV_H
|
|
|
|
#include <QScriptEngine>
|
|
#include <QSet>
|
|
|
|
#include <KPluginInfo>
|
|
|
|
#include "authorization.h"
|
|
|
|
class ScriptEnv : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
enum AllowedUrl { NoUrls = 0,
|
|
HttpUrls = 1,
|
|
NetworkUrls = 2,
|
|
LocalUrls = 4,
|
|
AppLaunching = 8};
|
|
Q_DECLARE_FLAGS(AllowedUrls, AllowedUrl)
|
|
|
|
ScriptEnv(QObject *parent, QScriptEngine *engine);
|
|
~ScriptEnv();
|
|
|
|
/**
|
|
* Adds common properties (e.g. registerEventFilter)
|
|
* for a 'main' object (e.g. plasmoid, engine, runner)
|
|
*/
|
|
void addMainObjectProperties(QScriptValue &value);
|
|
|
|
/** Returns the QScriptEngine in use. */
|
|
QScriptEngine *engine() const;
|
|
|
|
/** Returns the ScriptEnv in use for a given QScriptEngine or 0. */
|
|
static ScriptEnv *findScriptEnv(QScriptEngine *engine);
|
|
|
|
static void registerEnums(QScriptValue &scriptValue, const QMetaObject &meta);
|
|
bool include(const QString &path);
|
|
|
|
bool importExtensions(const KPluginInfo &info, QScriptValue &obj, Authorization &authorizer);
|
|
QSet<QString> loadedExtensions() const;
|
|
|
|
bool checkForErrors(bool fatal);
|
|
|
|
bool addEventListener(const QString &event, const QScriptValue &func);
|
|
bool removeEventListener(const QString &event, const QScriptValue &func);
|
|
|
|
QScriptValue callFunction(QScriptValue &func, const QScriptValueList &args = QScriptValueList(), const QScriptValue &activator = QScriptValue());
|
|
bool callEventListeners(const QString &event, const QScriptValueList &args = QScriptValueList());
|
|
bool hasEventListeners(const QString &event) const;
|
|
|
|
QString filePathFromScriptContext(const char *type, const QString &file) const;
|
|
|
|
Q_SIGNALS:
|
|
void reportError(ScriptEnv *engine, bool fatal);
|
|
|
|
private:
|
|
void registerGetUrl(QScriptValue &obj);
|
|
void registerOpenUrl(QScriptValue &obj);
|
|
bool importBuiltinExtension(const QString &extension, QScriptValue &obj);
|
|
|
|
static QScriptValue debug(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue print(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue runApplication(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue runCommand(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue openUrl(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue getUrl(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue listAddons(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue loadAddon(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue registerAddon(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue addEventListener(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue removeEventListener(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue hasExtension(QScriptContext *context, QScriptEngine *engine);
|
|
static QScriptValue throwNonFatalError(const QString &msg, QScriptContext *context, QScriptEngine *engine);
|
|
|
|
private Q_SLOTS:
|
|
void signalException();
|
|
|
|
private:
|
|
/** Call to set common properties on the global object **/
|
|
void setupGlobalObject();
|
|
|
|
QSet<QString> m_extensions;
|
|
AllowedUrls m_allowedUrls;
|
|
QScriptEngine *m_engine;
|
|
QHash<QString, QScriptValueList> m_eventListeners;
|
|
};
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(ScriptEnv::AllowedUrls)
|
|
|
|
#endif
|
|
|