osg::Log Class Reference
[Log]

#include <OSGLog.h>

List of all members.

Public Member Functions
Constructors
*	Log (LogType logType=LOG_STDERR, LogLevel logLevel=LOG_NOTICE)
	Log (const Char8 *fileName, LogLevel logLevel=LOG_NOTICE)
	Constructor which takes a log file name.
Destructors
*virtual	~Log (void)
Class Specific
*void	lock (void)
void	unlock (void)
Module Handling
*virtual void	setHeaderElem (UInt32 elemMask, bool force=false)
	set method for attribute _headerElem
virtual void	addHeaderElem (LogHeaderElem elem, bool force=false)
	add method for attribute _headerElem
virtual void	delHeaderElem (LogHeaderElem elem, bool force=false)
	delete method for attribute _headerElem
virtual bool	hasHeaderElem (LogHeaderElem elem)
	check for a single headerElem
virtual void	addModuleHandling (LogModuleHandling handling, bool force=false)
	set method for attribute _headerElem
virtual void	delModuleHandling (LogModuleHandling handling, bool force=false)
	set method for attribute _headerElem
virtual void	addModuleName (const Char8 *module, bool isStatic=false)
	set method for attribute _headerElem
virtual void	delModuleName (const Char8 *module)
	set method for attribute _headerElem
bool	hasModule (const Char8 *module)
	set method for attribute _headerElem
bool	checkModule (const Char8 *module)
	set method for attribute _headerElem
Level, Type and Time Handling
*LogType	getLogType (void)
void	setLogType (LogType logType, bool force=false)
	set method for attribute logType, checks OSG_LOG_TYPE env var if not forced.
LogLevel	getLogLevel (void)
void	setLogLevel (LogLevel logLevel, bool force=false)
	set method for attribute logLevel, checks OSG_LOG_LEVEL env var if not forced.
bool	checkLevel (LogLevel logLevel)
void	setLogFile (const Char8 *fileName, bool force=false)
	method to set and activate the log file, checks OSG_LOG_FILE env var if not forced
Time	getRefTime (void)
void	setRefTime (Time refTime)
void	resetRefTime (void)
Stream Handling
*LogBuf &	getLogBuf (void)
std::ostream &	stream (LogLevel level)
std::ostream &	nilstream (void)
Logging
*std::ostream &	doHeader (LogLevel level, const Char8 *module, const Char8 *file, UInt32 line)
void	doLog (const Char8 *format,...)
	print for C-interface helper method
Protected Member Functions
Class Specific
*void	connect (void)
	reconnects the streams for the current settings
Private Types
typedef std::ostream	Inherited
Private Member Functions
Constructors
*	Log (const Log &source)
Operators
*void	operator= (const Log &source)
Private Attributes
Static Fields
*LogType	_logType
	holds the log type
LogLevel	_logLevel
	holds the log level
std::fstream	_fileStream
	file stream
LogBuf	_logBuf
	holds the log type
LogOStream *	_streamVec [6]
	stream vector
UInt32	_headerElem
	holds the log type
UInt32	_moduleHandling
	holds the log type
std::list< Module >	_moduleList
	holds the log type
Time	_refTime
	holds the log type
Static Private Attributes
Static Fields
*static nilbuf *	_nilbufP = NULL
	holds the nil buffer
static std::ostream *	_nilstreamP = NULL
	holds the nil buffer
static const Char8 *	_levelName []
	holds the nil buffer
static const Char8 *	_levelColor []
	holds the nil buffer
Friends
void	doInitLog (void)
Classes
struct	Module
struct	nilbuf

---

Detailed Description

Message logger class, handles info,warning and error messages

Definition at line 224 of file OSGLog.h.

---

Member Typedef Documentation

typedef std::ostream osg::Log::Inherited [private]

Definition at line 336 of file OSGLog.h.

---

Constructor & Destructor Documentation

Log::Log (  LogType  logType = LOG_STDERR, LogLevel  logLevel = LOG_NOTICE )

