Kross::Api::Exception Class Reference

#include <exception.h>

Inheritance diagram for Kross::Api::Exception:

[legend]Collaboration diagram for Kross::Api::Exception:

[legend]List of all members.

---

Detailed Description

Common exception class used for representing exceptions in Kross.

Internal we use Exception instances to throw and handle exceptions. Those exceptions are inherited from Object and therefore they are first class citizens in Kross.

Definition at line 38 of file exception.h.

Public Types
typedef KSharedPtr< Exception >	Ptr
Public Member Functions
	Exception (const QString &error, long lineno=-1, Object::Ptr parent=0)
virtual	~Exception ()
virtual const QString	getClassName () const
virtual const QString	toString ()
const QString &	getError () const
const QString &	getTrace () const
void	setTrace (const QString &tracemessage)
long	getLineNo () const
const QString &	getName () const
Object::Ptr	getParent () const
bool	hasChild (const QString &name) const
Object::Ptr	getChild (const QString &name) 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 Object::Ptr	call (const QString &name, KSharedPtr< List > arguments)
virtual QStringList	getCalls ()
Static Public Member Functions
template<class T>
static T *	fromObject (Object::Ptr object)

---

Member Typedef Documentation

typedef KSharedPtr<Exception> Kross::Api::Exception::Ptr

Shared pointer to implement reference-counting. Reimplemented from Kross::Api::Object. Definition at line 56 of file exception.h.

---

Constructor & Destructor Documentation

Exception::Exception (  const QString &  error, long  lineno = -1, Object::Ptr  parent = 0 )

Constructor. Parameters: error  The error message. lineno  The liner number in the scripting code where this exception got thrown. parent  The parent Object or NULL if this exception object doesn't has a parent. Definition at line 28 of file exception.cpp. : Object("Exception", parent) , m_error(error) , m_lineno(lineno) { kdWarning() << QString("Kross::Api::Exception error='%1' lineno='%3'").arg(m_error).arg(m_lineno) << endl; }

Exception::~Exception (   )  [virtual]

Destructor. Definition at line 36 of file exception.cpp. { }

---

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(). { QString n = name.isNull() ? object->getName() : name; #ifdef KROSS_API_OBJECT_ADDCHILD_DEBUG kdDebug() << QString("Kross::Api::Object::addChild() object.name='%2' object.classname='%3'") .arg(n).arg(object->getClassName()) << endl; #endif if(n.isEmpty()) // prevent invalid items. 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()) ) ); object->m_parent = this; m_children.replace(n, object); return true; }

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().

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. { T* t = (T*) object.data(); if(! t) throw KSharedPtr<Exception>( new Exception(QString("Object \"%1\" invalid.").arg(object ? object->getClassName() : "")) ); return t; }

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. { 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(). { return m_children[name]; }

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(). { return m_children; }

const QString Exception::getClassName (   )  const [virtual]

See also: Kross::Api::Object::getClassName() Implements Kross::Api::Object. Definition at line 40 of file exception.cpp. { return "Kross::Api::Exception"; }

const QString & Exception::getError (   )  const

Returns: the error message. Definition at line 52 of file exception.cpp. { return m_error; }

long Exception::getLineNo (   )  const

Returns: the line number in the scripting code where the exception got thrown or -1 if there was no line number defined. Definition at line 67 of file exception.cpp. { return m_lineno; }

const QString & Object::getName (   )  const [inherited]

Return the name this object has. Returns: Name of this object. Reimplemented in Kross::Api::ScriptContainer. Definition at line 49 of file object.cpp. Referenced by Kross::Api::Event< QtObject >::call(), Kross::Api::Callable::call(), Kross::Api::Callable::getChild(), and Kross::Api::Module::~Module(). { return m_name; }

Object::Ptr Object::getParent (   )  const [inherited]

Return the parent object or NULL if this object doesn't has a parent. Returns: The parent-Object or NULL if this Object doesn't has a parent. Definition at line 59 of file object.cpp. { return m_parent; }

const QString & Exception::getTrace (   )  const

Returns: a more detailed tracemessage or QString::null if there is no trace avaiable. Definition at line 57 of file exception.cpp. { return m_trace; }

bool Object::hasChild (  const QString &  name  )  const [inherited]

Returns if the defined child is avaible. Returns: true if child exists else false. Reimplemented in Kross::Api::MainModule. Definition at line 64 of file object.cpp. References QMap::contains(). Referenced by Kross::Api::MainModule::hasChild(), and Kross::Api::Callable::hasChild(). { return m_children.contains(name); }

void Object::removeAllChildren (   )  [inherited]

Remove all children. Definition at line 104 of file object.cpp. References QMap::clear(). { #ifdef KROSS_API_OBJECT_REMCHILD_DEBUG kdDebug() << "Kross::Api::Object::removeAllChildren()" << endl; #endif m_children.clear(); }

void Object::removeChild (  const QString &  name  )  [inherited]

Remove an existing child. Parameters: name  The name of the Object to remove. If there doesn't exists an Object with such name just nothing will be done. Definition at line 96 of file object.cpp. References QMap::remove(). { #ifdef KROSS_API_OBJECT_REMCHILD_DEBUG kdDebug() << QString("Kross::Api::Object::removeChild() name='%1'").arg(name) << endl; #endif m_children.remove(name); }

void Exception::setTrace (  const QString &  tracemessage  )

Set a more detailed tracemessage. Definition at line 62 of file exception.cpp. { m_trace = tracemessage; }

const QString Exception::toString (   )  [virtual]

See also: Kross::Api::Object::toString() Reimplemented from Kross::Api::Object. Definition at line 45 of file exception.cpp. References QString::arg(). { return (m_lineno != -1) ? QString("Exception at line %1: %2").arg(m_lineno).arg(m_error) : QString("Exception: %1").arg(m_error); }

---

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

• exception.h
• exception.cpp

---