A garbage collector manager. More...

#include <libsswf.h>

Inheritance diagram for sswf::MemoryManager:


Public Member Functions
void *	MemAlloc (size_t size, const char *info)
	Allocate a new buffer of memory.
void	MemAttach (MemBuffer ptr, size_t size, const char info)
	Attach a memory buffer to a manager.
void	MemClean (void *ptr)
	Free a memory buffer and clean the holding pointer.
void	MemFree (void *ptr)
	Free a memory buffer.
	MemoryManager (void)
	Initialize a memory manager object.
void *	MemRealloc (void ptr, size_t size, const char info)
	Allocate or re-allocate a memory buffer pointer.
unsigned long	Size (void *ptr)
	Return the current size of a buffer of memory.
char *	StrCat (const char s1, const char s2)
	Concatenate two strings using a managed buffer.
char *	StrDup (const char *string)
	Duplicate a string using a managed buffer.
virtual	~MemoryManager ()
	Delete all the memory buffers.
Private Attributes
Buffer *	f_head

Detailed Description

The MemoryManager class is used as a garbage collection for all the object derived from it. These objects will allocate memory buffers and attach them to the collection of buffers in their memory manager.

Then when the object is deleted, all the buffers are automatically deleted.

The sswf::MemoryManager uses the Buffer and sswf::MemBuffer classes to manage the buffers.

See also:: sswf::Buffer
sswf::MemBuffer

Constructor & Destructor Documentation

MemoryManager::MemoryManager ( void )

This constructor initialize the memory manager by clearing the head of the memory buffers.

References f_head.

MemoryManager::~MemoryManager ( ) [virtual]

The destructor goes through the list of memory buffers allocated by the memory manager functions and delete them all.

References f_head.

Member Function Documentation

void * MemoryManager::MemAlloc	(	size_t	size,
		const char *	info
	)

The memory manager allocates a new buffer and returns the pointer to the data of the buffer.

Note that the allocation of the sswf::Buffer object is hidden from view.

Parameters:

	size	Size of the memory block to allocate
	info	Information about the buffer (a static const string)

Returns:: A pointer to the newly allocated memory block

References sswf::Buffer::Data(), and f_head.

Referenced by sswf::TagText::AddText(), sswf::TagEditText::AddUsedString(), sswf::TagText::DefineText(), sswf::Data::GetString(), sswf::TagImage::LoadJPEG(), sswf::TagImage::LoadTGA(), sswf::TagSound::LoadWaveFile(), MemRealloc(), sswf::TagFrameLabel::ParseTag(), sswf::TagEditText::PreSave(), sswf::TagFont::PreSave2ndPass(), sswf::TagMetadata::Save(), sswf::TagImage::Save(), sswf::TagHeader::Save(), sswf::TagHeader::SaveEncodedString(), sswf::TagImage::SaveJPEG(), sswf::TagSound::SetData(), sswf::TagBinaryData::SetData(), sswf::TagSceneFrameData::SetFileData(), sswf::TagSceneFrameData::SetSceneFrameData(), sswf::TagEditText::SetUsedGlyphs(), StrCat(), and StrDup().

void MemoryManager::MemAttach	(	MemBuffer *	ptr,
		size_t	size,
		const char *	info
	)

This function takes the specified memory buffer under control.

This means it will delete the buffer whenever the object is deleted or when MemFree() is called.

Parameters:

	ptr	The pointer to take control over
	size	The size of the buffer pointed by ptr
	info	Information about the buffer (a static const string)

References f_head.

void MemoryManager::MemClean ( void * ptr )

This function is a convenience function which (1) calls MemFree() on the specified pointer and then clears the pointer.

This is particularly useful to not have to do the cleaning of the pointer yourself.

        char *buf;

        buf = MemAlloc(123);
        ...
        if(some flag) {
                MemClean(&buf);

                // is equivalent to:
                //  MemFree(buf);
                //  buf = 0;
        }
        ...
        if(buf != 0) {
                ...
        }

Note:: The compilers have a problem with a 'void **' type here. Thus I use 'void *' which can look a bit confusing. Sorry about that!

Parameters:

ptr

The pointer to the pointer to free

References sswf::assert(), and sswf::Buffer::FindBuffer().

Referenced by sswf::Data::GetString(), sswf::ActionFunction::ParseData(), sswf::TagProtect::ParseTag(), sswf::TagFrameLabel::ParseTag(), sswf::TagText::PreSave(), sswf::TagFont::PreSave2ndPass(), sswf::TagSceneFrameData::SetFileData(), sswf::TagImage::SetFilename(), sswf::TagImage::SetImage(), sswf::TagSceneFrameData::SetSceneFrameData(), and sswf::Vectors::SetSize().

void MemoryManager::MemFree ( void * ptr )

This function release the memory associated with the specified pointer.

Parameters:

ptr

The pointer to the memory to release

References sswf::Buffer::FindBuffer().

void * MemoryManager::MemRealloc	(	void *	ptr,
		size_t	size,
		const char *	info
	)

This function is used to enlarge or reduce the size of a previously allocated buffer or to allocate a new buffer.

When ptr is set to NULL, it behaves like sswf::MemoryManager::MemAlloc().

When ptr is not NULL, then the function searches the buffer. If the buffer was not previously allocated by MemAlloc() or some similar function, then an assert(3) will be emited in debug mode. In release, the buffer will be assumed correct and you will corrupt your memory.

Parameters: