tDecoratableManagerBase Class Reference

base class for managers of decorated classes More...

#include <tDecorator.h>

Inheritance diagram for tDecoratableManagerBase:

[legend]

Collaboration diagram for tDecoratableManagerBase:

[legend]

List of all members.

Public Member Functions
	tDecoratableManagerBase ()
size_t	GetSize () const
	returns the total allocated size of decorations
size_t	Reserve (size_t allocate, size_t alignment=4)
	allocates some byes of decorator space, returns the offset to it
void	AddDecorator (tDecoratorBase &decorator)
void	CalculateOffsets ()
void	ConstructAll (void *decorated)
void	DestructAll (void *decorated)
void *	Allocate (size_t size, const char *classn, const char *file, int line)
	reserve space for an object of class Decorated, prepended with space for its decorators
void	Free (void *ptr, const char *classn, const char *file, int line)
	frees space reserved by Reseve() again
Protected Attributes
tDecoratableManagerBase *	base_
size_t	refCount_
	manager of the base class
Private Member Functions
	tDecoratableManagerBase (tDecoratableManagerBase const &)
	number of objects of this
tDecoratableManagerBase &	operator= (tDecoratableManagerBase const &)
Private Attributes
tDecoratorBase *	decorators_
bool	updateRequired_
	anchor of the decorators managed by this managers
size_t	offset_
	flag indicating whether the following information needs an update

---

Detailed Description

base class for managers of decorated classes

Definition at line 80 of file tDecorator.h.

---

Constructor & Destructor Documentation

tDecoratableManagerBase::tDecoratableManagerBase

(

)

[inline]

Definition at line 83 of file tDecorator.h.

            : base_( 0 ), refCount_( 0 ), decorators_( 0 )
            , updateRequired_( true ), offset_( 0 )
    {
    }

tDecoratableManagerBase::tDecoratableManagerBase

(

tDecoratableManagerBase const &

)

[private]

number of objects of this

---

Member Function Documentation

size_t tDecoratableManagerBase::GetSize

(

)

const [inline]

returns the total allocated size of decorations

Definition at line 90 of file tDecorator.h.

References tASSERT.

Referenced by Allocate(), and Free().

    {
        tASSERT( !updateRequired_ );

        return offset_;
    }

Here is the caller graph for this function:

size_t tDecoratableManagerBase::Reserve	(	size_t	allocate,
		size_t	alignment = 4
	)			[inline]

allocates some byes of decorator space, returns the offset to it

Definition at line 98 of file tDecorator.h.

    {
        offset_ += allocate;
        offset_ = (( offset_ + alignment - 1 ) / alignment ) * alignment;
        return offset_;
    }

void tDecoratableManagerBase::AddDecorator

(

tDecoratorBase &

decorator

)

[inline]

Definition at line 105 of file tDecorator.h.

References tListItem< T >::Insert(), and tASSERT.

