1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtScript module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-ONLY$
** GNU Lesser General Public License Usage
** 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.
**
** If you have questions regarding the use of this file, please contact
** us via http://www.qt-project.org/.
**
** $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
|
