Kross::Api::ScriptContainer

Kross::Api::ScriptContainer Class Reference

#include <scriptcontainer.h>

Inheritance diagram for Kross::Api::ScriptContainer:

Inheritance graph
[legend]
Collaboration diagram for Kross::Api::ScriptContainer:

Collaboration graph
[legend]
List of all members.

Detailed Description

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 Manager takes care of handling the ScriptContainer instances application width.

The class ScriptAction provides a higher level class to work with a ScriptContainer instances.

Definition at line 51 of file scriptcontainer.h.

Public Types

typedef KSharedPtr< ScriptContainer > Ptr
 Shared pointer to implement reference-counting.

Public Member Functions

virtual ~ScriptContainer ()
const QString & getName () const
void setName (const QString &name)
const QString & getCode () const
void setCode (const QString &code)
const QString & getInterpreterName () const
void setInterpreterName (const QString &interpretername)
const QString & getFile () const
void setFile (const QString &scriptfile)
QMap< QString, QVariant > & getOptions ()
const QVariant & getOption (const QString name, QVariant defaultvalue=QVariant(), bool recursive=false)
bool setOption (const QString name, const QVariant &value)
Object::Ptr execute ()
const QStringList getFunctionNames ()
KSharedPtr< Object > callFunction (const QString &functionname, KSharedPtr< List > arguments=0)
const QStringList getClassNames ()
KSharedPtr< Object > classInstance (const QString &classname)
bool initialize ()
void finalize ()
virtual const QString getClassName () const
bool hadException ()
Exception::Ptr getException ()
void setException (Exception::Ptr exception)
bool hasChild (const QString &name) const
Object::Ptr hasChild (List::Ptr args)
EventSignal::Ptr addSignal (const QString &name, QObject *sender, QCString signal)
EventSlot::Ptr addSlot (const QString &name, QObject *receiver, QCString slot)
QtObject::Ptr addQObject (QObject *object, const QString &name=QString::null)
EventAction::Ptr addKAction (KAction *action, const QString &name=QString::null)
virtual Kross::Api::Object::Ptr get (const QString &, void *=0)
void addFunction (const QString &name, FunctionPtr function, const ArgumentList &=ArgumentList())
void addFunction (const QString &name, Function *function)
void addProxyFunction (const QString &name, INSTANCE *instance, METHOD method)
void addProxyFunction (const QString &name, INSTANCE *instance, METHOD method)
 Same as above, but with three arguments.
void addProxyFunction (const QString &name, INSTANCE *instance, METHOD method)
 Same as above, but with two arguments.
void addProxyFunction (const QString &name, INSTANCE *instance, METHOD method)
 Same as above, but with one argument.
void addProxyFunction (const QString &name, INSTANCE *instance, METHOD method)
 Same as above, but with no arguments.
bool isAFunction (const QString &name) const
virtual Object::Ptr call (const QString &name, List::Ptr arguments)
virtual Object::Ptr call (const QString &name, KSharedPtr< List > arguments)
Object::Ptr getChild (List::Ptr args)
Object::Ptr getChild (const QString &name) const
Object::Ptr getChildrenList (List::Ptr args)
Object::Ptr getChildrenDict (List::Ptr args)
Object::Ptr callChild (List::Ptr args)
virtual const QString toString ()
Object::Ptr getParent () const
QMap< QString, Object::Ptr > getChildren () const
bool addChild (Object::Ptr object, const QString &name=QString::null)
void removeChild (const QString &name)
void removeAllChildren ()
virtual QStringList getCalls ()

Static Public Member Functions

template<class T>
static T * fromObject (Object::Ptr object)

Protected Member Functions

 ScriptContainer (const QString &name=QString::null)

Protected Attributes

ArgumentList m_arglist

Friends

class Manager

Constructor & Destructor Documentation

ScriptContainer::ScriptContainer (  const QString &  name = QString::null  )  [explicit, protected]
 

Constructor.

The constructor is protected cause only with the ScriptManager it's possible to access ScriptContainer instances.

Parameters:
name The unique name this ScriptContainer has. It's used e.g. at the Manager to identify the ScriptContainer.

Definition at line 84 of file scriptcontainer.cpp.

References Kross::Api::ScriptContainerPrivate::name, and Kross::Api::ScriptContainerPrivate::script.

00085     : MainModule(name)
00086     , d( new ScriptContainerPrivate() ) // initialize d-pointer class
00087 {
00088     kdDebug() << QString("ScriptContainer::ScriptContainer() Ctor name='%1'").arg(name) << endl;
00089 
00090     d->script = 0;
00091     d->name = name;
00092 }

ScriptContainer::~ScriptContainer (   )  [virtual]
 

Destructor.

Definition at line 94 of file scriptcontainer.cpp.

References finalize(), and Kross::Api::ScriptContainerPrivate::name.

00095 {
00096     kdDebug() << QString("ScriptContainer::~ScriptContainer() Dtor name='%1'").arg(d->name) << endl;
00097 
00098     finalize();
00099     delete d;
00100 }

Member Function Documentation

bool Object::addChild (  Object::Ptr  object,
const QString &  name = QString::null
)  [inherited]
 

Add a new child. Replaces a possible already existing child with such a name.

Parameters:
name the name of the child
object The Object to add.
Returns:
true if the Object was added successfully else false.

Definition at line 79 of file object.cpp.

References QString::arg(), QString::isEmpty(), QString::isNull(), and QMap::replace().

Referenced by Kross::Api::MainModule::addKAction(), Kross::Api::MainModule::addQObject(), Kross::Api::MainModule::addSignal(), Kross::Api::MainModule::addSlot(), Kross::Api::QtObject::QtObject(), and TestPluginModule::TestPluginModule().

00080 {
00081     QString n = name.isNull() ? object->getName() : name;
00082 
00083 #ifdef KROSS_API_OBJECT_ADDCHILD_DEBUG
00084     kdDebug() << QString("Kross::Api::Object::addChild() object.name='%2' object.classname='%3'")
00085         .arg(n).arg(object->getClassName()) << endl;
00086 #endif
00087 
00088     if(n.isEmpty()) // prevent invalid items.
00089         return false; //throw Exception::Ptr( new Exception( QString("Failed to add child object to object '%1'. Invalid name for class '%2'.").arg(getName()).arg(object->getClassName()) ) );
00090 
00091     object->m_parent = this;
00092     m_children.replace(n, object);
00093     return true;
00094 }

void Kross::Api::Event< Module >::addFunction (  const QString &  name,
Function *  function
)  [inline, inherited]
 

Add a methodfunction to the list of functions this Object supports.

Parameters:
name The functionname. Each function this object holds should have an unique name to be still accessable.
function A Function instance which defines the methodfunction. This Event will be the owner of the Function instance and will take care of deleting it if this Event got deleted.
arglist A list of arguments for the function.

Definition at line 119 of file event.h.

00120             {
00121                 m_functions.replace(name, function);
00122             }

void Kross::Api::Event< Module >::addFunction (  const QString &  name,
FunctionPtr  function,
const ArgumentList &  = ArgumentList()
)  [inline, inherited]
 

Add a Callable methodfunction to the list of functions this Object supports.

The FunctionPtr points to the concret Object::Ptr myfuncname(List::Ptr) method in the class defined with template T.

Parameters:
name The functionname. Each function this object holds should have an unique name to be still accessable.
function A pointer to the methodfunction that should handle calls.
arglist A list of arguments for the function.

Definition at line 101 of file event.h.

00102             {
00103                 m_functions.replace(name, new VarFunction0<T>(static_cast<T*>(this), function));
00104             }

EventAction::Ptr MainModule::addKAction (  KAction *  action,
const QString &  name = QString::null
)  [inherited]
 

