lout::identity::IdentifiableObject Class Reference

Instances of classes, which are sub classes of this class, may be identified at run-time. More...

#include <identity.hh>

Classes
class	Class

Public Member Functions
	IdentifiableObject ()
void	intoStringBuffer (misc::StringBuffer *sb)
	Store a textual representation of the object in a misc::StringBuffer.
int	getClassId ()
	Returns the class identifier.
const char *	getClassName ()
	Return the name, under which the class of this object was registered.
bool	instanceOf (int otherClassId)
	Returns, whether this class is an instance of the class, given by otherClassId, or of a sub class of this class.
Public Member Functions inherited from lout::object::Object
virtual	~Object ()
	The destructor is defined as virtual (but not abstract), so that destruction of Object's works properly.
virtual bool	equals (Object *other)
	Returns, whether two objects are equal.
virtual int	hashValue ()
	Return a hash value for the object.
virtual Object *	clone ()
	Return an exact copy of the object.
const char *	toString ()
	Use object::Object::intoStringBuffer to return a textual representation of the object.
virtual size_t	sizeOf ()
	Return the number of bytes, this object totally uses.

Protected Member Functions
void	registerName (const char *className, int *classId)
	This method must be called in the constructor for the sub class.

Private Attributes
int	classId

Static Private Attributes
static container::typed::HashTable< object::ConstString, Class > *	classesByName
static container::typed::Vector< Class > *	classesById
static Class *	currentlyConstructedClass

Detailed Description

Instances of classes, which are sub classes of this class, may be identified at run-time.

Testing the class

Since e.g. dw::Textblock is a sub class of IdentifiableObject, and implemented in the correct way (as described below), for any given IdentifiableObject the following test can be done:

identity::IdentifiableObject *o;
// ...
bool isATextblock = o->instanceOf(dw::Textblock::CLASS_ID);

isATextblock is true, when o is an instance of dw::Textblock, or of a sub class of dw::Textblock. Otherwise, isATextblock is false.

It is also possible to get the class identifier of an identity::IdentifiableObject, e.g.

bool isOnlyATextblock = o->getClassId() == dw::Textblock::CLASS_ID;

would result in true, if o is an instance of dw::Textblock, but not an instance of a sub class of dw::Textblock.

Defining Sub Classes

Each direct or indirect sub class of IdentifiableObject must

• add a static int CLASS_ID with -1 as initial value, and
• call registerName (name, &CLASS_ID) in the constructor, where name should be unique, e.g. the fully qualified class name.

After this, class::CLASS_ID refers to a number, which denotes the class. (If this is still -1, since the class has not yet been instantiated, any test will fail, which is correct.)

Notes on implementation

If there are some classes like this:

[legend]

and first, an instance of A, and then an instance of C is created, there will be the following calls of functions and constructors:

1. IdentifiableObject ();
2. registerName ("A", &A::CLASS_ID);
3. IdentifiableObject ();
4. registerName ("B", &B::CLASS_ID);
5. registerName ("C", &C::CLASS_ID);

From this, the class hierarchy above can easily constructed, and stored in identity::IdentifiableObject::classesByName and in identity::IdentifiableObject::classesById. See the code for details.

N.b. Multiple inheritance is not supported, the construction of the tree would become confused.

Definition at line 98 of file identity.hh.

Constructor & Destructor Documentation

IdentifiableObject()

lout::identity::IdentifiableObject::IdentifiableObject

(

)

Definition at line 65 of file identity.cc.

References currentlyConstructedClass.

Member Function Documentation

getClassId()

int lout::identity::IdentifiableObject::getClassId ( )

inline

Returns the class identifier.

This is rarely used, rather, tests with identity::IdentifiableObject::instanceOf are done.

Definition at line 134 of file identity.hh.

References classId.

getClassName()

const char * lout::identity::IdentifiableObject::getClassName ( )

inline

Return the name, under which the class of this object was registered.

Definition at line 140 of file identity.hh.

References classesById, and classId.

Referenced by dw::oof::OOFAwareWidget::getWidgetAtPointLevel(), dw::core::Content::intoStringBuffer(), dw::core::Iterator::intoStringBuffer(), and intoStringBuffer().

instanceOf()

bool lout::identity::IdentifiableObject::instanceOf

(

int

otherClassId

)

Returns, whether this class is an instance of the class, given by otherClassId, or of a sub class of this class.

Definition at line 105 of file identity.cc.

References classesById, and classId.

Referenced by dw::Textblock::addWidget(), dw::oof::OOFPosRelMgr::calcWidgetRefSize(), dw::Table::getCellRef(), dw::Textblock::getGeneratorWidth(), dw::Textblock::handOverBreak(), and dw::oof::OOFAwareWidget::isOOFContainer().

intoStringBuffer()

void lout::identity::IdentifiableObject::intoStringBuffer ( misc::StringBuffer *  sb )

virtual

Store a textual representation of the object in a misc::StringBuffer.

This is used by object::Object::toString.

Reimplemented from lout::object::Object.

Definition at line 70 of file identity.cc.

References lout::misc::StringBuffer::append(), lout::misc::StringBuffer::appendPointer(), and getClassName().

Referenced by dw::Textblock::TextblockIterator::highlight(), dw::oof::OOFAwareWidget::OOFAwareWidgetIterator::next(), dw::oof::OOFAwareWidget::OOFAwareWidgetIterator::prev(), and dw::Textblock::TextblockIterator::unhighlight().

registerName()

void lout::identity::IdentifiableObject::registerName ( const char *  className, int *  classId  )

protected

This method must be called in the constructor for the sub class.

See class comment for details.

Definition at line 83 of file identity.cc.

References classesById, classesByName, classId, currentlyConstructedClass, and lout::identity::IdentifiableObject::Class::id.

Referenced by dw::AlignedTableCell::AlignedTableCell(), dw::AlignedTextblock::AlignedTextblock(), dw::core::ui::Embed::Embed(), dw::ListItem::ListItem(), dw::oof::OOFAwareWidget::OOFAwareWidget(), dw::RegardingBorder::RegardingBorder(), dw::Ruler::Ruler(), dw::SimpleContainer::SimpleContainer(), dw::SimpleTableCell::SimpleTableCell(), dw::Table::Table(), dw::Textblock::Textblock(), and dw::core::Widget::Widget().

Member Data Documentation

classesById

Vector< IdentifiableObject::Class > * lout::identity::IdentifiableObject::classesById

staticprivate

Initial value:

=
   new Vector <IdentifiableObject::Class> (16, false)

Definition at line 115 of file identity.hh.

Referenced by getClassName(), instanceOf(), and registerName().

classesByName

HashTable< ConstString, IdentifiableObject::Class > * lout::identity::IdentifiableObject::classesByName

staticprivate

Initial value:

=
      new HashTable<ConstString, IdentifiableObject::Class> (true, true)

Definition at line 114 of file identity.hh.

Referenced by registerName().

classId

int lout::identity::IdentifiableObject::classId

private

Definition at line 118 of file identity.hh.

Referenced by getClassId(), getClassName(), instanceOf(), and registerName().

currentlyConstructedClass

IdentifiableObject::Class * lout::identity::IdentifiableObject::currentlyConstructedClass

staticprivate

Definition at line 116 of file identity.hh.

Referenced by IdentifiableObject(), and registerName().

---

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

• lout/identity.hh
• lout/identity.cc