Referenced by tDecorator< DecoratedDerived, Decoration >::tDecorator().

    {
        tASSERT( refCount_ == 0 );

        // add decorator to list and request
        decorator.Insert( decorators_ );
        updateRequired_ = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void tDecoratableManagerBase::CalculateOffsets

(

)

[inline]

Definition at line 114 of file tDecorator.h.

References tDecoratorBase::GetSize(), tListItem< T >::Next(), and tDecoratorBase::offset_.

Referenced by Allocate().

    {
        // early exit if there is nothing to od
        if ( !updateRequired_ )
            return;

        // get start offset from base class
        offset_ = 0;
        if ( base_ )
        {
            base_->CalculateOffsets();
            offset_ = base_->offset_;
        }

        // iterate over listed decorators
        tDecoratorBase * run = decorators_;
        while ( run )
        {
            run->offset_ = Reserve( run->GetSize() );
            run = run->Next();
        }

        updateRequired_ = false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void tDecoratableManagerBase::ConstructAll

(

void *

decorated

)

[inline]

Definition at line 139 of file tDecorator.h.

References tDecoratorBase::Construct(), tListItem< T >::Next(), and tDecoratorBase::offset_.

Referenced by Allocate().

    {
        if ( base_ )
        {
            base_->ConstructAll( decorated );
        }

        // iterate over listed decorators
        tDecoratorBase * run = decorators_;
        while ( run )
        {
            void * decoration = static_cast< char * >( decorated ) - run->offset_;
            run->Construct( decoration );
            run = run->Next();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void tDecoratableManagerBase::DestructAll

(

void *

decorated

)

[inline]

Definition at line 156 of file tDecorator.h.

References tDecoratorBase::Destruct(), tListItem< T >::Next(), and tDecoratorBase::offset_.

Referenced by Free().

    {
        if ( base_ )
        {
            base_->DestructAll( decorated );
        }

        // iterate over listed decorators
        tDecoratorBase * run = decorators_;
        while ( run )
        {
            void * decoration = static_cast< char * >( decorated ) - run->offset_;
            run->Destruct( decoration );
            run = run->Next();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void * tDecoratableManagerBase::Allocate	(	size_t	size,
		const char *	classn,
		const char *	file,
		int	line
	)

reserve space for an object of class Decorated, prepended with space for its decorators

Parameters:

	size	size of the memory block to allocate
	classn	name of the class that is allocated
	file	name of the file this call comes from
	line	line in the file the call ocmes from

Returns:

the newly allocated block of memory, with space for decorators

calculate offsets of decorators if required

Reimplemented in tDecoratableManager< Decorated >.

Definition at line 45 of file tDecorator.cpp.

References CalculateOffsets(), ConstructAll(), GetSize(), and refCount_.

Referenced by tDecoratableManager< Decorated >::Allocate().

{
    // register object with manager
    if ( refCount_++ == 0 )
    {
        CalculateOffsets();
    }

    // allocate requested space plus overhead for decorators
    size_t overhead = GetSize();
#ifndef DONTUSEMEMMANAGER

    char * base = static_cast< char * > ( ::operator new( size + overhead, classn, file, line ) ) + overhead;
#else
    char * base = static_cast< char * > ( ::operator new( size + overhead ) ) + overhead;
#endif

    // call decoration constructors
    ConstructAll( base);

    return base;

Here is the call graph for this function:

Here is the caller graph for this function:

void tDecoratableManagerBase::Free	(	void *	ptr,
		const char *	classn,
		const char *	file,
		int	line
	)

frees space reserved by Reseve() again

Parameters:

	ptr	pointer to the memory area to be freed
	classn	name of the class that is allocated
	file	name of the file this call comes from
	line	line in the file the call ocmes from

Reimplemented in tDecoratableManager< Decorated >.

Definition at line 81 of file tDecorator.cpp.

References DestructAll(), GetSize(), and refCount_.

Referenced by tDecoratableManager< Decorated >::Free().

{
    // call decoration destructors
    DestructAll( ptr );

    // deregister with manager
    --refCount_;

    // deallocate space and overhead
    size_t overhead = GetSize();
    char * base = ( ( char * ) ptr ) - overhead;

#ifndef DONTUSEMEMMANAGER
    ::operator delete( base, classn, file, line );
#else
    ::operator delete( base );

Here is the call graph for this function:

Here is the caller graph for this function:

tDecoratableManagerBase& tDecoratableManagerBase::operator=

(

tDecoratableManagerBase const &

)

[private]

---

Member Data Documentation

tDecoratableManagerBase* tDecoratableManagerBase::base_ [protected]

Definition at line 179 of file tDecorator.h.

size_t tDecoratableManagerBase::refCount_ [protected]

manager of the base class

Definition at line 180 of file tDecorator.h.

Referenced by Allocate(), and Free().

tDecoratorBase* tDecoratableManagerBase::decorators_ [private]

Definition at line 185 of file tDecorator.h.

bool tDecoratableManagerBase::updateRequired_ [private]

anchor of the decorators managed by this managers

Definition at line 188 of file tDecorator.h.

size_t tDecoratableManagerBase::offset_ [private]

flag indicating whether the following information needs an update

Definition at line 189 of file tDecorator.h.

---

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

• src/tools/tDecorator.h
• src/tools/tDecorator.cpp

---