Add a KAction to the eventcollection. The KAction will be wrapped by a EventAction and will be added to this collection.

Parameters:
name name to identify the action by
action the KAction instance that should be added to this MainModule
Returns:
the newly added EventAction instance which is now a child of this MainModule
Todo:
check name dox.

Definition at line 110 of file mainmodule.cpp.

References Kross::Api::Object::addChild().

00111 {
00112     EventAction* event = new EventAction(name, this, action);
00113     if(! addChild(event)) {
00114         kdWarning() << QString("Failed to add KAction name='%1'").arg(action->name()) << endl;
00115         delete event;
00116         return 0;
00117     }
00118     return event;
00119 }

void Kross::Api::Event< Module >::addProxyFunction (  const QString &  name,
INSTANCE *  instance,
METHOD  method
)  [inline, inherited]
 

Template function to add a Kross::Api::ProxyFunction as builtin-function to this Event instance.

Definition at line 129 of file event.h.

00130             {
00131                 m_functions.replace(name,
00132                     new Kross::Api::ProxyFunction <
00133                         INSTANCE, METHOD,
00134                         RET, ARG1, ARG2, ARG3, ARG4
00135                     > ( instance, method ) );
00136             }

QtObject::Ptr MainModule::addQObject (  QObject *  object,
const QString &  name = QString::null
)  [inherited]
 

Add a QObject to the eventcollection. All signals and slots the QObject has will be added to a new EventCollection instance which is child of this EventCollection instance.

Parameters:
object the QObject instance that should be added to this MainModule
name the name under which this QObject instance should be registered as
Returns:
the newly added QtObject instance which is now a child of this MainModule

Definition at line 99 of file mainmodule.cpp.

References Kross::Api::Object::addChild(), and QObject::name().

00100 {
00101     QtObject* qtobject = new QtObject(this, object, name);
00102     if(! addChild(qtobject)) {
00103         kdWarning() << QString("Failed to add QObject name='%1'").arg(object->name()) << endl;
00104         delete qtobject;
00105         return 0;
00106     }
00107     return qtobject;
00108 }

EventSignal::Ptr MainModule::addSignal (  const QString &  name,
QObject *  sender,
QCString  signal
)  [inherited]
 

Add a Qt signal to the Module by creating an EventSignal for it.

Parameters:
name the name the EventSignal is reachable as
sender the QObject instance which is the sender of the signal
signal the Qt signal macro the sender emits to call the EventSignal
Returns:
the newly added EventSignal instance which is now a child of this MainModule

Definition at line 78 of file mainmodule.cpp.

References Kross::Api::Object::addChild().

00079 {
00080     EventSignal* event = new EventSignal(name, this, sender, signal);
00081     if(! addChild(event)) {
00082         kdWarning() << QString("Failed to add signal name='%1' signature='%2'").arg(name).arg(signal) << endl;
00083         return 0;
00084     }
00085     return event;
00086 }

EventSlot::Ptr MainModule::addSlot (  const QString &  name,
QObject *  receiver,
QCString  slot
)  [inherited]
 

Add a Qt slot to the Module by creating an EventSlot for it.

Parameters:
name the name the EventSlot is reachable as
receiver the QObject instance which is the receiver of the signal
slot the Qt slot macro of the receiver to invoke if the EventSlot got called.
Returns:
the newly added EventSlot instance which is now a child of this MainModule

Definition at line 88 of file mainmodule.cpp.

References Kross::Api::Object::addChild().

00089 {
00090     EventSlot* event = new EventSlot(name, this, receiver, slot);
00091     if(! addChild(event)) {
00092         kdWarning() << QString("Failed to add slot name='%1' signature='%2'").arg(name).arg(slot) << endl;
00093         delete event;
00094         return 0;
00095     }
00096     return event;
00097 }

virtual Object::Ptr Kross::Api::Object::call (  const QString &  name,
KSharedPtr< List >  arguments
)  [virtual, inherited]
 

