osg::LogBuf Class Reference
[Log]

#include <OSGLog.h>

List of all members.

Public Types
typedef void(*	Callback )(const Char8 *data, Int32 size, void *clientData)
Public Member Functions
Constructors
	LogBuf (UInt32 bufferSize=1024)
	LogBuf (const LogBuf &)
Destructors
virtual	~LogBuf ()
Class Specific
bool	getEnabled (void)
void	setEnabled (bool value=true)
void	clearChunkBag (void)
	clear the chunk bag
Callback handling
void	setCallback (Callback cb, void *clientData=0, bool flushData=false)
void	removeCallback (void)
Private Member Functions
const LogBuf &	operator= (const LogBuf &)
void	write (const Char8 *buffer, std::streamsize size)
Callback handling
virtual Int32	overflow (Int32 c)
virtual Int32	sync (void)
virtual std::streamsize	xsputn (const Char8 *buffer, std::streamsize size)
Private Attributes
bool	_enabled
std::list< Chunk * >	_chunkBag
Callback	_callback
void *	_clientData
Classes
struct	Chunk

---

Detailed Description

stream buf helper class; creates a chunk buffer of all messages which can ge fetched by a application (e.g. gui)

Definition at line 137 of file OSGLog.h.

---

Member Typedef Documentation

typedef void(* osg::LogBuf::Callback)(const Char8 *data, Int32 size, void *clientData)

---

Constructor & Destructor Documentation

LogBuf::LogBuf

(

UInt32

bufferSize = 1024

)

Definition at line 72 of file OSGLog.cpp.

                                :
     std::streambuf(    ), 
    _enabled       (true), 
    _chunkBag      (    ),
    _callback      (NULL), 
    _clientData    (NULL)
{
    setg(0, 0, 0);

    if(bufferSize > 0) 
    {
        Char8 *buffer = new Char8[bufferSize];

        setp(buffer, buffer + bufferSize - 1);
    }
    else
    {
        setp(0, 0);
    }
}

osg::LogBuf::LogBuf

(

const LogBuf &

)

LogBuf::~LogBuf

(

void

)

[virtual]

Definition at line 93 of file OSGLog.cpp.

References _callback.

{
    delete [] pbase();

    _callback = NULL;
}

---

Member Function Documentation

bool osg::LogBuf::getEnabled

(

void

)

[inline]

Definition at line 99 of file OSGLog.inl.

References _enabled.

{
    return _enabled; 
}

void osg::LogBuf::setEnabled

(

bool

value = true

)

[inline]

Definition at line 106 of file OSGLog.inl.

References _enabled.

{
    _enabled = value; 
}

void LogBuf::clearChunkBag

(

void

)

Definition at line 103 of file OSGLog.cpp.

References _chunkBag.

{
    std::list<LogBuf::Chunk*>::iterator cI;

    for(cI = _chunkBag.begin(); cI != _chunkBag.end(); ++cI)
        delete *cI;

    _chunkBag.clear();
}

void LogBuf::setCallback	(	LogBuf::Callback	cb,
		void *	clientData = 0,
		bool	flushData = false
	)

Definition at line 114 of file OSGLog.cpp.

References _callback, _chunkBag, _clientData, osg::LogBuf::Chunk::data, and osg::LogBuf::Chunk::size.

{
    std::list<LogBuf::Chunk*>::iterator  cI;
    LogBuf::Chunk                       *chunk;

    if(cb) 
    {
        if(flushData) 
        {
            for(cI = _chunkBag.begin(); cI != _chunkBag.end(); cI++) 
            {
                if((chunk = *cI))
                    cb(chunk->data,chunk->size,clientData);
            }
        }

        _callback   = cb;
        _clientData = clientData;
    }
}

void LogBuf::removeCallback

(

void

)

Definition at line 137 of file OSGLog.cpp.

References _callback.

{
    _callback = 0;
}

const LogBuf& osg::LogBuf::operator=

(

const LogBuf &

)

[private]

void LogBuf::write	(	const Char8 *	buffer,
		std::streamsize	size
	)			[private]

Definition at line 143 of file OSGLog.cpp.

References _callback, _chunkBag, _clientData, _enabled, osg::LogBuf::Chunk::data, and osg::LogBuf::Chunk::size.

Referenced by overflow(), sync(), and xsputn().

{
    Chunk    *chunk = 0;
    Callback  cb    = NULL;

    if(_enabled)
    {
        chunk = new Chunk;

        chunk->size = size;
        chunk->data = new Char8[size];

        memcpy(chunk->data, buffer, size);

        _chunkBag.push_back(chunk);
    }
    
    if ((cb = _callback))
        cb(buffer,size, _clientData);
}

int LogBuf::overflow

(

Int32

c

)

[private, virtual]

Definition at line 164 of file OSGLog.cpp.

References write().

{
    if(!pptr())
        return EOF;
    
    if(c != EOF) 
    {
        // Put character into write buffer
        *pptr() = c; 

        pbump(1);

        // Flush write buffer
        std::streamsize size = pptr() - pbase();

        if(size > 0)
        {
            write(pbase(), size);
            pbump(-size);
        }
    }
  
    return 0;
}

int LogBuf::sync

(

void

)

[private, virtual]

Definition at line 189 of file OSGLog.cpp.

References write().

{
    if(!pptr())
        return EOF;

    // Flush write buffer
    std::streamsize size = pptr() -  pbase();

    if(size > 0) 
    {
        write(pbase(), size);
        pbump(-size);
    }

    return 0;
}

std::streamsize LogBuf::xsputn	(	const Char8 *	buffer,
		std::streamsize	size
	)			[private, virtual]

Definition at line 206 of file OSGLog.cpp.

References write().

{
    if(size > 0)
    {
        if(!pptr())
            return 0;

        std::streamsize s = epptr() - pptr();

        if(s >= size) 
        {
            // Put it into the write buffer
            memcpy(pptr(), buffer, size);
            pbump(size);
        }
        else 
        {
            // Flush write buffer
            s = pptr() - pbase();

            if (s > 0) 
            {
                write(pbase(), s);
                pbump(-s);
            }

            // Write data
            write(buffer, size);
        }
    }

    return size;
}

---

Member Data Documentation

bool osg::LogBuf::_enabled [private]

Definition at line 198 of file OSGLog.h.

Referenced by getEnabled(), setEnabled(), and write().

std::list<Chunk*> osg::LogBuf::_chunkBag [private]

Definition at line 200 of file OSGLog.h.

Referenced by clearChunkBag(), setCallback(), and write().

Callback osg::LogBuf::_callback [private]

Definition at line 202 of file OSGLog.h.

Referenced by removeCallback(), setCallback(), write(), and ~LogBuf().

void* osg::LogBuf::_clientData [private]

Definition at line 203 of file OSGLog.h.

Referenced by setCallback(), and write().

---

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

• OSGLog.h
• OSGLog.cpp
• OSGLog.inl