Definition at line 271 of file OSGLog.cpp. References _nilbufP, _nilstreamP, _refTime, _streamVec, osg::getSystemTime(), osg::LOG_TYPE_HEADER, setHeaderElem(), and setLogLevel(). : std::ostream (_nilbufP == NULL ? _nilbufP = new Log::nilbuf() : _nilbufP), _logType (logType ), _logLevel (logLevel ), _fileStream ( ), _logBuf ( ), _headerElem ( 0), _moduleHandling(LOG_MODULE_ALL) { if(_nilstreamP == NULL) _nilstreamP = new std::ostream(_nilbufP); for(UInt32 i = 0; i < sizeof(_streamVec)/sizeof(LogOStream *); i++) { #ifdef OSG_HAS_NILBUF _streamVec[i] = new LogOStream(_nilbufP); #else _streamVec[i] = new LogOStream(_nilStreamP->rdbuf()); #endif } setHeaderElem(LOG_TYPE_HEADER); _refTime = getSystemTime(); setLogLevel(logLevel); }

Log::Log (  const Char8 *  fileName, LogLevel  logLevel = LOG_NOTICE )

Definition at line 303 of file OSGLog.cpp. References _nilbufP, _nilstreamP, _refTime, _streamVec, osg::getSystemTime(), osg::LOG_TYPE_HEADER, setHeaderElem(), setLogFile(), and setLogLevel(). : std::ostream (_nilbufP == NULL ? _nilbufP = new Log::nilbuf() : _nilbufP), _logType (LOG_FILE ), _logLevel (logLevel ), _fileStream ( ), _logBuf ( ), _headerElem ( 0), _moduleHandling(LOG_MODULE_ALL) { if(_nilstreamP == NULL) _nilstreamP = new std::ostream(_nilbufP); for(UInt32 i = 0; i < sizeof(_streamVec)/sizeof(LogOStream *); i++) { #ifdef OSG_HAS_NILBUF _streamVec[i] = new LogOStream(_nilbufP); #else _streamVec[i] = new LogOStream(_nilStreamP->rdbuf()); #endif } _refTime = getSystemTime(); setHeaderElem(LOG_TYPE_HEADER); setLogFile (fileName); setLogLevel (logLevel); }

Log::~Log (  void   )  [virtual]

Definition at line 332 of file OSGLog.cpp. References setLogFile(). { setLogFile(NULL, true); }

* osg::Log::Log (  const Log &  source  )  [private]

---

Member Function Documentation

* void osg::Log::lock (  void   )  [inline]

Definition at line 252 of file OSGLog.h. Referenced by osg::osgStartLog(). {;} // TODO: implement

void osg::Log::unlock (  void   )  [inline]

Definition at line 253 of file OSGLog.h. Referenced by osg::endLog(). {;} // TODO: implement

void Log::setHeaderElem (  UInt32  elemMask, bool  force = false )  [virtual]

Definition at line 342 of file OSGLog.cpp. References _headerElem, osg::endLog(), osg::osgLog(), and osg::osgLogP. Referenced by addHeaderElem(), delHeaderElem(), and Log(). { Char8 *env; if(!force && (this == osgLogP) && (env = getenv( "OSG_LOG_HEADER" ))) { osgLog() << "Log::setHeaderElem: overriden by envvar OSG_LOG_HEADER '" << env << "'." << endLog; elemMask = LogHeaderElem(atoi(env)); } _headerElem = elemMask; }

void Log::addHeaderElem (  LogHeaderElem  elem, bool  force = false )  [virtual]

Definition at line 360 of file OSGLog.cpp. References _headerElem, and setHeaderElem(). { setHeaderElem((_headerElem | elem), force); }

void Log::delHeaderElem (  LogHeaderElem  elem, bool  force = false )  [virtual]

Definition at line 368 of file OSGLog.cpp. References _headerElem, and setHeaderElem(). { setHeaderElem((_headerElem & ~elem),force); }

bool Log::hasHeaderElem (  LogHeaderElem  elem  )  [virtual]

Definition at line 376 of file OSGLog.cpp. References _headerElem. { return (_headerElem & elem) != 0; }

void Log::addModuleHandling (  LogModuleHandling  handling, bool  force = false )  [virtual]

Definition at line 381 of file OSGLog.cpp. References _moduleHandling. { _moduleHandling |= handling; }

void Log::delModuleHandling (  LogModuleHandling  handling, bool  force = false )  [virtual]

Definition at line 387 of file OSGLog.cpp. References _moduleHandling. { _moduleHandling &= ~handling; }

void Log::addModuleName (  const Char8 *  module, bool  isStatic = false )  [virtual]

Definition at line 393 of file OSGLog.cpp. References _moduleList. { Module m; int len; if(module && *module) { _moduleList.push_back(m); if(isStatic) { _moduleList.back().name = module; _moduleList.back().isStatic = true; } else { len = strlen(module); _moduleList.back().name = new Char8[len + 1]; strcpy(const_cast<Char8 *>(_moduleList.back().name), module); _moduleList.back().isStatic = false; } } }

void Log::delModuleName (  const Char8 *  module  )  [virtual]

Definition at line 420 of file OSGLog.cpp. { }

bool Log::hasModule (  const Char8 *  module  )

Definition at line 424 of file OSGLog.cpp. References _moduleList. Referenced by checkModule(). { bool retCode = false; std::list<Module>::iterator mI; if(module && *module) { for( mI = _moduleList.begin(); retCode || (mI != _moduleList.end()); ++mI) { retCode = (mI->isStatic) ? (module == mI->name) : (!strcmp(module,mI->name)); } } return retCode; }

bool Log::checkModule (  const Char8 *  module  )

Definition at line 443 of file OSGLog.cpp. References _moduleHandling, hasModule(), osg::LOG_MODULE_ALL, osg::LOG_MODULE_KNOWN, osg::LOG_MODULE_NONE, osg::LOG_MODULE_UNDEFINED, and osg::LOG_MODULE_UNKNOWN. Referenced by osg::osgStartLog(). { bool retCode = false; std::list<Module>::iterator mI; if(_moduleHandling != LOG_MODULE_NONE) { if(_moduleHandling == LOG_MODULE_ALL) { retCode = true; } else { if(module && &module) { if(hasModule(module)) { if(_moduleHandling & LOG_MODULE_KNOWN) retCode = true; } else { if(_moduleHandling & LOG_MODULE_UNKNOWN) retCode = true; } } else { if(_moduleHandling & LOG_MODULE_UNDEFINED) retCode = true; } } } return retCode; }

LogType Log::getLogType (  void   )

Definition at line 481 of file OSGLog.cpp. References _logType. { return _logType; }

void Log::setLogType (  LogType  logType, bool  force = false )

Definition at line 490 of file OSGLog.cpp. References _logType, connect(), osg::LOG_BUFFER, osg::LOG_FILE, osg::LOG_NONE, osg::LOG_STDERR, osg::LOG_STDOUT, osg::osgLog(), osg::osgLogP, and osg::stringcasecmp(). { static Char8 *typenames[] = { "none", "-", "stdout", "stderr", "file", "buffer", NULL }; static LogType types [] = { LOG_NONE, LOG_STDOUT, LOG_STDOUT, LOG_STDERR, LOG_FILE, LOG_BUFFER }; static Int32 typeCount = sizeof(types) / sizeof(LogType); Char8 *et; Int32 lt; Int32 i; if(!force && (this == osgLogP) && (et = getenv("OSG_LOG_TYPE"))) { osgLog() << "Log::setLogType: overriden by envvar OSG_LOG_TYPE '" << et << "'." << std::endl; if(sscanf(et, "%d", &lt) != 1) { for(i = 0; typenames[i]; i++) { if(!stringcasecmp(et, typenames[i])) { _logType = types[i]; break; } } if(! typenames[i]) { _logType = LOG_STDERR; osgLog() << "Log::setLogType: couldn't interpret envvar, " << "set to LOG_STDERR!" << std::endl; } } else { if(lt < 0) { lt = 0; } else { if(lt >= typeCount) lt = typeCount - 1; } _logType = types[lt]; } } else { _logType = logType; } connect(); }

LogLevel Log::getLogLevel (  void   )

Definition at line 568 of file OSGLog.cpp. References _logLevel. Referenced by osg::DVRVolume::commonConstructor(), and osg::DVRVolume::findParameter(). { return _logLevel; }

void Log::setLogLevel (  LogLevel  logLevel, bool  force = false )

Definition at line 578 of file OSGLog.cpp. References _logLevel, connect(), osg::LOG_DEBUG, osg::LOG_FATAL, osg::LOG_INFO, osg::LOG_LOG, osg::LOG_NOTICE, osg::LOG_WARNING, osg::osgLog(), osg::osgLogP, and osg::stringcasecmp(). Referenced by Log(). { static Char8 *levelnames[] = { "log", "fatal", "warning", "notice", "info", "debug", NULL }; static LogLevel levels [] = { LOG_LOG, LOG_FATAL, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG }; static Int32 levelCount = sizeof(levels) / sizeof(LogLevel); Char8 *el; Int32 ll; Int32 i; if(!force && (this == osgLogP) && (el = getenv("OSG_LOG_LEVEL"))) { osgLog() << "OSGLog::setLogLevel: overriden by envvar OSG_LOG_LEVEL '" << el << "'." << std::endl; if(sscanf(el, "%d", &ll) != 1) { for(i = 0; levelnames[i]; i++) { if(!stringcasecmp(el, levelnames[i])) { _logLevel = levels[i]; break; } } if(! levelnames[i]) { _logLevel = LOG_DEBUG; osgLog() << "Log::setLogLevel: couldn't interpret envvar, " << "set to LOG_DEBUG!" << std::endl; } } else { if (ll < 0) { ll = 0; } else { if (ll >= levelCount) ll = levelCount - 1; } _logLevel = levels[ll]; } } else { _logLevel = logLevel; } connect() ; }

bool osg::Log::checkLevel (  LogLevel  logLevel  )  [inline]

Definition at line 116 of file OSGLog.inl. References _logLevel. { return (_logLevel >= level) ? true : false; }

void Log::setLogFile (  const Char8 *  fileName, bool  force = false )

Definition at line 660 of file OSGLog.cpp. References _fileStream, _logType, connect(), osg::LOG_FILE, osg::osgLog(), and osg::osgLogP. Referenced by Log(), and ~Log(). { const Char8 *name; #ifdef OSG_STREAM_HAS_ISOPEN if(_fileStream.is_open()) #else if(_fileStream.rdbuf()->is_open()) #endif { _fileStream.close(); } if(!force && (this == osgLogP) && (name = getenv("OSG_LOG_FILE"))) { osgLog() << "Log::setLogFile: overriden by envvar OSG_LOG_FILE '" << name << "'." << std::endl; } else { name = fileName; } if(name && *name) { _fileStream.open(name, std::ios::out); #ifdef OSG_STREAM_HAS_ISOPEN if(_fileStream.is_open()) #else if(_fileStream.rdbuf()->is_open()) #endif { _logType = LOG_FILE; connect(); } } }

Time osg::Log::getRefTime (  void   )  [inline]

Definition at line 122 of file OSGLog.inl. References _refTime. { return _refTime; }

void osg::Log::setRefTime (  Time  refTime  )  [inline]

Definition at line 128 of file OSGLog.inl. References _refTime. { _refTime = refTime; }

void osg::Log::resetRefTime (  void   )  [inline]

Definition at line 134 of file OSGLog.inl. References _refTime, and osg::getSystemTime(). { _refTime = getSystemTime(); }

LogBuf & osg::Log::getLogBuf (  void   )  [inline]

Definition at line 148 of file OSGLog.inl. References _logBuf. { return _logBuf; }

std::ostream & osg::Log::stream (  LogLevel  level  )  [inline]

Definition at line 154 of file OSGLog.inl. References _streamVec. Referenced by osg::osgStartLog(), and osg::SceneFileType::print(). { return *(_streamVec[level]); }

std::ostream & osg::Log::nilstream (  void   )  [inline]

Definition at line 160 of file OSGLog.inl. References _nilstreamP. Referenced by osg::osgStartLog(). { return *_nilstreamP; }

std::ostream & osg::Log::doHeader (  LogLevel  level, const Char8 *  module, const Char8 *  file, UInt32  line )  [inline]

Definition at line 166 of file OSGLog.inl. References _headerElem, _levelColor, _levelName, _refTime, _streamVec, osg::getSystemTime(), osg::LOG_BEGIN_NEWLINE_HEADER, osg::LOG_COLOR_HEADER, osg::LOG_END_NEWLINE_HEADER, osg::LOG_FILE_HEADER, osg::LOG_LINE_HEADER, osg::LOG_MODULE_HEADER, osg::LOG_TAB_HEADER, osg::LOG_TIMESTAMP_HEADER, and osg::LOG_TYPE_HEADER. Referenced by osg::osgStartLog(). { LogOStream &sout = *(_streamVec[level]); const char *sep = ( (_headerElem & LOG_TAB_HEADER) ? "\t" : ":" ); const char *color = ( (_headerElem & LOG_COLOR_HEADER) ? _levelColor[level] : 0 ); const char *resetColor = "\x1b[0m"; if(_headerElem) { if(_headerElem & LOG_BEGIN_NEWLINE_HEADER) sout << std::endl; if(_headerElem & LOG_TYPE_HEADER) { if (color) sout << color; sout << _levelName[level] << sep; if (color) sout << resetColor; } if(_headerElem & LOG_TIMESTAMP_HEADER) sout << (getSystemTime() - _refTime) << sep; if(module && *module && (_headerElem & LOG_MODULE_HEADER)) sout << module << sep; if(file && *file && (_headerElem & LOG_FILE_HEADER)) { sout << file; if(_headerElem & LOG_LINE_HEADER) sout << ":" << line; sout << sep; } if(_headerElem & LOG_END_NEWLINE_HEADER) sout << std::endl; else sout << ' '; } return sout; }

void Log::doLog (  const Char8 *  format,   ... )

Definition at line 703 of file OSGLog.cpp. { Char8 buffer[4096]; va_list args; va_start( args, format ); #ifdef OSG_HAS_VSNPRINTF vsnprintf(buffer, sizeof(buffer) - 1, format, args); #else vsprintf(buffer, format, args); #endif //*this << buffer; //*this << std::flush; // Work around VC71. Patch by Chad Austin. std::ostream& os = *this; os << buffer; os << std::flush; va_end(args); }

void Log::connect (  void   )  [protected]

Definition at line 730 of file OSGLog.cpp. References _fileStream, _logBuf, _logLevel, _logType, _nilbufP, _streamVec, osg::LOG_BUFFER, osg::LOG_FILE, osg::LOG_NONE, osg::LOG_STDERR, and osg::LOG_STDOUT. Referenced by setLogFile(), setLogLevel(), and setLogType(). { Int32 i; #ifndef OSG_STREAM_RDBUF_HAS_PARAM switch(_logType) { case LOG_STDOUT: this->bp = std::cout.rdbuf(); break; case LOG_STDERR: this->bp = std::cerr.rdbuf(); break; case LOG_FILE: this->bp = _fileStream.rdbuf(); break; case LOG_BUFFER: this->bp = _logBuf; break; case LOG_NONE: default: this->bp = _nilStreamP->rdbuf(); break; } #else switch(_logType) { case LOG_STDOUT: this->rdbuf(std::cout.rdbuf()); break; case LOG_STDERR: this->rdbuf(std::cerr.rdbuf()); break; case LOG_FILE: this->rdbuf(_fileStream.rdbuf()); break; case LOG_BUFFER: this->rdbuf(&_logBuf); break; case LOG_NONE: default: this->rdbuf(_nilbufP); break; } #endif for(i = 0; i < int(sizeof(_streamVec)/sizeof(std::ostream*)); ++i) { if (i <= _logLevel) { _streamVec[i]->setrdbuf(this->rdbuf()); } else { #ifdef OSG_HAS_NILBUF _streamVec[i]->setrdbuf(_nilbufP); #else _streamVec[i]->setrdbuf(_nilStreamP->rdbuf()); #endif } } }

* void osg::Log::operator= (  const Log &  source  )  [private]

---

Friends And Related Function Documentation

void doInitLog (  void   )  [friend]

Definition at line 818 of file OSGLog.cpp. { #ifdef OSG_HAS_NILBUF if(Log::_nilbufP == NULL) Log::_nilbufP = new Log::nilbuf(); #else if(Log::_nilstreamP == NULL) Log::_nilstreamP = new std::fstream("/dev/null", std::ios::out); #endif if(osgLogP == NULL) { osgLogP = new Log(); osgLogP->setLogLevel(OSG_DEFAULT_LOG_LEVEL); osgLogP->setLogFile (NULL ); osgLogP->setLogType (OSG_DEFAULT_LOG_TYPE ); } }

---

Member Data Documentation

Log::nilbuf * Log::_nilbufP = NULL [static, private]

Definition at line 246 of file OSGLog.cpp. Referenced by connect(), and Log().

std::ostream * Log::_nilstreamP = NULL [static, private]

Definition at line 247 of file OSGLog.cpp. Referenced by osg::doInitLog(), Log(), and nilstream().

const Char8 * Log::_levelName [static, private]

Initial value: { "LOG", "FATAL", "WARNING", "NOTICE", "INFO", "DEBUG", 0 } Definition at line 249 of file OSGLog.cpp. Referenced by doHeader().

const Char8 * Log::_levelColor [static, private]

Initial value: { 0, "\x1b[31m", "\x1b[33m", 0, 0, 0, 0 } Definition at line 260 of file OSGLog.cpp. Referenced by doHeader().

LogType Log::_logType [private]

Referenced by connect(), getLogType(), setLogFile(), and setLogType().

LogLevel Log::_logLevel [private]

Referenced by checkLevel(), connect(), getLogLevel(), and setLogLevel().

fstream Log::_fileStream [private]

Referenced by connect(), and setLogFile().

LogBuf osg::Log::_logBuf [private]

Definition at line 379 of file OSGLog.h. Referenced by connect(), and getLogBuf().

LogOStream * Log::_streamVec[6] [private]

Referenced by connect(), doHeader(), Log(), and stream().

UInt32 osg::Log::_headerElem [private]

Definition at line 382 of file OSGLog.h. Referenced by addHeaderElem(), delHeaderElem(), doHeader(),