Pass a call to the object and evaluated it recursive down the object-hierachy. Objects like Class are able to handle call's by just implementing this function. If the call is done the called() method will be executed recursive from bottom up the call hierachy.

Exceptions:
TypeException if the object or the name is not callable.
Parameters:
name Each call has a name that says what should be called. In the case of a Class the name is the functionname.
arguments The list of arguments passed to the call.
Returns:
The call-result as Object::Ptr instance or NULL if the call has no result.

Reimplemented in Kross::Api::EventScript, Kross::Api::EventSignal, and Kross::Api::EventSlot.

Referenced by Kross::Api::Callable::call(), and Kross::Api::Callable::callChild().

virtual Object::Ptr Kross::Api::Event< Module >::call (  const QString &  name,
List::Ptr  arguments
)  [inline, virtual, inherited]
 

Overloaded method to handle function-calls.

Exceptions:
AttributeException if argumentparameters arn't valid.
RuntimeException if the functionname isn't valid.
Parameters:
name The functionname. Each function this Object holds should have a different name cause they are access by they name. If name is QString::null or empty, a self-reference to this instance is returned.
arguments The list of arguments.
Returns:
An Object representing the call result or NULL if there doesn't exists such a function with defined name.

Reimplemented from Kross::Api::Callable.

Definition at line 210 of file event.h.

00211             {
00212 #ifdef KROSS_API_EVENT_CALL_DEBUG
00213                 kdDebug() << QString("Event::call() name='%1' getName()='%2'").arg(name).arg(getName()) << endl;
00214 #endif
00215 
00216                 Function* function = m_functions[name];
00217                 if(function) {
00218 #ifdef KROSS_API_EVENT_CALL_DEBUG
00219                     kdDebug() << QString("Event::call() name='%1' is a builtin function.").arg(name) << endl;
00220 #endif
00221 
00222                     //FIXME checkArguments(arguments);
00223                     return function->call(arguments);
00224                 }
00225 
00226                 if(name.isNull()) {
00227                     // If no name is defined, we return a reference to our instance.
00228                     return this;
00229                 }
00230 
00231                 // Redirect the call to the Kross::Api::Callable we are inheritated from.
00232                 return Callable::call(name, arguments);
00233             }

Object::Ptr Callable::callChild (  List::Ptr  args  )  [inherited]
 

Wrapper for the Kross::Api::Object::call() method to call a children.

Definition at line 172 of file callable.cpp.

References Kross::Api::Object::call(), and Kross::Api::Variant::toString().

Referenced by Kross::Api::Callable::call().

00173 {
00174     //kdDebug() << QString("Kross::Api::Callable::callChild() getName()=%1").arg(getName()) << endl;
00175     return Object::call(Variant::toString(args->item(0)), args);
00176 }

KSharedPtr<Object> Kross::Api::ScriptContainer::callFunction (  const QString &  functionname,
KSharedPtr< List >  arguments = 0
) 
 

Call a function in the script container.

Parameters:
functionname The name of the function to call.
arguments Optional list of arguments passed to the function.
Returns:
Object instance representing the functioncall returnvalue.

Object::Ptr ScriptContainer::classInstance (  const QString &  classname  ) 
 

Create and return a new class instance.

Definition at line 222 of file scriptcontainer.cpp.

References Kross::Api::Script::classInstance(), finalize(), Kross::Api::Script::getException(), Kross::Api::Script::hadException(), Kross::Api::MainModule::hadException(), initialize(), Kross::Api::ScriptContainerPrivate::script, and Kross::Api::MainModule::setException().

00223 {
00224     if(! d->script)
00225         if(! initialize())
00226             return 0;
00227 
00228     if(hadException())
00229         return 0;
00230 
00231     Object::Ptr r = d->script->classInstance(classname);
00232     if(d->script->hadException()) {
00233         setException( d->script->getException() );
00234         finalize();
00235         return 0;
00236     }
00237     return r;
00238 }

