Kross::Ruby::RubyScript Class Reference

#include <rubyscript.h>

Inheritance diagram for Kross::Ruby::RubyScript:

[legend]Collaboration diagram for Kross::Ruby::RubyScript:

[legend]List of all members.

---

Detailed Description

Handle ruby scripts. This class implements Kross::Api::Script for ruby.

Author:

Cyrille Berger

Definition at line 36 of file rubyscript.h.

Public Member Functions
	RubyScript (Kross::Api::Interpreter *interpreter, Kross::Api::ScriptContainer *scriptcontainer)
	~RubyScript ()
virtual const QStringList &	getFunctionNames ()
virtual Kross::Api::Object::Ptr	execute ()
virtual Kross::Api::Object::Ptr	callFunction (const QString &name, Kross::Api::List::Ptr args)
virtual const QStringList &	getClassNames ()
virtual Kross::Api::Object::Ptr	classInstance (const QString &name)
bool	hadException ()
Exception::Ptr	getException ()
void	setException (Exception::Ptr e)
void	clearException ()
Protected Attributes
Interpreter *const	m_interpreter
	The Interpreter used to create this Script instance.
ScriptContainer *const	m_scriptcontainer
	The ScriptContainer associated with this Script.

---

Constructor & Destructor Documentation

Kross::Ruby::RubyScript::RubyScript (  Kross::Api::Interpreter *  interpreter, Kross::Api::ScriptContainer *  scriptcontainer )

Constructor. Parameters: interpreter  The RubyInterpreter instance used to create this script. scriptcontainer  The Kross::Api::ScriptContainer instance this RubyScript does handle the backend-work for. Definition at line 50 of file rubyscript.cpp. : Kross::Api::Script(interpreter, scriptcontainer), d(new RubyScriptPrivate()) { }

Kross::Ruby::RubyScript::~RubyScript (   )

Destructor. Definition at line 56 of file rubyscript.cpp. { }

---

Member Function Documentation

Kross::Api::Object::Ptr Kross::Ruby::RubyScript::callFunction (  const QString &  name, Kross::Api::List::Ptr  args )  [virtual]

Call a function. Implements Kross::Api::Script. Definition at line 139 of file rubyscript.cpp. References Kross::Ruby::RubyScriptPrivate::m_compile. { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "RubyScript::callFunction()" << endl; #endif if(d->m_compile == 0) { compile(); } selectScript(); unselectScript(); return 0; }

Kross::Api::Object::Ptr Kross::Ruby::RubyScript::classInstance (  const QString &  name  )  [virtual]

Create and return a new class instance. Implements Kross::Api::Script. Definition at line 165 of file rubyscript.cpp. References Kross::Ruby::RubyScriptPrivate::m_compile. { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "RubyScript::classInstance()" << endl; #endif if(d->m_compile == 0) { compile(); } selectScript(); unselectScript(); return 0; }

void Script::clearException (   )  [inherited]

Clear previous exceptions. If called hadException() will return false again. Definition at line 55 of file script.cpp. { m_exception = 0; }

Kross::Api::Object::Ptr Kross::Ruby::RubyScript::execute (   )  [virtual]

Execute the script. Implements Kross::Api::Script. Definition at line 109 of file rubyscript.cpp. References Kross::Ruby::RubyScriptPrivate::m_compile, and Kross::Api::Script::setException(). { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "RubyScript::execute()" << endl; #endif if(d->m_compile == 0) { compile(); } #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "Start execution" << endl; #endif selectScript(); int result = ruby_exec(); if (result != 0) { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "Execution has failed" << endl; #endif setException( new Kross::Api::Exception(QString("Failed to execute ruby code: %1").arg(STR2CSTR( rb_obj_as_string(ruby_errinfo) )), 0) ); // TODO: get the error d->m_compile = 0; } unselectScript(); #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "Execution is finished" << endl; #endif return 0; }

const QStringList & Kross::Ruby::RubyScript::getClassNames (   )  [virtual]

Return a list of class types this script supports. Implements Kross::Api::Script. Definition at line 153 of file rubyscript.cpp. References Kross::Ruby::RubyScriptPrivate::m_classes, and Kross::Ruby::RubyScriptPrivate::m_compile. { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "RubyScript::getClassNames()" << endl; #endif if(d->m_compile == 0) { compile(); } return d->m_classes; }

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

Returns: the Exception the script throwed. Definition at line 45 of file script.cpp. Referenced by Kross::Api::ScriptContainer::classInstance(), and Kross::Api::ScriptContainer::execute(). { return m_exception; }

const QStringList & Kross::Ruby::RubyScript::getFunctionNames (   )  [virtual]

Return a list of callable functionnames this script spends. Implements Kross::Api::Script. Definition at line 97 of file rubyscript.cpp. References Kross::Ruby::RubyScriptPrivate::m_compile, and Kross::Ruby::RubyScriptPrivate::m_functions. { #ifdef KROSS_RUBY_SCRIPT_DEBUG kdDebug() << "RubyScript::getFunctionNames()" << endl; #endif if(d->m_compile == 0) { compile(); } return d->m_functions; }

bool Script::hadException (   )  [inherited]

Returns: true if the script throwed an exception else false. Definition at line 40 of file script.cpp. Referenced by Kross::Python::PythonScript::callFunction(), Kross::Api::ScriptContainer::classInstance(), Kross::Python::PythonScript::classInstance(), and Kross::Api::ScriptContainer::execute(). { return m_exception != 0; }

void Script::setException (  Exception::Ptr  e  )  [inherited]

Set a new exception this script throwed. Parameters: e  The Exception . Definition at line 50 of file script.cpp. Referenced by Kross::Python::PythonScript::callFunction(), Kross::Python::PythonScript::classInstance(), and execute(). { m_exception = e; }

---

The documentation for this class was generated from the following files:

• rubyscript.h
• rubyscript.cpp

---