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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/***************************************************************************
* scriptcontainer.h
* This file is part of the KDE project
* copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KROSS_API_SCRIPTCONTAINER_H
#define KROSS_API_SCRIPTCONTAINER_H
#include "mainmodule.h"
#include <tqstring.h>
#include <tqvariant.h>
#include <tqobject.h>
#include <ksharedptr.h>
namespace Kross { namespace Api {
// Forward declarations.
class Object;
class List;
class ScriptContainerPrivate;
/**
* The ScriptContainer class is something like a single
* standalone scriptfile.
*
* Once you've such a ScriptContainer instance you're
* able to perform actions with it like to execute
* scripting code. The \a Manager takes care of
* handling the ScriptContainer instances application
* width.
*
* The class \a ScriptAction provides a higher level class
* to work with a \a ScriptContainer instances.
*/
class ScriptContainer : public MainModule
{
// We protected the constructor cause ScriptContainer
// instances should be created only within the
// Manager::getScriptContainer() method.
friend class Manager;
protected:
/**
* Constructor.
*
* The constructor is protected cause only with the
* \a ScriptManager it's possible to access
* \a ScriptContainer instances.
*
* \param name The unique name this ScriptContainer
* has. It's used e.g. at the \a Manager to
* identify the ScriptContainer.
*/
explicit ScriptContainer(const TQString& name = TQString());
public:
/// Shared pointer to implement reference-counting.
typedef TDESharedPtr<ScriptContainer> Ptr;
/**
* Destructor.
*/
virtual ~ScriptContainer();
/**
* \return the unique name this ScriptContainer is
* reachable as.
*/
const TQString getName() const;
/**
* Set the name this ScriptContainer is reachable as.
*/
void setName(const TQString& name);
/**
* Return the scriptcode this ScriptContainer holds.
*/
TQString getCode() const;
/**
* Set the scriptcode this ScriptContainer holds.
*/
void setCode(const TQString& code);
/**
* \return the name of the interpreter used
* on \a execute.
*/
TQString getInterpreterName() const;
/**
* Set the name of the interpreter used
* on \a execute.
*/
void setInterpreterName(const TQString& interpretername);
/**
* \return the filename which will be executed
* on \a execute.
*/
TQString getFile() const;
/**
* Set the filename which will be executed
* on \a execute. The \p scriptfile needs to
* be a valid local file or TQString() if
* you don't like to use a file rather then
* the with \a setCode() defined scripting code.
*/
void setFile(const TQString& scriptfile);
/**
* \return a map of options this \a ScriptContainer defines.
* The options are returned call-by-ref, so you are able to
* manipulate them.
*/
TQMap<TQString, TQVariant>& getOptions();
/**
* \return the value of the option defined with \p name .
* If there doesn't exists an option with such a name,
* the \p defaultvalue is returned. If \p recursive is
* true then first the \a ScriptContainer options are
* seeked for the matching \p name and if not found
* the \a Manager options are seeked for the \p name and
* if not found either the \p defaultvalue is returned.
*/
TQVariant getOption(const TQString name, TQVariant defaultvalue = TQVariant(), bool recursive = false);
/**
* Set the \a Interpreter::Option value.
*/
bool setOption(const TQString name, const TQVariant& value);
/**
* Execute the script container.
*/
Object::Ptr execute();
/**
* Return a list of functionnames the with
* \a setCode defined scriptcode spends.
*/
const TQStringList getFunctionNames();
/**
* Call a function in the script container.
*
* \param functionname The name of the function
* to call.
* \param arguments Optional list of arguments
* passed to the function.
* \return \a Object instance representing
* the functioncall returnvalue.
*/
TDESharedPtr<Object> callFunction(const TQString& functionname, TDESharedPtr<List> arguments = 0);
/**
* Return a list of classes.
*/
TQStringList getClassNames();
/**
* Create and return a new class instance.
*/
TDESharedPtr<Object> classInstance(const TQString& classname);
/**
* Initialize the \a Script instance.
*
* Normaly it's not needed to call this function direct cause
* if will be internaly called if needed (e.g. on \a execute ).
*/
bool initialize();
/**
* Finalize the \a Script instance and free's any cached or still
* running executions. Normaly it's not needed to call this
* function direct cause the \a ScriptContainer will take care
* of calling it if needed.
*/
void finalize();
private:
/// Internaly used private d-pointer.
ScriptContainerPrivate* d;
};
}}
#endif
|