Object::Ptr ScriptContainer::execute (   ) 
 

Execute the script container.

Definition at line 170 of file scriptcontainer.cpp.

References Kross::Api::Script::execute(), finalize(), Kross::Api::Script::getException(), Kross::Api::Script::hadException(), Kross::Api::MainModule::hadException(), initialize(), Kross::Api::ScriptContainerPrivate::script, and Kross::Api::MainModule::setException().

Referenced by Kross::Api::ScriptAction::activate().

00171 {
00172     if(! d->script)
00173         if(! initialize())
00174             return 0;
00175 
00176     if(hadException())
00177         return 0;
00178 
00179     Object::Ptr r = d->script->execute();
00180     if(d->script->hadException()) {
00181         setException( d->script->getException() );
00182         finalize();
00183         return 0;
00184     }
00185     return r;
00186 }

void ScriptContainer::finalize (   ) 
 

Finalize the Script instance and free's any cached or still running executions. Normaly it's not needed to call this function direct cause the ScriptContainer will take care of calling it if needed.

Reimplemented in Kross::Api::ScriptAction.

Definition at line 285 of file scriptcontainer.cpp.

References Kross::Api::ScriptContainerPrivate::script.

Referenced by classInstance(), execute(), Kross::Api::ScriptAction::finalize(), initialize(), setCode(), setFile(), setInterpreterName(), and ~ScriptContainer().

00286 {
00287     delete d->script;
00288     d->script = 0;
00289 }

template<class T>
static T* Kross::Api::Object::fromObject (  Object::Ptr  object  )  [inline, static, inherited]
 

Try to convert the Object instance to the template class T.

Exceptions:
TypeException if the cast failed.
Parameters:
object The Object to cast.
Returns:
The to a instance from template type T casted Object.

Definition at line 198 of file object.h.

00199             {
00200                 T* t = (T*) object.data();
00201                 if(! t)
00202                     throw KSharedPtr<Exception>( new Exception(QString("Object \"%1\" invalid.").arg(object ? object->getClassName() : "")) );
00203                 return t;
00204             }

virtual Kross::Api::Object::Ptr Kross::Api::Module::get (  const QString &  ,
void *  = 0
)  [inline, virtual, inherited]
 

Method to load from Kross::Api::Object inherited classes this module implements from within other modules.

Reimplemented in TestPluginModule.

Definition at line 70 of file module.h.

00071             {
00072                 return 0;
00073             }

virtual QStringList Kross::Api::Object::getCalls (   )  [inline, virtual, inherited]
 

Return a list of supported callable objects.

Returns:
List of supported calls.

Reimplemented in Kross::Python::PythonObject.

Definition at line 186 of file object.h.

00186 { return QStringList(); }

Object::Ptr Object::getChild (  const QString &  name  )  const [inherited]
 

Return the defined child or NULL if there is no such object with that name avaible.

Parameters:
name The name of the Object to return.
Returns:
The Object matching to the defined name or NULL if there is no such Object.

Definition at line 69 of file object.cpp.

Referenced by Kross::Api::Callable::getChild().

00070 {
00071     return m_children[name];
00072 }

Object::Ptr Callable::getChild (  List::Ptr  args  )  [inherited]
 

Wrapper for the Kross::Api::Object::getChild() method to return a children this object has.

Definition at line 146 of file callable.cpp.

References Kross::Api::Object::getChild(), Kross::Api::Object::getName(), and Kross::Api::Variant::toString().

Referenced by Kross::Api::Callable::call().

00147 {
00148     QString s = Variant::toString(args->item(0));
00149     //kdDebug() << QString("Kross::Api::Callable::getChild() getName()=%1 childName=%2").arg(getName()).arg(s) << endl;
00150     Object::Ptr obj = Object::getChild(s);
00151     if(! obj)
00152         throw Exception::Ptr( new Exception(QString("The object '%1' has no child object '%2'").arg(getName()).arg(s)) );
00153     return obj;
00154 }

