src/script/api/qscriptextensionplugin.cpp
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/script/api/qscriptextensionplugin.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,143 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtScript module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qscriptextensionplugin.h"
+
+#include "qscriptvalue.h"
+#include "qscriptengine.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \since 4.3
+    \class QScriptExtensionPlugin
+    \brief The QScriptExtensionPlugin class provides an abstract base for custom QScript extension plugins.
+
+    \ingroup plugins
+
+    QScriptExtensionPlugin is a plugin interface that makes it
+    possible to offer extensions that can be loaded dynamically into
+    applications using the QScriptEngine class.
+
+    Writing a script extension plugin is achieved by subclassing this
+    base class, reimplementing the pure virtual keys() and initialize()
+    functions, and exporting the class using the Q_EXPORT_PLUGIN2()
+    macro. See \l {How to Create Qt Plugins} for details.
+
+    \sa QScriptEngine::importExtension(), {Creating QtScript Extensions}
+*/
+
+/*!
+    \fn QStringList QScriptExtensionPlugin::keys() const
+
+    Returns the list of keys this plugin supports.
+
+    These keys are usually the names of the "modules" or "packages"
+    that are implemented in the plugin (e.g. \c{com.mycompany.MyProduct}).
+
+    \sa initialize()
+*/
+
+/*!
+    \fn void QScriptExtensionPlugin::initialize(const QString& key, QScriptEngine *engine)
+
+    Initializes the extension specified by \a key in the given \a engine.
+    The key must come from the set of keys().
+
+    \sa keys()
+*/
+
+/*!
+    Constructs a script extension plugin with the given \a parent.
+
+    Note that this constructor is invoked automatically by the
+    Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
+    explicitly.
+*/
+QScriptExtensionPlugin::QScriptExtensionPlugin(QObject *parent)
+    : QObject(parent)
+{
+}
+
+/*!
+    Destroys the script extension plugin.
+
+    Note that Qt destroys a plugin automatically when it is no longer
+    used, so there is no need for calling the destructor explicitly.
+*/
+QScriptExtensionPlugin::~QScriptExtensionPlugin()
+{
+}
+
+/*!
+
+  This function is provided for convenience when reimplementing
+  initialize(). It splits the given \a key on \c{'.'} (dot), and
+  ensures that there's a corresponding path of objects in the
+  environment of the given \a engine, creating new objects to complete
+  the path if necessary.  E.g. if the key is "com.trolltech", after
+  the call to setupPackage() the script expression \c{com.trolltech}
+  will evaluate to an object. More specifically, the engine's Global
+  Object will have a property called "com", which in turn has a
+  property called "trolltech".
+
+  Use this function to avoid global namespace pollution when installing
+  your extensions in the engine.
+
+  \sa initialize()
+*/
+QScriptValue QScriptExtensionPlugin::setupPackage(
+    const QString &key, QScriptEngine *engine) const
+{
+    QStringList components = key.split(QLatin1Char('.'));
+    QScriptValue o = engine->globalObject();
+    for (int i = 0; i < components.count(); ++i) {
+        QScriptValue oo = o.property(components.at(i));
+        if (!oo.isValid()) {
+            oo = engine->newObject();
+            o.setProperty(components.at(i), oo);
+        }
+        o = oo;
+    }
+    return o;
+}
+
+QT_END_NAMESPACE