QMap< QString, Object::Ptr > Object::getChildren (   )  const [inherited]
 

Return all children.

Returns:
A ObjectMap of children this Object has.

Definition at line 74 of file object.cpp.

Referenced by Kross::Api::Callable::getChildrenDict(), and Kross::Api::Callable::getChildrenList().

00075 {
00076     return m_children;
00077 }

Object::Ptr Callable::getChildrenDict (  List::Ptr  args  )  [inherited]
 

Wrapper for the Kross::Api::Object::getChild() method to return a dictonary of children this object has.

Returns:
a Dict filled with the children.

Definition at line 166 of file callable.cpp.

References Kross::Api::Object::getChildren().

Referenced by Kross::Api::Callable::call().

00167 {
00168     //kdDebug()<<"Kross::Api::Callable::getChildrenDict()"<<endl;
00169     return new Dict(Object::getChildren(), "Kross::Api::Callable::getChildrenDict::Dict");
00170 }

Object::Ptr Callable::getChildrenList (  List::Ptr  args  )  [inherited]
 

Wrapper for the Kross::Api::Object::getChildren() method to return a list of childrennames this object has.

Returns:
a List filled with a list of names of the children this object has.

Definition at line 156 of file callable.cpp.

References QMap::begin(), QMap::end(), and Kross::Api::Object::getChildren().

Referenced by Kross::Api::Callable::call().

00157 {
00158     QStringList list;
00159     QMap<QString, Object::Ptr> children = getChildren();
00160     QMap<QString, Object::Ptr>::Iterator it( children.begin() );
00161     for(; it != children.end(); ++it)
00162         list.append( it.key() );
00163     return new Variant(list);
00164 }

const QString MainModule::getClassName (   )  const [virtual, inherited]
 

See also:
Kross::Api::Object::getClassName()

Reimplemented from Kross::Api::Callable.

Definition at line 53 of file mainmodule.cpp.

00054 {
00055     return "Kross::Api::MainModule";
00056 }

const QStringList ScriptContainer::getClassNames (   ) 
 

Return a list of classes.

Definition at line 217 of file scriptcontainer.cpp.

References Kross::Api::Script::getClassNames(), and Kross::Api::ScriptContainerPrivate::script.

00218 {
00219     return d->script ? d->script->getClassNames() : QStringList(); //FIXME init before if needed?
00220 }

const QString & ScriptContainer::getCode (   )  const
 

Return the scriptcode this ScriptContainer holds.

Definition at line 112 of file scriptcontainer.cpp.

References Kross::Api::ScriptContainerPrivate::code.

00113 {
00114     return d->code;
00115 }

Exception::Ptr MainModule::getException (   )  [inherited]
 

Returns:
the Exception this module throwed.

Definition at line 63 of file mainmodule.cpp.

References Kross::Api::MainModulePrivate::exception.

Referenced by Kross::Api::ScriptAction::activate().

00064 {
00065     return d->exception;
00066 }

const QString & ScriptContainer::getFile (   )  const
 

Returns:
the filename which will be executed on execute.

Definition at line 134 of file scriptcontainer.cpp.

References Kross::Api::ScriptContainerPrivate::scriptfile.

00135 {
00136     return d->scriptfile;
00137 }

const QStringList ScriptContainer::getFunctionNames (   ) 
 

Return a list of functionnames the with setCode defined scriptcode spends.

Definition at line 188 of file scriptcontainer.cpp.

References Kross::Api::Script::getFunctionNames(), and Kross::Api::ScriptContainerPrivate::script.

00189 {
00190     return d->script ? d->script->getFunctionNames() : QStringList(); //FIXME init before if needed?
00191 }

const QString & ScriptContainer::getInterpreterName (   )  const
 

Returns:
the name of the interpreter used on execute.

Definition at line 123 of file scriptcontainer.cpp.

References Kross::Api::ScriptContainerPrivate::interpretername.

00124 {
00125     r